Package software.amazon.awscdk.services.servicediscovery

Class IpInstance

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.servicediscovery.InstanceBase

software.amazon.awscdk.services.servicediscovery.IpInstance

All Implemented Interfaces:

IEnvironmentAware, IResource, IInstance, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)",
           date="2025-11-04T09:27:50.542Z")
@Stability(Stable)
public class IpInstance
extends InstanceBase

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 software.amazon.awscdk.services.servicediscovery.*;
 Service service;
 IpInstance ipInstance = IpInstance.Builder.create(this, "MyIpInstance")
         .service(service)
         // the properties below are optional
         .customAttributes(Map.of(
                 "customAttributesKey", "customAttributes"))
         .instanceId("instanceId")
         .ipv4("ipv4")
         .ipv6("ipv6")
         .port(123)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	IpInstance.Builder	A fluent builder for IpInstance.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.servicediscovery.IInstance

IInstance.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource

IResource.Jsii$Default

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROPERTY_INJECTION_ID	Uniquely identifies this class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	IpInstance(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	IpInstance(software.amazon.jsii.JsiiObjectRef objRef)
	IpInstance(software.constructs.Construct scope, String id, IpInstanceProps props)

Method Summary

Modifier and Type	Method	Description
String	getInstanceId()	The Id of the instance.
String	getIpv4()	The Ipv4 address of the instance, or blank string if none available.
String	getIpv6()	The Ipv6 address of the instance, or blank string if none available.
Number	getPort()	The exposed port of the instance.
IService	getService()	The Cloudmap service to which the instance is registered.

Methods inherited from class software.amazon.awscdk.services.servicediscovery.InstanceBase

uniqueInstanceId

Methods inherited from class software.amazon.awscdk.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.IEnvironmentAware

getEnv

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getStack

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

PROPERTY_INJECTION_ID

@Stability(Stable)
public static final String PROPERTY_INJECTION_ID

Uniquely identifies this class.

Constructor Details

IpInstance

protected IpInstance(software.amazon.jsii.JsiiObjectRef objRef)

IpInstance

protected IpInstance(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

IpInstance

@Stability(Stable)
public IpInstance(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 IpInstanceProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Details

getInstanceId

@Stability(Stable)
@NotNull
public String getInstanceId()

The Id of the instance.

Specified by:

getInstanceId in interface IInstance

Specified by:

getInstanceId in class InstanceBase

getIpv4

@Stability(Stable)
@NotNull
public String getIpv4()

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

getIpv6

@Stability(Stable)
@NotNull
public String getIpv6()

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

getPort

@Stability(Stable)
@NotNull
public Number getPort()

The exposed port of the instance.

getService

@Stability(Stable)
@NotNull
public IService getService()

The Cloudmap service to which the instance is registered.

Specified by:

getService in interface IInstance

Specified by:

getService in class InstanceBase