@cloudcomponents/cdk-developer-tools-notifications
- ApplicationNotificationRule
- MSTeamsIncomingWebhook
- NotificationRule
- PipelineNotificationRule
- ProjectNotificationRule
- RepositoryNotificationRule
- SlackChannel
- SnsTopic
- ApplicationNotificationRuleProps
- CommonNotificationRuleProps
- INotificationRule
- INotificationTarget
- NotificationRuleProps
- NotificationTargetProperty
- PipelineNotificationRuleProps
- ProjectNotificationRuleProps
- RepositoryNotificationRuleProps
@cloudcomponents/cdk-developer-tools-notifications / ApplicationNotificationRule
-
↳
ApplicationNotificationRule
• new ApplicationNotificationRule(scope
, id
, props
)
Name | Type |
---|---|
scope |
Construct |
id |
string |
props |
ApplicationNotificationRuleProps |
• Readonly
node: ConstructNode
The construct tree node associated with this construct.
stability
stable
• Readonly
notificationRuleArn: string
NotificationRule.notificationRuleArn
▸ addTarget(target
): void
Name | Type |
---|---|
target |
INotificationTarget |
void
▸ Protected
onPrepare(): void
Perform final modifications before synthesis.
This method can be implemented by derived constructs in order to perform final changes before synthesis. prepare() will be called after child constructs have been prepared.
This is an advanced framework feature. Only use this if you understand the implications.
stability
stable
void
▸ Protected
onSynthesize(session
): void
Allows this construct to emit artifacts into the cloud assembly during synthesis.
This method is usually implemented by framework-level constructs such as Stack
and Asset
as they participate in synthesizing the cloud assembly.
stability
stable
Name | Type | Description |
---|---|---|
session |
ISynthesisSession |
The synthesis session. |
void
▸ Protected
onValidate(): string
[]
Validate the current construct.
This method can be implemented by derived constructs in order to perform validation logic. It is called on all constructs before synthesis.
stability
stable
string
[]
An array of validation error messages, or an empty array if the construct is valid.
▸ Protected
prepare(): void
Perform final modifications before synthesis.
This method can be implemented by derived constructs in order to perform final changes before synthesis. prepare() will be called after child constructs have been prepared.
This is an advanced framework feature. Only use this if you understand the implications.
stability
stable
void
▸ Protected
synthesize(session
): void
Allows this construct to emit artifacts into the cloud assembly during synthesis.
This method is usually implemented by framework-level constructs such as Stack
and Asset
as they participate in synthesizing the cloud assembly.
stability
stable
Name | Type | Description |
---|---|---|
session |
ISynthesisSession |
The synthesis session. |
void
▸ toString(): string
Returns a string representation of this construct.
stability
stable
string
▸ Protected
validate(): string
[]
string
[]
▸ Static
isConstruct(x
): x is Construct
Return whether the given object is a Construct.
stability
stable
Name | Type |
---|---|
x |
any |
x is Construct
@cloudcomponents/cdk-developer-tools-notifications / MSTeamsIncomingWebhook
• new MSTeamsIncomingWebhook(webhook
)
Name | Type |
---|---|
webhook |
MSTeamsIncomingWebhookConfiguration |
▸ bind(scope
, _rule
): NotificationTargetProperty
Name | Type |
---|---|
scope |
Construct |
_rule |
INotificationRule |
@cloudcomponents/cdk-developer-tools-notifications / NotificationRule
-
Construct
↳
NotificationRule
• new NotificationRule(scope
, id
, props
)
Name | Type |
---|---|
scope |
Construct |
id |
string |
props |
NotificationRuleProps |
Construct.constructor
• Readonly
node: ConstructNode
The construct tree node associated with this construct.
stability
stable
Construct.node
• Readonly
notificationRuleArn: string
INotificationRule.notificationRuleArn
• Private
Readonly
targets: NotificationTargetProperty
[]
▸ addTarget(target
): void
Name | Type |
---|---|
target |
INotificationTarget |
void
▸ Protected
onPrepare(): void
Perform final modifications before synthesis.
This method can be implemented by derived constructs in order to perform final changes before synthesis. prepare() will be called after child constructs have been prepared.
This is an advanced framework feature. Only use this if you understand the implications.
stability
stable
void
Construct.onPrepare
▸ Protected
onSynthesize(session
): void
Allows this construct to emit artifacts into the cloud assembly during synthesis.
This method is usually implemented by framework-level constructs such as Stack
and Asset
as they participate in synthesizing the cloud assembly.
stability
stable
Name | Type | Description |
---|---|---|
session |
ISynthesisSession |
The synthesis session. |
void
Construct.onSynthesize
▸ Protected
onValidate(): string
[]
Validate the current construct.
This method can be implemented by derived constructs in order to perform validation logic. It is called on all constructs before synthesis.
stability
stable
string
[]
An array of validation error messages, or an empty array if the construct is valid.
Construct.onValidate
▸ Protected
prepare(): void
Perform final modifications before synthesis.
This method can be implemented by derived constructs in order to perform final changes before synthesis. prepare() will be called after child constructs have been prepared.
This is an advanced framework feature. Only use this if you understand the implications.
stability
stable
void
Construct.prepare
▸ Protected
synthesize(session
): void
Allows this construct to emit artifacts into the cloud assembly during synthesis.
This method is usually implemented by framework-level constructs such as Stack
and Asset
as they participate in synthesizing the cloud assembly.
stability
stable
Name | Type | Description |
---|---|---|
session |
ISynthesisSession |
The synthesis session. |
void
Construct.synthesize
▸ toString(): string
Returns a string representation of this construct.
stability
stable
string
Construct.toString
▸ Protected
validate(): string
[]
string
[]
Construct.validate
▸ Static
isConstruct(x
): x is Construct
Return whether the given object is a Construct.
stability
stable
Name | Type |
---|---|
x |
any |
x is Construct
Construct.isConstruct
@cloudcomponents/cdk-developer-tools-notifications / PipelineNotificationRule
-
↳
PipelineNotificationRule
• new PipelineNotificationRule(scope
, id
, props
)
Name | Type |
---|---|
scope |
Construct |
id |
string |
props |
PipelineNotificationRuleProps |
• Readonly
node: ConstructNode
The construct tree node associated with this construct.
stability
stable
• Readonly
notificationRuleArn: string
NotificationRule.notificationRuleArn
▸ addTarget(target
): void
Name | Type |
---|---|
target |
INotificationTarget |
void
▸ Protected
onPrepare(): void
Perform final modifications before synthesis.
This method can be implemented by derived constructs in order to perform final changes before synthesis. prepare() will be called after child constructs have been prepared.
This is an advanced framework feature. Only use this if you understand the implications.
stability
stable
void
▸ Protected
onSynthesize(session
): void
Allows this construct to emit artifacts into the cloud assembly during synthesis.
This method is usually implemented by framework-level constructs such as Stack
and Asset
as they participate in synthesizing the cloud assembly.
stability
stable
Name | Type | Description |
---|---|---|
session |
ISynthesisSession |
The synthesis session. |
void
▸ Protected
onValidate(): string
[]
Validate the current construct.
This method can be implemented by derived constructs in order to perform validation logic. It is called on all constructs before synthesis.
stability
stable
string
[]
An array of validation error messages, or an empty array if the construct is valid.
▸ Protected
prepare(): void
Perform final modifications before synthesis.
This method can be implemented by derived constructs in order to perform final changes before synthesis. prepare() will be called after child constructs have been prepared.
This is an advanced framework feature. Only use this if you understand the implications.
stability
stable
void
▸ Protected
synthesize(session
): void
Allows this construct to emit artifacts into the cloud assembly during synthesis.
This method is usually implemented by framework-level constructs such as Stack
and Asset
as they participate in synthesizing the cloud assembly.
stability
stable
Name | Type | Description |
---|---|---|
session |
ISynthesisSession |
The synthesis session. |
void
▸ toString(): string
Returns a string representation of this construct.
stability
stable
string
▸ Protected
validate(): string
[]
string
[]
▸ Static
isConstruct(x
): x is Construct
Return whether the given object is a Construct.
stability
stable
Name | Type |
---|---|
x |
any |
x is Construct
@cloudcomponents/cdk-developer-tools-notifications / ProjectNotificationRule
-
↳
ProjectNotificationRule
• new ProjectNotificationRule(scope
, id
, props
)
Name | Type |
---|---|
scope |
Construct |
id |
string |
props |
ProjectNotificationRuleProps |
• Readonly
node: ConstructNode
The construct tree node associated with this construct.
stability
stable
• Readonly
notificationRuleArn: string
NotificationRule.notificationRuleArn
▸ addTarget(target
): void
Name | Type |
---|---|
target |
INotificationTarget |
void
▸ Protected
onPrepare(): void
Perform final modifications before synthesis.
This method can be implemented by derived constructs in order to perform final changes before synthesis. prepare() will be called after child constructs have been prepared.
This is an advanced framework feature. Only use this if you understand the implications.
stability
stable
void
▸ Protected
onSynthesize(session
): void
Allows this construct to emit artifacts into the cloud assembly during synthesis.
This method is usually implemented by framework-level constructs such as Stack
and Asset
as they participate in synthesizing the cloud assembly.
stability
stable
Name | Type | Description |
---|---|---|
session |
ISynthesisSession |
The synthesis session. |
void
▸ Protected
onValidate(): string
[]
Validate the current construct.
This method can be implemented by derived constructs in order to perform validation logic. It is called on all constructs before synthesis.
stability
stable
string
[]
An array of validation error messages, or an empty array if the construct is valid.
▸ Protected
prepare(): void
Perform final modifications before synthesis.
This method can be implemented by derived constructs in order to perform final changes before synthesis. prepare() will be called after child constructs have been prepared.
This is an advanced framework feature. Only use this if you understand the implications.
stability
stable
void
▸ Protected
synthesize(session
): void
Allows this construct to emit artifacts into the cloud assembly during synthesis.
This method is usually implemented by framework-level constructs such as Stack
and Asset
as they participate in synthesizing the cloud assembly.
stability
stable
Name | Type | Description |
---|---|---|
session |
ISynthesisSession |
The synthesis session. |
void
▸ toString(): string
Returns a string representation of this construct.
stability
stable
string
▸ Protected
validate(): string
[]
string
[]
▸ Static
isConstruct(x
): x is Construct
Return whether the given object is a Construct.
stability
stable
Name | Type |
---|---|
x |
any |
x is Construct
@cloudcomponents/cdk-developer-tools-notifications / RepositoryNotificationRule
-
↳
RepositoryNotificationRule
• new RepositoryNotificationRule(scope
, id
, props
)
Name | Type |
---|---|
scope |
Construct |
id |
string |
props |
RepositoryNotificationRuleProps |
• Readonly
node: ConstructNode
The construct tree node associated with this construct.
stability
stable
• Readonly
notificationRuleArn: string
NotificationRule.notificationRuleArn
▸ addTarget(target
): void
Name | Type |
---|---|
target |
INotificationTarget |
void
▸ Protected
onPrepare(): void
Perform final modifications before synthesis.
This method can be implemented by derived constructs in order to perform final changes before synthesis. prepare() will be called after child constructs have been prepared.
This is an advanced framework feature. Only use this if you understand the implications.
stability
stable
void
▸ Protected
onSynthesize(session
): void
Allows this construct to emit artifacts into the cloud assembly during synthesis.
This method is usually implemented by framework-level constructs such as Stack
and Asset
as they participate in synthesizing the cloud assembly.
stability
stable
Name | Type | Description |
---|---|---|
session |
ISynthesisSession |
The synthesis session. |
void
▸ Protected
onValidate(): string
[]
Validate the current construct.
This method can be implemented by derived constructs in order to perform validation logic. It is called on all constructs before synthesis.
stability
stable
string
[]
An array of validation error messages, or an empty array if the construct is valid.
▸ Protected
prepare(): void
Perform final modifications before synthesis.
This method can be implemented by derived constructs in order to perform final changes before synthesis. prepare() will be called after child constructs have been prepared.
This is an advanced framework feature. Only use this if you understand the implications.
stability
stable
void
▸ Protected
synthesize(session
): void
Allows this construct to emit artifacts into the cloud assembly during synthesis.
This method is usually implemented by framework-level constructs such as Stack
and Asset
as they participate in synthesizing the cloud assembly.
stability
stable
Name | Type | Description |
---|---|---|
session |
ISynthesisSession |
The synthesis session. |
void
▸ toString(): string
Returns a string representation of this construct.
stability
stable
string
▸ Protected
validate(): string
[]
string
[]
▸ Static
isConstruct(x
): x is Construct
Return whether the given object is a Construct.
stability
stable
Name | Type |
---|---|
x |
any |
x is Construct
@cloudcomponents/cdk-developer-tools-notifications / SlackChannel
• new SlackChannel(channel
)
Name | Type |
---|---|
channel |
ISlackChannelConfiguration |
▸ bind(_scope
, _rule
): NotificationTargetProperty
Name | Type |
---|---|
_scope |
Construct |
_rule |
INotificationRule |
@cloudcomponents/cdk-developer-tools-notifications / SnsTopic
• new SnsTopic(topic
)
Name | Type |
---|---|
topic |
ITopic |
▸ bind(_scope
, _rule
): NotificationTargetProperty
Name | Type |
---|---|
_scope |
Construct |
_rule |
INotificationRule |
@cloudcomponents/cdk-developer-tools-notifications / ApplicationEvent
• DEPLOYMENT_FAILED = "codedeploy-application-deployment-failed"
• DEPLOYMENT_STARTED = "codedeploy-application-deployment-started"
• DEPLOYMENT_SUCCEEDED = "codedeploy-application-deployment-succeeded"
@cloudcomponents/cdk-developer-tools-notifications / DetailType
• BASIC = "BASIC"
• FULL = "FULL"
@cloudcomponents/cdk-developer-tools-notifications / PipelineEvent
- ACTION_EXECUTION_CANCELED
- ACTION_EXECUTION_FAILED
- ACTION_EXECUTION_STARTED
- ACTION_EXECUTION_SUCCEEDED
- MANUAL_APPROVAL_FAILED
- MANUAL_APPROVAL_NEEDED
- MANUAL_APPROVAL_SUCCEEDED
- PIPELINE_EXECUTION_CANCELED
- PIPELINE_EXECUTION_FAILED
- PIPELINE_EXECUTION_RESUMED
- PIPELINE_EXECUTION_STARTED
- PIPELINE_EXECUTION_SUCCEEDED
- PIPELINE_EXECUTION_SUPERSEDED
- STAGE_EXECUTION_CANCELED
- STAGE_EXECUTION_FAILED
- STAGE_EXECUTION_RESUMED
- STAGE_EXECUTION_STARTED
- STAGE_EXECUTION_SUCCEEDED
• ACTION_EXECUTION_CANCELED = "codepipeline-pipeline-action-execution-canceled"
• ACTION_EXECUTION_FAILED = "codepipeline-pipeline-action-execution-failed"
• ACTION_EXECUTION_STARTED = "codepipeline-pipeline-action-execution-started"
• ACTION_EXECUTION_SUCCEEDED = "codepipeline-pipeline-action-execution-succeeded"
• MANUAL_APPROVAL_FAILED = "codepipeline-pipeline-manual-approval-failed"
• MANUAL_APPROVAL_NEEDED = "codepipeline-pipeline-manual-approval-needed"
• MANUAL_APPROVAL_SUCCEEDED = "codepipeline-pipeline-manual-approval-succeeded"
• PIPELINE_EXECUTION_CANCELED = "codepipeline-pipeline-pipeline-execution-canceled"
• PIPELINE_EXECUTION_FAILED = "codepipeline-pipeline-pipeline-execution-failed"
• PIPELINE_EXECUTION_RESUMED = "codepipeline-pipeline-pipeline-execution-resumed"
• PIPELINE_EXECUTION_STARTED = "codepipeline-pipeline-pipeline-execution-started"
• PIPELINE_EXECUTION_SUCCEEDED = "codepipeline-pipeline-pipeline-execution-succeeded"
• PIPELINE_EXECUTION_SUPERSEDED = "codepipeline-pipeline-pipeline-execution-superseded"
• STAGE_EXECUTION_CANCELED = "codepipeline-pipeline-stage-execution-canceled"
• STAGE_EXECUTION_FAILED = "codepipeline-pipeline-stage-execution-failed"
• STAGE_EXECUTION_RESUMED = "codepipeline-pipeline-stage-execution-resumed"
• STAGE_EXECUTION_STARTED = "codepipeline-pipeline-stage-execution-started"
• STAGE_EXECUTION_SUCCEEDED = "codepipeline-pipeline-stage-execution-succeeded"
@cloudcomponents/cdk-developer-tools-notifications / ProjectEvent
- BUILD_PHASE_FAILURE
- BUILD_PHASE_SUCCESS
- BUILD_STATE_FAILED
- BUILD_STATE_IN_PROGRESS
- BUILD_STATE_STOPPED
- BUILD_STATE_SUCCEEDED
• BUILD_PHASE_FAILURE = "codebuild-project-build-phase-failure"
• BUILD_PHASE_SUCCESS = "codebuild-project-build-phase-success"
• BUILD_STATE_FAILED = "codebuild-project-build-state-failed"
• BUILD_STATE_IN_PROGRESS = "codebuild-project-build-state-in-progress"
• BUILD_STATE_STOPPED = "codebuild-project-build-state-stopped"
• BUILD_STATE_SUCCEEDED = "codebuild-project-build-state-succeeded"
@cloudcomponents/cdk-developer-tools-notifications / RepositoryEvent
- APPROVAL_RULE_OVERRIDE
- APPROVAL_STATUS_CHANGED
- BRANCHES_AND_TAGS_CREATED
- BRANCHES_AND_TAGS_DELETED
- BRANCHES_AND_TAGS_UPDATED
- COMMENTS_ON_COMMITS
- COMMENTS_ON_PULL_REQUEST
- PULL_REQUEST_CREATED
- PULL_REQUEST_MERGED
- PULL_REQUEST_SOURCE_UPDATED
- PULL_REQUEST_STATUS_CHANGED
• APPROVAL_RULE_OVERRIDE = "codecommit-repository-approvals-rule-override"
• APPROVAL_STATUS_CHANGED = "codecommit-repository-approvals-status-changed"
• BRANCHES_AND_TAGS_CREATED = "codecommit-repository-branches-and-tags-created"
• BRANCHES_AND_TAGS_DELETED = "codecommit-repository-branches-and-tags-deleted"
• BRANCHES_AND_TAGS_UPDATED = "codecommit-repository-branches-and-tags-updated"
• COMMENTS_ON_COMMITS = "codecommit-repository-comments-on-commits"
• COMMENTS_ON_PULL_REQUEST = "codecommit-repository-comments-on-pull-requests"
• PULL_REQUEST_CREATED = "codecommit-repository-pull-request-created"
• PULL_REQUEST_MERGED = "codecommit-repository-pull-request-merged"
• PULL_REQUEST_SOURCE_UPDATED = "codecommit-repository-pull-request-source-updated"
• PULL_REQUEST_STATUS_CHANGED = "codecommit-repository-pull-request-status-changed"
@cloudcomponents/cdk-developer-tools-notifications / Status
• DISABLED = "DISABLED"
• ENABLED = "ENABLED"
@cloudcomponents/cdk-developer-tools-notifications / TargetType
• AWS_CHATBOT_SLACK = "AWSChatbotSlack"
• SNS = "SNS"
@cloudcomponents/cdk-developer-tools-notifications / ApplicationNotificationRuleProps
-
↳
ApplicationNotificationRuleProps
• Readonly
application: IServerApplication
| ILambdaApplication
| IEcsApplication
• Optional
Readonly
detailType: DetailType
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 AWS 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.
default
FULL
CommonNotificationRuleProps.detailType
• Readonly
events: ApplicationEvent
[]
• Readonly
name: string
The name for the notification rule. Notification rule names must be unique in your AWS account.
CommonNotificationRuleProps.name
• Optional
Readonly
status: 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.
default
ENABLED
CommonNotificationRuleProps.status
• Optional
Readonly
targets: INotificationTarget
[]
SNS topics or AWS Chatbot clients to associate with the notification rule.
CommonNotificationRuleProps.targets
@cloudcomponents/cdk-developer-tools-notifications / CommonNotificationRuleProps
-
CommonNotificationRuleProps
↳
RepositoryNotificationRuleProps
↳
PipelineNotificationRuleProps
• Optional
Readonly
detailType: DetailType
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 AWS 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.
default
FULL
• Readonly
name: string
The name for the notification rule. Notification rule names must be unique in your AWS account.
• Optional
Readonly
status: 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.
default
ENABLED
• Optional
Readonly
targets: INotificationTarget
[]
SNS topics or AWS Chatbot clients to associate with the notification rule.
@cloudcomponents/cdk-developer-tools-notifications / INotificationRule
• Readonly
notificationRuleArn: string
@cloudcomponents/cdk-developer-tools-notifications / INotificationTarget
▸ bind(scope
, rule
): NotificationTargetProperty
Name | Type |
---|---|
scope |
Construct |
rule |
INotificationRule |
@cloudcomponents/cdk-developer-tools-notifications / NotificationRuleProps
-
↳
NotificationRuleProps
• Optional
Readonly
detailType: DetailType
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 AWS 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.
default
FULL
CommonNotificationRuleProps.detailType
• Readonly
events: Events
[]
A list of events associated with this notification rule.
• Readonly
name: string
The name for the notification rule. Notification rule names must be unique in your AWS account.
CommonNotificationRuleProps.name
• Readonly
resource: string
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.
• Optional
Readonly
status: 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.
default
ENABLED
CommonNotificationRuleProps.status
• Optional
Readonly
targets: INotificationTarget
[]
SNS topics or AWS Chatbot clients to associate with the notification rule.
CommonNotificationRuleProps.targets
@cloudcomponents/cdk-developer-tools-notifications / NotificationTargetProperty
• Readonly
targetAddress: string
• Readonly
targetType: TargetType
@cloudcomponents/cdk-developer-tools-notifications / PipelineNotificationRuleProps
-
↳
PipelineNotificationRuleProps
• Optional
Readonly
detailType: DetailType
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 AWS 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.
default
FULL
CommonNotificationRuleProps.detailType
• Readonly
events: PipelineEvent
[]
• Readonly
name: string
The name for the notification rule. Notification rule names must be unique in your AWS account.
CommonNotificationRuleProps.name
• Readonly
pipeline: IPipeline
• Optional
Readonly
status: 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.
default
ENABLED
CommonNotificationRuleProps.status
• Optional
Readonly
targets: INotificationTarget
[]
SNS topics or AWS Chatbot clients to associate with the notification rule.
CommonNotificationRuleProps.targets
@cloudcomponents/cdk-developer-tools-notifications / ProjectNotificationRuleProps
-
↳
ProjectNotificationRuleProps
• Optional
Readonly
detailType: DetailType
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 AWS 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.
default
FULL
CommonNotificationRuleProps.detailType
• Readonly
events: ProjectEvent
[]
• Readonly
name: string
The name for the notification rule. Notification rule names must be unique in your AWS account.
CommonNotificationRuleProps.name
• Readonly
project: IProject
• Optional
Readonly
status: 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.
default
ENABLED
CommonNotificationRuleProps.status
• Optional
Readonly
targets: INotificationTarget
[]
SNS topics or AWS Chatbot clients to associate with the notification rule.
CommonNotificationRuleProps.targets
@cloudcomponents/cdk-developer-tools-notifications / RepositoryNotificationRuleProps
-
↳
RepositoryNotificationRuleProps
• Optional
Readonly
detailType: DetailType
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 AWS 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.
default
FULL
CommonNotificationRuleProps.detailType
• Readonly
events: RepositoryEvent
[]
• Readonly
name: string
The name for the notification rule. Notification rule names must be unique in your AWS account.
CommonNotificationRuleProps.name
• Readonly
repository: IRepository
• Optional
Readonly
status: 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.
default
ENABLED
CommonNotificationRuleProps.status
• Optional
Readonly
targets: INotificationTarget
[]
SNS topics or AWS Chatbot clients to associate with the notification rule.