ConfigurationSetEventDestination

class aws_cdk.aws_ses.ConfigurationSetEventDestination(scope, id, *, configuration_set, destination, configuration_set_event_destination_name=None, enabled=None, events=None)

Bases: Resource

A configuration set event destination.

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_ses as ses

# configuration_set: ses.ConfigurationSet
# event_destination: ses.EventDestination

configuration_set_event_destination = ses.ConfigurationSetEventDestination(self, "MyConfigurationSetEventDestination",
    configuration_set=configuration_set,
    destination=event_destination,

    # the properties below are optional
    configuration_set_event_destination_name="configurationSetEventDestinationName",
    enabled=False,
    events=[ses.EmailSendingEvent.SEND]
)
Parameters:

  • scope (Construct) –

  • id (str) –

  • configuration_set (IConfigurationSet) – The configuration set that contains the event destination.

  • destination (EventDestination) – The event destination.

  • configuration_set_event_destination_name (Optional[str]) – A name for the configuration set event destination. Default: - a CloudFormation generated name

  • enabled (Optional[bool]) – Whether Amazon SES publishes events to this destination. Default: true

  • events (Optional[Sequence[EmailSendingEvent]]) – The type of email sending events to publish to the event destination. Default: - send all event types

Methods

apply_removal_policy(policy)

Apply the given removal policy to this resource.

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).

Parameters:

policy (RemovalPolicy) –

Return type:

None

to_string()

Returns a string representation of this construct.

Return type:

str

Attributes

configuration_set_event_destination_id

The ID of the configuration set event destination.

env

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

node

The tree node.

stack

The stack in which this resource is defined.

Static Methods

classmethod from_configuration_set_event_destination_id(scope, id, configuration_set_event_destination_id)

Use an existing configuration set.

Parameters:

  • scope (Construct) –

  • id (str) –

  • configuration_set_event_destination_id (str) –

Return type:

IConfigurationSetEventDestination

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.

classmethod is_owned_resource(construct)

Returns true if the construct was created by CDK, and false otherwise.

Parameters:

construct (IConstruct) –

Return type:

bool

classmethod is_resource(construct)

Check whether the given construct is a Resource.

Parameters:

construct (IConstruct) –

Return type:

bool