AWS::ApiGateway::DomainNameAccessAssociation - AWS CloudFormation
SyntaxPropertiesReturn valuesExamples

AWS::ApiGateway::DomainNameAccessAssociation

The AWS::ApiGateway::DomainNameAccessAssociation resource creates a domain name access association between an access association source and a private custom domain name.

Use a domain name access association to invoke a private custom domain name while isolated from the public internet.

You can only create or delete a DomainNameAccessAssociation using CloudFormation. To reject a domain name access association, use the AWS CLI.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::ApiGateway::DomainNameAccessAssociation",
  "Properties" : {
      "AccessAssociationSource" : String,
      "AccessAssociationSourceType" : String,
      "DomainNameArn" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::ApiGateway::DomainNameAccessAssociation
Properties:
  AccessAssociationSource: String
  AccessAssociationSourceType: String
  DomainNameArn: String
  Tags: 
    - Tag

Properties

AccessAssociationSource

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

Required: Yes

Type: String

Update requires: Replacement

AccessAssociationSourceType

The type of the domain name access association source. Only VPCE is currently supported.

Required: Yes

Type: String

Allowed values: VPCE

Update requires: Replacement

DomainNameArn

The ARN of the domain name.

Required: Yes

Type: String

Update requires: Replacement

Tags

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

Required: No

Type: Array of Tag

Update requires: Replacement

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the domain name access association ARN.

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

DomainNameAccessAssociationArn

The access association ARN. For example: arn:aws:apigateway:us-west-2:111122223333:/accessassociations/domainname/private.example.com+abcd1234/vpcesource/vpce-abcd1234efg.

Examples

Domain name access association example

The following example creates a DomainNameAccessAssociation resource named MyDomainNameAccessAssociation.

JSON

{
    "MyDomainNameAccessAssociation": {
        "Type": "AWS::ApiGateway::DomainNameAccessAssociation",
        "Properties": {
            "DomainNameArn": {
                "Fn::GetAtt": [
                    "MyDomainName",
                    "DomainNameArn"
                ]
            },
            "AccessAssociationSource": "vpce-abcd123456",
            "AccessAssociationSourceType": "VPCE"
        }
    }
}

YAML

MyDomainNameAccessAssociation:
  Type: AWS::ApiGateway::DomainNameAccessAssociation
  Properties:
    DomainNameArn: !GetAtt MyDomainName.DomainNameArn
    AccessAssociationSource: vpce-abcd123456
    AccessAssociationSourceType: VPCE