Skip to content

Latest commit

 

History

History
2636 lines (1473 loc) · 50.5 KB

File metadata and controls

2636 lines (1473 loc) · 50.5 KB

README

@cloudcomponents/cdk-developer-tools-notifications

@cloudcomponents/cdk-developer-tools-notifications

Table of contents

Enumerations

Classes

Interfaces

Application Notification Rule

@cloudcomponents/cdk-developer-tools-notifications / ApplicationNotificationRule

Class: ApplicationNotificationRule

Hierarchy

Table of contents

Constructors

Properties

Methods

Constructors

constructor

new ApplicationNotificationRule(scope, id, props)

Parameters

Name Type
scope Construct
id string
props ApplicationNotificationRuleProps

Overrides

NotificationRule.constructor

Properties

node

Readonly node: ConstructNode

The construct tree node associated with this construct.

stability stable

Inherited from

NotificationRule.node


notificationRuleArn

Readonly notificationRuleArn: string

Inherited from

NotificationRule.notificationRuleArn

Methods

addTarget

addTarget(target): void

Parameters

Name Type
target INotificationTarget

Returns

void

Inherited from

NotificationRule.addTarget


onPrepare

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

Returns

void

Inherited from

NotificationRule.onPrepare


onSynthesize

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

Parameters

Name Type Description
session ISynthesisSession The synthesis session.

Returns

void

Inherited from

NotificationRule.onSynthesize


onValidate

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

Returns

string[]

An array of validation error messages, or an empty array if the construct is valid.

Inherited from

NotificationRule.onValidate


prepare

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

Returns

void

Inherited from

NotificationRule.prepare


synthesize

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

Parameters

Name Type Description
session ISynthesisSession The synthesis session.

Returns

void

Inherited from

NotificationRule.synthesize


toString

toString(): string

Returns a string representation of this construct.

stability stable

Returns

string

Inherited from

NotificationRule.toString


validate

Protected validate(): string[]

Returns

string[]

Inherited from

NotificationRule.validate


isConstruct

Static isConstruct(x): x is Construct

Return whether the given object is a Construct.

stability stable

Parameters

Name Type
x any

Returns

x is Construct

Inherited from

NotificationRule.isConstruct

MS Teams Incoming Webhook

@cloudcomponents/cdk-developer-tools-notifications / MSTeamsIncomingWebhook

Class: MSTeamsIncomingWebhook

Implements

Table of contents

Constructors

Methods

Constructors

constructor

new MSTeamsIncomingWebhook(webhook)

Parameters

Name Type
webhook MSTeamsIncomingWebhookConfiguration

Methods

bind

bind(scope, _rule): NotificationTargetProperty

Parameters

Name Type
scope Construct
_rule INotificationRule

Returns

NotificationTargetProperty

Implementation of

INotificationTarget.bind

Notification Rule

@cloudcomponents/cdk-developer-tools-notifications / NotificationRule

Class: NotificationRule

Hierarchy

Implements

Table of contents

Constructors

Properties

Methods

Constructors

constructor

new NotificationRule(scope, id, props)

Parameters

Name Type
scope Construct
id string
props NotificationRuleProps

Overrides

Construct.constructor

Properties

node

Readonly node: ConstructNode

The construct tree node associated with this construct.

stability stable

Inherited from

Construct.node


notificationRuleArn

Readonly notificationRuleArn: string

Implementation of

INotificationRule.notificationRuleArn


targets

Private Readonly targets: NotificationTargetProperty[]

Methods

addTarget

addTarget(target): void

Parameters

Name Type
target INotificationTarget

Returns

void


onPrepare

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

Returns

void

Inherited from

Construct.onPrepare


onSynthesize

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

Parameters

Name Type Description
session ISynthesisSession The synthesis session.

Returns

void

Inherited from

Construct.onSynthesize


onValidate

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

Returns

string[]

An array of validation error messages, or an empty array if the construct is valid.

Inherited from

Construct.onValidate


prepare

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

Returns

void

Inherited from

Construct.prepare


synthesize

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

Parameters

Name Type Description
session ISynthesisSession The synthesis session.

Returns

void

Inherited from

Construct.synthesize


toString

toString(): string

Returns a string representation of this construct.

stability stable

Returns

string

Inherited from

Construct.toString


validate

Protected validate(): string[]

Returns

string[]

Overrides

Construct.validate


isConstruct

Static isConstruct(x): x is Construct

Return whether the given object is a Construct.

stability stable

Parameters

Name Type
x any

Returns

x is Construct

Inherited from

Construct.isConstruct

Pipeline Notification Rule

@cloudcomponents/cdk-developer-tools-notifications / PipelineNotificationRule

Class: PipelineNotificationRule

Hierarchy

Table of contents

Constructors

Properties

Methods

Constructors

constructor

new PipelineNotificationRule(scope, id, props)

Parameters

Name Type
scope Construct
id string
props PipelineNotificationRuleProps

Overrides

NotificationRule.constructor

Properties

node

Readonly node: ConstructNode

The construct tree node associated with this construct.

stability stable

Inherited from

NotificationRule.node


notificationRuleArn

Readonly notificationRuleArn: string

Inherited from

NotificationRule.notificationRuleArn

Methods

addTarget

addTarget(target): void

Parameters

Name Type
target INotificationTarget

Returns

void

Inherited from

NotificationRule.addTarget


onPrepare

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

Returns

void

Inherited from

NotificationRule.onPrepare


onSynthesize

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

Parameters

Name Type Description
session ISynthesisSession The synthesis session.

Returns

void

Inherited from

NotificationRule.onSynthesize


onValidate

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

Returns

string[]

An array of validation error messages, or an empty array if the construct is valid.

Inherited from

NotificationRule.onValidate


prepare

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

Returns

void

Inherited from

NotificationRule.prepare


synthesize

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

Parameters

Name Type Description
session ISynthesisSession The synthesis session.

Returns

void

Inherited from

NotificationRule.synthesize


toString

toString(): string

Returns a string representation of this construct.

stability stable

Returns

string

Inherited from

NotificationRule.toString


validate

Protected validate(): string[]

Returns

string[]

Inherited from

NotificationRule.validate


isConstruct

Static isConstruct(x): x is Construct

Return whether the given object is a Construct.

stability stable

Parameters

Name Type
x any

Returns

x is Construct

Inherited from

NotificationRule.isConstruct

Project Notification Rule

@cloudcomponents/cdk-developer-tools-notifications / ProjectNotificationRule

Class: ProjectNotificationRule

Hierarchy

Table of contents

Constructors

Properties

Methods

Constructors

constructor

new ProjectNotificationRule(scope, id, props)

Parameters

Name Type
scope Construct
id string
props ProjectNotificationRuleProps

Overrides

NotificationRule.constructor

Properties

node

Readonly node: ConstructNode

The construct tree node associated with this construct.

stability stable

Inherited from

NotificationRule.node


notificationRuleArn

Readonly notificationRuleArn: string

Inherited from

NotificationRule.notificationRuleArn

Methods

addTarget

addTarget(target): void

Parameters

Name Type
target INotificationTarget

Returns

void

Inherited from

NotificationRule.addTarget


onPrepare

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

Returns

void

Inherited from

NotificationRule.onPrepare


onSynthesize

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

Parameters

Name Type Description
session ISynthesisSession The synthesis session.

Returns

void

Inherited from

NotificationRule.onSynthesize


onValidate

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

Returns

string[]

An array of validation error messages, or an empty array if the construct is valid.

Inherited from

NotificationRule.onValidate


prepare

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

Returns

void

Inherited from

NotificationRule.prepare


synthesize

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

Parameters

Name Type Description
session ISynthesisSession The synthesis session.

Returns

void

Inherited from

NotificationRule.synthesize


toString

toString(): string

Returns a string representation of this construct.

stability stable

Returns

string

Inherited from

NotificationRule.toString


validate

Protected validate(): string[]

Returns

string[]

Inherited from

NotificationRule.validate


isConstruct

Static isConstruct(x): x is Construct

Return whether the given object is a Construct.

stability stable

Parameters

Name Type
x any

Returns

x is Construct

Inherited from

NotificationRule.isConstruct

Repository Notification Rule

@cloudcomponents/cdk-developer-tools-notifications / RepositoryNotificationRule

Class: RepositoryNotificationRule

Hierarchy

Table of contents

Constructors

Properties

Methods

Constructors

constructor

new RepositoryNotificationRule(scope, id, props)

Parameters

Name Type
scope Construct
id string
props RepositoryNotificationRuleProps

Overrides

NotificationRule.constructor

Properties

node

Readonly node: ConstructNode

The construct tree node associated with this construct.

stability stable

Inherited from

NotificationRule.node


notificationRuleArn

Readonly notificationRuleArn: string

Inherited from

NotificationRule.notificationRuleArn

Methods

addTarget

addTarget(target): void

Parameters

Name Type
target INotificationTarget

Returns

void

Inherited from

NotificationRule.addTarget


onPrepare

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

Returns

void

Inherited from

NotificationRule.onPrepare


onSynthesize

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

Parameters

Name Type Description
session ISynthesisSession The synthesis session.

Returns

void

Inherited from

NotificationRule.onSynthesize


onValidate

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

Returns

string[]

An array of validation error messages, or an empty array if the construct is valid.

Inherited from

NotificationRule.onValidate


prepare

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

Returns

void

Inherited from

NotificationRule.prepare


synthesize

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

Parameters

Name Type Description
session ISynthesisSession The synthesis session.

Returns

void

Inherited from

NotificationRule.synthesize


toString

toString(): string

Returns a string representation of this construct.

stability stable

Returns

string

Inherited from

NotificationRule.toString


validate

Protected validate(): string[]

Returns

string[]

Inherited from

NotificationRule.validate


isConstruct

Static isConstruct(x): x is Construct

Return whether the given object is a Construct.

stability stable

Parameters

Name Type
x any

Returns

x is Construct

Inherited from

NotificationRule.isConstruct

Slack Channel

@cloudcomponents/cdk-developer-tools-notifications / SlackChannel

Class: SlackChannel

Implements

Table of contents

Constructors

Methods

Constructors

constructor

new SlackChannel(channel)

Parameters

Name Type
channel ISlackChannelConfiguration

Methods

bind

bind(_scope, _rule): NotificationTargetProperty

Parameters

Name Type
_scope Construct
_rule INotificationRule

Returns

NotificationTargetProperty

Implementation of

INotificationTarget.bind

Sns Topic

@cloudcomponents/cdk-developer-tools-notifications / SnsTopic

Class: SnsTopic

Implements

Table of contents

Constructors

Methods

Constructors

constructor

new SnsTopic(topic)

Parameters

Name Type
topic ITopic

Methods

bind

bind(_scope, _rule): NotificationTargetProperty

Parameters

Name Type
_scope Construct
_rule INotificationRule

Returns

NotificationTargetProperty

Implementation of

INotificationTarget.bind

Application Event

@cloudcomponents/cdk-developer-tools-notifications / ApplicationEvent

Enumeration: ApplicationEvent

Table of contents

Enumeration members

Enumeration members

DEPLOYMENT_FAILED

DEPLOYMENT_FAILED = "codedeploy-application-deployment-failed"


DEPLOYMENT_STARTED

DEPLOYMENT_STARTED = "codedeploy-application-deployment-started"


DEPLOYMENT_SUCCEEDED

DEPLOYMENT_SUCCEEDED = "codedeploy-application-deployment-succeeded"

Detail Type

@cloudcomponents/cdk-developer-tools-notifications / DetailType

Enumeration: DetailType

Table of contents

Enumeration members

Enumeration members

BASIC

BASIC = "BASIC"


FULL

FULL = "FULL"

Pipeline Event

@cloudcomponents/cdk-developer-tools-notifications / PipelineEvent

Enumeration: PipelineEvent

Table of contents

Enumeration members

Enumeration members

ACTION_EXECUTION_CANCELED

ACTION_EXECUTION_CANCELED = "codepipeline-pipeline-action-execution-canceled"


ACTION_EXECUTION_FAILED

ACTION_EXECUTION_FAILED = "codepipeline-pipeline-action-execution-failed"


ACTION_EXECUTION_STARTED

ACTION_EXECUTION_STARTED = "codepipeline-pipeline-action-execution-started"


ACTION_EXECUTION_SUCCEEDED

ACTION_EXECUTION_SUCCEEDED = "codepipeline-pipeline-action-execution-succeeded"


MANUAL_APPROVAL_FAILED

MANUAL_APPROVAL_FAILED = "codepipeline-pipeline-manual-approval-failed"


MANUAL_APPROVAL_NEEDED

MANUAL_APPROVAL_NEEDED = "codepipeline-pipeline-manual-approval-needed"


MANUAL_APPROVAL_SUCCEEDED

MANUAL_APPROVAL_SUCCEEDED = "codepipeline-pipeline-manual-approval-succeeded"


PIPELINE_EXECUTION_CANCELED

PIPELINE_EXECUTION_CANCELED = "codepipeline-pipeline-pipeline-execution-canceled"


PIPELINE_EXECUTION_FAILED

PIPELINE_EXECUTION_FAILED = "codepipeline-pipeline-pipeline-execution-failed"


PIPELINE_EXECUTION_RESUMED

PIPELINE_EXECUTION_RESUMED = "codepipeline-pipeline-pipeline-execution-resumed"


PIPELINE_EXECUTION_STARTED

PIPELINE_EXECUTION_STARTED = "codepipeline-pipeline-pipeline-execution-started"


PIPELINE_EXECUTION_SUCCEEDED

PIPELINE_EXECUTION_SUCCEEDED = "codepipeline-pipeline-pipeline-execution-succeeded"


PIPELINE_EXECUTION_SUPERSEDED

PIPELINE_EXECUTION_SUPERSEDED = "codepipeline-pipeline-pipeline-execution-superseded"


STAGE_EXECUTION_CANCELED

STAGE_EXECUTION_CANCELED = "codepipeline-pipeline-stage-execution-canceled"


STAGE_EXECUTION_FAILED

STAGE_EXECUTION_FAILED = "codepipeline-pipeline-stage-execution-failed"


STAGE_EXECUTION_RESUMED

STAGE_EXECUTION_RESUMED = "codepipeline-pipeline-stage-execution-resumed"


STAGE_EXECUTION_STARTED

STAGE_EXECUTION_STARTED = "codepipeline-pipeline-stage-execution-started"


STAGE_EXECUTION_SUCCEEDED

STAGE_EXECUTION_SUCCEEDED = "codepipeline-pipeline-stage-execution-succeeded"

Project Event

@cloudcomponents/cdk-developer-tools-notifications / ProjectEvent

Enumeration: ProjectEvent

Table of contents

Enumeration members

Enumeration members

BUILD_PHASE_FAILURE

BUILD_PHASE_FAILURE = "codebuild-project-build-phase-failure"


BUILD_PHASE_SUCCESS

BUILD_PHASE_SUCCESS = "codebuild-project-build-phase-success"


BUILD_STATE_FAILED

BUILD_STATE_FAILED = "codebuild-project-build-state-failed"


BUILD_STATE_IN_PROGRESS

BUILD_STATE_IN_PROGRESS = "codebuild-project-build-state-in-progress"


BUILD_STATE_STOPPED

BUILD_STATE_STOPPED = "codebuild-project-build-state-stopped"


BUILD_STATE_SUCCEEDED

BUILD_STATE_SUCCEEDED = "codebuild-project-build-state-succeeded"

Repository Event

@cloudcomponents/cdk-developer-tools-notifications / RepositoryEvent

Enumeration: RepositoryEvent

Table of contents

Enumeration members

Enumeration members

APPROVAL_RULE_OVERRIDE

APPROVAL_RULE_OVERRIDE = "codecommit-repository-approvals-rule-override"


APPROVAL_STATUS_CHANGED

APPROVAL_STATUS_CHANGED = "codecommit-repository-approvals-status-changed"


BRANCHES_AND_TAGS_CREATED

BRANCHES_AND_TAGS_CREATED = "codecommit-repository-branches-and-tags-created"


BRANCHES_AND_TAGS_DELETED

BRANCHES_AND_TAGS_DELETED = "codecommit-repository-branches-and-tags-deleted"


BRANCHES_AND_TAGS_UPDATED

BRANCHES_AND_TAGS_UPDATED = "codecommit-repository-branches-and-tags-updated"


COMMENTS_ON_COMMITS

COMMENTS_ON_COMMITS = "codecommit-repository-comments-on-commits"


COMMENTS_ON_PULL_REQUEST

COMMENTS_ON_PULL_REQUEST = "codecommit-repository-comments-on-pull-requests"


PULL_REQUEST_CREATED

PULL_REQUEST_CREATED = "codecommit-repository-pull-request-created"


PULL_REQUEST_MERGED

PULL_REQUEST_MERGED = "codecommit-repository-pull-request-merged"


PULL_REQUEST_SOURCE_UPDATED

PULL_REQUEST_SOURCE_UPDATED = "codecommit-repository-pull-request-source-updated"


PULL_REQUEST_STATUS_CHANGED

PULL_REQUEST_STATUS_CHANGED = "codecommit-repository-pull-request-status-changed"

Status

@cloudcomponents/cdk-developer-tools-notifications / Status

Enumeration: Status

Table of contents

Enumeration members

Enumeration members

DISABLED

DISABLED = "DISABLED"


ENABLED

ENABLED = "ENABLED"

Target Type

@cloudcomponents/cdk-developer-tools-notifications / TargetType

Enumeration: TargetType

Table of contents

Enumeration members

Enumeration members

AWS_CHATBOT_SLACK

AWS_CHATBOT_SLACK = "AWSChatbotSlack"


SNS

SNS = "SNS"

Application Notification Rule Props

@cloudcomponents/cdk-developer-tools-notifications / ApplicationNotificationRuleProps

Interface: ApplicationNotificationRuleProps

Hierarchy

Table of contents

Properties

Properties

application

Readonly application: IServerApplication | ILambdaApplication | IEcsApplication


detailType

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

Inherited from

CommonNotificationRuleProps.detailType


events

Readonly events: ApplicationEvent[]


name

Readonly name: string

The name for the notification rule. Notification rule names must be unique in your AWS account.

Inherited from

CommonNotificationRuleProps.name


status

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

Inherited from

CommonNotificationRuleProps.status


targets

Optional Readonly targets: INotificationTarget[]

SNS topics or AWS Chatbot clients to associate with the notification rule.

Inherited from

CommonNotificationRuleProps.targets

Common Notification Rule Props

@cloudcomponents/cdk-developer-tools-notifications / CommonNotificationRuleProps

Interface: CommonNotificationRuleProps

Hierarchy

Table of contents

Properties

Properties

detailType

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


name

Readonly name: string

The name for the notification rule. Notification rule names must be unique in your AWS account.


status

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


targets

Optional Readonly targets: INotificationTarget[]

SNS topics or AWS Chatbot clients to associate with the notification rule.

I Notification Rule

@cloudcomponents/cdk-developer-tools-notifications / INotificationRule

Interface: INotificationRule

Implemented by

Table of contents

Properties

Properties

notificationRuleArn

Readonly notificationRuleArn: string

I Notification Target

@cloudcomponents/cdk-developer-tools-notifications / INotificationTarget

Interface: INotificationTarget

Implemented by

Table of contents

Methods

Methods

bind

bind(scope, rule): NotificationTargetProperty

Parameters

Name Type
scope Construct
rule INotificationRule

Returns

NotificationTargetProperty

Notification Rule Props

@cloudcomponents/cdk-developer-tools-notifications / NotificationRuleProps

Interface: NotificationRuleProps

Hierarchy

Table of contents

Properties

Properties

detailType

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

Inherited from

CommonNotificationRuleProps.detailType


events

Readonly events: Events[]

A list of events associated with this notification rule.


name

Readonly name: string

The name for the notification rule. Notification rule names must be unique in your AWS account.

Inherited from

CommonNotificationRuleProps.name


resource

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.


status

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

Inherited from

CommonNotificationRuleProps.status


targets

Optional Readonly targets: INotificationTarget[]

SNS topics or AWS Chatbot clients to associate with the notification rule.

Inherited from

CommonNotificationRuleProps.targets

Notification Target Property

@cloudcomponents/cdk-developer-tools-notifications / NotificationTargetProperty

Interface: NotificationTargetProperty

Table of contents

Properties

Properties

targetAddress

Readonly targetAddress: string


targetType

Readonly targetType: TargetType

Pipeline Notification Rule Props

@cloudcomponents/cdk-developer-tools-notifications / PipelineNotificationRuleProps

Interface: PipelineNotificationRuleProps

Hierarchy

Table of contents

Properties

Properties

detailType

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

Inherited from

CommonNotificationRuleProps.detailType


events

Readonly events: PipelineEvent[]


name

Readonly name: string

The name for the notification rule. Notification rule names must be unique in your AWS account.

Inherited from

CommonNotificationRuleProps.name


pipeline

Readonly pipeline: IPipeline


status

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

Inherited from

CommonNotificationRuleProps.status


targets

Optional Readonly targets: INotificationTarget[]

SNS topics or AWS Chatbot clients to associate with the notification rule.

Inherited from

CommonNotificationRuleProps.targets

Project Notification Rule Props

@cloudcomponents/cdk-developer-tools-notifications / ProjectNotificationRuleProps

Interface: ProjectNotificationRuleProps

Hierarchy

Table of contents

Properties

Properties

detailType

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

Inherited from

CommonNotificationRuleProps.detailType


events

Readonly events: ProjectEvent[]


name

Readonly name: string

The name for the notification rule. Notification rule names must be unique in your AWS account.

Inherited from

CommonNotificationRuleProps.name


project

Readonly project: IProject


status

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

Inherited from

CommonNotificationRuleProps.status


targets

Optional Readonly targets: INotificationTarget[]

SNS topics or AWS Chatbot clients to associate with the notification rule.

Inherited from

CommonNotificationRuleProps.targets

Repository Notification Rule Props

@cloudcomponents/cdk-developer-tools-notifications / RepositoryNotificationRuleProps

Interface: RepositoryNotificationRuleProps

Hierarchy

Table of contents

Properties

Properties

detailType

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

Inherited from

CommonNotificationRuleProps.detailType


events

Readonly events: RepositoryEvent[]


name

Readonly name: string

The name for the notification rule. Notification rule names must be unique in your AWS account.

Inherited from

CommonNotificationRuleProps.name


repository

Readonly repository: IRepository


status

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

Inherited from

CommonNotificationRuleProps.status


targets

Optional Readonly targets: INotificationTarget[]

SNS topics or AWS Chatbot clients to associate with the notification rule.

Inherited from

CommonNotificationRuleProps.targets