Skip to content

UpdateDistributionTenantRequest

Source code in docs_src/capo_cloudfront/types/update_distribution_tenant_request.py
class UpdateDistributionTenantRequest(TypedDict, closed=True):
    id: "capo_cloudfront.types.string.string"
    """<p>The ID of the distribution tenant.</p>"""
    distribution_id: NotRequired["capo_cloudfront.types.string.string"]
    """<p>The ID for the multi-tenant distribution.</p>"""
    domains: NotRequired["capo_cloudfront.types.domain_list.DomainList"]
    """<p>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.</p>"""
    customizations: NotRequired["capo_cloudfront.types.customizations.Customizations"]
    """<p>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.</p>"""
    parameters: NotRequired["capo_cloudfront.types.parameters.Parameters"]
    """<p>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.</p>"""
    connection_group_id: NotRequired["capo_cloudfront.types.string.string"]
    """<p>The ID of the target connection group.</p>"""
    if_match: "capo_cloudfront.types.string.string"
    """<p>The value of the <code>ETag</code> header that you received when retrieving the distribution tenant to update. This value is returned in the response of the <code>GetDistributionTenant</code> API operation.</p>"""
    managed_certificate_request: NotRequired[
        "capo_cloudfront.types.managed_certificate_request.ManagedCertificateRequest"
    ]
    """<p>An object that contains the CloudFront managed ACM certificate request.</p>"""
    enabled: NotRequired["capo_cloudfront.types.boolean.boolean"]
    """<p>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.</p>"""

connection_group_id instance-attribute

connection_group_id: NotRequired[string]

The ID of the target connection group.

customizations instance-attribute

customizations: NotRequired[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.

distribution_id instance-attribute

distribution_id: NotRequired[string]

The ID for the multi-tenant distribution.

domains instance-attribute

domains: NotRequired[DomainList]

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 instance-attribute

enabled: NotRequired[boolean]

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 instance-attribute

id: string

The ID of the distribution tenant.

if_match instance-attribute

if_match: string

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 instance-attribute

managed_certificate_request: NotRequired[ManagedCertificateRequest]

An object that contains the CloudFront managed ACM certificate request.

parameters instance-attribute

parameters: NotRequired[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.