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

Class: Aws::ApiGatewayV2::Types::DomainNameConfiguration

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

Overview

Note:

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

{
  api_gateway_domain_name: "__string",
  certificate_arn: "Arn",
  certificate_name: "StringWithLengthBetween1And128",
  certificate_upload_date: Time.now,
  endpoint_type: "REGIONAL", # accepts REGIONAL, EDGE
  hosted_zone_id: "__string",
  security_policy: "TLS_1_0", # accepts TLS_1_0, TLS_1_2
  domain_name_status: "AVAILABLE", # accepts AVAILABLE, UPDATING
  domain_name_status_message: "__string",
}

The domain name configuration.

Instance Attribute Summary collapse

Instance Attribute Details

#api_gateway_domain_nameString

A domain name for the WebSocket API.

Returns:

  • (String)

    A domain name for the WebSocket API.

#certificate_arnString

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.

Returns:

  • (String)

    An AWS-managed certificate that will be used by the edge-optimized endpoint for this domain name.

#certificate_nameString

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

Returns:

  • (String)

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

#certificate_upload_dateTime

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

Returns:

  • (Time)

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

#domain_name_statusString

Possible values:

  • AVAILABLE
  • UPDATING

Returns:

  • (String)

#domain_name_status_messageString

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

Returns:

  • (String)

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

#endpoint_typeString

The endpoint type.

Possible values:

  • REGIONAL
  • EDGE

Returns:

  • (String)

    The endpoint type.

#hosted_zone_idString

The Amazon Route 53 Hosted Zone ID of the endpoint.

Returns:

  • (String)

    The Amazon Route 53 Hosted Zone ID of the endpoint.

#security_policyString

Possible values:

  • TLS_1_0
  • TLS_1_2

Returns:

  • (String)