Class: Aws::ServiceDiscovery::Types::CreateServiceRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::ServiceDiscovery::Types::CreateServiceRequest
- Includes:
- Aws::Structure
- Defined in:
- lib/aws-sdk-servicediscovery/types.rb
Overview
When making an API call, you may pass CreateServiceRequest data as a hash:
{
name: "ServiceName", # required
namespace_id: "ResourceId",
creator_request_id: "ResourceId",
description: "ResourceDescription",
dns_config: {
namespace_id: "ResourceId",
routing_policy: "MULTIVALUE", # accepts MULTIVALUE, WEIGHTED
dns_records: [ # required
{
type: "SRV", # required, accepts SRV, A, AAAA, CNAME
ttl: 1, # required
},
],
},
health_check_config: {
type: "HTTP", # required, accepts HTTP, HTTPS, TCP
resource_path: "ResourcePath",
failure_threshold: 1,
},
health_check_custom_config: {
failure_threshold: 1,
},
}
Instance Attribute Summary collapse
-
#creator_request_id ⇒ String
A unique string that identifies the request and that allows failed ‘CreateService` requests to be retried without the risk of executing the operation twice.
-
#description ⇒ String
A description for the service.
-
#dns_config ⇒ Types::DnsConfig
A complex type that contains information about the Amazon Route 53 records that you want AWS Cloud Map to create when you register an instance.
-
#health_check_config ⇒ Types::HealthCheckConfig
*Public DNS namespaces only.* A complex type that contains settings for an optional Route 53 health check.
-
#health_check_custom_config ⇒ Types::HealthCheckCustomConfig
A complex type that contains information about an optional custom health check.
-
#name ⇒ String
The name that you want to assign to the service.
-
#namespace_id ⇒ String
The ID of the namespace that you want to use to create the service.
Instance Attribute Details
#creator_request_id ⇒ String
A unique string that identifies the request and that allows failed ‘CreateService` requests to be retried without the risk of executing the operation twice. `CreatorRequestId` can be any unique string, for example, a date/time stamp.
**A suitable default value is auto-generated.** You should normally not need to pass this option.
248 249 250 251 252 253 254 255 256 257 |
# File 'lib/aws-sdk-servicediscovery/types.rb', line 248 class CreateServiceRequest < Struct.new( :name, :namespace_id, :creator_request_id, :description, :dns_config, :health_check_config, :health_check_custom_config) include Aws::Structure end |
#description ⇒ String
A description for the service.
248 249 250 251 252 253 254 255 256 257 |
# File 'lib/aws-sdk-servicediscovery/types.rb', line 248 class CreateServiceRequest < Struct.new( :name, :namespace_id, :creator_request_id, :description, :dns_config, :health_check_config, :health_check_custom_config) include Aws::Structure end |
#dns_config ⇒ Types::DnsConfig
A complex type that contains information about the Amazon Route 53 records that you want AWS Cloud Map to create when you register an instance.
248 249 250 251 252 253 254 255 256 257 |
# File 'lib/aws-sdk-servicediscovery/types.rb', line 248 class CreateServiceRequest < Struct.new( :name, :namespace_id, :creator_request_id, :description, :dns_config, :health_check_config, :health_check_custom_config) include Aws::Structure end |
#health_check_config ⇒ Types::HealthCheckConfig
*Public DNS namespaces only.* A complex type that contains settings for an optional Route 53 health check. If you specify settings for a health check, AWS Cloud Map associates the health check with all the Route 53 DNS records that you specify in ‘DnsConfig`.
If you specify a health check configuration, you can specify either ‘HealthCheckCustomConfig` or `HealthCheckConfig` but not both.
For information about the charges for health checks, see [AWS Cloud Map Pricing].
248 249 250 251 252 253 254 255 256 257 |
# File 'lib/aws-sdk-servicediscovery/types.rb', line 248 class CreateServiceRequest < Struct.new( :name, :namespace_id, :creator_request_id, :description, :dns_config, :health_check_config, :health_check_custom_config) include Aws::Structure end |
#health_check_custom_config ⇒ Types::HealthCheckCustomConfig
A complex type that contains information about an optional custom health check.
If you specify a health check configuration, you can specify either ‘HealthCheckCustomConfig` or `HealthCheckConfig` but not both.
248 249 250 251 252 253 254 255 256 257 |
# File 'lib/aws-sdk-servicediscovery/types.rb', line 248 class CreateServiceRequest < Struct.new( :name, :namespace_id, :creator_request_id, :description, :dns_config, :health_check_config, :health_check_custom_config) include Aws::Structure end |
#name ⇒ String
The name that you want to assign to the service.
248 249 250 251 252 253 254 255 256 257 |
# File 'lib/aws-sdk-servicediscovery/types.rb', line 248 class CreateServiceRequest < Struct.new( :name, :namespace_id, :creator_request_id, :description, :dns_config, :health_check_config, :health_check_custom_config) include Aws::Structure end |
#namespace_id ⇒ String
The ID of the namespace that you want to use to create the service.
248 249 250 251 252 253 254 255 256 257 |
# File 'lib/aws-sdk-servicediscovery/types.rb', line 248 class CreateServiceRequest < Struct.new( :name, :namespace_id, :creator_request_id, :description, :dns_config, :health_check_config, :health_check_custom_config) include Aws::Structure end |