CfnConfigurationSet

class aws_cdk.aws_pinpointemail.CfnConfigurationSet(scope, id, *, name, delivery_options=None, reputation_options=None, sending_options=None, tags=None, tracking_options=None)

Bases: aws_cdk.core.CfnResource

A CloudFormation AWS::PinpointEmail::ConfigurationSet.

Create a configuration set. Configuration sets are groups of rules that you can apply to the emails you send using Amazon Pinpoint. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.

CloudformationResource

AWS::PinpointEmail::ConfigurationSet

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpointemail-configurationset.html

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_pinpointemail as pinpointemail

cfn_configuration_set = pinpointemail.CfnConfigurationSet(self, "MyCfnConfigurationSet",
    name="name",

    # the properties below are optional
    delivery_options=pinpointemail.CfnConfigurationSet.DeliveryOptionsProperty(
        sending_pool_name="sendingPoolName"
    ),
    reputation_options=pinpointemail.CfnConfigurationSet.ReputationOptionsProperty(
        reputation_metrics_enabled=False
    ),
    sending_options=pinpointemail.CfnConfigurationSet.SendingOptionsProperty(
        sending_enabled=False
    ),
    tags=[pinpointemail.CfnConfigurationSet.TagsProperty(
        key="key",
        value="value"
    )],
    tracking_options=pinpointemail.CfnConfigurationSet.TrackingOptionsProperty(
        custom_redirect_domain="customRedirectDomain"
    )
)

Create a new AWS::PinpointEmail::ConfigurationSet.

Parameters
  • scope (Construct) –

    • scope in which this resource is defined.

  • id (str) –

    • scoped id of the resource.

  • name (str) – The name of the configuration set.

  • delivery_options (Union[DeliveryOptionsProperty, IResolvable, None]) – An object that defines the dedicated IP pool that is used to send emails that you send using the configuration set.

  • reputation_options (Union[IResolvable, ReputationOptionsProperty, None]) – An object that defines whether or not Amazon Pinpoint collects reputation metrics for the emails that you send that use the configuration set.

  • sending_options (Union[IResolvable, SendingOptionsProperty, None]) – An object that defines whether or not Amazon Pinpoint can send email that you send using the configuration set.

  • tags (Optional[Sequence[TagsProperty]]) – An object that defines the tags (keys and values) that you want to associate with the configuration set.

  • tracking_options (Union[IResolvable, TrackingOptionsProperty, None]) – An object that defines the open and click tracking options for emails that you send using the configuration set.

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 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 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: 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 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

Reference

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::PinpointEmail::ConfigurationSet'
cfn_options

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

Return type

ICfnResourceOptions

cfn_resource_type

AWS resource type.

Return type

str

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]

delivery_options

An object that defines the dedicated IP pool that is used to send emails that you send using the configuration set.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpointemail-configurationset.html#cfn-pinpointemail-configurationset-deliveryoptions

Return type

Union[DeliveryOptionsProperty, IResolvable, None]

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.

name

The name of the configuration set.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpointemail-configurationset.html#cfn-pinpointemail-configurationset-name

Return type

str

node

The construct tree node associated with this construct.

Return type

ConstructNode

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

reputation_options

An object that defines whether or not Amazon Pinpoint collects reputation metrics for the emails that you send that use the configuration set.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpointemail-configurationset.html#cfn-pinpointemail-configurationset-reputationoptions

Return type

Union[IResolvable, ReputationOptionsProperty, None]

sending_options

An object that defines whether or not Amazon Pinpoint can send email that you send using the configuration set.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpointemail-configurationset.html#cfn-pinpointemail-configurationset-sendingoptions

Return type

Union[IResolvable, SendingOptionsProperty, None]

stack

The stack in which this element is defined.

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

Return type

Stack

tags

An object that defines the tags (keys and values) that you want to associate with the configuration set.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpointemail-configurationset.html#cfn-pinpointemail-configurationset-tags

Return type

Optional[List[TagsProperty]]

tracking_options

An object that defines the open and click tracking options for emails that you send using the configuration set.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpointemail-configurationset.html#cfn-pinpointemail-configurationset-trackingoptions

Return type

Union[IResolvable, TrackingOptionsProperty, None]

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

DeliveryOptionsProperty

class CfnConfigurationSet.DeliveryOptionsProperty(*, sending_pool_name=None)

Bases: object

Used to associate a configuration set with a dedicated IP pool.

Parameters

sending_pool_name (Optional[str]) – The name of the dedicated IP pool that you want to associate with the configuration set.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpointemail-configurationset-deliveryoptions.html

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_pinpointemail as pinpointemail

delivery_options_property = pinpointemail.CfnConfigurationSet.DeliveryOptionsProperty(
    sending_pool_name="sendingPoolName"
)

Attributes

sending_pool_name

The name of the dedicated IP pool that you want to associate with the configuration set.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpointemail-configurationset-deliveryoptions.html#cfn-pinpointemail-configurationset-deliveryoptions-sendingpoolname

Return type

Optional[str]

ReputationOptionsProperty

class CfnConfigurationSet.ReputationOptionsProperty(*, reputation_metrics_enabled=None)

Bases: object

Enable or disable collection of reputation metrics for emails that you send using this configuration set in the current AWS Region.

Parameters

reputation_metrics_enabled (Union[bool, IResolvable, None]) – If true , tracking of reputation metrics is enabled for the configuration set. If false , tracking of reputation metrics is disabled for the configuration set.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpointemail-configurationset-reputationoptions.html

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_pinpointemail as pinpointemail

reputation_options_property = pinpointemail.CfnConfigurationSet.ReputationOptionsProperty(
    reputation_metrics_enabled=False
)

Attributes

reputation_metrics_enabled

If true , tracking of reputation metrics is enabled for the configuration set.

If false , tracking of reputation metrics is disabled for the configuration set.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpointemail-configurationset-reputationoptions.html#cfn-pinpointemail-configurationset-reputationoptions-reputationmetricsenabled

Return type

Union[bool, IResolvable, None]

SendingOptionsProperty

class CfnConfigurationSet.SendingOptionsProperty(*, sending_enabled=None)

Bases: object

Used to enable or disable email sending for messages that use this configuration set in the current AWS Region.

Parameters

sending_enabled (Union[bool, IResolvable, None]) – If true , email sending is enabled for the configuration set. If false , email sending is disabled for the configuration set.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpointemail-configurationset-sendingoptions.html

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_pinpointemail as pinpointemail

sending_options_property = pinpointemail.CfnConfigurationSet.SendingOptionsProperty(
    sending_enabled=False
)

Attributes

sending_enabled

If true , email sending is enabled for the configuration set.

If false , email sending is disabled for the configuration set.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpointemail-configurationset-sendingoptions.html#cfn-pinpointemail-configurationset-sendingoptions-sendingenabled

Return type

Union[bool, IResolvable, None]

TagsProperty

class CfnConfigurationSet.TagsProperty(*, key=None, value=None)

Bases: object

An object that defines the tags (keys and values) that you want to associate with the configuration set.

Parameters
  • key (Optional[str]) – One part of a key-value pair that defines a tag. The maximum length of a tag key is 128 characters. The minimum length is 1 character. If you specify tags for the configuration set, then this value is required.

  • value (Optional[str]) – The optional part of a key-value pair that defines a tag. The maximum length of a tag value is 256 characters. The minimum length is 0 characters. If you don’t want a resource to have a specific tag value, don’t specify a value for this parameter. Amazon Pinpoint will set the value to an empty string.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpointemail-configurationset-tags.html

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_pinpointemail as pinpointemail

tags_property = pinpointemail.CfnConfigurationSet.TagsProperty(
    key="key",
    value="value"
)

Attributes

key

One part of a key-value pair that defines a tag.

The maximum length of a tag key is 128 characters. The minimum length is 1 character.

If you specify tags for the configuration set, then this value is required.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpointemail-configurationset-tags.html#cfn-pinpointemail-configurationset-tags-key

Return type

Optional[str]

value

The optional part of a key-value pair that defines a tag.

The maximum length of a tag value is 256 characters. The minimum length is 0 characters. If you don’t want a resource to have a specific tag value, don’t specify a value for this parameter. Amazon Pinpoint will set the value to an empty string.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpointemail-configurationset-tags.html#cfn-pinpointemail-configurationset-tags-value

Return type

Optional[str]

TrackingOptionsProperty

class CfnConfigurationSet.TrackingOptionsProperty(*, custom_redirect_domain=None)

Bases: object

An object that defines the tracking options for a configuration set.

When you use Amazon Pinpoint to send an email, it contains an invisible image that’s used to track when recipients open your email. If your email contains links, those links are changed slightly in order to track when recipients click them.

These images and links include references to a domain operated by AWS . You can optionally configure Amazon Pinpoint to use a domain that you operate for these images and links.

Parameters

custom_redirect_domain (Optional[str]) – The domain that you want to use for tracking open and click events.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpointemail-configurationset-trackingoptions.html

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_pinpointemail as pinpointemail

tracking_options_property = pinpointemail.CfnConfigurationSet.TrackingOptionsProperty(
    custom_redirect_domain="customRedirectDomain"
)

Attributes

custom_redirect_domain

The domain that you want to use for tracking open and click events.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpointemail-configurationset-trackingoptions.html#cfn-pinpointemail-configurationset-trackingoptions-customredirectdomain

Return type

Optional[str]