software.amazon.awscdk.services.apigateway

Class CfnDomainName.Builder

java.lang.Object

software.amazon.awscdk.services.apigateway.CfnDomainName.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnDomainName>

Enclosing class:

CfnDomainName

@Stability(value=Stable)
public static final class CfnDomainName.Builder
extends Object
implements software.amazon.jsii.Builder<CfnDomainName>

A fluent builder for CfnDomainName.

Method Summary

Modifier and Type	Method and Description
CfnDomainName	build()
CfnDomainName.Builder	certificateArn(String certificateArn) The reference to an AWS -managed certificate for use by the edge-optimized endpoint for this domain name.
static CfnDomainName.Builder	create(software.constructs.Construct scope, String id)
CfnDomainName.Builder	domainName(String domainName) The custom domain name for your API.
CfnDomainName.Builder	endpointConfiguration(CfnDomainName.EndpointConfigurationProperty endpointConfiguration) A list of the endpoint types of the domain name.
CfnDomainName.Builder	endpointConfiguration(IResolvable endpointConfiguration) A list of the endpoint types of the domain name.
CfnDomainName.Builder	mutualTlsAuthentication(CfnDomainName.MutualTlsAuthenticationProperty mutualTlsAuthentication) The mutual TLS authentication configuration for a custom domain name.
CfnDomainName.Builder	mutualTlsAuthentication(IResolvable mutualTlsAuthentication) The mutual TLS authentication configuration for a custom domain name.
CfnDomainName.Builder	ownershipVerificationCertificateArn(String ownershipVerificationCertificateArn) The ARN of the public certificate issued by ACM to validate ownership of your custom domain.
CfnDomainName.Builder	regionalCertificateArn(String regionalCertificateArn) The reference to an AWS -managed certificate for use by the regional endpoint for the domain name.
CfnDomainName.Builder	securityPolicy(String securityPolicy) The Transport Layer Security (TLS) version + cipher suite for this domain name.
CfnDomainName.Builder	tags(List<? extends CfnTag> tags) An array of arbitrary tags (key-value pairs) to associate with the domain name.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

@Stability(value=Stable)
public static CfnDomainName.Builder create(software.constructs.Construct scope,
                                                                    String id)

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

Returns:

a new instance of CfnDomainName.EndpointConfigurationProperty.Builder.

certificateArn

@Stability(value=Stable)
public CfnDomainName.Builder certificateArn(String certificateArn)

The reference to an AWS -managed certificate for use by the edge-optimized endpoint for this domain name.

AWS Certificate Manager is the only supported source. For requirements and additional information about setting up certificates, see Get Certificates Ready in AWS Certificate Manager in the API Gateway Developer Guide .

Parameters:

certificateArn - The reference to an AWS -managed certificate for use by the edge-optimized endpoint for this domain name. This parameter is required.

Returns:

this

domainName

@Stability(value=Stable)
public CfnDomainName.Builder domainName(String domainName)

The custom domain name for your API.

Uppercase letters are not supported.

Parameters:

domainName - The custom domain name for your API. This parameter is required.

Returns:

this

endpointConfiguration

@Stability(value=Stable)
public CfnDomainName.Builder endpointConfiguration(CfnDomainName.EndpointConfigurationProperty endpointConfiguration)

A list of the endpoint types of the domain name.

Parameters:

endpointConfiguration - A list of the endpoint types of the domain name. This parameter is required.

Returns:

this

endpointConfiguration

@Stability(value=Stable)
public CfnDomainName.Builder endpointConfiguration(IResolvable endpointConfiguration)

A list of the endpoint types of the domain name.

Parameters:

endpointConfiguration - A list of the endpoint types of the domain name. This parameter is required.

Returns:

this

mutualTlsAuthentication

@Stability(value=Stable)
public CfnDomainName.Builder mutualTlsAuthentication(CfnDomainName.MutualTlsAuthenticationProperty mutualTlsAuthentication)

The mutual TLS authentication configuration for a custom domain name.

Parameters:

mutualTlsAuthentication - The mutual TLS authentication configuration for a custom domain name. This parameter is required.

Returns:

this

mutualTlsAuthentication

@Stability(value=Stable)
public CfnDomainName.Builder mutualTlsAuthentication(IResolvable mutualTlsAuthentication)

The mutual TLS authentication configuration for a custom domain name.

Parameters:

mutualTlsAuthentication - The mutual TLS authentication configuration for a custom domain name. This parameter is required.

Returns:

this

ownershipVerificationCertificateArn

@Stability(value=Stable)
public CfnDomainName.Builder ownershipVerificationCertificateArn(String ownershipVerificationCertificateArn)

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.

Parameters:

ownershipVerificationCertificateArn - The ARN of the public certificate issued by ACM to validate ownership of your custom domain. This parameter is required.

Returns:

this

regionalCertificateArn

@Stability(value=Stable)
public CfnDomainName.Builder regionalCertificateArn(String regionalCertificateArn)

The reference to an AWS -managed certificate for use by the regional endpoint for the domain name.

AWS Certificate Manager is the only supported source.

Parameters:

regionalCertificateArn - The reference to an AWS -managed certificate for use by the regional endpoint for the domain name. This parameter is required.

Returns:

this

securityPolicy

@Stability(value=Stable)
public CfnDomainName.Builder securityPolicy(String securityPolicy)

The Transport Layer Security (TLS) version + cipher suite for this domain name.

Valid values include TLS_1_0 and TLS_1_2 .

Parameters:

securityPolicy - The Transport Layer Security (TLS) version + cipher suite for this domain name. This parameter is required.

Returns:

this

tags

@Stability(value=Stable)
public CfnDomainName.Builder tags(List<? extends CfnTag> tags)

An array of arbitrary tags (key-value pairs) to associate with the domain name.

Parameters:

tags - An array of arbitrary tags (key-value pairs) to associate with the domain name. This parameter is required.

Returns:

this

build

@Stability(value=Stable)
public CfnDomainName build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnDomainName>