CloudFront / Client / associate_alias

associate_alias

CloudFront.Client.associate_alias(**kwargs)

Note

The AssociateAlias API operation only supports standard distributions. To move domains between distribution tenants and/or standard distributions, we recommend that you use the UpdateDomainAssociation API operation instead.

Associates an alias with a CloudFront standard distribution. An alias is commonly known as a custom domain or vanity domain. It can also be called a CNAME or alternate domain name.

With this operation, you can move an alias that’s already used for a standard distribution to a different standard distribution. This prevents the downtime that could occur if you first remove the alias from one standard distribution and then separately add the alias to another standard distribution.

To use this operation, specify the alias and the ID of the target standard distribution.

For more information, including how to set up the target standard distribution, prerequisites that you must complete, and other restrictions, see Moving an alternate domain name to a different standard distribution or distribution tenant in the Amazon CloudFront Developer Guide.

See also: AWS API Documentation

Request Syntax

response = client.associate_alias(
    TargetDistributionId='string',
    Alias='string'
)
Parameters:

  • TargetDistributionId (string) –

    [REQUIRED]

    The ID of the standard distribution that you’re associating the alias with.

  • Alias (string) –

    [REQUIRED]

    The alias (also known as a CNAME) to add to the target standard distribution.

Returns:

None

Exceptions