Interface CfnNotificationRuleProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnNotificationRuleProps.Jsii$Proxy
CfnNotificationRule
.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.codestarnotifications.*; CfnNotificationRuleProps cfnNotificationRuleProps = CfnNotificationRuleProps.builder() .detailType("detailType") .eventTypeIds(List.of("eventTypeIds")) .name("name") .resource("resource") .targets(List.of(TargetProperty.builder() .targetAddress("targetAddress") .targetType("targetType") .build())) // the properties below are optional .createdBy("createdBy") .eventTypeId("eventTypeId") .status("status") .tags(Map.of( "tagsKey", "tags")) .targetAddress("targetAddress") .build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnNotificationRuleProps
static final class
An implementation forCfnNotificationRuleProps
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
default String
The name or email alias of the person who created the notification rule.The level of detail to include in the notifications for this resource.default String
The event type associated with this notification rule.A list of event types associated with this notification rule.getName()
The name for the notification rule.The Amazon Resource Name (ARN) of the resource to associate with the notification rule.default String
The status of the notification rule.getTags()
A list of tags to apply to this notification rule.default String
The Amazon Resource Name (ARN) of the Amazon SNS topic or AWS Chatbot client.A list of Amazon Resource Names (ARNs) of Amazon SNS topics and AWS Chatbot clients to associate with the notification rule.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getDetailType
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 Also:
-
getEventTypeIds
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 Also:
-
getName
The name for the notification rule.Notification rule names must be unique in your AWS account .
- See Also:
-
getResource
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 Also:
-
getTargets
A list of Amazon Resource Names (ARNs) of Amazon SNS topics and AWS Chatbot clients to associate with the notification rule.- See Also:
-
getCreatedBy
The name or email alias of the person who created the notification rule.- See Also:
-
getEventTypeId
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 Also:
-
getStatus
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.- See Also:
-
getTags
A list of tags to apply to this notification rule.Key names cannot start with "
aws
".- See Also:
-
getTargetAddress
The Amazon Resource Name (ARN) of the Amazon SNS topic or AWS Chatbot client.- See Also:
-
builder
- Returns:
- a
CfnNotificationRuleProps.Builder
ofCfnNotificationRuleProps
-