class DeploymentIdentities
Language | Type name |
---|---|
![]() | Amazon.CDK.AppStagingSynthesizer.Alpha.DeploymentIdentities |
![]() | software.amazon.awscdk.app.staging.synthesizer.alpha.DeploymentIdentities |
![]() | aws_cdk.app_staging_synthesizer_alpha.DeploymentIdentities |
![]() | @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
import { BucketEncryption } from 'aws-cdk-lib/aws-s3';
const app = new App({
defaultStackSynthesizer: AppStagingSynthesizer.defaultResources({
appId: 'my-app-id',
stagingBucketEncryption: 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.
deploymentIdentities: DeploymentIdentities.defaultBootstrapRoles({ bootstrapRegion: 'us-east-1' }),
}),
});
Properties
Name | Type | Description |
---|---|---|
cloud | Bootstrap | CloudFormation Execution Role. |
deployment | Bootstrap | Deployment Action Role. |
lookup | Bootstrap | Lookup Role. |
cloudFormationExecutionRole?
Type:
Bootstrap
(optional)
CloudFormation Execution Role.
deploymentRole?
Type:
Bootstrap
(optional)
Deployment Action Role.
lookupRole?
Type:
Bootstrap
(optional, default: use bootstrapped role)
Lookup Role.
Methods
Name | Description |
---|---|
static cli | Use CLI credentials for all deployment identities. |
static default | Use the Roles that have been created by the default bootstrap stack. |
static specify | Specify your own roles for all deployment identities. |
static cliCredentials()
public static cliCredentials(): DeploymentIdentities
Returns
Use CLI credentials for all deployment identities.
static defaultBootstrapRoles(options?)
public static defaultBootstrapRoles(options?: DefaultBootstrapRolesOptions): DeploymentIdentities
Parameters
- options
Default
Bootstrap Roles Options
Returns
Use the Roles that have been created by the default bootstrap stack.
static specifyRoles(roles)
public static specifyRoles(roles: BootstrapRoles): DeploymentIdentities
Parameters
- roles
Bootstrap
Roles
Returns
Specify your own roles for all deployment identities.
These roles must already exist.