software.amazon.awscdk.services.codepipeline.actions

Interface SelfManagedDeploymentProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

SelfManagedDeploymentProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:37.564Z")
 @Stability(value=Stable)
public interface SelfManagedDeploymentProps
extends software.amazon.jsii.JsiiSerializable

Properties for configuring self-managed permissions.

Example:

 // Example automatically generated from non-compiling source. May contain errors.
 IRole existingAdminRole = Role.fromRoleName(this, "AdminRole", "AWSCloudFormationStackSetAdministrationRole");
 StackSetDeploymentModel deploymentModel = StackSetDeploymentModel.selfManaged(SelfManagedDeploymentProps.builder()
         // Use an existing Role. Leave this out to create a new Role.
         .administrationRole(existingAdminRole)
         .build());
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	SelfManagedDeploymentProps.Builder A builder for SelfManagedDeploymentProps
static class	SelfManagedDeploymentProps.Jsii$Proxy An implementation for SelfManagedDeploymentProps

Method Summary

Modifier and Type	Method and Description
static SelfManagedDeploymentProps.Builder	builder()
default IRole	getAdministrationRole() The IAM role in the administrator account used to assume execution roles in the target accounts.
default String	getExecutionRoleName() The name of the IAM role in the target accounts used to perform stack set operations.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAdministrationRole

@Stability(value=Stable)
 @Nullable
default IRole getAdministrationRole()

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

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.

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

See Also:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-self-managed.html

getExecutionRoleName

@Stability(value=Stable)
 @Nullable
default String getExecutionRoleName()

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

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.

Default: AWSCloudFormationStackSetExecutionRole

See Also:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-self-managed.html

builder

@Stability(value=Stable)
static SelfManagedDeploymentProps.Builder builder()

Returns:

a SelfManagedDeploymentProps.Builder of SelfManagedDeploymentProps