CfnEventSourcePropsMixin

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

Bases: Mixin

Resource schema for AWS::EventsV2::EventSource.

A managed event source that forwards AWS service events or partner events onto a custom event bus.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventsv2-eventsource.html
CloudformationResource:: AWS::EventsV2::EventSource
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_source_props_mixin = eventsv2.CfnEventSourcePropsMixin(eventsv2.CfnEventSourceMixinProps(
    configuration=eventsv2.CfnEventSourcePropsMixin.EventSourceConfigurationProperty(
        aws_service_events_configuration=eventsv2.CfnEventSourcePropsMixin.AwsServiceEventsConfigurationProperty(
            aws_service="awsService",
            on_failure_configuration=eventsv2.CfnEventSourcePropsMixin.OnFailureConfigurationProperty(
                arn="arn"
            ),
            pattern="pattern"
        ),
        partner_events_configuration=eventsv2.CfnEventSourcePropsMixin.PartnerEventsConfigurationProperty(
            on_failure_configuration=eventsv2.CfnEventSourcePropsMixin.OnFailureConfigurationProperty(
                arn="arn"
            ),
            partner_bus_kms_key_identifier="partnerBusKmsKeyIdentifier",
            partner_event_source_arn="partnerEventSourceArn",
            pattern="pattern"
        )
    ),
    description="description",
    event_bus_arn="eventBusArn",
    name="name",
    tags=[cdk.CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=merge_strategy
)

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

Parameters:

props (Union[CfnEventSourceMixinProps, 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 = ['configuration', 'description', 'eventBusArn', 'name', '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.

AwsServiceEventsConfigurationProperty

class CfnEventSourcePropsMixin.AwsServiceEventsConfigurationProperty(*, aws_service=None, on_failure_configuration=None, pattern=None)

Bases: object

Forward a single AWS service’s events from the account’s default event bus.

Parameters:

aws_service (Optional[str]) – A single AWS service source identifier, for example aws.s3. Wildcards and lists are not allowed.
on_failure_configuration (Union[IResolvable, OnFailureConfigurationProperty, Dict[str, Any], None]) – The destination for events that could not be forwarded by the managed forwarding target or, for partner event sources, the managed partner event bus. Arn is optional. An empty object removes a configured destination on update.
pattern (Optional[str]) – A filter pattern, as a JSON string, that defines which events from the specified AWS service are forwarded to the event bus. Do not include source, account, or region as top-level fields. If you do not specify a pattern, all events from the service are forwarded.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eventsv2-eventsource-awsserviceeventsconfiguration.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

aws_service_events_configuration_property = eventsv2.CfnEventSourcePropsMixin.AwsServiceEventsConfigurationProperty(
    aws_service="awsService",
    on_failure_configuration=eventsv2.CfnEventSourcePropsMixin.OnFailureConfigurationProperty(
        arn="arn"
    ),
    pattern="pattern"
)

Attributes

aws_service

A single AWS service source identifier, for example aws.s3. Wildcards and lists are not allowed.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eventsv2-eventsource-awsserviceeventsconfiguration.html#cfn-eventsv2-eventsource-awsserviceeventsconfiguration-awsservice

on_failure_configuration

The destination for events that could not be forwarded by the managed forwarding target or, for partner event sources, the managed partner event bus.

Arn is optional. An empty object removes a configured destination on update.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eventsv2-eventsource-awsserviceeventsconfiguration.html#cfn-eventsv2-eventsource-awsserviceeventsconfiguration-onfailureconfiguration

pattern

A filter pattern, as a JSON string, that defines which events from the specified AWS service are forwarded to the event bus.

Do not include source, account, or region as top-level fields. If you do not specify a pattern, all events from the service are forwarded.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eventsv2-eventsource-awsserviceeventsconfiguration.html#cfn-eventsv2-eventsource-awsserviceeventsconfiguration-pattern

EventSourceConfigurationProperty

class CfnEventSourcePropsMixin.EventSourceConfigurationProperty(*, aws_service_events_configuration=None, partner_events_configuration=None)

Bases: object

Event source configuration.

Exactly one of the two variants must be set.

Parameters:

aws_service_events_configuration (Union[IResolvable, AwsServiceEventsConfigurationProperty, Dict[str, Any], None]) – Forward a single AWS service’s events from the account’s default event bus.
partner_events_configuration (Union[IResolvable, PartnerEventsConfigurationProperty, Dict[str, Any], None]) – Forward a partner event source’s events through a managed partner event bus.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eventsv2-eventsource-eventsourceconfiguration.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

event_source_configuration_property = eventsv2.CfnEventSourcePropsMixin.EventSourceConfigurationProperty(
    aws_service_events_configuration=eventsv2.CfnEventSourcePropsMixin.AwsServiceEventsConfigurationProperty(
        aws_service="awsService",
        on_failure_configuration=eventsv2.CfnEventSourcePropsMixin.OnFailureConfigurationProperty(
            arn="arn"
        ),
        pattern="pattern"
    ),
    partner_events_configuration=eventsv2.CfnEventSourcePropsMixin.PartnerEventsConfigurationProperty(
        on_failure_configuration=eventsv2.CfnEventSourcePropsMixin.OnFailureConfigurationProperty(
            arn="arn"
        ),
        partner_bus_kms_key_identifier="partnerBusKmsKeyIdentifier",
        partner_event_source_arn="partnerEventSourceArn",
        pattern="pattern"
    )
)

Attributes

aws_service_events_configuration

Forward a single AWS service’s events from the account’s default event bus.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eventsv2-eventsource-eventsourceconfiguration.html#cfn-eventsv2-eventsource-eventsourceconfiguration-awsserviceeventsconfiguration

partner_events_configuration

Forward a partner event source’s events through a managed partner event bus.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eventsv2-eventsource-eventsourceconfiguration.html#cfn-eventsv2-eventsource-eventsourceconfiguration-partnereventsconfiguration

OnFailureConfigurationProperty

class CfnEventSourcePropsMixin.OnFailureConfigurationProperty(*, arn=None)

Bases: object

The destination for events that could not be forwarded by the managed forwarding target or, for partner event sources, the managed partner event bus.

Arn is optional. An empty object removes a configured destination on update.

Parameters:: arn (Optional[str]) – The ARN of the Amazon SQS standard queue that receives events that could not be forwarded. FIFO queues are not supported.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eventsv2-eventsource-onfailureconfiguration.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

on_failure_configuration_property = eventsv2.CfnEventSourcePropsMixin.OnFailureConfigurationProperty(
    arn="arn"
)

Attributes

arn

The ARN of the Amazon SQS standard queue that receives events that could not be forwarded.

FIFO queues are not supported.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eventsv2-eventsource-onfailureconfiguration.html#cfn-eventsv2-eventsource-onfailureconfiguration-arn

PartnerEventsConfigurationProperty

class CfnEventSourcePropsMixin.PartnerEventsConfigurationProperty(*, on_failure_configuration=None, partner_bus_kms_key_identifier=None, partner_event_source_arn=None, pattern=None)

Bases: object

Forward a partner event source’s events through a managed partner event bus.

Parameters:

on_failure_configuration (Union[IResolvable, OnFailureConfigurationProperty, Dict[str, Any], None]) – The destination for events that could not be forwarded by the managed forwarding target or, for partner event sources, the managed partner event bus. Arn is optional. An empty object removes a configured destination on update.
partner_bus_kms_key_identifier (Optional[str]) – The identifier of the AWS KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt events on the managed partner event bus. 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.
partner_event_source_arn (Optional[str]) – The ARN of the partner event source to forward. The partner owns the event source, so the ARN’s account segment is empty. Changing this property replaces the event source. Because Name and EventBusArn together identify an event source, and the replacement is created before the old resource is deleted, change Name in the same update.
pattern (Optional[str]) – A filter pattern, as a JSON string, that defines which events from the specified partner event source are forwarded to the event bus. If you do not specify a pattern, all events from the partner event source are forwarded.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eventsv2-eventsource-partnereventsconfiguration.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

partner_events_configuration_property = eventsv2.CfnEventSourcePropsMixin.PartnerEventsConfigurationProperty(
    on_failure_configuration=eventsv2.CfnEventSourcePropsMixin.OnFailureConfigurationProperty(
        arn="arn"
    ),
    partner_bus_kms_key_identifier="partnerBusKmsKeyIdentifier",
    partner_event_source_arn="partnerEventSourceArn",
    pattern="pattern"
)

Attributes

on_failure_configuration

The destination for events that could not be forwarded by the managed forwarding target or, for partner event sources, the managed partner event bus.

Arn is optional. An empty object removes a configured destination on update.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eventsv2-eventsource-partnereventsconfiguration.html#cfn-eventsv2-eventsource-partnereventsconfiguration-onfailureconfiguration

partner_bus_kms_key_identifier

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

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.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eventsv2-eventsource-partnereventsconfiguration.html#cfn-eventsv2-eventsource-partnereventsconfiguration-partnerbuskmskeyidentifier

partner_event_source_arn

The ARN of the partner event source to forward.

The partner owns the event source, so the ARN’s account segment is empty. Changing this property replaces the event source. Because Name and EventBusArn together identify an event source, and the replacement is created before the old resource is deleted, change Name in the same update.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eventsv2-eventsource-partnereventsconfiguration.html#cfn-eventsv2-eventsource-partnereventsconfiguration-partnereventsourcearn

pattern

A filter pattern, as a JSON string, that defines which events from the specified partner event source are forwarded to the event bus.

If you do not specify a pattern, all events from the partner event source are forwarded.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eventsv2-eventsource-partnereventsconfiguration.html#cfn-eventsv2-eventsource-partnereventsconfiguration-pattern