CfnNotificationRuleMixinProps

class aws_cdk.mixins_preview.aws_codestarnotifications.mixins.CfnNotificationRuleMixinProps(*, created_by=None, detail_type=None, event_type_id=None, event_type_ids=None, name=None, resource=None, status=None, tags=None, target_address=None, targets=None)

Bases: object

Properties for CfnNotificationRulePropsMixin.

Parameters:

created_by (Optional[str]) – The name or email alias of the person who created the notification rule.
detail_type (Optional[str]) – The level of detail to include in the notifications for this resource. BASIC will include only the contents of the event as it would appear in Amazon CloudWatch. FULL will include any supplemental information provided by AWS CodeStar Notifications and/or the service for the resource for which the notification is created.
event_type_id (Optional[str]) – The event type associated with this notification rule. For a complete list of event types and IDs, see Notification concepts in the Developer Tools Console User Guide .
event_type_ids (Optional[Sequence[str]]) –
A list of event types associated with this notification rule. For a complete list of event types and IDs, see Notification concepts in the Developer Tools Console User Guide .
name (Optional[str]) – The name for the notification rule. Notification rule names must be unique in your AWS account .
resource (Optional[str]) – The Amazon Resource Name (ARN) of the resource to associate with the notification rule. Supported resources include pipelines in AWS CodePipeline , repositories in AWS CodeCommit , and build projects in AWS CodeBuild .
status (Optional[str]) – The status of the notification rule. The default value is ENABLED . If the status is set to DISABLED , notifications aren’t sent for the notification rule.
tags (Optional[Mapping[str, str]]) – A list of tags to apply to this notification rule. Key names cannot start with “ aws “.
target_address (Optional[str]) – The Amazon Resource Name (ARN) of the Amazon topic or client.
targets (Union[IResolvable, Sequence[Union[IResolvable, TargetProperty, Dict[str, Any]]], None]) – A list of Amazon Resource Names (ARNs) of Amazon topics and clients to associate with the notification rule.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarnotifications-notificationrule.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_codestarnotifications import mixins as codestarnotifications_mixins

cfn_notification_rule_mixin_props = codestarnotifications_mixins.CfnNotificationRuleMixinProps(
    created_by="createdBy",
    detail_type="detailType",
    event_type_id="eventTypeId",
    event_type_ids=["eventTypeIds"],
    name="name",
    resource="resource",
    status="status",
    tags={
        "tags_key": "tags"
    },
    target_address="targetAddress",
    targets=[codestarnotifications_mixins.CfnNotificationRulePropsMixin.TargetProperty(
        target_address="targetAddress",
        target_type="targetType"
    )]
)

Attributes

created_by

The name or email alias of the person who created the notification rule.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarnotifications-notificationrule.html#cfn-codestarnotifications-notificationrule-createdby

detail_type

The level of detail to include in the notifications for this resource.

BASIC will include only the contents of the event as it would appear in Amazon CloudWatch. FULL will include any supplemental information provided by AWS CodeStar Notifications and/or the service for the resource for which the notification is created.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarnotifications-notificationrule.html#cfn-codestarnotifications-notificationrule-detailtype

event_type_id

The event type associated with this notification rule.

For a complete list of event types and IDs, see Notification concepts in the Developer Tools Console User Guide .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarnotifications-notificationrule.html#cfn-codestarnotifications-notificationrule-eventtypeid

event_type_ids

A list of event types associated with this notification rule.

For a complete list of event types and IDs, see Notification concepts in the Developer Tools Console User Guide .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarnotifications-notificationrule.html#cfn-codestarnotifications-notificationrule-eventtypeids

name

The name for the notification rule.

Notification rule names must be unique in your AWS account .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarnotifications-notificationrule.html#cfn-codestarnotifications-notificationrule-name

resource

The Amazon Resource Name (ARN) of the resource to associate with the notification rule.

Supported resources include pipelines in AWS CodePipeline , repositories in AWS CodeCommit , and build projects in AWS CodeBuild .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarnotifications-notificationrule.html#cfn-codestarnotifications-notificationrule-resource

status

The status of the notification rule.

The default value is ENABLED . If the status is set to DISABLED , notifications aren’t sent for the notification rule.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarnotifications-notificationrule.html#cfn-codestarnotifications-notificationrule-status

tags

A list of tags to apply to this notification rule.

Key names cannot start with “ aws “.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarnotifications-notificationrule.html#cfn-codestarnotifications-notificationrule-tags

target_address

The Amazon Resource Name (ARN) of the Amazon topic or client.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarnotifications-notificationrule.html#cfn-codestarnotifications-notificationrule-targetaddress

targets

A list of Amazon Resource Names (ARNs) of Amazon topics and clients to associate with the notification rule.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarnotifications-notificationrule.html#cfn-codestarnotifications-notificationrule-targets