Interface CreateDomainNameRequest.Builder
-
- All Superinterfaces:
ApiGatewayRequest.Builder,AwsRequest.Builder,Buildable,CopyableBuilder<CreateDomainNameRequest.Builder,CreateDomainNameRequest>,SdkBuilder<CreateDomainNameRequest.Builder,CreateDomainNameRequest>,SdkPojo,SdkRequest.Builder
- Enclosing class:
- CreateDomainNameRequest
public static interface CreateDomainNameRequest.Builder extends ApiGatewayRequest.Builder, SdkPojo, CopyableBuilder<CreateDomainNameRequest.Builder,CreateDomainNameRequest>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description CreateDomainNameRequest.BuildercertificateArn(String certificateArn)The reference to an Amazon Web Services-managed certificate that will be used by edge-optimized endpoint or private endpoint for this domain name.CreateDomainNameRequest.BuildercertificateBody(String certificateBody)[Deprecated] The body of the server certificate that will be used by edge-optimized endpoint or private endpoint for this domain name provided by your certificate authority.CreateDomainNameRequest.BuildercertificateChain(String certificateChain)[Deprecated] The intermediate certificates and optionally the root certificate, one after the other without any blank lines, used by an edge-optimized endpoint for this domain name.CreateDomainNameRequest.BuildercertificateName(String certificateName)The user-friendly name of the certificate that will be used by edge-optimized endpoint or private endpoint for this domain name.CreateDomainNameRequest.BuildercertificatePrivateKey(String certificatePrivateKey)[Deprecated] Your edge-optimized endpoint's domain name certificate's private key.CreateDomainNameRequest.BuilderdomainName(String domainName)The name of the DomainName resource.default CreateDomainNameRequest.BuilderendpointConfiguration(Consumer<EndpointConfiguration.Builder> endpointConfiguration)The endpoint configuration of this DomainName showing the endpoint types of the domain name.CreateDomainNameRequest.BuilderendpointConfiguration(EndpointConfiguration endpointConfiguration)The endpoint configuration of this DomainName showing the endpoint types of the domain name.default CreateDomainNameRequest.BuildermutualTlsAuthentication(Consumer<MutualTlsAuthenticationInput.Builder> mutualTlsAuthentication)Sets the value of the MutualTlsAuthentication property for this object.CreateDomainNameRequest.BuildermutualTlsAuthentication(MutualTlsAuthenticationInput mutualTlsAuthentication)Sets the value of the MutualTlsAuthentication property for this object.CreateDomainNameRequest.BuilderoverrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)CreateDomainNameRequest.BuilderoverrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)CreateDomainNameRequest.BuilderownershipVerificationCertificateArn(String ownershipVerificationCertificateArn)The ARN of the public certificate issued by ACM to validate ownership of your custom domain.CreateDomainNameRequest.Builderpolicy(String policy)A stringified JSON policy document that applies to theexecute-apiservice for this DomainName regardless of the caller and Method configuration.CreateDomainNameRequest.BuilderregionalCertificateArn(String regionalCertificateArn)The reference to an Amazon Web Services-managed certificate that will be used by regional endpoint for this domain name.CreateDomainNameRequest.BuilderregionalCertificateName(String regionalCertificateName)The user-friendly name of the certificate that will be used by regional endpoint for this domain name.CreateDomainNameRequest.BuildersecurityPolicy(String securityPolicy)The Transport Layer Security (TLS) version + cipher suite for this DomainName.CreateDomainNameRequest.BuildersecurityPolicy(SecurityPolicy securityPolicy)The Transport Layer Security (TLS) version + cipher suite for this DomainName.CreateDomainNameRequest.Buildertags(Map<String,String> tags)The key-value map of strings.-
Methods inherited from interface software.amazon.awssdk.services.apigateway.model.ApiGatewayRequest.Builder
build
-
Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
-
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, sdkFieldNameToField, sdkFields
-
-
-
-
Method Detail
-
domainName
CreateDomainNameRequest.Builder domainName(String domainName)
The name of the DomainName resource.
- Parameters:
domainName- The name of the DomainName resource.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
certificateName
CreateDomainNameRequest.Builder certificateName(String certificateName)
The user-friendly name of the certificate that will be used by edge-optimized endpoint or private endpoint for this domain name.
- Parameters:
certificateName- The user-friendly name of the certificate that will be used by edge-optimized endpoint or private endpoint for this domain name.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
certificateBody
CreateDomainNameRequest.Builder certificateBody(String certificateBody)
[Deprecated] The body of the server certificate that will be used by edge-optimized endpoint or private endpoint for this domain name provided by your certificate authority.
- Parameters:
certificateBody- [Deprecated] The body of the server certificate that will be used by edge-optimized endpoint or private endpoint for this domain name provided by your certificate authority.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
certificatePrivateKey
CreateDomainNameRequest.Builder certificatePrivateKey(String certificatePrivateKey)
[Deprecated] Your edge-optimized endpoint's domain name certificate's private key.
- Parameters:
certificatePrivateKey- [Deprecated] Your edge-optimized endpoint's domain name certificate's private key.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
certificateChain
CreateDomainNameRequest.Builder certificateChain(String certificateChain)
[Deprecated] The intermediate certificates and optionally the root certificate, one after the other without any blank lines, used by an edge-optimized endpoint for this domain name. If you include the root certificate, your certificate chain must start with intermediate certificates and end with the root certificate. Use the intermediate certificates that were provided by your certificate authority. Do not include any intermediaries that are not in the chain of trust path.
- Parameters:
certificateChain- [Deprecated] The intermediate certificates and optionally the root certificate, one after the other without any blank lines, used by an edge-optimized endpoint for this domain name. If you include the root certificate, your certificate chain must start with intermediate certificates and end with the root certificate. Use the intermediate certificates that were provided by your certificate authority. Do not include any intermediaries that are not in the chain of trust path.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
certificateArn
CreateDomainNameRequest.Builder certificateArn(String certificateArn)
The reference to an Amazon Web Services-managed certificate that will be used by edge-optimized endpoint or private 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 or private 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.
-
regionalCertificateName
CreateDomainNameRequest.Builder regionalCertificateName(String regionalCertificateName)
The user-friendly name of the certificate that will be used by regional endpoint for this domain name.
- Parameters:
regionalCertificateName- The user-friendly name of the certificate that will be used by regional endpoint for this domain name.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
regionalCertificateArn
CreateDomainNameRequest.Builder regionalCertificateArn(String regionalCertificateArn)
The reference to an Amazon Web Services-managed certificate that will be used by regional endpoint for this domain name. Certificate Manager is the only supported source.
- Parameters:
regionalCertificateArn- The reference to an Amazon Web Services-managed certificate that will be used by regional 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.
-
endpointConfiguration
CreateDomainNameRequest.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 CreateDomainNameRequest.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.Builderavoiding the need to create one manually viaEndpointConfiguration.builder().When the
Consumercompletes,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:
endpointConfiguration(EndpointConfiguration)
-
tags
CreateDomainNameRequest.Builder tags(Map<String,String> tags)
The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with
aws:. The tag value can be up to 256 characters.- Parameters:
tags- The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start withaws:. The tag value can be up to 256 characters.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
securityPolicy
CreateDomainNameRequest.Builder securityPolicy(String securityPolicy)
The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are
TLS_1_0andTLS_1_2.- Parameters:
securityPolicy- The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values areTLS_1_0andTLS_1_2.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
SecurityPolicy,SecurityPolicy
-
securityPolicy
CreateDomainNameRequest.Builder securityPolicy(SecurityPolicy securityPolicy)
The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are
TLS_1_0andTLS_1_2.- Parameters:
securityPolicy- The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values areTLS_1_0andTLS_1_2.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
SecurityPolicy,SecurityPolicy
-
mutualTlsAuthentication
CreateDomainNameRequest.Builder mutualTlsAuthentication(MutualTlsAuthenticationInput mutualTlsAuthentication)
Sets the value of the MutualTlsAuthentication property for this object.- Parameters:
mutualTlsAuthentication- The new value for the MutualTlsAuthentication property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
mutualTlsAuthentication
default CreateDomainNameRequest.Builder mutualTlsAuthentication(Consumer<MutualTlsAuthenticationInput.Builder> mutualTlsAuthentication)
Sets the value of the MutualTlsAuthentication property for this object. This is a convenience method that creates an instance of theMutualTlsAuthenticationInput.Builderavoiding the need to create one manually viaMutualTlsAuthenticationInput.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tomutualTlsAuthentication(MutualTlsAuthenticationInput).- Parameters:
mutualTlsAuthentication- a consumer that will call methods onMutualTlsAuthenticationInput.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
mutualTlsAuthentication(MutualTlsAuthenticationInput)
-
ownershipVerificationCertificateArn
CreateDomainNameRequest.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.
-
policy
CreateDomainNameRequest.Builder policy(String policy)
A stringified JSON policy document that applies to the
execute-apiservice for this DomainName regardless of the caller and Method configuration. Supported only for private custom domain names.- Parameters:
policy- A stringified JSON policy document that applies to theexecute-apiservice for this DomainName regardless of the caller and Method configuration. Supported only for private custom domain names.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
CreateDomainNameRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
overrideConfiguration
CreateDomainNameRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
-