Class CfnDomainName
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.CfnDomainName
- All Implemented Interfaces:
IInspectable
,ITaggable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)",
date="2024-07-12T19:33:56.703Z")
@Stability(Stable)
public class CfnDomainName
extends CfnResource
implements IInspectable, ITaggable
The
AWS::ApiGateway::DomainName
resource specifies a custom domain name for your API in API Gateway.
You can use a custom domain name to provide a URL that's more intuitive and easier to recall. For more information about using custom domain names, see Set up Custom Domain Name for an API in API Gateway in the API Gateway Developer Guide .
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.*; CfnDomainName cfnDomainName = CfnDomainName.Builder.create(this, "MyCfnDomainName") .certificateArn("certificateArn") .domainName("domainName") .endpointConfiguration(EndpointConfigurationProperty.builder() .types(List.of("types")) .build()) .mutualTlsAuthentication(MutualTlsAuthenticationProperty.builder() .truststoreUri("truststoreUri") .truststoreVersion("truststoreVersion") .build()) .ownershipVerificationCertificateArn("ownershipVerificationCertificateArn") .regionalCertificateArn("regionalCertificateArn") .securityPolicy("securityPolicy") .tags(List.of(CfnTag.builder() .key("key") .value("value") .build())) .build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final class
A fluent builder forCfnDomainName
.static interface
TheEndpointConfiguration
property type specifies the endpoint types of an Amazon API Gateway domain name.static interface
The mutual TLS authentication configuration for a custom domain name.Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggable
ITaggable.Jsii$Default, ITaggable.Jsii$Proxy
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
CfnDomainName
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnDomainName
(software.amazon.jsii.JsiiObjectRef objRef) CfnDomainName
(software.constructs.Construct scope, String id) CfnDomainName
(software.constructs.Construct scope, String id, CfnDomainNameProps props) -
Method Summary
Modifier and TypeMethodDescriptionThe Amazon CloudFront distribution domain name that's mapped to the custom domain name.The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized endpoint.The domain name associated with the regional endpoint for this custom domain name.The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint.The reference to an AWS -managed certificate that will be used by edge-optimized endpoint for this domain name.The custom domain name as an API host name, for example,my-api.example.com
.The endpoint configuration of this DomainName showing the endpoint types of the domain name.The mutual TLS authentication configuration for a custom domain name.The ARN of the public certificate issued by ACM to validate ownership of your custom domain.The reference to an AWS -managed certificate that will be used for validating the regional domain name.The Transport Layer Security (TLS) version + cipher suite for this DomainName.getTags()
Tag Manager which manages the tags for this resource.The collection of tags.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
setCertificateArn
(String value) The reference to an AWS -managed certificate that will be used by edge-optimized endpoint for this domain name.void
setDomainName
(String value) The custom domain name as an API host name, for example,my-api.example.com
.void
The endpoint configuration of this DomainName showing the endpoint types of the domain name.void
The endpoint configuration of this DomainName showing the endpoint types of the domain name.void
The mutual TLS authentication configuration for a custom domain name.void
The mutual TLS authentication configuration for a custom domain name.void
The ARN of the public certificate issued by ACM to validate ownership of your custom domain.void
setRegionalCertificateArn
(String value) The reference to an AWS -managed certificate that will be used for validating the regional domain name.void
setSecurityPolicy
(String value) The Transport Layer Security (TLS) version + cipher suite for this DomainName.void
setTagsRaw
(List<CfnTag> value) The collection of tags.Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties
Methods inherited from class software.amazon.awscdk.CfnRefElement
getRef
Methods inherited from class software.amazon.awscdk.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
Methods inherited from class software.constructs.Construct
getNode, isConstruct
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
-
-
Constructor Details
-
CfnDomainName
protected CfnDomainName(software.amazon.jsii.JsiiObjectRef objRef) -
CfnDomainName
protected CfnDomainName(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnDomainName
@Stability(Stable) public CfnDomainName(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable CfnDomainNameProps 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.
-
CfnDomainName
@Stability(Stable) public CfnDomainName(@NotNull software.constructs.Construct scope, @NotNull String id) - 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.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- 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 classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrDistributionDomainName
The Amazon CloudFront distribution domain name that's mapped to the custom domain name.This is only applicable for endpoints whose type is
EDGE
.Example:
d111111abcdef8.cloudfront.net
-
getAttrDistributionHostedZoneId
The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized endpoint.The only valid value is
Z2FDTNDATAQYW2
for all regions. -
getAttrRegionalDomainName
The domain name associated with the regional endpoint for this custom domain name.You set up this association by adding a DNS record that points the custom domain name to this regional domain name.
-
getAttrRegionalHostedZoneId
The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint. -
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getTags
Tag Manager which manages the tags for this resource. -
getCertificateArn
The reference to an AWS -managed certificate that will be used by edge-optimized endpoint for this domain name. -
setCertificateArn
The reference to an AWS -managed certificate that will be used by edge-optimized endpoint for this domain name. -
getDomainName
The custom domain name as an API host name, for example,my-api.example.com
. -
setDomainName
The custom domain name as an API host name, for example,my-api.example.com
. -
getEndpointConfiguration
The endpoint configuration of this DomainName showing the endpoint types of the domain name. -
setEndpointConfiguration
The endpoint configuration of this DomainName showing the endpoint types of the domain name. -
setEndpointConfiguration
@Stability(Stable) public void setEndpointConfiguration(@Nullable CfnDomainName.EndpointConfigurationProperty value) The endpoint configuration of this DomainName showing the endpoint types of the domain name. -
getMutualTlsAuthentication
The mutual TLS authentication configuration for a custom domain name. -
setMutualTlsAuthentication
The mutual TLS authentication configuration for a custom domain name. -
setMutualTlsAuthentication
@Stability(Stable) public void setMutualTlsAuthentication(@Nullable CfnDomainName.MutualTlsAuthenticationProperty value) The mutual TLS authentication configuration for a custom domain name. -
getOwnershipVerificationCertificateArn
The ARN of the public certificate issued by ACM to validate ownership of your custom domain. -
setOwnershipVerificationCertificateArn
The ARN of the public certificate issued by ACM to validate ownership of your custom domain. -
getRegionalCertificateArn
The reference to an AWS -managed certificate that will be used for validating the regional domain name. -
setRegionalCertificateArn
The reference to an AWS -managed certificate that will be used for validating the regional domain name. -
getSecurityPolicy
The Transport Layer Security (TLS) version + cipher suite for this DomainName. -
setSecurityPolicy
The Transport Layer Security (TLS) version + cipher suite for this DomainName. -
getTagsRaw
The collection of tags. -
setTagsRaw
The collection of tags.
-