EventBus L2 construct
Define an EventBridge EventBus.
Example
import * as events from 'aws-cdk-lib/aws-events';
declare const myConfigurationSet: ses.ConfigurationSet;
const bus = events.EventBus.fromEventBusName(this, 'EventBus', 'default');
myConfigurationSet.addEventDestination('ToEventBus', {
destination: ses.EventDestination.eventBus(bus),
})
import aws_cdk.aws_events as events
# my_configuration_set: ses.ConfigurationSet
bus = events.EventBus.from_event_bus_name(self, "EventBus", "default")
my_configuration_set.add_event_destination("ToEventBus",
destination=ses.EventDestination.event_bus(bus)
)
import software.amazon.awscdk.services.events.*;
ConfigurationSet myConfigurationSet;
IEventBus bus = EventBus.fromEventBusName(this, "EventBus", "default");
myConfigurationSet.addEventDestination("ToEventBus", ConfigurationSetEventDestinationOptions.builder()
.destination(EventDestination.eventBus(bus))
.build());
// Install: dotnet add package Amazon.CDK.Lib
using Amazon.CDK.AWS.Events;
ConfigurationSet myConfigurationSet;
var bus = EventBus.FromEventBusName(this, "EventBus", "default");
myConfigurationSet.AddEventDestination("ToEventBus", new ConfigurationSetEventDestinationOptions {
Destination = EventDestination.EventBus(bus)
});
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
import events "github.com/aws/aws-cdk-go/awscdk"
var myConfigurationSet ConfigurationSet
bus := events.EventBus_FromEventBusName(this, jsii.String("EventBus"), jsii.String("default"))
myConfigurationSet.AddEventDestination(jsii.String("ToEventBus"), &ConfigurationSetEventDestinationOptions{
Destination: ses.EventDestination_EventBus(bus),
})
Initializer
new EventBus(scope: Construct, id: string, props?: EventBusProps)
EventBus(scope: Construct, id: str, props: typing.Optional[EventBusProps] = None)
new EventBus(Construct scope, String id, EventBusProps props)
new EventBus(Construct scope, string id, EventBusProps? props = null)
NewEventBus(Scope Construct, Id *string, Props EventBusProps)
Construct Props
deadLetterQueueIQueuedead_letter_queueIQueuedeadLetterQueueIQueueDeadLetterQueueIQueueDeadLetterQueueIQueue= no dead-letter queue#descriptionstringdescriptionstrdescriptionStringDescriptionstringDescription*string= no description#The description can be up to 512 characters long.
eventBusNamestringevent_bus_namestreventBusNameStringEventBusNamestringEventBusName*string= automatically generated name#eventSourceNamestringevent_source_namestreventSourceNameStringEventSourceNamestringEventSourceName*string= no partner event source#Properties
envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironmentrequired#notes
For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.
For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.
eventBusPolicystringevent_bus_policystreventBusPolicyStringEventBusPolicystringEventBusPolicy*stringrequired#eventBusRefEventBusReferenceevent_bus_refEventBusReferenceeventBusRefEventBusReferenceEventBusRefEventBusReferenceEventBusRefEventBusReferencerequired#eventSourceNamestringevent_source_namestreventSourceNameStringEventSourceNamestringEventSourceName*string#grantsEventBusGrantsgrantsEventBusGrantsgrantsEventBusGrantsGrantsEventBusGrantsGrantsEventBusGrantsrequired#PROPERTY_INJECTION_IDstringproperty_injection_idstrPROPERTY_INJECTION_IDStringPROPERTY_INJECTION_IDstringPROPERTY_INJECTION_ID*stringrequiredstatic#Methods
addToResourcePolicy(statement: PolicyStatement): AddToResourcePolicyResultdef add_to_resource_policy(self, statement: PolicyStatement) -> AddToResourcePolicyResultpublic AddToResourcePolicyResult addToResourcePolicy(PolicyStatement statement)public AddToResourcePolicyResult AddToResourcePolicy(PolicyStatement statement)func AddToResourcePolicy(Statement PolicyStatement) AddToResourcePolicyResult#applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#notes · 1 parameter
When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.
Parameters
strengthstrengthstrengthstrengthStrength— - The reference strength to use for this resource.
applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#notes
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).
archive(id: string, props: BaseArchiveProps): Archivedef archive(self, id: str, props: BaseArchiveProps) -> Archivepublic Archive archive(String id, BaseArchiveProps props)public Archive Archive(string id, BaseArchiveProps props)func Archive(Id *string, Props BaseArchiveProps) Archive#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.
fromEventBusArn(scope: Construct, id: string, eventBusArn: string): IEventBus@staticmethod def from_event_bus_arn(scope: Construct, id: str, event_bus_arn: str) -> IEventBuspublic static IEventBus fromEventBusArn(Construct scope, String id, String eventBusArn)public static IEventBus FromEventBusArn(Construct scope, string id, string eventBusArn)func FromEventBusArn(Scope Construct, Id *string, EventBusArn *string) IEventBusstatic#3 parameters
Parameters
scopescopescopescopeScope— Parent construct.ididididId— Construct ID.eventBusArnevent_bus_arneventBusArneventBusArnEventBusArn— ARN of imported event bus.
fromEventBusAttributes(scope: Construct, id: string, attrs: EventBusAttributes): IEventBus@staticmethod def from_event_bus_attributes(scope: Construct, id: str, attrs: EventBusAttributes) -> IEventBuspublic static IEventBus fromEventBusAttributes(Construct scope, String id, EventBusAttributes attrs)public static IEventBus FromEventBusAttributes(Construct scope, string id, EventBusAttributes attrs)func FromEventBusAttributes(Scope Construct, Id *string, Attrs EventBusAttributes) IEventBusstatic#3 parameters
Parameters
scopescopescopescopeScope— Parent construct.ididididId— Construct ID.attrsattrsattrsattrsAttrs— Imported event bus properties.
fromEventBusName(scope: Construct, id: string, eventBusName: string): IEventBus@staticmethod def from_event_bus_name(scope: Construct, id: str, event_bus_name: str) -> IEventBuspublic static IEventBus fromEventBusName(Construct scope, String id, String eventBusName)public static IEventBus FromEventBusName(Construct scope, string id, string eventBusName)func FromEventBusName(Scope Construct, Id *string, EventBusName *string) IEventBusstatic#3 parameters
Parameters
scopescopescopescopeScope— Parent construct.ididididId— Construct ID.eventBusNameevent_bus_nameeventBusNameeventBusNameEventBusName— Name of imported event bus.
grantAllPutEvents(grantee: IGrantable): Grant@staticmethod def grant_all_put_events(grantee: IGrantable) -> Grantpublic static Grant grantAllPutEvents(IGrantable grantee)public static Grant GrantAllPutEvents(IGrantable grantee)func GrantAllPutEvents(Grantee IGrantable) Grantstatic#1 parameter
Parameters
granteegranteegranteegranteeGrantee— The principal (no-op if undefined).
grantPutEventsTo(grantee: IGrantable, sid?: string): Grantdef grant_put_events_to(self, grantee: IGrantable, sid: typing.Optional[str] = None) -> Grantpublic Grant grantPutEventsTo(IGrantable grantee, String sid)public Grant GrantPutEventsTo(IGrantable grantee, string? sid = null)func GrantPutEventsTo(Grantee IGrantable, Sid *string) Grant#isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#notes · 1 parameter · returns
Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.
Parameters
xxxxX— Any object.
Returns: true if x is an object created from a class which extends Construct.
isOwnedResource(construct: IConstruct): boolean@staticmethod def is_owned_resource(construct: IConstruct) -> boolpublic static Boolean isOwnedResource(IConstruct construct)public static bool IsOwnedResource(IConstruct construct)func IsOwnedResource(Construct IConstruct) *boolstatic#isResource(construct: IConstruct): boolean@staticmethod def is_resource(construct: IConstruct) -> boolpublic static Boolean isResource(IConstruct construct)public static bool IsResource(IConstruct construct)func IsResource(Construct IConstruct) *boolstatic#toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.