Class: Aws::ApiGatewayV2::Types::CreateDomainNameRequest

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

{
  domain_name: "StringWithLengthBetween1And512", # 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",
  },
  tags: {
    "__string" => "StringWithLengthBetween1And1600",
  },
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#domain_nameString

A string with a length between [1-512].

Returns:

  • (String)


1310
1311
1312
1313
1314
1315
1316
1317
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 1310

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

#domain_name_configurationsArray<Types::DomainNameConfiguration>

The domain name configurations.

Returns:



1310
1311
1312
1313
1314
1315
1316
1317
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 1310

class CreateDomainNameRequest < Struct.new(
  :domain_name,
  :domain_name_configurations,
  :mutual_tls_authentication,
  :tags)
  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.



1310
1311
1312
1313
1314
1315
1316
1317
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 1310

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

#tagsHash<String,String>

Represents a collection of tags associated with the resource.

Returns:

  • (Hash<String,String>)


1310
1311
1312
1313
1314
1315
1316
1317
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 1310

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