Class: Aws::ServiceDiscovery::Types::Instance

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

Overview

A complex type that contains information about an instance that Cloud Map creates when you submit a RegisterInstance request.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#attributes ⇒ Hash<String,String>

A string map that contains the following information for the service that you specify in ServiceId:

  • The attributes that apply to the records that are defined in the service.

  • For each attribute, the applicable value.

<note markdown=“1”> Do not include sensitive information in the attributes if the namespace is discoverable by public DNS queries.

</note>

Supported attribute keys include the following:

AWS_ALIAS_DNS_NAME

: If you want Cloud Map to create a Route 53 alias record that

routes traffic to an Elastic Load Balancing load balancer, specify
the DNS name that's associated with the load balancer. For
information about how to get the DNS name, see
[AliasTarget-&gt;DNSName][1] in the *Route 53 API Reference*.

Note the following:

* The configuration for the service that's specified by
  `ServiceId` must include settings for an `A` record, an `AAAA`
  record, or both.

* In the service that's specified by `ServiceId`, the value of
  `RoutingPolicy` must be `WEIGHTED`.

* If the service that's specified by `ServiceId` includes
  `HealthCheckConfig` settings, Cloud Map creates the health
  check, but it won't associate the health check with the alias
  record.

* Auto naming currently doesn't support creating alias records
  that route traffic to Amazon Web Services resources other than
  ELB load balancers.

* If you specify a value for `AWS_ALIAS_DNS_NAME`, don't specify
  values for any of the `AWS_INSTANCE` attributes.

AWS_EC2_INSTANCE_ID

: *HTTP namespaces only.* The Amazon EC2 instance ID for the

instance. The `AWS_INSTANCE_IPV4` attribute contains the primary
private IPv4 address.

AWS_INIT_HEALTH_STATUS

: If the service configuration includes HealthCheckCustomConfig,

you can optionally use `AWS_INIT_HEALTH_STATUS` to specify the
initial status of the custom health check, `HEALTHY` or
`UNHEALTHY`. If you don't specify a value for
`AWS_INIT_HEALTH_STATUS`, the initial status is `HEALTHY`.

AWS_INSTANCE_CNAME

: If the service configuration includes a CNAME record, the domain

name that you want Route

AWS_INSTANCE_IPV4

: If the service configuration includes an A record, the IPv4

address that you want Route

AWS_INSTANCE_IPV6

: If the service configuration includes an AAAA record, the IPv6

address that you want Route

AWS_INSTANCE_PORT

: If the service includes an SRV record, the value that you want

Route

[1]: docs.aws.amazon.com/Route53/latest/APIReference/API_AliasTarget.html#Route53-Type-AliasTarget-DNSName

Returns:

  • (Hash<String,String>) 


1615
1616
1617
1618
1619
1620
1621
1622
 
# File 'lib/aws-sdk-servicediscovery/types.rb', line 1615

class Instance < Struct.new(
  :id,
  :creator_request_id,
  :attributes,
  :created_by_account)
  SENSITIVE = []
  include Aws::Structure
end

#created_by_account ⇒ String

The ID of the Amazon Web Services account that registered the instance. If this isn’t your account ID, it’s the ID of the account that shared the namespace with your account or the ID 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*.

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

Returns:

  • (String) 


1615
1616
1617
1618
1619
1620
1621
1622
 
# File 'lib/aws-sdk-servicediscovery/types.rb', line 1615

class Instance < Struct.new(
  :id,
  :creator_request_id,
  :attributes,
  :created_by_account)
  SENSITIVE = []
  include Aws::Structure
end

#creator_request_id ⇒ String

A unique string that identifies the request and that allows failed RegisterInstance requests to be retried without the risk of executing the operation twice. You must use a unique CreatorRequestId string every time you submit a RegisterInstance request if you’re registering additional instances for the same namespace and service. CreatorRequestId can be any unique string (for example, a date/time stamp).

Returns:

  • (String) 


1615
1616
1617
1618
1619
1620
1621
1622
 
# File 'lib/aws-sdk-servicediscovery/types.rb', line 1615

class Instance < Struct.new(
  :id,
  :creator_request_id,
  :attributes,
  :created_by_account)
  SENSITIVE = []
  include Aws::Structure
end

#id ⇒ String

An identifier that you want to associate with the instance. Note the following:

  • If the service that’s specified by ServiceId includes settings for an SRV record, the value of InstanceId is automatically included as part of the value for the SRV record. For more information, see [DnsRecord &gt; Type].

  • You can use this value to update an existing instance.

  • To register a new instance, you must specify a value that’s unique among instances that you register by using the same service.

  • If you specify an existing InstanceId and ServiceId, Cloud Map updates the existing DNS records. If there’s also an existing health check, Cloud Map deletes the old health check and creates a new one.

    <note markdown=“1”> The health check isn’t deleted immediately, so it will still appear for a while if you submit a ListHealthChecks request, for example.

    </note>

[1]: docs.aws.amazon.com/cloud-map/latest/api/API_DnsRecord.html#cloudmap-Type-DnsRecord-Type

Returns:

  • (String) 


1615
1616
1617
1618
1619
1620
1621
1622
 
# File 'lib/aws-sdk-servicediscovery/types.rb', line 1615

class Instance < Struct.new(
  :id,
  :creator_request_id,
  :attributes,
  :created_by_account)
  SENSITIVE = []
  include Aws::Structure
end