Package software.amazon.awscdk.services.sam

Interface CfnHttpApi.HttpApiDomainConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnHttpApi.HttpApiDomainConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnHttpApi

@Stability(Stable)
public static interface CfnHttpApi.HttpApiDomainConfigurationProperty
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.*;
 HttpApiDomainConfigurationProperty httpApiDomainConfigurationProperty = HttpApiDomainConfigurationProperty.builder()
         .certificateArn("certificateArn")
         .domainName("domainName")
         // the properties below are optional
         .basePath("basePath")
         .endpointConfiguration("endpointConfiguration")
         .mutualTlsAuthentication(MutualTlsAuthenticationProperty.builder()
                 .truststoreUri("truststoreUri")
                 .truststoreVersion(false)
                 .build())
         .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-httpapi-httpapidomainconfiguration.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnHttpApi.HttpApiDomainConfigurationProperty.Builder	builder()
default String	getBasePath()
String	getCertificateArn()
String	getDomainName()
default String	getEndpointConfiguration()
default Object	getMutualTlsAuthentication()	Returns union: either IResolvable or CfnHttpApi.MutualTlsAuthenticationProperty
default Object	getRoute53()	Returns union: either IResolvable or CfnHttpApi.Route53ConfigurationProperty
default String	getSecurityPolicy()

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCertificateArn

@Stability(Stable)
@NotNull
String getCertificateArn()

See Also:

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

getDomainName

@Stability(Stable)
@NotNull
String getDomainName()

See Also:

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

getBasePath

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

See Also:

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

getEndpointConfiguration

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

See Also:

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

getMutualTlsAuthentication

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

Returns union: either IResolvable or CfnHttpApi.MutualTlsAuthenticationProperty

See Also:

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

getRoute53

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

Returns union: either IResolvable or CfnHttpApi.Route53ConfigurationProperty

See Also:

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

getSecurityPolicy

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

See Also:

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

builder

@Stability(Stable)
static CfnHttpApi.HttpApiDomainConfigurationProperty.Builder builder()

Returns:

a CfnHttpApi.HttpApiDomainConfigurationProperty.Builder of CfnHttpApi.HttpApiDomainConfigurationProperty