Input
- class aws_cdk.aws_iotevents_alpha.Input(scope, id, *, attribute_json_paths, input_name=None)
Bases:
Resource
(experimental) Defines an AWS IoT Events input in this stack.
- Stability:
experimental
- ExampleMetadata:
infused
Example:
import aws_cdk.aws_iotevents_alpha as iotevents import aws_cdk.aws_iam as iam # role: iam.IRole input = iotevents.Input(self, "MyInput", attribute_json_paths=["payload.temperature", "payload.transactionId"] ) topic_rule = iot.TopicRule(self, "TopicRule", sql=iot.IotSql.from_string_as_ver20160323("SELECT * FROM 'device/+/data'"), actions=[ actions.IotEventsPutMessageAction(input, batch_mode=True, # optional property, default is 'false' message_id="${payload.transactionId}", # optional property, default is a new UUID role=role ) ] )
- Parameters:
scope (
Construct
) –id (
str
) –attribute_json_paths (
Sequence
[str
]) – (experimental) An expression that specifies an attribute-value pair in a JSON structure. Use this to specify an attribute from the JSON payload that is made available by the input. Inputs are derived from messages sent to AWS IoT Events (BatchPutMessage). Each such message contains a JSON payload. The attribute (and its paired value) specified here are available for use in the condition expressions used by detectors.input_name (
Optional
[str
]) – (experimental) The name of the input. Default: - CloudFormation will generate a unique name of the input
- Stability:
experimental
Methods
- apply_removal_policy(policy)
Apply the given removal policy to this resource.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.
The resource can be deleted (
RemovalPolicy.DESTROY
), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN
).- Parameters:
policy (
RemovalPolicy
) –- Return type:
None
- grant(grantee, *actions)
(experimental) Grant the indicated permissions on this input to the given IAM principal (Role/Group/User).
- Parameters:
grantee (
IGrantable
) –actions (
str
) –
- Stability:
experimental
- Return type:
- grant_write(grantee)
(experimental) Grant write permissions on this input and its contents to an IAM principal (Role/Group/User).
- Parameters:
grantee (
IGrantable
) –- Stability:
experimental
- Return type:
- to_string()
Returns a string representation of this construct.
- Return type:
str
Attributes
- env
The environment this resource belongs to.
For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.
- input_arn
(experimental) The ARN of the input.
- Stability:
experimental
- input_name
(experimental) The name of the input.
- Stability:
experimental
- node
The tree node.
- stack
The stack in which this resource is defined.
Static Methods
- classmethod from_input_name(scope, id, input_name)
(experimental) Import an existing input.
- classmethod is_construct(x)
Checks if
x
is a construct.Use this method instead of
instanceof
to properly detectConstruct
instances, even when the construct library is symlinked.Explanation: in JavaScript, multiple copies of the
constructs
library on disk are seen as independent, completely different libraries. As a consequence, the classConstruct
in each copy of theconstructs
library is seen as a different class, and an instance of one class will not test asinstanceof
the other class.npm install
will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of theconstructs
library can be accidentally installed, andinstanceof
will behave unpredictably. It is safest to avoid usinginstanceof
, and using this type-testing method instead.- Parameters:
x (
Any
) – Any object.- Return type:
bool
- Returns:
true if
x
is an object created from a class which extendsConstruct
.
- classmethod is_owned_resource(construct)
Returns true if the construct was created by CDK, and false otherwise.
- Parameters:
construct (
IConstruct
) –- Return type:
bool
- classmethod is_resource(construct)
Check whether the given construct is a Resource.
- Parameters:
construct (
IConstruct
) –- Return type:
bool