@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-14T16:25:22.674Z") public class CfnDashboard extends CfnResource implements IInspectable
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();
Modifier and Type | Class and Description |
---|---|
static class |
CfnDashboard.Builder
A fluent builder for
CfnDashboard . |
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
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) |
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.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnDashboard(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnDashboard(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnDashboard(Construct scope, java.lang.String id, CfnDashboardProps props)
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.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.public java.lang.String getAttrDashboardArn()
arn:${Partition}:iotsitewise:${Region}:${Account}:dashboard/${DashboardId}
public java.lang.String getAttrDashboardId()
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public TagManager getTags()
For more information, see Tagging your AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide .
public java.lang.String getDashboardDefinition()
For detailed information, see Creating dashboards (CLI) in the AWS IoT SiteWise User Guide .
public void setDashboardDefinition(java.lang.String value)
For detailed information, see Creating dashboards (CLI) in the AWS IoT SiteWise User Guide .
public java.lang.String getDashboardDescription()
public void setDashboardDescription(java.lang.String value)
public java.lang.String getDashboardName()
public void setDashboardName(java.lang.String value)
public java.lang.String getProjectId()
public void setProjectId(java.lang.String value)