java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.apigateway.model.ApiGatewayRequest
    - - software.amazon.awssdk.services.apigateway.model.CreateDomainNameRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<CreateDomainNameRequest.Builder,CreateDomainNameRequest>

@Generated("software.amazon.awssdk:codegen")
public final class CreateDomainNameRequest
extends ApiGatewayRequest
implements ToCopyableBuilder<CreateDomainNameRequest.Builder,CreateDomainNameRequest>

A request to create a new domain name.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface CreateDomainNameRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static CreateDomainNameRequest.Builder`	`builder()`
`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.
`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.
`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.
`String`	`certificateName()`	The user-friendly name of the certificate that will be used by edge-optimized endpoint or private endpoint for this domain name.
`String`	`certificatePrivateKey()`	[Deprecated] Your edge-optimized endpoint's domain name certificate's private key.
`String`	`domainName()`	The name of the DomainName resource.
`EndpointConfiguration`	`endpointConfiguration()`	The endpoint configuration of this DomainName showing the endpoint types of the domain name.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasTags()`	For responses, this returns true if the service returned a value for the Tags property.
`MutualTlsAuthenticationInput`	`mutualTlsAuthentication()`	Returns the value of the MutualTlsAuthentication property for this object.
`String`	`ownershipVerificationCertificateArn()`	The ARN of the public certificate issued by ACM to validate ownership of your custom domain.
`String`	`policy()`	A stringified JSON policy document that applies to the `execute-api` service for this DomainName regardless of the caller and Method configuration.
`String`	`regionalCertificateArn()`	The reference to an Amazon Web Services-managed certificate that will be used by regional endpoint for this domain name.
`String`	`regionalCertificateName()`	The user-friendly name of the certificate that will be used by regional endpoint for this domain name.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`SecurityPolicy`	`securityPolicy()`	The Transport Layer Security (TLS) version + cipher suite for this DomainName.
`String`	`securityPolicyAsString()`	The Transport Layer Security (TLS) version + cipher suite for this DomainName.
`static Class<? extends CreateDomainNameRequest.Builder>`	`serializableBuilderClass()`
`Map<String,String>`	`tags()`	The key-value map of strings.
`CreateDomainNameRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - domainName
```
public final String domainName()
```
    The name of the DomainName resource.
    
    Returns:
    
    The name of the DomainName resource.
  - certificateName
```
public final String certificateName()
```
    The user-friendly name of the certificate that will be used by edge-optimized endpoint or private endpoint for this domain name.
    
    Returns:
    
    The user-friendly name of the certificate that will be used by edge-optimized endpoint or private endpoint for this domain name.
  - certificateBody
```
public final 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.
    
    Returns:
    
    [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.
  - certificatePrivateKey
```
public final String 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
```
public final 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.
    
    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
```
public final 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.
    
    Returns:
    
    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.
  - regionalCertificateName
```
public final String 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
```
public final 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.
    
    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
```
public final EndpointConfiguration 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 the isEmpty() 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
```
public final 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.
    
    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
```
public final SecurityPolicy securityPolicy()
```
    The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are TLS_1_0 and TLS_1_2.
    
    If the service returns an enum value that is not available in the current SDK version, securityPolicy will return SecurityPolicy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from securityPolicyAsString().
    
    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
  - securityPolicyAsString
```
public final String securityPolicyAsString()
```
    The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are TLS_1_0 and TLS_1_2.
    
    If the service returns an enum value that is not available in the current SDK version, securityPolicy will return SecurityPolicy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from securityPolicyAsString().
    
    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
  - mutualTlsAuthentication
```
public final MutualTlsAuthenticationInput mutualTlsAuthentication()
```
    Returns the value of the MutualTlsAuthentication property for this object.
    
    Returns:
    
    The value of the MutualTlsAuthentication property for this object.
  - ownershipVerificationCertificateArn
```
public final 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.
    
    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.
  - policy
```
public final String policy()
```
    A stringified JSON policy document that applies to the execute-api service for this DomainName regardless of the caller and Method configuration. Supported only for private custom domain names.
    
    Returns:
    
    A stringified JSON policy document that applies to the execute-api service for this DomainName regardless of the caller and Method configuration. Supported only for private custom domain names.
  - toBuilder
```
public CreateDomainNameRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateDomainNameRequest.Builder,CreateDomainNameRequest>
    
    Specified by:
    
    toBuilder in class ApiGatewayRequest
  - builder
```
public static CreateDomainNameRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateDomainNameRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class CreateDomainNameRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

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

Method Detail

domainName

certificateName

certificateBody

certificatePrivateKey

certificateChain

certificateArn

regionalCertificateName

regionalCertificateArn

endpointConfiguration

hasTags

tags

securityPolicy

securityPolicyAsString

mutualTlsAuthentication

ownershipVerificationCertificateArn

policy

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField