aws-cdk-lib.aws_codepipeline_actions.ManualApprovalActionProps

ManualApprovalActionProps Struct

Construction properties of the ManualApprovalAction.

ManualApprovalActionProps

extends

• CommonAwsActionProps

used as props by

• ManualApprovalAction

Source

aws-codepipeline-actions/lib/manual-approval-action.ts

Type last changed

v2.180.0 · 21 Feb 2025

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);

Properties

actionNamestringaction_namestractionNameStringActionNamestringActionName*stringrequired#

The physical, human-readable name of the Action.

Note that Action names must be unique within a single Stage.

additionalInformation?optionalstringadditional_information?optionalstradditionalInformation?optionalStringAdditionalInformation?optionalstringAdditionalInformation?optional*string#

Any additional information that you want to include in the notification email message.

externalEntityLink?optionalstringexternal_entity_link?optionalstrexternalEntityLink?optionalStringExternalEntityLink?optionalstringExternalEntityLink?optional*string#

URL you want to provide to the reviewer as part of the approval request.

Default: the approval request will not have an external link

notificationTopic?optionalITopicnotification_topic?optionalITopicnotificationTopic?optionalITopicNotificationTopic?optionalITopicNotificationTopic?optionalITopic#

Optional SNS topic to send notifications to when an approval is pending.

notifyEmails?optionalstring[]notify_emails?optionaltyping.List[str]notifyEmails?optionalList<String>NotifyEmails?optionalstring[]NotifyEmails?optional*[]*string#

A list of email addresses to subscribe to notifications when this Action is pending approval.

If this has been provided, but not notificationTopic, a new Topic will be created.

role?optionalIRolerole?optionalIRolerole?optionalIRoleRole?optionalIRoleRole?optionalIRole#

The Role in which context's this Action will be executing in.

Default: a new Role will be generated

notes

The Pipeline's Role will assume this Role (the required permissions for that will be granted automatically) right before executing this Action. This Action will be passed into your IAction.bind method in the ActionBindOptions.role property.

runOrder?optionalnumberrun_order?optionalint | floatrunOrder?optionalNumberRunOrder?optionaldoubleRunOrder?optional*float64= 1#

The runOrder property for this Action.

RunOrder determines the relative order in which multiple Actions in the same Stage execute.

timeout?optionalDurationtimeout?optionalDurationtimeout?optionalDurationTimeout?optionalDurationTimeout?optionalDuration#

A timeout duration.

Default: 10080 minutes (7 days)

It is configurable up to 86400 minutes (60 days) with a minimum value of 5 minutes.

variablesNamespace?optionalstringvariables_namespace?optionalstrvariablesNamespace?optionalStringVariablesNamespace?optionalstringVariablesNamespace?optional*string#

The name of the namespace to use for variables emitted by this action.

Default: a name will be generated, based on the stage and action names, if any of the action's variables were referenced - otherwise, no namespace will be set