Package software.amazon.awscdk.services.apigatewayv2

Class DomainNameProps.Builder

java.lang.Object

software.amazon.awscdk.services.apigatewayv2.DomainNameProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<DomainNameProps>

Enclosing interface:

DomainNameProps

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

A builder for DomainNameProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
DomainNameProps	build()	Builds the configured instance.
DomainNameProps.Builder	certificate(ICertificate certificate)	Sets the value of EndpointOptions.getCertificate()
DomainNameProps.Builder	certificateName(String certificateName)	Sets the value of EndpointOptions.getCertificateName()
DomainNameProps.Builder	domainName(String domainName)	Sets the value of DomainNameProps.getDomainName()
DomainNameProps.Builder	endpointType(EndpointType endpointType)	Sets the value of EndpointOptions.getEndpointType()
DomainNameProps.Builder	mtls(MTLSConfig mtls)	Sets the value of DomainNameProps.getMtls()
DomainNameProps.Builder	ownershipCertificate(ICertificate ownershipCertificate)	Sets the value of EndpointOptions.getOwnershipCertificate()
DomainNameProps.Builder	securityPolicy(SecurityPolicy securityPolicy)	Sets the value of EndpointOptions.getSecurityPolicy()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

domainName

@Stability(Stable)
public DomainNameProps.Builder domainName(String domainName)

Sets the value of DomainNameProps.getDomainName()

Parameters:

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

Returns:

this

mtls

@Stability(Stable)
public DomainNameProps.Builder mtls(MTLSConfig mtls)

Sets the value of DomainNameProps.getMtls()

Parameters:

mtls - The mutual TLS authentication configuration for a custom domain name.

Returns:

this

certificate

@Stability(Stable)
public DomainNameProps.Builder certificate(ICertificate certificate)

Sets the value of EndpointOptions.getCertificate()

Parameters:

certificate - The ACM certificate for this domain name. This parameter is required. Certificate can be both ACM issued or imported.

Returns:

this

certificateName

@Stability(Stable)
public DomainNameProps.Builder certificateName(String certificateName)

Sets the value of EndpointOptions.getCertificateName()

Parameters:

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

Returns:

this

endpointType

@Stability(Stable)
public DomainNameProps.Builder endpointType(EndpointType endpointType)

Sets the value of EndpointOptions.getEndpointType()

Parameters:

endpointType - The type of endpoint for this DomainName.

Returns:

this

ownershipCertificate

@Stability(Stable)
public DomainNameProps.Builder ownershipCertificate(ICertificate ownershipCertificate)

Sets the value of EndpointOptions.getOwnershipCertificate()

Parameters:

ownershipCertificate - 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.

Returns:

this

securityPolicy

@Stability(Stable)
public DomainNameProps.Builder securityPolicy(SecurityPolicy securityPolicy)

Sets the value of EndpointOptions.getSecurityPolicy()

Parameters:

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

Returns:

this

build

@Stability(Stable)
public DomainNameProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of DomainNameProps

Throws:

NullPointerException - if any required attribute was not provided