Class CfnInput

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

Inheritance

System.Object

CfnElement

CfnRefElement

CfnResource

CfnInput

Implements

IInspectable

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(Nullable<RemovalPolicy>, IRemovalPolicyOptions)

CfnResource.GetAtt(String, Nullable<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.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, ITaggable

Syntax (vb)

Public Class CfnInput
    Inherits CfnResource
    Implements IInspectable, 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(ByRefValue)	Used by jsii to construct an instance of this class from a Javascript-owned object reference
CfnInput(DeputyBase.DeputyProps)	Used by jsii to construct an instance of this class from DeputyProps
CfnInput(Construct, String, ICfnInputProps)

Properties

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

Methods

Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<String, Object>)

Constructors

CfnInput(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected CfnInput(ByRefValue reference)

Parameters

reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

CfnInput(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected CfnInput(DeputyBase.DeputyProps props)

Parameters

props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

CfnInput(Construct, String, ICfnInputProps)

public CfnInput(Construct scope, string id, ICfnInputProps 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 ICfnInputProps

Resource properties.

Properties

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

CfnResource.CfnProperties

InputDefinition

The definition of the input.

public virtual object InputDefinition { get; set; }

Property Value

System.Object

InputDescription

A brief description of the input.

public virtual string InputDescription { get; set; }

Property Value

System.String

InputName

The name of the input.

public virtual string InputName { get; set; }

Property Value

System.String

Tags

Tag Manager which manages the tags for this resource.

public virtual TagManager Tags { get; }

Property Value

TagManager

TagsRaw

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

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

Property Value

ICfnTag[]

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>

Overrides

CfnResource.RenderProperties(IDictionary<String, Object>)

Implements

IInspectable

ITaggable