CfnNotificationChannelPropsMixin

class aws_cdk.mixins_preview.aws_devopsguru.mixins.CfnNotificationChannelPropsMixin(props, *, strategy=None)

Bases: Mixin

Adds a notification channel to DevOps Guru.

A notification channel is used to notify you about important DevOps Guru events, such as when an insight is generated.

If you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission to send it notifications. DevOps Guru adds the required policy on your behalf to send notifications using Amazon SNS in your account. DevOps Guru only supports standard SNS topics. For more information, see Permissions for Amazon SNS topics .

If you use an Amazon SNS topic that is encrypted by an AWS Key Management Service customer-managed key (CMK), then you must add permissions to the CMK. For more information, see Permissions for AWS KMS–encrypted Amazon SNS topics .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-devopsguru-notificationchannel.html
CloudformationResource:: AWS::DevOpsGuru::NotificationChannel
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_devopsguru import mixins as devopsguru_mixins

cfn_notification_channel_props_mixin = devopsguru_mixins.CfnNotificationChannelPropsMixin(devopsguru_mixins.CfnNotificationChannelMixinProps(
    config=devopsguru_mixins.CfnNotificationChannelPropsMixin.NotificationChannelConfigProperty(
        filters=devopsguru_mixins.CfnNotificationChannelPropsMixin.NotificationFilterConfigProperty(
            message_types=["messageTypes"],
            severities=["severities"]
        ),
        sns=devopsguru_mixins.CfnNotificationChannelPropsMixin.SnsChannelConfigProperty(
            topic_arn="topicArn"
        )
    )
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::DevOpsGuru::NotificationChannel.

Parameters:

props (Union[CfnNotificationChannelMixinProps, 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 = ['config']

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

NotificationChannelConfigProperty

class CfnNotificationChannelPropsMixin.NotificationChannelConfigProperty(*, filters=None, sns=None)

Bases: object

Information about notification channels you have configured with DevOps Guru.

The one supported notification channel is Amazon Simple Notification Service (Amazon SNS).

Parameters:

filters (Union[IResolvable, NotificationFilterConfigProperty, Dict[str, Any], None]) – The filter configurations for the Amazon SNS notification topic you use with DevOps Guru. If you do not provide filter configurations, the default configurations are to receive notifications for all message types of High or Medium severity.
sns (Union[IResolvable, SnsChannelConfigProperty, Dict[str, Any], None]) –
Information about a notification channel configured in DevOps Guru to send notifications when insights are created. If you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission to send it notifications. DevOps Guru adds the required policy on your behalf to send notifications using Amazon SNS in your account. DevOps Guru only supports standard SNS topics. For more information, see Permissions for Amazon SNS topics . If you use an Amazon SNS topic that is encrypted by an AWS Key Management Service customer-managed key (CMK), then you must add permissions to the CMK. For more information, see Permissions for AWS KMS–encrypted Amazon SNS topics .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsguru-notificationchannel-notificationchannelconfig.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_devopsguru import mixins as devopsguru_mixins

notification_channel_config_property = devopsguru_mixins.CfnNotificationChannelPropsMixin.NotificationChannelConfigProperty(
    filters=devopsguru_mixins.CfnNotificationChannelPropsMixin.NotificationFilterConfigProperty(
        message_types=["messageTypes"],
        severities=["severities"]
    ),
    sns=devopsguru_mixins.CfnNotificationChannelPropsMixin.SnsChannelConfigProperty(
        topic_arn="topicArn"
    )
)

Attributes

filters

The filter configurations for the Amazon SNS notification topic you use with DevOps Guru.

If you do not provide filter configurations, the default configurations are to receive notifications for all message types of High or Medium severity.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsguru-notificationchannel-notificationchannelconfig.html#cfn-devopsguru-notificationchannel-notificationchannelconfig-filters

sns

Information about a notification channel configured in DevOps Guru to send notifications when insights are created.

If you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission to send it notifications. DevOps Guru adds the required policy on your behalf to send notifications using Amazon SNS in your account. DevOps Guru only supports standard SNS topics. For more information, see Permissions for Amazon SNS topics .

If you use an Amazon SNS topic that is encrypted by an AWS Key Management Service customer-managed key (CMK), then you must add permissions to the CMK. For more information, see Permissions for AWS KMS–encrypted Amazon SNS topics .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsguru-notificationchannel-notificationchannelconfig.html#cfn-devopsguru-notificationchannel-notificationchannelconfig-sns

NotificationFilterConfigProperty

class CfnNotificationChannelPropsMixin.NotificationFilterConfigProperty(*, message_types=None, severities=None)

Bases: object

The filter configurations for the Amazon SNS notification topic you use with DevOps Guru.

You can choose to specify which events or message types to receive notifications for. You can also choose to specify which severity levels to receive notifications for.

Parameters:

message_types (Optional[Sequence[str]]) – The events that you want to receive notifications for. For example, you can choose to receive notifications only when the severity level is upgraded or a new insight is created.
severities (Optional[Sequence[str]]) – The severity levels that you want to receive notifications for. For example, you can choose to receive notifications only for insights with HIGH and MEDIUM severity levels. For more information, see Understanding insight severities .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsguru-notificationchannel-notificationfilterconfig.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_devopsguru import mixins as devopsguru_mixins

notification_filter_config_property = devopsguru_mixins.CfnNotificationChannelPropsMixin.NotificationFilterConfigProperty(
    message_types=["messageTypes"],
    severities=["severities"]
)

Attributes

message_types

The events that you want to receive notifications for.

For example, you can choose to receive notifications only when the severity level is upgraded or a new insight is created.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsguru-notificationchannel-notificationfilterconfig.html#cfn-devopsguru-notificationchannel-notificationfilterconfig-messagetypes

severities

The severity levels that you want to receive notifications for.

For example, you can choose to receive notifications only for insights with HIGH and MEDIUM severity levels. For more information, see Understanding insight severities .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsguru-notificationchannel-notificationfilterconfig.html#cfn-devopsguru-notificationchannel-notificationfilterconfig-severities

SnsChannelConfigProperty

class CfnNotificationChannelPropsMixin.SnsChannelConfigProperty(*, topic_arn=None)

Bases: object

Contains the Amazon Resource Name (ARN) of an Amazon Simple Notification Service topic.

If you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission to send it notifications. DevOps Guru adds the required policy on your behalf to send notifications using Amazon SNS in your account. DevOps Guru only supports standard SNS topics. For more information, see Permissions for Amazon SNS topics .

If you use an Amazon SNS topic that is encrypted by an AWS Key Management Service customer-managed key (CMK), then you must add permissions to the CMK. For more information, see Permissions for AWS KMS–encrypted Amazon SNS topics .

Parameters:: topic_arn (Optional[str]) – The Amazon Resource Name (ARN) of an Amazon Simple Notification Service topic.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsguru-notificationchannel-snschannelconfig.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_devopsguru import mixins as devopsguru_mixins

sns_channel_config_property = devopsguru_mixins.CfnNotificationChannelPropsMixin.SnsChannelConfigProperty(
    topic_arn="topicArn"
)

Attributes

topic_arn

The Amazon Resource Name (ARN) of an Amazon Simple Notification Service topic.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsguru-notificationchannel-snschannelconfig.html#cfn-devopsguru-notificationchannel-snschannelconfig-topicarn