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

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

Overview

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


3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
# File 'gems/aws-sdk-servicediscovery/lib/aws-sdk-servicediscovery/types.rb', line 3420

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

#create_dateTime

The date and time that the service was created.

Returns:

  • (Time)


3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
# File 'gems/aws-sdk-servicediscovery/lib/aws-sdk-servicediscovery/types.rb', line 3420

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

#descriptionString

The description that you specify when you create the service.

Returns:

  • (String)


3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
# File 'gems/aws-sdk-servicediscovery/lib/aws-sdk-servicediscovery/types.rb', line 3420

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

#dns_configTypes::DnsConfig

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

Returns:



3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
# File 'gems/aws-sdk-servicediscovery/lib/aws-sdk-servicediscovery/types.rb', line 3420

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

#health_check_configTypes::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.



3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
# File 'gems/aws-sdk-servicediscovery/lib/aws-sdk-servicediscovery/types.rb', line 3420

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

#health_check_custom_configTypes::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.



3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
# File 'gems/aws-sdk-servicediscovery/lib/aws-sdk-servicediscovery/types.rb', line 3420

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

#idString

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

Returns:

  • (String)


3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
# File 'gems/aws-sdk-servicediscovery/lib/aws-sdk-servicediscovery/types.rb', line 3420

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


3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
# File 'gems/aws-sdk-servicediscovery/lib/aws-sdk-servicediscovery/types.rb', line 3420

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

#nameString

The name of the service.

Returns:

  • (String)


3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
# File 'gems/aws-sdk-servicediscovery/lib/aws-sdk-servicediscovery/types.rb', line 3420

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


3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
# File 'gems/aws-sdk-servicediscovery/lib/aws-sdk-servicediscovery/types.rb', line 3420

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