Class CreateDomainNameRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateDomainNameRequest.Builder,
CreateDomainNameRequest>
A request to create a new domain name.
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final String
The reference to an Amazon Web Services-managed certificate that will be used by edge-optimized endpoint for this domain name.final String
[Deprecated] The body of the server certificate that will be used by edge-optimized endpoint for this domain name provided by your certificate authority.final String
[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.final String
The user-friendly name of the certificate that will be used by edge-optimized endpoint for this domain name.final String
[Deprecated] Your edge-optimized endpoint's domain name certificate's private key.final String
The name of the DomainName resource.final EndpointConfiguration
The endpoint configuration of this DomainName showing the endpoint types of the domain name.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.Returns the value of the MutualTlsAuthentication property for this object.final String
The ARN of the public certificate issued by ACM to validate ownership of your custom domain.final String
The reference to an Amazon Web Services-managed certificate that will be used by regional endpoint for this domain name.final String
The user-friendly name of the certificate that will be used by regional endpoint for this domain name.final SecurityPolicy
The Transport Layer Security (TLS) version + cipher suite for this DomainName.final String
The Transport Layer Security (TLS) version + cipher suite for this DomainName.static Class
<? extends CreateDomainNameRequest.Builder> tags()
The key-value map of strings.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
domainName
The name of the DomainName resource.
- Returns:
- The name of the DomainName resource.
-
certificateName
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.
-
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:
- [Deprecated] The body of the server certificate that will be used by edge-optimized endpoint for this domain name provided by your certificate authority.
-
certificatePrivateKey
[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.
-
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:
- [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.
-
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:
- 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.
-
regionalCertificateName
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.
-
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:
- 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.
-
endpointConfiguration
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.
-
hasTags
public final boolean hasTags()For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
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.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasTags()
method.- 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.
-
securityPolicy
The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are
TLS_1_0
andTLS_1_2
.If the service returns an enum value that is not available in the current SDK version,
securityPolicy
will returnSecurityPolicy.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsecurityPolicyAsString()
.- Returns:
- The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are
TLS_1_0
andTLS_1_2
. - See Also:
-
securityPolicyAsString
The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are
TLS_1_0
andTLS_1_2
.If the service returns an enum value that is not available in the current SDK version,
securityPolicy
will returnSecurityPolicy.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsecurityPolicyAsString()
.- Returns:
- The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are
TLS_1_0
andTLS_1_2
. - See Also:
-
mutualTlsAuthentication
Returns the value of the MutualTlsAuthentication property for this object.- Returns:
- The value of the MutualTlsAuthentication property for this object.
-
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:
- 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.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<CreateDomainNameRequest.Builder,
CreateDomainNameRequest> - Specified by:
toBuilder
in classApiGatewayRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-