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
  creator_request_id: "ResourceId",
  description: "ResourceDescription",
  dns_config: { # required
    namespace_id: "ResourceId", # required
    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,
  },
}

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)


179
180
181
182
183
184
185
186
# File 'gems/aws-sdk-servicediscovery/lib/aws-sdk-servicediscovery/types.rb', line 179

class CreateServiceRequest < Struct.new(
  :name,
  :creator_request_id,
  :description,
  :dns_config,
  :health_check_config)
  include Aws::Structure
end

#descriptionString

A description for the service.

Returns:

  • (String)


179
180
181
182
183
184
185
186
# File 'gems/aws-sdk-servicediscovery/lib/aws-sdk-servicediscovery/types.rb', line 179

class CreateServiceRequest < Struct.new(
  :name,
  :creator_request_id,
  :description,
  :dns_config,
  :health_check_config)
  include Aws::Structure
end

#dns_configTypes::DnsConfig

A complex type that contains information about the records that you want Route 53 to create when you register an instance.

Returns:



179
180
181
182
183
184
185
186
# File 'gems/aws-sdk-servicediscovery/lib/aws-sdk-servicediscovery/types.rb', line 179

class CreateServiceRequest < Struct.new(
  :name,
  :creator_request_id,
  :description,
  :dns_config,
  :health_check_config)
  include Aws::Structure
end

#health_check_configTypes::HealthCheckConfig

Public DNS namespaces only. A complex type that contains settings for an optional health check. If you specify settings for a health check, Route 53 associates the health check with all the records that you specify in DnsConfig.

For information about the charges for health checks, see Route 53 Pricing.



179
180
181
182
183
184
185
186
# File 'gems/aws-sdk-servicediscovery/lib/aws-sdk-servicediscovery/types.rb', line 179

class CreateServiceRequest < Struct.new(
  :name,
  :creator_request_id,
  :description,
  :dns_config,
  :health_check_config)
  include Aws::Structure
end

#nameString

The name that you want to assign to the service.

Returns:

  • (String)


179
180
181
182
183
184
185
186
# File 'gems/aws-sdk-servicediscovery/lib/aws-sdk-servicediscovery/types.rb', line 179

class CreateServiceRequest < Struct.new(
  :name,
  :creator_request_id,
  :description,
  :dns_config,
  :health_check_config)
  include Aws::Structure
end