software.amazon.awscdk.services.events

Class IEventBus.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.events.IEventBus.Jsii$Proxy

All Implemented Interfaces:

IConstruct, IConstruct.Jsii$Default, IDependable, IDependable.Jsii$Default, IResource, IResource.Jsii$Default, IEventBus, IEventBus.Jsii$Default

Enclosing interface:

IEventBus

public static final class IEventBus.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements IEventBus.Jsii$Default

A proxy class which represents a concrete javascript instance of this type.

Nested Class Summary

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

IEventBus.Jsii$Default, IEventBus.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
void	applyRemovalPolicy(RemovalPolicy policy) Apply the given removal policy to this resource.
Archive	archive(java.lang.String id, BaseArchiveProps props) Create an EventBridge archive to send events to.
ResourceEnvironment	getEnv() The environment this resource belongs to.
java.lang.String	getEventBusArn() The ARN of this event bus resource.
java.lang.String	getEventBusName() The physical ID of this event bus resource.
java.lang.String	getEventBusPolicy() The JSON policy of this event bus resource.
java.lang.String	getEventSourceName() The partner event source to associate with this event bus resource.
ConstructNode	getNode() The construct tree node for this construct.
Stack	getStack() The stack in which this resource is defined.
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 class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Method Detail

getNode

public final ConstructNode getNode()

The construct tree node for this construct.

Specified by:

getNode in interface IConstruct

Specified by:

getNode in interface IConstruct.Jsii$Default

Specified by:

getNode in interface IResource.Jsii$Default

Specified by:

getNode in interface IEventBus.Jsii$Default

getEnv

public final 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

Specified by:

getEnv in interface IEventBus.Jsii$Default

getStack

public final Stack getStack()

The stack in which this resource is defined.

Specified by:

getStack in interface IResource

Specified by:

getStack in interface IResource.Jsii$Default

Specified by:

getStack in interface IEventBus.Jsii$Default

getEventBusArn

public final java.lang.String getEventBusArn()

The ARN of this event bus resource.

Specified by:

getEventBusArn in interface IEventBus

Specified by:

getEventBusArn in interface IEventBus.Jsii$Default

getEventBusName

public final java.lang.String getEventBusName()

The physical ID of this event bus resource.

Specified by:

getEventBusName in interface IEventBus

Specified by:

getEventBusName in interface IEventBus.Jsii$Default

getEventBusPolicy

public final java.lang.String getEventBusPolicy()

The JSON policy of this event bus resource.

Specified by:

getEventBusPolicy in interface IEventBus

Specified by:

getEventBusPolicy in interface IEventBus.Jsii$Default

getEventSourceName

public final java.lang.String getEventSourceName()

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

Specified by:

getEventSourceName in interface IEventBus

Specified by:

getEventSourceName in interface IEventBus.Jsii$Default

applyRemovalPolicy

public final void applyRemovalPolicy(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

Specified by:

applyRemovalPolicy in interface IEventBus.Jsii$Default

Parameters:

policy - This parameter is required.

archive

public final Archive archive(java.lang.String id,
                             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

Specified by:

archive in interface IEventBus.Jsii$Default

Parameters:

id - This parameter is required.

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

grantPutEventsTo

public final Grant grantPutEventsTo(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

Specified by:

grantPutEventsTo in interface IEventBus.Jsii$Default

Parameters:

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