Interface CfnDomainNameProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnDomainNameProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
date="2024-11-22T02:23:56.139Z")
@Stability(Stable)
public interface CfnDomainNameProps
extends software.amazon.jsii.JsiiSerializable
Properties for defining a
CfnDomainName
.
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.*; CfnDomainNameProps cfnDomainNameProps = CfnDomainNameProps.builder() .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
Modifier and TypeInterfaceDescriptionstatic final class
A builder forCfnDomainNameProps
static final class
An implementation forCfnDomainNameProps
-
Method Summary
Modifier and TypeMethodDescriptionstatic CfnDomainNameProps.Builder
builder()
default String
The reference to an AWS -managed certificate that will be used by edge-optimized endpoint for this domain name.default String
The custom domain name as an API host name, for example,my-api.example.com
.default Object
The endpoint configuration of this DomainName showing the endpoint types of the domain name.default Object
The mutual TLS authentication configuration for a custom domain name.default String
The ARN of the public certificate issued by ACM to validate ownership of your custom domain.default String
The reference to an AWS -managed certificate that will be used for validating the regional domain name.default String
The Transport Layer Security (TLS) version + cipher suite for this DomainName.getTags()
The collection of tags.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getCertificateArn
The reference to an AWS -managed certificate that will be used by edge-optimized endpoint for this domain name.AWS Certificate Manager is the only supported source.
- See Also:
-
getDomainName
The custom domain name as an API host name, for example,my-api.example.com
.- See Also:
-
getEndpointConfiguration
The endpoint configuration of this DomainName showing the endpoint types of the domain name.- See Also:
-
getMutualTlsAuthentication
The mutual TLS authentication configuration for a custom domain name.If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your API.
- See Also:
-
getOwnershipVerificationCertificateArn
The ARN of the public certificate issued by ACM to validate ownership of your custom domain.Only required when configuring mutual TLS and using an ACM imported or private CA certificate ARN as the RegionalCertificateArn.
- See Also:
-
getRegionalCertificateArn
The reference to an AWS -managed certificate that will be used for validating the regional domain name.AWS Certificate Manager is the only supported source.
- See Also:
-
getSecurityPolicy
The Transport Layer Security (TLS) version + cipher suite for this DomainName.The valid values are
TLS_1_0
andTLS_1_2
.- See Also:
-
getTags
The collection of tags.Each tag element is associated with a given resource.
- See Also:
-
builder
- Returns:
- a
CfnDomainNameProps.Builder
ofCfnDomainNameProps
-