Class CfnEventBus
- All Implemented Interfaces:
IConstruct
,IDependable
,IInspectable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
AWS::Events::EventBus
.
Creates a new event bus within your account. This can be a custom event bus which you can use to receive events from your custom applications and services, or it can be a partner event bus which can be matched to a partner event source.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.events.*; CfnEventBus cfnEventBus = CfnEventBus.Builder.create(this, "MyCfnEventBus") .name("name") // the properties below are optional .eventSourceName("eventSourceName") .tags(List.of(TagEntryProperty.builder() .key("key") .value("value") .build())) .build();
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic final class
A fluent builder forCfnEventBus
.static interface
A key-value pair associated with an AWS resource.Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionCfnEventBus
(Construct scope, String id, CfnEventBusProps props) Create a newAWS::Events::EventBus
.protected
CfnEventBus
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnEventBus
(software.amazon.jsii.JsiiObjectRef objRef) -
Method Summary
Modifier and TypeMethodDescriptionThe ARN of the event bus, such asarn:aws:events:us-east-2:123456789012:event-bus/aws.partner/PartnerName/acct1/repo1
.The name of the event bus, such asPartnerName/acct1/repo1
.The policy for the event bus in JSON form.If you are creating a partner event bus, this specifies the partner event source that the new event bus will be matched with.getName()
The name of the new event bus.getTags()
Tags to associate with the event bus.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
setEventSourceName
(String value) If you are creating a partner event bus, this specifies the partner event source that the new event bus will be matched with.void
The name of the new event bus.void
setTags
(List<CfnEventBus.TagEntryProperty> value) Tags to associate with the event bus.Methods inherited from class software.amazon.awscdk.core.CfnResource
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
Methods inherited from class software.amazon.awscdk.core.CfnRefElement
getRef
Methods inherited from class software.amazon.awscdk.core.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
Methods inherited from class software.amazon.awscdk.core.Construct
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
-
-
Constructor Details
-
CfnEventBus
protected CfnEventBus(software.amazon.jsii.JsiiObjectRef objRef) -
CfnEventBus
protected CfnEventBus(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnEventBus
@Stability(Stable) public CfnEventBus(@NotNull Construct scope, @NotNull String id, @NotNull CfnEventBusProps props) Create a newAWS::Events::EventBus
.- Parameters:
scope
-- scope in which this resource is defined.
id
-- scoped id of the resource.
props
-- resource properties.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- Parameters:
inspector
-- tree inspector to collect and process attributes.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderProperties
in classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrArn
The ARN of the event bus, such asarn:aws:events:us-east-2:123456789012:event-bus/aws.partner/PartnerName/acct1/repo1
. -
getAttrName
The name of the event bus, such asPartnerName/acct1/repo1
. -
getAttrPolicy
The policy for the event bus in JSON form. -
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getName
The name of the new event bus.Custom event bus names can't contain the
/
character, but you can use the/
character in partner event bus names. In addition, for partner event buses, the name must exactly match the name of the partner event source that this event bus is matched to.You can't use the name
default
for a custom event bus, as this name is already used for your account's default event bus. -
setName
The name of the new event bus.Custom event bus names can't contain the
/
character, but you can use the/
character in partner event bus names. In addition, for partner event buses, the name must exactly match the name of the partner event source that this event bus is matched to.You can't use the name
default
for a custom event bus, as this name is already used for your account's default event bus. -
getEventSourceName
If you are creating a partner event bus, this specifies the partner event source that the new event bus will be matched with. -
setEventSourceName
If you are creating a partner event bus, this specifies the partner event source that the new event bus will be matched with. -
getTags
Tags to associate with the event bus. -
setTags
Tags to associate with the event bus.
-