PipelineDeployStackActionProps

class aws_cdk.app_delivery.PipelineDeployStackActionProps(*, admin_permissions, input, stack, capabilities=None, change_set_name=None, create_change_set_action_name=None, create_change_set_run_order=None, execute_change_set_action_name=None, execute_change_set_run_order=None, role=None)

Bases: object

Parameters
  • admin_permissions (bool) – (deprecated) Whether to grant admin permissions to CloudFormation while deploying this template. Setting this to true affects the defaults for role and capabilities, if you don’t specify any alternatives. The default role that will be created for you will have admin (i.e., *) permissions on all resources, and the deployment will have named IAM capabilities (i.e., able to create all IAM resources). This is a shorthand that you can use if you fully trust the templates that are deployed in this pipeline. If you want more fine-grained permissions, use addToRolePolicy and capabilities to control what the CloudFormation deployment is allowed to do.

  • input (Artifact) – (deprecated) The CodePipeline artifact that holds the synthesized app, which is the contents of the <directory> when running cdk synth -o <directory>.

  • stack (Stack) – (deprecated) The CDK stack to be deployed.

  • capabilities (Optional[List[CloudFormationCapabilities]]) – (deprecated) Acknowledge certain changes made as part of deployment. For stacks that contain certain resources, explicit acknowledgement that AWS CloudFormation might create or update those resources. For example, you must specify AnonymousIAM if your stack template contains AWS Identity and Access Management (IAM) resources. For more information Default: [AnonymousIAM, AutoExpand], unless adminPermissions is true

  • change_set_name (Optional[str]) – (deprecated) The name to use when creating a ChangeSet for the stack. Default: CDK-CodePipeline-ChangeSet

  • create_change_set_action_name (Optional[str]) – (deprecated) The name of the CodePipeline action creating the ChangeSet. Default: ‘ChangeSet’

  • create_change_set_run_order (Union[int, float, None]) – (deprecated) The runOrder for the CodePipeline action creating the ChangeSet. Default: 1

  • execute_change_set_action_name (Optional[str]) – (deprecated) The name of the CodePipeline action creating the ChangeSet. Default: ‘Execute’

  • execute_change_set_run_order (Union[int, float, None]) – (deprecated) The runOrder for the CodePipeline action executing the ChangeSet. Default: createChangeSetRunOrder + 1

  • role (Optional[IRole]) – (deprecated) IAM role to assume when deploying changes. If not specified, a fresh role is created. The role is created with zero permissions unless adminPermissions is true, in which case the role will have admin permissions. Default: A fresh role with admin or no permissions (depending on the value of adminPermissions).

Stability

deprecated

Attributes

admin_permissions

(deprecated) Whether to grant admin permissions to CloudFormation while deploying this template.

Setting this to true affects the defaults for role and capabilities, if you don’t specify any alternatives.

The default role that will be created for you will have admin (i.e., *) permissions on all resources, and the deployment will have named IAM capabilities (i.e., able to create all IAM resources).

This is a shorthand that you can use if you fully trust the templates that are deployed in this pipeline. If you want more fine-grained permissions, use addToRolePolicy and capabilities to control what the CloudFormation deployment is allowed to do.

Stability

deprecated

Return type

bool

capabilities

(deprecated) Acknowledge certain changes made as part of deployment.

For stacks that contain certain resources, explicit acknowledgement that AWS CloudFormation might create or update those resources. For example, you must specify AnonymousIAM if your stack template contains AWS Identity and Access Management (IAM) resources. For more information

Default

[AnonymousIAM, AutoExpand], unless adminPermissions is true

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities

Stability

deprecated

Return type

Optional[List[CloudFormationCapabilities]]

change_set_name

(deprecated) The name to use when creating a ChangeSet for the stack.

Default

CDK-CodePipeline-ChangeSet

Stability

deprecated

Return type

Optional[str]

create_change_set_action_name

(deprecated) The name of the CodePipeline action creating the ChangeSet.

Default

‘ChangeSet’

Stability

deprecated

Return type

Optional[str]

create_change_set_run_order

(deprecated) The runOrder for the CodePipeline action creating the ChangeSet.

Default

1

Stability

deprecated

Return type

Union[int, float, None]

execute_change_set_action_name

(deprecated) The name of the CodePipeline action creating the ChangeSet.

Default

‘Execute’

Stability

deprecated

Return type

Optional[str]

execute_change_set_run_order

(deprecated) The runOrder for the CodePipeline action executing the ChangeSet.

Default

createChangeSetRunOrder + 1

Stability

deprecated

Return type

Union[int, float, None]

input

(deprecated) The CodePipeline artifact that holds the synthesized app, which is the contents of the <directory> when running cdk synth -o <directory>.

Stability

deprecated

Return type

Artifact

role

(deprecated) IAM role to assume when deploying changes.

If not specified, a fresh role is created. The role is created with zero permissions unless adminPermissions is true, in which case the role will have admin permissions.

Default

A fresh role with admin or no permissions (depending on the value of adminPermissions).

Stability

deprecated

Return type

Optional[IRole]

stack

(deprecated) The CDK stack to be deployed.

Stability

deprecated

Return type

Stack