software.amazon.awscdk.services.iotevents

Class CfnInput

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.iotevents.CfnInput

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:40.025Z")
 @Stability(value=Stable)
public class CfnInput
extends CfnResource
implements IInspectable

A CloudFormation `AWS::IoTEvents::Input`.

The AWS::IoTEvents::Input resource creates an input. 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 .

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.iotevents.*;
 CfnInput cfnInput = CfnInput.Builder.create(this, "MyCfnInput")
         .inputDefinition(InputDefinitionProperty.builder()
                 .attributes(List.of(AttributeProperty.builder()
                         .jsonPath("jsonPath")
                         .build()))
                 .build())
         // the properties below are optional
         .inputDescription("inputDescription")
         .inputName("inputName")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CfnInput.AttributeProperty The attributes from the JSON payload that are made available by the input.
static class	CfnInput.Builder A fluent builder for CfnInput.
static interface	CfnInput.InputDefinitionProperty The definition of the input.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnInput(software.constructs.Construct scope, String id, CfnInputProps props) Create a new `AWS::IoTEvents::Input`.
protected	CfnInput(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnInput(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
protected Map<String,Object>	getCfnProperties()
Object	getInputDefinition() The definition of the input.
String	getInputDescription() A brief description of the input.
String	getInputName() The name of the input.
TagManager	getTags() An array of key-value pairs to apply to this resource.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setInputDefinition(CfnInput.InputDefinitionProperty value) The definition of the input.
void	setInputDefinition(IResolvable value) The definition of the input.
void	setInputDescription(String value) A brief description of the input.
void	setInputName(String value) The name of the input.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnInput

protected CfnInput(software.amazon.jsii.JsiiObjectRef objRef)

CfnInput

protected CfnInput(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnInput

@Stability(value=Stable)
public CfnInput(@NotNull
                                         software.constructs.Construct scope,
                                         @NotNull
                                         String id,
                                         @NotNull
                                         CfnInputProps props)

Create a new `AWS::IoTEvents::Input`.

Parameters:

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.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

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

For more information, see Tag .

getInputDefinition

@Stability(value=Stable)
 @NotNull
public Object getInputDefinition()

The definition of the input.

setInputDefinition

@Stability(value=Stable)
public void setInputDefinition(@NotNull
                                                        CfnInput.InputDefinitionProperty value)

The definition of the input.

setInputDefinition

@Stability(value=Stable)
public void setInputDefinition(@NotNull
                                                        IResolvable value)

The definition of the input.

getInputDescription

@Stability(value=Stable)
 @Nullable
public String getInputDescription()

A brief description of the input.

setInputDescription

@Stability(value=Stable)
public void setInputDescription(@Nullable
                                                         String value)

A brief description of the input.

getInputName

@Stability(value=Stable)
 @Nullable
public String getInputName()

The name of the input.

setInputName

@Stability(value=Stable)
public void setInputName(@Nullable
                                                  String value)

The name of the input.