:doc:`APIGateway <../../apigateway>` / Client / create_domain_name_access_association

*************************************
create_domain_name_access_association
*************************************



.. py:method:: 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 <https://docs.aws.amazon.com/goto/WebAPI/apigateway-2015-07-09/CreateDomainNameAccessAssociation>`_  


  **Request Syntax**
  ::

    response = client.create_domain_name_access_association(
        domainNameArn='string',
        accessAssociationSourceType='VPCE',
        accessAssociationSource='string',
        tags={
            'string': 'string'
        }
    )
    
  :type domainNameArn: string
  :param domainNameArn: **[REQUIRED]** 

    The ARN of the domain name.

    

  
  :type accessAssociationSourceType: string
  :param accessAssociationSourceType: **[REQUIRED]** 

    The type of the domain name access association source.

    

  
  :type accessAssociationSource: string
  :param accessAssociationSource: **[REQUIRED]** 

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

    

  
  :type tags: dict
  :param tags: 

    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) --* 

      


  
  :rtype: 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**
  
  *   :py:class:`APIGateway.Client.exceptions.BadRequestException`

  
  *   :py:class:`APIGateway.Client.exceptions.ConflictException`

  
  *   :py:class:`APIGateway.Client.exceptions.LimitExceededException`

  
  *   :py:class:`APIGateway.Client.exceptions.UnauthorizedException`

  
  *   :py:class:`APIGateway.Client.exceptions.TooManyRequestsException`

  