DistributionBuilder (FsCDK)

DistributionBuilder Type

Namespace: FsCDK
Assembly: FsCDK.dll
Base Type: obj

Constructors

Constructor Description

Constructor	Description
`DistributionBuilder(name)` Full Usage: `DistributionBuilder(name)` Parameters: name : `string` Returns: `DistributionBuilder`	name : `string` Returns: `DistributionBuilder`


                
                  
                    
                      DistributionBuilder(name)

Full Usage: DistributionBuilder(name)

Parameters:

name : string

Returns: DistributionBuilder

name : string

Returns: DistributionBuilder

Instance members

Instance member	Description
`additionalBehavior pathPattern behavior` Full Usage: `additionalBehavior pathPattern behavior` Parameters: pathPattern : `string` behavior : `IBehaviorOptions` Returns: `DistributionConfig`	Add an additional behavior for a path pattern. pathPattern : `string` behavior : `IBehaviorOptions` Returns: `DistributionConfig`
`additionalHttpBehavior pathPattern domainName ?originPath ?viewerProtocolPolicy ?cachePolicy ?originRequestPolicy ?responseHeadersPolicy ?allowedMethods ?cachedMethods ?compress` Full Usage: `additionalHttpBehavior pathPattern domainName ?originPath ?viewerProtocolPolicy ?cachePolicy ?originRequestPolicy ?responseHeadersPolicy ?allowedMethods ?cachedMethods ?compress` Parameters: pathPattern : `string` domainName : `string` ?originPath : `string` ?viewerProtocolPolicy : `ViewerProtocolPolicy` ?cachePolicy : `ICachePolicy` ?originRequestPolicy : `IOriginRequestPolicy` ?responseHeadersPolicy : `ResponseHeadersPolicy` ?allowedMethods : `AllowedMethods` ?cachedMethods : `CachedMethods` ?compress : `bool` Returns: `DistributionConfig`	Convenience: adds an additional HTTP(S) behavior at a path pattern. Same defaults as httpDefaultBehavior unless overridden. pathPattern : `string` domainName : `string` ?originPath : `string` ?viewerProtocolPolicy : `ViewerProtocolPolicy` ?cachePolicy : `ICachePolicy` ?originRequestPolicy : `IOriginRequestPolicy` ?responseHeadersPolicy : `ResponseHeadersPolicy` ?allowedMethods : `AllowedMethods` ?cachedMethods : `CachedMethods` ?compress : `bool` Returns: `DistributionConfig`
`additionalS3Behavior pathPattern originType ?viewerProtocolPolicy ?cachePolicy ?originRequestPolicy ?responseHeadersPolicy ?allowedMethods ?cachedMethods ?compress` Full Usage: `additionalS3Behavior pathPattern originType ?viewerProtocolPolicy ?cachePolicy ?originRequestPolicy ?responseHeadersPolicy ?allowedMethods ?cachedMethods ?compress` Parameters: pathPattern : `string` originType : `S3OriginType` ?viewerProtocolPolicy : `ViewerProtocolPolicy` ?cachePolicy : `ICachePolicy` ?originRequestPolicy : `IOriginRequestPolicy` ?responseHeadersPolicy : `ResponseHeadersPolicy` ?allowedMethods : `AllowedMethods` ?cachedMethods : `CachedMethods` ?compress : `bool` Returns: `DistributionConfig`	Convenience: adds S3 behavior at a path pattern. Same defaults as s3DefaultBehavior unless overridden. pathPattern : `string` originType : `S3OriginType` ?viewerProtocolPolicy : `ViewerProtocolPolicy` ?cachePolicy : `ICachePolicy` ?originRequestPolicy : `IOriginRequestPolicy` ?responseHeadersPolicy : `ResponseHeadersPolicy` ?allowedMethods : `AllowedMethods` ?cachedMethods : `CachedMethods` ?compress : `bool` Returns: `DistributionConfig`
`certificate certificate` Full Usage: `certificate certificate` Parameters: certificate : `ICertificate` Returns: `DistributionConfig`	Sets an ACM certificate for the distribution. certificate : `ICertificate` Returns: `DistributionConfig`
`this.Combine` Full Usage: `this.Combine` Parameters: a : `DistributionConfig` b : `DistributionConfig` Returns: `DistributionConfig`	a : `DistributionConfig` b : `DistributionConfig` Returns: `DistributionConfig`
`comment comment` Full Usage: `comment comment` Parameters: comment : `string` Returns: `DistributionConfig`	Sets the comment for the distribution. comment : `string` Returns: `DistributionConfig`
`constructId id` Full Usage: `constructId id` Parameters: id : `string` Returns: `DistributionConfig`	Sets the construct ID for the distribution. id : `string` Returns: `DistributionConfig`
`defaultBehavior behavior` Full Usage: `defaultBehavior behavior` Parameters: behavior : `IBehaviorOptions` Returns: `DistributionConfig`	Sets the default behavior from a pre-built IBehaviorOptions. behavior : `IBehaviorOptions` Returns: `DistributionConfig`
`defaultRootObject obj` Full Usage: `defaultRootObject obj` Parameters: obj : `string` Returns: `DistributionConfig`	Sets the default root object (e.g., "index.html"). obj : `string` Returns: `DistributionConfig`
`this.Delay` Full Usage: `this.Delay` Parameters: f : `unit -> DistributionConfig` Returns: `DistributionConfig` Modifiers: inline	f : `unit -> DistributionConfig` Returns: `DistributionConfig`
`domainName domain` Full Usage: `domainName domain` Parameters: domain : `string` Returns: `DistributionConfig`	Adds a domain name (call multiple times to add several). domain : `string` Returns: `DistributionConfig`
`enableIpv6 enabled` Full Usage: `enableIpv6 enabled` Parameters: enabled : `bool` Returns: `DistributionConfig`	Enables or disables IPv6. enabled : `bool` Returns: `DistributionConfig`
`enableLogging bucket ?prefix ?includeCookies` Full Usage: `enableLogging bucket ?prefix ?includeCookies` Parameters: bucket : `IBucket` ?prefix : `string` ?includeCookies : `bool` Returns: `DistributionConfig`	Enables logging to an S3 bucket (optionally with a prefix and cookies flag). bucket : `IBucket` ?prefix : `string` ?includeCookies : `bool` Returns: `DistributionConfig`
`enabled enabled` Full Usage: `enabled enabled` Parameters: enabled : `bool` Returns: `DistributionConfig`	Enables or disables the distribution. enabled : `bool` Returns: `DistributionConfig`
`this.For` Full Usage: `this.For` Parameters: config : `DistributionConfig` f : `unit -> DistributionConfig` Returns: `DistributionConfig` Modifiers: inline	config : `DistributionConfig` f : `unit -> DistributionConfig` Returns: `DistributionConfig`
`httpDefaultBehavior domainName ?originPath ?viewerProtocolPolicy ?cachePolicy ?originRequestPolicy ?responseHeadersPolicy ?allowedMethods ?cachedMethods ?compress` Full Usage: `httpDefaultBehavior domainName ?originPath ?viewerProtocolPolicy ?cachePolicy ?originRequestPolicy ?responseHeadersPolicy ?allowedMethods ?cachedMethods ?compress` Parameters: domainName : `string` ?originPath : `string` ?viewerProtocolPolicy : `ViewerProtocolPolicy` ?cachePolicy : `ICachePolicy` ?originRequestPolicy : `IOriginRequestPolicy` ?responseHeadersPolicy : `ResponseHeadersPolicy` ?allowedMethods : `AllowedMethods` ?cachedMethods : `CachedMethods` ?compress : `bool` Returns: `DistributionConfig`	Convenience: default HTTP(S) origin behavior (e.g., ALB/API) with common defaults. Defaults: - ViewerProtocolPolicy = REDIRECT_TO_HTTPS - CachePolicy = CachePolicy.CACHING_OPTIMIZED (override for dynamic APIs) - OriginRequestPolicy = OriginRequestPolicy.ALL_VIEWER - Compress = true domainName : `string` ?originPath : `string` ?viewerProtocolPolicy : `ViewerProtocolPolicy` ?cachePolicy : `ICachePolicy` ?originRequestPolicy : `IOriginRequestPolicy` ?responseHeadersPolicy : `ResponseHeadersPolicy` ?allowedMethods : `AllowedMethods` ?cachedMethods : `CachedMethods` ?compress : `bool` Returns: `DistributionConfig`
`httpVersion version` Full Usage: `httpVersion version` Parameters: version : `HttpVersion` Returns: `DistributionConfig`	Sets the HTTP version preference. version : `HttpVersion` Returns: `DistributionConfig`
`minimumProtocolVersion version` Full Usage: `minimumProtocolVersion version` Parameters: version : `SecurityPolicyProtocol` Returns: `DistributionConfig`	Sets the minimum TLS protocol version. version : `SecurityPolicyProtocol` Returns: `DistributionConfig`
`priceClass priceClass` Full Usage: `priceClass priceClass` Parameters: priceClass : `PriceClass` Returns: `DistributionConfig`	Sets the price class. priceClass : `PriceClass` Returns: `DistributionConfig`
`this.Run` Full Usage: `this.Run` Parameters: config : `DistributionConfig` Returns: `DistributionSpec`	config : `DistributionConfig` Returns: `DistributionSpec`
`s3DefaultBehavior originType ?viewerProtocolPolicy ?cachePolicy ?originRequestPolicy ?responseHeadersPolicy ?allowedMethods ?cachedMethods ?compress` Full Usage: `s3DefaultBehavior originType ?viewerProtocolPolicy ?cachePolicy ?originRequestPolicy ?responseHeadersPolicy ?allowedMethods ?cachedMethods ?compress` Parameters: originType : `S3OriginType` ?viewerProtocolPolicy : `ViewerProtocolPolicy` ?cachePolicy : `ICachePolicy` ?originRequestPolicy : `IOriginRequestPolicy` ?responseHeadersPolicy : `ResponseHeadersPolicy` ?allowedMethods : `AllowedMethods` ?cachedMethods : `CachedMethods` ?compress : `bool` Returns: `DistributionConfig`	Convenience: default S3 origin behavior with common best-practice defaults. Defaults: - ViewerProtocolPolicy = REDIRECT_TO_HTTPS - CachePolicy = CachePolicy.CACHING_OPTIMIZED - OriginRequestPolicy = OriginRequestPolicy.CORS_S3_ORIGIN - Compress = true You can override any default via optional parameters. originType : `S3OriginType` ?viewerProtocolPolicy : `ViewerProtocolPolicy` ?cachePolicy : `ICachePolicy` ?originRequestPolicy : `IOriginRequestPolicy` ?responseHeadersPolicy : `ResponseHeadersPolicy` ?allowedMethods : `AllowedMethods` ?cachedMethods : `CachedMethods` ?compress : `bool` Returns: `DistributionConfig`
`webAclId aclId` Full Usage: `webAclId aclId` Parameters: aclId : `string` Returns: `DistributionConfig`	Sets the associated WAF web ACL ID. aclId : `string` Returns: `DistributionConfig`
`this.Yield` Full Usage: `this.Yield` Parameters: () : `unit` Returns: `DistributionConfig`	() : `unit` Returns: `DistributionConfig`
`this.Zero` Full Usage: `this.Zero` Returns: `DistributionConfig`	Returns: `DistributionConfig`