class IpInstance (construct)

Language	Type name
.NET	`Amazon.CDK.AWS.ServiceDiscovery.IpInstance`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsservicediscovery#IpInstance`
Java	`software.amazon.awscdk.services.servicediscovery.IpInstance`
Python	`aws_cdk.aws_servicediscovery.IpInstance`
TypeScript (source)	`aws-cdk-lib` » `aws_servicediscovery` » `IpInstance`

Implements IConstruct, IDependable, IResource, IInstance

Instance that is accessible using an IP address.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_servicediscovery as servicediscovery } from 'aws-cdk-lib';

declare const service: servicediscovery.Service;
const ipInstance = new servicediscovery.IpInstance(this, 'MyIpInstance', {
  service: service,

  // the properties below are optional
  customAttributes: {
    customAttributesKey: 'customAttributes',
  },
  instanceId: 'instanceId',
  ipv4: 'ipv4',
  ipv6: 'ipv6',
  port: 123,
});

Initializer

new IpInstance(scope: Construct, id: string, props: IpInstanceProps)

Parameters

scope Construct
id string
props IpInstanceProps

Construct Props

Name	Type	Description
service	`IService`	The Cloudmap service this resource is registered to.
customAttributes?	`{ [string]: string }`	Custom attributes of the instance.
instanceId?	`string`	The id of the instance resource.
ipv4?	`string`	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.
ipv6?	`string`	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.
port?	`number`	The port on the endpoint that you want AWS Cloud Map to perform health checks on.

service

Type: IService

The Cloudmap service this resource is registered to.

customAttributes?

Type: { [string]: string } (optional, default: none)

Custom attributes of the instance.

instanceId?

Type: string (optional, default: Automatically generated name)

The id of the instance resource.

ipv4?

Type: string (optional, default: none)

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.

ipv6?

Type: string (optional, default: none)

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.

port?

Type: number (optional, default: 80)

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.

Properties

Name	Type	Description
env	`ResourceEnvironment`	The environment this resource belongs to.
instanceId	`string`	The Id of the instance.
ipv4	`string`	The Ipv4 address of the instance, or blank string if none available.
ipv6	`string`	The Ipv6 address of the instance, or blank string if none available.
node	`Node`	The tree node.
port	`number`	The exposed port of the instance.
service	`IService`	The Cloudmap service to which the instance is registered.
stack	`Stack`	The stack in which this resource is defined.

env

Type: ResourceEnvironment

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.

instanceId

Type: string

The Id of the instance.

ipv4

Type: string

The Ipv4 address of the instance, or blank string if none available.

ipv6

Type: string

The Ipv6 address of the instance, or blank string if none available.

node

Type: Node

The tree node.

port

Type: number

The exposed port of the instance.

service

Type: IService

The Cloudmap service to which the instance is registered.

stack

Type: Stack

The stack in which this resource is defined.

Methods

Name	Description
applyRemovalPolicy(policy)	Apply the given removal policy to this resource.
toString()	Returns a string representation of this construct.

applyRemovalPolicy(policy)

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

policy RemovalPolicy

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).

toString()

public toString(): string

Returns

string

Returns a string representation of this construct.