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
,ITaggable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
date="2024-10-05T03:43:44.825Z")
@Stability(Stable)
public class CfnInput
extends CfnResource
implements IInspectable, ITaggable
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();
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic interface
The attributes from the JSON payload that are made available by the input.static final class
A fluent builder forCfnInput
.static interface
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.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggable
ITaggable.Jsii$Default, ITaggable.Jsii$Proxy
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionprotected
CfnInput
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnInput
(software.amazon.jsii.JsiiObjectRef objRef) CfnInput
(software.constructs.Construct scope, String id, CfnInputProps props) -
Method Summary
Modifier and TypeMethodDescriptionThe definition of the input.A brief description of the input.The name of the input.getTags()
Tag Manager which manages the tags for this resource.An array of key-value pairs to apply to this resource.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
setInputDefinition
(IResolvable value) The definition of the input.void
The definition of the input.void
setInputDescription
(String value) A brief description of the input.void
setInputName
(String value) The name of the input.void
setTagsRaw
(List<CfnTag> value) An array of key-value pairs to apply to this resource.Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, 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 Details
-
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
-
-
Constructor Details
-
CfnInput
protected CfnInput(software.amazon.jsii.JsiiObjectRef objRef) -
CfnInput
protected CfnInput(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnInput
@Stability(Stable) public CfnInput(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnInputProps props) - Parameters:
scope
- Scope in which this resource is defined. This parameter is required.id
- Construct identifier for this resource (unique in its scope). This parameter is required.props
- Resource properties. This parameter is required.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- Parameters:
inspector
- tree inspector to collect and process attributes. This parameter is required.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderProperties
in classCfnResource
- Parameters:
props
- This parameter is required.
-
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getTags
Tag Manager which manages the tags for this resource. -
getInputDefinition
The definition of the input. -
setInputDefinition
The definition of the input. -
setInputDefinition
The definition of the input. -
getInputDescription
A brief description of the input. -
setInputDescription
A brief description of the input. -
getInputName
The name of the input. -
setInputName
The name of the input. -
getTagsRaw
An array of key-value pairs to apply to this resource. -
setTagsRaw
An array of key-value pairs to apply to this resource.
-