Class: Aws::ServiceDiscovery::Types::Service
- Inherits:
-
Struct
- Object
- Struct
- Aws::ServiceDiscovery::Types::Service
- 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
-
#arn ⇒ String
The Amazon Resource Name (ARN) that AWS Cloud Map assigns to the service when you create it.
-
#create_date ⇒ Time
The date and time that the service was created, in Unix format and Coordinated Universal Time (UTC).
-
#creator_request_id ⇒ String
A unique string that identifies the request and that allows failed requests to be retried without the risk of running the operation twice.
-
#description ⇒ String
The description of the service.
-
#dns_config ⇒ Types::DnsConfig
A complex type that contains information about the Route 53 DNS records that you want AWS Cloud Map to create when you register an instance.
-
#health_check_config ⇒ Types::HealthCheckConfig
*Public DNS and HTTP namespaces only.* A complex type that contains settings for an optional health check.
-
#health_check_custom_config ⇒ Types::HealthCheckCustomConfig
A complex type that contains information about an optional custom health check.
-
#id ⇒ String
The ID that AWS Cloud Map assigned to the service when you created it.
-
#instance_count ⇒ Integer
The number of instances that are currently associated with the service.
-
#name ⇒ String
The name of the service.
-
#namespace_id ⇒ String
The ID of the namespace that was used to create the service.
-
#type ⇒ String
Describes the systems that can be used to discover the service instances.
Instance Attribute Details
#arn ⇒ String
The Amazon Resource Name (ARN) that AWS Cloud Map assigns to the service when you create it.
2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 |
# File 'lib/aws-sdk-servicediscovery/types.rb', line 2828 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_date ⇒ Time
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.
2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 |
# File 'lib/aws-sdk-servicediscovery/types.rb', line 2828 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_id ⇒ String
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.
2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 |
# File 'lib/aws-sdk-servicediscovery/types.rb', line 2828 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 |
#description ⇒ String
The description of the service.
2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 |
# File 'lib/aws-sdk-servicediscovery/types.rb', line 2828 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_config ⇒ Types::DnsConfig
A complex type that contains information about the Route 53 DNS records that you want AWS Cloud Map to create when you register an instance.
2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 |
# File 'lib/aws-sdk-servicediscovery/types.rb', line 2828 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_config ⇒ Types::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, AWS 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].
2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 |
# File 'lib/aws-sdk-servicediscovery/types.rb', line 2828 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_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.
2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 |
# File 'lib/aws-sdk-servicediscovery/types.rb', line 2828 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 |
#id ⇒ String
The ID that AWS Cloud Map assigned to the service when you created it.
2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 |
# File 'lib/aws-sdk-servicediscovery/types.rb', line 2828 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_count ⇒ Integer
The number of instances that are currently associated with the service. Instances that were previously associated with the service but that have been deleted are not included in the count. The count might not reflect pending registrations and deregistrations.
2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 |
# File 'lib/aws-sdk-servicediscovery/types.rb', line 2828 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 |
#name ⇒ String
The name of the service.
2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 |
# File 'lib/aws-sdk-servicediscovery/types.rb', line 2828 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_id ⇒ String
The ID of the namespace that was used to create the service.
2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 |
# File 'lib/aws-sdk-servicediscovery/types.rb', line 2828 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 |
#type ⇒ String
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.
2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 |
# File 'lib/aws-sdk-servicediscovery/types.rb', line 2828 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 |