Class: Aws::APIGateway::Types::DomainName

Inherits:

Struct

Object
Struct
Aws::APIGateway::Types::DomainName

show all

Includes:: Structure

Defined in:: lib/aws-sdk-apigateway/types.rb

Overview

Represents a custom domain name as a user-friendly host name of an API (RestApi).

<div class=“Remarks” markdown=“1”> When you deploy an API, API Gateway creates a default host name for the API. This default API host name is of the ‘restapi-id.execute-api.region.amazonaws.com` format. With the default host name, you can access the API’s root resource with the URL of ‘https://restapi-id.execute-api.region.amazonaws.com/stage/`. When you set up a custom domain name of `apis.example.com` for this API, you can then access the same resource using the URL of the `apis.examples.com/myApi`, where `myApi` is the base path mapping (BasePathMapping) of your API under the custom domain name.

</div>

Set a Custom Host Name for an API][1

</div>

[1]: docs.aws.amazon.com/apigateway/latest/developerguide/how-to-custom-domains.html

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#certificate_arn ⇒ String

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

The name of the certificate that will be used by edge-optimized endpoint for this domain name.
#certificate_upload_date ⇒ Time

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

The domain name of the Amazon CloudFront distribution associated with this custom domain name for an edge-optimized endpoint.
#distribution_hosted_zone_id ⇒ String

The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized endpoint.
#domain_name ⇒ String

The custom domain name as an API host name, for example, ‘my-api.example.com`.
#domain_name_status ⇒ String

The status of the DomainName migration.
#domain_name_status_message ⇒ String

An optional text message containing detailed information about status of the DomainName migration.
#endpoint_configuration ⇒ Types::EndpointConfiguration

The endpoint configuration of this DomainName showing the endpoint types of the domain name.
#mutual_tls_authentication ⇒ Types::MutualTlsAuthentication

The mutual TLS authentication configuration for a custom domain name.
#ownership_verification_certificate_arn ⇒ String

The ARN of the public certificate issued by ACM to validate ownership of your custom domain.
#regional_certificate_arn ⇒ String

The reference to an AWS-managed certificate that will be used for validating the regional domain name.
#regional_certificate_name ⇒ String

The name of the certificate that will be used for validating the regional domain name.
#regional_domain_name ⇒ String

The domain name associated with the regional endpoint for this custom domain name.
#regional_hosted_zone_id ⇒ String

The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint.
#security_policy ⇒ String

The Transport Layer Security (TLS) version + cipher suite for this DomainName.
#tags ⇒ Hash<String,String>

The collection of tags.

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)

# File 'lib/aws-sdk-apigateway/types.rb', line 2689

class DomainName < Struct.new(
  :domain_name,
  :certificate_name,
  :certificate_arn,
  :certificate_upload_date,
  :regional_domain_name,
  :regional_hosted_zone_id,
  :regional_certificate_name,
  :regional_certificate_arn,
  :distribution_domain_name,
  :distribution_hosted_zone_id,
  :endpoint_configuration,
  :domain_name_status,
  :domain_name_status_message,
  :security_policy,
  :tags,
  :mutual_tls_authentication,
  :ownership_verification_certificate_arn)
  SENSITIVE = []
  include Aws::Structure
end

#certificate_name ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-apigateway/types.rb', line 2689

class DomainName < Struct.new(
  :domain_name,
  :certificate_name,
  :certificate_arn,
  :certificate_upload_date,
  :regional_domain_name,
  :regional_hosted_zone_id,
  :regional_certificate_name,
  :regional_certificate_arn,
  :distribution_domain_name,
  :distribution_hosted_zone_id,
  :endpoint_configuration,
  :domain_name_status,
  :domain_name_status_message,
  :security_policy,
  :tags,
  :mutual_tls_authentication,
  :ownership_verification_certificate_arn)
  SENSITIVE = []
  include Aws::Structure
end

#certificate_upload_date ⇒ `Time`

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

Returns:

(Time)

# File 'lib/aws-sdk-apigateway/types.rb', line 2689

class DomainName < Struct.new(
  :domain_name,
  :certificate_name,
  :certificate_arn,
  :certificate_upload_date,
  :regional_domain_name,
  :regional_hosted_zone_id,
  :regional_certificate_name,
  :regional_certificate_arn,
  :distribution_domain_name,
  :distribution_hosted_zone_id,
  :endpoint_configuration,
  :domain_name_status,
  :domain_name_status_message,
  :security_policy,
  :tags,
  :mutual_tls_authentication,
  :ownership_verification_certificate_arn)
  SENSITIVE = []
  include Aws::Structure
end

#distribution_domain_name ⇒ `String`

The domain name of the Amazon CloudFront distribution associated with this custom domain name for an edge-optimized endpoint. You set up this association when adding a DNS record pointing the custom domain name to this distribution name. For more information about CloudFront distributions, see the [Amazon CloudFront documentation].

[1]: aws.amazon.com/documentation/cloudfront/

Returns:

(String)

# File 'lib/aws-sdk-apigateway/types.rb', line 2689

class DomainName < Struct.new(
  :domain_name,
  :certificate_name,
  :certificate_arn,
  :certificate_upload_date,
  :regional_domain_name,
  :regional_hosted_zone_id,
  :regional_certificate_name,
  :regional_certificate_arn,
  :distribution_domain_name,
  :distribution_hosted_zone_id,
  :endpoint_configuration,
  :domain_name_status,
  :domain_name_status_message,
  :security_policy,
  :tags,
  :mutual_tls_authentication,
  :ownership_verification_certificate_arn)
  SENSITIVE = []
  include Aws::Structure
end

#distribution_hosted_zone_id ⇒ `String`

The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized endpoint. The valid value is ‘Z2FDTNDATAQYW2` for all the regions. For more information, see [Set up a Regional Custom Domain Name] and [AWS Regions and Endpoints for API Gateway].

[1]: docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-regional-api-custom-domain-create.html [2]: docs.aws.amazon.com/general/latest/gr/rande.html#apigateway_region

Returns:

(String)

# File 'lib/aws-sdk-apigateway/types.rb', line 2689

class DomainName < Struct.new(
  :domain_name,
  :certificate_name,
  :certificate_arn,
  :certificate_upload_date,
  :regional_domain_name,
  :regional_hosted_zone_id,
  :regional_certificate_name,
  :regional_certificate_arn,
  :distribution_domain_name,
  :distribution_hosted_zone_id,
  :endpoint_configuration,
  :domain_name_status,
  :domain_name_status_message,
  :security_policy,
  :tags,
  :mutual_tls_authentication,
  :ownership_verification_certificate_arn)
  SENSITIVE = []
  include Aws::Structure
end

#domain_name ⇒ `String`

The custom domain name as an API host name, for example, ‘my-api.example.com`.

Returns:

(String)

# File 'lib/aws-sdk-apigateway/types.rb', line 2689

class DomainName < Struct.new(
  :domain_name,
  :certificate_name,
  :certificate_arn,
  :certificate_upload_date,
  :regional_domain_name,
  :regional_hosted_zone_id,
  :regional_certificate_name,
  :regional_certificate_arn,
  :distribution_domain_name,
  :distribution_hosted_zone_id,
  :endpoint_configuration,
  :domain_name_status,
  :domain_name_status_message,
  :security_policy,
  :tags,
  :mutual_tls_authentication,
  :ownership_verification_certificate_arn)
  SENSITIVE = []
  include Aws::Structure
end

#domain_name_status ⇒ `String`

The status of the DomainName 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.

Returns:

(String)

# File 'lib/aws-sdk-apigateway/types.rb', line 2689

class DomainName < Struct.new(
  :domain_name,
  :certificate_name,
  :certificate_arn,
  :certificate_upload_date,
  :regional_domain_name,
  :regional_hosted_zone_id,
  :regional_certificate_name,
  :regional_certificate_arn,
  :distribution_domain_name,
  :distribution_hosted_zone_id,
  :endpoint_configuration,
  :domain_name_status,
  :domain_name_status_message,
  :security_policy,
  :tags,
  :mutual_tls_authentication,
  :ownership_verification_certificate_arn)
  SENSITIVE = []
  include Aws::Structure
end

#domain_name_status_message ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-apigateway/types.rb', line 2689

class DomainName < Struct.new(
  :domain_name,
  :certificate_name,
  :certificate_arn,
  :certificate_upload_date,
  :regional_domain_name,
  :regional_hosted_zone_id,
  :regional_certificate_name,
  :regional_certificate_arn,
  :distribution_domain_name,
  :distribution_hosted_zone_id,
  :endpoint_configuration,
  :domain_name_status,
  :domain_name_status_message,
  :security_policy,
  :tags,
  :mutual_tls_authentication,
  :ownership_verification_certificate_arn)
  SENSITIVE = []
  include Aws::Structure
end

#endpoint_configuration ⇒ `Types::EndpointConfiguration`

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

Returns:

(Types::EndpointConfiguration)

# File 'lib/aws-sdk-apigateway/types.rb', line 2689

class DomainName < Struct.new(
  :domain_name,
  :certificate_name,
  :certificate_arn,
  :certificate_upload_date,
  :regional_domain_name,
  :regional_hosted_zone_id,
  :regional_certificate_name,
  :regional_certificate_arn,
  :distribution_domain_name,
  :distribution_hosted_zone_id,
  :endpoint_configuration,
  :domain_name_status,
  :domain_name_status_message,
  :security_policy,
  :tags,
  :mutual_tls_authentication,
  :ownership_verification_certificate_arn)
  SENSITIVE = []
  include Aws::Structure
end

#mutual_tls_authentication ⇒ `Types::MutualTlsAuthentication`

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

Returns:

(Types::MutualTlsAuthentication)

# File 'lib/aws-sdk-apigateway/types.rb', line 2689

class DomainName < Struct.new(
  :domain_name,
  :certificate_name,
  :certificate_arn,
  :certificate_upload_date,
  :regional_domain_name,
  :regional_hosted_zone_id,
  :regional_certificate_name,
  :regional_certificate_arn,
  :distribution_domain_name,
  :distribution_hosted_zone_id,
  :endpoint_configuration,
  :domain_name_status,
  :domain_name_status_message,
  :security_policy,
  :tags,
  :mutual_tls_authentication,
  :ownership_verification_certificate_arn)
  SENSITIVE = []
  include Aws::Structure
end

#ownership_verification_certificate_arn ⇒ `String`

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:

(String)

# File 'lib/aws-sdk-apigateway/types.rb', line 2689

class DomainName < Struct.new(
  :domain_name,
  :certificate_name,
  :certificate_arn,
  :certificate_upload_date,
  :regional_domain_name,
  :regional_hosted_zone_id,
  :regional_certificate_name,
  :regional_certificate_arn,
  :distribution_domain_name,
  :distribution_hosted_zone_id,
  :endpoint_configuration,
  :domain_name_status,
  :domain_name_status_message,
  :security_policy,
  :tags,
  :mutual_tls_authentication,
  :ownership_verification_certificate_arn)
  SENSITIVE = []
  include Aws::Structure
end

#regional_certificate_arn ⇒ `String`

The reference to an AWS-managed certificate that will be used for validating the regional domain name. AWS Certificate Manager is the only supported source.

Returns:

(String)

# File 'lib/aws-sdk-apigateway/types.rb', line 2689

class DomainName < Struct.new(
  :domain_name,
  :certificate_name,
  :certificate_arn,
  :certificate_upload_date,
  :regional_domain_name,
  :regional_hosted_zone_id,
  :regional_certificate_name,
  :regional_certificate_arn,
  :distribution_domain_name,
  :distribution_hosted_zone_id,
  :endpoint_configuration,
  :domain_name_status,
  :domain_name_status_message,
  :security_policy,
  :tags,
  :mutual_tls_authentication,
  :ownership_verification_certificate_arn)
  SENSITIVE = []
  include Aws::Structure
end

#regional_certificate_name ⇒ `String`

The name of the certificate that will be used for validating the regional domain name.

Returns:

(String)

# File 'lib/aws-sdk-apigateway/types.rb', line 2689

class DomainName < Struct.new(
  :domain_name,
  :certificate_name,
  :certificate_arn,
  :certificate_upload_date,
  :regional_domain_name,
  :regional_hosted_zone_id,
  :regional_certificate_name,
  :regional_certificate_arn,
  :distribution_domain_name,
  :distribution_hosted_zone_id,
  :endpoint_configuration,
  :domain_name_status,
  :domain_name_status_message,
  :security_policy,
  :tags,
  :mutual_tls_authentication,
  :ownership_verification_certificate_arn)
  SENSITIVE = []
  include Aws::Structure
end

#regional_domain_name ⇒ `String`

The domain name associated with the regional endpoint for this custom domain name. You set up this association by adding a DNS record that points the custom domain name to this regional domain name. The regional domain name is returned by API Gateway when you create a regional endpoint.

Returns:

(String)

# File 'lib/aws-sdk-apigateway/types.rb', line 2689

class DomainName < Struct.new(
  :domain_name,
  :certificate_name,
  :certificate_arn,
  :certificate_upload_date,
  :regional_domain_name,
  :regional_hosted_zone_id,
  :regional_certificate_name,
  :regional_certificate_arn,
  :distribution_domain_name,
  :distribution_hosted_zone_id,
  :endpoint_configuration,
  :domain_name_status,
  :domain_name_status_message,
  :security_policy,
  :tags,
  :mutual_tls_authentication,
  :ownership_verification_certificate_arn)
  SENSITIVE = []
  include Aws::Structure
end

#regional_hosted_zone_id ⇒ `String`

The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint. For more information, see [Set up a Regional Custom Domain Name] and [AWS Regions and Endpoints for API Gateway].

[1]: docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-regional-api-custom-domain-create.html [2]: docs.aws.amazon.com/general/latest/gr/rande.html#apigateway_region

Returns:

(String)

# File 'lib/aws-sdk-apigateway/types.rb', line 2689

class DomainName < Struct.new(
  :domain_name,
  :certificate_name,
  :certificate_arn,
  :certificate_upload_date,
  :regional_domain_name,
  :regional_hosted_zone_id,
  :regional_certificate_name,
  :regional_certificate_arn,
  :distribution_domain_name,
  :distribution_hosted_zone_id,
  :endpoint_configuration,
  :domain_name_status,
  :domain_name_status_message,
  :security_policy,
  :tags,
  :mutual_tls_authentication,
  :ownership_verification_certificate_arn)
  SENSITIVE = []
  include Aws::Structure
end

#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`.

Returns:

(String)

# File 'lib/aws-sdk-apigateway/types.rb', line 2689

class DomainName < Struct.new(
  :domain_name,
  :certificate_name,
  :certificate_arn,
  :certificate_upload_date,
  :regional_domain_name,
  :regional_hosted_zone_id,
  :regional_certificate_name,
  :regional_certificate_arn,
  :distribution_domain_name,
  :distribution_hosted_zone_id,
  :endpoint_configuration,
  :domain_name_status,
  :domain_name_status_message,
  :security_policy,
  :tags,
  :mutual_tls_authentication,
  :ownership_verification_certificate_arn)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ `Hash<String,String>`

The collection of tags. Each tag element is associated with a given resource.

Returns:

(Hash<String,String>)

# File 'lib/aws-sdk-apigateway/types.rb', line 2689

class DomainName < Struct.new(
  :domain_name,
  :certificate_name,
  :certificate_arn,
  :certificate_upload_date,
  :regional_domain_name,
  :regional_hosted_zone_id,
  :regional_certificate_name,
  :regional_certificate_arn,
  :distribution_domain_name,
  :distribution_hosted_zone_id,
  :endpoint_configuration,
  :domain_name_status,
  :domain_name_status_message,
  :security_policy,
  :tags,
  :mutual_tls_authentication,
  :ownership_verification_certificate_arn)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::APIGateway::Types::DomainName

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#certificate_arn ⇒ String

#certificate_name ⇒ String

#certificate_upload_date ⇒ Time

#distribution_domain_name ⇒ String

#distribution_hosted_zone_id ⇒ String

#domain_name ⇒ String

#domain_name_status ⇒ String

#domain_name_status_message ⇒ String

#endpoint_configuration ⇒ Types::EndpointConfiguration

#mutual_tls_authentication ⇒ Types::MutualTlsAuthentication

#ownership_verification_certificate_arn ⇒ String

#regional_certificate_arn ⇒ String

#regional_certificate_name ⇒ String

#regional_domain_name ⇒ String

#regional_hosted_zone_id ⇒ String

#security_policy ⇒ String

#tags ⇒ Hash<String,String>

#certificate_arn ⇒ `String`

#certificate_name ⇒ `String`

#certificate_upload_date ⇒ `Time`

#distribution_domain_name ⇒ `String`

#distribution_hosted_zone_id ⇒ `String`

#domain_name ⇒ `String`

#domain_name_status ⇒ `String`

#domain_name_status_message ⇒ `String`

#endpoint_configuration ⇒ `Types::EndpointConfiguration`

#mutual_tls_authentication ⇒ `Types::MutualTlsAuthentication`

#ownership_verification_certificate_arn ⇒ `String`

#regional_certificate_arn ⇒ `String`

#regional_certificate_name ⇒ `String`

#regional_domain_name ⇒ `String`

#regional_hosted_zone_id ⇒ `String`

#security_policy ⇒ `String`

#tags ⇒ `Hash<String,String>`