@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-28T21:34:20.450Z") public class CfnInput extends CfnResource implements IInspectable
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();
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.
|
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
Modifier | Constructor and Description |
---|---|
|
CfnInput(Construct scope,
java.lang.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) |
Modifier and Type | Method and Description |
---|---|
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.lang.Object |
getInputDefinition()
The definition of the input.
|
java.lang.String |
getInputDescription()
A brief description of the input.
|
java.lang.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 java.util.Map<java.lang.String,java.lang.Object> |
renderProperties(java.util.Map<java.lang.String,java.lang.Object> props) |
void |
setInputDefinition(CfnInput.InputDefinitionProperty value)
The definition of the input.
|
void |
setInputDefinition(IResolvable value)
The definition of the input.
|
void |
setInputDescription(java.lang.String value)
A brief description of the input.
|
void |
setInputName(java.lang.String value)
The name of the input.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnInput(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnInput(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnInput(Construct scope, java.lang.String id, CfnInputProps props)
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.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public TagManager getTags()
For more information, see Tag .
public java.lang.Object getInputDefinition()
public void setInputDefinition(IResolvable value)
public void setInputDefinition(CfnInput.InputDefinitionProperty value)
public java.lang.String getInputDescription()
public void setInputDescription(java.lang.String value)
public java.lang.String getInputName()
public void setInputName(java.lang.String value)