Class CfnProject
The AWS::IoT1Click::Project
resource creates an empty project with a placement template.
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.IoT1Click
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnProject : CfnResource, IInspectable
Syntax (vb)
Public Class CfnProject
Inherits CfnResource
Implements IInspectable
Remarks
A project contains zero or more placements that adhere to the placement template defined in the project. For more information, see CreateProject in the AWS IoT 1-Click Projects API Reference .
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot1click-project.html
CloudformationResource: AWS::IoT1Click::Project
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.IoT1Click;
var callbackOverrides;
var defaultAttributes;
var cfnProject = new CfnProject(this, "MyCfnProject", new CfnProjectProps {
PlacementTemplate = new PlacementTemplateProperty {
DefaultAttributes = defaultAttributes,
DeviceTemplates = new Dictionary<string, object> {
{ "deviceTemplatesKey", new DeviceTemplateProperty {
CallbackOverrides = callbackOverrides,
DeviceType = "deviceType"
} }
}
},
// the properties below are optional
Description = "description",
ProjectName = "projectName"
});
Synopsis
Constructors
CfnProject(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnProject(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnProject(Construct, String, ICfnProjectProps) |
Properties
AttrArn | The Amazon Resource Name (ARN) of the project, such as |
AttrId | |
AttrProjectName | The name of the project, such as |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
Description | The description of the project. |
PlacementTemplate | An object describing the project's placement specifications. |
ProjectName | The name of the project from which to obtain information. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnProject(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnProject(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnProject(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnProject(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnProject(Construct, String, ICfnProjectProps)
public CfnProject(Construct scope, string id, ICfnProjectProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnProjectProps
Resource properties.
Properties
AttrArn
The Amazon Resource Name (ARN) of the project, such as arn:aws:iot1click:us-east-1:123456789012:projects/project-a1bzhi
.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Arn
AttrId
public virtual string AttrId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Id
AttrProjectName
The name of the project, such as project-a1bzhi
.
public virtual string AttrProjectName { get; }
Property Value
System.String
Remarks
CloudformationAttribute: ProjectName
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
Description
The description of the project.
public virtual string Description { get; set; }
Property Value
System.String
PlacementTemplate
An object describing the project's placement specifications.
public virtual object PlacementTemplate { get; set; }
Property Value
System.Object
ProjectName
The name of the project from which to obtain information.
public virtual string ProjectName { get; set; }
Property Value
System.String
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>