1. Packages
  2. AWS Native
  3. API Docs
  4. iotsitewise
  5. Dashboard

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.108.3 published on Wednesday, Jun 12, 2024 by Pulumi

aws-native.iotsitewise.Dashboard

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.108.3 published on Wednesday, Jun 12, 2024 by Pulumi

    Resource schema for AWS::IoTSiteWise::Dashboard

    Create Dashboard Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Dashboard(name: string, args: DashboardArgs, opts?: CustomResourceOptions);
    @overload
    def Dashboard(resource_name: str,
                  args: DashboardArgs,
                  opts: Optional[ResourceOptions] = None)
    
    @overload
    def Dashboard(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  dashboard_definition: Optional[str] = None,
                  dashboard_description: Optional[str] = None,
                  dashboard_name: Optional[str] = None,
                  project_id: Optional[str] = None,
                  tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
    func NewDashboard(ctx *Context, name string, args DashboardArgs, opts ...ResourceOption) (*Dashboard, error)
    public Dashboard(string name, DashboardArgs args, CustomResourceOptions? opts = null)
    public Dashboard(String name, DashboardArgs args)
    public Dashboard(String name, DashboardArgs args, CustomResourceOptions options)
    
    type: aws-native:iotsitewise:Dashboard
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args DashboardArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args DashboardArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args DashboardArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DashboardArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DashboardArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    const dashboardResource = new aws_native.iotsitewise.Dashboard("dashboardResource", {
        dashboardDefinition: "string",
        dashboardDescription: "string",
        dashboardName: "string",
        projectId: "string",
        tags: [{
            key: "string",
            value: "string",
        }],
    });
    
    Coming soon!
    

    Dashboard Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Dashboard resource accepts the following input properties:

    DashboardDefinition string
    The dashboard definition specified in a JSON literal.
    DashboardDescription string
    A description for the dashboard.
    DashboardName string
    A friendly name for the dashboard.
    ProjectId string
    The ID of the project in which to create the dashboard.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    A list of key-value pairs that contain metadata for the dashboard.
    DashboardDefinition string
    The dashboard definition specified in a JSON literal.
    DashboardDescription string
    A description for the dashboard.
    DashboardName string
    A friendly name for the dashboard.
    ProjectId string
    The ID of the project in which to create the dashboard.
    Tags TagArgs
    A list of key-value pairs that contain metadata for the dashboard.
    dashboardDefinition String
    The dashboard definition specified in a JSON literal.
    dashboardDescription String
    A description for the dashboard.
    dashboardName String
    A friendly name for the dashboard.
    projectId String
    The ID of the project in which to create the dashboard.
    tags List<Tag>
    A list of key-value pairs that contain metadata for the dashboard.
    dashboardDefinition string
    The dashboard definition specified in a JSON literal.
    dashboardDescription string
    A description for the dashboard.
    dashboardName string
    A friendly name for the dashboard.
    projectId string
    The ID of the project in which to create the dashboard.
    tags Tag[]
    A list of key-value pairs that contain metadata for the dashboard.
    dashboard_definition str
    The dashboard definition specified in a JSON literal.
    dashboard_description str
    A description for the dashboard.
    dashboard_name str
    A friendly name for the dashboard.
    project_id str
    The ID of the project in which to create the dashboard.
    tags Sequence[TagArgs]
    A list of key-value pairs that contain metadata for the dashboard.
    dashboardDefinition String
    The dashboard definition specified in a JSON literal.
    dashboardDescription String
    A description for the dashboard.
    dashboardName String
    A friendly name for the dashboard.
    projectId String
    The ID of the project in which to create the dashboard.
    tags List<Property Map>
    A list of key-value pairs that contain metadata for the dashboard.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Dashboard resource produces the following output properties:

    DashboardArn string
    The ARN of the dashboard.
    DashboardId string
    The ID of the dashboard.
    Id string
    The provider-assigned unique ID for this managed resource.
    DashboardArn string
    The ARN of the dashboard.
    DashboardId string
    The ID of the dashboard.
    Id string
    The provider-assigned unique ID for this managed resource.
    dashboardArn String
    The ARN of the dashboard.
    dashboardId String
    The ID of the dashboard.
    id String
    The provider-assigned unique ID for this managed resource.
    dashboardArn string
    The ARN of the dashboard.
    dashboardId string
    The ID of the dashboard.
    id string
    The provider-assigned unique ID for this managed resource.
    dashboard_arn str
    The ARN of the dashboard.
    dashboard_id str
    The ID of the dashboard.
    id str
    The provider-assigned unique ID for this managed resource.
    dashboardArn String
    The ARN of the dashboard.
    dashboardId String
    The ID of the dashboard.
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    Tag, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.108.3 published on Wednesday, Jun 12, 2024 by Pulumi