Package software.amazon.awscdk.cfnpropertymixins.services.sam

Interface CfnApiPropsMixin.DomainConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnApiPropsMixin.DomainConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnApiPropsMixin

@Stability(Stable)
public static interface CfnApiPropsMixin.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.cfnpropertymixins.services.sam.*;
 DomainConfigurationProperty domainConfigurationProperty = DomainConfigurationProperty.builder()
         .basePath(List.of("basePath"))
         .certificateArn("certificateArn")
         .domainName("domainName")
         .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();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-api-domainconfiguration.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnApiPropsMixin.DomainConfigurationProperty.Builder	builder()
default List<String>	getBasePath()
default String	getCertificateArn()
default String	getDomainName()
default String	getEndpointConfiguration()
default Object	getMutualTlsAuthentication()	Returns union: either IResolvable or CfnApiPropsMixin.MutualTlsAuthenticationProperty
default String	getOwnershipVerificationCertificateArn()
default Object	getRoute53()	Returns union: either IResolvable or CfnApiPropsMixin.Route53ConfigurationProperty
default String	getSecurityPolicy()

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getBasePath

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-api-domainconfiguration.html#cfn-serverless-api-domainconfiguration-basepath

getCertificateArn

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-api-domainconfiguration.html#cfn-serverless-api-domainconfiguration-certificatearn

getDomainName

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-api-domainconfiguration.html#cfn-serverless-api-domainconfiguration-domainname

getEndpointConfiguration

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-api-domainconfiguration.html#cfn-serverless-api-domainconfiguration-endpointconfiguration

getMutualTlsAuthentication

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

Returns union: either IResolvable or CfnApiPropsMixin.MutualTlsAuthenticationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-api-domainconfiguration.html#cfn-serverless-api-domainconfiguration-mutualtlsauthentication

getOwnershipVerificationCertificateArn

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-api-domainconfiguration.html#cfn-serverless-api-domainconfiguration-ownershipverificationcertificatearn

getRoute53

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

Returns union: either IResolvable or CfnApiPropsMixin.Route53ConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-api-domainconfiguration.html#cfn-serverless-api-domainconfiguration-route53

getSecurityPolicy

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-api-domainconfiguration.html#cfn-serverless-api-domainconfiguration-securitypolicy

builder

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

Returns:

a CfnApiPropsMixin.DomainConfigurationProperty.Builder of CfnApiPropsMixin.DomainConfigurationProperty