/v2/domainnames

POST

/v2/domainnames

Creates a domain name.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/v2/domainnames' \
--header 'Content-Type: application/json' \
--data-raw ''

Response Example

201 - Example 1

{
  "ApiMappingSelectionExpression": "string",
  "DomainName": "string",
  "DomainNameConfigurations": [],
  "MutualTlsAuthentication": {
    "TruststoreUri": "string",
    "TruststoreVersion": "string",
    "TruststoreWarnings": []
  },
  "Tags": {
    "property1": "string",
    "property2": "string"
  }
}

Request

Body Params application/json

domainName

string

required

A string with a length between [1-512].

domainNameConfigurations

array[object (DomainNameConfiguration) {10}]

optional

The domain name configurations.

ApiGatewayDomainName

string

optional

A domain name for the API.

CertificateArn

string

optional

An AWS-managed certificate that will be used by the edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.

CertificateName

string

optional

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

CertificateUploadDate

string <date-time>

optional

The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.

DomainNameStatus

enum<string>

optional

The status of the domain name migration. The valid values are AVAILABLE, UPDATING, PENDING_CERTIFICATE_REIMPORT, and PENDING_OWNERSHIP_VERIFICATION. If the status is UPDATING, the domain cannot be modified further until the existing operation is complete. If it is AVAILABLE, the domain can be updated.

Allowed values:

AVAILABLEUPDATINGPENDING_CERTIFICATE_REIMPORTPENDING_OWNERSHIP_VERIFICATION

DomainNameStatusMessage

string

optional

An optional text message containing detailed information about status of the domain name migration.

EndpointType

enum<string>

optional

The endpoint type.

Allowed values:

REGIONALEDGE

HostedZoneId

string

optional

The Amazon Route 53 Hosted Zone ID of the endpoint.

SecurityPolicy

enum<string>

optional

The Transport Layer Security (TLS) version of the security policy for this domain name. The valid values are TLS_1_0 and TLS_1_2.

Allowed values:

TLS_1_0TLS_1_2

OwnershipVerificationCertificateArn

string

optional

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

mutualTlsAuthentication

object

optional

The mutual TLS authentication configuration for a custom domain name.

TruststoreUri

string

optional

An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example, s3:///. The truststore can contain certificates from public or private certificate authorities. To update the truststore, upload a new version to S3, and then update your custom domain name to use the new version. To update the truststore, you must have permissions to access the S3 object.

TruststoreVersion

string

optional

The version of the S3 object that contains your truststore. To specify a version, you must have versioning enabled for the S3 bucket.

Responses

🟢201Success

application/json

Body

ApiMappingSelectionExpression

string

optional

The API mapping selection expression.

DomainName

string

optional

The name of the DomainName resource.

DomainNameConfigurations

array[object (DomainNameConfiguration) {10}]

optional

The domain name configurations.

ApiGatewayDomainName

string

optional

A domain name for the API.

CertificateArn

string

optional

An AWS-managed certificate that will be used by the edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.

CertificateName

string

optional

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

CertificateUploadDate

string <date-time>

optional

The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.

DomainNameStatus

enum<string>

optional

Allowed values:

AVAILABLEUPDATINGPENDING_CERTIFICATE_REIMPORTPENDING_OWNERSHIP_VERIFICATION

DomainNameStatusMessage

string

optional

An optional text message containing detailed information about status of the domain name migration.

EndpointType

enum<string>

optional

The endpoint type.

Allowed values:

REGIONALEDGE

HostedZoneId

string

optional

The Amazon Route 53 Hosted Zone ID of the endpoint.

SecurityPolicy

enum<string>

optional

The Transport Layer Security (TLS) version of the security policy for this domain name. The valid values are TLS_1_0 and TLS_1_2.

Allowed values:

TLS_1_0TLS_1_2

OwnershipVerificationCertificateArn

string

optional

MutualTlsAuthentication

object

optional

The mutual TLS authentication configuration for a custom domain name.

TruststoreUri

string

optional

TruststoreVersion

string

optional

The version of the S3 object that contains your truststore. To specify a version, you must have versioning enabled for the S3 bucket.

TruststoreWarnings

array[string]

optional

A list of warnings that API Gateway returns while processing your truststore. Invalid certificates produce warnings. Mutual TLS is still enabled, but some clients might not be able to access your API. To resolve warnings, upload a new truststore to S3, and then update you domain name to use the new version.