software.amazon.awssdk.services.apigateway.model

Interface DomainName.Builder

All Superinterfaces:

Buildable, CopyableBuilder<DomainName.Builder,DomainName>, SdkBuilder<DomainName.Builder,DomainName>, SdkPojo

Enclosing class:

DomainName

public static interface DomainName.Builder
extends SdkPojo, CopyableBuilder<DomainName.Builder,DomainName>

Method Summary

Modifier and Type	Method and Description
DomainName.Builder	certificateArn(String certificateArn) The reference to an Amazon Web Services-managed certificate that will be used by edge-optimized endpoint for this domain name.
DomainName.Builder	certificateName(String certificateName) The name of the certificate that will be used by edge-optimized endpoint for this domain name.
DomainName.Builder	certificateUploadDate(Instant certificateUploadDate) The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.
DomainName.Builder	distributionDomainName(String distributionDomainName) The domain name of the Amazon CloudFront distribution associated with this custom domain name for an edge-optimized endpoint.
DomainName.Builder	distributionHostedZoneId(String distributionHostedZoneId) The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized endpoint.
DomainName.Builder	domainName(String domainName) The custom domain name as an API host name, for example, my-api.example.com.
DomainName.Builder	domainNameStatus(DomainNameStatus domainNameStatus) The status of the DomainName migration.
DomainName.Builder	domainNameStatus(String domainNameStatus) The status of the DomainName migration.
DomainName.Builder	domainNameStatusMessage(String domainNameStatusMessage) An optional text message containing detailed information about status of the DomainName migration.
default DomainName.Builder	endpointConfiguration(Consumer<EndpointConfiguration.Builder> endpointConfiguration) The endpoint configuration of this DomainName showing the endpoint types of the domain name.
DomainName.Builder	endpointConfiguration(EndpointConfiguration endpointConfiguration) The endpoint configuration of this DomainName showing the endpoint types of the domain name.
default DomainName.Builder	mutualTlsAuthentication(Consumer<MutualTlsAuthentication.Builder> mutualTlsAuthentication) The mutual TLS authentication configuration for a custom domain name.
DomainName.Builder	mutualTlsAuthentication(MutualTlsAuthentication mutualTlsAuthentication) The mutual TLS authentication configuration for a custom domain name.
DomainName.Builder	ownershipVerificationCertificateArn(String ownershipVerificationCertificateArn) The ARN of the public certificate issued by ACM to validate ownership of your custom domain.
DomainName.Builder	regionalCertificateArn(String regionalCertificateArn) The reference to an Amazon Web Services-managed certificate that will be used for validating the regional domain name.
DomainName.Builder	regionalCertificateName(String regionalCertificateName) The name of the certificate that will be used for validating the regional domain name.
DomainName.Builder	regionalDomainName(String regionalDomainName) The domain name associated with the regional endpoint for this custom domain name.
DomainName.Builder	regionalHostedZoneId(String regionalHostedZoneId) The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint.
DomainName.Builder	securityPolicy(SecurityPolicy securityPolicy) The Transport Layer Security (TLS) version + cipher suite for this DomainName.
DomainName.Builder	securityPolicy(String securityPolicy) The Transport Layer Security (TLS) version + cipher suite for this DomainName.
DomainName.Builder	tags(Map<String,String> tags) The collection of tags.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

domainName

DomainName.Builder domainName(String domainName)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

certificateName

DomainName.Builder certificateName(String certificateName)

The name of the certificate that will be used by edge-optimized endpoint for this domain name.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

certificateArn

DomainName.Builder certificateArn(String certificateArn)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

certificateUploadDate

DomainName.Builder certificateUploadDate(Instant certificateUploadDate)

The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.

Parameters:

certificateUploadDate - The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.

Returns:

Returns a reference to this object so that method calls can be chained together.

regionalDomainName

DomainName.Builder regionalDomainName(String regionalDomainName)

The domain name associated with the regional endpoint for this custom domain name. You set up this association by adding a DNS record that points the custom domain name to this regional domain name. The regional domain name is returned by API Gateway when you create a regional endpoint.

Parameters:

regionalDomainName - The domain name associated with the regional endpoint for this custom domain name. You set up this association by adding a DNS record that points the custom domain name to this regional domain name. The regional domain name is returned by API Gateway when you create a regional endpoint.

Returns:

Returns a reference to this object so that method calls can be chained together.

regionalHostedZoneId

DomainName.Builder regionalHostedZoneId(String regionalHostedZoneId)

The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.

Parameters:

regionalHostedZoneId - The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.

Returns:

Returns a reference to this object so that method calls can be chained together.

regionalCertificateName

DomainName.Builder regionalCertificateName(String regionalCertificateName)

The name of the certificate that will be used for validating the regional domain name.

Parameters:

regionalCertificateName - The name of the certificate that will be used for validating the regional domain name.

Returns:

Returns a reference to this object so that method calls can be chained together.

regionalCertificateArn

DomainName.Builder regionalCertificateArn(String regionalCertificateArn)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

distributionDomainName

DomainName.Builder distributionDomainName(String distributionDomainName)

The domain name of the Amazon CloudFront distribution associated with this custom domain name for an edge-optimized endpoint. You set up this association when adding a DNS record pointing the custom domain name to this distribution name. For more information about CloudFront distributions, see the Amazon CloudFront documentation.

Parameters:

distributionDomainName - The domain name of the Amazon CloudFront distribution associated with this custom domain name for an edge-optimized endpoint. You set up this association when adding a DNS record pointing the custom domain name to this distribution name. For more information about CloudFront distributions, see the Amazon CloudFront documentation.

Returns:

Returns a reference to this object so that method calls can be chained together.

distributionHostedZoneId

DomainName.Builder distributionHostedZoneId(String distributionHostedZoneId)

The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized endpoint. The valid value is Z2FDTNDATAQYW2 for all the regions. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.

Parameters:

distributionHostedZoneId - The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized endpoint. The valid value is Z2FDTNDATAQYW2 for all the regions. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.

Returns:

Returns a reference to this object so that method calls can be chained together.

endpointConfiguration

DomainName.Builder endpointConfiguration(EndpointConfiguration endpointConfiguration)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

endpointConfiguration

default DomainName.Builder endpointConfiguration(Consumer<EndpointConfiguration.Builder> endpointConfiguration)

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

This is a convenience method that creates an instance of the EndpointConfiguration.Builder avoiding the need to create one manually via EndpointConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to endpointConfiguration(EndpointConfiguration).

Parameters:

endpointConfiguration - a consumer that will call methods on EndpointConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

endpointConfiguration(EndpointConfiguration)

domainNameStatus

DomainName.Builder domainNameStatus(String domainNameStatus)

The status of the DomainName migration. The valid values are AVAILABLE and UPDATING . If the status is UPDATING, the domain cannot be modified further until the existing operation is complete. If it is AVAILABLE, the domain can be updated.

Parameters:

domainNameStatus - The status of the DomainName migration. The valid values are AVAILABLE and UPDATING. If the status is UPDATING, the domain cannot be modified further until the existing operation is complete. If it is AVAILABLE, the domain can be updated.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

DomainNameStatus, DomainNameStatus

domainNameStatus

DomainName.Builder domainNameStatus(DomainNameStatus domainNameStatus)

The status of the DomainName migration. The valid values are AVAILABLE and UPDATING . If the status is UPDATING, the domain cannot be modified further until the existing operation is complete. If it is AVAILABLE, the domain can be updated.

Parameters:

domainNameStatus - The status of the DomainName migration. The valid values are AVAILABLE and UPDATING. If the status is UPDATING, the domain cannot be modified further until the existing operation is complete. If it is AVAILABLE, the domain can be updated.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

DomainNameStatus, DomainNameStatus

domainNameStatusMessage

DomainName.Builder domainNameStatusMessage(String domainNameStatusMessage)

An optional text message containing detailed information about status of the DomainName migration.

Parameters:

domainNameStatusMessage - An optional text message containing detailed information about status of the DomainName migration.

Returns:

Returns a reference to this object so that method calls can be chained together.

securityPolicy

DomainName.Builder securityPolicy(String securityPolicy)

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

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:

Returns a reference to this object so that method calls can be chained together.

See Also:

SecurityPolicy, SecurityPolicy

securityPolicy

DomainName.Builder securityPolicy(SecurityPolicy securityPolicy)

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

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:

Returns a reference to this object so that method calls can be chained together.

See Also:

SecurityPolicy, SecurityPolicy

tags

DomainName.Builder tags(Map<String,String> tags)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

mutualTlsAuthentication

DomainName.Builder mutualTlsAuthentication(MutualTlsAuthentication 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.

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:

Returns a reference to this object so that method calls can be chained together.

mutualTlsAuthentication

default DomainName.Builder mutualTlsAuthentication(Consumer<MutualTlsAuthentication.Builder> 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.

This is a convenience method that creates an instance of the MutualTlsAuthentication.Builder avoiding the need to create one manually via MutualTlsAuthentication.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to mutualTlsAuthentication(MutualTlsAuthentication).

Parameters:

mutualTlsAuthentication - a consumer that will call methods on MutualTlsAuthentication.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

mutualTlsAuthentication(MutualTlsAuthentication)

ownershipVerificationCertificateArn

DomainName.Builder ownershipVerificationCertificateArn(String 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.

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:

Returns a reference to this object so that method calls can be chained together.