interface IInput 🔹

Language	Type name
.NET	Amazon.CDK.AWS.IoTEvents.IInput
Java	software.amazon.awscdk.services.iotevents.IInput
Python	aws_cdk.aws_iotevents.IInput
TypeScript (source)	@aws-cdk/aws-iotevents » IInput

Implemented by Input

Obtainable from Input.fromInputName()

Represents an AWS IoT Events input.

Properties

Name	Type	Description
env🔹	ResourceEnvironment	The environment this resource belongs to.
inputArn🔹	string	The ARN of the input.
inputName🔹	string	The name of the input.
node🔹	ConstructNode	The construct tree node for this construct.
stack🔹	Stack	The stack in which this resource is defined.

---

env🔹

Type: ResourceEnvironment

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.

---

inputArn🔹

Type: string

The ARN of the input.

---

inputName🔹

Type: string

The name of the input.

---

node🔹

Type: ConstructNode

The construct tree node for this construct.

---

stack🔹

Type: Stack

The stack in which this resource is defined.

Methods

Name	Description
applyRemovalPolicy(policy)🔹	Apply the given removal policy to this resource.
grant(grantee, ...actions)🔹	Grant the indicated permissions on this input to the given IAM principal (Role/Group/User).
grantWrite(grantee)🔹	Grant write permissions on this input and its contents to an IAM principal (Role/Group/User).

---

applyRemovalPolicy(policy)🔹

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

• policy RemovalPolicy

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).

---

grant(grantee, ...actions)🔹

public grant(grantee: IGrantable, ...actions: string[]): Grant

Parameters

• grantee IGrantable — the principal.
• actions string — the set of actions to allow (i.e. "iotevents:BatchPutMessage").

Returns

• Grant

Grant the indicated permissions on this input to the given IAM principal (Role/Group/User).

---

grantWrite(grantee)🔹

public grantWrite(grantee: IGrantable): Grant

Parameters

• grantee IGrantable — the principal.

Returns

• Grant

Grant write permissions on this input and its contents to an IAM principal (Role/Group/User).