software.amazon.awscdk.services.apigatewayv2

Class DomainName.Builder

java.lang.Object

software.amazon.awscdk.services.apigatewayv2.DomainName.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<DomainName>

Enclosing class:

DomainName

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

(experimental) A fluent builder for DomainName.

Method Summary

Modifier and Type	Method and Description
DomainName	build()
DomainName.Builder	certificate(ICertificate certificate) (experimental) The ACM certificate for this domain name.
DomainName.Builder	certificateName(String certificateName) (experimental) The user-friendly name of the certificate that will be used by the endpoint for this domain name.
static DomainName.Builder	create(software.constructs.Construct scope, String id)
DomainName.Builder	domainName(String domainName) (experimental) The custom domain name.
DomainName.Builder	endpointType(EndpointType endpointType) (experimental) The type of endpoint for this DomainName.
DomainName.Builder	mtls(MTLSConfig mtls) (experimental) The mutual TLS authentication configuration for a custom domain name.
DomainName.Builder	ownershipCertificate(ICertificate ownershipCertificate) (experimental) A public certificate issued by ACM to validate that you own a custom domain.
DomainName.Builder	securityPolicy(SecurityPolicy securityPolicy) (experimental) The Transport Layer Security (TLS) version + cipher suite for this 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=Experimental)
public static DomainName.Builder create(software.constructs.Construct scope,
                                                                       String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of DomainName.Builder.

certificate

@Stability(value=Experimental)
public DomainName.Builder certificate(ICertificate certificate)

(experimental) The ACM certificate for this domain name.

Certificate can be both ACM issued or imported.

Parameters:

certificate - The ACM certificate for this domain name. This parameter is required.

Returns:

this

certificateName

@Stability(value=Experimental)
public DomainName.Builder certificateName(String certificateName)

(experimental) The user-friendly name of the certificate that will be used by the endpoint for this domain name.

Default: - No friendly certificate name

Parameters:

certificateName - The user-friendly name of the certificate that will be used by the endpoint for this domain name. This parameter is required.

Returns:

this

endpointType

@Stability(value=Experimental)
public DomainName.Builder endpointType(EndpointType endpointType)

(experimental) The type of endpoint for this DomainName.

Default: EndpointType.REGIONAL

Parameters:

endpointType - The type of endpoint for this DomainName. This parameter is required.

Returns:

this

ownershipCertificate

@Stability(value=Experimental)
public DomainName.Builder ownershipCertificate(ICertificate ownershipCertificate)

(experimental) A public certificate issued by ACM to validate that you own a custom domain.

This parameter is required only when you configure mutual TLS authentication and you specify an ACM imported or private CA certificate for certificate. The ownership certificate validates that you have permissions to use the domain name.

Default: - only required when configuring mTLS

Parameters:

ownershipCertificate - A public certificate issued by ACM to validate that you own a custom domain. This parameter is required.

Returns:

this

securityPolicy

@Stability(value=Experimental)
public DomainName.Builder securityPolicy(SecurityPolicy securityPolicy)

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

Default: SecurityPolicy.TLS_1_2

Parameters:

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

Returns:

this

domainName

@Stability(value=Experimental)
public DomainName.Builder domainName(String domainName)

(experimental) The custom domain name.

Parameters:

domainName - The custom domain name. This parameter is required.

Returns:

this

mtls

@Stability(value=Experimental)
public DomainName.Builder mtls(MTLSConfig mtls)

(experimental) The mutual TLS authentication configuration for a custom domain name.

Default: - mTLS is not configured.

Parameters:

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

Returns:

this

build

@Stability(value=Experimental)
public DomainName build()

Specified by:

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