CfnApplicationSettings

class aws_cdk.aws_pinpoint.CfnApplicationSettings(scope, id, *, application_id, campaign_hook=None, cloud_watch_metrics_enabled=None, limits=None, quiet_time=None)

Bases: CfnResource

A CloudFormation AWS::Pinpoint::ApplicationSettings.

Specifies the settings for an Amazon Pinpoint application. In Amazon Pinpoint, an application (also referred to as an app or project ) is a collection of related settings, customer information, segments, and campaigns, and other types of Amazon Pinpoint resources.

CloudformationResource:: AWS::Pinpoint::ApplicationSettings
Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-applicationsettings.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_pinpoint as pinpoint

cfn_application_settings = pinpoint.CfnApplicationSettings(self, "MyCfnApplicationSettings",
    application_id="applicationId",

    # the properties below are optional
    campaign_hook=pinpoint.CfnApplicationSettings.CampaignHookProperty(
        lambda_function_name="lambdaFunctionName",
        mode="mode",
        web_url="webUrl"
    ),
    cloud_watch_metrics_enabled=False,
    limits=pinpoint.CfnApplicationSettings.LimitsProperty(
        daily=123,
        maximum_duration=123,
        messages_per_second=123,
        total=123
    ),
    quiet_time=pinpoint.CfnApplicationSettings.QuietTimeProperty(
        end="end",
        start="start"
    )
)

Create a new AWS::Pinpoint::ApplicationSettings.

Parameters:

scope (Construct) –
- scope in which this resource is defined.
id (str) –
- scoped id of the resource.
application_id (str) – The unique identifier for the Amazon Pinpoint application.
campaign_hook (Union[IResolvable, CampaignHookProperty, Dict[str, Any], None]) – The settings for the Lambda function to use by default as a code hook for campaigns in the application. To override these settings for a specific campaign, use the Campaign resource to define custom Lambda function settings for the campaign.
cloud_watch_metrics_enabled (Union[bool, IResolvable, None]) – Specifies whether to enable application-related alarms in Amazon CloudWatch.
limits (Union[IResolvable, LimitsProperty, Dict[str, Any], None]) – The default sending limits for campaigns in the application. To override these limits for a specific campaign, use the Campaign resource to define custom limits for the campaign.
quiet_time (Union[IResolvable, QuietTimeProperty, Dict[str, Any], None]) – The default quiet time for campaigns in the application. Quiet time is a specific time range when campaigns don’t send messages to endpoints, if all the following conditions are met: - The EndpointDemographic.Timezone property of the endpoint is set to a valid value. - The current time in the endpoint’s time zone is later than or equal to the time specified by the QuietTime.Start property for the application (or a campaign that has custom quiet time settings). - The current time in the endpoint’s time zone is earlier than or equal to the time specified by the QuietTime.End property for the application (or a campaign that has custom quiet time settings). If any of the preceding conditions isn’t met, the endpoint will receive messages from a campaign, even if quiet time is enabled. To override the default quiet time settings for a specific campaign, use the Campaign resource to define a custom quiet time for the campaign.

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

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.

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:

Return type:

Any

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.

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::Pinpoint::ApplicationSettings'

application_id

The unique identifier for the Amazon Pinpoint application.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-applicationsettings.html#cfn-pinpoint-applicationsettings-applicationid

campaign_hook

The settings for the Lambda function to use by default as a code hook for campaigns in the application.

To override these settings for a specific campaign, use the Campaign resource to define custom Lambda function settings for the campaign.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-applicationsettings.html#cfn-pinpoint-applicationsettings-campaignhook

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

cfn_resource_type: AWS resource type.

cloud_watch_metrics_enabled

Specifies whether to enable application-related alarms in Amazon CloudWatch.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-applicationsettings.html#cfn-pinpoint-applicationsettings-cloudwatchmetricsenabled

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.

limits

The default sending limits for campaigns in the application.

To override these limits for a specific campaign, use the Campaign resource to define custom limits for the campaign.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-applicationsettings.html#cfn-pinpoint-applicationsettings-limits

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 construct tree node associated with this construct.

quiet_time

The default quiet time for campaigns in the application.

Quiet time is a specific time range when campaigns don’t send messages to endpoints, if all the following conditions are met:

The EndpointDemographic.Timezone property of the endpoint is set to a valid value.
The current time in the endpoint’s time zone is later than or equal to the time specified by the QuietTime.Start property for the application (or a campaign that has custom quiet time settings).
The current time in the endpoint’s time zone is earlier than or equal to the time specified by the QuietTime.End property for the application (or a campaign that has custom quiet time settings).

If any of the preceding conditions isn’t met, the endpoint will receive messages from a campaign, even if quiet time is enabled.

To override the default quiet time settings for a specific campaign, use the Campaign resource to define a custom quiet time for the campaign.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-applicationsettings.html#cfn-pinpoint-applicationsettings-quiettime

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

CampaignHookProperty

class CfnApplicationSettings.CampaignHookProperty(*, lambda_function_name=None, mode=None, web_url=None)

Bases: object

Specifies the Lambda function to use by default as a code hook for campaigns in the application.

Parameters:

lambda_function_name (Optional[str]) – The name or Amazon Resource Name (ARN) of the Lambda function that Amazon Pinpoint invokes to send messages for campaigns in the application.
mode (Optional[str]) – The mode that Amazon Pinpoint uses to invoke the Lambda function. Possible values are:. - FILTER - Invoke the function to customize the segment that’s used by a campaign. - DELIVERY - (Deprecated) Previously, invoked the function to send a campaign through a custom channel. This functionality is not supported anymore. To send a campaign through a custom channel, use the CustomDeliveryConfiguration and CampaignCustomMessage objects of the campaign.
web_url (Optional[str]) – The web URL that Amazon Pinpoint calls to invoke the Lambda function over HTTPS.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-applicationsettings-campaignhook.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_pinpoint as pinpoint

campaign_hook_property = pinpoint.CfnApplicationSettings.CampaignHookProperty(
    lambda_function_name="lambdaFunctionName",
    mode="mode",
    web_url="webUrl"
)

Attributes

lambda_function_name

The name or Amazon Resource Name (ARN) of the Lambda function that Amazon Pinpoint invokes to send messages for campaigns in the application.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-applicationsettings-campaignhook.html#cfn-pinpoint-applicationsettings-campaignhook-lambdafunctionname

mode

.

FILTER - Invoke the function to customize the segment that’s used by a campaign.
DELIVERY - (Deprecated) Previously, invoked the function to send a campaign through a custom channel. This functionality is not supported anymore. To send a campaign through a custom channel, use the CustomDeliveryConfiguration and CampaignCustomMessage objects of the campaign.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-applicationsettings-campaignhook.html#cfn-pinpoint-applicationsettings-campaignhook-mode
Type:: The mode that Amazon Pinpoint uses to invoke the Lambda function. Possible values are

web_url

The web URL that Amazon Pinpoint calls to invoke the Lambda function over HTTPS.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-applicationsettings-campaignhook.html#cfn-pinpoint-applicationsettings-campaignhook-weburl

LimitsProperty

class CfnApplicationSettings.LimitsProperty(*, daily=None, maximum_duration=None, messages_per_second=None, total=None)

Bases: object

Specifies the default sending limits for campaigns in the application.

Parameters:

daily (Union[int, float, None]) – The maximum number of messages that a campaign can send to a single endpoint during a 24-hour period. The maximum value is 100.
maximum_duration (Union[int, float, None]) – The maximum amount of time, in seconds, that a campaign can attempt to deliver a message after the scheduled start time for the campaign. The minimum value is 60 seconds.
messages_per_second (Union[int, float, None]) – The maximum number of messages that a campaign can send each second. The minimum value is 1. The maximum value is 20,000.
total (Union[int, float, None]) – The maximum number of messages that a campaign can send to a single endpoint during the course of the campaign. The maximum value is 100.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-applicationsettings-limits.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_pinpoint as pinpoint

limits_property = pinpoint.CfnApplicationSettings.LimitsProperty(
    daily=123,
    maximum_duration=123,
    messages_per_second=123,
    total=123
)

Attributes

daily

The maximum number of messages that a campaign can send to a single endpoint during a 24-hour period.

The maximum value is 100.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-applicationsettings-limits.html#cfn-pinpoint-applicationsettings-limits-daily

maximum_duration

The maximum amount of time, in seconds, that a campaign can attempt to deliver a message after the scheduled start time for the campaign.

The minimum value is 60 seconds.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-applicationsettings-limits.html#cfn-pinpoint-applicationsettings-limits-maximumduration

messages_per_second

The maximum number of messages that a campaign can send each second.

The minimum value is 1. The maximum value is 20,000.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-applicationsettings-limits.html#cfn-pinpoint-applicationsettings-limits-messagespersecond

total

The maximum number of messages that a campaign can send to a single endpoint during the course of the campaign.

The maximum value is 100.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-applicationsettings-limits.html#cfn-pinpoint-applicationsettings-limits-total

QuietTimeProperty

class CfnApplicationSettings.QuietTimeProperty(*, end, start)

Bases: object

Specifies the start and end times that define a time range when messages aren’t sent to endpoints.

Parameters:

end (str) – The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
start (str) – The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-applicationsettings-quiettime.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_pinpoint as pinpoint

quiet_time_property = pinpoint.CfnApplicationSettings.QuietTimeProperty(
    end="end",
    start="start"
)

Attributes

end

The specific time when quiet time ends.

This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-applicationsettings-quiettime.html#cfn-pinpoint-applicationsettings-quiettime-end

start

The specific time when quiet time begins.

This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-applicationsettings-quiettime.html#cfn-pinpoint-applicationsettings-quiettime-start