Package software.amazon.awscdk.services.servicediscovery

Class CfnInstance

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.servicediscovery.CfnInstance
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IInstanceRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)", date="2025-11-20T23:37:30.331Z") @Stability(Stable) public class CfnInstance extends CfnResource implements IInspectable, IInstanceRef
A complex type that contains information about an instance that AWS Cloud Map creates when you submit a RegisterInstance request.

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.*;
 Object instanceAttributes;
 CfnInstance cfnInstance = CfnInstance.Builder.create(this, "MyCfnInstance")
         .instanceAttributes(instanceAttributes)
         .serviceId("serviceId")
         // the properties below are optional
         .instanceId("instanceId")
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnInstance

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

    • CfnInstance

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

    • CfnInstance

      @Stability(Stable) public CfnInstance(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnInstanceProps props)
      Create a new AWS::ServiceDiscovery::Instance.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getInstanceRef

      @Stability(Stable) @NotNull public InstanceReference getInstanceRef()
      A reference to a Instance resource.
      Specified by:
      getInstanceRef in interface IInstanceRef

    • getInstanceAttributes

      @Stability(Stable) @NotNull public Object getInstanceAttributes()
      A string map that contains the following information for the service that you specify in ServiceId :.

    • setInstanceAttributes

      @Stability(Stable) public void setInstanceAttributes(@NotNull Object value)
      A string map that contains the following information for the service that you specify in ServiceId :.

    • getServiceId

      @Stability(Stable) @NotNull public String getServiceId()
      The ID or Amazon Resource Name (ARN) of the service that you want to use for settings for the instance.

    • setServiceId

      @Stability(Stable) public void setServiceId(@NotNull String value)
      The ID or Amazon Resource Name (ARN) of the service that you want to use for settings for the instance.

    • getInstanceId

      @Stability(Stable) @Nullable public String getInstanceId()
      An identifier that you want to associate with the instance.

      Note the following:.

    • setInstanceId

      @Stability(Stable) public void setInstanceId(@Nullable String value)
      An identifier that you want to associate with the instance.

      Note the following:.