AwsEventbridgeEventBusArgs

interface AwsEventbridgeEventBusArgs extends Omit<aws.cloudwatch.EventBusArgs, 'kmsKeyIdentifier' | 'name'> {
deadLetterConfig?: Input<EventBusDeadLetterConfig | undefined>;
description?: Input<string | undefined>;
eventSourceName?: Input<string | undefined>;
kmsKey?: AwsKmsKeyInput;
logConfig?: Input<EventBusLogConfig | undefined>;
name: string;
policy?: Input<string>;
region?: Input<string | undefined>;
schemaDiscovery?: AwsEventbridgeSchemaDiscoveryArgs;
tags?: Input<{ [key: string]: Input<string> } | undefined>;
}

Input arguments for AwsEventbridgeEventBus.

Remarks

Extends aws.cloudwatch.EventBusArgs with optional fields for attaching a resource-based policy and enabling schema discovery on the event bus.

Example

CODE

const bus = new AwsEventbridgeEventBus({
  name: 'myApp',
  description: 'Application event bus',
  policy: JSON.stringify({
    Version: '2012-10-17',
    Statement: [{
      Sid: 'AllowAccountAccess',
      Effect: 'Allow',
      Principal: { AWS: '000000000000' },
      Action: ['events:PutEvents'],
      Resource: '*',
    }],
  }),
  schemaDiscovery: {
    description: 'Auto-discover event schemas for my-app',
  },
});

Hierarchy

EventBusArgs, "kmsKeyIdentifier" | "name">
AwsEventbridgeEventBusArgs

Properties

`deadLetterConfig: Input<EventBusDeadLetterConfig | undefined>`

Inherited from deadLetterConfig

Configuration details of the Amazon SQS queue for EventBridge to use as a dead-letter queue (DLQ). This block supports the following arguments:

`description: Input<string | undefined>`

Inherited from description

Event bus description.

`eventSourceName: Input<string | undefined>`

Inherited from eventSourceName

Partner event source that the new event bus will be matched with. Must match name.

`kmsKey: AwsKmsKeyInput`

Optional customer-managed KMS key used to encrypt events.

`logConfig: Input<EventBusLogConfig | undefined>`

Inherited from logConfig

Block for logging configuration settings for the event bus.

`name: string`

Required event bus purpose name used in the AWS naming pattern.

`policy: Input<string>`

Optional resource-based policy document (JSON string) to attach to the event bus.

Remarks

When provided, an aws.cloudwatch.EventBusPolicy is created and linked to this event bus. The policy document controls cross-account or cross-service access. Omit this field if no resource-based policy is required.

`region: Input<string | undefined>`

Inherited from region

Region where this resource will be managed. Defaults to the Region set in the provider configuration.

`schemaDiscovery: AwsEventbridgeSchemaDiscoveryArgs`

Optional schema discovery configuration.

Remarks

When provided, an aws.schemas.Discoverer is created and attached to this event bus to automatically discover and register schemas for events flowing through the bus. The discoverer ARN is exposed via AwsEventbridgeEventBus.discovererArn. Omit this field if schema discovery is not required.

`tags: Input<{ [key: string]: Input<string> } | undefined>`

Inherited from tags

Map of tags assigned to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.