software.amazon.awscdk.services.iotevents

Interface IInput.Jsii$Default

All Superinterfaces:

software.constructs.IConstruct, software.constructs.IConstruct.Jsii$Default, IDependable, IDependable.Jsii$Default, IInput, IResource, IResource.Jsii$Default, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

IInput.Jsii$Proxy

Enclosing interface:

IInput

@Internal
public static interface IInput.Jsii$Default
extends IInput, IResource.Jsii$Default

Internal default implementation for IInput.

Nested Class Summary

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.iotevents.IInput

IInput.Jsii$Default, IInput.Jsii$Proxy

Method Summary

Modifier and Type	Method and Description
default void	applyRemovalPolicy(RemovalPolicy policy) (experimental) Apply the given removal policy to this resource.
default ResourceEnvironment	getEnv() (experimental) The environment this resource belongs to.
default String	getInputArn() (experimental) The ARN of the input.
default String	getInputName() (experimental) The name of the input.
default ConstructNode	getNode() (experimental) The construct tree node for this construct.
default Stack	getStack() (experimental) The stack in which this resource is defined.
default Grant	grant(IGrantable grantee, String... actions) (experimental) Grant the indicated permissions on this input to the given IAM principal (Role/Group/User).
default Grant	grantWrite(IGrantable grantee) (experimental) Grant write permissions on this input and its contents to an IAM principal (Role/Group/User).

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getNode

@Stability(value=Experimental)
 @NotNull
default ConstructNode getNode()

(experimental) The construct tree node for this construct.

Specified by:

getNode in interface IResource.Jsii$Default

getEnv

@Stability(value=Experimental)
 @NotNull
default ResourceEnvironment getEnv()

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

Specified by:

getEnv in interface IResource

Specified by:

getEnv in interface IResource.Jsii$Default

getStack

@Stability(value=Experimental)
 @NotNull
default Stack getStack()

(experimental) The stack in which this resource is defined.

Specified by:

getStack in interface IResource

Specified by:

getStack in interface IResource.Jsii$Default

getInputArn

@Stability(value=Experimental)
 @NotNull
default String getInputArn()

(experimental) The ARN of the input.

Specified by:

getInputArn in interface IInput

getInputName

@Stability(value=Experimental)
 @NotNull
default String getInputName()

(experimental) The name of the input.

Specified by:

getInputName in interface IInput

applyRemovalPolicy

@Stability(value=Experimental)
default void applyRemovalPolicy(@NotNull
                                                               RemovalPolicy policy)

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

Specified by:

applyRemovalPolicy in interface IResource

Specified by:

applyRemovalPolicy in interface IResource.Jsii$Default

Parameters:

policy - This parameter is required.

grant

@Stability(value=Experimental)
 @NotNull
default Grant grant(@NotNull
                                                             IGrantable grantee,
                                                             @NotNull
                                                             String... actions)

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

Specified by:

grant in interface IInput

Parameters:

grantee - the principal. This parameter is required.

actions - the set of actions to allow (i.e. "iotevents:BatchPutMessage"). This parameter is required.

grantWrite

@Stability(value=Experimental)
 @NotNull
default Grant grantWrite(@NotNull
                                                                  IGrantable grantee)

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

Specified by:

grantWrite in interface IInput

Parameters:

grantee - the principal. This parameter is required.