public static final class CfnInstance.Builder
extends java.lang.Object
CfnInstance
.Modifier and Type | Method and Description |
---|---|
CfnInstance |
build() |
static CfnInstance.Builder |
create(Construct scope,
java.lang.String id) |
CfnInstance.Builder |
instanceAttributes(java.lang.Object instanceAttributes)
A string map that contains the following information for the service that you specify in `ServiceId` :.
|
CfnInstance.Builder |
instanceId(java.lang.String instanceId)
An identifier that you want to associate with the instance.
|
CfnInstance.Builder |
serviceId(java.lang.String serviceId)
The ID of the service that you want to use for settings for the instance.
|
public static CfnInstance.Builder create(Construct scope, java.lang.String id)
scope
- - scope in which this resource is defined. This parameter is required.id
- - scoped id of the resource. This parameter is required.CfnInstance.Builder
.public CfnInstance.Builder instanceAttributes(java.lang.Object instanceAttributes)
Supported attribute keys include the following:
Note the following:
ServiceId
must include settings for an A
record, an AAAA
record, or both.ServiceId
, the value of RoutingPolicy
must be WEIGHTED
.ServiceId
includes HealthCheckConfig
settings, AWS Cloud Map will create the health check, but it won't associate the health check with the alias record.AWS_ALIAS_DNS_NAME
, don't specify values for any of the AWS_INSTANCE
attributes.AWS_INSTANCE_IPV4
attribute contains the primary private IPv4 address. When creating resources with a type of AWS::ServiceDiscovery::Instance , if the AWS_EC2_INSTANCE_ID
attribute is specified, the only other attribute that can be specified is AWS_INIT_HEALTH_STATUS
. After the resource has been created, the AWS_INSTANCE_IPV4
attribute contains the primary private IPv4 address.HealthCheckCustomConfig
, when creating resources with a type of AWS::ServiceDiscovery::Instance 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
. This attribute can only be used when creating resources and will not be seen on existing resources.CNAME
record, the domain name that you want Route 53 to return in response to DNS queries, for example, example.com
.
This value is required if the service specified by ServiceId
includes settings for an CNAME
record.
A
record, the IPv4 address that you want Route 53 to return in response to DNS queries, for example, 192.0.2.44
.
This value is required if the service specified by ServiceId
includes settings for an A
record. If the service includes settings for an SRV
record, you must specify a value for AWS_INSTANCE_IPV4
, AWS_INSTANCE_IPV6
, or both.
AAAA
record, the IPv6 address that you want Route 53 to return in response to DNS queries, for example, 2001:0db8:85a3:0000:0000:abcd:0001:2345
.
This value is required if the service specified by ServiceId
includes settings for an AAAA
record. If the service includes settings for an SRV
record, you must specify a value for AWS_INSTANCE_IPV4
, AWS_INSTANCE_IPV6
, or both.
SRV
record, the value that you want Route 53 to return for the port.
If the service includes HealthCheckConfig
, the port on the endpoint that you want Route 53 to send requests to.
This value is required if you specified settings for an SRV
record or a Route 53 health check when you created the service.
instanceAttributes
- A string map that contains the following information for the service that you specify in `ServiceId` :. This parameter is required.this
public CfnInstance.Builder serviceId(java.lang.String serviceId)
serviceId
- The ID of the service that you want to use for settings for the instance. This parameter is required.this
public CfnInstance.Builder instanceId(java.lang.String instanceId)
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 > Type .InstanceId
and ServiceId
, AWS Cloud Map updates the existing DNS records, if any. If there's also an existing health check, AWS Cloud Map deletes the old health check and creates a new one.
The health check isn't deleted immediately, so it will still appear for a while if you submit a
ListHealthChecks
request, for example.
Do not include sensitive information in
InstanceId
if the namespace is discoverable by public DNS queries and anyType
member ofDnsRecord
for the service containsSRV
because theInstanceId
is discoverable by public DNS queries.
instanceId
- An identifier that you want to associate with the instance. Note the following:. This parameter is required.this
public CfnInstance build()