CfnNotificationRuleProps

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

Bases: object

Properties for defining a AWS::CodeStarNotifications::NotificationRule.

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

  • detail_type (str) – AWS::CodeStarNotifications::NotificationRule.DetailType.

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

  • event_type_ids (Sequence[str]) – AWS::CodeStarNotifications::NotificationRule.EventTypeIds.

  • name (str) – AWS::CodeStarNotifications::NotificationRule.Name.

  • resource (str) – AWS::CodeStarNotifications::NotificationRule.Resource.

  • status (Optional[str]) – AWS::CodeStarNotifications::NotificationRule.Status.

  • tags (Optional[Any]) – AWS::CodeStarNotifications::NotificationRule.Tags.

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

  • targets (Union[IResolvable, Sequence[Union[TargetProperty, IResolvable]]]) – AWS::CodeStarNotifications::NotificationRule.Targets.

Link

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

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 is of type object

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

AWS::CodeStarNotifications::NotificationRule.DetailType.

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

AWS::CodeStarNotifications::NotificationRule.EventTypeIds.

Link

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

Return type

List[str]

name

AWS::CodeStarNotifications::NotificationRule.Name.

Link

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

Return type

str

resource

AWS::CodeStarNotifications::NotificationRule.Resource.

Link

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

Return type

str

status

AWS::CodeStarNotifications::NotificationRule.Status.

Link

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

Return type

Optional[str]

tags

AWS::CodeStarNotifications::NotificationRule.Tags.

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

AWS::CodeStarNotifications::NotificationRule.Targets.

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