Class CfnPlacement
The AWS::IoT1Click::Placement
resource creates a placement to be associated with an AWS IoT 1-Click project.
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.IoT1Click
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnPlacement : CfnResource, IInspectable
Syntax (vb)
Public Class CfnPlacement
Inherits CfnResource
Implements IInspectable
Remarks
A placement is an instance of a device in a location. For more information, see Projects, Templates, and Placements in the AWS IoT 1-Click Developer Guide .
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot1click-placement.html
CloudformationResource: AWS::IoT1Click::Placement
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 associatedDevices;
var attributes;
var cfnPlacement = new CfnPlacement(this, "MyCfnPlacement", new CfnPlacementProps {
ProjectName = "projectName",
// the properties below are optional
AssociatedDevices = associatedDevices,
Attributes = attributes,
PlacementName = "placementName"
});
Synopsis
Constructors
CfnPlacement(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnPlacement(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnPlacement(Construct, String, ICfnPlacementProps) |
Properties
AssociatedDevices | The devices to associate with the placement, as defined by a mapping of zero or more key-value pairs wherein the key is a template name and the value is a device ID. |
Attributes | The user-defined attributes associated with the placement. |
AttrId | |
AttrPlacementName | The name of the placement, such as |
AttrProjectName | The name of the project containing the placement, such as |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
PlacementName | The name of the placement. |
ProjectName | The name of the project containing the placement. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnPlacement(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnPlacement(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnPlacement(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnPlacement(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnPlacement(Construct, String, ICfnPlacementProps)
public CfnPlacement(Construct scope, string id, ICfnPlacementProps 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 ICfnPlacementProps
Resource properties.
Properties
AssociatedDevices
The devices to associate with the placement, as defined by a mapping of zero or more key-value pairs wherein the key is a template name and the value is a device ID.
public virtual object AssociatedDevices { get; set; }
Property Value
System.Object
Attributes
The user-defined attributes associated with the placement.
public virtual object Attributes { get; set; }
Property Value
System.Object
AttrId
public virtual string AttrId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Id
AttrPlacementName
The name of the placement, such as floor17
.
public virtual string AttrPlacementName { get; }
Property Value
System.String
Remarks
CloudformationAttribute: PlacementName
AttrProjectName
The name of the project containing the placement, such as conference-rooms
.
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
PlacementName
The name of the placement.
public virtual string PlacementName { get; set; }
Property Value
System.String
ProjectName
The name of the project containing the placement.
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>