Package software.amazon.awscdk.services.apigateway

Interface CfnDomainNameAccessAssociationProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDomainNameAccessAssociationProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)",
           date="2025-11-04T09:27:33.307Z")
@Stability(Stable)
public interface CfnDomainNameAccessAssociationProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnDomainNameAccessAssociation.

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.*;
 CfnDomainNameAccessAssociationProps cfnDomainNameAccessAssociationProps = CfnDomainNameAccessAssociationProps.builder()
         .accessAssociationSource("accessAssociationSource")
         .accessAssociationSourceType("accessAssociationSourceType")
         .domainNameArn("domainNameArn")
         // the properties below are optional
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainnameaccessassociation.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDomainNameAccessAssociationProps.Builder	A builder for CfnDomainNameAccessAssociationProps
static final class	CfnDomainNameAccessAssociationProps.Jsii$Proxy	An implementation for CfnDomainNameAccessAssociationProps

Method Summary

Modifier and Type	Method	Description
static CfnDomainNameAccessAssociationProps.Builder	builder()
String	getAccessAssociationSource()	The identifier of the domain name access association source.
String	getAccessAssociationSourceType()	The type of the domain name access association source.
String	getDomainNameArn()	The ARN of the domain name.
default List<CfnTag>	getTags()	The collection of tags.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAccessAssociationSource

@Stability(Stable)
@NotNull
String getAccessAssociationSource()

The identifier of the domain name access association source.

For a VPCE , the value is the VPC endpoint ID.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainnameaccessassociation.html#cfn-apigateway-domainnameaccessassociation-accessassociationsource

getAccessAssociationSourceType

@Stability(Stable)
@NotNull
String getAccessAssociationSourceType()

The type of the domain name access association source.

Only VPCE is currently supported.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainnameaccessassociation.html#cfn-apigateway-domainnameaccessassociation-accessassociationsourcetype

getDomainNameArn

@Stability(Stable)
@NotNull
String getDomainNameArn()

The ARN of the domain name.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainnameaccessassociation.html#cfn-apigateway-domainnameaccessassociation-domainnamearn

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

The collection of tags.

Each tag element is associated with a given resource.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainnameaccessassociation.html#cfn-apigateway-domainnameaccessassociation-tags

builder

@Stability(Stable)
static CfnDomainNameAccessAssociationProps.Builder builder()

Returns:

a CfnDomainNameAccessAssociationProps.Builder of CfnDomainNameAccessAssociationProps