Skip to content

Api Gateway  >  Operations  >  create_domain_name_access_association

create_domain_name_access_association

Operation

create_domain_name_access_association async

create_domain_name_access_association(input: CreateDomainNameAccessAssociationInput, plugins: list[Plugin] | None = None) -> CreateDomainNameAccessAssociationOutput

Creates a domain name access association resource between an access association source and a private custom domain name.

Parameters:

Name Type Description Default
input CreateDomainNameAccessAssociationInput

An instance of CreateDomainNameAccessAssociationInput.

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
CreateDomainNameAccessAssociationOutput

An instance of CreateDomainNameAccessAssociationOutput.

Input

CreateDomainNameAccessAssociationInput dataclass

Dataclass for CreateDomainNameAccessAssociationInput structure.

Attributes

access_association_source class-attribute instance-attribute
access_association_source: str | None = None

The identifier of the domain name access association source. For a VPCE, the value is the VPC endpoint ID.

access_association_source_type class-attribute instance-attribute
access_association_source_type: AccessAssociationSourceType | None = None

The type of the domain name access association source.

domain_name_arn class-attribute instance-attribute
domain_name_arn: str | None = None

The ARN of the domain name.

tags class-attribute instance-attribute
tags: dict[str, str] | None = None

The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.

Output

CreateDomainNameAccessAssociationOutput dataclass

Represents a domain name access association between an access association source and a private custom domain name. With a domain name access association, an access association source can invoke a private custom domain name while isolated from the public internet.

Attributes

access_association_source class-attribute instance-attribute
access_association_source: str | None = None

The ARN of the domain name access association source. For a VPCE, the ARN must be a VPC endpoint.

access_association_source_type class-attribute instance-attribute
access_association_source_type: AccessAssociationSourceType | None = None

The type of the domain name access association source.

domain_name_access_association_arn class-attribute instance-attribute
domain_name_access_association_arn: str | None = None

The ARN of the domain name access association resource.

domain_name_arn class-attribute instance-attribute
domain_name_arn: str | None = None

The ARN of the domain name.

tags class-attribute instance-attribute
tags: dict[str, str] | None = None

The collection of tags. Each tag element is associated with a given resource.