Class CfnInput

The AWS::IoTEvents::Input resource creates an input.

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnInput

Implements

IInspectable

IInputRef

IConstruct

IDependable

IEnvironmentAware

ITaggable

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.Env

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.IoTEvents

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnInput : CfnResource, IInspectable, IInputRef, IConstruct, IDependable, IEnvironmentAware, ITaggable

Syntax (vb)

Public Class CfnInput Inherits CfnResource Implements IInspectable, IInputRef, IConstruct, IDependable, IEnvironmentAware, ITaggable

Remarks

To monitor your devices and processes, they must have a way to get telemetry data into AWS IoT Events . This is done by sending messages as inputs to AWS IoT Events . For more information, see How to Use AWS IoT Events in the AWS IoT Events Developer Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-input.html

CloudformationResource: AWS::IoTEvents::Input

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.IoTEvents;

             var cfnInput = new CfnInput(this, "MyCfnInput", new CfnInputProps {
                 InputDefinition = new InputDefinitionProperty {
                     Attributes = new [] { new AttributeProperty {
                         JsonPath = "jsonPath"
                     } }
                 },

                 // the properties below are optional
                 InputDescription = "inputDescription",
                 InputName = "inputName",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             });

Synopsis

Constructors

CfnInput(Construct, string, ICfnInputProps)

Create a new AWS::IoTEvents::Input.

Properties

CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CfnProperties	The AWS::IoTEvents::Input resource creates an input.
InputDefinition	The definition of the input.
InputDescription	A brief description of the input.
InputName	The name of the input.
InputRef	A reference to a Input resource.
Tags	Tag Manager which manages the tags for this resource.
TagsRaw	An array of key-value pairs to apply to this resource.

Methods

ArnForInput(IInputRef)	The AWS::IoTEvents::Input resource creates an input.
FromInputName(Construct, string, string)	Creates a new IInputRef from a inputName.
Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
IsCfnInput(object)	Checks whether the given object is a CfnInput.
RenderProperties(IDictionary<string, object>)	The AWS::IoTEvents::Input resource creates an input.

Constructors

CfnInput(Construct, string, ICfnInputProps)

Create a new AWS::IoTEvents::Input.

public CfnInput(Construct scope, string id, ICfnInputProps props)

Parameters

scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnInputProps

Resource properties.

Remarks

To monitor your devices and processes, they must have a way to get telemetry data into AWS IoT Events . This is done by sending messages as inputs to AWS IoT Events . For more information, see How to Use AWS IoT Events in the AWS IoT Events Developer Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-input.html

CloudformationResource: AWS::IoTEvents::Input

ExampleMetadata: fixture=_generated

Properties

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

Remarks

To monitor your devices and processes, they must have a way to get telemetry data into AWS IoT Events . This is done by sending messages as inputs to AWS IoT Events . For more information, see How to Use AWS IoT Events in the AWS IoT Events Developer Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-input.html

CloudformationResource: AWS::IoTEvents::Input

ExampleMetadata: fixture=_generated

CfnProperties

The AWS::IoTEvents::Input resource creates an input.

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

Remarks

To monitor your devices and processes, they must have a way to get telemetry data into AWS IoT Events . This is done by sending messages as inputs to AWS IoT Events . For more information, see How to Use AWS IoT Events in the AWS IoT Events Developer Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-input.html

CloudformationResource: AWS::IoTEvents::Input

ExampleMetadata: fixture=_generated

InputDefinition

The definition of the input.

public virtual object InputDefinition { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnInput.IInputDefinitionProperty

InputDescription

A brief description of the input.

public virtual string? InputDescription { get; set; }

Property Value

string

Remarks

To monitor your devices and processes, they must have a way to get telemetry data into AWS IoT Events . This is done by sending messages as inputs to AWS IoT Events . For more information, see How to Use AWS IoT Events in the AWS IoT Events Developer Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-input.html

CloudformationResource: AWS::IoTEvents::Input

ExampleMetadata: fixture=_generated

InputName

The name of the input.

public virtual string? InputName { get; set; }

Property Value

string

Remarks

To monitor your devices and processes, they must have a way to get telemetry data into AWS IoT Events . This is done by sending messages as inputs to AWS IoT Events . For more information, see How to Use AWS IoT Events in the AWS IoT Events Developer Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-input.html

CloudformationResource: AWS::IoTEvents::Input

ExampleMetadata: fixture=_generated

InputRef

A reference to a Input resource.

public virtual IInputReference InputRef { get; }

Property Value

IInputReference

Remarks

To monitor your devices and processes, they must have a way to get telemetry data into AWS IoT Events . This is done by sending messages as inputs to AWS IoT Events . For more information, see How to Use AWS IoT Events in the AWS IoT Events Developer Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-input.html

CloudformationResource: AWS::IoTEvents::Input

ExampleMetadata: fixture=_generated

Tags

Tag Manager which manages the tags for this resource.

public virtual TagManager Tags { get; }

Property Value

TagManager

Remarks

To monitor your devices and processes, they must have a way to get telemetry data into AWS IoT Events . This is done by sending messages as inputs to AWS IoT Events . For more information, see How to Use AWS IoT Events in the AWS IoT Events Developer Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-input.html

CloudformationResource: AWS::IoTEvents::Input

ExampleMetadata: fixture=_generated

TagsRaw

An array of key-value pairs to apply to this resource.

public virtual ICfnTag[]? TagsRaw { get; set; }

Property Value

ICfnTag[]

Remarks

To monitor your devices and processes, they must have a way to get telemetry data into AWS IoT Events . This is done by sending messages as inputs to AWS IoT Events . For more information, see How to Use AWS IoT Events in the AWS IoT Events Developer Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-input.html

CloudformationResource: AWS::IoTEvents::Input

ExampleMetadata: fixture=_generated

Methods

ArnForInput(IInputRef)

The AWS::IoTEvents::Input resource creates an input.

public static string ArnForInput(IInputRef resource)

Parameters

resource IInputRef

Returns

string

Remarks

To monitor your devices and processes, they must have a way to get telemetry data into AWS IoT Events . This is done by sending messages as inputs to AWS IoT Events . For more information, see How to Use AWS IoT Events in the AWS IoT Events Developer Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-input.html

CloudformationResource: AWS::IoTEvents::Input

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.IoTEvents;

             var cfnInput = new CfnInput(this, "MyCfnInput", new CfnInputProps {
                 InputDefinition = new InputDefinitionProperty {
                     Attributes = new [] { new AttributeProperty {
                         JsonPath = "jsonPath"
                     } }
                 },

                 // the properties below are optional
                 InputDescription = "inputDescription",
                 InputName = "inputName",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             });

FromInputName(Construct, string, string)

Creates a new IInputRef from a inputName.

public static IInputRef FromInputName(Construct scope, string id, string inputName)

Parameters

scope Construct

id string

inputName string

Returns

IInputRef

Remarks

To monitor your devices and processes, they must have a way to get telemetry data into AWS IoT Events . This is done by sending messages as inputs to AWS IoT Events . For more information, see How to Use AWS IoT Events in the AWS IoT Events Developer Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-input.html

CloudformationResource: AWS::IoTEvents::Input

ExampleMetadata: fixture=_generated

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.

Remarks

To monitor your devices and processes, they must have a way to get telemetry data into AWS IoT Events . This is done by sending messages as inputs to AWS IoT Events . For more information, see How to Use AWS IoT Events in the AWS IoT Events Developer Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-input.html

CloudformationResource: AWS::IoTEvents::Input

ExampleMetadata: fixture=_generated

IsCfnInput(object)

Checks whether the given object is a CfnInput.

public static bool IsCfnInput(object x)

Parameters

x object

Returns

bool

Remarks

To monitor your devices and processes, they must have a way to get telemetry data into AWS IoT Events . This is done by sending messages as inputs to AWS IoT Events . For more information, see How to Use AWS IoT Events in the AWS IoT Events Developer Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-input.html

CloudformationResource: AWS::IoTEvents::Input

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

The AWS::IoTEvents::Input resource creates an input.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

Remarks

To monitor your devices and processes, they must have a way to get telemetry data into AWS IoT Events . This is done by sending messages as inputs to AWS IoT Events . For more information, see How to Use AWS IoT Events in the AWS IoT Events Developer Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-input.html

CloudformationResource: AWS::IoTEvents::Input

ExampleMetadata: fixture=_generated

Implements

IInspectable

IInputRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware

ITaggable