Class CfnDashboard
- All Implemented Interfaces:
IConstruct
,IDependable
,IInspectable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
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/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionCfnDashboard
(Construct scope, String id, CfnDashboardProps props) Create a newAWS::IoTSiteWise::Dashboard
.protected
CfnDashboard
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnDashboard
(software.amazon.jsii.JsiiObjectRef objRef) -
Method Summary
Modifier and TypeMethodDescriptionThe ARN of the dashboard, which has the following format.The ID of the dashboard.The dashboard definition specified in a JSON literal.A description for the dashboard.A friendly name for the dashboard.The ID of the project in which to create the dashboard.getTags()
A list of key-value pairs that contain metadata for the dashboard.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.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.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 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 Details
-
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
-
-
Constructor Details
-
CfnDashboard
protected CfnDashboard(software.amazon.jsii.JsiiObjectRef objRef) -
CfnDashboard
protected CfnDashboard(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnDashboard
@Stability(Stable) public CfnDashboard(@NotNull Construct scope, @NotNull String id, @NotNull CfnDashboardProps props) Create a newAWS::IoTSiteWise::Dashboard
.- Parameters:
scope
-- scope in which this resource is defined.
id
-- scoped id of the resource.
props
-- resource properties.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- Parameters:
inspector
-- tree inspector to collect and process attributes.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderProperties
in classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrDashboardArn
The ARN of the dashboard, which has the following format.arn:${Partition}:iotsitewise:${Region}:${Account}:dashboard/${DashboardId}
-
getAttrDashboardId
The ID of the dashboard. -
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
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
The dashboard definition specified in a JSON literal.For detailed information, see Creating dashboards (CLI) in the AWS IoT SiteWise User Guide .
-
setDashboardDefinition
The dashboard definition specified in a JSON literal.For detailed information, see Creating dashboards (CLI) in the AWS IoT SiteWise User Guide .
-
getDashboardDescription
A description for the dashboard. -
setDashboardDescription
A description for the dashboard. -
getDashboardName
A friendly name for the dashboard. -
setDashboardName
A friendly name for the dashboard. -
getProjectId
The ID of the project in which to create the dashboard. -
setProjectId
The ID of the project in which to create the dashboard.
-