Package software.amazon.awscdk.services.apigateway

Class CfnDomainNameProps.Builder

java.lang.Object

software.amazon.awscdk.services.apigateway.CfnDomainNameProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnDomainNameProps>

Enclosing interface:

CfnDomainNameProps

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

A builder for CfnDomainNameProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnDomainNameProps	build()	Builds the configured instance.
CfnDomainNameProps.Builder	certificateArn(String certificateArn)	Sets the value of CfnDomainNameProps.getCertificateArn()
CfnDomainNameProps.Builder	domainName(String domainName)	Sets the value of CfnDomainNameProps.getDomainName()
CfnDomainNameProps.Builder	endpointConfiguration(IResolvable endpointConfiguration)	Sets the value of CfnDomainNameProps.getEndpointConfiguration()
CfnDomainNameProps.Builder	endpointConfiguration(CfnDomainName.EndpointConfigurationProperty endpointConfiguration)	Sets the value of CfnDomainNameProps.getEndpointConfiguration()
CfnDomainNameProps.Builder	mutualTlsAuthentication(IResolvable mutualTlsAuthentication)	Sets the value of CfnDomainNameProps.getMutualTlsAuthentication()
CfnDomainNameProps.Builder	mutualTlsAuthentication(CfnDomainName.MutualTlsAuthenticationProperty mutualTlsAuthentication)	Sets the value of CfnDomainNameProps.getMutualTlsAuthentication()
CfnDomainNameProps.Builder	ownershipVerificationCertificateArn(String ownershipVerificationCertificateArn)	Sets the value of CfnDomainNameProps.getOwnershipVerificationCertificateArn()
CfnDomainNameProps.Builder	regionalCertificateArn(String regionalCertificateArn)	Sets the value of CfnDomainNameProps.getRegionalCertificateArn()
CfnDomainNameProps.Builder	securityPolicy(String securityPolicy)	Sets the value of CfnDomainNameProps.getSecurityPolicy()
CfnDomainNameProps.Builder	tags(List<? extends CfnTag> tags)	Sets the value of CfnDomainNameProps.getTags()

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

certificateArn

@Stability(Stable)
public CfnDomainNameProps.Builder certificateArn(String certificateArn)

Sets the value of CfnDomainNameProps.getCertificateArn()

Parameters:

certificateArn - The reference to an AWS -managed certificate that will be used by edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.

Returns:

this

domainName

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

Sets the value of CfnDomainNameProps.getDomainName()

Parameters:

domainName - The custom domain name as an API host name, for example, my-api.example.com .

Returns:

this

endpointConfiguration

@Stability(Stable)
public CfnDomainNameProps.Builder endpointConfiguration(IResolvable endpointConfiguration)

Sets the value of CfnDomainNameProps.getEndpointConfiguration()

Parameters:

endpointConfiguration - The endpoint configuration of this DomainName showing the endpoint types of the domain name.

Returns:

this

endpointConfiguration

@Stability(Stable)
public CfnDomainNameProps.Builder endpointConfiguration(CfnDomainName.EndpointConfigurationProperty endpointConfiguration)

Sets the value of CfnDomainNameProps.getEndpointConfiguration()

Parameters:

endpointConfiguration - The endpoint configuration of this DomainName showing the endpoint types of the domain name.

Returns:

this

mutualTlsAuthentication

@Stability(Stable)
public CfnDomainNameProps.Builder mutualTlsAuthentication(IResolvable mutualTlsAuthentication)

Sets the value of CfnDomainNameProps.getMutualTlsAuthentication()

Parameters:

mutualTlsAuthentication - The mutual TLS authentication configuration for a custom domain name. If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your API.

Returns:

this

mutualTlsAuthentication

@Stability(Stable)
public CfnDomainNameProps.Builder mutualTlsAuthentication(CfnDomainName.MutualTlsAuthenticationProperty mutualTlsAuthentication)

Sets the value of CfnDomainNameProps.getMutualTlsAuthentication()

Parameters:

mutualTlsAuthentication - The mutual TLS authentication configuration for a custom domain name. If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your API.

Returns:

this

ownershipVerificationCertificateArn

@Stability(Stable)
public CfnDomainNameProps.Builder ownershipVerificationCertificateArn(String ownershipVerificationCertificateArn)

Sets the value of CfnDomainNameProps.getOwnershipVerificationCertificateArn()

Parameters:

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.

Returns:

this

regionalCertificateArn

@Stability(Stable)
public CfnDomainNameProps.Builder regionalCertificateArn(String regionalCertificateArn)

Sets the value of CfnDomainNameProps.getRegionalCertificateArn()

Parameters:

regionalCertificateArn - The reference to an AWS -managed certificate that will be used for validating the regional domain name. AWS Certificate Manager is the only supported source.

Returns:

this

securityPolicy

@Stability(Stable)
public CfnDomainNameProps.Builder securityPolicy(String securityPolicy)

Sets the value of CfnDomainNameProps.getSecurityPolicy()

Parameters:

securityPolicy - The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are TLS_1_0 and TLS_1_2 .

Returns:

this

tags

@Stability(Stable)
public CfnDomainNameProps.Builder tags(List<? extends CfnTag> tags)

Sets the value of CfnDomainNameProps.getTags()

Parameters:

tags - The collection of tags. Each tag element is associated with a given resource.

Returns:

this

build

@Stability(Stable)
public CfnDomainNameProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnDomainNameProps

Throws:

NullPointerException - if any required attribute was not provided