Skip to content

DistributionSummary

Source code in docs_src/capo_cloudfront/types/distribution_summary.py
class DistributionSummary(TypedDict, closed=True):
    id: "capo_cloudfront.types.string.string"
    """<p>The identifier for the distribution. For example: <code>EDFDVBD632BHDS5</code>.</p>"""
    arn: "capo_cloudfront.types.string.string"
    """<p>The ARN (Amazon Resource Name) for the distribution. For example: <code>arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5</code>, where <code>123456789012</code> is your Amazon Web Services account ID.</p>"""
    e_tag: NotRequired["capo_cloudfront.types.string.string"]
    """<p>The current version of the distribution.</p>"""
    status: "capo_cloudfront.types.string.string"
    """<p>The current status of the distribution. When the status is <code>Deployed</code>, the distribution's information is propagated to all CloudFront edge locations.</p>"""
    last_modified_time: "capo_cloudfront.types.timestamp.timestamp"
    """<p>The date and time the distribution was last modified.</p>"""
    domain_name: "capo_cloudfront.types.string.string"
    """<p>The domain name that corresponds to the distribution, for example, <code>d111111abcdef8.cloudfront.net</code>.</p>"""
    aliases: "capo_cloudfront.types.aliases.Aliases"
    """<p>A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.</p>"""
    origins: "capo_cloudfront.types.origins.Origins"
    """<p>A complex type that contains information about origins for this distribution.</p>"""
    origin_groups: NotRequired["capo_cloudfront.types.origin_groups.OriginGroups"]
    """<p>A complex type that contains information about origin groups for this distribution.</p>"""
    default_cache_behavior: (
        "capo_cloudfront.types.default_cache_behavior.DefaultCacheBehavior"
    )
    """<p>A complex type that describes the default cache behavior if you don't specify a <code>CacheBehavior</code> element or if files don't match any of the values of <code>PathPattern</code> in <code>CacheBehavior</code> elements. You must create exactly one default cache behavior.</p>"""
    cache_behaviors: "capo_cloudfront.types.cache_behaviors.CacheBehaviors"
    """<p>A complex type that contains zero or more <code>CacheBehavior</code> elements.</p>"""
    custom_error_responses: (
        "capo_cloudfront.types.custom_error_responses.CustomErrorResponses"
    )
    """<p>A complex type that contains zero or more <code>CustomErrorResponses</code> elements.</p>"""
    comment: "capo_cloudfront.types.sensitive_string_type.sensitiveStringType"
    """<p>The comment originally specified when this distribution was created.</p>"""
    price_class: "capo_cloudfront.types.price_class.PriceClass"
    """<note> <p>This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-config-options.html#unsupported-saas">Unsupported features for SaaS Manager for Amazon CloudFront</a> in the <i>Amazon CloudFront Developer Guide</i>.</p> </note> <p>A complex type that contains information about price class for this streaming distribution.</p>"""
    enabled: "capo_cloudfront.types.boolean.boolean"
    """<p>Whether the distribution is enabled to accept user requests for content.</p>"""
    viewer_certificate: "capo_cloudfront.types.viewer_certificate.ViewerCertificate"
    """<p>A complex type that determines the distribution's SSL/TLS configuration for communicating with viewers.</p>"""
    restrictions: "capo_cloudfront.types.restrictions.Restrictions"
    """<p>A complex type that identifies ways in which you want to restrict distribution of your content.</p>"""
    web_acl_id: "capo_cloudfront.types.string.string"
    """<p>The Web ACL Id (if any) associated with the distribution.</p>"""
    http_version: "capo_cloudfront.types.http_version.HttpVersion"
    """<p>Specify the maximum HTTP version that you want viewers to use to communicate with CloudFront. The default value for new web distributions is <code>http2</code>. Viewers that don't support <code>HTTP/2</code> will automatically use an earlier version.</p>"""
    is_ipv6_enabled: "capo_cloudfront.types.boolean.boolean"
    """<p>Whether CloudFront responds to IPv6 DNS requests with an IPv6 address for your distribution.</p>"""
    alias_icp_recordals: NotRequired[
        "capo_cloudfront.types.alias_icp_recordals.AliasICPRecordals"
    ]
    """<p>Amazon Web Services services in China customers must file for an Internet Content Provider (ICP) recordal if they want to serve content publicly on an alternate domain name, also known as a CNAME, that they've added to CloudFront. AliasICPRecordal provides the ICP recordal status for CNAMEs associated with distributions.</p> <p>For more information about ICP recordals, see <a href="https://docs.amazonaws.cn/en_us/aws/latest/userguide/accounts-and-credentials.html"> Signup, Accounts, and Credentials</a> in <i>Getting Started with Amazon Web Services services in China</i>.</p>"""
    staging: "capo_cloudfront.types.boolean.boolean"
    """<p>A Boolean that indicates whether this is a staging distribution. When this value is <code>true</code>, this is a staging distribution. When this value is <code>false</code>, this is not a staging distribution.</p>"""
    connection_mode: NotRequired["capo_cloudfront.types.connection_mode.ConnectionMode"]
    """<p>This field specifies whether the connection mode is through a standard distribution (direct) or a multi-tenant distribution with distribution tenants (tenant-only).</p>"""
    anycast_ip_list_id: NotRequired["capo_cloudfront.types.string.string"]
    """<p>ID of the Anycast static IP list that is associated with the distribution.</p>"""
    viewer_mtls_config: NotRequired[
        "capo_cloudfront.types.viewer_mtls_config.ViewerMtlsConfig"
    ]
    """<p>The distribution's viewer mTLS configuration.</p>"""
    connection_function_association: NotRequired[
        "capo_cloudfront.types.connection_function_association.ConnectionFunctionAssociation"
    ]
    """<p>The distribution's connection function association.</p>"""

alias_icp_recordals instance-attribute

alias_icp_recordals: NotRequired[AliasICPRecordals]

Amazon Web Services services in China customers must file for an Internet Content Provider (ICP) recordal if they want to serve content publicly on an alternate domain name, also known as a CNAME, that they've added to CloudFront. AliasICPRecordal provides the ICP recordal status for CNAMEs associated with distributions.

For more information about ICP recordals, see Signup, Accounts, and Credentials in Getting Started with Amazon Web Services services in China.

aliases instance-attribute

aliases: Aliases

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

anycast_ip_list_id instance-attribute

anycast_ip_list_id: NotRequired[string]

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

arn instance-attribute

arn: string

The ARN (Amazon Resource Name) for the distribution. For example: arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5, where 123456789012 is your Amazon Web Services account ID.

cache_behaviors instance-attribute

cache_behaviors: CacheBehaviors

A complex type that contains zero or more CacheBehavior elements.

comment instance-attribute

The comment originally specified when this distribution was created.

connection_function_association instance-attribute

connection_function_association: NotRequired[ConnectionFunctionAssociation]

The distribution's connection function association.

connection_mode instance-attribute

connection_mode: NotRequired[ConnectionMode]

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

custom_error_responses instance-attribute

custom_error_responses: CustomErrorResponses

A complex type that contains zero or more CustomErrorResponses elements.

default_cache_behavior instance-attribute

default_cache_behavior: 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.

domain_name instance-attribute

domain_name: string

The domain name that corresponds to the distribution, for example, d111111abcdef8.cloudfront.net.

e_tag instance-attribute

e_tag: NotRequired[string]

The current version of the distribution.

enabled instance-attribute

enabled: boolean

Whether the distribution is enabled to accept user requests for content.

http_version instance-attribute

http_version: HttpVersion

Specify the maximum HTTP version 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 will automatically use an earlier version.

id instance-attribute

id: string

The identifier for the distribution. For example: EDFDVBD632BHDS5.

is_ipv6_enabled instance-attribute

is_ipv6_enabled: boolean

Whether CloudFront responds to IPv6 DNS requests with an IPv6 address for your distribution.

last_modified_time instance-attribute

last_modified_time: timestamp

The date and time the distribution was last modified.

origin_groups instance-attribute

origin_groups: NotRequired[OriginGroups]

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

origins instance-attribute

origins: Origins

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

price_class instance-attribute

price_class: 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.

A complex type that contains information about price class for this streaming distribution.

restrictions instance-attribute

restrictions: Restrictions

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

staging instance-attribute

staging: boolean

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.

status instance-attribute

status: string

The current status of the distribution. When the status is Deployed, the distribution's information is propagated to all CloudFront edge locations.

viewer_certificate instance-attribute

viewer_certificate: ViewerCertificate

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

viewer_mtls_config instance-attribute

viewer_mtls_config: NotRequired[ViewerMtlsConfig]

The distribution's viewer mTLS configuration.

web_acl_id instance-attribute

web_acl_id: string

The Web ACL Id (if any) associated with the distribution.