Class: Aws::ServiceDiscovery::Types::ServiceSummary

Inherits:

Struct

• Object
• Struct
• Aws::ServiceDiscovery::Types::ServiceSummary

Defined in:

gems/aws-sdk-servicediscovery/lib/aws-sdk-servicediscovery/types.rb

Overview

A complex type that contains information about a 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.

• #created_by_account ⇒ String

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

• #description ⇒ String

  The description that you specify when you create the service.

• #dns_config ⇒ Types::DnsConfig

  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. Settings for an optional health check.

• #health_check_custom_config ⇒ Types::HealthCheckCustomConfig

  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.

• #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 'gems/aws-sdk-servicediscovery/lib/aws-sdk-servicediscovery/types.rb', line 3428

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

#create_date ⇒ Time

The date and time that the service was created.

Returns:

• (Time)

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

class ServiceSummary < Struct.new(
  :id,
  :arn,
  :resource_owner,
  :name,
  :type,
  :description,
  :instance_count,
  :dns_config,
  :health_check_config,
  :health_check_custom_config,
  :create_date,
  :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 account ID 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 in the Cloud Map Developer Guide.

Returns:

• (String)

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

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

#description ⇒ String

The description that you specify when you create the service.

Returns:

• (String)

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

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

#dns_config ⇒ Types::DnsConfig

Information about the Route 53 DNS records that you want Cloud Map to create when you register an instance.

Returns:

• (Types::DnsConfig)

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

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

#health_check_config ⇒ Types::HealthCheckConfig

Public DNS and HTTP namespaces only. 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.

Returns:

• (Types::HealthCheckConfig)

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

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

#health_check_custom_config ⇒ Types::HealthCheckCustomConfig

Information about an optional custom health check. A custom health check, which requires that you use a third-party health checker to evaluate the health of your resources, is useful in the following circumstances:

• You can't use a health check that's defined by HealthCheckConfig because the resource isn't available over the internet. For example, you can use a custom health check when the instance is in an Amazon VPC. (To check the health of resources in a VPC, the health checker must also be in the VPC.)

• You want to use a third-party health checker regardless of where your resources are located.

If you specify a health check configuration, you can specify either HealthCheckCustomConfig or HealthCheckConfig but not both.

Returns:

• (Types::HealthCheckCustomConfig)

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

class ServiceSummary < Struct.new(
  :id,
  :arn,
  :resource_owner,
  :name,
  :type,
  :description,
  :instance_count,
  :dns_config,
  :health_check_config,
  :health_check_custom_config,
  :create_date,
  :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 'gems/aws-sdk-servicediscovery/lib/aws-sdk-servicediscovery/types.rb', line 3428

class ServiceSummary < Struct.new(
  :id,
  :arn,
  :resource_owner,
  :name,
  :type,
  :description,
  :instance_count,
  :dns_config,
  :health_check_config,
  :health_check_custom_config,
  :create_date,
  :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 'gems/aws-sdk-servicediscovery/lib/aws-sdk-servicediscovery/types.rb', line 3428

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

#name ⇒ String

The name of the service.

Returns:

• (String)

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

class ServiceSummary < Struct.new(
  :id,
  :arn,
  :resource_owner,
  :name,
  :type,
  :description,
  :instance_count,
  :dns_config,
  :health_check_config,
  :health_check_custom_config,
  :create_date,
  :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 in the Cloud Map Developer Guide.

Returns:

• (String)

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

class ServiceSummary < Struct.new(
  :id,
  :arn,
  :resource_owner,
  :name,
  :type,
  :description,
  :instance_count,
  :dns_config,
  :health_check_config,
  :health_check_custom_config,
  :create_date,
  :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 'gems/aws-sdk-servicediscovery/lib/aws-sdk-servicediscovery/types.rb', line 3428

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