software.amazon.awscdk.services.events

Interface IEventBus.Jsii$Default

All Superinterfaces:

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

All Known Implementing Classes:

IEventBus.Jsii$Proxy

Enclosing interface:

IEventBus

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

Internal default implementation for IEventBus.

Nested Class Summary

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.events.IEventBus

IEventBus.Jsii$Default, IEventBus.Jsii$Proxy

Method Summary

Modifier and Type	Method and Description
default void	applyRemovalPolicy(RemovalPolicy policy) Apply the given removal policy to this resource.
default Archive	archive(String id, BaseArchiveProps props) Create an EventBridge archive to send events to.
default ResourceEnvironment	getEnv() The environment this resource belongs to.
default String	getEventBusArn() The ARN of this event bus resource.
default String	getEventBusName() The physical ID of this event bus resource.
default String	getEventBusPolicy() The JSON policy of this event bus resource.
default String	getEventSourceName() The partner event source to associate with this event bus resource.
default software.constructs.Node	getNode() The tree node.
default Stack	getStack() The stack in which this resource is defined.
default Grant	grantPutEventsTo(IGrantable grantee) Grants an IAM Principal to send custom events to the eventBus so that they can be matched to rules.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getNode

@Stability(value=Stable)
 @NotNull
default software.constructs.Node getNode()

The tree node.

Specified by:

getNode in interface software.constructs.IConstruct

Specified by:

getNode in interface software.constructs.IConstruct.Jsii$Default

Specified by:

getNode in interface IResource.Jsii$Default

getEnv

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

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=Stable)
 @NotNull
default Stack getStack()

The stack in which this resource is defined.

Specified by:

getStack in interface IResource

Specified by:

getStack in interface IResource.Jsii$Default

getEventBusArn

@Stability(value=Stable)
 @NotNull
default String getEventBusArn()

The ARN of this event bus resource.

Specified by:

getEventBusArn in interface IEventBus

getEventBusName

@Stability(value=Stable)
 @NotNull
default String getEventBusName()

The physical ID of this event bus resource.

Specified by:

getEventBusName in interface IEventBus

getEventBusPolicy

@Stability(value=Stable)
 @NotNull
default String getEventBusPolicy()

The JSON policy of this event bus resource.

Specified by:

getEventBusPolicy in interface IEventBus

getEventSourceName

@Stability(value=Stable)
 @Nullable
default String getEventSourceName()

The partner event source to associate with this event bus resource.

Specified by:

getEventSourceName in interface IEventBus

applyRemovalPolicy

@Stability(value=Stable)
default void applyRemovalPolicy(@NotNull
                                                         RemovalPolicy 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).

Specified by:

applyRemovalPolicy in interface IResource

Specified by:

applyRemovalPolicy in interface IResource.Jsii$Default

Parameters:

policy - This parameter is required.

archive

@Stability(value=Stable)
 @NotNull
default Archive archive(@NotNull
                                                           String id,
                                                           @NotNull
                                                           BaseArchiveProps props)

Create an EventBridge archive to send events to.

When you create an archive, incoming events might not immediately start being sent to the archive. Allow a short period of time for changes to take effect.

Specified by:

archive in interface IEventBus

Parameters:

id - This parameter is required.

props - Properties of the archive. This parameter is required.

grantPutEventsTo

@Stability(value=Stable)
 @NotNull
default Grant grantPutEventsTo(@NotNull
                                                                  IGrantable grantee)

Grants an IAM Principal to send custom events to the eventBus so that they can be matched to rules.

Specified by:

grantPutEventsTo in interface IEventBus

Parameters:

grantee - The principal (no-op if undefined). This parameter is required.