NonIpInstance¶

class aws_cdk.aws_servicediscovery.NonIpInstance(scope, id, *, service, custom_attributes=None, instance_id=None)¶

Bases: aws_cdk.aws_servicediscovery.InstanceBase

Instance accessible using values other than an IP address or a domain name (CNAME).

Specify the other values in Custom attributes.

Resource: AWS::ServiceDiscovery::Instance

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

# service is of type Service

non_ip_instance = servicediscovery.NonIpInstance(self, "MyNonIpInstance",
    service=service,

    # the properties below are optional
    custom_attributes={
        "custom_attributes_key": "customAttributes"
    },
    instance_id="instanceId"
)

Parameters

scope (Construct) –
id (str) –
service (IService) – The Cloudmap service this resource is registered to.
custom_attributes (Optional[Mapping[str, str]]) – Custom attributes of the instance. Default: none
instance_id (Optional[str]) – The id of the instance resource. Default: Automatically generated name

Methods

apply_removal_policy(policy)¶

Apply the given removal policy to this resource.

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 (RemovalPolicy) –

Return type

None

to_string()¶

Returns a string representation of this construct.

Return type: str

Attributes

env¶

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

Return type: ResourceEnvironment

instance_id¶

The Id of the instance.

Return type: str

node¶

The construct tree node associated with this construct.

Return type: ConstructNode

service¶

The Cloudmap service to which the instance is registered.

Return type: IService

stack¶

The stack in which this resource is defined.

Return type: Stack

Static Methods

classmethod is_construct(x)¶

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool

classmethod is_resource(construct)¶

Check whether the given construct is a Resource.

Parameters

construct (IConstruct) –

Return type

bool