AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::ApiGateway::DomainNameAccessAssociation

CfnDomainNameAccessAssociation

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.

Import

import { CfnDomainNameAccessAssociation } from 'aws-cdk-lib/aws-apigateway';

Or use the module namespace:

import * as apigateway from 'aws-cdk-lib/aws-apigateway';
// apigateway.CfnDomainNameAccessAssociation

Properties

Configuration passed to the constructor as CfnDomainNameAccessAssociationProps.

accessAssociationSourceRequired
string

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

accessAssociationSourceTypeRequired
string

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

domainNameArnRequired
string

The ARN of the domain name.

tagsOptional
CfnTag[]

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

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

AWS::ApiGateway::DomainNameAccessAssociationView in CloudFormation Explorer

Get the Amazon API Gateway Cheat Sheet

Everything you need to know about Amazon API Gateway on one page. HD quality, print-friendly.

Download Free Infographic

Quick Facts

LevelL1 (CloudFormation)
Moduleaws-apigateway
CFN TypeAWS::ApiGateway::DomainNameAccessAssociation
Properties4

Related Constructs

Explore This Service

External Links