aws-cdk-lib.aws_codepipeline_actions.SelfManagedDeploymentProps

SelfManagedDeploymentProps Struct

Properties for configuring self-managed permissions.

Source

aws-codepipeline-actions/lib/cloudformation/stackset-types.ts

Type last changed

v2.13.0 · 19 Feb 2022

Example

const existingAdminRole = iam.Role.fromRoleName(this, 'AdminRole', 'AWSCloudFormationStackSetAdministrationRole');

const deploymentModel = codepipeline_actions.StackSetDeploymentModel.selfManaged({
  // Use an existing Role. Leave this out to create a new Role.
  administrationRole: existingAdminRole,
});

Properties

administrationRole?optionalIRoleadministration_role?optionalIRoleadministrationRole?optionalIRoleAdministrationRole?optionalIRoleAdministrationRole?optionalIRole#

The IAM role in the administrator account used to assume execution roles in the target accounts.

Default: Assume an existing role named AWSCloudFormationStackSetAdministrationRole in the same account as the pipeline.

notes

You must create this role before using the StackSet action.

The role needs to be assumable by CloudFormation, and it needs to be able to sts:AssumeRole each of the execution roles (whose names are specified in the executionRoleName parameter) in each of the target accounts.

If you do not specify the role, we assume you have created a role named AWSCloudFormationStackSetAdministrationRole.

executionRoleName?optionalstringexecution_role_name?optionalstrexecutionRoleName?optionalStringExecutionRoleName?optionalstringExecutionRoleName?optional*string#

The name of the IAM role in the target accounts used to perform stack set operations.

Default: AWSCloudFormationStackSetExecutionRole

notes

You must create these roles in each of the target accounts before using the StackSet action.

The roles need to be assumable by by the administrationRole, and need to have the permissions necessary to successfully create and modify the resources that the subsequent CloudFormation deployments need. Administrator permissions would be commonly granted to these, but if you can scope the permissions down frome there you would be safer.