CfnNotificationRuleProps

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

Bases: object

Properties for defining a CfnNotificationRule.

Parameters
  • detail_type (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_ids (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 (str) – The name for the notification rule. Notification rule names must be unique in your AWS account .

  • resource (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 .

  • targets (Union[IResolvable, Sequence[Union[TargetProperty, Dict[str, Any], IResolvable]]]) – A list of Amazon Resource Names (ARNs) of AWS Chatbot topics and AWS Chatbot clients to associate with the notification rule.

  • created_by (Optional[str]) – AWS::CodeStarNotifications::NotificationRule.CreatedBy.

  • event_type_id (Optional[str]) – AWS::CodeStarNotifications::NotificationRule.EventTypeId.

  • 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[Any]) – A list of tags to apply to this notification rule. Key names cannot start with ” aws “.

  • target_address (Optional[str]) – AWS::CodeStarNotifications::NotificationRule.TargetAddress.

Link

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.
import aws_cdk.aws_codestarnotifications as codestarnotifications

# tags: Any

cfn_notification_rule_props = codestarnotifications.CfnNotificationRuleProps(
    detail_type="detailType",
    event_type_ids=["eventTypeIds"],
    name="name",
    resource="resource",
    targets=[codestarnotifications.CfnNotificationRule.TargetProperty(
        target_address="targetAddress",
        target_type="targetType"
    )],

    # the properties below are optional
    created_by="createdBy",
    event_type_id="eventTypeId",
    status="status",
    tags=tags,
    target_address="targetAddress"
)

Attributes

created_by

AWS::CodeStarNotifications::NotificationRule.CreatedBy.

Link

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

Return type

Optional[str]

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.

Link

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

Return type

str

event_type_id

AWS::CodeStarNotifications::NotificationRule.EventTypeId.

Link

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

Return type

Optional[str]

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 .

Link

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

Return type

List[str]

name

The name for the notification rule.

Notification rule names must be unique in your AWS account .

Link

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

Return type

str

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 .

Link

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

Return type

str

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.

Link

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

Return type

Optional[str]

tags

A list of tags to apply to this notification rule.

Key names cannot start with ” aws “.

Link

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

Return type

Any

target_address

AWS::CodeStarNotifications::NotificationRule.TargetAddress.

Link

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

Return type

Optional[str]

targets

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

Link

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

Return type

Union[IResolvable, List[Union[TargetProperty, IResolvable]]]