CfnConfigurationSetPropsMixin

class aws_cdk.mixins_preview.aws_smsvoice.mixins.CfnConfigurationSetPropsMixin(props, *, strategy=None)

Bases: Mixin

Creates a new configuration set.

After you create the configuration set, you can add one or more event destinations to it.

A configuration set is a set of rules that you apply to the SMS and voice messages that you send.

When you send a message, you can optionally specify a single configuration set.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-configurationset.html
CloudformationResource:: AWS::SMSVOICE::ConfigurationSet
Mixin:: true
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.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_smsvoice import mixins as smsvoice_mixins

cfn_configuration_set_props_mixin = smsvoice_mixins.CfnConfigurationSetPropsMixin(smsvoice_mixins.CfnConfigurationSetMixinProps(
    configuration_set_name="configurationSetName",
    default_sender_id="defaultSenderId",
    event_destinations=[smsvoice_mixins.CfnConfigurationSetPropsMixin.EventDestinationProperty(
        cloud_watch_logs_destination=smsvoice_mixins.CfnConfigurationSetPropsMixin.CloudWatchLogsDestinationProperty(
            iam_role_arn="iamRoleArn",
            log_group_arn="logGroupArn"
        ),
        enabled=False,
        event_destination_name="eventDestinationName",
        kinesis_firehose_destination=smsvoice_mixins.CfnConfigurationSetPropsMixin.KinesisFirehoseDestinationProperty(
            delivery_stream_arn="deliveryStreamArn",
            iam_role_arn="iamRoleArn"
        ),
        matching_event_types=["matchingEventTypes"],
        sns_destination=smsvoice_mixins.CfnConfigurationSetPropsMixin.SnsDestinationProperty(
            topic_arn="topicArn"
        )
    )],
    message_feedback_enabled=False,
    protect_configuration_id="protectConfigurationId",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::SMSVOICE::ConfigurationSet.

Parameters:

props (Union[CfnConfigurationSetMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['configurationSetName', 'defaultSenderId', 'eventDestinations', 'messageFeedbackEnabled', 'protectConfigurationId', 'tags']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

CloudWatchLogsDestinationProperty

class CfnConfigurationSetPropsMixin.CloudWatchLogsDestinationProperty(*, iam_role_arn=None, log_group_arn=None)

Bases: object

Contains the destination configuration to use when publishing message sending events.

Parameters:

iam_role_arn (Optional[str]) – The Amazon Resource Name (ARN) of an AWS Identity and Access Management role that is able to write event data to an Amazon CloudWatch destination.
log_group_arn (Optional[str]) – The name of the Amazon CloudWatch log group that you want to record events in.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-configurationset-cloudwatchlogsdestination.html

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.mixins_preview.aws_smsvoice import mixins as smsvoice_mixins

cloud_watch_logs_destination_property = smsvoice_mixins.CfnConfigurationSetPropsMixin.CloudWatchLogsDestinationProperty(
    iam_role_arn="iamRoleArn",
    log_group_arn="logGroupArn"
)

Attributes

iam_role_arn

The Amazon Resource Name (ARN) of an AWS Identity and Access Management role that is able to write event data to an Amazon CloudWatch destination.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-configurationset-cloudwatchlogsdestination.html#cfn-smsvoice-configurationset-cloudwatchlogsdestination-iamrolearn

log_group_arn

The name of the Amazon CloudWatch log group that you want to record events in.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-configurationset-cloudwatchlogsdestination.html#cfn-smsvoice-configurationset-cloudwatchlogsdestination-loggrouparn

EventDestinationProperty

class CfnConfigurationSetPropsMixin.EventDestinationProperty(*, cloud_watch_logs_destination=None, enabled=None, event_destination_name=None, kinesis_firehose_destination=None, matching_event_types=None, sns_destination=None)

Bases: object

Contains information about an event destination.

Event destinations are associated with configuration sets, which enable you to publish message sending events to CloudWatch, Firehose, or Amazon SNS.

Parameters:

cloud_watch_logs_destination (Union[IResolvable, CloudWatchLogsDestinationProperty, Dict[str, Any], None]) – An object that contains information about an event destination that sends logging events to Amazon CloudWatch logs.
enabled (Union[bool, IResolvable, None]) – When set to true events will be logged.
event_destination_name (Optional[str]) – The name of the EventDestination.
kinesis_firehose_destination (Union[IResolvable, KinesisFirehoseDestinationProperty, Dict[str, Any], None]) – An object that contains information about an event destination for logging to Amazon Data Firehose.
matching_event_types (Optional[Sequence[str]]) – An array of event types that determine which events to log. .. epigraph:: The TEXT_SENT event type is not supported.
sns_destination (Union[IResolvable, SnsDestinationProperty, Dict[str, Any], None]) – An object that contains information about an event destination that sends logging events to Amazon SNS.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-configurationset-eventdestination.html

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.mixins_preview.aws_smsvoice import mixins as smsvoice_mixins

event_destination_property = smsvoice_mixins.CfnConfigurationSetPropsMixin.EventDestinationProperty(
    cloud_watch_logs_destination=smsvoice_mixins.CfnConfigurationSetPropsMixin.CloudWatchLogsDestinationProperty(
        iam_role_arn="iamRoleArn",
        log_group_arn="logGroupArn"
    ),
    enabled=False,
    event_destination_name="eventDestinationName",
    kinesis_firehose_destination=smsvoice_mixins.CfnConfigurationSetPropsMixin.KinesisFirehoseDestinationProperty(
        delivery_stream_arn="deliveryStreamArn",
        iam_role_arn="iamRoleArn"
    ),
    matching_event_types=["matchingEventTypes"],
    sns_destination=smsvoice_mixins.CfnConfigurationSetPropsMixin.SnsDestinationProperty(
        topic_arn="topicArn"
    )
)

Attributes

cloud_watch_logs_destination

An object that contains information about an event destination that sends logging events to Amazon CloudWatch logs.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-configurationset-eventdestination.html#cfn-smsvoice-configurationset-eventdestination-cloudwatchlogsdestination

enabled

When set to true events will be logged.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-configurationset-eventdestination.html#cfn-smsvoice-configurationset-eventdestination-enabled

event_destination_name

The name of the EventDestination.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-configurationset-eventdestination.html#cfn-smsvoice-configurationset-eventdestination-eventdestinationname

kinesis_firehose_destination

An object that contains information about an event destination for logging to Amazon Data Firehose.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-configurationset-eventdestination.html#cfn-smsvoice-configurationset-eventdestination-kinesisfirehosedestination

matching_event_types

An array of event types that determine which events to log.

The TEXT_SENT event type is not supported.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-configurationset-eventdestination.html#cfn-smsvoice-configurationset-eventdestination-matchingeventtypes

sns_destination

An object that contains information about an event destination that sends logging events to Amazon SNS.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-configurationset-eventdestination.html#cfn-smsvoice-configurationset-eventdestination-snsdestination

KinesisFirehoseDestinationProperty

class CfnConfigurationSetPropsMixin.KinesisFirehoseDestinationProperty(*, delivery_stream_arn=None, iam_role_arn=None)

Bases: object

Contains the delivery stream Amazon Resource Name (ARN), and the ARN of the AWS Identity and Access Management (IAM) role associated with a Firehose event destination.

Event destinations, such as Firehose, are associated with configuration sets, which enable you to publish message sending events.

Parameters:

delivery_stream_arn (Optional[str]) – The Amazon Resource Name (ARN) of the delivery stream.
iam_role_arn (Optional[str]) – The ARN of an AWS Identity and Access Management role that is able to write event data to an Amazon Data Firehose destination.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-configurationset-kinesisfirehosedestination.html

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.mixins_preview.aws_smsvoice import mixins as smsvoice_mixins

kinesis_firehose_destination_property = smsvoice_mixins.CfnConfigurationSetPropsMixin.KinesisFirehoseDestinationProperty(
    delivery_stream_arn="deliveryStreamArn",
    iam_role_arn="iamRoleArn"
)

Attributes

delivery_stream_arn

The Amazon Resource Name (ARN) of the delivery stream.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-configurationset-kinesisfirehosedestination.html#cfn-smsvoice-configurationset-kinesisfirehosedestination-deliverystreamarn

iam_role_arn

The ARN of an AWS Identity and Access Management role that is able to write event data to an Amazon Data Firehose destination.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-configurationset-kinesisfirehosedestination.html#cfn-smsvoice-configurationset-kinesisfirehosedestination-iamrolearn

SnsDestinationProperty

class CfnConfigurationSetPropsMixin.SnsDestinationProperty(*, topic_arn=None)

Bases: object

An object that defines an Amazon SNS destination for events.

You can use Amazon SNS to send notification when certain events occur.

Parameters:: topic_arn (Optional[str]) – The Amazon Resource Name (ARN) of the Amazon SNS topic that you want to publish events to.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-configurationset-snsdestination.html
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.mixins_preview.aws_smsvoice import mixins as smsvoice_mixins

sns_destination_property = smsvoice_mixins.CfnConfigurationSetPropsMixin.SnsDestinationProperty(
    topic_arn="topicArn"
)

Attributes

topic_arn

The Amazon Resource Name (ARN) of the Amazon SNS topic that you want to publish events to.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-configurationset-snsdestination.html#cfn-smsvoice-configurationset-snsdestination-topicarn