Package software.amazon.awscdk.services.apigatewayv2

Interface CfnDomainNameProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDomainNameProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:43.186Z")
@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.apigatewayv2.*;
 Object tags;
 CfnDomainNameProps cfnDomainNameProps = CfnDomainNameProps.builder()
         .domainName("domainName")
         // the properties below are optional
         .domainNameConfigurations(List.of(DomainNameConfigurationProperty.builder()
                 .certificateArn("certificateArn")
                 .certificateName("certificateName")
                 .endpointType("endpointType")
                 .ownershipVerificationCertificateArn("ownershipVerificationCertificateArn")
                 .securityPolicy("securityPolicy")
                 .build()))
         .mutualTlsAuthentication(MutualTlsAuthenticationProperty.builder()
                 .truststoreUri("truststoreUri")
                 .truststoreVersion("truststoreVersion")
                 .build())
         .tags(tags)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnDomainNameProps.Builder	builder()
String	getDomainName()	The custom domain name for your API in Amazon API Gateway.
default Object	getDomainNameConfigurations()	The domain name configurations.
default Object	getMutualTlsAuthentication()	The mutual TLS authentication configuration for a custom domain name.
default Object	getTags()	The collection of tags associated with a domain name.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDomainName

@Stability(Stable)
@NotNull
String getDomainName()

The custom domain name for your API in Amazon API Gateway.

Uppercase letters are not supported.

getDomainNameConfigurations

@Stability(Stable)
@Nullable
default Object getDomainNameConfigurations()

The domain name configurations.

getMutualTlsAuthentication

@Stability(Stable)
@Nullable
default Object getMutualTlsAuthentication()

The mutual TLS authentication configuration for a custom domain name.

getTags

@Stability(Stable)
@Nullable
default Object getTags()

The collection of tags associated with a domain name.

builder

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

Returns:

a CfnDomainNameProps.Builder of CfnDomainNameProps