CfnInstance

class aws_cdk.aws_servicediscovery.CfnInstance(scope, id, *, instance_attributes, service_id, instance_id=None)

Bases: CfnResource

A CloudFormation AWS::ServiceDiscovery::Instance.

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

CloudformationResource:: AWS::ServiceDiscovery::Instance
Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicediscovery-instance.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_servicediscovery as servicediscovery

# instance_attributes: Any

cfn_instance = servicediscovery.CfnInstance(self, "MyCfnInstance",
    instance_attributes=instance_attributes,
    service_id="serviceId",

    # the properties below are optional
    instance_id="instanceId"
)

Create a new AWS::ServiceDiscovery::Instance.

Parameters:

scope (Construct) –
- scope in which this resource is defined.
id (str) –
- scoped id of the resource.
instance_attributes (Any) –
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. Supported attribute keys include the following: - AWS_ALIAS_DNS_NAME - If you want AWS Cloud Map to create a Route 53 alias record that routes traffic to an Elastic Load Balancing load balancer, specify the DNS name that is associated with the load balancer. For information about how to get the DNS name, see AliasTarget->DNSName in the Route 53 API Reference . Note the following: - The configuration for the service that is specified by ServiceId must include settings for an A record, an AAAA record, or both. - In the service that is specified by ServiceId , the value of RoutingPolicy must be WEIGHTED . - If the service that is specified by ServiceId includes HealthCheckConfig settings, AWS Cloud Map will create 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 AWS 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. 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. - AWS_INIT_HEALTH_STATUS - If the service configuration includes 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. - AWS_INSTANCE_CNAME - If the service configuration includes a 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. - AWS_INSTANCE_IPV4 - If the service configuration includes an 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. - AWS_INSTANCE_IPV6 - If the service configuration includes an 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. - AWS_INSTANCE_PORT - If the service includes an 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.
service_id (str) – The ID of the service that you want to use for settings for the instance.
instance_id (Optional[str]) – 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 > 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 , 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. .. epigraph:: The health check isn’t deleted immediately, so it will still appear for a while if you submit a ListHealthChecks request, for example. .. epigraph:: Do not include sensitive information in InstanceId if the namespace is discoverable by public DNS queries and any Type member of DnsRecord for the service contains SRV because the InstanceId is discoverable by public DNS queries.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:: path (str) – The path of the value to delete.
Return type:: None

add_depends_on(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:: target (CfnResource)
Return type:: None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

key (str)
value (Any)

See:

Return type:

None

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

path (str) –
- The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
value (Any) –
- The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters:: property_path (str) – The path to the property.
Return type:: None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

property_path (str) – The path of the property.
value (Any) – The value.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters:

policy (Optional[RemovalPolicy])
apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true
default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.

Return type:

None

get_att(attribute_name)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:: attribute_name (str) – The name of the attribute.
Return type:: Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:: key (str)
See:
Return type:: Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:

inspector (TreeInspector) –

tree inspector to collect and process attributes.

Return type:

None

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters:: new_logical_id (str) – The new logical ID to use for this stack element.
Return type:: None

to_string()

Returns a string representation of this construct.

Return type:: str
Returns:: a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::ServiceDiscovery::Instance'

cfn_options: Options for this resource, such as condition, update policy etc.

cfn_resource_type: AWS resource type.

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

instance_attributes

.

The attributes that apply to the records that are defined in the service.
For each attribute, the applicable value.

Supported attribute keys include the following:

AWS_ALIAS_DNS_NAME - If you want AWS Cloud Map to create a Route 53 alias record that routes traffic to an Elastic Load Balancing load balancer, specify the DNS name that is associated with the load balancer. For information about how to get the DNS name, see AliasTarget->DNSName in the Route 53 API Reference .

Note the following:

The configuration for the service that is specified by ServiceId must include settings for an A record, an AAAA record, or both.
In the service that is specified by ServiceId , the value of RoutingPolicy must be WEIGHTED .
If the service that is specified by ServiceId includes HealthCheckConfig settings, AWS Cloud Map will create 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 AWS 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. 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.
AWS_INIT_HEALTH_STATUS - If the service configuration includes 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.
AWS_INSTANCE_CNAME - If the service configuration includes a 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.

AWS_INSTANCE_IPV4 - If the service configuration includes an 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.

AWS_INSTANCE_IPV6 - If the service configuration includes an 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.

AWS_INSTANCE_PORT - If the service includes an 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.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicediscovery-instance.html#cfn-servicediscovery-instance-instanceattributes
Type:: A string map that contains the following information for the service that you specify in ServiceId

instance_id

.

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 > 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 , 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 any Type member of DnsRecord for the service contains SRV because the InstanceId is discoverable by public DNS queries.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicediscovery-instance.html#cfn-servicediscovery-instance-instanceid
Type:: An identifier that you want to associate with the instance. Note the following

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

node: The construct tree node associated with this construct.

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

service_id

The ID of the service that you want to use for settings for the instance.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicediscovery-instance.html#cfn-servicediscovery-instance-serviceid

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:: x (Any)
Return type:: bool
Returns:: The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(construct)

Check whether the given construct is a CfnResource.

Parameters:: construct (IConstruct)
Return type:: bool

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters:: x (Any)
Return type:: bool