Class CfnEventBus
A CloudFormation AWS::Events::EventBus
.
Inherited Members
Namespace: Amazon.CDK.AWS.Events
Assembly: Amazon.CDK.AWS.Events.dll
Syntax (csharp)
public class CfnEventBus : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnEventBus
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
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.
CloudformationResource: AWS::Events::EventBus
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html
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 cfnEventBus = new CfnEventBus(this, "MyCfnEventBus", new CfnEventBusProps {
Name = "name",
// the properties below are optional
EventSourceName = "eventSourceName",
Tags = new [] { new TagEntryProperty {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnEventBus(Construct, String, ICfnEventBusProps) | Create a new |
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 |
Properties
AttrArn | The ARN of the event bus, such as |
AttrName | The name of the event bus, such as |
AttrPolicy | The policy for the event bus in JSON form. |
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. |
Tags | Tags to associate with the event bus. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnEventBus(Construct, String, ICfnEventBusProps)
Create a new AWS::Events::EventBus
.
public CfnEventBus(Construct scope, string id, ICfnEventBusProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnEventBusProps
- resource properties.
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
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
The policy for the event bus in JSON form.
public virtual string AttrPolicy { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Policy
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
Remarks
Name
The name of the new event bus.
public virtual string Name { get; set; }
Property Value
System.String
Remarks
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.
Tags
Tags to associate with the event bus.
public virtual CfnEventBus.ITagEntryProperty[] Tags { get; set; }
Property Value
CfnEventBus.ITagEntryProperty[]
Remarks
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>