Class CfnEventBus
java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.events.CfnEventBus
- All Implemented Interfaces:
IInspectable
,ITaggableV2
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
date="2024-05-24T02:42:38.382Z")
@Stability(Stable)
public class CfnEventBus
extends CfnResource
implements IInspectable, ITaggableV2
Specifies an 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.
As an aid to help you jumpstart developing CloudFormation templates, the EventBridge console enables you to create templates from the existing event buses in your account. For more information, see Generating CloudFormation templates from an EventBridge event bus in the Amazon EventBridge User Guide .
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.*; Object policy; CfnEventBus cfnEventBus = CfnEventBus.Builder.create(this, "MyCfnEventBus") .name("name") // the properties below are optional .deadLetterConfig(DeadLetterConfigProperty.builder() .arn("arn") .build()) .description("description") .eventSourceName("eventSourceName") .kmsKeyIdentifier("kmsKeyIdentifier") .policy(policy) .tags(List.of(CfnTag.builder() .key("key") .value("value") .build())) .build();
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic final class
A fluent builder forCfnEventBus
.static interface
Dead Letter Queue for the event bus.Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggableV2
ITaggableV2.Jsii$Default, ITaggableV2.Jsii$Proxy
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionprotected
CfnEventBus
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnEventBus
(software.amazon.jsii.JsiiObjectRef objRef) CfnEventBus
(software.constructs.Construct scope, String id, CfnEventBusProps props) -
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
.Tag Manager which manages the tags for this resource.Dead Letter Queue for the event bus.The description of the event bus.If you are creating a partner event bus, this specifies the partner event source that the new event bus will be matched with.Kms Key Identifier used to encrypt events at rest in the event bus.getName()
The name of the new event bus.The permissions policy of the event bus, describing which other AWS accounts can write events to this 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
setDeadLetterConfig
(IResolvable value) Dead Letter Queue for the event bus.void
Dead Letter Queue for the event bus.void
setDescription
(String value) The description of the event bus.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
setKmsKeyIdentifier
(String value) Kms Key Identifier used to encrypt events at rest in the event bus.void
The name of the new event bus.void
The permissions policy of the event bus, describing which other AWS accounts can write events to this event bus.void
Tags to associate with the event bus.Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties
Methods inherited from class software.amazon.awscdk.CfnRefElement
getRef
Methods inherited from class software.amazon.awscdk.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
Methods inherited from class software.constructs.Construct
getNode, isConstruct
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 software.constructs.Construct scope, @NotNull String id, @NotNull CfnEventBusProps props) - Parameters:
scope
- Scope in which this resource is defined. This parameter is required.id
- Construct identifier for this resource (unique in its scope). This parameter is required.props
- Resource properties. This parameter is required.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- Parameters:
inspector
- tree inspector to collect and process attributes. This parameter is required.
-
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
-
getCdkTagManager
Tag Manager which manages the tags for this resource.- Specified by:
getCdkTagManager
in interfaceITaggableV2
-
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getName
The name of the new event bus. -
setName
The name of the new event bus. -
getDeadLetterConfig
Dead Letter Queue for the event bus. -
setDeadLetterConfig
Dead Letter Queue for the event bus. -
setDeadLetterConfig
@Stability(Stable) public void setDeadLetterConfig(@Nullable CfnEventBus.DeadLetterConfigProperty value) Dead Letter Queue for the event bus. -
getDescription
The description of the event bus. -
setDescription
The description of the 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. -
getKmsKeyIdentifier
Kms Key Identifier used to encrypt events at rest in the event bus. -
setKmsKeyIdentifier
Kms Key Identifier used to encrypt events at rest in the event bus. -
getPolicy
The permissions policy of the event bus, describing which other AWS accounts can write events to this event bus. -
setPolicy
The permissions policy of the event bus, describing which other AWS accounts can write events to this event bus. -
getTags
Tags to associate with the event bus. -
setTags
Tags to associate with the event bus.
-