CfnConfigurationSetEventDestination¶
-
class
aws_cdk.aws_ses.
CfnConfigurationSetEventDestination
(scope, id, *, configuration_set_name, event_destination)¶ Bases:
aws_cdk.core.CfnResource
A CloudFormation
AWS::SES::ConfigurationSetEventDestination
.Specifies a configuration set event destination. An event destination is an AWS service that Amazon SES publishes email sending events to. When you specify an event destination, you provide one, and only one, destination. You can send event data to Amazon CloudWatch or Amazon Kinesis Data Firehose. .. epigraph:
You can't specify Amazon SNS event destinations in CloudFormation templates.
- CloudformationResource
AWS::SES::ConfigurationSetEventDestination
- Link
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_ses as ses cfn_configuration_set_event_destination = ses.CfnConfigurationSetEventDestination(self, "MyCfnConfigurationSetEventDestination", configuration_set_name="configurationSetName", event_destination=ses.CfnConfigurationSetEventDestination.EventDestinationProperty( matching_event_types=["matchingEventTypes"], # the properties below are optional cloud_watch_destination=ses.CfnConfigurationSetEventDestination.CloudWatchDestinationProperty( dimension_configurations=[ses.CfnConfigurationSetEventDestination.DimensionConfigurationProperty( default_dimension_value="defaultDimensionValue", dimension_name="dimensionName", dimension_value_source="dimensionValueSource" )] ), enabled=False, kinesis_firehose_destination=ses.CfnConfigurationSetEventDestination.KinesisFirehoseDestinationProperty( delivery_stream_arn="deliveryStreamArn", iam_role_arn="iamRoleArn" ), name="name" ) )
Create a new
AWS::SES::ConfigurationSetEventDestination
.- Parameters
scope (
Construct
) –scope in which this resource is defined.
id (
str
) –scoped id of the resource.
configuration_set_name (
str
) – The name of the configuration set that contains the event destination.event_destination (
Union
[EventDestinationProperty
,IResolvable
]) – The event destination object.
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_depends_on
(target)¶ 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.
- Parameters
target (
CfnResource
) –- Return type
None
-
add_metadata
(key, value)¶ Add a value to the CloudFormation Resource Metadata.
- Parameters
key (
str
) –value (
Any
) –
- See
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.
- Return type
None
-
add_override
(path, value)¶ Adds an override to the synthesized CloudFormation resource.
To add a property override, either use
addPropertyOverride
or prefixpath
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 toaddOverride
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 intermdediate 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
-
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
).- Parameters
policy (
Optional
[RemovalPolicy
]) –apply_to_update_replace_policy (
Optional
[bool
]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: truedefault (
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 resoure, please consult that specific resource’s documentation.
- Return type
None
-
get_att
(attribute_name)¶ 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.- Return type
-
get_metadata
(key)¶ Retrieve a value value from the CloudFormation Resource Metadata.
- Parameters
key (
str
) –- See
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.
- Return type
Any
-
inspect
(inspector)¶ Examines the CloudFormation resource and discloses attributes.
- Parameters
inspector (
TreeInspector
) –tree inspector to collect and process attributes.
- Return type
None
-
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
-
to_string
()¶ Returns a string representation of this construct.
- Return type
str
- Returns
a string representation of this resource
Attributes
-
CFN_RESOURCE_TYPE_NAME
= 'AWS::SES::ConfigurationSetEventDestination'¶
-
attr_id
¶ Id
- Type
cloudformationAttribute
- Return type
str
-
cfn_options
¶ Options for this resource, such as condition, update policy etc.
- Return type
-
cfn_resource_type
¶ AWS resource type.
- Return type
str
-
configuration_set_name
¶ The name of the configuration set that contains the event destination.
-
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.
- Return type
List
[str
]
-
event_destination
¶ The event destination object.
-
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)
.- Return type
str
- Returns
the logical ID as a stringified token. This value will only get resolved during synthesis.
-
node
¶ The construct tree node associated with this construct.
- Return type
-
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 })
.- Return type
str
-
stack
¶ The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
- Return type
Static Methods
-
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_resource
(construct)¶ Check whether the given construct is a CfnResource.
- Parameters
construct (
IConstruct
) –- Return type
bool
-
classmethod
is_construct
(x)¶ Return whether the given object is a Construct.
- Parameters
x (
Any
) –- Return type
bool
CloudWatchDestinationProperty¶
-
class
CfnConfigurationSetEventDestination.
CloudWatchDestinationProperty
(*, dimension_configurations=None)¶ Bases:
object
Contains information associated with an Amazon CloudWatch event destination to which email sending events are published.
Event destinations, such as Amazon CloudWatch, are associated with configuration sets, which enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide .
- Parameters
dimension_configurations (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,DimensionConfigurationProperty
]],None
]) – A list of dimensions upon which to categorize your emails when you publish email sending events to Amazon CloudWatch.- Link
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_ses as ses cloud_watch_destination_property = ses.CfnConfigurationSetEventDestination.CloudWatchDestinationProperty( dimension_configurations=[ses.CfnConfigurationSetEventDestination.DimensionConfigurationProperty( default_dimension_value="defaultDimensionValue", dimension_name="dimensionName", dimension_value_source="dimensionValueSource" )] )
Attributes
-
dimension_configurations
¶ A list of dimensions upon which to categorize your emails when you publish email sending events to Amazon CloudWatch.
- Link
- Return type
Union
[IResolvable
,List
[Union
[IResolvable
,DimensionConfigurationProperty
]],None
]
DimensionConfigurationProperty¶
-
class
CfnConfigurationSetEventDestination.
DimensionConfigurationProperty
(*, default_dimension_value, dimension_name, dimension_value_source)¶ Bases:
object
Contains the dimension configuration to use when you publish email sending events to Amazon CloudWatch.
For information about publishing email sending events to Amazon CloudWatch, see the Amazon SES Developer Guide .
- Parameters
default_dimension_value (
str
) – The default value of the dimension that is published to Amazon CloudWatch if you do not provide the value of the dimension when you send an email. The default value must meet the following requirements: - Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), dashes (-), at signs (@), or periods (.). - Contain 256 characters or fewer.dimension_name (
str
) – The name of an Amazon CloudWatch dimension associated with an email sending metric. The name must meet the following requirements: - Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), dashes (-), or colons (:). - Contain 256 characters or fewer.dimension_value_source (
str
) – The place where Amazon SES finds the value of a dimension to publish to Amazon CloudWatch. To use the message tags that you specify using anX-SES-MESSAGE-TAGS
header or a parameter to theSendEmail
/SendRawEmail
API, specifymessageTag
. To use your own email headers, specifyemailHeader
. To put a custom tag on any link included in your email, specifylinkTag
.
- Link
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_ses as ses dimension_configuration_property = ses.CfnConfigurationSetEventDestination.DimensionConfigurationProperty( default_dimension_value="defaultDimensionValue", dimension_name="dimensionName", dimension_value_source="dimensionValueSource" )
Attributes
-
default_dimension_value
¶ The default value of the dimension that is published to Amazon CloudWatch if you do not provide the value of the dimension when you send an email.
The default value must meet the following requirements:
Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), dashes (-), at signs (@), or periods (.).
Contain 256 characters or fewer.
-
dimension_name
¶ The name of an Amazon CloudWatch dimension associated with an email sending metric.
The name must meet the following requirements:
Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), dashes (-), or colons (:).
Contain 256 characters or fewer.
-
dimension_value_source
¶ The place where Amazon SES finds the value of a dimension to publish to Amazon CloudWatch.
To use the message tags that you specify using an
X-SES-MESSAGE-TAGS
header or a parameter to theSendEmail
/SendRawEmail
API, specifymessageTag
. To use your own email headers, specifyemailHeader
. To put a custom tag on any link included in your email, specifylinkTag
.
EventDestinationProperty¶
-
class
CfnConfigurationSetEventDestination.
EventDestinationProperty
(*, matching_event_types, cloud_watch_destination=None, enabled=None, kinesis_firehose_destination=None, name=None)¶ Bases:
object
Contains information about an event destination.
When you create or update an event destination, you must provide one, and only one, destination. The destination can be Amazon CloudWatch, Amazon Kinesis Firehose or Amazon Simple Notification Service (Amazon SNS).
Event destinations are associated with configuration sets, which enable you to publish email sending events to Amazon CloudWatch, Amazon Kinesis Firehose, or Amazon Simple Notification Service (Amazon SNS). For information about using configuration sets, see the Amazon SES Developer Guide .
- Parameters
matching_event_types (
Sequence
[str
]) – The type of email sending events to publish to the event destination. -send
- The call was successful and Amazon SES is attempting to deliver the email. -reject
- Amazon SES determined that the email contained a virus and rejected it. -bounce
- The recipient’s mail server permanently rejected the email. This corresponds to a hard bounce. -complaint
- The recipient marked the email as spam. -delivery
- Amazon SES successfully delivered the email to the recipient’s mail server. -open
- The recipient received the email and opened it in their email client. -click
- The recipient clicked one or more links in the email. -renderingFailure
- Amazon SES did not send the email because of a template rendering issue.cloud_watch_destination (
Union
[IResolvable
,CloudWatchDestinationProperty
,None
]) – An object that contains the names, default values, and sources of the dimensions associated with an Amazon CloudWatch event destination.enabled (
Union
[bool
,IResolvable
,None
]) – Sets whether Amazon SES publishes events to this destination when you send an email with the associated configuration set. Set totrue
to enable publishing to this destination; set tofalse
to prevent publishing to this destination. The default value isfalse
.kinesis_firehose_destination (
Union
[IResolvable
,KinesisFirehoseDestinationProperty
,None
]) – An object that contains the delivery stream ARN and the IAM role ARN associated with an Amazon Kinesis Firehose event destination.name (
Optional
[str
]) – The name of the event destination. The name must meet the following requirements:. - Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). - Contain 64 characters or fewer.
- Link
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_ses as ses event_destination_property = ses.CfnConfigurationSetEventDestination.EventDestinationProperty( matching_event_types=["matchingEventTypes"], # the properties below are optional cloud_watch_destination=ses.CfnConfigurationSetEventDestination.CloudWatchDestinationProperty( dimension_configurations=[ses.CfnConfigurationSetEventDestination.DimensionConfigurationProperty( default_dimension_value="defaultDimensionValue", dimension_name="dimensionName", dimension_value_source="dimensionValueSource" )] ), enabled=False, kinesis_firehose_destination=ses.CfnConfigurationSetEventDestination.KinesisFirehoseDestinationProperty( delivery_stream_arn="deliveryStreamArn", iam_role_arn="iamRoleArn" ), name="name" )
Attributes
-
cloud_watch_destination
¶ An object that contains the names, default values, and sources of the dimensions associated with an Amazon CloudWatch event destination.
-
enabled
¶ Sets whether Amazon SES publishes events to this destination when you send an email with the associated configuration set.
Set to
true
to enable publishing to this destination; set tofalse
to prevent publishing to this destination. The default value isfalse
.
-
kinesis_firehose_destination
¶ An object that contains the delivery stream ARN and the IAM role ARN associated with an Amazon Kinesis Firehose event destination.
-
matching_event_types
¶ The type of email sending events to publish to the event destination.
send
- The call was successful and Amazon SES is attempting to deliver the email.reject
- Amazon SES determined that the email contained a virus and rejected it.bounce
- The recipient’s mail server permanently rejected the email. This corresponds to a hard bounce.complaint
- The recipient marked the email as spam.delivery
- Amazon SES successfully delivered the email to the recipient’s mail server.open
- The recipient received the email and opened it in their email client.click
- The recipient clicked one or more links in the email.renderingFailure
- Amazon SES did not send the email because of a template rendering issue.
-
name
¶ .
Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
Contain 64 characters or fewer.
- Link
- Type
The name of the event destination. The name must meet the following requirements
- Return type
Optional
[str
]
KinesisFirehoseDestinationProperty¶
-
class
CfnConfigurationSetEventDestination.
KinesisFirehoseDestinationProperty
(*, delivery_stream_arn, iam_role_arn)¶ Bases:
object
Contains the delivery stream ARN and the IAM role ARN associated with an Amazon Kinesis Firehose event destination.
Event destinations, such as Amazon Kinesis Firehose, are associated with configuration sets, which enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide .
- Parameters
delivery_stream_arn (
str
) – The ARN of the Amazon Kinesis Firehose stream that email sending events should be published to.iam_role_arn (
str
) – The ARN of the IAM role under which Amazon SES publishes email sending events to the Amazon Kinesis Firehose stream.
- Link
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_ses as ses kinesis_firehose_destination_property = ses.CfnConfigurationSetEventDestination.KinesisFirehoseDestinationProperty( delivery_stream_arn="deliveryStreamArn", iam_role_arn="iamRoleArn" )
Attributes
-
delivery_stream_arn
¶ The ARN of the Amazon Kinesis Firehose stream that email sending events should be published to.
-
iam_role_arn
¶ The ARN of the IAM role under which Amazon SES publishes email sending events to the Amazon Kinesis Firehose stream.