@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-22T19:35:41.105Z") public class CfnEventBus extends CfnResource implements IInspectable
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();
Modifier and Type | Class and Description |
---|---|
static class |
CfnEventBus.Builder
A fluent builder for
CfnEventBus . |
static interface |
CfnEventBus.TagEntryProperty
A key-value pair associated with an AWS resource.
|
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
Modifier | Constructor and Description |
---|---|
|
CfnEventBus(Construct scope,
java.lang.String id,
CfnEventBusProps props)
Create a new `AWS::Events::EventBus`.
|
protected |
CfnEventBus(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
CfnEventBus(software.amazon.jsii.JsiiObjectRef objRef) |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getAttrArn()
The ARN of the event bus, such as `arn:aws:events:us-east-2:123456789012:event-bus/aws.partner/PartnerName/acct1/repo1` .
|
java.lang.String |
getAttrName()
The name of the event bus, such as `PartnerName/acct1/repo1` .
|
java.lang.String |
getAttrPolicy()
The policy for the event bus in JSON form.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.lang.String |
getEventSourceName()
If you are creating a partner event bus, this specifies the partner event source that the new event bus will be matched with.
|
java.lang.String |
getName()
The name of the new event bus.
|
java.util.List<CfnEventBus.TagEntryProperty> |
getTags()
Tags to associate with the event bus.
|
void |
inspect(TreeInspector inspector)
Examines the CloudFormation resource and discloses attributes.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
renderProperties(java.util.Map<java.lang.String,java.lang.Object> props) |
void |
setEventSourceName(java.lang.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 |
setName(java.lang.String value)
The name of the new event bus.
|
void |
setTags(java.util.List<CfnEventBus.TagEntryProperty> value)
Tags to associate with the event bus.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnEventBus(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnEventBus(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnEventBus(Construct scope, java.lang.String id, CfnEventBusProps props)
scope
- - scope in which this resource is defined. This parameter is required.id
- - scoped id of the resource. This parameter is required.props
- - resource properties. This parameter is required.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.public java.lang.String getAttrArn()
public java.lang.String getAttrName()
public java.lang.String getAttrPolicy()
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public java.lang.String getName()
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.
public void setName(java.lang.String value)
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.
public java.lang.String getEventSourceName()
public void setEventSourceName(java.lang.String value)
public java.util.List<CfnEventBus.TagEntryProperty> getTags()
public void setTags(java.util.List<CfnEventBus.TagEntryProperty> value)