CfnEventSource

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

Bases: CfnResource

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
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 = eventsv2.CfnEventSource(self, "MyCfnEventSource",
    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"
    )]
)

Create a new AWS::EventsV2::EventSource.

Parameters:

scope (Construct) – Scope in which this resource is defined.
id (str) – Construct identifier for this resource (unique in its scope).
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.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:: path (str) – The path of the value to delete.
Return type:: None

add_dependency(target)

(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This method has been renamed to addResourceDependency to more clearly set it apart from construct.node.addDependency. See the documentation of that function for more details.

Parameters:: target (CfnResource)
Deprecated:: Use addResourceDependency instead.
Stability:: deprecated
Return type:: None

add_depends_on(target)

(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

This method has been renamed to addResourceDependency, which makes it more clear that this method operates at a different level from the construct-level construct.node.addDependency() mechanism.

Parameters:: target (CfnResource)
Deprecated:: Use addResourceDependency instead.
Stability:: deprecated
Return type:: None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

key (str)
value (Any)

See:

Return type:

None

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

path (str) –
- The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.
value (Any) –
- The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters:: property_path (str) – The path to the property.
Return type:: None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

property_path (str) – The path of the property.
value (Any) – The value.

Return type:

None

add_resource_dependency(target, reason=None)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

This method only adds dependencies between L1 resources. If you are looking for a generic construct-to-construct dependency mechanism that works for all constructs including L2s, use construct.node.addDependency instead.

Parameters:

target (CfnResource)
reason (Optional[str])

Return type:

None

apply_cross_stack_reference_strength(strength)

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack’s context.

Parameters:

strength (ReferenceStrength) –

The reference strength to use for this resource.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

policy (Optional[RemovalPolicy])
apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true
default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type:

None

cfn_property_name(cdk_property_name)

Parameters:: cdk_property_name (str)
Return type:: Optional[str]

get_att(attribute_name, type_hint=None)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

attribute_name (str) – The name of the attribute.
type_hint (Optional[ResolutionTypeHint])

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:: key (str)
See:
Return type:: Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:: inspector (TreeInspector) – tree inspector to collect and process attributes.
Return type:: None

obtain_dependencies()

Retrieves an array of resources and stacks this resource depends on.

For resources depended on directly, returns the CfnResource object. For dependencies on other stacks, returns the Stack object. The order of the array is not guaranteed.

Return type:: List[Union[Stack, CfnResource]]

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters:: new_logical_id (str) – The new logical ID to use for this stack element.
Return type:: None

remove_dependency(target)

(deprecated) Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:: target (CfnResource)
Deprecated:: Use removeResourceDependency instead
Stability:: deprecated
Return type:: None

remove_resource_dependency(target)

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:: target (CfnResource)
Return type:: None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:

target (CfnResource) – The dependency to replace.
new_target (CfnResource) – The new dependency to add.

Return type:

None

to_string()

Returns a string representation of this construct.

Return type:: str
Returns:: a string representation of this resource

with_(*mixins)

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:: mixins (IMixin)
Return type:: IConstruct

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::EventsV2::EventSource'

attr_creation_time

The time the event source was created, as an ISO 8601 timestamp.

CloudformationAttribute:: CreationTime

attr_event_source_arn

The Amazon Resource Name (ARN) of the event source.

Its resource segment has the form event-sourcev2///. The type segment is set by the service (aws.service for AWS service events, aws.partner for partner events) and is not part of the event source name. The id segment is a 25-character identifier generated by the service.

CloudformationAttribute:: EventSourceArn

attr_last_modified_time

The time the event source was last modified, as an ISO 8601 timestamp.

CloudformationAttribute:: LastModifiedTime

attr_revoked

Whether the event bus owner has revoked this event source.

Revocation is permanent: a revoked event source cannot be updated, but it can be deleted.

CloudformationAttribute:: Revoked

attr_state

CREATING, ACTIVE, UPDATING, CREATE_FAILED, UPDATE_FAILED, DELETING, or DELETE_FAILED.

Revocation by the event bus owner is reported by the Revoked property, not by the state.

CloudformationAttribute:: State
Type:: The lifecycle state of the event source

cdk_tag_manager: Tag Manager which manages the tags for this resource.

cfn_options: Options for this resource, such as condition, update policy etc.

cfn_resource_type: AWS resource type.

configuration: Event source configuration.

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

description: A description of the event source.

env

event_bus_arn: The ARN of the custom event bus the event source forwards onto.

event_source_ref: A reference to a EventSource resource.

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

name: The name of the event source.

node: The tree node.

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

tags: The tags assigned to the event source.

Static Methods

classmethod arn_for_event_source(resource)

Parameters:: resource (IEventSourceRef)
Return type:: str

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:: x (Any)
Return type:: bool
Returns:: The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_event_source(x)

Checks whether the given object is a CfnEventSource.

Parameters:: x (Any)
Return type:: bool

classmethod is_cfn_resource(x)

Check whether the given object is a CfnResource.

Parameters:: x (Any)
Return type:: bool

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

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

AwsServiceEventsConfigurationProperty

class CfnEventSource.AwsServiceEventsConfigurationProperty(*, aws_service, 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 (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 import aws_eventsv2 as eventsv2

aws_service_events_configuration_property = eventsv2.CfnEventSource.AwsServiceEventsConfigurationProperty(
    aws_service="awsService",

    # the properties below are optional
    on_failure_configuration=eventsv2.CfnEventSource.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 CfnEventSource.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 import aws_eventsv2 as eventsv2

event_source_configuration_property = 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"
    )
)

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 CfnEventSource.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 import aws_eventsv2 as eventsv2

on_failure_configuration_property = eventsv2.CfnEventSource.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 CfnEventSource.PartnerEventsConfigurationProperty(*, partner_event_source_arn, on_failure_configuration=None, partner_bus_kms_key_identifier=None, pattern=None)

Bases: object

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

Parameters:

partner_event_source_arn (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.
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.
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 import aws_eventsv2 as eventsv2

partner_events_configuration_property = 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"
)

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