AWS::IoT1Click::Project - Amazon CloudFormation
SyntaxPropertiesReturn valuesExamplesSee also
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

AWS::IoT1Click::Project

The AWS::IoT1Click::Project resource creates an empty project with a placement template. A project contains zero or more placements that adhere to the placement template defined in the project. For more information, see CreateProject in the Amazon IoT 1-Click Projects API Reference.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::IoT1Click::Project",
  "Properties" : {
      "Description" : String,
      "PlacementTemplate" : PlacementTemplate,
      "ProjectName" : String
    }
}

YAML

Type: AWS::IoT1Click::Project
Properties:
  Description: String
  PlacementTemplate: 
    PlacementTemplate
  ProjectName: String

Properties

Description

The description of the project.

Required: No

Type: String

Update requires: No interruption

PlacementTemplate

An object describing the project's placement specifications.

Required: Yes

Type: PlacementTemplate

Update requires: No interruption

ProjectName

The name of the project from which to obtain information.

Required: No

Type: String

Update requires: Replacement

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the project ARN, such as arn:aws:iot1click:us-west-2:0123456789012:projects/test-project.

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

Arn

The Amazon Resource Name (ARN) of the project, such as arn:aws:iot1click:us-east-1:123456789012:projects/project-a1bzhi.

ProjectName

The name of the project, such as project-a1bzhi.

Examples

Declare a 1-Click project

JSON


{
    "Description": "IoT1Click Project test",
    "Resources": {
        "BasicProject": {
            "Type": "AWS::IoT1Click::Project",
            "Properties": {
                "ProjectName": "project",
                "Description": "description",
                "PlacementTemplate": {
                    "DefaultAttributes": {
                        "Attribute": "Value",
                        "Foo": "Bar"
                    },
                    "DeviceTemplates": {
                        "testButton": {
                            "DeviceType": "button",
                            "CallbackOverrides": {
                                "onClickCallback": ""
                            }
                        }
                    }
                }
            }
        }
    },

    "Outputs": {
        "ProjectId": {
            "Value": {
                "Ref": "BasicProject"
            }
        }
    }
}

YAML


Description: "IoT1Click Project test"
Resources:
  BasicProject:
    Type: "AWS::IoT1Click::Project"
    Properties:
      ProjectName: "project"
      Description: "description"
      PlacementTemplate:
        DefaultAttributes:
          Attribute: Value
          Foo: Bar
        DeviceTemplates:
          testButton:
            DeviceType: "button"
            CallbackOverrides:
              onClickCallback: ""

Outputs:
  ProjectId:
    Value: !Ref BasicProject

See also