AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Class: Aws::ApiGatewayV2::Types::UpdateDomainNameRequest

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 UpdateDomainNameRequest data as a hash:

{
  domain_name: "__string", # required
  domain_name_configurations: [
    {
      api_gateway_domain_name: "__string",
      certificate_arn: "Arn",
      certificate_name: "StringWithLengthBetween1And128",
      certificate_upload_date: Time.now,
      domain_name_status: "AVAILABLE", # accepts AVAILABLE, UPDATING, PENDING_CERTIFICATE_REIMPORT, PENDING_OWNERSHIP_VERIFICATION
      domain_name_status_message: "__string",
      endpoint_type: "REGIONAL", # accepts REGIONAL, EDGE
      hosted_zone_id: "__string",
      security_policy: "TLS_1_0", # accepts TLS_1_0, TLS_1_2
      ownership_verification_certificate_arn: "Arn",
    },
  ],
  mutual_tls_authentication: {
    truststore_uri: "UriWithLengthBetween1And2048",
    truststore_version: "StringWithLengthBetween1And64",
  },
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#domain_nameString

Returns:

  • (String)


7296
7297
7298
7299
7300
7301
7302
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 7296

class UpdateDomainNameRequest < Struct.new(
  :domain_name,
  :domain_name_configurations,
  :mutual_tls_authentication)
  SENSITIVE = []
  include Aws::Structure
end

#domain_name_configurationsArray<Types::DomainNameConfiguration>

The domain name configurations.

Returns:



7296
7297
7298
7299
7300
7301
7302
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 7296

class UpdateDomainNameRequest < Struct.new(
  :domain_name,
  :domain_name_configurations,
  :mutual_tls_authentication)
  SENSITIVE = []
  include Aws::Structure
end

#mutual_tls_authenticationTypes::MutualTlsAuthenticationInput

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



7296
7297
7298
7299
7300
7301
7302
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 7296

class UpdateDomainNameRequest < Struct.new(
  :domain_name,
  :domain_name_configurations,
  :mutual_tls_authentication)
  SENSITIVE = []
  include Aws::Structure
end