awsiot1click

Documentation

Index

• func CfnDevice_CFN_RESOURCE_TYPE_NAME() *string
• func CfnDevice_IsCfnElement(x interface{}) *bool
• func CfnDevice_IsCfnResource(construct constructs.IConstruct) *bool
• func CfnDevice_IsConstruct(x interface{}) *bool
• func CfnPlacement_CFN_RESOURCE_TYPE_NAME() *string
• func CfnPlacement_IsCfnElement(x interface{}) *bool
• func CfnPlacement_IsCfnResource(construct constructs.IConstruct) *bool
• func CfnPlacement_IsConstruct(x interface{}) *bool
• func CfnProject_CFN_RESOURCE_TYPE_NAME() *string
• func CfnProject_IsCfnElement(x interface{}) *bool
• func CfnProject_IsCfnResource(construct constructs.IConstruct) *bool
• func CfnProject_IsConstruct(x interface{}) *bool
• func NewCfnDevice_Override(c CfnDevice, scope constructs.Construct, id *string, props *CfnDeviceProps)
• func NewCfnPlacement_Override(c CfnPlacement, scope constructs.Construct, id *string, ...)
• func NewCfnProject_Override(c CfnProject, scope constructs.Construct, id *string, props *CfnProjectProps)
• type CfnDevice
  • func NewCfnDevice(scope constructs.Construct, id *string, props *CfnDeviceProps) CfnDevice
• type CfnDeviceProps
• type CfnPlacement
  • func NewCfnPlacement(scope constructs.Construct, id *string, props *CfnPlacementProps) CfnPlacement
• type CfnPlacementProps
• type CfnProject
  • func NewCfnProject(scope constructs.Construct, id *string, props *CfnProjectProps) CfnProject
• type CfnProjectProps
• type CfnProject_DeviceTemplateProperty
• type CfnProject_PlacementTemplateProperty

Functions

func CfnDevice_CFN_RESOURCE_TYPE_NAME

func CfnDevice_CFN_RESOURCE_TYPE_NAME() *string

func CfnDevice_IsCfnElement

func CfnDevice_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnDevice_IsCfnResource

func CfnDevice_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnDevice_IsConstruct

func CfnDevice_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnPlacement_CFN_RESOURCE_TYPE_NAME

func CfnPlacement_CFN_RESOURCE_TYPE_NAME() *string

func CfnPlacement_IsCfnElement

func CfnPlacement_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnPlacement_IsCfnResource

func CfnPlacement_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnPlacement_IsConstruct

func CfnPlacement_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnProject_CFN_RESOURCE_TYPE_NAME

func CfnProject_CFN_RESOURCE_TYPE_NAME() *string

func CfnProject_IsCfnElement

func CfnProject_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnProject_IsCfnResource

func CfnProject_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnProject_IsConstruct

func CfnProject_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func NewCfnDevice_Override

func NewCfnDevice_Override(c CfnDevice, scope constructs.Construct, id *string, props *CfnDeviceProps)

Create a new `AWS::IoT1Click::Device`.

func NewCfnPlacement_Override

func NewCfnPlacement_Override(c CfnPlacement, scope constructs.Construct, id *string, props *CfnPlacementProps)

Create a new `AWS::IoT1Click::Placement`.

func NewCfnProject_Override

func NewCfnProject_Override(c CfnProject, scope constructs.Construct, id *string, props *CfnProjectProps)

Create a new `AWS::IoT1Click::Project`.

Types

type CfnDevice

type CfnDevice interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrArn() *string
	AttrDeviceId() *string
	AttrEnabled() awscdk.IResolvable
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	DeviceId() *string
	SetDeviceId(val *string)
	Enabled() interface{}
	SetEnabled(val interface{})
	LogicalId() *string
	Node() constructs.Node
	Ref() *string
	Stack() awscdk.Stack
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::IoT1Click::Device`.

The `AWS::IoT1Click::Device` resource controls the enabled state of an AWS IoT 1-Click compatible device. For more information, see [Device](https://docs.aws.amazon.com/iot-1-click/1.0/devices-apireference/devices-deviceid.html) in the *AWS IoT 1-Click Devices API Reference* .

TODO: EXAMPLE

func NewCfnDevice

func NewCfnDevice(scope constructs.Construct, id *string, props *CfnDeviceProps) CfnDevice

Create a new `AWS::IoT1Click::Device`.

type CfnDeviceProps

type CfnDeviceProps struct {
	// The ID of the device, such as `G030PX0312744DWM` .
	DeviceId *string `json:"deviceId" yaml:"deviceId"`
	// A Boolean value indicating whether the device is enabled ( `true` ) or not ( `false` ).
	Enabled interface{} `json:"enabled" yaml:"enabled"`
}

Properties for defining a `CfnDevice`.

TODO: EXAMPLE

type CfnPlacement

type CfnPlacement interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AssociatedDevices() interface{}
	SetAssociatedDevices(val interface{})
	Attributes() interface{}
	SetAttributes(val interface{})
	AttrPlacementName() *string
	AttrProjectName() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	LogicalId() *string
	Node() constructs.Node
	PlacementName() *string
	SetPlacementName(val *string)
	ProjectName() *string
	SetProjectName(val *string)
	Ref() *string
	Stack() awscdk.Stack
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::IoT1Click::Placement`.

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](https://docs.aws.amazon.com/iot-1-click/latest/developerguide/1click-PTP.html) in the *AWS IoT 1-Click Developer Guide* .

TODO: EXAMPLE

func NewCfnPlacement

func NewCfnPlacement(scope constructs.Construct, id *string, props *CfnPlacementProps) CfnPlacement

Create a new `AWS::IoT1Click::Placement`.

type CfnPlacementProps

type CfnPlacementProps struct {
	// The name of the project containing the placement.
	ProjectName *string `json:"projectName" yaml:"projectName"`
	// 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.
	AssociatedDevices interface{} `json:"associatedDevices" yaml:"associatedDevices"`
	// The user-defined attributes associated with the placement.
	Attributes interface{} `json:"attributes" yaml:"attributes"`
	// The name of the placement.
	PlacementName *string `json:"placementName" yaml:"placementName"`
}

Properties for defining a `CfnPlacement`.

TODO: EXAMPLE

type CfnProject

type CfnProject interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrArn() *string
	AttrProjectName() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	Description() *string
	SetDescription(val *string)
	LogicalId() *string
	Node() constructs.Node
	PlacementTemplate() interface{}
	SetPlacementTemplate(val interface{})
	ProjectName() *string
	SetProjectName(val *string)
	Ref() *string
	Stack() awscdk.Stack
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `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](https://docs.aws.amazon.com/iot-1-click/latest/projects-apireference/API_CreateProject.html) in the *AWS IoT 1-Click Projects API Reference* .

TODO: EXAMPLE

func NewCfnProject

func NewCfnProject(scope constructs.Construct, id *string, props *CfnProjectProps) CfnProject

Create a new `AWS::IoT1Click::Project`.

type CfnProjectProps

type CfnProjectProps struct {
	// An object describing the project's placement specifications.
	PlacementTemplate interface{} `json:"placementTemplate" yaml:"placementTemplate"`
	// The description of the project.
	Description *string `json:"description" yaml:"description"`
	// The name of the project from which to obtain information.
	ProjectName *string `json:"projectName" yaml:"projectName"`
}

Properties for defining a `CfnProject`.

TODO: EXAMPLE

type CfnProject_DeviceTemplateProperty

type CfnProject_DeviceTemplateProperty struct {
	// An optional AWS Lambda function to invoke instead of the default AWS Lambda function provided by the placement template.
	CallbackOverrides interface{} `json:"callbackOverrides" yaml:"callbackOverrides"`
	// The device type, which currently must be `"button"` .
	DeviceType *string `json:"deviceType" yaml:"deviceType"`
}

In AWS CloudFormation , use the `DeviceTemplate` property type to define the template for an AWS IoT 1-Click project.

`DeviceTemplate` is a property of the `AWS::IoT1Click::Project` resource.

TODO: EXAMPLE

type CfnProject_PlacementTemplateProperty

type CfnProject_PlacementTemplateProperty struct {
	// The default attributes (key-value pairs) to be applied to all placements using this template.
	DefaultAttributes interface{} `json:"defaultAttributes" yaml:"defaultAttributes"`
	// An object specifying the [DeviceTemplate](https://docs.aws.amazon.com/iot-1-click/latest/projects-apireference/API_DeviceTemplate.html) for all placements using this ( [PlacementTemplate](https://docs.aws.amazon.com/iot-1-click/latest/projects-apireference/API_PlacementTemplate.html) ) template.
	DeviceTemplates interface{} `json:"deviceTemplates" yaml:"deviceTemplates"`
}

In AWS CloudFormation , use the `PlacementTemplate` property type to define the template for an AWS IoT 1-Click project.

`PlacementTemplate` is a property of the `AWS::IoT1Click::Project` resource.

TODO: EXAMPLE