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(Stable)
public static final class DomainName.Builder
extends Object
implements software.amazon.jsii.Builder<DomainName>
A fluent builder for
DomainName
.-
Method Summary
Modifier and TypeMethodDescriptionbuild()
certificate
(ICertificate certificate) The ACM certificate for this domain name.certificateName
(String certificateName) The user-friendly name of the certificate that will be used by the endpoint for this domain name.static DomainName.Builder
domainName
(String domainName) The custom domain name.endpointType
(EndpointType endpointType) The type of endpoint for this DomainName.mtls
(MTLSConfig mtls) The mutual TLS authentication configuration for a custom domain name.ownershipCertificate
(ICertificate ownershipCertificate) A public certificate issued by ACM to validate that you own a custom domain.securityPolicy
(SecurityPolicy securityPolicy) The Transport Layer Security (TLS) version + cipher suite for this domain name.
-
Method Details
-
create
@Stability(Stable) 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
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
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
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(Stable) public DomainName.Builder ownershipCertificate(ICertificate 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.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
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
The custom domain name.- Parameters:
domainName
- The custom domain name. This parameter is required.- Returns:
this
-
mtls
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
- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<DomainName>
- Returns:
- a newly built instance of
DomainName
.
-