ManualApprovalActionProps¶
-
class
aws_cdk.aws_codepipeline_actions.
ManualApprovalActionProps
(*, action_name, run_order=None, variables_namespace=None, role=None, additional_information=None, external_entity_link=None, notification_topic=None, notify_emails=None)¶ Bases:
aws_cdk.aws_codepipeline.CommonAwsActionProps
Construction properties of the {@link ManualApprovalAction}.
- Parameters
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: 1variables_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 setrole (
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 generatedadditional_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 linknotification_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 notnotificationTopic
, a new Topic will be created.
- 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)
Attributes
-
action_name
¶ The physical, human-readable name of the Action.
Note that Action names must be unique within a single Stage.
- Return type
str
-
additional_information
¶ Any additional information that you want to include in the notification email message.
- Return type
Optional
[str
]
-
external_entity_link
¶ URL you want to provide to the reviewer as part of the approval request.
- Default
the approval request will not have an external link
- Return type
Optional
[str
]
-
notification_topic
¶ Optional SNS topic to send notifications to when an approval is pending.
- Return type
Optional
[ITopic
]
-
notify_emails
¶ 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.- Return type
Optional
[List
[str
]]
-
role
¶ 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
- Return type
Optional
[IRole
]
-
run_order
¶ The runOrder property for this Action.
RunOrder determines the relative order in which multiple Actions in the same Stage execute.
- Default
1
- See
https://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html
- Return type
Union
[int
,float
,None
]
-
variables_namespace
¶ 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
- Return type
Optional
[str
]