Skip to content

CloudFront  >  Operations  >  update_domain_association

update_domain_association

Operation

update_domain_association async

update_domain_association(input: UpdateDomainAssociationInput, plugins: list[Plugin] | None = None) -> UpdateDomainAssociationOutput
Note

We recommend that you use the UpdateDomainAssociation API operation to move a domain association, as it supports both standard distributions and distribution tenants. AssociateAlias performs similar checks but only supports standard distributions.

Moves a domain from its current standard distribution or distribution tenant to another one.

You must first disable the source distribution (standard distribution or distribution tenant) and then separately call this operation to move the domain to another target distribution (standard distribution or distribution tenant).

To use this operation, specify the domain and the ID of the target resource (standard distribution or distribution tenant). For more information, including how to set up the target resource, 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.

Parameters:

Name Type Description Default
input UpdateDomainAssociationInput

An instance of UpdateDomainAssociationInput.

required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None

Returns:

Type Description
UpdateDomainAssociationOutput

An instance of UpdateDomainAssociationOutput.

Input

UpdateDomainAssociationInput dataclass

Bases: _SerdeShape

Dataclass for UpdateDomainAssociationInput structure.

Attributes

domain class-attribute instance-attribute
domain: str | None = ...

The domain to update.

if_match class-attribute instance-attribute
if_match: str | None = ...

The value of the ETag identifier for the standard distribution or distribution tenant that will be associated with the domain.

target_resource class-attribute instance-attribute
target_resource: DistributionResourceId | None = ...

The target standard distribution or distribution tenant resource for the domain. You can specify either DistributionId or DistributionTenantId, but not both.

Output

UpdateDomainAssociationOutput dataclass

Bases: _SerdeShape

Dataclass for UpdateDomainAssociationOutput structure.

Attributes

domain class-attribute instance-attribute
domain: str | None = ...

The domain that you're moving.

e_tag class-attribute instance-attribute
e_tag: str | None = ...

The current version of the target standard distribution or distribution tenant that was associated with the domain.

resource_id class-attribute instance-attribute
resource_id: str | None = ...

The intended destination for the domain.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.