@aws-cdk_app-staging-synthesizer-alpha.DeploymentIdentities

class DeploymentIdentities ๐Ÿ”น

LanguageType name
.NETAmazon.CDK.AppStagingSynthesizer.Alpha.DeploymentIdentities
Javasoftware.amazon.awscdk.app.staging.synthesizer.alpha.DeploymentIdentities
Pythonaws_cdk.app_staging_synthesizer_alpha.DeploymentIdentities
TypeScript (source)@aws-cdk/app-staging-synthesizer-alpha ยป DeploymentIdentities

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

Example

const app = new App({
  defaultStackSynthesizer: AppStagingSynthesizer.defaultResources({
    appId: 'my-app-id',

    // 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.
    deploymentIdentities: DeploymentIdentities.defaultBootstrapRoles({ bootstrapRegion: 'us-east-1' }),
  }),
});

Properties

NameTypeDescription
cloudFormationExecutionRole?๐Ÿ”นBootstrapRoleCloudFormation Execution Role.
deploymentRole?๐Ÿ”นBootstrapRoleDeployment Action Role.
lookupRole?๐Ÿ”นBootstrapRoleLookup Role.

cloudFormationExecutionRole?๐Ÿ”น

Type: BootstrapRole (optional)

CloudFormation Execution Role.


deploymentRole?๐Ÿ”น

Type: BootstrapRole (optional)

Deployment Action Role.


lookupRole?๐Ÿ”น

Type: BootstrapRole (optional, default: use bootstrapped role)

Lookup Role.

Methods

NameDescription
static cliCredentials()๐Ÿ”นUse CLI credentials for all deployment identities.
static defaultBootstrapRoles(options?)๐Ÿ”นUse the Roles that have been created by the default bootstrap stack.
static specifyRoles(roles)๐Ÿ”นSpecify your own roles for all deployment identities.

static cliCredentials()๐Ÿ”น

public static cliCredentials(): DeploymentIdentities

Returns

  • DeploymentIdentities

Use CLI credentials for all deployment identities.


static defaultBootstrapRoles(options?)๐Ÿ”น

public static defaultBootstrapRoles(options?: DefaultBootstrapRolesOptions): DeploymentIdentities

Parameters

  • options DefaultBootstrapRolesOptions

Returns

  • DeploymentIdentities

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


static specifyRoles(roles)๐Ÿ”น

public static specifyRoles(roles: BootstrapRoles): DeploymentIdentities

Parameters

  • roles BootstrapRoles

Returns

  • DeploymentIdentities

Specify your own roles for all deployment identities.

These roles must already exist.