@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-22T19:35:48.174Z") public class CfnInstance extends CfnResource implements IInspectable
A complex type that contains information about an instance that AWS Cloud Map creates when you submit a RegisterInstance
request.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.servicediscovery.*; Object instanceAttributes; CfnInstance cfnInstance = CfnInstance.Builder.create(this, "MyCfnInstance") .instanceAttributes(instanceAttributes) .serviceId("serviceId") // the properties below are optional .instanceId("instanceId") .build();
Modifier and Type | Class and Description |
---|---|
static class |
CfnInstance.Builder
A fluent builder for
CfnInstance . |
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
Modifier | Constructor and Description |
---|---|
|
CfnInstance(Construct scope,
java.lang.String id,
CfnInstanceProps props)
Create a new `AWS::ServiceDiscovery::Instance`.
|
protected |
CfnInstance(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
CfnInstance(software.amazon.jsii.JsiiObjectRef objRef) |
Modifier and Type | Method and Description |
---|---|
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.lang.Object |
getInstanceAttributes()
A string map that contains the following information for the service that you specify in `ServiceId` :.
|
java.lang.String |
getInstanceId()
An identifier that you want to associate with the instance.
|
java.lang.String |
getServiceId()
The ID of the service that you want to use for settings for the instance.
|
void |
inspect(TreeInspector inspector)
Examines the CloudFormation resource and discloses attributes.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
renderProperties(java.util.Map<java.lang.String,java.lang.Object> props) |
void |
setInstanceAttributes(java.lang.Object value)
A string map that contains the following information for the service that you specify in `ServiceId` :.
|
void |
setInstanceId(java.lang.String value)
An identifier that you want to associate with the instance.
|
void |
setServiceId(java.lang.String value)
The ID of the service that you want to use for settings for the instance.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnInstance(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnInstance(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnInstance(Construct scope, java.lang.String id, CfnInstanceProps props)
scope
- - scope in which this resource is defined. This parameter is required.id
- - scoped id of the resource. This parameter is required.props
- - resource properties. This parameter is required.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public java.lang.Object getInstanceAttributes()
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.
public void setInstanceAttributes(java.lang.Object value)
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.
public java.lang.String getServiceId()
public void setServiceId(java.lang.String value)
public java.lang.String getInstanceId()
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.
public void setInstanceId(java.lang.String value)
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.