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

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

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 running the operation twice. CreatorRequestId can be any unique string (for example, a date/timestamp).

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

  • (String) 


311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'gems/aws-sdk-servicediscovery/lib/aws-sdk-servicediscovery/types.rb', line 311

class CreateServiceRequest < Struct.new(
  :name,
  :namespace_id,
  :creator_request_id,
  :description,
  :dns_config,
  :health_check_config,
  :health_check_custom_config,
  :tags,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

A description for the service.

Returns:

  • (String) 


311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'gems/aws-sdk-servicediscovery/lib/aws-sdk-servicediscovery/types.rb', line 311

class CreateServiceRequest < Struct.new(
  :name,
  :namespace_id,
  :creator_request_id,
  :description,
  :dns_config,
  :health_check_config,
  :health_check_custom_config,
  :tags,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#dns_config ⇒ Types::DnsConfig

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

Returns:



311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'gems/aws-sdk-servicediscovery/lib/aws-sdk-servicediscovery/types.rb', line 311

class CreateServiceRequest < Struct.new(
  :name,
  :namespace_id,
  :creator_request_id,
  :description,
  :dns_config,
  :health_check_config,
  :health_check_custom_config,
  :tags,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#health_check_config ⇒ Types::HealthCheckConfig

Public DNS and HTTP namespaces only. A complex type that contains settings for an optional Route 53 health check. If you specify settings for a health check, 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 Cloud Map Pricing.

Returns:



311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'gems/aws-sdk-servicediscovery/lib/aws-sdk-servicediscovery/types.rb', line 311

class CreateServiceRequest < Struct.new(
  :name,
  :namespace_id,
  :creator_request_id,
  :description,
  :dns_config,
  :health_check_config,
  :health_check_custom_config,
  :tags,
  :type)
  SENSITIVE = []
  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.

You can't add, update, or delete a HealthCheckCustomConfig configuration from an existing service.

Returns:



311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'gems/aws-sdk-servicediscovery/lib/aws-sdk-servicediscovery/types.rb', line 311

class CreateServiceRequest < Struct.new(
  :name,
  :namespace_id,
  :creator_request_id,
  :description,
  :dns_config,
  :health_check_config,
  :health_check_custom_config,
  :tags,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name that you want to assign to the service.

Do not include sensitive information in the name if the namespace is discoverable by public DNS queries.

If you want Cloud Map to create an SRV record when you register an instance and you're using a system that requires a specific SRV format, such as HAProxy, specify the following for Name:

  • Start the name with an underscore (_), such as _exampleservice.

  • End the name with ._protocol, such as ._tcp.

When you register an instance, Cloud Map creates an SRV record and assigns a name to the record by concatenating the service name and the namespace name (for example,

_exampleservice._tcp.example.com).

For services that are accessible by DNS queries, you can't create multiple services with names that differ only by case (such as EXAMPLE and example). Otherwise, these services have the same DNS name and can't be distinguished. However, if you use a namespace that's only accessible by API calls, then you can create services that with names that differ only by case.

Returns:

  • (String) 


311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'gems/aws-sdk-servicediscovery/lib/aws-sdk-servicediscovery/types.rb', line 311

class CreateServiceRequest < Struct.new(
  :name,
  :namespace_id,
  :creator_request_id,
  :description,
  :dns_config,
  :health_check_config,
  :health_check_custom_config,
  :tags,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#namespace_id ⇒ String

The ID or Amazon Resource Name (ARN) of the namespace that you want to use to create the service. For namespaces shared with your Amazon Web Services account, specify the namespace ARN. For more information about shared namespaces, see Cross-account Cloud Map namespace sharing in the Cloud Map Developer Guide.

Returns:

  • (String) 


311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'gems/aws-sdk-servicediscovery/lib/aws-sdk-servicediscovery/types.rb', line 311

class CreateServiceRequest < Struct.new(
  :name,
  :namespace_id,
  :creator_request_id,
  :description,
  :dns_config,
  :health_check_config,
  :health_check_custom_config,
  :tags,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

The tags to add to the service. Each tag consists of a key and an optional value that you define. Tags keys can be up to 128 characters in length, and tag values can be up to 256 characters in length.

Returns:



311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'gems/aws-sdk-servicediscovery/lib/aws-sdk-servicediscovery/types.rb', line 311

class CreateServiceRequest < Struct.new(
  :name,
  :namespace_id,
  :creator_request_id,
  :description,
  :dns_config,
  :health_check_config,
  :health_check_custom_config,
  :tags,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ String

If present, specifies that the service instances are only discoverable using the DiscoverInstances API operation. No DNS records is registered for the service instances. The only valid value is HTTP.

Returns:

  • (String) 


311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'gems/aws-sdk-servicediscovery/lib/aws-sdk-servicediscovery/types.rb', line 311

class CreateServiceRequest < Struct.new(
  :name,
  :namespace_id,
  :creator_request_id,
  :description,
  :dns_config,
  :health_check_config,
  :health_check_custom_config,
  :tags,
  :type)
  SENSITIVE = []
  include Aws::Structure
end