CfnConfigurationSet
- class aws_cdk.aws_ses.CfnConfigurationSet(scope, id, *, delivery_options=None, name=None, reputation_options=None, sending_options=None, suppression_options=None, tracking_options=None, vdm_options=None)
Bases:
CfnResource
A CloudFormation
AWS::SES::ConfigurationSet
.Configuration sets let you create groups of rules that you can apply to the emails you send using Amazon SES. For more information about using configuration sets, see Using Amazon SES Configuration Sets in the Amazon SES Developer Guide . .. epigraph:
*Required permissions:* To apply any of the resource options, you will need to have the corresponding AWS Identity and Access Management (IAM) SES API v2 permissions: - ``ses:GetConfigurationSet`` - (This permission is replacing the v1 *ses:DescribeConfigurationSet* permission which will not work with these v2 resource options.) - ``ses:PutConfigurationSetDeliveryOptions`` - ``ses:PutConfigurationSetReputationOptions`` - ``ses:PutConfigurationSetSendingOptions`` - ``ses:PutConfigurationSetSuppressionOptions`` - ``ses:PutConfigurationSetTrackingOptions``
- CloudformationResource:
AWS::SES::ConfigurationSet
- Link:
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-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_ses as ses cfn_configuration_set = ses.CfnConfigurationSet(self, "MyCfnConfigurationSet", delivery_options=ses.CfnConfigurationSet.DeliveryOptionsProperty( sending_pool_name="sendingPoolName", tls_policy="tlsPolicy" ), name="name", reputation_options=ses.CfnConfigurationSet.ReputationOptionsProperty( reputation_metrics_enabled=False ), sending_options=ses.CfnConfigurationSet.SendingOptionsProperty( sending_enabled=False ), suppression_options=ses.CfnConfigurationSet.SuppressionOptionsProperty( suppressed_reasons=["suppressedReasons"] ), tracking_options=ses.CfnConfigurationSet.TrackingOptionsProperty( custom_redirect_domain="customRedirectDomain" ), vdm_options=ses.CfnConfigurationSet.VdmOptionsProperty( dashboard_options=ses.CfnConfigurationSet.DashboardOptionsProperty( engagement_metrics="engagementMetrics" ), guardian_options=ses.CfnConfigurationSet.GuardianOptionsProperty( optimized_shared_delivery="optimizedSharedDelivery" ) ) )
Create a new
AWS::SES::ConfigurationSet
.- Parameters:
scope (
Construct
) –scope in which this resource is defined.
id (
str
) –scoped id of the resource.
delivery_options (
Union
[DeliveryOptionsProperty
,Dict
[str
,Any
],IResolvable
,None
]) – Specifies whether messages that use the configuration set are required to use Transport Layer Security (TLS).name (
Optional
[str
]) – The name of the configuration set. The name must meet the following requirements:. - Contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). - Contain 64 characters or fewer.reputation_options (
Union
[IResolvable
,ReputationOptionsProperty
,Dict
[str
,Any
],None
]) – An object that represents the reputation settings for the configuration set.sending_options (
Union
[IResolvable
,SendingOptionsProperty
,Dict
[str
,Any
],None
]) – An object that defines whether or not Amazon SES can send email that you send using the configuration set.suppression_options (
Union
[IResolvable
,SuppressionOptionsProperty
,Dict
[str
,Any
],None
]) – An object that contains information about the suppression list preferences for your account.tracking_options (
Union
[IResolvable
,TrackingOptionsProperty
,Dict
[str
,Any
],None
]) – The name of the custom open and click tracking domain associated with the configuration set.vdm_options (
Union
[IResolvable
,VdmOptionsProperty
,Dict
[str
,Any
],None
]) – The Virtual Deliverability Manager (VDM) options that apply to 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:
- 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
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:
- 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
- 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::ConfigurationSet'
- cfn_options
Options for this resource, such as condition, update policy etc.
- cfn_resource_type
AWS resource type.
- 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.
- delivery_options
Specifies whether messages that use the configuration set are required to use Transport Layer Security (TLS).
- 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
.
Contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
Contain 64 characters or fewer.
- Link:
- Type:
The name of the configuration set. The name must meet the following requirements
- node
The construct tree node associated with this construct.
- 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 })
.
- reputation_options
An object that represents the reputation settings for the configuration set.
- sending_options
An object that defines whether or not Amazon SES can send email that you send using the configuration set.
- stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
- suppression_options
An object that contains information about the suppression list preferences for your account.
- tracking_options
The name of the custom open and click tracking domain associated with the configuration set.
- vdm_options
The Virtual Deliverability Manager (VDM) options that apply to the configuration set.
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
DashboardOptionsProperty
- class CfnConfigurationSet.DashboardOptionsProperty(*, engagement_metrics)
Bases:
object
Settings for your VDM configuration as applicable to the Dashboard.
- Parameters:
engagement_metrics (
str
) – Specifies the status of your VDM engagement metrics collection. Can be one of the following:. -ENABLED
– Amazon SES enables engagement metrics for the configuration set. -DISABLED
– Amazon SES disables engagement metrics for the configuration set.- 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 dashboard_options_property = ses.CfnConfigurationSet.DashboardOptionsProperty( engagement_metrics="engagementMetrics" )
Attributes
- engagement_metrics
.
ENABLED
– Amazon SES enables engagement metrics for the configuration set.DISABLED
– Amazon SES disables engagement metrics for the configuration set.
- Link:
- Type:
Specifies the status of your VDM engagement metrics collection. Can be one of the following
DeliveryOptionsProperty
- class CfnConfigurationSet.DeliveryOptionsProperty(*, sending_pool_name=None, tls_policy=None)
Bases:
object
Specifies whether messages that use the configuration set are required to use Transport Layer Security (TLS).
- Parameters:
sending_pool_name (
Optional
[str
]) – The name of the dedicated IP pool to associate with the configuration set.tls_policy (
Optional
[str
]) – Specifies whether messages that use the configuration set are required to use Transport Layer Security (TLS). If the value isREQUIRE
, messages are only delivered if a TLS connection can be established. If the value isOPTIONAL
, messages can be delivered in plain text if a TLS connection can’t be established. Valid Values:REQUIRE | OPTIONAL
- 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 delivery_options_property = ses.CfnConfigurationSet.DeliveryOptionsProperty( sending_pool_name="sendingPoolName", tls_policy="tlsPolicy" )
Attributes
- sending_pool_name
The name of the dedicated IP pool to associate with the configuration set.
- tls_policy
Specifies whether messages that use the configuration set are required to use Transport Layer Security (TLS).
If the value is
REQUIRE
, messages are only delivered if a TLS connection can be established. If the value isOPTIONAL
, messages can be delivered in plain text if a TLS connection can’t be established.Valid Values:
REQUIRE | OPTIONAL
GuardianOptionsProperty
- class CfnConfigurationSet.GuardianOptionsProperty(*, optimized_shared_delivery)
Bases:
object
Settings for your VDM configuration as applicable to the Guardian.
- Parameters:
optimized_shared_delivery (
str
) – Specifies the status of your VDM optimized shared delivery. Can be one of the following:. -ENABLED
– Amazon SES enables optimized shared delivery for the configuration set. -DISABLED
– Amazon SES disables optimized shared delivery for the configuration set.- 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 guardian_options_property = ses.CfnConfigurationSet.GuardianOptionsProperty( optimized_shared_delivery="optimizedSharedDelivery" )
Attributes
.
ENABLED
– Amazon SES enables optimized shared delivery for the configuration set.DISABLED
– Amazon SES disables optimized shared delivery for the configuration set.
- Link:
- Type:
Specifies the status of your VDM optimized shared delivery. Can be one of the following
ReputationOptionsProperty
- class CfnConfigurationSet.ReputationOptionsProperty(*, reputation_metrics_enabled=None)
Bases:
object
Contains information about the reputation settings for a configuration set.
- Parameters:
reputation_metrics_enabled (
Union
[bool
,IResolvable
,None
]) – Describes whether or not Amazon SES publishes reputation metrics for the configuration set, such as bounce and complaint rates, to Amazon CloudWatch. If the value istrue
, reputation metrics are published. If the value isfalse
, reputation metrics are not published. The default value isfalse
.- 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 reputation_options_property = ses.CfnConfigurationSet.ReputationOptionsProperty( reputation_metrics_enabled=False )
Attributes
- reputation_metrics_enabled
Describes whether or not Amazon SES publishes reputation metrics for the configuration set, such as bounce and complaint rates, to Amazon CloudWatch.
If the value is
true
, reputation metrics are published. If the value isfalse
, reputation metrics are not published. The default value isfalse
.
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
]) – Iftrue
, email sending is enabled for the configuration set. Iffalse
, email sending is disabled for the configuration set.- 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 sending_options_property = ses.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.
SuppressionOptionsProperty
- class CfnConfigurationSet.SuppressionOptionsProperty(*, suppressed_reasons=None)
Bases:
object
An object that contains information about the suppression list preferences for your account.
- Parameters:
suppressed_reasons (
Optional
[Sequence
[str
]]) – A list that contains the reasons that email addresses are automatically added to the suppression list for your account. This list can contain any or all of the following: -COMPLAINT
– Amazon SES adds an email address to the suppression list for your account when a message sent to that address results in a complaint. -BOUNCE
– Amazon SES adds an email address to the suppression list for your account when a message sent to that address results in a hard bounce.- 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 suppression_options_property = ses.CfnConfigurationSet.SuppressionOptionsProperty( suppressed_reasons=["suppressedReasons"] )
Attributes
- suppressed_reasons
A list that contains the reasons that email addresses are automatically added to the suppression list for your account.
This list can contain any or all of the following:
COMPLAINT
– Amazon SES adds an email address to the suppression list for your account when a message sent to that address results in a complaint.BOUNCE
– Amazon SES adds an email address to the suppression list for your account when a message sent to that address results in a hard bounce.
TrackingOptionsProperty
- class CfnConfigurationSet.TrackingOptionsProperty(*, custom_redirect_domain=None)
Bases:
object
A domain that is used to redirect email recipients to an Amazon SES-operated domain.
This domain captures open and click events generated by Amazon SES emails.
For more information, see Configuring Custom Domains to Handle Open and Click Tracking in the Amazon SES Developer Guide .
- Parameters:
custom_redirect_domain (
Optional
[str
]) – The custom subdomain that is used to redirect email recipients to the Amazon SES event tracking domain.- 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 tracking_options_property = ses.CfnConfigurationSet.TrackingOptionsProperty( custom_redirect_domain="customRedirectDomain" )
Attributes
- custom_redirect_domain
The custom subdomain that is used to redirect email recipients to the Amazon SES event tracking domain.
VdmOptionsProperty
- class CfnConfigurationSet.VdmOptionsProperty(*, dashboard_options=None, guardian_options=None)
Bases:
object
The Virtual Deliverability Manager (VDM) options that apply to a configuration set.
- Parameters:
dashboard_options (
Union
[IResolvable
,DashboardOptionsProperty
,Dict
[str
,Any
],None
]) – Settings for your VDM configuration as applicable to the Dashboard.guardian_options (
Union
[IResolvable
,GuardianOptionsProperty
,Dict
[str
,Any
],None
]) – Settings for your VDM configuration as applicable to the Guardian.
- 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 vdm_options_property = ses.CfnConfigurationSet.VdmOptionsProperty( dashboard_options=ses.CfnConfigurationSet.DashboardOptionsProperty( engagement_metrics="engagementMetrics" ), guardian_options=ses.CfnConfigurationSet.GuardianOptionsProperty( optimized_shared_delivery="optimizedSharedDelivery" ) )
Attributes
- dashboard_options
Settings for your VDM configuration as applicable to the Dashboard.
- guardian_options
Settings for your VDM configuration as applicable to the Guardian.