CfnEventBusProps

class aws_cdk.aws_eventsv2.CfnEventBusProps(*, name, description=None, encryption_configuration=None, storage_configuration=None, tags=None)

Bases: object

Properties for defining a CfnEventBus.

Parameters:
  • name (str) – The name of the event bus. The first character must be alphanumeric; the remaining characters may also include ‘.’, ‘-’, and ‘_’.

  • description (Optional[str]) – A description of the event bus. Control characters and Unicode line separators are not allowed.

  • encryption_configuration (Union[IResolvable, EncryptionConfigurationProperty, Dict[str, Any], None]) – Encryption configuration for an event bus.

  • storage_configuration (Union[IResolvable, StorageConfigurationProperty, Dict[str, Any], None]) – Storage (retention) configuration for the event bus.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – The tags assigned to the event bus.

See:

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

ExampleMetadata:

fixture=_generated

Example:

from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_eventsv2 as eventsv2

cfn_event_bus_props = eventsv2.CfnEventBusProps(
    name="name",

    # the properties below are optional
    description="description",
    encryption_configuration=eventsv2.CfnEventBus.EncryptionConfigurationProperty(
        kms_key_identifier="kmsKeyIdentifier"
    ),
    storage_configuration=eventsv2.CfnEventBus.StorageConfigurationProperty(
        retention_period_in_days=123
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

description

A description of the event bus.

Control characters and Unicode line separators are not allowed.

See:

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

encryption_configuration

Encryption configuration for an event bus.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventsv2-eventbus.html#cfn-eventsv2-eventbus-encryptionconfiguration

name

The name of the event bus.

The first character must be alphanumeric; the remaining characters may also include ‘.’, ‘-’, and ‘_’.

See:

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

storage_configuration

Storage (retention) configuration for the event bus.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventsv2-eventbus.html#cfn-eventsv2-eventbus-storageconfiguration

tags

The tags assigned to the event bus.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventsv2-eventbus.html#cfn-eventsv2-eventbus-tags