Class CfnEventBus
Specifies an event bus within your account.
Inherited Members
Namespace: Amazon.CDK.AWS.Events
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnEventBus : CfnResource, IInspectable, ITaggableV2
Syntax (vb)
Public Class CfnEventBus
Inherits CfnResource
Implements IInspectable, ITaggableV2
Remarks
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 .
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html
CloudformationResource: AWS::Events::EventBus
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Events;
var policy;
var cfnEventBus = new CfnEventBus(this, "MyCfnEventBus", new CfnEventBusProps {
Name = "name",
// the properties below are optional
EventSourceName = "eventSourceName",
Policy = policy,
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnEventBus(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnEventBus(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnEventBus(Construct, String, ICfnEventBusProps) |
Properties
AttrArn | The ARN of the event bus, such as |
AttrName | The name of the event bus, such as |
AttrPolicy | |
CdkTagManager | Tag Manager which manages the tags for this resource. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
EventSourceName | If you are creating a partner event bus, this specifies the partner event source that the new event bus will be matched with. |
Name | The name of the new event bus. |
Policy | The permissions policy of the event bus, describing which other AWS accounts can write events to this event bus. |
Tags | Tags to associate with the event bus. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnEventBus(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnEventBus(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnEventBus(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnEventBus(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnEventBus(Construct, String, ICfnEventBusProps)
public CfnEventBus(Construct scope, string id, ICfnEventBusProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnEventBusProps
Resource properties.
Properties
AttrArn
The ARN of the event bus, such as arn:aws:events:us-east-2:123456789012:event-bus/aws.partner/PartnerName/acct1/repo1
.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Arn
AttrName
The name of the event bus, such as PartnerName/acct1/repo1
.
public virtual string AttrName { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Name
AttrPolicy
public virtual string AttrPolicy { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Policy
CdkTagManager
Tag Manager which manages the tags for this resource.
public virtual TagManager CdkTagManager { get; }
Property Value
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
EventSourceName
If you are creating a partner event bus, this specifies the partner event source that the new event bus will be matched with.
public virtual string EventSourceName { get; set; }
Property Value
System.String
Name
The name of the new event bus.
public virtual string Name { get; set; }
Property Value
System.String
Policy
The permissions policy of the event bus, describing which other AWS accounts can write events to this event bus.
public virtual object Policy { get; set; }
Property Value
System.Object
Tags
Tags to associate with the event bus.
public virtual ICfnTag[] Tags { get; set; }
Property Value
ICfnTag[]
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>