DistributionConfigArgs

data class DistributionConfigArgs(val aliases: Output<List<String>>? = null, val anycastIpListId: Output<String>? = null, val cacheBehaviors: Output<List<DistributionCacheBehaviorArgs>>? = null, val cnames: Output<List<String>>? = null, val comment: Output<String>? = null, val connectionMode: Output<DistributionConnectionMode>? = null, val continuousDeploymentPolicyId: Output<String>? = null, val customErrorResponses: Output<List<DistributionCustomErrorResponseArgs>>? = null, val customOrigin: Output<DistributionLegacyCustomOriginArgs>? = null, val defaultCacheBehavior: Output<DistributionDefaultCacheBehaviorArgs>, val defaultRootObject: Output<String>? = null, val enabled: Output<Boolean>, val httpVersion: Output<String>? = null, val ipv6Enabled: Output<Boolean>? = null, val logging: Output<DistributionLoggingArgs>? = null, val originGroups: Output<DistributionOriginGroupsArgs>? = null, val origins: Output<List<DistributionOriginArgs>>? = null, val priceClass: Output<String>? = null, val restrictions: Output<DistributionRestrictionsArgs>? = null, val s3Origin: Output<DistributionLegacyS3OriginArgs>? = null, val staging: Output<Boolean>? = null, val tenantConfig: Output<DistributionConfigTenantConfigPropertiesArgs>? = null, val viewerCertificate: Output<DistributionViewerCertificateArgs>? = null, val webAclId: Output<String>? = null) : ConvertibleToJava<DistributionConfigArgs>

A distribution configuration.

Constructors

Link copied to clipboard
constructor(aliases: Output<List<String>>? = null, anycastIpListId: Output<String>? = null, cacheBehaviors: Output<List<DistributionCacheBehaviorArgs>>? = null, cnames: Output<List<String>>? = null, comment: Output<String>? = null, connectionMode: Output<DistributionConnectionMode>? = null, continuousDeploymentPolicyId: Output<String>? = null, customErrorResponses: Output<List<DistributionCustomErrorResponseArgs>>? = null, customOrigin: Output<DistributionLegacyCustomOriginArgs>? = null, defaultCacheBehavior: Output<DistributionDefaultCacheBehaviorArgs>, defaultRootObject: Output<String>? = null, enabled: Output<Boolean>, httpVersion: Output<String>? = null, ipv6Enabled: Output<Boolean>? = null, logging: Output<DistributionLoggingArgs>? = null, originGroups: Output<DistributionOriginGroupsArgs>? = null, origins: Output<List<DistributionOriginArgs>>? = null, priceClass: Output<String>? = null, restrictions: Output<DistributionRestrictionsArgs>? = null, s3Origin: Output<DistributionLegacyS3OriginArgs>? = null, staging: Output<Boolean>? = null, tenantConfig: Output<DistributionConfigTenantConfigPropertiesArgs>? = null, viewerCertificate: Output<DistributionViewerCertificateArgs>? = null, webAclId: Output<String>? = null)

Properties

Link copied to clipboard
val aliases: Output<List<String>>? = null

A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.

Link copied to clipboard
val anycastIpListId: Output<String>? = null

ID of the Anycast static IP list that is associated with the distribution.

Link copied to clipboard

A complex type that contains zero or more `CacheBehavior` elements.

Link copied to clipboard
val cnames: Output<List<String>>? = null

An alias for the CF distribution's domain name. This property is legacy. We recommend that you use Aliases instead.

Link copied to clipboard
val comment: Output<String>? = null

A comment to describe the distribution. The comment cannot be longer than 128 characters.

Link copied to clipboard

The connection mode to filter distributions by.

Link copied to clipboard

The identifier of a continuous deployment policy. For more information, see `CreateContinuousDeploymentPolicy`.

Link copied to clipboard

A complex type that controls the following:

Link copied to clipboard

The user-defined HTTP server that serves as the origin for content that CF distributes. This property is legacy. We recommend that you use Origin instead.

Link copied to clipboard

A complex type that describes the default cache behavior if you don't specify a `CacheBehavior` element or if files don't match any of the values of `PathPattern` in `CacheBehavior` elements. You must create exactly one default cache behavior.

Link copied to clipboard
val defaultRootObject: Output<String>? = null

When a viewer requests the root URL for your distribution, the default root object is the object that you want CloudFront to request from your origin. For example, if your root URL is `https://www.example.com`, you can specify CloudFront to return the `index.html` file as the default root object. You can specify a default root object so that viewers see a specific file or object, instead of another object in your distribution (for example, `https://www.example.com/product-description.html`). A default root object avoids exposing the contents of your distribution. You can specify the object name or a path to the object name (for example, `index.html` or `exampleFolderName/index.html`). Your string can't begin with a forward slash (`/`). Only specify the object name or the path to the object. If you don't want to specify a default root object when you create a distribution, include an empty `DefaultRootObject` element. To delete the default root object from an existing distribution, update the distribution configuration and include an empty `DefaultRootObject` element. To replace the default root object, update the distribution configuration and specify the new object. For more information about the default root object, see Specify a default root object in the Amazon CloudFront Developer Guide.

Link copied to clipboard
val enabled: Output<Boolean>

From this field, you can enable or disable the selected distribution.

Link copied to clipboard
val httpVersion: Output<String>? = null

(Optional) Specify the HTTP version(s) that you want viewers to use to communicate with CF. The default value for new distributions is `http1.1`. For viewers and CF to use HTTP/2, viewers must support TLSv1.2 or later, and must support Server Name Indication (SNI). For viewers and CF to use HTTP/3, viewers must support TLSv1.3 and Server Name Indication (SNI). CF supports HTTP/3 connection migration to allow the viewer to switch networks without losing connection. For more information about connection migration, see Connection Migration at RFC 9000. For more information about supported TLSv1.3 ciphers, see Supported protocols and ciphers between viewers and CloudFront.

Link copied to clipboard
val ipv6Enabled: Output<Boolean>? = null

If you want CloudFront to respond to IPv6 DNS requests with an IPv6 address for your distribution, specify `true`. If you specify `false`, CloudFront responds to IPv6 DNS requests with the DNS response code `NOERROR` and with no IP addresses. This allows viewers to submit a second request, for an IPv4 address for your distribution. In general, you should enable IPv6 if you have users on IPv6 networks who want to access your content. However, if you're using signed URLs or signed cookies to restrict access to your content, and if you're using a custom policy that includes the `IpAddress` parameter to restrict the IP addresses that can access your content, don't enable IPv6. If you want to restrict access to some content by IP address and not restrict access to other content (or restrict access but not by IP address), you can create two distributions. For more information, see Creating a Signed URL Using a Custom Policy in the Amazon CloudFront Developer Guide. If you're using an R53AWSIntlong alias resource record set to route traffic to your CloudFront distribution, you need to create a second alias resource record set when both of the following are true:

Link copied to clipboard
val logging: Output<DistributionLoggingArgs>? = null

A complex type that controls whether access logs are written for the distribution. For more information about logging, see Access Logs in the Amazon CloudFront Developer Guide.

Link copied to clipboard

A complex type that contains information about origin groups for this distribution. Specify a value for either the `Origins` or `OriginGroups` property.

Link copied to clipboard
val origins: Output<List<DistributionOriginArgs>>? = null

A complex type that contains information about origins for this distribution. Specify a value for either the `Origins` or `OriginGroups` property.

Link copied to clipboard
val priceClass: Output<String>? = null

The price class that corresponds with the maximum price that you want to pay for CloudFront service. If you specify `PriceClass_All`, CloudFront responds to requests for your objects from all CloudFront edge locations. If you specify a price class other than `PriceClass_All`, CloudFront serves your objects from the CloudFront edge location that has the lowest latency among the edge locations in your price class. Viewers who are in or near regions that are excluded from your specified price class may encounter slower performance. For more information about price classes, see Choosing the Price Class for a CloudFront Distribution in the Amazon CloudFront Developer Guide. For information about CloudFront pricing, including how price classes (such as Price Class 100) map to CloudFront regions, see Amazon CloudFront Pricing.

Link copied to clipboard

A complex type that identifies ways in which you want to restrict distribution of your content.

Link copied to clipboard

The origin as an S3 bucket. This property is legacy. We recommend that you use Origin instead.

Link copied to clipboard
val staging: Output<Boolean>? = null

A Boolean that indicates whether this is a staging distribution. When this value is `true`, this is a staging distribution. When this value is `false`, this is not a staging distribution.

Link copied to clipboard

A distribution tenant configuration.

Link copied to clipboard

A complex type that determines the distribution's SSL/TLS configuration for communicating with viewers.

Link copied to clipboard
val webAclId: Output<String>? = null

A unique identifier that specifies the WAF web ACL, if any, to associate with this distribution. To specify a web ACL created using the latest version of WAF, use the ACL ARN, for example `arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111`. To specify a web ACL created using WAF Classic, use the ACL ID, for example `a1b2c3d4-5678-90ab-cdef-EXAMPLE11111`. WAF is a web application firewall that lets you monitor the HTTP and HTTPS requests that are forwarded to CloudFront, and lets you control access to your content. Based on conditions that you specify, such as the IP addresses that requests originate from or the values of query strings, CloudFront responds to requests either with the requested content or with an HTTP 403 status code (Forbidden). You can also configure CloudFront to return a custom error page when a request is blocked. For more information about WAF, see the Developer Guide.

Functions

Link copied to clipboard
open override fun toJava(): DistributionConfigArgs