DistributionState class
Input properties used for looking up and filtering Distribution resources.
Constructors
-
DistributionState({Input<
List< ? aliases, Input<String> ?>String?> ? anycastIpListId, Input<String?> ? arn, Input<DistributionCacheTagConfig?> ? cacheTagConfig, Input<String?> ? callerReference, Input<String?> ? comment, Input<DistributionConnectionFunctionAssociation?> ? connectionFunctionAssociation, Input<String?> ? continuousDeploymentPolicyId, Input<List< ? customErrorResponses, Input<DistributionCustomErrorResponse> ?>DistributionDefaultCacheBehavior?> ? defaultCacheBehavior, Input<String?> ? defaultRootObject, Input<String?> ? domainName, Input<bool?> ? enabled, Input<String?> ? etag, Input<String?> ? hostedZoneId, Input<String?> ? httpVersion, Input<int?> ? inProgressValidationBatches, Input<bool?> ? isIpv6Enabled, Input<String?> ? lastModifiedTime, Input<DistributionLoggingConfig?> ? loggingConfig, Input<bool?> ? loggingV1Enabled, Input<List< ? orderedCacheBehaviors, Input<DistributionOrderedCacheBehavior> ?>List< ? originGroups, Input<DistributionOriginGroup> ?>List< ? origins, Input<DistributionOrigin> ?>String?> ? priceClass, Input<DistributionRestrictions?> ? restrictions, Input<bool?> ? retainOnDelete, Input<bool?> ? staging, Input<String?> ? status, Input<Map< ? tags, Input<String, String> ?>Map< ? tagsAll, Input<String, String> ?>List< ? trustedKeyGroups, Input<DistributionTrustedKeyGroup> ?>List< ? trustedSigners, Input<DistributionTrustedSigner> ?>DistributionViewerCertificate?> ? viewerCertificate, Input<DistributionViewerMtlsConfig?> ? viewerMtlsConfig, Input<bool?> ? waitForDeployment, Input<String?> ? webAclId}) -
Creates a new DistributionState.
aliasesExtra CNAMEs (alternate domain names), if any, for this distribution.anycastIpListIdID of the Anycast static IP list that is associated with the distribution.arnARN for the distribution. For example:arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5, where123456789012is your AWS account ID.cacheTagConfigCache tag configuration block for cache tag extraction from origin responses (maximum one). See the AWS documentation for more information about cache tags.callerReferenceInternal value used by CloudFront to allow future updates to the distribution configuration.commentAny comments you want to include about the distribution.connectionFunctionAssociationA connection function association configuration block (maximum one).continuousDeploymentPolicyIdIdentifier of a continuous deployment policy. This argument should only be set on a production distribution. See theaws.cloudfront.ContinuousDeploymentPolicyresource for additional details.customErrorResponsesOne or more custom error response elements (multiples allowed).defaultCacheBehaviorDefault cache behavior for this distribution (maximum one). Requires eithercachePolicyId(preferred) orforwardedValues(deprecated) be set.defaultRootObjectObject that you want CloudFront to return (for example, index.html) when an end user requests the root URL.domainNameDomain name corresponding to the distribution. For example:d604721fxaaqy9.cloudfront.net.enabledWhether the distribution is enabled to accept end user requests for content.etagCurrent version of the distribution's information. For example:E2QWRUHAPOMQZL.hostedZoneIdCloudFront Route 53 zone ID that can be used to route an Alias Resource Record Set to. This attribute is simply an alias for the zone IDZ2FDTNDATAQYW2.httpVersionMaximum HTTP version to support on the distribution. Allowed values arehttp1.1,http2,http2and3andhttp3. The default ishttp2.inProgressValidationBatchesNumber of invalidation batches currently in progress.isIpv6EnabledWhether the IPv6 is enabled for the distribution.lastModifiedTimeDate and time the distribution was last modified.loggingConfigThe 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.loggingV1EnabledWhether V1 logging is enabled for the distribution.orderedCacheBehaviorsOrdered 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.originGroupsOne or more originGroup for this distribution (multiples allowed).originsOne or more origins for this distribution (multiples allowed).priceClassPrice class for this distribution. One ofPriceClass_All,PriceClass_200,PriceClass_100.restrictionsThe restriction configuration for this distribution (maximum one).retainOnDeleteDisables 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.stagingA Boolean that indicates whether this is a staging distribution. Defaults tofalse.statusCurrent status of the distribution.Deployedif the distribution's information is fully propagated throughout the Amazon CloudFront system.tagsA map of tags to assign to the resource. If configured with a providerdefaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.tagsAllMap of tags assigned to the resource, including those inherited from the providerdefaultTagsconfiguration block.trustedKeyGroupsList of nested attributes for active trusted key groups, if the distribution is set up to serve private content with signed URLs.trustedSignersList of nested attributes for active trusted signers, if the distribution is set up to serve private content with signed URLs.viewerCertificateThe SSL configuration for this distribution (maximum one).viewerMtlsConfigThe viewer mTLS configuration for this distribution (maximum one).waitForDeploymentIf enabled, the resource will wait for the distribution status to change fromInProgresstoDeployed. Setting this tofalsewill skip the process. Default:true.webAclIdUnique 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 exampleaws_wafv2_web_acl.example.arn. To specify a web ACL created using AWS WAF Classic, use the ACL ID, for exampleaws_waf_web_acl.example.id. The WAF Web ACL must exist in the WAF Global (CloudFront) region and the credentials configuring this argument must havewaf:GetWebACLpermissions assigned.const -
DistributionState.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
-
arn
→ Input<
String?> ? -
ARN for the distribution. For example:
arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5, where123456789012is your AWS account ID.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
-
callerReference
→ Input<
String?> ? -
Internal value used by CloudFront to allow future updates to the distribution configuration.
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.ContinuousDeploymentPolicyresource 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) orforwardedValues(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
-
domainName
→ Input<
String?> ? -
Domain name corresponding to the distribution. For example:
d604721fxaaqy9.cloudfront.net.final -
enabled
→ Input<
bool?> ? -
Whether the distribution is enabled to accept end user requests for content.
final
-
etag
→ Input<
String?> ? -
Current version of the distribution's information. For example:
E2QWRUHAPOMQZL.final - hashCode → int
-
The hash code for this object.
no setterinherited
-
hostedZoneId
→ Input<
String?> ? -
CloudFront Route 53 zone ID that can be used to route an Alias Resource Record Set to. This attribute is simply an alias for the zone ID
Z2FDTNDATAQYW2.final -
httpVersion
→ Input<
String?> ? -
Maximum HTTP version to support on the distribution. Allowed values are
http1.1,http2,http2and3andhttp3. The default ishttp2.final -
inProgressValidationBatches
→ Input<
int?> ? -
Number of invalidation batches currently in progress.
final
-
isIpv6Enabled
→ Input<
bool?> ? -
Whether the IPv6 is enabled for the distribution.
final
-
lastModifiedTime
→ Input<
String?> ? -
Date and time the distribution was last modified.
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
-
loggingV1Enabled
→ Input<
bool?> ? -
Whether V1 logging is enabled for the distribution.
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 -
status
→ Input<
String?> ? -
Current status of the distribution.
Deployedif the distribution's information is fully propagated throughout the Amazon CloudFront system.final -
A map of tags to assign to the resource. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.final -
Map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.final -
trustedKeyGroups
→ Input<
List< ?DistributionTrustedKeyGroup> ?> -
List of nested attributes for active trusted key groups, if the distribution is set up to serve private content with signed URLs.
final
-
trustedSigners
→ Input<
List< ?DistributionTrustedSigner> ?> -
List of nested attributes for active trusted signers, if the distribution is set up to serve private content with signed URLs.
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
InProgresstoDeployed. Setting this tofalsewill 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 exampleaws_waf_web_acl.example.id. The WAF Web ACL must exist in the WAF Global (CloudFront) region and the credentials configuring this argument must havewaf:GetWebACLpermissions 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