IpInstance
- class aws_cdk.aws_servicediscovery.IpInstance(scope, id, *, service, ipv4=None, ipv6=None, port=None, custom_attributes=None, instance_id=None)
Bases:
InstanceBase
Instance that is accessible using an IP address.
- Resource:
AWS::ServiceDiscovery::Instance
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_servicediscovery as servicediscovery # service: servicediscovery.Service ip_instance = servicediscovery.IpInstance(self, "MyIpInstance", service=service, # the properties below are optional custom_attributes={ "custom_attributes_key": "customAttributes" }, instance_id="instanceId", ipv4="ipv4", ipv6="ipv6", port=123 )
- Parameters:
scope (
Construct
) –id (
str
) –service (
IService
) – The Cloudmap service this resource is registered to.ipv4 (
Optional
[str
]) – If the service that you specify contains a template for an A record, the IPv4 address that you want AWS Cloud Map to use for the value of the A record. Default: noneipv6 (
Optional
[str
]) – If the service that you specify contains a template for an AAAA record, the IPv6 address that you want AWS Cloud Map to use for the value of the AAAA record. Default: noneport (
Union
[int
,float
,None
]) – The port on the endpoint that you want AWS Cloud Map to perform health checks on. This value is also used for the port value in an SRV record if the service that you specify includes an SRV record. You can also specify a default port that is applied to all instances in the Service configuration. Default: 80custom_attributes (
Optional
[Mapping
[str
,str
]]) – Custom attributes of the instance. Default: noneinstance_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.
- instance_id
The Id of the instance.
- ipv4
The Ipv4 address of the instance, or blank string if none available.
- ipv6
The Ipv6 address of the instance, or blank string if none available.
- node
The tree node.
- port
The exposed port of the instance.
- service
The Cloudmap service to which the instance is registered.
- stack
The stack in which this resource is defined.
Static Methods
- classmethod is_construct(x)
Checks if
x
is a construct.Use this method instead of
instanceof
to properly detectConstruct
instances, even when the construct library is symlinked.Explanation: in JavaScript, multiple copies of the
constructs
library on disk are seen as independent, completely different libraries. As a consequence, the classConstruct
in each copy of theconstructs
library is seen as a different class, and an instance of one class will not test asinstanceof
the other class.npm install
will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of theconstructs
library can be accidentally installed, andinstanceof
will behave unpredictably. It is safest to avoid usinginstanceof
, and using this type-testing method instead.- Parameters:
x (
Any
) – Any object.- Return type:
bool
- Returns:
true if
x
is an object created from a class which extendsConstruct
.
- classmethod is_owned_resource(construct)
Returns true if the construct was created by CDK, and false otherwise.
- Parameters:
construct (
IConstruct
) –- Return type:
bool
- classmethod is_resource(construct)
Check whether the given construct is a Resource.
- Parameters:
construct (
IConstruct
) –- Return type:
bool