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

Class: Aws::ServiceDiscovery::Types::CreateServiceRequest

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

Overview

Note:

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

Instance Attribute Details

#creator_request_idString

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.

Returns:

  • (String)


248
249
250
251
252
253
254
255
256
257
# File 'gems/aws-sdk-servicediscovery/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

#descriptionString

A description for the service.

Returns:

  • (String)


248
249
250
251
252
253
254
255
256
257
# File 'gems/aws-sdk-servicediscovery/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_configTypes::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.

Returns:



248
249
250
251
252
253
254
255
256
257
# File 'gems/aws-sdk-servicediscovery/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_configTypes::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 'gems/aws-sdk-servicediscovery/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_configTypes::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 'gems/aws-sdk-servicediscovery/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

#nameString

The name that you want to assign to the service.

Returns:

  • (String)


248
249
250
251
252
253
254
255
256
257
# File 'gems/aws-sdk-servicediscovery/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_idString

The ID of the namespace that you want to use to create the service.

Returns:

  • (String)


248
249
250
251
252
253
254
255
256
257
# File 'gems/aws-sdk-servicediscovery/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