CreateDomainNameRequest

A request to create a new domain name.

APIs.ioEngineeringPlatform

Properties

Name Type Description
domainName object
certificateName object
certificateBody object
certificatePrivateKey object
certificateChain object
certificateArn object
regionalCertificateName object
regionalCertificateArn object
endpointConfiguration object
tags object
securityPolicy object
mutualTlsAuthentication object
ownershipVerificationCertificateArn object
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-createdomainnamerequest-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CreateDomainNameRequest",
  "title": "CreateDomainNameRequest",
  "type": "object",
  "required": [
    "domainName"
  ],
  "properties": {
    "domainName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "The name of the DomainName resource."
        }
      ]
    },
    "certificateName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "The user-friendly name of the certificate that will be used by edge-optimized endpoint for this domain name."
        }
      ]
    },
    "certificateBody": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "[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": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "[Deprecated] Your edge-optimized endpoint's domain name certificate's private key."
        }
      ]
    },
    "certificateChain": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "[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": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "The reference to an AWS-managed certificate that will be used by edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source."
        }
      ]
    },
    "regionalCertificateName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "The user-friendly name of the certificate that will be used by regional endpoint for this domain name."
        }
      ]
    },
    "regionalCertificateArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "The reference to an AWS-managed certificate that will be used by regional endpoint for this domain name. AWS Certificate Manager is the only supported source."
        }
      ]
    },
    "endpointConfiguration": {
      "allOf": [
        {
          "$ref": "#/components/schemas/EndpointConfiguration"
        },
        {
          "description": "The endpoint configuration of this DomainName showing the endpoint types of the domain name. "
        }
      ]
    },
    "tags": {
      "allOf": [
        {
          "$ref": "#/components/schemas/MapOfStringToString"
        },
        {
          "description": "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 <code>aws:</code>. The tag value can be up to 256 characters."
        }
      ]
    },
    "securityPolicy": {
      "allOf": [
        {
          "$ref": "#/components/schemas/SecurityPolicy"
        },
        {
          "description": "The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are <code>TLS_1_0</code> and <code>TLS_1_2</code>."
        }
      ]
    },
    "mutualTlsAuthentication": {
      "$ref": "#/components/schemas/MutualTlsAuthenticationInput"
    },
    "ownershipVerificationCertificateArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "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."
        }
      ]
    }
  },
  "description": "A request to create a new domain name."
}