com.amazonaws.services.apigateway.model

Class CreateDomainNameRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.apigateway.model.CreateDomainNameRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateDomainNameRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

A request to create a new domain name.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateDomainNameRequest()

Method Summary

Modifier and Type	Method and Description
CreateDomainNameRequest	addTagsEntry(String key, String value) Add a single Tags entry
CreateDomainNameRequest	clearTagsEntries() Removes all the entries added into Tags.
CreateDomainNameRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getCertificateArn() The reference to an Amazon Web Services-managed certificate that will be used by edge-optimized endpoint for this domain name.
String	getCertificateBody() [Deprecated] The body of the server certificate that will be used by edge-optimized endpoint for this domain name provided by your certificate authority.
String	getCertificateChain() [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.
String	getCertificateName() The user-friendly name of the certificate that will be used by edge-optimized endpoint for this domain name.
String	getCertificatePrivateKey() [Deprecated] Your edge-optimized endpoint's domain name certificate's private key.
String	getDomainName() The name of the DomainName resource.
EndpointConfiguration	getEndpointConfiguration() The endpoint configuration of this DomainName showing the endpoint types of the domain name.
MutualTlsAuthenticationInput	getMutualTlsAuthentication()
String	getOwnershipVerificationCertificateArn() The ARN of the public certificate issued by ACM to validate ownership of your custom domain.
String	getRegionalCertificateArn() The reference to an Amazon Web Services-managed certificate that will be used by regional endpoint for this domain name.
String	getRegionalCertificateName() The user-friendly name of the certificate that will be used by regional endpoint for this domain name.
String	getSecurityPolicy() The Transport Layer Security (TLS) version + cipher suite for this DomainName.
Map<String,String>	getTags() The key-value map of strings.
int	hashCode()
void	setCertificateArn(String certificateArn) The reference to an Amazon Web Services-managed certificate that will be used by edge-optimized endpoint for this domain name.
void	setCertificateBody(String certificateBody) [Deprecated] The body of the server certificate that will be used by edge-optimized endpoint for this domain name provided by your certificate authority.
void	setCertificateChain(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.
void	setCertificateName(String certificateName) The user-friendly name of the certificate that will be used by edge-optimized endpoint for this domain name.
void	setCertificatePrivateKey(String certificatePrivateKey) [Deprecated] Your edge-optimized endpoint's domain name certificate's private key.
void	setDomainName(String domainName) The name of the DomainName resource.
void	setEndpointConfiguration(EndpointConfiguration endpointConfiguration) The endpoint configuration of this DomainName showing the endpoint types of the domain name.
void	setMutualTlsAuthentication(MutualTlsAuthenticationInput mutualTlsAuthentication)
void	setOwnershipVerificationCertificateArn(String ownershipVerificationCertificateArn) The ARN of the public certificate issued by ACM to validate ownership of your custom domain.
void	setRegionalCertificateArn(String regionalCertificateArn) The reference to an Amazon Web Services-managed certificate that will be used by regional endpoint for this domain name.
void	setRegionalCertificateName(String regionalCertificateName) The user-friendly name of the certificate that will be used by regional endpoint for this domain name.
void	setSecurityPolicy(String securityPolicy) The Transport Layer Security (TLS) version + cipher suite for this DomainName.
void	setTags(Map<String,String> tags) The key-value map of strings.
String	toString() Returns a string representation of this object.
CreateDomainNameRequest	withCertificateArn(String certificateArn) The reference to an Amazon Web Services-managed certificate that will be used by edge-optimized endpoint for this domain name.
CreateDomainNameRequest	withCertificateBody(String certificateBody) [Deprecated] The body of the server certificate that will be used by edge-optimized endpoint for this domain name provided by your certificate authority.
CreateDomainNameRequest	withCertificateChain(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	withCertificateName(String certificateName) The user-friendly name of the certificate that will be used by edge-optimized endpoint for this domain name.
CreateDomainNameRequest	withCertificatePrivateKey(String certificatePrivateKey) [Deprecated] Your edge-optimized endpoint's domain name certificate's private key.
CreateDomainNameRequest	withDomainName(String domainName) The name of the DomainName resource.
CreateDomainNameRequest	withEndpointConfiguration(EndpointConfiguration endpointConfiguration) The endpoint configuration of this DomainName showing the endpoint types of the domain name.
CreateDomainNameRequest	withMutualTlsAuthentication(MutualTlsAuthenticationInput mutualTlsAuthentication)
CreateDomainNameRequest	withOwnershipVerificationCertificateArn(String ownershipVerificationCertificateArn) The ARN of the public certificate issued by ACM to validate ownership of your custom domain.
CreateDomainNameRequest	withRegionalCertificateArn(String regionalCertificateArn) The reference to an Amazon Web Services-managed certificate that will be used by regional endpoint for this domain name.
CreateDomainNameRequest	withRegionalCertificateName(String regionalCertificateName) The user-friendly name of the certificate that will be used by regional endpoint for this domain name.
CreateDomainNameRequest	withSecurityPolicy(SecurityPolicy securityPolicy) The Transport Layer Security (TLS) version + cipher suite for this DomainName.
CreateDomainNameRequest	withSecurityPolicy(String securityPolicy) The Transport Layer Security (TLS) version + cipher suite for this DomainName.
CreateDomainNameRequest	withTags(Map<String,String> tags) The key-value map of strings.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateDomainNameRequest

public CreateDomainNameRequest()

Method Detail

setDomainName

public void setDomainName(String domainName)

The name of the DomainName resource.

Parameters:

domainName - The name of the DomainName resource.

getDomainName

public String getDomainName()

The name of the DomainName resource.

Returns:

The name of the DomainName resource.

withDomainName

public CreateDomainNameRequest withDomainName(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.

setCertificateName

public void setCertificateName(String certificateName)

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

Parameters:

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

getCertificateName

public String getCertificateName()

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

Returns:

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

withCertificateName

public CreateDomainNameRequest withCertificateName(String certificateName)

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

Parameters:

certificateName - The user-friendly 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.

setCertificateBody

public void setCertificateBody(String certificateBody)

[Deprecated] The body of the server certificate that will be used by edge-optimized 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 for this domain name provided by your certificate authority.

getCertificateBody

public String getCertificateBody()

[Deprecated] The body of the server certificate that will be used by edge-optimized endpoint for this domain name provided by your certificate authority.

Returns:

[Deprecated] The body of the server certificate that will be used by edge-optimized endpoint for this domain name provided by your certificate authority.

withCertificateBody

public CreateDomainNameRequest withCertificateBody(String certificateBody)

[Deprecated] The body of the server certificate that will be used by edge-optimized 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 for this domain name provided by your certificate authority.

Returns:

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

setCertificatePrivateKey

public void setCertificatePrivateKey(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.

getCertificatePrivateKey

public String getCertificatePrivateKey()

[Deprecated] Your edge-optimized endpoint's domain name certificate's private key.

Returns:

[Deprecated] Your edge-optimized endpoint's domain name certificate's private key.

withCertificatePrivateKey

public CreateDomainNameRequest withCertificatePrivateKey(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.

setCertificateChain

public void setCertificateChain(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.

getCertificateChain

public String getCertificateChain()

[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:

[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.

withCertificateChain

public CreateDomainNameRequest withCertificateChain(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.

setCertificateArn

public void setCertificateArn(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.

getCertificateArn

public String getCertificateArn()

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:

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.

withCertificateArn

public CreateDomainNameRequest withCertificateArn(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.

setRegionalCertificateName

public void setRegionalCertificateName(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.

getRegionalCertificateName

public String getRegionalCertificateName()

The user-friendly name of the certificate that will be used by regional endpoint for this domain name.

Returns:

The user-friendly name of the certificate that will be used by regional endpoint for this domain name.

withRegionalCertificateName

public CreateDomainNameRequest withRegionalCertificateName(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.

setRegionalCertificateArn

public void setRegionalCertificateArn(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.

getRegionalCertificateArn

public String getRegionalCertificateArn()

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:

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.

withRegionalCertificateArn

public CreateDomainNameRequest withRegionalCertificateArn(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.

setEndpointConfiguration

public void setEndpointConfiguration(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.

getEndpointConfiguration

public EndpointConfiguration getEndpointConfiguration()

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

Returns:

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

withEndpointConfiguration

public CreateDomainNameRequest withEndpointConfiguration(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.

getTags

public Map<String,String> getTags()

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.

Returns:

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.

setTags

public void setTags(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 with aws:. The tag value can be up to 256 characters.

withTags

public CreateDomainNameRequest withTags(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 with aws:. The tag value can be up to 256 characters.

Returns:

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

addTagsEntry

public CreateDomainNameRequest addTagsEntry(String key,
                                            String value)

Add a single Tags entry

See Also:

withTags(java.util.Map<java.lang.String, java.lang.String>)

clearTagsEntries

public CreateDomainNameRequest clearTagsEntries()

Removes all the entries added into Tags.

Returns:

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

setSecurityPolicy

public void setSecurityPolicy(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.

See Also:

SecurityPolicy

getSecurityPolicy

public String getSecurityPolicy()

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

Returns:

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

See Also:

SecurityPolicy

withSecurityPolicy

public CreateDomainNameRequest withSecurityPolicy(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

withSecurityPolicy

public CreateDomainNameRequest withSecurityPolicy(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

setMutualTlsAuthentication

public void setMutualTlsAuthentication(MutualTlsAuthenticationInput mutualTlsAuthentication)

Parameters:

mutualTlsAuthentication -

getMutualTlsAuthentication

public MutualTlsAuthenticationInput getMutualTlsAuthentication()

Returns:

withMutualTlsAuthentication

public CreateDomainNameRequest withMutualTlsAuthentication(MutualTlsAuthenticationInput mutualTlsAuthentication)

Parameters:

mutualTlsAuthentication -

Returns:

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

setOwnershipVerificationCertificateArn

public void setOwnershipVerificationCertificateArn(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.

getOwnershipVerificationCertificateArn

public String getOwnershipVerificationCertificateArn()

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:

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.

withOwnershipVerificationCertificateArn

public CreateDomainNameRequest withOwnershipVerificationCertificateArn(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.

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CreateDomainNameRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()