software.amazon.awscdk.services.codestarnotifications

Class CfnNotificationRule

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.codestarnotifications.CfnNotificationRule

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:37.575Z")
 @Stability(value=Stable)
public class CfnNotificationRule
extends CfnResource
implements IInspectable

A CloudFormation `AWS::CodeStarNotifications::NotificationRule`.

Creates a notification rule for a resource. The rule specifies the events you want notifications about and the targets (such as AWS Chatbot topics or AWS Chatbot clients configured for Slack) where you want to receive them.

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.*;
 Object tags;
 CfnNotificationRule cfnNotificationRule = CfnNotificationRule.Builder.create(this, "MyCfnNotificationRule")
         .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(tags)
         .targetAddress("targetAddress")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnNotificationRule.Builder A fluent builder for CfnNotificationRule.
static interface	CfnNotificationRule.TargetProperty Information about the AWS Chatbot topics or AWS Chatbot clients associated with a notification rule.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnNotificationRule(software.constructs.Construct scope, String id, CfnNotificationRuleProps props) Create a new `AWS::CodeStarNotifications::NotificationRule`.
protected	CfnNotificationRule(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnNotificationRule(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrArn()
protected Map<String,Object>	getCfnProperties()
String	getCreatedBy() `AWS::CodeStarNotifications::NotificationRule.CreatedBy`.
String	getDetailType() The level of detail to include in the notifications for this resource.
String	getEventTypeId() `AWS::CodeStarNotifications::NotificationRule.EventTypeId`.
List<String>	getEventTypeIds() A list of event types associated with this notification rule.
String	getName() The name for the notification rule.
String	getResource() The Amazon Resource Name (ARN) of the resource to associate with the notification rule.
String	getStatus() The status of the notification rule.
TagManager	getTags() A list of tags to apply to this notification rule.
String	getTargetAddress() `AWS::CodeStarNotifications::NotificationRule.TargetAddress`.
Object	getTargets() A list of Amazon Resource Names (ARNs) of AWS Chatbot topics and AWS Chatbot clients to associate with the notification rule.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setCreatedBy(String value) `AWS::CodeStarNotifications::NotificationRule.CreatedBy`.
void	setDetailType(String value) The level of detail to include in the notifications for this resource.
void	setEventTypeId(String value) `AWS::CodeStarNotifications::NotificationRule.EventTypeId`.
void	setEventTypeIds(List<String> value) A list of event types associated with this notification rule.
void	setName(String value) The name for the notification rule.
void	setResource(String value) The Amazon Resource Name (ARN) of the resource to associate with the notification rule.
void	setStatus(String value) The status of the notification rule.
void	setTargetAddress(String value) `AWS::CodeStarNotifications::NotificationRule.TargetAddress`.
void	setTargets(IResolvable value) A list of Amazon Resource Names (ARNs) of AWS Chatbot topics and AWS Chatbot clients to associate with the notification rule.
void	setTargets(List<Object> value) A list of Amazon Resource Names (ARNs) of AWS Chatbot topics and AWS Chatbot clients to associate with the notification rule.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnNotificationRule

protected CfnNotificationRule(software.amazon.jsii.JsiiObjectRef objRef)

CfnNotificationRule

protected CfnNotificationRule(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnNotificationRule

@Stability(value=Stable)
public CfnNotificationRule(@NotNull
                                                    software.constructs.Construct scope,
                                                    @NotNull
                                                    String id,
                                                    @NotNull
                                                    CfnNotificationRuleProps props)

Create a new `AWS::CodeStarNotifications::NotificationRule`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(value=Stable)
 @NotNull
public String getAttrArn()

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

A list of tags to apply to this notification rule.

Key names cannot start with " aws ".

getDetailType

@Stability(value=Stable)
 @NotNull
public String 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.

setDetailType

@Stability(value=Stable)
public void setDetailType(@NotNull
                                                   String value)

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.

getEventTypeIds

@Stability(value=Stable)
 @NotNull
public List<String> 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 .

setEventTypeIds

@Stability(value=Stable)
public void setEventTypeIds(@NotNull
                                                     List<String> value)

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 .

getName

@Stability(value=Stable)
 @NotNull
public String getName()

The name for the notification rule.

Notification rule names must be unique in your AWS account .

setName

@Stability(value=Stable)
public void setName(@NotNull
                                             String value)

The name for the notification rule.

Notification rule names must be unique in your AWS account .

getResource

@Stability(value=Stable)
 @NotNull
public String 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 .

setResource

@Stability(value=Stable)
public void setResource(@NotNull
                                                 String value)

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 .

getTargets

@Stability(value=Stable)
 @NotNull
public Object getTargets()

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

setTargets

@Stability(value=Stable)
public void setTargets(@NotNull
                                                IResolvable value)

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

setTargets

@Stability(value=Stable)
public void setTargets(@NotNull
                                                List<Object> value)

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

getCreatedBy

@Stability(value=Stable)
 @Nullable
public String getCreatedBy()

`AWS::CodeStarNotifications::NotificationRule.CreatedBy`.

setCreatedBy

@Stability(value=Stable)
public void setCreatedBy(@Nullable
                                                  String value)

`AWS::CodeStarNotifications::NotificationRule.CreatedBy`.

getEventTypeId

@Stability(value=Stable)
 @Nullable
public String getEventTypeId()

`AWS::CodeStarNotifications::NotificationRule.EventTypeId`.

setEventTypeId

@Stability(value=Stable)
public void setEventTypeId(@Nullable
                                                    String value)

`AWS::CodeStarNotifications::NotificationRule.EventTypeId`.

getStatus

@Stability(value=Stable)
 @Nullable
public String getStatus()

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.

setStatus

@Stability(value=Stable)
public void setStatus(@Nullable
                                               String value)

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.

getTargetAddress

@Stability(value=Stable)
 @Nullable
public String getTargetAddress()

`AWS::CodeStarNotifications::NotificationRule.TargetAddress`.

setTargetAddress

@Stability(value=Stable)
public void setTargetAddress(@Nullable
                                                      String value)

`AWS::CodeStarNotifications::NotificationRule.TargetAddress`.