software.amazon.awscdk.services.iotsitewise

Class CfnDashboard

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.iotsitewise.CfnDashboard

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-14T16:25:22.674Z")
public class CfnDashboard
extends CfnResource
implements IInspectable

A CloudFormation `AWS::IoTSiteWise::Dashboard`.

Creates a dashboard in an AWS IoT SiteWise Monitor project.

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.*;
 CfnDashboard cfnDashboard = CfnDashboard.Builder.create(this, "MyCfnDashboard")
         .dashboardDefinition("dashboardDefinition")
         .dashboardDescription("dashboardDescription")
         .dashboardName("dashboardName")
         // the properties below are optional
         .projectId("projectId")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

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

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

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

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnDashboard(Construct scope, java.lang.String id, CfnDashboardProps props) Create a new `AWS::IoTSiteWise::Dashboard`.
protected	CfnDashboard(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnDashboard(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAttrDashboardArn() The [ARN](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of the dashboard, which has the following format.
java.lang.String	getAttrDashboardId() The ID of the dashboard.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getDashboardDefinition() The dashboard definition specified in a JSON literal.
java.lang.String	getDashboardDescription() A description for the dashboard.
java.lang.String	getDashboardName() A friendly name for the dashboard.
java.lang.String	getProjectId() The ID of the project in which to create the dashboard.
TagManager	getTags() A list of key-value pairs that contain metadata for the dashboard.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setDashboardDefinition(java.lang.String value) The dashboard definition specified in a JSON literal.
void	setDashboardDescription(java.lang.String value) A description for the dashboard.
void	setDashboardName(java.lang.String value) A friendly name for the dashboard.
void	setProjectId(java.lang.String value) The ID of the project in which to create the dashboard.

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

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

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

getRef

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

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

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, wait, wait, wait

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnDashboard

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

CfnDashboard

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

CfnDashboard

public CfnDashboard(Construct scope,
                    java.lang.String id,
                    CfnDashboardProps props)

Create a new `AWS::IoTSiteWise::Dashboard`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

public void inspect(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

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrDashboardArn

public java.lang.String getAttrDashboardArn()

The [ARN](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of the dashboard, which has the following format.

arn:${Partition}:iotsitewise:${Region}:${Account}:dashboard/${DashboardId}

getAttrDashboardId

public java.lang.String getAttrDashboardId()

The ID of the dashboard.

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

public TagManager getTags()

A list of key-value pairs that contain metadata for the dashboard.

For more information, see Tagging your AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide .

getDashboardDefinition

public java.lang.String getDashboardDefinition()

The dashboard definition specified in a JSON literal.

For detailed information, see Creating dashboards (CLI) in the AWS IoT SiteWise User Guide .

setDashboardDefinition

public void setDashboardDefinition(java.lang.String value)

The dashboard definition specified in a JSON literal.

For detailed information, see Creating dashboards (CLI) in the AWS IoT SiteWise User Guide .

getDashboardDescription

public java.lang.String getDashboardDescription()

A description for the dashboard.

setDashboardDescription

public void setDashboardDescription(java.lang.String value)

A description for the dashboard.

getDashboardName

public java.lang.String getDashboardName()

A friendly name for the dashboard.

setDashboardName

public void setDashboardName(java.lang.String value)

A friendly name for the dashboard.

getProjectId

public java.lang.String getProjectId()

The ID of the project in which to create the dashboard.

setProjectId

public void setProjectId(java.lang.String value)

The ID of the project in which to create the dashboard.