CfnConfigurationSetEventDestination
- class aws_cdk.aws_pinpointemail.CfnConfigurationSetEventDestination(scope, id, *, configuration_set_name, event_destination_name, event_destination=None)
Bases:
CfnResourceCreate an event destination.
In Amazon Pinpoint, events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage.
A single configuration set can include more than one event destination.
- See:
- CloudformationResource:
AWS::PinpointEmail::ConfigurationSetEventDestination
- 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_pinpointemail as pinpointemail cfn_configuration_set_event_destination = pinpointemail.CfnConfigurationSetEventDestination(self, "MyCfnConfigurationSetEventDestination", configuration_set_name="configurationSetName", event_destination_name="eventDestinationName", # the properties below are optional event_destination=pinpointemail.CfnConfigurationSetEventDestination.EventDestinationProperty( matching_event_types=["matchingEventTypes"], # the properties below are optional cloud_watch_destination=pinpointemail.CfnConfigurationSetEventDestination.CloudWatchDestinationProperty( dimension_configurations=[pinpointemail.CfnConfigurationSetEventDestination.DimensionConfigurationProperty( default_dimension_value="defaultDimensionValue", dimension_name="dimensionName", dimension_value_source="dimensionValueSource" )] ), enabled=False, kinesis_firehose_destination=pinpointemail.CfnConfigurationSetEventDestination.KinesisFirehoseDestinationProperty( delivery_stream_arn="deliveryStreamArn", iam_role_arn="iamRoleArn" ), pinpoint_destination=pinpointemail.CfnConfigurationSetEventDestination.PinpointDestinationProperty( application_arn="applicationArn" ), sns_destination=pinpointemail.CfnConfigurationSetEventDestination.SnsDestinationProperty( topic_arn="topicArn" ) ) )
- Parameters:
scope (
Construct) – Scope in which this resource is defined.id (
str) – Construct identifier for this resource (unique in its scope).configuration_set_name (
str) – The name of the configuration set that contains the event destination that you want to modify.event_destination_name (
str) – The name of the event destination that you want to modify.event_destination (
Union[IResolvable,EventDestinationProperty,Dict[str,Any],None]) – An object that defines the event destination.
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)
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_depends_on(target)
(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
- Parameters:
target (
CfnResource) –- Deprecated:
use addDependency
- 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
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
addPropertyOverrideor prefixpathwith “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
valueargument toaddOverridewill 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
- 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: 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 resource, please consult that specific resource’s documentation.
- See:
- Return type:
None
- 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:
- get_metadata(key)
Retrieve a value value from the CloudFormation Resource Metadata.
- Parameters:
key (
str) –- See:
- Return type:
Any
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 this resource depends on.
This assembles dependencies on resources across stacks (including nested stacks) automatically.
- Return type:
List[Union[Stack,CfnResource]]
- obtain_resource_dependencies()
Get a shallow copy of dependencies between this resource and other resources in the same stack.
- Return type:
List[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)
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
Attributes
- CFN_RESOURCE_TYPE_NAME = 'AWS::PinpointEmail::ConfigurationSetEventDestination'
- attr_id
Id
- Type:
cloudformationAttribute
- cfn_options
Options for this resource, such as condition, update policy etc.
- cfn_resource_type
AWS resource type.
- configuration_set_name
The name of the configuration set that contains the event destination that you want to modify.
- 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.
- event_destination
An object that defines the event destination.
- event_destination_name
The name of the event destination that you want to modify.
- 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.
- 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).
Static Methods
- classmethod is_cfn_element(x)
Returns
trueif a construct is a stack element (i.e. part of the synthesized cloudformation template).Uses duck-typing instead of
instanceofto 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(x)
Check whether the given object is a CfnResource.
- Parameters:
x (
Any) –- Return type:
bool
- classmethod is_construct(x)
Checks if
xis a construct.Use this method instead of
instanceofto properly detectConstructinstances, even when the construct library is symlinked.Explanation: in JavaScript, multiple copies of the
constructslibrary on disk are seen as independent, completely different libraries. As a consequence, the classConstructin each copy of theconstructslibrary is seen as a different class, and an instance of one class will not test asinstanceofthe other class.npm installwill not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of theconstructslibrary can be accidentally installed, andinstanceofwill behave unpredictably. It is safest to avoid usinginstanceof, and using this type-testing method instead.- Parameters:
x (
Any) – Any object.- Return type:
bool- Returns:
true if
xis an object created from a class which extendsConstruct.
CloudWatchDestinationProperty
- class CfnConfigurationSetEventDestination.CloudWatchDestinationProperty(*, dimension_configurations=None)
Bases:
objectAn object that defines an Amazon CloudWatch destination for email events.
You can use Amazon CloudWatch to monitor and gain insights on your email sending metrics.
- Parameters:
dimension_configurations (
Union[IResolvable,Sequence[Union[IResolvable,DimensionConfigurationProperty,Dict[str,Any]]],None]) – An array of objects that define the dimensions to use when you send email events to Amazon CloudWatch.- See:
- 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_pinpointemail as pinpointemail cloud_watch_destination_property = pinpointemail.CfnConfigurationSetEventDestination.CloudWatchDestinationProperty( dimension_configurations=[pinpointemail.CfnConfigurationSetEventDestination.DimensionConfigurationProperty( default_dimension_value="defaultDimensionValue", dimension_name="dimensionName", dimension_value_source="dimensionValueSource" )] )
Attributes
- dimension_configurations
An array of objects that define the dimensions to use when you send email events to Amazon CloudWatch.
DimensionConfigurationProperty
- class CfnConfigurationSetEventDestination.DimensionConfigurationProperty(*, default_dimension_value, dimension_name, dimension_value_source)
Bases:
objectAn array of objects that define the dimensions to use when you send email events to Amazon CloudWatch.
- Parameters:
default_dimension_value (
str) – The default value of the dimension that is published to Amazon CloudWatch if you don’t provide the value of the dimension when you send an email. This value has to meet the following criteria: - It can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-). - It can contain no more than 256 characters.dimension_name (
str) – The name of an Amazon CloudWatch dimension associated with an email sending metric. The name has to meet the following criteria: - It can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-). - It can contain no more than 256 characters.dimension_value_source (
str) – The location where Amazon Pinpoint finds the value of a dimension to publish to Amazon CloudWatch. Acceptable values:MESSAGE_TAG,EMAIL_HEADER, andLINK_TAG. If you want Amazon Pinpoint to use the message tags that you specify using anX-SES-MESSAGE-TAGSheader or a parameter to theSendEmailAPI, chooseMESSAGE_TAG. If you want Amazon Pinpoint to use your own email headers, chooseEMAIL_HEADER. If you want Amazon Pinpoint to use tags that are specified in your links, chooseLINK_TAG.
- See:
- 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_pinpointemail as pinpointemail dimension_configuration_property = pinpointemail.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 don’t provide the value of the dimension when you send an email.
This value has to meet the following criteria:
It can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-).
It can contain no more than 256 characters.
- dimension_name
The name of an Amazon CloudWatch dimension associated with an email sending metric.
The name has to meet the following criteria:
It can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-).
It can contain no more than 256 characters.
- dimension_value_source
The location where Amazon Pinpoint finds the value of a dimension to publish to Amazon CloudWatch.
Acceptable values:
MESSAGE_TAG,EMAIL_HEADER, andLINK_TAG.If you want Amazon Pinpoint to use the message tags that you specify using an
X-SES-MESSAGE-TAGSheader or a parameter to theSendEmailAPI, chooseMESSAGE_TAG. If you want Amazon Pinpoint to use your own email headers, chooseEMAIL_HEADER. If you want Amazon Pinpoint to use tags that are specified in your links, chooseLINK_TAG.
EventDestinationProperty
- class CfnConfigurationSetEventDestination.EventDestinationProperty(*, matching_event_types, cloud_watch_destination=None, enabled=None, kinesis_firehose_destination=None, pinpoint_destination=None, sns_destination=None)
Bases:
objectIn Amazon Pinpoint, events include message sends, deliveries, opens, clicks, bounces, and complaints.
Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage.
- Parameters:
matching_event_types (
Sequence[str]) – The types of events that Amazon Pinpoint sends to the specified event destinations. Acceptable values:SEND,REJECT,BOUNCE,COMPLAINT,DELIVERY,OPEN,CLICK, andRENDERING_FAILURE.cloud_watch_destination (
Union[IResolvable,CloudWatchDestinationProperty,Dict[str,Any],None]) – An object that defines an Amazon CloudWatch destination for email events. You can use Amazon CloudWatch to monitor and gain insights on your email sending metrics.enabled (
Union[bool,IResolvable,None]) – Iftrue, the event destination is enabled. When the event destination is enabled, the specified event types are sent to the destinations in thisEventDestinationDefinition. Iffalse, the event destination is disabled. When the event destination is disabled, events aren’t sent to the specified destinations.kinesis_firehose_destination (
Union[IResolvable,KinesisFirehoseDestinationProperty,Dict[str,Any],None]) – An object that defines an Amazon Kinesis Data Firehose destination for email events. You can use Amazon Kinesis Data Firehose to stream data to other services, such as Amazon S3 and Amazon Redshift.pinpoint_destination (
Union[IResolvable,PinpointDestinationProperty,Dict[str,Any],None]) – An object that defines a Amazon Pinpoint destination for email events. You can use Amazon Pinpoint events to create attributes in Amazon Pinpoint projects. You can use these attributes to create segments for your campaigns.sns_destination (
Union[IResolvable,SnsDestinationProperty,Dict[str,Any],None]) – An object that defines an Amazon SNS destination for email events. You can use Amazon SNS to send notification when certain email events occur.
- See:
- 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_pinpointemail as pinpointemail event_destination_property = pinpointemail.CfnConfigurationSetEventDestination.EventDestinationProperty( matching_event_types=["matchingEventTypes"], # the properties below are optional cloud_watch_destination=pinpointemail.CfnConfigurationSetEventDestination.CloudWatchDestinationProperty( dimension_configurations=[pinpointemail.CfnConfigurationSetEventDestination.DimensionConfigurationProperty( default_dimension_value="defaultDimensionValue", dimension_name="dimensionName", dimension_value_source="dimensionValueSource" )] ), enabled=False, kinesis_firehose_destination=pinpointemail.CfnConfigurationSetEventDestination.KinesisFirehoseDestinationProperty( delivery_stream_arn="deliveryStreamArn", iam_role_arn="iamRoleArn" ), pinpoint_destination=pinpointemail.CfnConfigurationSetEventDestination.PinpointDestinationProperty( application_arn="applicationArn" ), sns_destination=pinpointemail.CfnConfigurationSetEventDestination.SnsDestinationProperty( topic_arn="topicArn" ) )
Attributes
- cloud_watch_destination
An object that defines an Amazon CloudWatch destination for email events.
You can use Amazon CloudWatch to monitor and gain insights on your email sending metrics.
- enabled
If
true, the event destination is enabled.When the event destination is enabled, the specified event types are sent to the destinations in this
EventDestinationDefinition.If
false, the event destination is disabled. When the event destination is disabled, events aren’t sent to the specified destinations.
- kinesis_firehose_destination
An object that defines an Amazon Kinesis Data Firehose destination for email events.
You can use Amazon Kinesis Data Firehose to stream data to other services, such as Amazon S3 and Amazon Redshift.
- matching_event_types
The types of events that Amazon Pinpoint sends to the specified event destinations.
Acceptable values:
SEND,REJECT,BOUNCE,COMPLAINT,DELIVERY,OPEN,CLICK, andRENDERING_FAILURE.
- pinpoint_destination
An object that defines a Amazon Pinpoint destination for email events.
You can use Amazon Pinpoint events to create attributes in Amazon Pinpoint projects. You can use these attributes to create segments for your campaigns.
- sns_destination
An object that defines an Amazon SNS destination for email events.
You can use Amazon SNS to send notification when certain email events occur.
KinesisFirehoseDestinationProperty
- class CfnConfigurationSetEventDestination.KinesisFirehoseDestinationProperty(*, delivery_stream_arn, iam_role_arn)
Bases:
objectAn object that defines an Amazon Kinesis Data Firehose destination for email events.
You can use Amazon Kinesis Data Firehose to stream data to other services, such as Amazon S3 and Amazon Redshift.
- Parameters:
delivery_stream_arn (
str) – The Amazon Resource Name (ARN) of the Amazon Kinesis Data Firehose stream that Amazon Pinpoint sends email events to.iam_role_arn (
str) – The Amazon Resource Name (ARN) of the IAM role that Amazon Pinpoint uses when sending email events to the Amazon Kinesis Data Firehose stream.
- See:
- 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_pinpointemail as pinpointemail kinesis_firehose_destination_property = pinpointemail.CfnConfigurationSetEventDestination.KinesisFirehoseDestinationProperty( delivery_stream_arn="deliveryStreamArn", iam_role_arn="iamRoleArn" )
Attributes
- delivery_stream_arn
The Amazon Resource Name (ARN) of the Amazon Kinesis Data Firehose stream that Amazon Pinpoint sends email events to.
- iam_role_arn
The Amazon Resource Name (ARN) of the IAM role that Amazon Pinpoint uses when sending email events to the Amazon Kinesis Data Firehose stream.
PinpointDestinationProperty
- class CfnConfigurationSetEventDestination.PinpointDestinationProperty(*, application_arn=None)
Bases:
objectAn object that defines a Amazon Pinpoint destination for email events.
You can use Amazon Pinpoint events to create attributes in Amazon Pinpoint projects. You can use these attributes to create segments for your campaigns.
- Parameters:
application_arn (
Optional[str]) – The Amazon Resource Name (ARN) of the Amazon Pinpoint project that you want to send email events to.- See:
- 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_pinpointemail as pinpointemail pinpoint_destination_property = pinpointemail.CfnConfigurationSetEventDestination.PinpointDestinationProperty( application_arn="applicationArn" )
Attributes
- application_arn
The Amazon Resource Name (ARN) of the Amazon Pinpoint project that you want to send email events to.
SnsDestinationProperty
- class CfnConfigurationSetEventDestination.SnsDestinationProperty(*, topic_arn)
Bases:
objectAn object that defines an Amazon SNS destination for email events.
You can use Amazon SNS to send notification when certain email events occur.
- Parameters:
topic_arn (
str) – The Amazon Resource Name (ARN) of the Amazon SNS topic that you want to publish email events to. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide .- See:
- 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_pinpointemail as pinpointemail sns_destination_property = pinpointemail.CfnConfigurationSetEventDestination.SnsDestinationProperty( topic_arn="topicArn" )
Attributes
- topic_arn
The Amazon Resource Name (ARN) of the Amazon SNS topic that you want to publish email events to.
For more information about Amazon SNS topics, see the Amazon SNS Developer Guide .