APIGateway / Client / create_domain_name_access_association

create_domain_name_access_association#

APIGateway.Client.create_domain_name_access_association(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.create_domain_name_access_association(
    domainNameArn='string',
    accessAssociationSourceType='VPCE',
    accessAssociationSource='string',
    tags={
        'string': 'string'
    }
)
Parameters:

  • domainNameArn (string) –

    [REQUIRED]

    The ARN of the domain name.

  • accessAssociationSourceType (string) –

    [REQUIRED]

    The type of the domain name access association source.

  • accessAssociationSource (string) –

    [REQUIRED]

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

  • tags (dict) –

    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.

    • (string) –

      • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'domainNameAccessAssociationArn': 'string',
    'domainNameArn': 'string',
    'accessAssociationSourceType': 'VPCE',
    'accessAssociationSource': 'string',
    'tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) –

    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.

    • domainNameAccessAssociationArn (string) –

      The ARN of the domain name access association resource.

    • domainNameArn (string) –

      The ARN of the domain name.

    • accessAssociationSourceType (string) –

      The type of the domain name access association source.

    • accessAssociationSource (string) –

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

    • tags (dict) –

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

      • (string) –

        • (string) –

Exceptions