DeploymentIdentities

class aws_cdk.app_staging_synthesizer_alpha.DeploymentIdentities(*args: Any, **kwargs)

Bases: object

(experimental) Deployment identities are the class of roles to be assumed by the CDK when deploying the App.

Stability:: experimental
ExampleMetadata:: infused

Example:

from aws_cdk.aws_s3 import BucketEncryption


app = App(
    default_stack_synthesizer=AppStagingSynthesizer.default_resources(
        app_id="my-app-id",
        staging_bucket_encryption=BucketEncryption.S3_MANAGED,

        # The following line is optional. By default it is assumed you have bootstrapped in the same
        # region(s) as the stack(s) you are deploying.
        deployment_identities=DeploymentIdentities.default_bootstrap_roles(bootstrap_region="us-east-1")
    )
)

Attributes

cloud_formation_execution_role

(experimental) CloudFormation Execution Role.

Stability:: experimental

deployment_role

(experimental) Deployment Action Role.

Stability:: experimental

lookup_role

(experimental) Lookup Role.

Default:

use bootstrapped role

Stability:

experimental

Static Methods

classmethod cli_credentials()

(experimental) Use CLI credentials for all deployment identities.

Stability:: experimental
Return type:: DeploymentIdentities

classmethod default_bootstrap_roles(*, bootstrap_region=None)

(experimental) Use the Roles that have been created by the default bootstrap stack.

Parameters:: bootstrap_region (Optional[str]) – (experimental) The region where the default bootstrap roles have been created. By default, the region in which the stack is deployed is used. Default: - the stack’s current region
Stability:: experimental
Return type:: DeploymentIdentities

classmethod specify_roles(*, cloud_formation_execution_role=None, deployment_role=None, lookup_role=None)

(experimental) Specify your own roles for all deployment identities.

These roles must already exist.

Parameters:

cloud_formation_execution_role (Optional[BootstrapRole]) – (experimental) CloudFormation Execution Role. Default: - use bootstrapped role
deployment_role (Optional[BootstrapRole]) – (experimental) Deployment Action Role. Default: - use boostrapped role
lookup_role (Optional[BootstrapRole]) – (experimental) Lookup Role. Default: - use bootstrapped role

Stability:

experimental

Return type:

DeploymentIdentities