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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb

Overview

Note:

When making an API call, you may pass DomainNameConfiguration data as a 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)


2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 2565

class DomainNameConfiguration < Struct.new(
  :api_gateway_domain_name,
  :certificate_arn,
  :certificate_name,
  :certificate_upload_date,
  :endpoint_type,
  :hosted_zone_id,
  :security_policy,
  :domain_name_status,
  :domain_name_status_message)
  include Aws::Structure
end

#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)


2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 2565

class DomainNameConfiguration < Struct.new(
  :api_gateway_domain_name,
  :certificate_arn,
  :certificate_name,
  :certificate_upload_date,
  :endpoint_type,
  :hosted_zone_id,
  :security_policy,
  :domain_name_status,
  :domain_name_status_message)
  include Aws::Structure
end

#certificate_nameString

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

Returns:

  • (String)


2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 2565

class DomainNameConfiguration < Struct.new(
  :api_gateway_domain_name,
  :certificate_arn,
  :certificate_name,
  :certificate_upload_date,
  :endpoint_type,
  :hosted_zone_id,
  :security_policy,
  :domain_name_status,
  :domain_name_status_message)
  include Aws::Structure
end

#certificate_upload_dateTime

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

Returns:

  • (Time)


2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 2565

class DomainNameConfiguration < Struct.new(
  :api_gateway_domain_name,
  :certificate_arn,
  :certificate_name,
  :certificate_upload_date,
  :endpoint_type,
  :hosted_zone_id,
  :security_policy,
  :domain_name_status,
  :domain_name_status_message)
  include Aws::Structure
end

#domain_name_statusString

The status of the domain name migration. The valid values are AVAILABLE and UPDATING. 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)


2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 2565

class DomainNameConfiguration < Struct.new(
  :api_gateway_domain_name,
  :certificate_arn,
  :certificate_name,
  :certificate_upload_date,
  :endpoint_type,
  :hosted_zone_id,
  :security_policy,
  :domain_name_status,
  :domain_name_status_message)
  include Aws::Structure
end

#domain_name_status_messageString

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

Returns:

  • (String)


2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 2565

class DomainNameConfiguration < Struct.new(
  :api_gateway_domain_name,
  :certificate_arn,
  :certificate_name,
  :certificate_upload_date,
  :endpoint_type,
  :hosted_zone_id,
  :security_policy,
  :domain_name_status,
  :domain_name_status_message)
  include Aws::Structure
end

#endpoint_typeString

The endpoint type.

Returns:

  • (String)


2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 2565

class DomainNameConfiguration < Struct.new(
  :api_gateway_domain_name,
  :certificate_arn,
  :certificate_name,
  :certificate_upload_date,
  :endpoint_type,
  :hosted_zone_id,
  :security_policy,
  :domain_name_status,
  :domain_name_status_message)
  include Aws::Structure
end

#hosted_zone_idString

The Amazon Route 53 Hosted Zone ID of the endpoint.

Returns:

  • (String)


2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 2565

class DomainNameConfiguration < Struct.new(
  :api_gateway_domain_name,
  :certificate_arn,
  :certificate_name,
  :certificate_upload_date,
  :endpoint_type,
  :hosted_zone_id,
  :security_policy,
  :domain_name_status,
  :domain_name_status_message)
  include Aws::Structure
end

#security_policyString

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.

Returns:

  • (String)


2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 2565

class DomainNameConfiguration < Struct.new(
  :api_gateway_domain_name,
  :certificate_arn,
  :certificate_name,
  :certificate_upload_date,
  :endpoint_type,
  :hosted_zone_id,
  :security_policy,
  :domain_name_status,
  :domain_name_status_message)
  include Aws::Structure
end