Package software.amazon.awscdk.cfnpropertymixins.services.apigateway

Class CfnDomainNameMixinProps.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.apigateway.CfnDomainNameMixinProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnDomainNameMixinProps>

Enclosing interface:

CfnDomainNameMixinProps

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

A builder for CfnDomainNameMixinProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnDomainNameMixinProps	build()	Builds the configured instance.
CfnDomainNameMixinProps.Builder	certificateArn(String certificateArn)	Sets the value of CfnDomainNameMixinProps.getCertificateArn()
CfnDomainNameMixinProps.Builder	domainName(String domainName)	Sets the value of CfnDomainNameMixinProps.getDomainName()
CfnDomainNameMixinProps.Builder	endpointAccessMode(String endpointAccessMode)	Sets the value of CfnDomainNameMixinProps.getEndpointAccessMode()
CfnDomainNameMixinProps.Builder	endpointConfiguration(CfnDomainNamePropsMixin.EndpointConfigurationProperty endpointConfiguration)	Sets the value of CfnDomainNameMixinProps.getEndpointConfiguration()
CfnDomainNameMixinProps.Builder	endpointConfiguration(IResolvable endpointConfiguration)	Sets the value of CfnDomainNameMixinProps.getEndpointConfiguration()
CfnDomainNameMixinProps.Builder	mutualTlsAuthentication(CfnDomainNamePropsMixin.MutualTlsAuthenticationProperty mutualTlsAuthentication)	Sets the value of CfnDomainNameMixinProps.getMutualTlsAuthentication()
CfnDomainNameMixinProps.Builder	mutualTlsAuthentication(IResolvable mutualTlsAuthentication)	Sets the value of CfnDomainNameMixinProps.getMutualTlsAuthentication()
CfnDomainNameMixinProps.Builder	ownershipVerificationCertificateArn(String ownershipVerificationCertificateArn)	Sets the value of CfnDomainNameMixinProps.getOwnershipVerificationCertificateArn()
CfnDomainNameMixinProps.Builder	regionalCertificateArn(String regionalCertificateArn)	Sets the value of CfnDomainNameMixinProps.getRegionalCertificateArn()
CfnDomainNameMixinProps.Builder	routingMode(String routingMode)	Sets the value of CfnDomainNameMixinProps.getRoutingMode()
CfnDomainNameMixinProps.Builder	securityPolicy(String securityPolicy)	Sets the value of CfnDomainNameMixinProps.getSecurityPolicy()
CfnDomainNameMixinProps.Builder	tags(List<? extends CfnTag> tags)	Sets the value of CfnDomainNameMixinProps.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 CfnDomainNameMixinProps.Builder certificateArn(String certificateArn)

Sets the value of CfnDomainNameMixinProps.getCertificateArn()

Parameters:

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

Returns:

this

domainName

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

Sets the value of CfnDomainNameMixinProps.getDomainName()

Parameters:

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

Returns:

this

endpointAccessMode

@Stability(Stable)
public CfnDomainNameMixinProps.Builder endpointAccessMode(String endpointAccessMode)

Sets the value of CfnDomainNameMixinProps.getEndpointAccessMode()

Parameters:

endpointAccessMode - The endpoint access mode for your DomainName.

Returns:

this

endpointConfiguration

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

Sets the value of CfnDomainNameMixinProps.getEndpointConfiguration()

Parameters:

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

Returns:

this

endpointConfiguration

@Stability(Stable)
public CfnDomainNameMixinProps.Builder endpointConfiguration(CfnDomainNamePropsMixin.EndpointConfigurationProperty endpointConfiguration)

Sets the value of CfnDomainNameMixinProps.getEndpointConfiguration()

Parameters:

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

Returns:

this

mutualTlsAuthentication

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

Sets the value of CfnDomainNameMixinProps.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 CfnDomainNameMixinProps.Builder mutualTlsAuthentication(CfnDomainNamePropsMixin.MutualTlsAuthenticationProperty mutualTlsAuthentication)

Sets the value of CfnDomainNameMixinProps.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 CfnDomainNameMixinProps.Builder ownershipVerificationCertificateArn(String ownershipVerificationCertificateArn)

Sets the value of CfnDomainNameMixinProps.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 CfnDomainNameMixinProps.Builder regionalCertificateArn(String regionalCertificateArn)

Sets the value of CfnDomainNameMixinProps.getRegionalCertificateArn()

Parameters:

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

Returns:

this

routingMode

@Stability(Stable)
public CfnDomainNameMixinProps.Builder routingMode(String routingMode)

Sets the value of CfnDomainNameMixinProps.getRoutingMode()

Parameters:

routingMode - The routing mode for this domain name. The routing mode determines how API Gateway sends traffic from your custom domain name to your public APIs.

Returns:

this

securityPolicy

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

Sets the value of CfnDomainNameMixinProps.getSecurityPolicy()

Parameters:

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

Returns:

this

tags

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

Sets the value of CfnDomainNameMixinProps.getTags()

Parameters:

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

Returns:

this

build

@Stability(Stable)
public CfnDomainNameMixinProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnDomainNameMixinProps

Throws:

NullPointerException - if any required attribute was not provided