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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
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",
}

A request to create a new domain name.

Instance Attribute Summary collapse

Instance Attribute Details

#certificate_arn ⇒ String

The reference to an AWS-managed certificate. AWS Certificate Manager is the only supported source.

Returns:

  • (String) 


898
899
900
901
902
903
904
905
906
 
# File 'lib/aws-sdk-apigateway/types.rb', line 898

class CreateDomainNameRequest < Struct.new(
  :domain_name,
  :certificate_name,
  :certificate_body,
  :certificate_private_key,
  :certificate_chain,
  :certificate_arn)
  include Aws::Structure
end

#certificate_body ⇒ String

[Deprecated] The body of the server certificate provided by your certificate authority.

Returns:

  • (String) 


898
899
900
901
902
903
904
905
906
 
# File 'lib/aws-sdk-apigateway/types.rb', line 898

class CreateDomainNameRequest < Struct.new(
  :domain_name,
  :certificate_name,
  :certificate_body,
  :certificate_private_key,
  :certificate_chain,
  :certificate_arn)
  include Aws::Structure
end

#certificate_chain ⇒ String

[Deprecated] The intermediate certificates and optionally the root certificate, one after the other without any blank lines. 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) 


898
899
900
901
902
903
904
905
906
 
# File 'lib/aws-sdk-apigateway/types.rb', line 898

class CreateDomainNameRequest < Struct.new(
  :domain_name,
  :certificate_name,
  :certificate_body,
  :certificate_private_key,
  :certificate_chain,
  :certificate_arn)
  include Aws::Structure
end

#certificate_name ⇒ String

The user-friendly name of the certificate.

Returns:

  • (String) 


898
899
900
901
902
903
904
905
906
 
# File 'lib/aws-sdk-apigateway/types.rb', line 898

class CreateDomainNameRequest < Struct.new(
  :domain_name,
  :certificate_name,
  :certificate_body,
  :certificate_private_key,
  :certificate_chain,
  :certificate_arn)
  include Aws::Structure
end

#certificate_private_key ⇒ String

[Deprecated] Your certificate’s private key.

Returns:

  • (String) 


898
899
900
901
902
903
904
905
906
 
# File 'lib/aws-sdk-apigateway/types.rb', line 898

class CreateDomainNameRequest < Struct.new(
  :domain_name,
  :certificate_name,
  :certificate_body,
  :certificate_private_key,
  :certificate_chain,
  :certificate_arn)
  include Aws::Structure
end

#domain_name ⇒ String

(Required) The name of the DomainName resource.

Returns:

  • (String) 


898
899
900
901
902
903
904
905
906
 
# File 'lib/aws-sdk-apigateway/types.rb', line 898

class CreateDomainNameRequest < Struct.new(
  :domain_name,
  :certificate_name,
  :certificate_body,
  :certificate_private_key,
  :certificate_chain,
  :certificate_arn)
  include Aws::Structure
end