Interface CreateDomainNameResponse.Builder
- All Superinterfaces:
ApiGatewayResponse.Builder
,AwsResponse.Builder
,Buildable
,CopyableBuilder<CreateDomainNameResponse.Builder,
,CreateDomainNameResponse> SdkBuilder<CreateDomainNameResponse.Builder,
,CreateDomainNameResponse> SdkPojo
,SdkResponse.Builder
- Enclosing class:
CreateDomainNameResponse
-
Method Summary
Modifier and TypeMethodDescriptioncertificateArn
(String certificateArn) The reference to an Amazon Web Services-managed certificate that will be used by edge-optimized endpoint for this domain name.certificateName
(String certificateName) The name of the certificate that will be used by edge-optimized endpoint for this domain name.certificateUploadDate
(Instant certificateUploadDate) The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.distributionDomainName
(String distributionDomainName) The domain name of the Amazon CloudFront distribution associated with this custom domain name for an edge-optimized endpoint.distributionHostedZoneId
(String distributionHostedZoneId) The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized endpoint.domainName
(String domainName) The custom domain name as an API host name, for example,my-api.example.com
.domainNameStatus
(String domainNameStatus) The status of the DomainName migration.domainNameStatus
(DomainNameStatus domainNameStatus) The status of the DomainName migration.domainNameStatusMessage
(String domainNameStatusMessage) An optional text message containing detailed information about status of the DomainName migration.default CreateDomainNameResponse.Builder
endpointConfiguration
(Consumer<EndpointConfiguration.Builder> endpointConfiguration) The endpoint configuration of this DomainName showing the endpoint types of the domain name.endpointConfiguration
(EndpointConfiguration endpointConfiguration) The endpoint configuration of this DomainName showing the endpoint types of the domain name.default CreateDomainNameResponse.Builder
mutualTlsAuthentication
(Consumer<MutualTlsAuthentication.Builder> mutualTlsAuthentication) The mutual TLS authentication configuration for a custom domain name.mutualTlsAuthentication
(MutualTlsAuthentication mutualTlsAuthentication) The mutual TLS authentication configuration for a custom domain name.ownershipVerificationCertificateArn
(String ownershipVerificationCertificateArn) The ARN of the public certificate issued by ACM to validate ownership of your custom domain.regionalCertificateArn
(String regionalCertificateArn) The reference to an Amazon Web Services-managed certificate that will be used for validating the regional domain name.regionalCertificateName
(String regionalCertificateName) The name of the certificate that will be used for validating the regional domain name.regionalDomainName
(String regionalDomainName) The domain name associated with the regional endpoint for this custom domain name.regionalHostedZoneId
(String regionalHostedZoneId) The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint.securityPolicy
(String securityPolicy) The Transport Layer Security (TLS) version + cipher suite for this DomainName.securityPolicy
(SecurityPolicy securityPolicy) The Transport Layer Security (TLS) version + cipher suite for this DomainName.The collection of tags.Methods inherited from interface software.amazon.awssdk.services.apigateway.model.ApiGatewayResponse.Builder
build, responseMetadata, responseMetadata
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder
sdkHttpResponse, sdkHttpResponse
-
Method Details
-
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
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
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
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
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
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
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
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
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
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 isZ2FDTNDATAQYW2
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
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 CreateDomainNameResponse.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 theEndpointConfiguration.Builder
avoiding the need to create one manually viaEndpointConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toendpointConfiguration(EndpointConfiguration)
.- Parameters:
endpointConfiguration
- a consumer that will call methods onEndpointConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
domainNameStatus
The status of the DomainName migration. The valid values are
AVAILABLE
andUPDATING
. If the status isUPDATING
, the domain cannot be modified further until the existing operation is complete. If it isAVAILABLE
, the domain can be updated.- Parameters:
domainNameStatus
- The status of the DomainName migration. The valid values areAVAILABLE
andUPDATING
. If the status isUPDATING
, the domain cannot be modified further until the existing operation is complete. If it isAVAILABLE
, the domain can be updated.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
domainNameStatus
The status of the DomainName migration. The valid values are
AVAILABLE
andUPDATING
. If the status isUPDATING
, the domain cannot be modified further until the existing operation is complete. If it isAVAILABLE
, the domain can be updated.- Parameters:
domainNameStatus
- The status of the DomainName migration. The valid values areAVAILABLE
andUPDATING
. If the status isUPDATING
, the domain cannot be modified further until the existing operation is complete. If it isAVAILABLE
, the domain can be updated.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are
TLS_1_0
andTLS_1_2
.- Parameters:
securityPolicy
- The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values areTLS_1_0
andTLS_1_2
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
securityPolicy
The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are
TLS_1_0
andTLS_1_2
.- Parameters:
securityPolicy
- The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values areTLS_1_0
andTLS_1_2
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
CreateDomainNameResponse.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 CreateDomainNameResponse.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 theMutualTlsAuthentication.Builder
avoiding the need to create one manually viaMutualTlsAuthentication.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tomutualTlsAuthentication(MutualTlsAuthentication)
.- Parameters:
mutualTlsAuthentication
- a consumer that will call methods onMutualTlsAuthentication.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
ownershipVerificationCertificateArn
CreateDomainNameResponse.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.
-