You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::APIGateway::Types::CreateDomainNameRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CreateDomainNameRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  domain_name: "String", # required
  certificate_name: "String",
  certificate_body: "String",
  certificate_private_key: "String",
  certificate_chain: "String",
  certificate_arn: "String",
  regional_certificate_name: "String",
  regional_certificate_arn: "String",
  endpoint_configuration: {
    types: ["REGIONAL"], # accepts REGIONAL, EDGE, PRIVATE
    vpc_endpoint_ids: ["String"],
  },
  tags: {
    "String" => "String",
  },
  security_policy: "TLS_1_0", # accepts TLS_1_0, TLS_1_2
  mutual_tls_authentication: {
    truststore_uri: "String",
    truststore_version: "String",
  },
}

A request to create a new domain name.

Instance Attribute Summary collapse

Instance Attribute Details

#certificate_arn ⇒ String

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.

Returns:

  • (String) —

    The reference to an AWS-managed certificate that will be used by edge-optimized endpoint for this domain name.

#certificate_body ⇒ 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.

Returns:

  • (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.

#certificate_chain ⇒ 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. 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:

  • (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.

#certificate_name ⇒ String

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

Returns:

  • (String) —

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

#certificate_private_key ⇒ String

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

Returns:

  • (String) —

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

#domain_name ⇒ String

[Required] The name of the DomainName resource.

Returns:

  • (String) —

    [Required] The name of the DomainName resource.

#endpoint_configuration ⇒ Types::EndpointConfiguration

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

Returns:

#mutual_tls_authentication ⇒ Types::MutualTlsAuthenticationInput

If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your custom domain name.

Returns:

#regional_certificate_arn ⇒ String

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.

Returns:

  • (String) —

    The reference to an AWS-managed certificate that will be used by regional endpoint for this domain name.

#regional_certificate_name ⇒ String

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

Returns:

  • (String) —

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

#security_policy ⇒ String

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

Possible values:

  • TLS_1_0
  • TLS_1_2

Returns:

  • (String) —

    The Transport Layer Security (TLS) version + cipher suite for this DomainName.

#tags ⇒ Hash<String,String>

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:

  • (Hash<String,String>) —

    The key-value map of strings.