Package software.amazon.awscdk.services.apigateway

Class CfnDomainNameAccessAssociation

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.apigateway.CfnDomainNameAccessAssociation
All Implemented Interfaces:
IInspectable, ITaggableV2, IDomainNameAccessAssociationRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-29T11:15:31.407Z") @Stability(Stable) public class CfnDomainNameAccessAssociation extends CfnResource implements IInspectable, IDomainNameAccessAssociationRef, ITaggableV2
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.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.apigateway.*;
 CfnDomainNameAccessAssociation cfnDomainNameAccessAssociation = CfnDomainNameAccessAssociation.Builder.create(this, "MyCfnDomainNameAccessAssociation")
         .accessAssociationSource("accessAssociationSource")
         .accessAssociationSourceType("accessAssociationSourceType")
         .domainNameArn("domainNameArn")
         // the properties below are optional
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnDomainNameAccessAssociation

      protected CfnDomainNameAccessAssociation(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnDomainNameAccessAssociation

      protected CfnDomainNameAccessAssociation(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnDomainNameAccessAssociation

      @Stability(Stable) public CfnDomainNameAccessAssociation(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnDomainNameAccessAssociationProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrDomainNameAccessAssociationArn

      @Stability(Stable) @NotNull public String getAttrDomainNameAccessAssociationArn()
      The access association ARN.

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

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getDomainNameAccessAssociationRef

      @Stability(Stable) @NotNull public DomainNameAccessAssociationReference getDomainNameAccessAssociationRef()
      A reference to a DomainNameAccessAssociation resource.
      Specified by:
      getDomainNameAccessAssociationRef in interface IDomainNameAccessAssociationRef

    • getAccessAssociationSource

      @Stability(Stable) @NotNull public String getAccessAssociationSource()
      The identifier of the domain name access association source.

    • setAccessAssociationSource

      @Stability(Stable) public void setAccessAssociationSource(@NotNull String value)
      The identifier of the domain name access association source.

    • getAccessAssociationSourceType

      @Stability(Stable) @NotNull public String getAccessAssociationSourceType()
      The type of the domain name access association source.

    • setAccessAssociationSourceType

      @Stability(Stable) public void setAccessAssociationSourceType(@NotNull String value)
      The type of the domain name access association source.

    • getDomainNameArn

      @Stability(Stable) @NotNull public String getDomainNameArn()
      The ARN of the domain name.

    • setDomainNameArn

      @Stability(Stable) public void setDomainNameArn(@NotNull String value)
      The ARN of the domain name.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      The collection of tags.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      The collection of tags.