Package software.amazon.awscdk.services.iot1click

Interface CfnPlacementProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnPlacementProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-06T23:25:11.318Z")
@Stability(Stable)
public interface CfnPlacementProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnPlacement.

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;
 CfnPlacementProps cfnPlacementProps = CfnPlacementProps.builder()
         .projectName("projectName")
         // the properties below are optional
         .associatedDevices(associatedDevices)
         .attributes(attributes)
         .placementName("placementName")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot1click-placement.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnPlacementProps.Builder	A builder for CfnPlacementProps
static final class	CfnPlacementProps.Jsii$Proxy	An implementation for CfnPlacementProps

Method Summary

Modifier and Type	Method	Description
static CfnPlacementProps.Builder	builder()
default 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.
default Object	getAttributes()	The user-defined attributes associated with the placement.
default String	getPlacementName()	The name of the placement.
String	getProjectName()	The name of the project containing the placement.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getProjectName

@Stability(Stable)
@NotNull
String getProjectName()

The name of the project containing the placement.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot1click-placement.html#cfn-iot1click-placement-projectname

getAssociatedDevices

@Stability(Stable)
@Nullable
default 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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot1click-placement.html#cfn-iot1click-placement-associateddevices

getAttributes

@Stability(Stable)
@Nullable
default Object getAttributes()

The user-defined attributes associated with the placement.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot1click-placement.html#cfn-iot1click-placement-attributes

getPlacementName

@Stability(Stable)
@Nullable
default String getPlacementName()

The name of the placement.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot1click-placement.html#cfn-iot1click-placement-placementname

builder

@Stability(Stable)
static CfnPlacementProps.Builder builder()

Returns:

a CfnPlacementProps.Builder of CfnPlacementProps