Class CfnEventBus

Specifies an event bus within your account.

Inheritance
object
CfnElement
CfnRefElement
CfnResource
CfnEventBus
Implements
IConstruct
IDependable
Inherited Members
Namespace: Amazon.CDK.AWS.Events
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnEventBus : CfnResource, IInspectable, IEventBusRef, IConstruct, IDependable, IEnvironmentAware, ITaggableV2
Syntax (vb)
Public Class CfnEventBus Inherits CfnResource Implements IInspectable, IEventBusRef, IConstruct, IDependable, IEnvironmentAware, 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 <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-generate-event-bus-template.html">Generating CloudFormation templates from an EventBridge event bus</a> in the <em>Amazon EventBridge User Guide</em> .

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
                 DeadLetterConfig = new DeadLetterConfigProperty {
                     Arn = "arn"
                 },
                 Description = "description",
                 EventSourceName = "eventSourceName",
                 KmsKeyIdentifier = "kmsKeyIdentifier",
                 LogConfig = new LogConfigProperty {
                     IncludeDetail = "includeDetail",
                     Level = "level"
                 },
                 Policy = policy,
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             });

Synopsis

Constructors

CfnEventBus(Construct, string, ICfnEventBusProps)

Create a new AWS::Events::EventBus.

Properties

AttrArn

The ARN of the event bus, such as arn:aws:events:us-east-2:123456789012:event-bus/aws.partner/PartnerName/acct1/repo1 .
AttrName

The name of the event bus, such as PartnerName/acct1/repo1 .
AttrPolicy

Specifies an event bus within your account.
CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.
CdkTagManager

Tag Manager which manages the tags for this resource.
CfnProperties

Specifies an event bus within your account.
DeadLetterConfig

Configuration details of the Amazon SQS queue for EventBridge to use as a dead-letter queue (DLQ).
Description

The event bus description.
EventBusRef

A reference to a EventBus resource.
EventSourceName

If you are creating a partner event bus, this specifies the partner event source that the new event bus will be matched with.
KmsKeyIdentifier

The identifier of the AWS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt events on this event bus.
LogConfig

The logging configuration settings for the event bus.
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

ArnForEventBus(IEventBusRef)

Specifies an event bus within your account.
FromEventBusArn(Construct, string, string)

Creates a new IEventBusRef from an ARN.
FromEventBusName(Construct, string, string)

Creates a new IEventBusRef from a eventBusName.
Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.
IsCfnEventBus(object)

Checks whether the given object is a CfnEventBus.
RenderProperties(IDictionary<string, object>)

Specifies an event bus within your account.

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 string

Construct identifier for this resource (unique in its scope).

props ICfnEventBusProps

Resource properties.

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 <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-generate-event-bus-template.html">Generating CloudFormation templates from an EventBridge event bus</a> in the <em>Amazon EventBridge User Guide</em> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html

CloudformationResource: AWS::Events::EventBus

ExampleMetadata: fixture=_generated

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

string

Remarks

CloudformationAttribute: Arn

AttrName

The name of the event bus, such as PartnerName/acct1/repo1 .

public virtual string AttrName { get; }
Property Value

string

Remarks

CloudformationAttribute: Name

AttrPolicy

Specifies an event bus within your account.

public virtual string AttrPolicy { get; }
Property Value

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

string

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 <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-generate-event-bus-template.html">Generating CloudFormation templates from an EventBridge event bus</a> in the <em>Amazon EventBridge User Guide</em> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html

CloudformationResource: AWS::Events::EventBus

ExampleMetadata: fixture=_generated

CdkTagManager

Tag Manager which manages the tags for this resource.

public virtual TagManager CdkTagManager { get; }
Property Value

TagManager

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 <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-generate-event-bus-template.html">Generating CloudFormation templates from an EventBridge event bus</a> in the <em>Amazon EventBridge User Guide</em> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html

CloudformationResource: AWS::Events::EventBus

ExampleMetadata: fixture=_generated

CfnProperties

Specifies an event bus within your account.

protected override IDictionary<string, object> CfnProperties { get; }
Property Value

IDictionary<string, object>

Overrides
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 <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-generate-event-bus-template.html">Generating CloudFormation templates from an EventBridge event bus</a> in the <em>Amazon EventBridge User Guide</em> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html

CloudformationResource: AWS::Events::EventBus

ExampleMetadata: fixture=_generated

DeadLetterConfig

Configuration details of the Amazon SQS queue for EventBridge to use as a dead-letter queue (DLQ).

public virtual object? DeadLetterConfig { get; set; }
Property Value

object

Remarks

Type union: either IResolvable or CfnEventBus.IDeadLetterConfigProperty

Description

The event bus description.

public virtual string? Description { get; set; }
Property Value

string

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 <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-generate-event-bus-template.html">Generating CloudFormation templates from an EventBridge event bus</a> in the <em>Amazon EventBridge User Guide</em> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html

CloudformationResource: AWS::Events::EventBus

ExampleMetadata: fixture=_generated

EventBusRef

A reference to a EventBus resource.

public virtual IEventBusReference EventBusRef { get; }
Property Value

IEventBusReference

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 <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-generate-event-bus-template.html">Generating CloudFormation templates from an EventBridge event bus</a> in the <em>Amazon EventBridge User Guide</em> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html

CloudformationResource: AWS::Events::EventBus

ExampleMetadata: fixture=_generated

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

string

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 <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-generate-event-bus-template.html">Generating CloudFormation templates from an EventBridge event bus</a> in the <em>Amazon EventBridge User Guide</em> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html

CloudformationResource: AWS::Events::EventBus

ExampleMetadata: fixture=_generated

KmsKeyIdentifier

The identifier of the AWS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt events on this event bus.

public virtual string? KmsKeyIdentifier { get; set; }
Property Value

string

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 <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-generate-event-bus-template.html">Generating CloudFormation templates from an EventBridge event bus</a> in the <em>Amazon EventBridge User Guide</em> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html

CloudformationResource: AWS::Events::EventBus

ExampleMetadata: fixture=_generated

LogConfig

The logging configuration settings for the event bus.

public virtual object? LogConfig { get; set; }
Property Value

object

Remarks

Type union: either IResolvable or CfnEventBus.ILogConfigProperty

Name

The name of the new event bus.

public virtual string Name { get; set; }
Property Value

string

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 <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-generate-event-bus-template.html">Generating CloudFormation templates from an EventBridge event bus</a> in the <em>Amazon EventBridge User Guide</em> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html

CloudformationResource: AWS::Events::EventBus

ExampleMetadata: fixture=_generated

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

object

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 <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-generate-event-bus-template.html">Generating CloudFormation templates from an EventBridge event bus</a> in the <em>Amazon EventBridge User Guide</em> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html

CloudformationResource: AWS::Events::EventBus

ExampleMetadata: fixture=_generated

Tags

Tags to associate with the event bus.

public virtual ICfnTag[]? Tags { get; set; }
Property Value

ICfnTag[]

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 <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-generate-event-bus-template.html">Generating CloudFormation templates from an EventBridge event bus</a> in the <em>Amazon EventBridge User Guide</em> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html

CloudformationResource: AWS::Events::EventBus

ExampleMetadata: fixture=_generated

Methods

ArnForEventBus(IEventBusRef)

Specifies an event bus within your account.

public static string ArnForEventBus(IEventBusRef resource)
Parameters
resource IEventBusRef
Returns

string

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 <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-generate-event-bus-template.html">Generating CloudFormation templates from an EventBridge event bus</a> in the <em>Amazon EventBridge User Guide</em> .

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
                 DeadLetterConfig = new DeadLetterConfigProperty {
                     Arn = "arn"
                 },
                 Description = "description",
                 EventSourceName = "eventSourceName",
                 KmsKeyIdentifier = "kmsKeyIdentifier",
                 LogConfig = new LogConfigProperty {
                     IncludeDetail = "includeDetail",
                     Level = "level"
                 },
                 Policy = policy,
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             });

FromEventBusArn(Construct, string, string)

Creates a new IEventBusRef from an ARN.

public static IEventBusRef FromEventBusArn(Construct scope, string id, string arn)
Parameters
scope Construct
id string
arn string
Returns

IEventBusRef

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 <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-generate-event-bus-template.html">Generating CloudFormation templates from an EventBridge event bus</a> in the <em>Amazon EventBridge User Guide</em> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html

CloudformationResource: AWS::Events::EventBus

ExampleMetadata: fixture=_generated

FromEventBusName(Construct, string, string)

Creates a new IEventBusRef from a eventBusName.

public static IEventBusRef FromEventBusName(Construct scope, string id, string eventBusName)
Parameters
scope Construct
id string
eventBusName string
Returns

IEventBusRef

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 <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-generate-event-bus-template.html">Generating CloudFormation templates from an EventBridge event bus</a> in the <em>Amazon EventBridge User Guide</em> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html

CloudformationResource: AWS::Events::EventBus

ExampleMetadata: fixture=_generated

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.

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 <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-generate-event-bus-template.html">Generating CloudFormation templates from an EventBridge event bus</a> in the <em>Amazon EventBridge User Guide</em> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html

CloudformationResource: AWS::Events::EventBus

ExampleMetadata: fixture=_generated

IsCfnEventBus(object)

Checks whether the given object is a CfnEventBus.

public static bool IsCfnEventBus(object x)
Parameters
x object
Returns

bool

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 <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-generate-event-bus-template.html">Generating CloudFormation templates from an EventBridge event bus</a> in the <em>Amazon EventBridge User Guide</em> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html

CloudformationResource: AWS::Events::EventBus

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

Specifies an event bus within your account.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
props IDictionary<string, object>
Returns

IDictionary<string, object>

Overrides
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 <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-generate-event-bus-template.html">Generating CloudFormation templates from an EventBridge event bus</a> in the <em>Amazon EventBridge User Guide</em> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html

CloudformationResource: AWS::Events::EventBus

ExampleMetadata: fixture=_generated

Implements

Constructs.IConstruct
Constructs.IDependable