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

class BootstrapRole ๐Ÿ”น

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

Bootstrapped role specifier.

These roles must exist already. This class does not create new IAM Roles.

Example

const app = new App({
  defaultStackSynthesizer: AppStagingSynthesizer.defaultResources({
    appId: 'my-app-id',
    deploymentIdentities: DeploymentIdentities.specifyRoles({
      cloudFormationExecutionRole: BootstrapRole.fromRoleArn('arn:aws:iam::123456789012:role/Execute'),
      deploymentRole: BootstrapRole.fromRoleArn('arn:aws:iam::123456789012:role/Deploy'),
      lookupRole: BootstrapRole.fromRoleArn('arn:aws:iam::123456789012:role/Lookup'),
    }),
  }),
});

Methods

NameDescription
isCliCredentials()๐Ÿ”นWhether or not this is object was created using BootstrapRole.cliCredentials().
static cliCredentials()๐Ÿ”นUse the currently assumed role/credentials.
static fromRoleArn(arn)๐Ÿ”นSpecify an existing IAM Role to assume.

isCliCredentials()๐Ÿ”น

public isCliCredentials(): boolean

Returns

  • boolean

Whether or not this is object was created using BootstrapRole.cliCredentials().


static cliCredentials()๐Ÿ”น

public static cliCredentials(): BootstrapRole

Returns

  • BootstrapRole

Use the currently assumed role/credentials.


static fromRoleArn(arn)๐Ÿ”น

public static fromRoleArn(arn: string): BootstrapRole

Parameters

  • arn string

Returns

  • BootstrapRole

Specify an existing IAM Role to assume.