@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-05-19T23:08:46.337Z") @Stability(value=Stable) public class CfnPlacement extends CfnResource implements IInspectable
The AWS::IoT1Click::Placement
resource creates a placement to be associated with an AWS IoT 1-Click project. 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 .
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.iot1click.*; Object associatedDevices; Object attributes; CfnPlacement cfnPlacement = CfnPlacement.Builder.create(this, "MyCfnPlacement") .projectName("projectName") // the properties below are optional .associatedDevices(associatedDevices) .attributes(attributes) .placementName("placementName") .build();
Modifier and Type | Class and Description |
---|---|
static class |
CfnPlacement.Builder
A fluent builder for
CfnPlacement . |
software.amazon.jsii.JsiiObject.InitializationMode
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
Modifier | Constructor and Description |
---|---|
|
CfnPlacement(Construct scope,
String id,
CfnPlacementProps props)
Create a new `AWS::IoT1Click::Placement`.
|
protected |
CfnPlacement(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
CfnPlacement(software.amazon.jsii.JsiiObjectRef objRef) |
Modifier and Type | Method and Description |
---|---|
Object |
getAssociatedDevices()
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.
|
Object |
getAttributes()
The user-defined attributes associated with the placement.
|
String |
getAttrPlacementName()
The name of the placement, such as `floor17` .
|
String |
getAttrProjectName()
The name of the project containing the placement, such as `conference-rooms` .
|
protected Map<String,Object> |
getCfnProperties() |
String |
getPlacementName()
The name of the placement.
|
String |
getProjectName()
The name of the project containing the placement.
|
void |
inspect(TreeInspector inspector)
Examines the CloudFormation resource and discloses attributes.
|
protected Map<String,Object> |
renderProperties(Map<String,Object> props) |
void |
setAssociatedDevices(Object value)
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.
|
void |
setAttributes(Object value)
The user-defined attributes associated with the placement.
|
void |
setPlacementName(String value)
The name of the placement.
|
void |
setProjectName(String value)
The name of the project containing the placement.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
@Stability(value=Stable) public static final String CFN_RESOURCE_TYPE_NAME
protected CfnPlacement(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnPlacement(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
@Stability(value=Stable) public CfnPlacement(@NotNull Construct scope, @NotNull String id, @NotNull CfnPlacementProps props)
scope
- - scope in which this resource is defined. This parameter is required.id
- - scoped id of the resource. This parameter is required.props
- - resource properties. This parameter is required.@Stability(value=Stable) public void inspect(@NotNull TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.@Stability(value=Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.@Stability(value=Stable) @NotNull public String getAttrPlacementName()
@Stability(value=Stable) @NotNull public String getAttrProjectName()
@Stability(value=Stable) @NotNull protected Map<String,Object> getCfnProperties()
getCfnProperties
in class CfnResource
@Stability(value=Stable) @NotNull public Object getAssociatedDevices()
@Stability(value=Stable) public void setAssociatedDevices(@NotNull Object value)
@Stability(value=Stable) @NotNull public Object getAttributes()
@Stability(value=Stable) public void setAttributes(@NotNull Object value)
@Stability(value=Stable) @NotNull public String getProjectName()
@Stability(value=Stable) public void setProjectName(@NotNull String value)
@Stability(value=Stable) @Nullable public String getPlacementName()
@Stability(value=Stable) public void setPlacementName(@Nullable String value)
Copyright © 2023. All rights reserved.