Skip to content

CloudFront  >  Operations  >  update_distribution_tenant

update_distribution_tenant

Operation

update_distribution_tenant async 

update_distribution_tenant(input: UpdateDistributionTenantInput, plugins: list[Plugin] | None = None) -> UpdateDistributionTenantOutput

Updates a distribution tenant.

Parameters:

Name Type Description Default
input UpdateDistributionTenantInput

An instance of UpdateDistributionTenantInput.

 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
UpdateDistributionTenantOutput

An instance of UpdateDistributionTenantOutput.

Input

UpdateDistributionTenantInput dataclass

Bases: _SerdeShape

Dataclass for UpdateDistributionTenantInput structure.

Attributes

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

The ID of the target connection group.

customizations class-attribute instance-attribute 
customizations: Customizations | None = ...

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.

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

The ID for the multi-tenant distribution.

domains class-attribute instance-attribute 
domains: list[DomainItem] | None = ...

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.

enabled class-attribute instance-attribute 
enabled: bool | None = ...

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.

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

The ID of the distribution tenant.

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

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.

managed_certificate_request class-attribute instance-attribute 
managed_certificate_request: ManagedCertificateRequest | None = ...

An object that contains the CloudFront managed ACM certificate request.

parameters class-attribute instance-attribute 
parameters: list[Parameter] | None = ...

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.

Output

UpdateDistributionTenantOutput dataclass

Bases: _SerdeShape

Dataclass for UpdateDistributionTenantOutput structure.

Attributes

distribution_tenant class-attribute instance-attribute 
distribution_tenant: DistributionTenant | None = ...

The distribution tenant that you're updating.

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

The current version of the distribution tenant.

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.