Amazon CloudFront

2026/11/19 - Amazon CloudFront - 11 updated api methods

Changes  Amazon CloudFront adds configuration for SNI-less clients on Anycast static IPs, introduces Anycast IP based domain routing for Distribution Tenants, provides automatic domain ownership validation when creating or updating Distribution Tenants, and enables HTTP traffic via DNS validation.

CreateConnectionGroup (updated) Link ¶
Changes (request, response)
Request
{'ViewerFallback': {'DistributionId': 'string'}}
Response
{'ConnectionGroup': {'ViewerFallback': {'DistributionId': 'string'}}}

Creates a connection group.

See also: AWS API Documentation

Request Syntax

client.create_connection_group(
    Name='string',
    Ipv6Enabled=True|False,
    Tags={
        'Items': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    },
    AnycastIpListId='string',
    Enabled=True|False,
    ViewerFallback={
        'DistributionId': 'string'
    }
)
type Name:

string

param Name:

[REQUIRED]

The name of the connection group. Enter a friendly identifier that is unique within your Amazon Web Services account. This name can't be updated after you create the connection group.

type Ipv6Enabled:

boolean

param Ipv6Enabled:

Enable IPv6 for the connection group. The default is true. For more information, see Enable IPv6 in the Amazon CloudFront Developer Guide.

type Tags:

dict

param Tags:

A complex type that contains zero or more Tag elements.

  • Items (list) --

    A complex type that contains Tag elements.

    • (dict) --

      A complex type that contains Tag key and Tag value.

      • Key (string) -- [REQUIRED]

        A string that contains Tag key.

        The string length should be between 1 and 128 characters. Valid characters include a-z, A-Z, 0-9, space, and the special characters _ - . : / = + @.

      • Value (string) --

        A string that contains an optional Tag value.

        The string length should be between 0 and 256 characters. Valid characters include a-z, A-Z, 0-9, space, and the special characters _ - . : / = + @.

type AnycastIpListId:

string

param AnycastIpListId:

The ID of the Anycast static IP list.

type Enabled:

boolean

param Enabled:

Enable the connection group.

type ViewerFallback:

dict

param ViewerFallback:

The distribution whose certificate CloudFront uses for viewer requests that arrive on the connection group's Anycast static IPs without Server Name Indication (SNI).

  • DistributionId (string) --

    The ID of the distribution whose certificate CloudFront uses to establish TLS connections for viewer requests that don't include SNI.

rtype:

dict

returns:

Response Syntax

{
    'ConnectionGroup': {
        'Id': 'string',
        'Name': 'string',
        'Arn': 'string',
        'CreatedTime': datetime(2015, 1, 1),
        'LastModifiedTime': datetime(2015, 1, 1),
        'Tags': {
            'Items': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
        'Ipv6Enabled': True|False,
        'RoutingEndpoint': 'string',
        'AnycastIpListId': 'string',
        'Status': 'string',
        'Enabled': True|False,
        'IsDefault': True|False,
        'ViewerFallback': {
            'DistributionId': 'string'
        }
    },
    'ETag': 'string'
}

Response Structure

  • (dict) --

    • ConnectionGroup (dict) --

      The connection group that you created.

      • Id (string) --

        The ID of the connection group.

      • Name (string) --

        The name of the connection group.

      • Arn (string) --

        The Amazon Resource Name (ARN) of the connection group.

      • CreatedTime (datetime) --

        The date and time when the connection group was created.

      • LastModifiedTime (datetime) --

        The date and time when the connection group was updated.

      • Tags (dict) --

        A complex type that contains zero or more Tag elements.

        • Items (list) --

          A complex type that contains Tag elements.

          • (dict) --

            A complex type that contains Tag key and Tag value.

            • Key (string) --

              A string that contains Tag key.

              The string length should be between 1 and 128 characters. Valid characters include a-z, A-Z, 0-9, space, and the special characters _ - . : / = + @.

            • Value (string) --

              A string that contains an optional Tag value.

              The string length should be between 0 and 256 characters. Valid characters include a-z, A-Z, 0-9, space, and the special characters _ - . : / = + @.

      • Ipv6Enabled (boolean) --

        IPv6 is enabled for the connection group.

      • RoutingEndpoint (string) --

        The routing endpoint (also known as the DNS name) that is assigned to the connection group, such as d111111abcdef8.cloudfront.net.

      • AnycastIpListId (string) --

        The ID of the Anycast static IP list.

      • Status (string) --

        The status of the connection group.

      • Enabled (boolean) --

        Whether the connection group is enabled.

      • IsDefault (boolean) --

        Whether the connection group is the default connection group for the distribution tenants.

      • ViewerFallback (dict) --

        The distribution whose certificate CloudFront uses for viewer requests that arrive on the connection group's Anycast static IPs without Server Name Indication (SNI).

        • DistributionId (string) --

          The ID of the distribution whose certificate CloudFront uses to establish TLS connections for viewer requests that don't include SNI.

    • ETag (string) --

      The current version of the connection group.

CreateDistributionTenant (updated) Link ¶
Changes (request, response)
Request
{'Domains': {'ServeOn': 'any | anycast-ip-list-only'},
 'OnDomainTakeover': 'allow | reject'}
Response
{'DistributionTenant': {'Domains': {'ServeOn': 'any | anycast-ip-list-only'}}}

Creates a distribution tenant.

See also: AWS API Documentation

Request Syntax

client.create_distribution_tenant(
    DistributionId='string',
    Name='string',
    Domains=[
        {
            'Domain': 'string',
            'ServeOn': 'any'|'anycast-ip-list-only'
        },
    ],
    Tags={
        'Items': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    },
    Customizations={
        'WebAcl': {
            'Action': 'override'|'disable',
            'Arn': 'string'
        },
        'Certificate': {
            'Arn': 'string'
        },
        'GeoRestrictions': {
            'RestrictionType': 'blacklist'|'whitelist'|'none',
            'Locations': [
                'string',
            ]
        }
    },
    Parameters=[
        {
            'Name': 'string',
            'Value': 'string'
        },
    ],
    ConnectionGroupId='string',
    ManagedCertificateRequest={
        'ValidationTokenHost': 'cloudfront'|'self-hosted',
        'PrimaryDomainName': 'string',
        'CertificateTransparencyLoggingPreference': 'enabled'|'disabled'
    },
    Enabled=True|False,
    OnDomainTakeover='allow'|'reject'
)
type DistributionId:

string

param DistributionId:

[REQUIRED]

The ID of the multi-tenant distribution to use for creating the distribution tenant.

type Name:

string

param Name:

[REQUIRED]

The name of the distribution tenant. Enter a friendly identifier that is unique within your Amazon Web Services account. This name can't be updated after you create the distribution tenant.

type Domains:

list

param Domains:

[REQUIRED]

The domains associated with the distribution tenant. You must specify at least one domain in the request.

  • (dict) --

    The domain for the specified distribution tenant.

    • Domain (string) -- [REQUIRED]

      The domain name.

    • ServeOn (string) --

      Specifies which requests for this domain CloudFront routes to the distribution tenant. Valid values are:

      • any – CloudFront routes requests for this domain to the distribution tenant regardless of the IP address that they arrive on. This is the default if you don't specify a value.

      • anycast-ip-list-only – CloudFront routes requests for this domain to the distribution tenant only when they arrive on the Anycast static IPs of the distribution tenant's connection group. CloudFront treats requests that arrive on other IP addresses as requests for an unknown domain.

type Tags:

dict

param Tags:

A complex type that contains zero or more Tag elements.

  • Items (list) --

    A complex type that contains Tag elements.

    • (dict) --

      A complex type that contains Tag key and Tag value.

      • Key (string) -- [REQUIRED]

        A string that contains Tag key.

        The string length should be between 1 and 128 characters. Valid characters include a-z, A-Z, 0-9, space, and the special characters _ - . : / = + @.

      • Value (string) --

        A string that contains an optional Tag value.

        The string length should be between 0 and 256 characters. Valid characters include a-z, A-Z, 0-9, space, and the special characters _ - . : / = + @.

type Customizations:

dict

param Customizations:

Customizations for the distribution tenant. For each distribution tenant, you can specify the geographic restrictions, and the Amazon Resource Names (ARNs) for the ACM certificate and WAF web ACL. These are specific values that you can override or disable from the multi-tenant distribution that was used to create the distribution tenant.

  • WebAcl (dict) --

    The WAF web ACL.

    • Action (string) -- [REQUIRED]

      The action for the WAF web ACL customization. You can specify override to specify a separate WAF web ACL for the distribution tenant. If you specify disable, the distribution tenant won't have WAF web ACL protections and won't inherit from the multi-tenant distribution.

    • Arn (string) --

      The Amazon Resource Name (ARN) of the WAF web ACL.

  • Certificate (dict) --

    The Certificate Manager (ACM) certificate.

    • Arn (string) -- [REQUIRED]

      The Amazon Resource Name (ARN) of the ACM certificate.

  • GeoRestrictions (dict) --

    The geographic restrictions.

    • RestrictionType (string) -- [REQUIRED]

      The method that you want to use to restrict distribution of your content by country:

      • none: No geographic restriction is enabled, meaning access to content is not restricted by client geo location.

      • blacklist: The Location elements specify the countries in which you don't want CloudFront to distribute your content.

      • whitelist: The Location elements specify the countries in which you want CloudFront to distribute your content.

    • Locations (list) --

      The locations for geographic restrictions.

      • (string) --

type Parameters:

list

param Parameters:

A list of parameter values to add to the resource. A parameter is specified as a key-value pair. A valid parameter value must exist for any parameter that is marked as required in the multi-tenant distribution.

  • (dict) --

    A list of parameter values to add to the resource. A parameter is specified as a key-value pair. A valid parameter value must exist for any parameter that is marked as required in the multi-tenant distribution.

    • Name (string) -- [REQUIRED]

      The parameter name.

    • Value (string) -- [REQUIRED]

      The parameter value.

type ConnectionGroupId:

string

param ConnectionGroupId:

The ID of the connection group to associate with the distribution tenant.

type ManagedCertificateRequest:

dict

param ManagedCertificateRequest:

The configuration for the CloudFront managed ACM certificate request.

  • ValidationTokenHost (string) -- [REQUIRED]

    Specify how the HTTP validation token will be served when requesting the CloudFront managed ACM certificate.

    • For cloudfront, CloudFront will automatically serve the validation token. Choose this mode if you can point the domain's DNS to CloudFront immediately.

    • For self-hosted, you serve the validation token from your existing infrastructure. Choose this mode when you need to maintain current traffic flow while your certificate is being issued. You can place the validation token at the well-known path on your existing web server, wait for ACM to validate and issue the certificate, and then update your DNS to point to CloudFront.

  • PrimaryDomainName (string) --

    The primary domain name associated with the CloudFront managed ACM certificate.

  • CertificateTransparencyLoggingPreference (string) --

    You can opt out of certificate transparency logging by specifying the disabled option. Opt in by specifying enabled. For more information, see Certificate Transparency Logging in the Certificate Manager User Guide.

type Enabled:

boolean

param Enabled:

Indicates whether the distribution tenant should be enabled when created. If the distribution tenant is disabled, the distribution tenant won't serve traffic.

type OnDomainTakeover:

string

param OnDomainTakeover:

Specifies whether CloudFront moves a domain in this request to this distribution tenant when the domain is already associated with another standard distribution or distribution tenant. Valid values are:

  • allow – CloudFront moves the domain to this distribution tenant when the domain's DNS points to this distribution tenant.

  • reject – CloudFront doesn't move the domain, and the request fails if the domain is associated with another resource. This is the default if you don't specify a value.

rtype:

dict

returns:

Response Syntax

{
    'DistributionTenant': {
        'Id': 'string',
        'DistributionId': 'string',
        'Name': 'string',
        'Arn': 'string',
        'Domains': [
            {
                'Domain': 'string',
                'Status': 'active'|'inactive',
                'ServeOn': 'any'|'anycast-ip-list-only'
            },
        ],
        'Tags': {
            'Items': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
        'Customizations': {
            'WebAcl': {
                'Action': 'override'|'disable',
                'Arn': 'string'
            },
            'Certificate': {
                'Arn': 'string'
            },
            'GeoRestrictions': {
                'RestrictionType': 'blacklist'|'whitelist'|'none',
                'Locations': [
                    'string',
                ]
            }
        },
        'Parameters': [
            {
                'Name': 'string',
                'Value': 'string'
            },
        ],
        'ConnectionGroupId': 'string',
        'CreatedTime': datetime(2015, 1, 1),
        'LastModifiedTime': datetime(2015, 1, 1),
        'Enabled': True|False,
        'Status': 'string'
    },
    'ETag': 'string'
}

Response Structure

  • (dict) --

    • DistributionTenant (dict) --

      The distribution tenant that you created.

      • Id (string) --

        The ID of the distribution tenant.

      • DistributionId (string) --

        The ID of the multi-tenant distribution.

      • Name (string) --

        The name of the distribution tenant.

      • Arn (string) --

        The Amazon Resource Name (ARN) of the distribution tenant.

      • Domains (list) --

        The domains associated with the distribution tenant.

        • (dict) --

          The details about the domain result.

          • Domain (string) --

            The specified domain.

          • Status (string) --

            Whether the domain is active or inactive.

          • ServeOn (string) --

            Specifies which requests for this domain CloudFront routes to the distribution tenant. Valid values are:

            • any – CloudFront routes requests for this domain to the distribution tenant regardless of the IP address that they arrive on. This is the default if you don't specify a value.

            • anycast-ip-list-only – CloudFront routes requests for this domain to the distribution tenant only when they arrive on the Anycast static IPs of the distribution tenant's connection group. CloudFront treats requests that arrive on other IP addresses as requests for an unknown domain.

      • Tags (dict) --

        A complex type that contains zero or more Tag elements.

        • Items (list) --

          A complex type that contains Tag elements.

          • (dict) --

            A complex type that contains Tag key and Tag value.

            • Key (string) --

              A string that contains Tag key.

              The string length should be between 1 and 128 characters. Valid characters include a-z, A-Z, 0-9, space, and the special characters _ - . : / = + @.

            • Value (string) --

              A string that contains an optional Tag value.

              The string length should be between 0 and 256 characters. Valid characters include a-z, A-Z, 0-9, space, and the special characters _ - . : / = + @.

      • Customizations (dict) --

        Customizations for the distribution tenant. For each distribution tenant, you can specify the geographic restrictions, and the Amazon Resource Names (ARNs) for the ACM certificate and WAF web ACL. These are specific values that you can override or disable from the multi-tenant distribution that was used to create the distribution tenant.

        • WebAcl (dict) --

          The WAF web ACL.

          • Action (string) --

            The action for the WAF web ACL customization. You can specify override to specify a separate WAF web ACL for the distribution tenant. If you specify disable, the distribution tenant won't have WAF web ACL protections and won't inherit from the multi-tenant distribution.

          • Arn (string) --

            The Amazon Resource Name (ARN) of the WAF web ACL.

        • Certificate (dict) --

          The Certificate Manager (ACM) certificate.

          • Arn (string) --

            The Amazon Resource Name (ARN) of the ACM certificate.

        • GeoRestrictions (dict) --

          The geographic restrictions.

          • RestrictionType (string) --

            The method that you want to use to restrict distribution of your content by country:

            • none: No geographic restriction is enabled, meaning access to content is not restricted by client geo location.

            • blacklist: The Location elements specify the countries in which you don't want CloudFront to distribute your content.

            • whitelist: The Location elements specify the countries in which you want CloudFront to distribute your content.

          • Locations (list) --

            The locations for geographic restrictions.

            • (string) --

      • Parameters (list) --

        A list of parameter values to add to the resource. A parameter is specified as a key-value pair. A valid parameter value must exist for any parameter that is marked as required in the multi-tenant distribution.

        • (dict) --

          A list of parameter values to add to the resource. A parameter is specified as a key-value pair. A valid parameter value must exist for any parameter that is marked as required in the multi-tenant distribution.

          • Name (string) --

            The parameter name.

          • Value (string) --

            The parameter value.

      • ConnectionGroupId (string) --

        The ID of the connection group for the distribution tenant. If you don't specify a connection group, CloudFront uses the default connection group.

      • CreatedTime (datetime) --

        The date and time when the distribution tenant was created.

      • LastModifiedTime (datetime) --

        The date and time when the distribution tenant was updated.

      • Enabled (boolean) --

        Indicates whether the distribution tenant is in an enabled state. If disabled, the distribution tenant won't serve traffic.

      • Status (string) --

        The status of the distribution tenant.

    • ETag (string) --

      The current version of the distribution tenant.

GetConnectionGroup (updated) Link ¶
Changes (response)
{'ConnectionGroup': {'ViewerFallback': {'DistributionId': 'string'}}}

Gets information about a connection group.

See also: AWS API Documentation

Request Syntax

client.get_connection_group(
    Identifier='string'
)
type Identifier:

string

param Identifier:

[REQUIRED]

The ID, name, or Amazon Resource Name (ARN) of the connection group.

rtype:

dict

returns:

Response Syntax

{
    'ConnectionGroup': {
        'Id': 'string',
        'Name': 'string',
        'Arn': 'string',
        'CreatedTime': datetime(2015, 1, 1),
        'LastModifiedTime': datetime(2015, 1, 1),
        'Tags': {
            'Items': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
        'Ipv6Enabled': True|False,
        'RoutingEndpoint': 'string',
        'AnycastIpListId': 'string',
        'Status': 'string',
        'Enabled': True|False,
        'IsDefault': True|False,
        'ViewerFallback': {
            'DistributionId': 'string'
        }
    },
    'ETag': 'string'
}

Response Structure

  • (dict) --

    • ConnectionGroup (dict) --

      The connection group that you retrieved.

      • Id (string) --

        The ID of the connection group.

      • Name (string) --

        The name of the connection group.

      • Arn (string) --

        The Amazon Resource Name (ARN) of the connection group.

      • CreatedTime (datetime) --

        The date and time when the connection group was created.

      • LastModifiedTime (datetime) --

        The date and time when the connection group was updated.

      • Tags (dict) --

        A complex type that contains zero or more Tag elements.

        • Items (list) --

          A complex type that contains Tag elements.

          • (dict) --

            A complex type that contains Tag key and Tag value.

            • Key (string) --

              A string that contains Tag key.

              The string length should be between 1 and 128 characters. Valid characters include a-z, A-Z, 0-9, space, and the special characters _ - . : / = + @.

            • Value (string) --

              A string that contains an optional Tag value.

              The string length should be between 0 and 256 characters. Valid characters include a-z, A-Z, 0-9, space, and the special characters _ - . : / = + @.

      • Ipv6Enabled (boolean) --

        IPv6 is enabled for the connection group.

      • RoutingEndpoint (string) --

        The routing endpoint (also known as the DNS name) that is assigned to the connection group, such as d111111abcdef8.cloudfront.net.

      • AnycastIpListId (string) --

        The ID of the Anycast static IP list.

      • Status (string) --

        The status of the connection group.

      • Enabled (boolean) --

        Whether the connection group is enabled.

      • IsDefault (boolean) --

        Whether the connection group is the default connection group for the distribution tenants.

      • ViewerFallback (dict) --

        The distribution whose certificate CloudFront uses for viewer requests that arrive on the connection group's Anycast static IPs without Server Name Indication (SNI).

        • DistributionId (string) --

          The ID of the distribution whose certificate CloudFront uses to establish TLS connections for viewer requests that don't include SNI.

    • ETag (string) --

      The current version of the connection group.

GetConnectionGroupByRoutingEndpoint (updated) Link ¶
Changes (response)
{'ConnectionGroup': {'ViewerFallback': {'DistributionId': 'string'}}}

Gets information about a connection group by using the endpoint that you specify.

See also: AWS API Documentation

Request Syntax

client.get_connection_group_by_routing_endpoint(
    RoutingEndpoint='string'
)
type RoutingEndpoint:

string

param RoutingEndpoint:

[REQUIRED]

The routing endpoint for the target connection group, such as d111111abcdef8.cloudfront.net.

rtype:

dict

returns:

Response Syntax

{
    'ConnectionGroup': {
        'Id': 'string',
        'Name': 'string',
        'Arn': 'string',
        'CreatedTime': datetime(2015, 1, 1),
        'LastModifiedTime': datetime(2015, 1, 1),
        'Tags': {
            'Items': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
        'Ipv6Enabled': True|False,
        'RoutingEndpoint': 'string',
        'AnycastIpListId': 'string',
        'Status': 'string',
        'Enabled': True|False,
        'IsDefault': True|False,
        'ViewerFallback': {
            'DistributionId': 'string'
        }
    },
    'ETag': 'string'
}

Response Structure

  • (dict) --

    • ConnectionGroup (dict) --

      The connection group for your distribution tenants. When you first create a distribution tenant and you don't specify a connection group, CloudFront will automatically create a default connection group for you. When you create a new distribution tenant and don't specify a connection group, the default one will be associated with your distribution tenant.

      • Id (string) --

        The ID of the connection group.

      • Name (string) --

        The name of the connection group.

      • Arn (string) --

        The Amazon Resource Name (ARN) of the connection group.

      • CreatedTime (datetime) --

        The date and time when the connection group was created.

      • LastModifiedTime (datetime) --

        The date and time when the connection group was updated.

      • Tags (dict) --

        A complex type that contains zero or more Tag elements.

        • Items (list) --

          A complex type that contains Tag elements.

          • (dict) --

            A complex type that contains Tag key and Tag value.

            • Key (string) --

              A string that contains Tag key.

              The string length should be between 1 and 128 characters. Valid characters include a-z, A-Z, 0-9, space, and the special characters _ - . : / = + @.

            • Value (string) --

              A string that contains an optional Tag value.

              The string length should be between 0 and 256 characters. Valid characters include a-z, A-Z, 0-9, space, and the special characters _ - . : / = + @.

      • Ipv6Enabled (boolean) --

        IPv6 is enabled for the connection group.

      • RoutingEndpoint (string) --

        The routing endpoint (also known as the DNS name) that is assigned to the connection group, such as d111111abcdef8.cloudfront.net.

      • AnycastIpListId (string) --

        The ID of the Anycast static IP list.

      • Status (string) --

        The status of the connection group.

      • Enabled (boolean) --

        Whether the connection group is enabled.

      • IsDefault (boolean) --

        Whether the connection group is the default connection group for the distribution tenants.

      • ViewerFallback (dict) --

        The distribution whose certificate CloudFront uses for viewer requests that arrive on the connection group's Anycast static IPs without Server Name Indication (SNI).

        • DistributionId (string) --

          The ID of the distribution whose certificate CloudFront uses to establish TLS connections for viewer requests that don't include SNI.

    • ETag (string) --

      The current version of the connection group.

GetDistributionTenant (updated) Link ¶
Changes (response)
{'DistributionTenant': {'Domains': {'ServeOn': 'any | anycast-ip-list-only'}}}

Gets information about a distribution tenant.

See also: AWS API Documentation

Request Syntax

client.get_distribution_tenant(
    Identifier='string'
)
type Identifier:

string

param Identifier:

[REQUIRED]

The identifier of the distribution tenant. You can specify the ARN, ID, or name of the distribution tenant.

rtype:

dict

returns:

Response Syntax

{
    'DistributionTenant': {
        'Id': 'string',
        'DistributionId': 'string',
        'Name': 'string',
        'Arn': 'string',
        'Domains': [
            {
                'Domain': 'string',
                'Status': 'active'|'inactive',
                'ServeOn': 'any'|'anycast-ip-list-only'
            },
        ],
        'Tags': {
            'Items': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
        'Customizations': {
            'WebAcl': {
                'Action': 'override'|'disable',
                'Arn': 'string'
            },
            'Certificate': {
                'Arn': 'string'
            },
            'GeoRestrictions': {
                'RestrictionType': 'blacklist'|'whitelist'|'none',
                'Locations': [
                    'string',
                ]
            }
        },
        'Parameters': [
            {
                'Name': 'string',
                'Value': 'string'
            },
        ],
        'ConnectionGroupId': 'string',
        'CreatedTime': datetime(2015, 1, 1),
        'LastModifiedTime': datetime(2015, 1, 1),
        'Enabled': True|False,
        'Status': 'string'
    },
    'ETag': 'string'
}

Response Structure

  • (dict) --

    • DistributionTenant (dict) --

      The distribution tenant that you retrieved.

      • Id (string) --

        The ID of the distribution tenant.

      • DistributionId (string) --

        The ID of the multi-tenant distribution.

      • Name (string) --

        The name of the distribution tenant.

      • Arn (string) --

        The Amazon Resource Name (ARN) of the distribution tenant.

      • Domains (list) --

        The domains associated with the distribution tenant.

        • (dict) --

          The details about the domain result.

          • Domain (string) --

            The specified domain.

          • Status (string) --

            Whether the domain is active or inactive.

          • ServeOn (string) --

            Specifies which requests for this domain CloudFront routes to the distribution tenant. Valid values are:

            • any – CloudFront routes requests for this domain to the distribution tenant regardless of the IP address that they arrive on. This is the default if you don't specify a value.

            • anycast-ip-list-only – CloudFront routes requests for this domain to the distribution tenant only when they arrive on the Anycast static IPs of the distribution tenant's connection group. CloudFront treats requests that arrive on other IP addresses as requests for an unknown domain.

      • Tags (dict) --

        A complex type that contains zero or more Tag elements.

        • Items (list) --

          A complex type that contains Tag elements.

          • (dict) --

            A complex type that contains Tag key and Tag value.

            • Key (string) --

              A string that contains Tag key.

              The string length should be between 1 and 128 characters. Valid characters include a-z, A-Z, 0-9, space, and the special characters _ - . : / = + @.

            • Value (string) --

              A string that contains an optional Tag value.

              The string length should be between 0 and 256 characters. Valid characters include a-z, A-Z, 0-9, space, and the special characters _ - . : / = + @.

      • Customizations (dict) --

        Customizations for the distribution tenant. For each distribution tenant, you can specify the geographic restrictions, and the Amazon Resource Names (ARNs) for the ACM certificate and WAF web ACL. These are specific values that you can override or disable from the multi-tenant distribution that was used to create the distribution tenant.

        • WebAcl (dict) --

          The WAF web ACL.

          • Action (string) --

            The action for the WAF web ACL customization. You can specify override to specify a separate WAF web ACL for the distribution tenant. If you specify disable, the distribution tenant won't have WAF web ACL protections and won't inherit from the multi-tenant distribution.

          • Arn (string) --

            The Amazon Resource Name (ARN) of the WAF web ACL.

        • Certificate (dict) --

          The Certificate Manager (ACM) certificate.

          • Arn (string) --

            The Amazon Resource Name (ARN) of the ACM certificate.

        • GeoRestrictions (dict) --

          The geographic restrictions.

          • RestrictionType (string) --

            The method that you want to use to restrict distribution of your content by country:

            • none: No geographic restriction is enabled, meaning access to content is not restricted by client geo location.

            • blacklist: The Location elements specify the countries in which you don't want CloudFront to distribute your content.

            • whitelist: The Location elements specify the countries in which you want CloudFront to distribute your content.

          • Locations (list) --

            The locations for geographic restrictions.

            • (string) --

      • Parameters (list) --

        A list of parameter values to add to the resource. A parameter is specified as a key-value pair. A valid parameter value must exist for any parameter that is marked as required in the multi-tenant distribution.

        • (dict) --

          A list of parameter values to add to the resource. A parameter is specified as a key-value pair. A valid parameter value must exist for any parameter that is marked as required in the multi-tenant distribution.

          • Name (string) --

            The parameter name.

          • Value (string) --

            The parameter value.

      • ConnectionGroupId (string) --

        The ID of the connection group for the distribution tenant. If you don't specify a connection group, CloudFront uses the default connection group.

      • CreatedTime (datetime) --

        The date and time when the distribution tenant was created.

      • LastModifiedTime (datetime) --

        The date and time when the distribution tenant was updated.

      • Enabled (boolean) --

        Indicates whether the distribution tenant is in an enabled state. If disabled, the distribution tenant won't serve traffic.

      • Status (string) --

        The status of the distribution tenant.

    • ETag (string) --

      The current version of the distribution tenant.

GetDistributionTenantByDomain (updated) Link ¶
Changes (response)
{'DistributionTenant': {'Domains': {'ServeOn': 'any | anycast-ip-list-only'}}}

Gets information about a distribution tenant by the associated domain.

See also: AWS API Documentation

Request Syntax

client.get_distribution_tenant_by_domain(
    Domain='string'
)
type Domain:

string

param Domain:

[REQUIRED]

A domain name associated with the target distribution tenant.

rtype:

dict

returns:

Response Syntax

{
    'DistributionTenant': {
        'Id': 'string',
        'DistributionId': 'string',
        'Name': 'string',
        'Arn': 'string',
        'Domains': [
            {
                'Domain': 'string',
                'Status': 'active'|'inactive',
                'ServeOn': 'any'|'anycast-ip-list-only'
            },
        ],
        'Tags': {
            'Items': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
        'Customizations': {
            'WebAcl': {
                'Action': 'override'|'disable',
                'Arn': 'string'
            },
            'Certificate': {
                'Arn': 'string'
            },
            'GeoRestrictions': {
                'RestrictionType': 'blacklist'|'whitelist'|'none',
                'Locations': [
                    'string',
                ]
            }
        },
        'Parameters': [
            {
                'Name': 'string',
                'Value': 'string'
            },
        ],
        'ConnectionGroupId': 'string',
        'CreatedTime': datetime(2015, 1, 1),
        'LastModifiedTime': datetime(2015, 1, 1),
        'Enabled': True|False,
        'Status': 'string'
    },
    'ETag': 'string'
}

Response Structure

  • (dict) --

    • DistributionTenant (dict) --

      The distribution tenant.

      • Id (string) --

        The ID of the distribution tenant.

      • DistributionId (string) --

        The ID of the multi-tenant distribution.

      • Name (string) --

        The name of the distribution tenant.

      • Arn (string) --

        The Amazon Resource Name (ARN) of the distribution tenant.

      • Domains (list) --

        The domains associated with the distribution tenant.

        • (dict) --

          The details about the domain result.

          • Domain (string) --

            The specified domain.

          • Status (string) --

            Whether the domain is active or inactive.

          • ServeOn (string) --

            Specifies which requests for this domain CloudFront routes to the distribution tenant. Valid values are:

            • any – CloudFront routes requests for this domain to the distribution tenant regardless of the IP address that they arrive on. This is the default if you don't specify a value.

            • anycast-ip-list-only – CloudFront routes requests for this domain to the distribution tenant only when they arrive on the Anycast static IPs of the distribution tenant's connection group. CloudFront treats requests that arrive on other IP addresses as requests for an unknown domain.

      • Tags (dict) --

        A complex type that contains zero or more Tag elements.

        • Items (list) --

          A complex type that contains Tag elements.

          • (dict) --

            A complex type that contains Tag key and Tag value.

            • Key (string) --

              A string that contains Tag key.

              The string length should be between 1 and 128 characters. Valid characters include a-z, A-Z, 0-9, space, and the special characters _ - . : / = + @.

            • Value (string) --

              A string that contains an optional Tag value.

              The string length should be between 0 and 256 characters. Valid characters include a-z, A-Z, 0-9, space, and the special characters _ - . : / = + @.

      • Customizations (dict) --

        Customizations for the distribution tenant. For each distribution tenant, you can specify the geographic restrictions, and the Amazon Resource Names (ARNs) for the ACM certificate and WAF web ACL. These are specific values that you can override or disable from the multi-tenant distribution that was used to create the distribution tenant.

        • WebAcl (dict) --

          The WAF web ACL.

          • Action (string) --

            The action for the WAF web ACL customization. You can specify override to specify a separate WAF web ACL for the distribution tenant. If you specify disable, the distribution tenant won't have WAF web ACL protections and won't inherit from the multi-tenant distribution.

          • Arn (string) --

            The Amazon Resource Name (ARN) of the WAF web ACL.

        • Certificate (dict) --

          The Certificate Manager (ACM) certificate.

          • Arn (string) --

            The Amazon Resource Name (ARN) of the ACM certificate.

        • GeoRestrictions (dict) --

          The geographic restrictions.

          • RestrictionType (string) --

            The method that you want to use to restrict distribution of your content by country:

            • none: No geographic restriction is enabled, meaning access to content is not restricted by client geo location.

            • blacklist: The Location elements specify the countries in which you don't want CloudFront to distribute your content.

            • whitelist: The Location elements specify the countries in which you want CloudFront to distribute your content.

          • Locations (list) --

            The locations for geographic restrictions.

            • (string) --

      • Parameters (list) --

        A list of parameter values to add to the resource. A parameter is specified as a key-value pair. A valid parameter value must exist for any parameter that is marked as required in the multi-tenant distribution.

        • (dict) --

          A list of parameter values to add to the resource. A parameter is specified as a key-value pair. A valid parameter value must exist for any parameter that is marked as required in the multi-tenant distribution.

          • Name (string) --

            The parameter name.

          • Value (string) --

            The parameter value.

      • ConnectionGroupId (string) --

        The ID of the connection group for the distribution tenant. If you don't specify a connection group, CloudFront uses the default connection group.

      • CreatedTime (datetime) --

        The date and time when the distribution tenant was created.

      • LastModifiedTime (datetime) --

        The date and time when the distribution tenant was updated.

      • Enabled (boolean) --

        Indicates whether the distribution tenant is in an enabled state. If disabled, the distribution tenant won't serve traffic.

      • Status (string) --

        The status of the distribution tenant.

    • ETag (string) --

      The current version of the distribution tenant.

ListConnectionGroups (updated) Link ¶
Changes (response)
{'ConnectionGroups': {'ViewerFallback': {'DistributionId': 'string'}}}

Lists the connection groups in your Amazon Web Services account.

See also: AWS API Documentation

Request Syntax

client.list_connection_groups(
    AssociationFilter={
        'AnycastIpListId': 'string'
    },
    Marker='string',
    MaxItems=123
)
type AssociationFilter:

dict

param AssociationFilter:

Filter by associated Anycast IP list ID.

  • AnycastIpListId (string) --

    The ID of the Anycast static IP list.

type Marker:

string

param Marker:

The marker for the next set of connection groups to retrieve.

type MaxItems:

integer

param MaxItems:

The maximum number of connection groups to return.

rtype:

dict

returns:

Response Syntax

{
    'NextMarker': 'string',
    'ConnectionGroups': [
        {
            'Id': 'string',
            'Name': 'string',
            'Arn': 'string',
            'RoutingEndpoint': 'string',
            'CreatedTime': datetime(2015, 1, 1),
            'LastModifiedTime': datetime(2015, 1, 1),
            'ETag': 'string',
            'AnycastIpListId': 'string',
            'Enabled': True|False,
            'Status': 'string',
            'IsDefault': True|False,
            'ViewerFallback': {
                'DistributionId': 'string'
            }
        },
    ]
}

Response Structure

  • (dict) --

    • NextMarker (string) --

      A token used for pagination of results returned in the response. You can use the token from the previous request to define where the current request should begin.

    • ConnectionGroups (list) --

      The list of connection groups that you retrieved.

      • (dict) --

        A summary that contains details about your connection groups.

        • Id (string) --

          The ID of the connection group.

        • Name (string) --

          The name of the connection group.

        • Arn (string) --

          The Amazon Resource Name (ARN) of the connection group.

        • RoutingEndpoint (string) --

          The routing endpoint (also known as the DNS name) that is assigned to the connection group, such as d111111abcdef8.cloudfront.net.

        • CreatedTime (datetime) --

          The date and time when the connection group was created.

        • LastModifiedTime (datetime) --

          The date and time when the connection group was updated.

        • ETag (string) --

          The current version of the connection group.

        • AnycastIpListId (string) --

          The ID of the Anycast static IP list.

        • Enabled (boolean) --

          Whether the connection group is enabled

        • Status (string) --

          The status of the connection group.

        • IsDefault (boolean) --

          Whether the connection group is the default connection group for the distribution tenants.

        • ViewerFallback (dict) --

          The distribution whose certificate CloudFront uses for viewer requests that arrive on the connection group's Anycast static IPs without Server Name Indication (SNI).

          • DistributionId (string) --

            The ID of the distribution whose certificate CloudFront uses to establish TLS connections for viewer requests that don't include SNI.

ListDistributionTenants (updated) Link ¶
Changes (response)
{'DistributionTenantList': {'Domains': {'ServeOn': 'any | '
                                                   'anycast-ip-list-only'}}}

Lists the distribution tenants in your Amazon Web Services account.

See also: AWS API Documentation

Request Syntax

client.list_distribution_tenants(
    AssociationFilter={
        'DistributionId': 'string',
        'ConnectionGroupId': 'string'
    },
    Marker='string',
    MaxItems=123
)
type AssociationFilter:

dict

param AssociationFilter:

Filter by the associated distribution ID or connection group ID.

  • DistributionId (string) --

    The distribution ID to filter by. You can find distribution tenants associated with a specific distribution.

  • ConnectionGroupId (string) --

    The ID of the connection group to filter by. You can find distribution tenants associated with a specific connection group.

type Marker:

string

param Marker:

The marker for the next set of results.

type MaxItems:

integer

param MaxItems:

The maximum number of distribution tenants to return.

rtype:

dict

returns:

Response Syntax

{
    'NextMarker': 'string',
    'DistributionTenantList': [
        {
            'Id': 'string',
            'DistributionId': 'string',
            'Name': 'string',
            'Arn': 'string',
            'Domains': [
                {
                    'Domain': 'string',
                    'Status': 'active'|'inactive',
                    'ServeOn': 'any'|'anycast-ip-list-only'
                },
            ],
            'ConnectionGroupId': 'string',
            'Customizations': {
                'WebAcl': {
                    'Action': 'override'|'disable',
                    'Arn': 'string'
                },
                'Certificate': {
                    'Arn': 'string'
                },
                'GeoRestrictions': {
                    'RestrictionType': 'blacklist'|'whitelist'|'none',
                    'Locations': [
                        'string',
                    ]
                }
            },
            'CreatedTime': datetime(2015, 1, 1),
            'LastModifiedTime': datetime(2015, 1, 1),
            'ETag': 'string',
            'Enabled': True|False,
            'Status': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • NextMarker (string) --

      A token used for pagination of results returned in the response. You can use the token from the previous request to define where the current request should begin.

    • DistributionTenantList (list) --

      The list of distribution tenants that you retrieved.

      • (dict) --

        A summary of the information about a distribution tenant.

        • Id (string) --

          The ID of the distribution tenant.

        • DistributionId (string) --

          The identifier for the multi-tenant distribution. For example: EDFDVBD632BHDS5.

        • Name (string) --

          The name of the distribution tenant.

        • Arn (string) --

          The Amazon Resource Name (ARN) of the distribution tenant.

        • Domains (list) --

          The domains associated with the distribution tenant.

          • (dict) --

            The details about the domain result.

            • Domain (string) --

              The specified domain.

            • Status (string) --

              Whether the domain is active or inactive.

            • ServeOn (string) --

              Specifies which requests for this domain CloudFront routes to the distribution tenant. Valid values are:

              • any – CloudFront routes requests for this domain to the distribution tenant regardless of the IP address that they arrive on. This is the default if you don't specify a value.

              • anycast-ip-list-only – CloudFront routes requests for this domain to the distribution tenant only when they arrive on the Anycast static IPs of the distribution tenant's connection group. CloudFront treats requests that arrive on other IP addresses as requests for an unknown domain.

        • ConnectionGroupId (string) --

          The ID of the connection group ID for the distribution tenant. If you don't specify a connection group, CloudFront uses the default connection group.

        • Customizations (dict) --

          Customizations for the distribution tenant. For each distribution tenant, you can specify the geographic restrictions, and the Amazon Resource Names (ARNs) for the ACM certificate and WAF web ACL. These are specific values that you can override or disable from the multi-tenant distribution that was used to create the distribution tenant.

          • WebAcl (dict) --

            The WAF web ACL.

            • Action (string) --

              The action for the WAF web ACL customization. You can specify override to specify a separate WAF web ACL for the distribution tenant. If you specify disable, the distribution tenant won't have WAF web ACL protections and won't inherit from the multi-tenant distribution.

            • Arn (string) --

              The Amazon Resource Name (ARN) of the WAF web ACL.

          • Certificate (dict) --

            The Certificate Manager (ACM) certificate.

            • Arn (string) --

              The Amazon Resource Name (ARN) of the ACM certificate.

          • GeoRestrictions (dict) --

            The geographic restrictions.

            • RestrictionType (string) --

              The method that you want to use to restrict distribution of your content by country:

              • none: No geographic restriction is enabled, meaning access to content is not restricted by client geo location.

              • blacklist: The Location elements specify the countries in which you don't want CloudFront to distribute your content.

              • whitelist: The Location elements specify the countries in which you want CloudFront to distribute your content.

            • Locations (list) --

              The locations for geographic restrictions.

              • (string) --

        • CreatedTime (datetime) --

          The date and time when the distribution tenant was created.

        • LastModifiedTime (datetime) --

          The date and time when the distribution tenant was updated.

        • ETag (string) --

          The current version of the distribution tenant.

        • Enabled (boolean) --

          Indicates whether the distribution tenants are in an enabled state. If disabled, the distribution tenant won't service traffic.

        • Status (string) --

          The status of the distribution tenant.

ListDistributionTenantsByCustomization (updated) Link ¶
Changes (response)
{'DistributionTenantList': {'Domains': {'ServeOn': 'any | '
                                                   'anycast-ip-list-only'}}}

Lists distribution tenants by the customization that you specify.

You must specify either the CertificateArn parameter or WebACLArn parameter, but not both in the same request.

See also: AWS API Documentation

Request Syntax

client.list_distribution_tenants_by_customization(
    WebACLArn='string',
    CertificateArn='string',
    Marker='string',
    MaxItems=123
)
type WebACLArn:

string

param WebACLArn:

Filter by the ARN of the associated WAF web ACL.

type CertificateArn:

string

param CertificateArn:

Filter by the ARN of the associated ACM certificate.

type Marker:

string

param Marker:

The marker for the next set of results.

type MaxItems:

integer

param MaxItems:

The maximum number of distribution tenants to return by the specified customization.

rtype:

dict

returns:

Response Syntax

{
    'NextMarker': 'string',
    'DistributionTenantList': [
        {
            'Id': 'string',
            'DistributionId': 'string',
            'Name': 'string',
            'Arn': 'string',
            'Domains': [
                {
                    'Domain': 'string',
                    'Status': 'active'|'inactive',
                    'ServeOn': 'any'|'anycast-ip-list-only'
                },
            ],
            'ConnectionGroupId': 'string',
            'Customizations': {
                'WebAcl': {
                    'Action': 'override'|'disable',
                    'Arn': 'string'
                },
                'Certificate': {
                    'Arn': 'string'
                },
                'GeoRestrictions': {
                    'RestrictionType': 'blacklist'|'whitelist'|'none',
                    'Locations': [
                        'string',
                    ]
                }
            },
            'CreatedTime': datetime(2015, 1, 1),
            'LastModifiedTime': datetime(2015, 1, 1),
            'ETag': 'string',
            'Enabled': True|False,
            'Status': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • NextMarker (string) --

      A token used for pagination of results returned in the response. You can use the token from the previous request to define where the current request should begin.

    • DistributionTenantList (list) --

      A list of distribution tenants with the specified customization.

      • (dict) --

        A summary of the information about a distribution tenant.

        • Id (string) --

          The ID of the distribution tenant.

        • DistributionId (string) --

          The identifier for the multi-tenant distribution. For example: EDFDVBD632BHDS5.

        • Name (string) --

          The name of the distribution tenant.

        • Arn (string) --

          The Amazon Resource Name (ARN) of the distribution tenant.

        • Domains (list) --

          The domains associated with the distribution tenant.

          • (dict) --

            The details about the domain result.

            • Domain (string) --

              The specified domain.

            • Status (string) --

              Whether the domain is active or inactive.

            • ServeOn (string) --

              Specifies which requests for this domain CloudFront routes to the distribution tenant. Valid values are:

              • any – CloudFront routes requests for this domain to the distribution tenant regardless of the IP address that they arrive on. This is the default if you don't specify a value.

              • anycast-ip-list-only – CloudFront routes requests for this domain to the distribution tenant only when they arrive on the Anycast static IPs of the distribution tenant's connection group. CloudFront treats requests that arrive on other IP addresses as requests for an unknown domain.

        • ConnectionGroupId (string) --

          The ID of the connection group ID for the distribution tenant. If you don't specify a connection group, CloudFront uses the default connection group.

        • Customizations (dict) --

          Customizations for the distribution tenant. For each distribution tenant, you can specify the geographic restrictions, and the Amazon Resource Names (ARNs) for the ACM certificate and WAF web ACL. These are specific values that you can override or disable from the multi-tenant distribution that was used to create the distribution tenant.

          • WebAcl (dict) --

            The WAF web ACL.

            • Action (string) --

              The action for the WAF web ACL customization. You can specify override to specify a separate WAF web ACL for the distribution tenant. If you specify disable, the distribution tenant won't have WAF web ACL protections and won't inherit from the multi-tenant distribution.

            • Arn (string) --

              The Amazon Resource Name (ARN) of the WAF web ACL.

          • Certificate (dict) --

            The Certificate Manager (ACM) certificate.

            • Arn (string) --

              The Amazon Resource Name (ARN) of the ACM certificate.

          • GeoRestrictions (dict) --

            The geographic restrictions.

            • RestrictionType (string) --

              The method that you want to use to restrict distribution of your content by country:

              • none: No geographic restriction is enabled, meaning access to content is not restricted by client geo location.

              • blacklist: The Location elements specify the countries in which you don't want CloudFront to distribute your content.

              • whitelist: The Location elements specify the countries in which you want CloudFront to distribute your content.

            • Locations (list) --

              The locations for geographic restrictions.

              • (string) --

        • CreatedTime (datetime) --

          The date and time when the distribution tenant was created.

        • LastModifiedTime (datetime) --

          The date and time when the distribution tenant was updated.

        • ETag (string) --

          The current version of the distribution tenant.

        • Enabled (boolean) --

          Indicates whether the distribution tenants are in an enabled state. If disabled, the distribution tenant won't service traffic.

        • Status (string) --

          The status of the distribution tenant.

UpdateConnectionGroup (updated) Link ¶
Changes (request, response)
Request
{'ViewerFallback': {'DistributionId': 'string'}}
Response
{'ConnectionGroup': {'ViewerFallback': {'DistributionId': 'string'}}}

Updates a connection group.

See also: AWS API Documentation

Request Syntax

client.update_connection_group(
    Id='string',
    Ipv6Enabled=True|False,
    IfMatch='string',
    AnycastIpListId='string',
    Enabled=True|False,
    ViewerFallback={
        'DistributionId': 'string'
    }
)
type Id:

string

param Id:

[REQUIRED]

The ID of the connection group.

type Ipv6Enabled:

boolean

param Ipv6Enabled:

Enable IPv6 for the connection group. For more information, see Enable IPv6 in the Amazon CloudFront Developer Guide.

type IfMatch:

string

param IfMatch:

[REQUIRED]

The value of the ETag header that you received when retrieving the connection group that you're updating.

type AnycastIpListId:

string

param AnycastIpListId:

The ID of the Anycast static IP list.

type Enabled:

boolean

param Enabled:

Whether the connection group is enabled.

type ViewerFallback:

dict

param ViewerFallback:

The distribution whose certificate CloudFront uses for viewer requests that arrive on the connection group's Anycast static IPs without Server Name Indication (SNI).

  • DistributionId (string) --

    The ID of the distribution whose certificate CloudFront uses to establish TLS connections for viewer requests that don't include SNI.

rtype:

dict

returns:

Response Syntax

{
    'ConnectionGroup': {
        'Id': 'string',
        'Name': 'string',
        'Arn': 'string',
        'CreatedTime': datetime(2015, 1, 1),
        'LastModifiedTime': datetime(2015, 1, 1),
        'Tags': {
            'Items': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
        'Ipv6Enabled': True|False,
        'RoutingEndpoint': 'string',
        'AnycastIpListId': 'string',
        'Status': 'string',
        'Enabled': True|False,
        'IsDefault': True|False,
        'ViewerFallback': {
            'DistributionId': 'string'
        }
    },
    'ETag': 'string'
}

Response Structure

  • (dict) --

    • ConnectionGroup (dict) --

      The connection group that you updated.

      • Id (string) --

        The ID of the connection group.

      • Name (string) --

        The name of the connection group.

      • Arn (string) --

        The Amazon Resource Name (ARN) of the connection group.

      • CreatedTime (datetime) --

        The date and time when the connection group was created.

      • LastModifiedTime (datetime) --

        The date and time when the connection group was updated.

      • Tags (dict) --

        A complex type that contains zero or more Tag elements.

        • Items (list) --

          A complex type that contains Tag elements.

          • (dict) --

            A complex type that contains Tag key and Tag value.

            • Key (string) --

              A string that contains Tag key.

              The string length should be between 1 and 128 characters. Valid characters include a-z, A-Z, 0-9, space, and the special characters _ - . : / = + @.

            • Value (string) --

              A string that contains an optional Tag value.

              The string length should be between 0 and 256 characters. Valid characters include a-z, A-Z, 0-9, space, and the special characters _ - . : / = + @.

      • Ipv6Enabled (boolean) --

        IPv6 is enabled for the connection group.

      • RoutingEndpoint (string) --

        The routing endpoint (also known as the DNS name) that is assigned to the connection group, such as d111111abcdef8.cloudfront.net.

      • AnycastIpListId (string) --

        The ID of the Anycast static IP list.

      • Status (string) --

        The status of the connection group.

      • Enabled (boolean) --

        Whether the connection group is enabled.

      • IsDefault (boolean) --

        Whether the connection group is the default connection group for the distribution tenants.

      • ViewerFallback (dict) --

        The distribution whose certificate CloudFront uses for viewer requests that arrive on the connection group's Anycast static IPs without Server Name Indication (SNI).

        • DistributionId (string) --

          The ID of the distribution whose certificate CloudFront uses to establish TLS connections for viewer requests that don't include SNI.

    • ETag (string) --

      The current version of the connection group.

UpdateDistributionTenant (updated) Link ¶
Changes (request, response)
Request
{'Domains': {'ServeOn': 'any | anycast-ip-list-only'},
 'OnDomainTakeover': 'allow | reject'}
Response
{'DistributionTenant': {'Domains': {'ServeOn': 'any | anycast-ip-list-only'}}}

Updates a distribution tenant.

See also: AWS API Documentation

Request Syntax

client.update_distribution_tenant(
    Id='string',
    DistributionId='string',
    Domains=[
        {
            'Domain': 'string',
            'ServeOn': 'any'|'anycast-ip-list-only'
        },
    ],
    Customizations={
        'WebAcl': {
            'Action': 'override'|'disable',
            'Arn': 'string'
        },
        'Certificate': {
            'Arn': 'string'
        },
        'GeoRestrictions': {
            'RestrictionType': 'blacklist'|'whitelist'|'none',
            'Locations': [
                'string',
            ]
        }
    },
    Parameters=[
        {
            'Name': 'string',
            'Value': 'string'
        },
    ],
    ConnectionGroupId='string',
    IfMatch='string',
    ManagedCertificateRequest={
        'ValidationTokenHost': 'cloudfront'|'self-hosted',
        'PrimaryDomainName': 'string',
        'CertificateTransparencyLoggingPreference': 'enabled'|'disabled'
    },
    Enabled=True|False,
    OnDomainTakeover='allow'|'reject'
)
type Id:

string

param Id:

[REQUIRED]

The ID of the distribution tenant.

type DistributionId:

string

param DistributionId:

The ID for the multi-tenant distribution.

type Domains:

list

param Domains:

The domains to update for the distribution tenant. A domain object can contain only a domain property. You must specify at least one domain. Each distribution tenant can have up to 5 domains.

  • (dict) --

    The domain for the specified distribution tenant.

    • Domain (string) -- [REQUIRED]

      The domain name.

    • ServeOn (string) --

      Specifies which requests for this domain CloudFront routes to the distribution tenant. Valid values are:

      • any – CloudFront routes requests for this domain to the distribution tenant regardless of the IP address that they arrive on. This is the default if you don't specify a value.

      • anycast-ip-list-only – CloudFront routes requests for this domain to the distribution tenant only when they arrive on the Anycast static IPs of the distribution tenant's connection group. CloudFront treats requests that arrive on other IP addresses as requests for an unknown domain.

type Customizations:

dict

param Customizations:

Customizations for the distribution tenant. For each distribution tenant, you can specify the geographic restrictions, and the Amazon Resource Names (ARNs) for the ACM certificate and WAF web ACL. These are specific values that you can override or disable from the multi-tenant distribution that was used to create the distribution tenant.

  • WebAcl (dict) --

    The WAF web ACL.

    • Action (string) -- [REQUIRED]

      The action for the WAF web ACL customization. You can specify override to specify a separate WAF web ACL for the distribution tenant. If you specify disable, the distribution tenant won't have WAF web ACL protections and won't inherit from the multi-tenant distribution.

    • Arn (string) --

      The Amazon Resource Name (ARN) of the WAF web ACL.

  • Certificate (dict) --

    The Certificate Manager (ACM) certificate.

    • Arn (string) -- [REQUIRED]

      The Amazon Resource Name (ARN) of the ACM certificate.

  • GeoRestrictions (dict) --

    The geographic restrictions.

    • RestrictionType (string) -- [REQUIRED]

      The method that you want to use to restrict distribution of your content by country:

      • none: No geographic restriction is enabled, meaning access to content is not restricted by client geo location.

      • blacklist: The Location elements specify the countries in which you don't want CloudFront to distribute your content.

      • whitelist: The Location elements specify the countries in which you want CloudFront to distribute your content.

    • Locations (list) --

      The locations for geographic restrictions.

      • (string) --

type Parameters:

list

param Parameters:

A list of parameter values to add to the resource. A parameter is specified as a key-value pair. A valid parameter value must exist for any parameter that is marked as required in the multi-tenant distribution.

  • (dict) --

    A list of parameter values to add to the resource. A parameter is specified as a key-value pair. A valid parameter value must exist for any parameter that is marked as required in the multi-tenant distribution.

    • Name (string) -- [REQUIRED]

      The parameter name.

    • Value (string) -- [REQUIRED]

      The parameter value.

type ConnectionGroupId:

string

param ConnectionGroupId:

The ID of the target connection group.

type IfMatch:

string

param IfMatch:

[REQUIRED]

The value of the ETag header that you received when retrieving the distribution tenant to update. This value is returned in the response of the GetDistributionTenant API operation.

type ManagedCertificateRequest:

dict

param ManagedCertificateRequest:

An object that contains the CloudFront managed ACM certificate request.

  • ValidationTokenHost (string) -- [REQUIRED]

    Specify how the HTTP validation token will be served when requesting the CloudFront managed ACM certificate.

    • For cloudfront, CloudFront will automatically serve the validation token. Choose this mode if you can point the domain's DNS to CloudFront immediately.

    • For self-hosted, you serve the validation token from your existing infrastructure. Choose this mode when you need to maintain current traffic flow while your certificate is being issued. You can place the validation token at the well-known path on your existing web server, wait for ACM to validate and issue the certificate, and then update your DNS to point to CloudFront.

  • PrimaryDomainName (string) --

    The primary domain name associated with the CloudFront managed ACM certificate.

  • CertificateTransparencyLoggingPreference (string) --

    You can opt out of certificate transparency logging by specifying the disabled option. Opt in by specifying enabled. For more information, see Certificate Transparency Logging in the Certificate Manager User Guide.

type Enabled:

boolean

param Enabled:

Indicates whether the distribution tenant should be updated to an enabled state. If you update the distribution tenant and it's not enabled, the distribution tenant won't serve traffic.

type OnDomainTakeover:

string

param OnDomainTakeover:

Specifies whether CloudFront moves a domain in this request to this distribution tenant when the domain is already associated with another standard distribution or distribution tenant. Valid values are:

  • allow – CloudFront moves the domain to this distribution tenant when the domain's DNS points to this distribution tenant.

  • reject – CloudFront doesn't move the domain, and the request fails if the domain is associated with another resource. This is the default if you don't specify a value.

rtype:

dict

returns:

Response Syntax

{
    'DistributionTenant': {
        'Id': 'string',
        'DistributionId': 'string',
        'Name': 'string',
        'Arn': 'string',
        'Domains': [
            {
                'Domain': 'string',
                'Status': 'active'|'inactive',
                'ServeOn': 'any'|'anycast-ip-list-only'
            },
        ],
        'Tags': {
            'Items': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
        'Customizations': {
            'WebAcl': {
                'Action': 'override'|'disable',
                'Arn': 'string'
            },
            'Certificate': {
                'Arn': 'string'
            },
            'GeoRestrictions': {
                'RestrictionType': 'blacklist'|'whitelist'|'none',
                'Locations': [
                    'string',
                ]
            }
        },
        'Parameters': [
            {
                'Name': 'string',
                'Value': 'string'
            },
        ],
        'ConnectionGroupId': 'string',
        'CreatedTime': datetime(2015, 1, 1),
        'LastModifiedTime': datetime(2015, 1, 1),
        'Enabled': True|False,
        'Status': 'string'
    },
    'ETag': 'string'
}

Response Structure

  • (dict) --

    • DistributionTenant (dict) --

      The distribution tenant that you're updating.

      • Id (string) --

        The ID of the distribution tenant.

      • DistributionId (string) --

        The ID of the multi-tenant distribution.

      • Name (string) --

        The name of the distribution tenant.

      • Arn (string) --

        The Amazon Resource Name (ARN) of the distribution tenant.

      • Domains (list) --

        The domains associated with the distribution tenant.

        • (dict) --

          The details about the domain result.

          • Domain (string) --

            The specified domain.

          • Status (string) --

            Whether the domain is active or inactive.

          • ServeOn (string) --

            Specifies which requests for this domain CloudFront routes to the distribution tenant. Valid values are:

            • any – CloudFront routes requests for this domain to the distribution tenant regardless of the IP address that they arrive on. This is the default if you don't specify a value.

            • anycast-ip-list-only – CloudFront routes requests for this domain to the distribution tenant only when they arrive on the Anycast static IPs of the distribution tenant's connection group. CloudFront treats requests that arrive on other IP addresses as requests for an unknown domain.

      • Tags (dict) --

        A complex type that contains zero or more Tag elements.

        • Items (list) --

          A complex type that contains Tag elements.

          • (dict) --

            A complex type that contains Tag key and Tag value.

            • Key (string) --

              A string that contains Tag key.

              The string length should be between 1 and 128 characters. Valid characters include a-z, A-Z, 0-9, space, and the special characters _ - . : / = + @.

            • Value (string) --

              A string that contains an optional Tag value.

              The string length should be between 0 and 256 characters. Valid characters include a-z, A-Z, 0-9, space, and the special characters _ - . : / = + @.

      • Customizations (dict) --

        Customizations for the distribution tenant. For each distribution tenant, you can specify the geographic restrictions, and the Amazon Resource Names (ARNs) for the ACM certificate and WAF web ACL. These are specific values that you can override or disable from the multi-tenant distribution that was used to create the distribution tenant.

        • WebAcl (dict) --

          The WAF web ACL.

          • Action (string) --

            The action for the WAF web ACL customization. You can specify override to specify a separate WAF web ACL for the distribution tenant. If you specify disable, the distribution tenant won't have WAF web ACL protections and won't inherit from the multi-tenant distribution.

          • Arn (string) --

            The Amazon Resource Name (ARN) of the WAF web ACL.

        • Certificate (dict) --

          The Certificate Manager (ACM) certificate.

          • Arn (string) --

            The Amazon Resource Name (ARN) of the ACM certificate.

        • GeoRestrictions (dict) --

          The geographic restrictions.

          • RestrictionType (string) --

            The method that you want to use to restrict distribution of your content by country:

            • none: No geographic restriction is enabled, meaning access to content is not restricted by client geo location.

            • blacklist: The Location elements specify the countries in which you don't want CloudFront to distribute your content.

            • whitelist: The Location elements specify the countries in which you want CloudFront to distribute your content.

          • Locations (list) --

            The locations for geographic restrictions.

            • (string) --

      • Parameters (list) --

        A list of parameter values to add to the resource. A parameter is specified as a key-value pair. A valid parameter value must exist for any parameter that is marked as required in the multi-tenant distribution.

        • (dict) --

          A list of parameter values to add to the resource. A parameter is specified as a key-value pair. A valid parameter value must exist for any parameter that is marked as required in the multi-tenant distribution.

          • Name (string) --

            The parameter name.

          • Value (string) --

            The parameter value.

      • ConnectionGroupId (string) --

        The ID of the connection group for the distribution tenant. If you don't specify a connection group, CloudFront uses the default connection group.

      • CreatedTime (datetime) --

        The date and time when the distribution tenant was created.

      • LastModifiedTime (datetime) --

        The date and time when the distribution tenant was updated.

      • Enabled (boolean) --

        Indicates whether the distribution tenant is in an enabled state. If disabled, the distribution tenant won't serve traffic.

      • Status (string) --

        The status of the distribution tenant.

    • ETag (string) --

      The current version of the distribution tenant.