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

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",
}

A request to create a new domain name.

Instance Attribute Summary collapse

Instance Attribute Details

#certificate_arnString

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

Returns:

  • (String)


828
829
830
831
832
833
834
835
836
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 828

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

#certificate_bodyString

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

Returns:

  • (String)


828
829
830
831
832
833
834
835
836
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 828

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

#certificate_chainString

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


828
829
830
831
832
833
834
835
836
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 828

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

#certificate_nameString

The user-friendly name of the certificate.

Returns:

  • (String)


828
829
830
831
832
833
834
835
836
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 828

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

#certificate_private_keyString

[Deprecated] Your certificate's private key.

Returns:

  • (String)


828
829
830
831
832
833
834
835
836
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 828

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

#domain_nameString

(Required) The name of the DomainName resource.

Returns:

  • (String)


828
829
830
831
832
833
834
835
836
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 828

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