CfnEventSourceProps

class aws_cdk.aws_eventsv2.CfnEventSourceProps(*, configuration, event_bus_arn, name, description=None, tags=None)

Bases: object

Properties for defining a CfnEventSource.

Parameters:

configuration (Union[IResolvable, EventSourceConfigurationProperty, Dict[str, Any]]) – Event source configuration. Exactly one of the two variants must be set.
event_bus_arn (str) – The ARN of the custom event bus the event source forwards onto.
name (str) – The name of the event source. The first character must be alphanumeric; the remaining characters may also include ‘.’, ‘-’, and ‘_’. Names cannot begin with the reserved aws. prefix.
description (Optional[str]) – A description of the event source. Control characters and Unicode line separators are not allowed.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – The tags assigned to the event source.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventsv2-eventsource.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_source_props = eventsv2.CfnEventSourceProps(
    configuration=eventsv2.CfnEventSource.EventSourceConfigurationProperty(
        aws_service_events_configuration=eventsv2.CfnEventSource.AwsServiceEventsConfigurationProperty(
            aws_service="awsService",

            # the properties below are optional
            on_failure_configuration=eventsv2.CfnEventSource.OnFailureConfigurationProperty(
                arn="arn"
            ),
            pattern="pattern"
        ),
        partner_events_configuration=eventsv2.CfnEventSource.PartnerEventsConfigurationProperty(
            partner_event_source_arn="partnerEventSourceArn",

            # the properties below are optional
            on_failure_configuration=eventsv2.CfnEventSource.OnFailureConfigurationProperty(
                arn="arn"
            ),
            partner_bus_kms_key_identifier="partnerBusKmsKeyIdentifier",
            pattern="pattern"
        )
    ),
    event_bus_arn="eventBusArn",
    name="name",

    # the properties below are optional
    description="description",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

configuration

Event source configuration.

Exactly one of the two variants must be set.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventsv2-eventsource.html#cfn-eventsv2-eventsource-configuration

description

A description of the event source.

Control characters and Unicode line separators are not allowed.

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

event_bus_arn

The ARN of the custom event bus the event source forwards onto.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventsv2-eventsource.html#cfn-eventsv2-eventsource-eventbusarn

name

The name of the event source.

The first character must be alphanumeric; the remaining characters may also include ‘.’, ‘-’, and ‘_’. Names cannot begin with the reserved aws. prefix.

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

tags

The tags assigned to the event source.

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