Package software.amazon.awscdk.services.servicediscovery

Class CnameInstance

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.servicediscovery.InstanceBase

software.amazon.awscdk.services.servicediscovery.CnameInstance

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:45.620Z")
@Stability(Stable)
public class CnameInstance
extends InstanceBase

Instance that is accessible using a domain name (CNAME).

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;
 CnameInstance cnameInstance = CnameInstance.Builder.create(this, "MyCnameInstance")
         .instanceCname("instanceCname")
         .service(service)
         // the properties below are optional
         .customAttributes(Map.of(
                 "customAttributesKey", "customAttributes"))
         .instanceId("instanceId")
         .build();
 

Nested Class Summary

Nested Classes

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

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

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

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.core.IResource

IResource.Jsii$Default

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
String	getCname()	The domain name returned by DNS queries for the instance.
String	getInstanceId()	The Id 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 software.constructs.Construct

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.amazon.awscdk.core.IConstruct

getNode

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

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

CnameInstance

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

CnameInstance

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

CnameInstance

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

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Details

getCname

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

The domain name returned by DNS queries for the instance.

getInstanceId

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

The Id of the instance.

Specified by:

getInstanceId in interface IInstance

Specified by:

getInstanceId in class InstanceBase

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