ManualApprovalAction

class aws_cdk.aws_codepipeline_actions.ManualApprovalAction(*, additional_information=None, external_entity_link=None, notification_topic=None, notify_emails=None, role=None, action_name, run_order=None, variables_namespace=None)

Bases: Action

Manual approval action.

ExampleMetadata:

infused

Example:

pipeline = codepipeline.Pipeline(self, "MyPipeline")
approve_stage = pipeline.add_stage(stage_name="Approve")
manual_approval_action = codepipeline_actions.ManualApprovalAction(
    action_name="Approve"
)
approve_stage.add_action(manual_approval_action)

role = iam.Role.from_role_arn(self, "Admin", Arn.format(ArnComponents(service="iam", resource="role", resource_name="Admin"), self))
manual_approval_action.grant_manual_approval(role)
Parameters:

  • additional_information (Optional[str]) – Any additional information that you want to include in the notification email message.

  • external_entity_link (Optional[str]) – URL you want to provide to the reviewer as part of the approval request. Default: - the approval request will not have an external link

  • notification_topic (Optional[ITopic]) – Optional SNS topic to send notifications to when an approval is pending.

  • notify_emails (Optional[Sequence[str]]) – 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 (Optional[IRole]) – The Role in which context’s this Action will be executing in. 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 {@link IAction.bind} method in the {@link ActionBindOptions.role} property. Default: a new Role will be generated

  • action_name (str) – The physical, human-readable name of the Action. Note that Action names must be unique within a single Stage.

  • run_order (Union[int, float, None]) – The runOrder property for this Action. RunOrder determines the relative order in which multiple Actions in the same Stage execute. Default: 1

  • variables_namespace (Optional[str]) – 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

Methods

bind(scope, stage, *, bucket, role)

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

Parameters:
Return type:

ActionConfig

grant_manual_approval(grantable)

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

Parameters:

grantable (IGrantable) – the grantable to attach the permissions to.

Return type:

None

on_state_change(name, target=None, *, description=None, enabled=None, event_bus=None, event_pattern=None, rule_name=None, schedule=None, targets=None)

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

Parameters:

  • name (str)

  • target (Optional[IRuleTarget])

  • description (Optional[str]) – A description of the rule’s purpose. Default: - No description.

  • enabled (Optional[bool]) – Indicates whether the rule is enabled. Default: true

  • event_bus (Optional[IEventBus]) – The event bus to associate with this rule. Default: - The default event bus.

  • event_pattern (Union[EventPattern, Dict[str, Any], None]) – Describes which events EventBridge routes to the specified target. These routed events are matched events. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide. Default: - None.

  • rule_name (Optional[str]) – A name for the rule. Default: - AWS CloudFormation generates a unique physical ID and uses that ID for the rule name. For more information, see Name Type.

  • schedule (Optional[Schedule]) – The schedule or rate (frequency) that determines when EventBridge runs the rule. For more information, see Schedule Expression Syntax for Rules in the Amazon EventBridge User Guide. Default: - None.

  • targets (Optional[Sequence[IRuleTarget]]) – Targets to invoke when this rule matches an event. Input will be the full matched event. If you wish to specify custom target input, use addTarget(target[, inputOptions]). Default: - No targets.

Return type:

Rule

Attributes

action_properties

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

Note that this accessor will be called before the {@link bind} callback.

notification_topic