Class: Aws::ServiceDiscovery::Types::Service

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

Overview

A complex type that contains information about the specified service.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#arnString

The Amazon Resource Name (ARN) that Cloud Map assigns to the service when you create it.

Returns:

  • (String)


2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
# File 'lib/aws-sdk-servicediscovery/types.rb', line 2838

class Service < Struct.new(
  :id,
  :arn,
  :name,
  :namespace_id,
  :description,
  :instance_count,
  :dns_config,
  :type,
  :health_check_config,
  :health_check_custom_config,
  :create_date,
  :creator_request_id)
  SENSITIVE = []
  include Aws::Structure
end

#create_dateTime

The date and time that the service was created, in Unix format and Coordinated Universal Time (UTC). The value of ‘CreateDate` is accurate to milliseconds. For example, the value `1516925490.087` represents Friday, January 26, 2018 12:11:30.087 AM.

Returns:

  • (Time)


2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
# File 'lib/aws-sdk-servicediscovery/types.rb', line 2838

class Service < Struct.new(
  :id,
  :arn,
  :name,
  :namespace_id,
  :description,
  :instance_count,
  :dns_config,
  :type,
  :health_check_config,
  :health_check_custom_config,
  :create_date,
  :creator_request_id)
  SENSITIVE = []
  include Aws::Structure
end

#creator_request_idString

A unique string that identifies the request and that allows failed requests to be retried without the risk of running the operation twice. ‘CreatorRequestId` can be any unique string (for example, a date/timestamp).

Returns:

  • (String)


2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
# File 'lib/aws-sdk-servicediscovery/types.rb', line 2838

class Service < Struct.new(
  :id,
  :arn,
  :name,
  :namespace_id,
  :description,
  :instance_count,
  :dns_config,
  :type,
  :health_check_config,
  :health_check_custom_config,
  :create_date,
  :creator_request_id)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

The description of the service.

Returns:

  • (String)


2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
# File 'lib/aws-sdk-servicediscovery/types.rb', line 2838

class Service < Struct.new(
  :id,
  :arn,
  :name,
  :namespace_id,
  :description,
  :instance_count,
  :dns_config,
  :type,
  :health_check_config,
  :health_check_custom_config,
  :create_date,
  :creator_request_id)
  SENSITIVE = []
  include Aws::Structure
end

#dns_configTypes::DnsConfig

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

The record types of a service can only be changed by deleting the service and recreating it with a new ‘Dnsconfig`.

Returns:



2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
# File 'lib/aws-sdk-servicediscovery/types.rb', line 2838

class Service < Struct.new(
  :id,
  :arn,
  :name,
  :namespace_id,
  :description,
  :instance_count,
  :dns_config,
  :type,
  :health_check_config,
  :health_check_custom_config,
  :create_date,
  :creator_request_id)
  SENSITIVE = []
  include Aws::Structure
end

#health_check_configTypes::HealthCheckConfig

*Public DNS and HTTP namespaces only.* A complex type that contains settings for an optional health check. If you specify settings for a health check, Cloud Map associates the health check with the records that you specify in ‘DnsConfig`.

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

[1]: aws.amazon.com/route53/pricing/



2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
# File 'lib/aws-sdk-servicediscovery/types.rb', line 2838

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



2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
# File 'lib/aws-sdk-servicediscovery/types.rb', line 2838

class Service < Struct.new(
  :id,
  :arn,
  :name,
  :namespace_id,
  :description,
  :instance_count,
  :dns_config,
  :type,
  :health_check_config,
  :health_check_custom_config,
  :create_date,
  :creator_request_id)
  SENSITIVE = []
  include Aws::Structure
end

#idString

The ID that Cloud Map assigned to the service when you created it.

Returns:

  • (String)


2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
# File 'lib/aws-sdk-servicediscovery/types.rb', line 2838

class Service < Struct.new(
  :id,
  :arn,
  :name,
  :namespace_id,
  :description,
  :instance_count,
  :dns_config,
  :type,
  :health_check_config,
  :health_check_custom_config,
  :create_date,
  :creator_request_id)
  SENSITIVE = []
  include Aws::Structure
end

#instance_countInteger

The number of instances that are currently associated with the service. Instances that were previously associated with the service but that are deleted aren’t included in the count. The count might not reflect pending registrations and deregistrations.

Returns:

  • (Integer)


2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
# File 'lib/aws-sdk-servicediscovery/types.rb', line 2838

class Service < Struct.new(
  :id,
  :arn,
  :name,
  :namespace_id,
  :description,
  :instance_count,
  :dns_config,
  :type,
  :health_check_config,
  :health_check_custom_config,
  :create_date,
  :creator_request_id)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

The name of the service.

Returns:

  • (String)


2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
# File 'lib/aws-sdk-servicediscovery/types.rb', line 2838

class Service < Struct.new(
  :id,
  :arn,
  :name,
  :namespace_id,
  :description,
  :instance_count,
  :dns_config,
  :type,
  :health_check_config,
  :health_check_custom_config,
  :create_date,
  :creator_request_id)
  SENSITIVE = []
  include Aws::Structure
end

#namespace_idString

The ID of the namespace that was used to create the service.

Returns:

  • (String)


2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
# File 'lib/aws-sdk-servicediscovery/types.rb', line 2838

class Service < Struct.new(
  :id,
  :arn,
  :name,
  :namespace_id,
  :description,
  :instance_count,
  :dns_config,
  :type,
  :health_check_config,
  :health_check_custom_config,
  :create_date,
  :creator_request_id)
  SENSITIVE = []
  include Aws::Structure
end

#typeString

Describes the systems that can be used to discover the service instances.

DNS_HTTP

: The service instances can be discovered using either DNS queries

or the `DiscoverInstances` API operation.

HTTP

: The service instances can only be discovered using the

`DiscoverInstances` API operation.

DNS

: Reserved.

Returns:

  • (String)


2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
# File 'lib/aws-sdk-servicediscovery/types.rb', line 2838

class Service < Struct.new(
  :id,
  :arn,
  :name,
  :namespace_id,
  :description,
  :instance_count,
  :dns_config,
  :type,
  :health_check_config,
  :health_check_custom_config,
  :create_date,
  :creator_request_id)
  SENSITIVE = []
  include Aws::Structure
end