Class: Aws::APIGateway::Types::CreateDomainNameRequest

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

Overview

Note:

When making an API call, you may pass CreateDomainNameRequest data as a hash:

{
  domain_name: "String", # required
  certificate_name: "String",
  certificate_body: "String",
  certificate_private_key: "String",
  certificate_chain: "String",
  certificate_arn: "String",
  regional_certificate_name: "String",
  regional_certificate_arn: "String",
  endpoint_configuration: {
    types: ["REGIONAL"], # accepts REGIONAL, EDGE, PRIVATE
    vpc_endpoint_ids: ["String"],
  },
  tags: {
    "String" => "String",
  },
  security_policy: "TLS_1_0", # accepts TLS_1_0, TLS_1_2
  mutual_tls_authentication: {
    truststore_uri: "String",
    truststore_version: "String",
  },
  ownership_verification_certificate_arn: "String",
}

A request to create a new domain name.

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

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) 


1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1002

class CreateDomainNameRequest < Struct.new(
  :domain_name,
  :certificate_name,
  :certificate_body,
  :certificate_private_key,
  :certificate_chain,
  :certificate_arn,
  :regional_certificate_name,
  :regional_certificate_arn,
  :endpoint_configuration,
  :tags,
  :security_policy,
  :mutual_tls_authentication,
  :ownership_verification_certificate_arn)
  SENSITIVE = []
  include Aws::Structure
end

#certificate_body ⇒ String

[Deprecated] The body of the server certificate that will be used by edge-optimized endpoint for this domain name provided by your certificate authority.

Returns:

  • (String) 


1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1002

class CreateDomainNameRequest < Struct.new(
  :domain_name,
  :certificate_name,
  :certificate_body,
  :certificate_private_key,
  :certificate_chain,
  :certificate_arn,
  :regional_certificate_name,
  :regional_certificate_arn,
  :endpoint_configuration,
  :tags,
  :security_policy,
  :mutual_tls_authentication,
  :ownership_verification_certificate_arn)
  SENSITIVE = []
  include Aws::Structure
end

#certificate_chain ⇒ String

[Deprecated] The intermediate certificates and optionally the root certificate, one after the other without any blank lines, used by an edge-optimized endpoint for this domain name. If you include the root certificate, your certificate chain must start with intermediate certificates and end with the root certificate. Use the intermediate certificates that were provided by your certificate authority. Do not include any intermediaries that are not in the chain of trust path.

Returns:

  • (String) 


1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1002

class CreateDomainNameRequest < Struct.new(
  :domain_name,
  :certificate_name,
  :certificate_body,
  :certificate_private_key,
  :certificate_chain,
  :certificate_arn,
  :regional_certificate_name,
  :regional_certificate_arn,
  :endpoint_configuration,
  :tags,
  :security_policy,
  :mutual_tls_authentication,
  :ownership_verification_certificate_arn)
  SENSITIVE = []
  include Aws::Structure
end

#certificate_name ⇒ String

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

Returns:

  • (String) 


1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1002

class CreateDomainNameRequest < Struct.new(
  :domain_name,
  :certificate_name,
  :certificate_body,
  :certificate_private_key,
  :certificate_chain,
  :certificate_arn,
  :regional_certificate_name,
  :regional_certificate_arn,
  :endpoint_configuration,
  :tags,
  :security_policy,
  :mutual_tls_authentication,
  :ownership_verification_certificate_arn)
  SENSITIVE = []
  include Aws::Structure
end

#certificate_private_key ⇒ String

[Deprecated] Your edge-optimized endpoint's domain name certificate's private key.

Returns:

  • (String) 


1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1002

class CreateDomainNameRequest < Struct.new(
  :domain_name,
  :certificate_name,
  :certificate_body,
  :certificate_private_key,
  :certificate_chain,
  :certificate_arn,
  :regional_certificate_name,
  :regional_certificate_arn,
  :endpoint_configuration,
  :tags,
  :security_policy,
  :mutual_tls_authentication,
  :ownership_verification_certificate_arn)
  SENSITIVE = []
  include Aws::Structure
end

#domain_name ⇒ String

The name of the DomainName resource.

Returns:

  • (String) 


1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1002

class CreateDomainNameRequest < Struct.new(
  :domain_name,
  :certificate_name,
  :certificate_body,
  :certificate_private_key,
  :certificate_chain,
  :certificate_arn,
  :regional_certificate_name,
  :regional_certificate_arn,
  :endpoint_configuration,
  :tags,
  :security_policy,
  :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:



1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1002

class CreateDomainNameRequest < Struct.new(
  :domain_name,
  :certificate_name,
  :certificate_body,
  :certificate_private_key,
  :certificate_chain,
  :certificate_arn,
  :regional_certificate_name,
  :regional_certificate_arn,
  :endpoint_configuration,
  :tags,
  :security_policy,
  :mutual_tls_authentication,
  :ownership_verification_certificate_arn)
  SENSITIVE = []
  include Aws::Structure
end

#mutual_tls_authentication ⇒ Types::MutualTlsAuthenticationInput

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:



1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1002

class CreateDomainNameRequest < Struct.new(
  :domain_name,
  :certificate_name,
  :certificate_body,
  :certificate_private_key,
  :certificate_chain,
  :certificate_arn,
  :regional_certificate_name,
  :regional_certificate_arn,
  :endpoint_configuration,
  :tags,
  :security_policy,
  :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) 


1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1002

class CreateDomainNameRequest < Struct.new(
  :domain_name,
  :certificate_name,
  :certificate_body,
  :certificate_private_key,
  :certificate_chain,
  :certificate_arn,
  :regional_certificate_name,
  :regional_certificate_arn,
  :endpoint_configuration,
  :tags,
  :security_policy,
  :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 by regional endpoint for this domain name. AWS Certificate Manager is the only supported source.

Returns:

  • (String) 


1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1002

class CreateDomainNameRequest < Struct.new(
  :domain_name,
  :certificate_name,
  :certificate_body,
  :certificate_private_key,
  :certificate_chain,
  :certificate_arn,
  :regional_certificate_name,
  :regional_certificate_arn,
  :endpoint_configuration,
  :tags,
  :security_policy,
  :mutual_tls_authentication,
  :ownership_verification_certificate_arn)
  SENSITIVE = []
  include Aws::Structure
end

#regional_certificate_name ⇒ String

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

Returns:

  • (String) 


1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1002

class CreateDomainNameRequest < Struct.new(
  :domain_name,
  :certificate_name,
  :certificate_body,
  :certificate_private_key,
  :certificate_chain,
  :certificate_arn,
  :regional_certificate_name,
  :regional_certificate_arn,
  :endpoint_configuration,
  :tags,
  :security_policy,
  :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) 


1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1002

class CreateDomainNameRequest < Struct.new(
  :domain_name,
  :certificate_name,
  :certificate_body,
  :certificate_private_key,
  :certificate_chain,
  :certificate_arn,
  :regional_certificate_name,
  :regional_certificate_arn,
  :endpoint_configuration,
  :tags,
  :security_policy,
  :mutual_tls_authentication,
  :ownership_verification_certificate_arn)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.

Returns:

  • (Hash<String,String>) 


1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1002

class CreateDomainNameRequest < Struct.new(
  :domain_name,
  :certificate_name,
  :certificate_body,
  :certificate_private_key,
  :certificate_chain,
  :certificate_arn,
  :regional_certificate_name,
  :regional_certificate_arn,
  :endpoint_configuration,
  :tags,
  :security_policy,
  :mutual_tls_authentication,
  :ownership_verification_certificate_arn)
  SENSITIVE = []
  include Aws::Structure
end