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",
  regional_certificate_name: "String",
  regional_certificate_arn: "String",
  endpoint_configuration: {
    types: ["REGIONAL"], # accepts REGIONAL, EDGE
  },
}

A request to create a new domain name.

Instance Attribute Summary collapse

Instance Attribute Details

#certificate_arnString

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)


1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1000

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)
  include Aws::Structure
end

#certificate_bodyString

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


1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1000

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)
  include Aws::Structure
end

#certificate_chainString

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


1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1000

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)
  include Aws::Structure
end

#certificate_nameString

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

Returns:

  • (String)


1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1000

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)
  include Aws::Structure
end

#certificate_private_keyString

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

Returns:

  • (String)


1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1000

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)
  include Aws::Structure
end

#domain_nameString

(Required) The name of the DomainName resource.

Returns:

  • (String)


1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1000

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)
  include Aws::Structure
end

#endpoint_configurationTypes::EndpointConfiguration

The endpoint configuration of this DomainName showing the endpoint types of the domain name.



1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1000

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)
  include Aws::Structure
end

#regional_certificate_arnString

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)


1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1000

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)
  include Aws::Structure
end

#regional_certificate_nameString

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

Returns:

  • (String)


1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1000

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)
  include Aws::Structure
end