software.amazon.awscdk.services.servicediscovery

Class IpInstance

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.servicediscovery.InstanceBase

software.amazon.awscdk.services.servicediscovery.IpInstance

All Implemented Interfaces:

IConstruct, IDependable, IResource, IInstance

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:48.227Z")
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 and Description
static class	IpInstance.Builder A fluent builder for IpInstance.

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

IInstance.Jsii$Default

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
java.lang.String	getInstanceId() The Id of the instance.
java.lang.String	getIpv4() The Ipv4 address of the instance, or blank string if none available.
java.lang.String	getIpv6() The Ipv6 address of the instance, or blank string if none available.
java.lang.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.core.Resource

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

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awscdk.core.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.awscdk.core.IConstruct

getNode

Constructor Detail

IpInstance

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

IpInstance

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

IpInstance

public IpInstance(software.constructs.Construct scope,
                  java.lang.String id,
                  IpInstanceProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

getInstanceId

public java.lang.String getInstanceId()

The Id of the instance.

Specified by:

getInstanceId in interface IInstance

Specified by:

getInstanceId in class InstanceBase

getIpv4

public java.lang.String getIpv4()

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

getIpv6

public java.lang.String getIpv6()

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

getPort

public java.lang.Number getPort()

The exposed port of the instance.

getService

public IService getService()

The Cloudmap service to which the instance is registered.

Specified by:

getService in interface IInstance

Specified by:

getService in class InstanceBase