CfnEventBusPropsMixin

class aws_cdk.cfn_property_mixins.aws_eventsv2.CfnEventBusPropsMixin(props, *, strategy=None)

Bases: Mixin

Resource type definition for AWS::EventsV2::EventBus, an Amazon EventBridge custom event bus that receives events and delivers them to matching subscribers.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventsv2-eventbus.html
CloudformationResource:: AWS::EventsV2::EventBus
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

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

# merge_strategy: cdk.IMergeStrategy

cfn_event_bus_props_mixin = eventsv2.CfnEventBusPropsMixin(eventsv2.CfnEventBusMixinProps(
    description="description",
    encryption_configuration=eventsv2.CfnEventBusPropsMixin.EncryptionConfigurationProperty(
        kms_key_identifier="kmsKeyIdentifier"
    ),
    name="name",
    storage_configuration=eventsv2.CfnEventBusPropsMixin.StorageConfigurationProperty(
        retention_period_in_days=123
    ),
    tags=[cdk.CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=merge_strategy
)

Create a mixin to apply properties to AWS::EventsV2::EventBus.

Parameters:

props (Union[CfnEventBusMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[IMergeStrategy]) – Strategy for merging nested properties. Default: - PropertyMergeStrategy.combine()

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: None

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['description', 'encryptionConfiguration', 'name', 'storageConfiguration', 'tags']

Static Methods

classmethod is_mixin(x)

Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.

EncryptionConfigurationProperty

class CfnEventBusPropsMixin.EncryptionConfigurationProperty(*, kms_key_identifier=None)

Bases: object

Encryption configuration for an event bus.

Parameters:: kms_key_identifier (Optional[str]) – The identifier of the AWS KMS customer managed key that the event bus uses to encrypt events. You can specify the key ARN, key ID, alias name, or alias ARN. If you do not specify a key, EventBridge uses an AWS owned key.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eventsv2-eventbus-encryptionconfiguration.html
ExampleMetadata:: fixture=_generated

Example:

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

encryption_configuration_property = eventsv2.CfnEventBusPropsMixin.EncryptionConfigurationProperty(
    kms_key_identifier="kmsKeyIdentifier"
)

Attributes

kms_key_identifier

The identifier of the AWS KMS customer managed key that the event bus uses to encrypt events.

You can specify the key ARN, key ID, alias name, or alias ARN. If you do not specify a key, EventBridge uses an AWS owned key.

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

StorageConfigurationProperty

class CfnEventBusPropsMixin.StorageConfigurationProperty(*, retention_period_in_days=None)

Bases: object

Storage (retention) configuration for the event bus.

Parameters:: retention_period_in_days (Union[int, float, None]) – The number of days events are retained on the event bus for replay, 1-365.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eventsv2-eventbus-storageconfiguration.html
ExampleMetadata:: fixture=_generated

Example:

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

storage_configuration_property = eventsv2.CfnEventBusPropsMixin.StorageConfigurationProperty(
    retention_period_in_days=123
)

Attributes

retention_period_in_days

The number of days events are retained on the event bus for replay, 1-365.

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