Skip to content

/AWS1/CL_FNTDISTRIBUTIONCONFIG

A distribution configuration.

CONSTRUCTOR

IMPORTING

Required arguments:

iv_callerreference TYPE /AWS1/FNTSTRING /AWS1/FNTSTRING

A unique value (for example, a date-time stamp) that ensures that the request can't be replayed.

If the value of CallerReference is new (regardless of the content of the DistributionConfig object), CloudFront creates a new distribution.

If CallerReference is a value that you already sent in a previous request to create a distribution, CloudFront returns a DistributionAlreadyExists error.

io_origins TYPE REF TO /AWS1/CL_FNTORIGINS /AWS1/CL_FNTORIGINS

A complex type that contains information about origins for this distribution.

io_defaultcachebehavior TYPE REF TO /AWS1/CL_FNTDEFAULTCACHEBEHAV /AWS1/CL_FNTDEFAULTCACHEBEHAV

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.

iv_comment TYPE /AWS1/FNTCOMMENTTYPE /AWS1/FNTCOMMENTTYPE

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

iv_enabled TYPE /AWS1/FNTBOOLEAN /AWS1/FNTBOOLEAN

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

Optional arguments:

io_aliases TYPE REF TO /AWS1/CL_FNTALIASES /AWS1/CL_FNTALIASES

This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the Amazon CloudFront Developer Guide.

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

iv_defaultrootobject TYPE /AWS1/FNTSTRING /AWS1/FNTSTRING

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.

io_origingroups TYPE REF TO /AWS1/CL_FNTORIGINGROUPS /AWS1/CL_FNTORIGINGROUPS

A complex type that contains information about origin groups for this distribution.

io_cachebehaviors TYPE REF TO /AWS1/CL_FNTCACHEBEHAVIORS /AWS1/CL_FNTCACHEBEHAVIORS

A complex type that contains zero or more CacheBehavior elements.

io_customerrorresponses TYPE REF TO /AWS1/CL_FNTCUSTOMERRORRSPS /AWS1/CL_FNTCUSTOMERRORRSPS

A complex type that controls the following:

  • Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer.

  • How long CloudFront caches HTTP status codes in the 4xx and 5xx range.

For more information about custom error pages, see Customizing Error Responses in the Amazon CloudFront Developer Guide.

io_logging TYPE REF TO /AWS1/CL_FNTLOGGINGCONFIG /AWS1/CL_FNTLOGGINGCONFIG

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.

iv_priceclass TYPE /AWS1/FNTPRICECLASS /AWS1/FNTPRICECLASS

This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the Amazon CloudFront Developer Guide.

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.

io_viewercertificate TYPE REF TO /AWS1/CL_FNTVIEWERCERTIFICATE /AWS1/CL_FNTVIEWERCERTIFICATE

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

io_restrictions TYPE REF TO /AWS1/CL_FNTRESTRICTIONS /AWS1/CL_FNTRESTRICTIONS

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

iv_webaclid TYPE /AWS1/FNTSTRING /AWS1/FNTSTRING

Multi-tenant distributions only support WAF V2 web ACLs.

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 WAF Developer Guide.

iv_httpversion TYPE /AWS1/FNTHTTPVERSION /AWS1/FNTHTTPVERSION

(Optional) Specify the HTTP version(s) that you want viewers to use to communicate with CloudFront. The default value for new web distributions is http2. Viewers that don't support HTTP/2 automatically use an earlier HTTP version.

For viewers and CloudFront to use HTTP/2, viewers must support TLSv1.2 or later, and must support Server Name Indication (SNI).

For viewers and CloudFront to use HTTP/3, viewers must support TLSv1.3 and Server Name Indication (SNI). CloudFront 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.

iv_isipv6enabled TYPE /AWS1/FNTBOOLEAN /AWS1/FNTBOOLEAN

To use this field for a multi-tenant distribution, use a connection group instead. For more information, see ConnectionGroup.

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 Route 53 Amazon Web Services Integration 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:

  • You enable IPv6 for the distribution

  • You're using alternate domain names in the URLs for your objects

For more information, see Routing Traffic to an Amazon CloudFront Web Distribution by Using Your Domain Name in the Route 53 Amazon Web Services Integration Developer Guide.

If you created a CNAME resource record set, either with Route 53 Amazon Web Services Integration or with another DNS service, you don't need to make any changes. A CNAME record will route traffic to your distribution regardless of the IP address format of the viewer request.

iv_contdeploymentpolicyid TYPE /AWS1/FNTSTRING /AWS1/FNTSTRING

This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the Amazon CloudFront Developer Guide.

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

iv_staging TYPE /AWS1/FNTBOOLEAN /AWS1/FNTBOOLEAN

This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the Amazon CloudFront Developer Guide.

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.

iv_anycastiplistid TYPE /AWS1/FNTSTRING /AWS1/FNTSTRING

To use this field for a multi-tenant distribution, use a connection group instead. For more information, see ConnectionGroup.

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

io_tenantconfig TYPE REF TO /AWS1/CL_FNTTENANTCONFIG /AWS1/CL_FNTTENANTCONFIG

This field only supports multi-tenant distributions. You can't specify this field for standard distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the Amazon CloudFront Developer Guide.

A distribution tenant configuration.

iv_connectionmode TYPE /AWS1/FNTCONNECTIONMODE /AWS1/FNTCONNECTIONMODE

This field specifies whether the connection mode is through a standard distribution (direct) or a multi-tenant distribution with distribution tenants (tenant-only).

Queryable Attributes

CallerReference

A unique value (for example, a date-time stamp) that ensures that the request can't be replayed.

If the value of CallerReference is new (regardless of the content of the DistributionConfig object), CloudFront creates a new distribution.

If CallerReference is a value that you already sent in a previous request to create a distribution, CloudFront returns a DistributionAlreadyExists error.

Accessible with the following methods

Method Description
GET_CALLERREFERENCE() Getter for CALLERREFERENCE, with configurable default
ASK_CALLERREFERENCE() Getter for CALLERREFERENCE w/ exceptions if field has no val
HAS_CALLERREFERENCE() Determine if CALLERREFERENCE has a value

Aliases

This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the Amazon CloudFront Developer Guide.

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

Accessible with the following methods

Method Description
GET_ALIASES() Getter for ALIASES

DefaultRootObject

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.

Accessible with the following methods

Method Description
GET_DEFAULTROOTOBJECT() Getter for DEFAULTROOTOBJECT, with configurable default
ASK_DEFAULTROOTOBJECT() Getter for DEFAULTROOTOBJECT w/ exceptions if field has no v
HAS_DEFAULTROOTOBJECT() Determine if DEFAULTROOTOBJECT has a value

Origins

A complex type that contains information about origins for this distribution.

Accessible with the following methods

Method Description
GET_ORIGINS() Getter for ORIGINS

OriginGroups

A complex type that contains information about origin groups for this distribution.

Accessible with the following methods

Method Description
GET_ORIGINGROUPS() Getter for ORIGINGROUPS

DefaultCacheBehavior

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.

Accessible with the following methods

Method Description
GET_DEFAULTCACHEBEHAVIOR() Getter for DEFAULTCACHEBEHAVIOR

CacheBehaviors

A complex type that contains zero or more CacheBehavior elements.

Accessible with the following methods

Method Description
GET_CACHEBEHAVIORS() Getter for CACHEBEHAVIORS

CustomErrorResponses

A complex type that controls the following:

  • Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer.

  • How long CloudFront caches HTTP status codes in the 4xx and 5xx range.

For more information about custom error pages, see Customizing Error Responses in the Amazon CloudFront Developer Guide.

Accessible with the following methods

Method Description
GET_CUSTOMERRORRESPONSES() Getter for CUSTOMERRORRESPONSES

Comment

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

Accessible with the following methods

Method Description
GET_COMMENT() Getter for COMMENT, with configurable default
ASK_COMMENT() Getter for COMMENT w/ exceptions if field has no value
HAS_COMMENT() Determine if COMMENT has a value

Logging

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.

Accessible with the following methods

Method Description
GET_LOGGING() Getter for LOGGING

PriceClass

This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the Amazon CloudFront Developer Guide.

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.

Accessible with the following methods

Method Description
GET_PRICECLASS() Getter for PRICECLASS, with configurable default
ASK_PRICECLASS() Getter for PRICECLASS w/ exceptions if field has no value
HAS_PRICECLASS() Determine if PRICECLASS has a value

Enabled

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

Accessible with the following methods

Method Description
GET_ENABLED() Getter for ENABLED, with configurable default
ASK_ENABLED() Getter for ENABLED w/ exceptions if field has no value
HAS_ENABLED() Determine if ENABLED has a value

ViewerCertificate

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

Accessible with the following methods

Method Description
GET_VIEWERCERTIFICATE() Getter for VIEWERCERTIFICATE

Restrictions

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

Accessible with the following methods

Method Description
GET_RESTRICTIONS() Getter for RESTRICTIONS

WebACLId

Multi-tenant distributions only support WAF V2 web ACLs.

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 WAF Developer Guide.

Accessible with the following methods

Method Description
GET_WEBACLID() Getter for WEBACLID, with configurable default
ASK_WEBACLID() Getter for WEBACLID w/ exceptions if field has no value
HAS_WEBACLID() Determine if WEBACLID has a value

HttpVersion

(Optional) Specify the HTTP version(s) that you want viewers to use to communicate with CloudFront. The default value for new web distributions is http2. Viewers that don't support HTTP/2 automatically use an earlier HTTP version.

For viewers and CloudFront to use HTTP/2, viewers must support TLSv1.2 or later, and must support Server Name Indication (SNI).

For viewers and CloudFront to use HTTP/3, viewers must support TLSv1.3 and Server Name Indication (SNI). CloudFront 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.

Accessible with the following methods

Method Description
GET_HTTPVERSION() Getter for HTTPVERSION, with configurable default
ASK_HTTPVERSION() Getter for HTTPVERSION w/ exceptions if field has no value
HAS_HTTPVERSION() Determine if HTTPVERSION has a value

IsIPV6Enabled

To use this field for a multi-tenant distribution, use a connection group instead. For more information, see ConnectionGroup.

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 Route 53 Amazon Web Services Integration 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:

  • You enable IPv6 for the distribution

  • You're using alternate domain names in the URLs for your objects

For more information, see Routing Traffic to an Amazon CloudFront Web Distribution by Using Your Domain Name in the Route 53 Amazon Web Services Integration Developer Guide.

If you created a CNAME resource record set, either with Route 53 Amazon Web Services Integration or with another DNS service, you don't need to make any changes. A CNAME record will route traffic to your distribution regardless of the IP address format of the viewer request.

Accessible with the following methods

Method Description
GET_ISIPV6ENABLED() Getter for ISIPV6ENABLED, with configurable default
ASK_ISIPV6ENABLED() Getter for ISIPV6ENABLED w/ exceptions if field has no value
HAS_ISIPV6ENABLED() Determine if ISIPV6ENABLED has a value

ContinuousDeploymentPolicyId

This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the Amazon CloudFront Developer Guide.

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

Accessible with the following methods

Method Description
GET_CONTDEPLOYMENTPOLICYID() Getter for CONTINUOUSDEPLOYMENTPOLICYID, with configurable d
ASK_CONTDEPLOYMENTPOLICYID() Getter for CONTINUOUSDEPLOYMENTPOLICYID w/ exceptions if fie
HAS_CONTDEPLOYMENTPOLICYID() Determine if CONTINUOUSDEPLOYMENTPOLICYID has a value

Staging

This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the Amazon CloudFront Developer Guide.

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.

Accessible with the following methods

Method Description
GET_STAGING() Getter for STAGING, with configurable default
ASK_STAGING() Getter for STAGING w/ exceptions if field has no value
HAS_STAGING() Determine if STAGING has a value

AnycastIpListId

To use this field for a multi-tenant distribution, use a connection group instead. For more information, see ConnectionGroup.

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

Accessible with the following methods

Method Description
GET_ANYCASTIPLISTID() Getter for ANYCASTIPLISTID, with configurable default
ASK_ANYCASTIPLISTID() Getter for ANYCASTIPLISTID w/ exceptions if field has no val
HAS_ANYCASTIPLISTID() Determine if ANYCASTIPLISTID has a value

TenantConfig

This field only supports multi-tenant distributions. You can't specify this field for standard distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the Amazon CloudFront Developer Guide.

A distribution tenant configuration.

Accessible with the following methods

Method Description
GET_TENANTCONFIG() Getter for TENANTCONFIG

ConnectionMode

This field specifies whether the connection mode is through a standard distribution (direct) or a multi-tenant distribution with distribution tenants (tenant-only).

Accessible with the following methods

Method Description
GET_CONNECTIONMODE() Getter for CONNECTIONMODE, with configurable default
ASK_CONNECTIONMODE() Getter for CONNECTIONMODE w/ exceptions if field has no valu
HAS_CONNECTIONMODE() Determine if CONNECTIONMODE has a value