DistributionArgs class

The set of arguments for Distribution. The set of arguments for Distribution.

Constructors

DistributionArgs({Input<List<String>?>? aliases, Input<String?>? anycastIpListId, Input<DistributionCacheTagConfig?>? cacheTagConfig, Input<String?>? comment, Input<DistributionConnectionFunctionAssociation?>? connectionFunctionAssociation, Input<String?>? continuousDeploymentPolicyId, Input<List<DistributionCustomErrorResponse>?>? customErrorResponses, required Input<DistributionDefaultCacheBehavior> defaultCacheBehavior, Input<String?>? defaultRootObject, required Input<bool> enabled, Input<String?>? httpVersion, Input<bool?>? isIpv6Enabled, Input<DistributionLoggingConfig?>? loggingConfig, Input<List<DistributionOrderedCacheBehavior>?>? orderedCacheBehaviors, Input<List<DistributionOriginGroup>?>? originGroups, required Input<List<DistributionOrigin>> origins, Input<String?>? priceClass, required Input<DistributionRestrictions> restrictions, Input<bool?>? retainOnDelete, Input<bool?>? staging, Input<Map<String, String>?>? tags, required Input<DistributionViewerCertificate> viewerCertificate, Input<DistributionViewerMtlsConfig?>? viewerMtlsConfig, Input<bool?>? waitForDeployment, Input<String?>? webAclId})
Creates a new DistributionArgs. aliases Extra CNAMEs (alternate domain names), if any, for this distribution. anycastIpListId ID of the Anycast static IP list that is associated with the distribution. cacheTagConfig Cache tag configuration block for cache tag extraction from origin responses (maximum one). See the AWS documentation for more information about cache tags. comment Any comments you want to include about the distribution. connectionFunctionAssociation A connection function association configuration block (maximum one). continuousDeploymentPolicyId Identifier of a continuous deployment policy. This argument should only be set on a production distribution. See the aws.cloudfront.ContinuousDeploymentPolicy resource for additional details. customErrorResponses One or more custom error response elements (multiples allowed). defaultCacheBehavior Default cache behavior for this distribution (maximum one). Requires either cachePolicyId (preferred) or forwardedValues (deprecated) be set. defaultRootObject Object that you want CloudFront to return (for example, index.html) when an end user requests the root URL. enabled Whether the distribution is enabled to accept end user requests for content. httpVersion Maximum HTTP version to support on the distribution. Allowed values are http1.1, http2, http2and3 and http3. The default is http2. isIpv6Enabled Whether the IPv6 is enabled for the distribution. loggingConfig The logging configuration that controls how logs are written to your distribution (maximum one). AWS provides two versions of access logs for CloudFront: Legacy and v2. This argument configures legacy version standard logs. orderedCacheBehaviors Ordered list of cache behaviors resource for this distribution. List from top to bottom in order of precedence. The topmost cache behavior will have precedence 0. originGroups One or more originGroup for this distribution (multiples allowed). origins One or more origins for this distribution (multiples allowed). priceClass Price class for this distribution. One of PriceClass_All, PriceClass_200, PriceClass_100. restrictions The restriction configuration for this distribution (maximum one). retainOnDelete Disables the distribution instead of deleting it when destroying the resource through the provider. If this is set, the distribution needs to be deleted manually afterwards. Default: false. staging A Boolean that indicates whether this is a staging distribution. Defaults to false. tags A map of tags to assign to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level. viewerCertificate The SSL configuration for this distribution (maximum one). viewerMtlsConfig The viewer mTLS configuration for this distribution (maximum one). waitForDeployment If enabled, the resource will wait for the distribution status to change from InProgress to Deployed. Setting this tofalse will skip the process. Default: true. webAclId Unique identifier that specifies the AWS WAF web ACL, if any, to associate with this distribution. To specify a web ACL created using the latest version of AWS WAF (WAFv2), use the ACL ARN, for example aws_wafv2_web_acl.example.arn. To specify a web ACL created using AWS WAF Classic, use the ACL ID, for example aws_waf_web_acl.example.id. The WAF Web ACL must exist in the WAF Global (CloudFront) region and the credentials configuring this argument must have waf:GetWebACL permissions assigned.
const
DistributionArgs.fromMap(Map<String, dynamic> map)
factory

Properties

aliases → Input<List<String>?>?
Extra CNAMEs (alternate domain names), if any, for this distribution.
final
anycastIpListId → Input<String?>?
ID of the Anycast static IP list that is associated with the distribution.
final
cacheTagConfig → Input<DistributionCacheTagConfig?>?
Cache tag configuration block for cache tag extraction from origin responses (maximum one). See the AWS documentation for more information about cache tags.
final
comment → Input<String?>?
Any comments you want to include about the distribution.
final
connectionFunctionAssociation → Input<DistributionConnectionFunctionAssociation?>?
A connection function association configuration block (maximum one).
final
continuousDeploymentPolicyId → Input<String?>?
Identifier of a continuous deployment policy. This argument should only be set on a production distribution. See the aws.cloudfront.ContinuousDeploymentPolicy resource for additional details.
final
customErrorResponses → Input<List<DistributionCustomErrorResponse>?>?
One or more custom error response elements (multiples allowed).
final
defaultCacheBehavior → Input<DistributionDefaultCacheBehavior>
Default cache behavior for this distribution (maximum one). Requires either cachePolicyId (preferred) or forwardedValues (deprecated) be set.
final
defaultRootObject → Input<String?>?
Object that you want CloudFront to return (for example, index.html) when an end user requests the root URL.
final
enabled → Input<bool>
Whether the distribution is enabled to accept end user requests for content.
final
hashCode → int
The hash code for this object.
no setterinherited
httpVersion → Input<String?>?
Maximum HTTP version to support on the distribution. Allowed values are http1.1, http2, http2and3 and http3. The default is http2.
final
isIpv6Enabled → Input<bool?>?
Whether the IPv6 is enabled for the distribution.
final
loggingConfig → Input<DistributionLoggingConfig?>?
The logging configuration that controls how logs are written to your distribution (maximum one). AWS provides two versions of access logs for CloudFront: Legacy and v2. This argument configures legacy version standard logs.
final
orderedCacheBehaviors → Input<List<DistributionOrderedCacheBehavior>?>?
Ordered list of cache behaviors resource for this distribution. List from top to bottom in order of precedence. The topmost cache behavior will have precedence 0.
final
originGroups → Input<List<DistributionOriginGroup>?>?
One or more originGroup for this distribution (multiples allowed).
final
origins → Input<List<DistributionOrigin>>
One or more origins for this distribution (multiples allowed).
final
priceClass → Input<String?>?
Price class for this distribution. One of PriceClass_All, PriceClass_200, PriceClass_100.
final
restrictions → Input<DistributionRestrictions>
The restriction configuration for this distribution (maximum one).
final
retainOnDelete → Input<bool?>?
Disables the distribution instead of deleting it when destroying the resource through the provider. If this is set, the distribution needs to be deleted manually afterwards. Default: false.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
staging → Input<bool?>?
A Boolean that indicates whether this is a staging distribution. Defaults to false.
final
tags → Input<Map<String, String>?>?
A map of tags to assign to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
final
viewerCertificate → Input<DistributionViewerCertificate>
The SSL configuration for this distribution (maximum one).
final
viewerMtlsConfig → Input<DistributionViewerMtlsConfig?>?
The viewer mTLS configuration for this distribution (maximum one).
final
waitForDeployment → Input<bool?>?
If enabled, the resource will wait for the distribution status to change from InProgress to Deployed. Setting this tofalse will skip the process. Default: true.
final
webAclId → Input<String?>?
Unique identifier that specifies the AWS WAF web ACL, if any, to associate with this distribution. To specify a web ACL created using the latest version of AWS WAF (WAFv2), use the ACL ARN, for example aws_wafv2_web_acl.example.arn. To specify a web ACL created using AWS WAF Classic, use the ACL ID, for example aws_waf_web_acl.example.id. The WAF Web ACL must exist in the WAF Global (CloudFront) region and the credentials configuring this argument must have waf:GetWebACL permissions assigned.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited