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.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #arn ⇒ String

  The Amazon Resource Name (ARN) that 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).

• #created_by_account ⇒ String

  The ID of the Amazon Web Services account that created the service.

• #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 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 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.

• #resource_owner ⇒ String

  The ID of the Amazon Web Services account that created the namespace with which the service is associated.

• #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 Cloud Map assigns to the service when you create it.

Returns:

• (String)

# File 'lib/aws-sdk-servicediscovery/types.rb', line 3119

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

Returns:

• (Time)

# File 'lib/aws-sdk-servicediscovery/types.rb', line 3119

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

#created_by_account ⇒ String

The ID of the Amazon Web Services account that created the service. If this isn’t your account ID, it is the ID of account of the namespace owner or of another account with which the namespace has been shared. For more information about shared namespaces, see

Cross-account Cloud Map namespace sharing][1

in the *Cloud Map

Developer Guide*.

[1]: docs.aws.amazon.com/cloud-map/latest/dg/sharing-namespaces.html

Returns:

• (String)

# File 'lib/aws-sdk-servicediscovery/types.rb', line 3119

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

Returns:

• (String)

# File 'lib/aws-sdk-servicediscovery/types.rb', line 3119

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

#description ⇒ String

The description of the service.

Returns:

• (String)

# File 'lib/aws-sdk-servicediscovery/types.rb', line 3119

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

#dns_config ⇒ Types::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:

• (Types::DnsConfig)

# File 'lib/aws-sdk-servicediscovery/types.rb', line 3119

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

Returns:

• (Types::HealthCheckConfig)

# File 'lib/aws-sdk-servicediscovery/types.rb', line 3119

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

Returns:

• (Types::HealthCheckCustomConfig)

# File 'lib/aws-sdk-servicediscovery/types.rb', line 3119

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

#id ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-servicediscovery/types.rb', line 3119

class Service < Struct.new(
  :id,
  :arn,
  :resource_owner,
  :name,
  :namespace_id,
  :description,
  :instance_count,
  :dns_config,
  :type,
  :health_check_config,
  :health_check_custom_config,
  :create_date,
  :creator_request_id,
  :created_by_account)
  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 are deleted aren’t included in the count. The count might not reflect pending registrations and deregistrations.

Returns:

• (Integer)

# File 'lib/aws-sdk-servicediscovery/types.rb', line 3119

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

#name ⇒ String

The name of the service.

Returns:

• (String)

# File 'lib/aws-sdk-servicediscovery/types.rb', line 3119

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

#namespace_id ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-servicediscovery/types.rb', line 3119

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

#resource_owner ⇒ String

The ID of the Amazon Web Services account that created the namespace with which the service is associated. If this isn’t your account ID, it is the ID of the account that shared the namespace with your account. For more information about shared namespaces, see

Cross-account Cloud Map namespace sharing][1

in the *Cloud Map

Developer Guide*.

[1]: docs.aws.amazon.com/cloud-map/latest/dg/sharing-namespaces.html

Returns:

• (String)

# File 'lib/aws-sdk-servicediscovery/types.rb', line 3119

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

Returns:

• (String)

# File 'lib/aws-sdk-servicediscovery/types.rb', line 3119

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