software.amazon.awscdk.services.iotsitewise

Class CfnDashboard

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

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:40.045Z")
 @Stability(value=Stable)
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 class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnDashboard(software.constructs.Construct scope, 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
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.
String	getAttrDashboardId() The ID of the dashboard.
protected Map<String,Object>	getCfnProperties()
String	getDashboardDefinition() The dashboard definition specified in a JSON literal.
String	getDashboardDescription() A description for the dashboard.
String	getDashboardName() A friendly name for the dashboard.
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 Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDashboardDefinition(String value) The dashboard definition specified in a JSON literal.
void	setDashboardDescription(String value) A description for the dashboard.
void	setDashboardName(String value) A friendly name for the dashboard.
void	setProjectId(String value) The ID of the project in which to create the dashboard.

Methods inherited from class software.amazon.awscdk.CfnResource

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

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

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.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final 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

@Stability(value=Stable)
public CfnDashboard(@NotNull
                                             software.constructs.Construct scope,
                                             @NotNull
                                             String id,
                                             @NotNull
                                             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

@Stability(value=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(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrDashboardArn

@Stability(value=Stable)
 @NotNull
public 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

@Stability(value=Stable)
 @NotNull
public String getAttrDashboardId()

The ID of the dashboard.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
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

@Stability(value=Stable)
 @NotNull
public 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

@Stability(value=Stable)
public void setDashboardDefinition(@NotNull
                                                            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

@Stability(value=Stable)
 @NotNull
public String getDashboardDescription()

A description for the dashboard.

setDashboardDescription

@Stability(value=Stable)
public void setDashboardDescription(@NotNull
                                                             String value)

A description for the dashboard.

getDashboardName

@Stability(value=Stable)
 @NotNull
public String getDashboardName()

A friendly name for the dashboard.

setDashboardName

@Stability(value=Stable)
public void setDashboardName(@NotNull
                                                      String value)

A friendly name for the dashboard.

getProjectId

@Stability(value=Stable)
 @Nullable
public String getProjectId()

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

setProjectId

@Stability(value=Stable)
public void setProjectId(@Nullable
                                                  String value)

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