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
[IResolvable
,TargetProperty
,Dict
[str
,Any
]]]]) – A list of Amazon Resource Names (ARNs) of Amazon SNS topics and AWS Chatbot clients to associate with the notification rule.created_by (
Optional
[str
]) – The name or email alias of the person who created the notification rule.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 .
status (
Optional
[str
]) – The status of the notification rule. The default value isENABLED
. If the status is set toDISABLED
, 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 SNS topic or AWS Chatbot client.
- See:
- 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 import aws_codestarnotifications as codestarnotifications 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_key": "tags" }, target_address="targetAddress" )
Attributes
- created_by
The name or email alias of the person who created the notification rule.
- 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.
- 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 .
- 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 .
- name
The name for the notification rule.
Notification rule names must be unique in your AWS account .
- 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 .
- status
The status of the notification rule.
The default value is
ENABLED
. If the status is set toDISABLED
, notifications aren’t sent for the notification rule.
- tags
A list of tags to apply to this notification rule.
Key names cannot start with “
aws
“.
- target_address
The Amazon Resource Name (ARN) of the Amazon SNS topic or AWS Chatbot client.
- targets
A list of Amazon Resource Names (ARNs) of Amazon SNS topics and AWS Chatbot clients to associate with the notification rule.