Interface ICfnEventBusProps

Properties for defining a CfnEventBus.

Namespace: Amazon.CDK.AWS.Events

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface ICfnEventBusProps

Syntax (vb)

Public Interface ICfnEventBusProps

Remarks

See: 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 policy;

             var cfnEventBusProps = 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

Properties

DeadLetterConfig	Configuration details of the Amazon SQS queue for EventBridge to use as a dead-letter queue (DLQ).
Description	The event bus description.
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.

Properties

DeadLetterConfig

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

object? DeadLetterConfig { get; }

Property Value

object

Remarks

For more information, see Using dead-letter queues to process undelivered events in the EventBridge User Guide .

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

Type union: either IResolvable or CfnEventBus.IDeadLetterConfigProperty

Description

The event bus description.

string? Description { get; }

Property Value

string

Remarks

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

EventSourceName

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

string? EventSourceName { get; }

Property Value

string

Remarks

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

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.

string? KmsKeyIdentifier { get; }

Property Value

string

Remarks

The identifier can be the key Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN.

If you do not specify a customer managed key identifier, EventBridge uses an AWS owned key to encrypt events on the event bus.

For more information, see Identify and view keys in the AWS Key Management Service Developer Guide .

Schema discovery is not supported for event buses encrypted using a customer managed key. EventBridge returns an error if:

To enable schema discovery on an event bus, choose to use an AWS owned key . For more information, see Encrypting events in the Amazon EventBridge User Guide . > If you have specified that EventBridge use a customer managed key for encrypting the source event bus, we strongly recommend you also specify a customer managed key for any archives for the event bus as well.

For more information, see Encrypting archives in the Amazon EventBridge User Guide .

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

LogConfig

The logging configuration settings for the event bus.

object? LogConfig { get; }

Property Value

object

Remarks

For more information, see Configuring logs for event buses in the EventBridge User Guide .

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

Type union: either IResolvable or CfnEventBus.ILogConfigProperty

Name

The name of the new event bus.

string Name { get; }

Property Value

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.

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

Policy

The permissions policy of the event bus, describing which other AWS accounts can write events to this event bus.

object? Policy { get; }

Property Value

object

Remarks

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