software.amazon.awscdk.services.apigatewayv2

Interface CfnDomainName.DomainNameConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDomainName.DomainNameConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnDomainName

@Stability(value=Stable)
public static interface CfnDomainName.DomainNameConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

The `DomainNameConfiguration` property type specifies the configuration for a an API's domain name.

DomainNameConfiguration is a property of the AWS::ApiGatewayV2::DomainName resource.

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.*;
 DomainNameConfigurationProperty domainNameConfigurationProperty = DomainNameConfigurationProperty.builder()
         .certificateArn("certificateArn")
         .certificateName("certificateName")
         .endpointType("endpointType")
         .ownershipVerificationCertificateArn("ownershipVerificationCertificateArn")
         .securityPolicy("securityPolicy")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnDomainName.DomainNameConfigurationProperty.Builder	builder()
default String	getCertificateArn() An AWS -managed certificate that will be used by the edge-optimized endpoint for this domain name.
default String	getCertificateName() The user-friendly name of the certificate that will be used by the edge-optimized endpoint for this domain name.
default String	getEndpointType() The endpoint type.
default String	getOwnershipVerificationCertificateArn() The ARN of the public certificate issued by ACM to validate ownership of your custom domain.
default String	getSecurityPolicy() The Transport Layer Security (TLS) version of the security policy for this domain name.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getCertificateArn

@Stability(value=Stable)
 @Nullable
default String getCertificateArn()

An AWS -managed certificate that will be used by the edge-optimized endpoint for this domain name.

AWS Certificate Manager is the only supported source.

getCertificateName

@Stability(value=Stable)
 @Nullable
default String getCertificateName()

The user-friendly name of the certificate that will be used by the edge-optimized endpoint for this domain name.

getEndpointType

@Stability(value=Stable)
 @Nullable
default String getEndpointType()

The endpoint type.

getOwnershipVerificationCertificateArn

@Stability(value=Stable)
 @Nullable
default String 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.

getSecurityPolicy

@Stability(value=Stable)
 @Nullable
default String getSecurityPolicy()

The Transport Layer Security (TLS) version of the security policy for this domain name.

The valid values are TLS_1_0 and TLS_1_2 .

builder

@Stability(value=Stable)
static CfnDomainName.DomainNameConfigurationProperty.Builder builder()

Returns:

a CfnDomainName.DomainNameConfigurationProperty.Builder of CfnDomainName.DomainNameConfigurationProperty