Package software.amazon.awscdk.services.sam

Interface CfnApi.DomainConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnApi.DomainConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnApi

@Stability(Stable)
public static interface CfnApi.DomainConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

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.sam.*;
 DomainConfigurationProperty domainConfigurationProperty = DomainConfigurationProperty.builder()
         .certificateArn("certificateArn")
         .domainName("domainName")
         // the properties below are optional
         .basePath(List.of("basePath"))
         .endpointConfiguration("endpointConfiguration")
         .mutualTlsAuthentication(MutualTlsAuthenticationProperty.builder()
                 .truststoreUri("truststoreUri")
                 .truststoreVersion("truststoreVersion")
                 .build())
         .ownershipVerificationCertificateArn("ownershipVerificationCertificateArn")
         .route53(Route53ConfigurationProperty.builder()
                 .distributedDomainName("distributedDomainName")
                 .evaluateTargetHealth(false)
                 .hostedZoneId("hostedZoneId")
                 .hostedZoneName("hostedZoneName")
                 .ipV6(false)
                 .build())
         .securityPolicy("securityPolicy")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnApi.DomainConfigurationProperty.Builder	builder()
default List<String>	getBasePath()	`CfnApi.DomainConfigurationProperty.BasePath`.
String	getCertificateArn()	`CfnApi.DomainConfigurationProperty.CertificateArn`.
String	getDomainName()	`CfnApi.DomainConfigurationProperty.DomainName`.
default String	getEndpointConfiguration()	`CfnApi.DomainConfigurationProperty.EndpointConfiguration`.
default Object	getMutualTlsAuthentication()	`CfnApi.DomainConfigurationProperty.MutualTlsAuthentication`.
default String	getOwnershipVerificationCertificateArn()	`CfnApi.DomainConfigurationProperty.OwnershipVerificationCertificateArn`.
default Object	getRoute53()	`CfnApi.DomainConfigurationProperty.Route53`.
default String	getSecurityPolicy()	`CfnApi.DomainConfigurationProperty.SecurityPolicy`.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCertificateArn

@Stability(Stable)
@NotNull
String getCertificateArn()

`CfnApi.DomainConfigurationProperty.CertificateArn`.

getDomainName

@Stability(Stable)
@NotNull
String getDomainName()

`CfnApi.DomainConfigurationProperty.DomainName`.

getBasePath

@Stability(Stable)
@Nullable
default List<String> getBasePath()

`CfnApi.DomainConfigurationProperty.BasePath`.

getEndpointConfiguration

@Stability(Stable)
@Nullable
default String getEndpointConfiguration()

`CfnApi.DomainConfigurationProperty.EndpointConfiguration`.

getMutualTlsAuthentication

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

`CfnApi.DomainConfigurationProperty.MutualTlsAuthentication`.

getOwnershipVerificationCertificateArn

@Stability(Stable)
@Nullable
default String getOwnershipVerificationCertificateArn()

`CfnApi.DomainConfigurationProperty.OwnershipVerificationCertificateArn`.

getRoute53

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

`CfnApi.DomainConfigurationProperty.Route53`.

getSecurityPolicy

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

`CfnApi.DomainConfigurationProperty.SecurityPolicy`.

builder

@Stability(Stable)
static CfnApi.DomainConfigurationProperty.Builder builder()

Returns:

a CfnApi.DomainConfigurationProperty.Builder of CfnApi.DomainConfigurationProperty