Package software.amazon.awscdk.services.iotsitewise

Class CfnApplication

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.iotsitewise.CfnApplication
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IApplicationRef, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.140.0 (build 79fd58c)", date="2026-09-30T11:04:54.033Z") @Stability(Stable) public class CfnApplication extends CfnResource implements IInspectable, IApplicationRef, ITaggableV2
Represents an AWS IoT SiteWise application that provides IAM Identity Center based access to a workspace.

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.iotsitewise.*;
 CfnApplication cfnApplication = CfnApplication.Builder.create(this, "MyCfnApplication")
         .name("name")
         .workspaceName("workspaceName")
         // the properties below are optional
         .description("description")
         .idcInstanceArn("idcInstanceArn")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .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

    • CfnApplication

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

    • CfnApplication

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

    • CfnApplication

      @Stability(Stable) public CfnApplication(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnApplicationProps props)
      Create a new AWS::IoTSiteWise::Application.

      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

    • arnForApplication

      @Stability(Stable) @NotNull public static String arnForApplication(@NotNull IApplicationRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnApplication

      @Stability(Stable) @NotNull public static Boolean isCfnApplication(@NotNull Object x)
      Checks whether the given object is a CfnApplication.

      Parameters:
      x - This parameter is required.

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

    • getApplicationRef

      @Stability(Stable) @NotNull public ApplicationReference getApplicationRef()
      A reference to a Application resource.
      Specified by:
      getApplicationRef in interface IApplicationRef

    • getAttrApplicationId

      @Stability(Stable) @NotNull public String getAttrApplicationId()
      The unique identifier of the application.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The ARN of the application.

    • getAttrCreatedAt

      @Stability(Stable) @NotNull public String getAttrCreatedAt()
      The time the application was created.

    • getAttrDnsSubdomain

      @Stability(Stable) @NotNull public String getAttrDnsSubdomain()
      The DNS-compliant subdomain label assigned to the application.

    • getAttrIdcApplicationArn

      @Stability(Stable) @NotNull public String getAttrIdcApplicationArn()
      The ARN of the IAM Identity Center application created for the application.

    • getAttrStatus

      @Stability(Stable) @NotNull public String getAttrStatus()
      The current status of the application.

    • getAttrUpdatedAt

      @Stability(Stable) @NotNull public String getAttrUpdatedAt()
      The time the application was last updated.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

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

    • getCfnPropertyNames

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

    • getName

      @Stability(Stable) @NotNull public String getName()
      The name of the application.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The name of the application.

    • getWorkspaceName

      @Stability(Stable) @NotNull public String getWorkspaceName()
      The name of the workspace that the application belongs to.

    • setWorkspaceName

      @Stability(Stable) public void setWorkspaceName(@NotNull String value)
      The name of the workspace that the application belongs to.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      A description of the application.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      A description of the application.

    • getIdcInstanceArn

      @Stability(Stable) @Nullable public String getIdcInstanceArn()
      The ARN of the IAM Identity Center instance used to create the application.

    • setIdcInstanceArn

      @Stability(Stable) public void setIdcInstanceArn(@Nullable String value)
      The ARN of the IAM Identity Center instance used to create the application.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      An array of key-value pairs to apply to this resource.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      An array of key-value pairs to apply to this resource.