Interface IEventBus.Jsii$Default
- All Superinterfaces:
IConstruct
,software.constructs.IConstruct
,IConstruct.Jsii$Default
,software.constructs.IConstruct.Jsii$Default
,IDependable
,IDependable.Jsii$Default
,IEventBus
,IResource
,IResource.Jsii$Default
,software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
IEventBus.Jsii$Proxy
- Enclosing interface:
- IEventBus
IEventBus
.-
Nested Class Summary
Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
IConstruct.Jsii$Default, IConstruct.Jsii$Proxy
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IDependable
IDependable.Jsii$Default, IDependable.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.services.events.IEventBus
IEventBus.Jsii$Default, IEventBus.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IResource
IResource.Jsii$Default, IResource.Jsii$Proxy
-
Method Summary
Modifier and TypeMethodDescriptiondefault 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
The ARN of this event bus resource.default String
The physical ID of this event bus resource.default String
The JSON policy of this event bus resource.default String
The partner event source to associate with this event bus resource.default ConstructNode
getNode()
The construct tree node for this construct.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 Details
-
getNode
The construct tree node for this construct.- Specified by:
getNode
in interfaceIConstruct
- Specified by:
getNode
in interfaceIConstruct.Jsii$Default
- Specified by:
getNode
in interfaceIResource.Jsii$Default
-
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 interfaceIResource
- Specified by:
getEnv
in interfaceIResource.Jsii$Default
-
getStack
The stack in which this resource is defined.- Specified by:
getStack
in interfaceIResource
- Specified by:
getStack
in interfaceIResource.Jsii$Default
-
getEventBusArn
The ARN of this event bus resource.- Specified by:
getEventBusArn
in interfaceIEventBus
-
getEventBusName
The physical ID of this event bus resource.- Specified by:
getEventBusName
in interfaceIEventBus
-
getEventBusPolicy
The JSON policy of this event bus resource.- Specified by:
getEventBusPolicy
in interfaceIEventBus
-
getEventSourceName
The partner event source to associate with this event bus resource.- Specified by:
getEventSourceName
in interfaceIEventBus
-
applyRemovalPolicy
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 interfaceIResource
- Specified by:
applyRemovalPolicy
in interfaceIResource.Jsii$Default
- Parameters:
policy
- This parameter is required.
-
archive
@Stability(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.
-
grantPutEventsTo
Grants an IAM Principal to send custom events to the eventBus so that they can be matched to rules.- Specified by:
grantPutEventsTo
in interfaceIEventBus
- Parameters:
grantee
- The principal (no-op if undefined). This parameter is required.
-