class ManualApprovalAction

Language	Type name
.NET	Amazon.CDK.AWS.CodePipeline.Actions.ManualApprovalAction
Go	github.com/aws/aws-cdk-go/awscdk/v2/awscodepipelineactions#ManualApprovalAction
Java	software.amazon.awscdk.services.codepipeline.actions.ManualApprovalAction
Python	aws_cdk.aws_codepipeline_actions.ManualApprovalAction
TypeScript (source)	aws-cdk-lib » aws_codepipeline_actions » ManualApprovalAction

Implements IAction

Extends Action

Manual approval action.

Example

const pipeline = new codepipeline.Pipeline(this, 'MyPipeline');
const approveStage = pipeline.addStage({ stageName: 'Approve' });
const manualApprovalAction = new codepipeline_actions.ManualApprovalAction({
  actionName: 'Approve',
});
approveStage.addAction(manualApprovalAction);

const role = iam.Role.fromRoleArn(this, 'Admin', Arn.format({ service: 'iam', resource: 'role', resourceName: 'Admin' }, this));
manualApprovalAction.grantManualApproval(role);

Initializer

new ManualApprovalAction(props: ManualApprovalActionProps)

Parameters

• props ManualApprovalActionProps

Properties

Name	Type	Description
actionProperties	ActionProperties	The simple properties of the Action, like its Owner, name, etc.
notificationTopic?	ITopic

---

actionProperties

Type: ActionProperties

The simple properties of the Action, like its Owner, name, etc.

Note that this accessor will be called before the bind callback.

---

notificationTopic?

Type: ITopic (optional)

Methods

Name	Description
bind(scope, stage, options)	The callback invoked when this Action is added to a Pipeline.
grantManualApproval(grantable)	grant the provided principal the permissions to approve or reject this manual approval action.
onStateChange(name, target?, options?)	Creates an Event that will be triggered whenever the state of this Action changes.
protected bound(scope, stage, options)	This is a renamed version of the IAction.bind method.

---

bind(scope, stage, options)

public bind(scope: Construct, stage: IStage, options: ActionBindOptions): ActionConfig

Parameters

• scope Construct
• stage IStage
• options ActionBindOptions

Returns

• ActionConfig

The callback invoked when this Action is added to a Pipeline.

---

grantManualApproval(grantable)

public grantManualApproval(grantable: IGrantable): void

Parameters

• grantable IGrantable — the grantable to attach the permissions to.

grant the provided principal the permissions to approve or reject this manual approval action.

For more info see: https://docs.aws.amazon.com/codepipeline/latest/userguide/approvals-iam-permissions.html

---

onStateChange(name, target?, options?)

public onStateChange(name: string, target?: IRuleTarget, options?: RuleProps): Rule

Parameters

• name string
• target IRuleTarget
• options RuleProps

Returns

• Rule

Creates an Event that will be triggered whenever the state of this Action changes.

---

protected bound(scope, stage, options)

protected bound(scope: Construct, stage: IStage, options: ActionBindOptions): ActionConfig

Parameters

• scope Construct
• stage IStage
• options ActionBindOptions

Returns

• ActionConfig

This is a renamed version of the IAction.bind method.