Language	Type name
.NET	Amazon.CDK.cloud_assembly_schema.BootstrapRole
Go	github.com/aws/aws-cdk-go/awscdk/v2/cloudassemblyschema#BootstrapRole
Java	software.amazon.awscdk.cloud_assembly_schema.BootstrapRole
Python	aws_cdk.cloud_assembly_schema.BootstrapRole
TypeScript (source)	aws-cdk-lib » cloud_assembly_schema » BootstrapRole

Information needed to access an IAM role created as part of the bootstrap process.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { cloud_assembly_schema } from 'aws-cdk-lib';

declare const assumeRoleAdditionalOptions: any;
const bootstrapRole: cloud_assembly_schema.BootstrapRole = {
  arn: 'arn',

  // the properties below are optional
  assumeRoleAdditionalOptions: {
    assumeRoleAdditionalOptionsKey: assumeRoleAdditionalOptions,
  },
  assumeRoleExternalId: 'assumeRoleExternalId',
  bootstrapStackVersionSsmParameter: 'bootstrapStackVersionSsmParameter',
  requiresBootstrapStackVersion: 123,
};

Properties

arn

Type: string

The ARN of the IAM role created as part of bootrapping e.g. lookupRoleArn.

assumeRoleAdditionalOptions?

Type: { [string]: any } (optional, default: No additional options.)

Additional options to pass to STS when assuming the role.

• RoleArn should not be used. Use the dedicated arn property instead.
• ExternalId should not be used. Use the dedicated assumeRoleExternalId instead.

See also: https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/STS.html#assumeRole-property

assumeRoleExternalId?

Type: string (optional, default: No external ID)

External ID to use when assuming the bootstrap role.

bootstrapStackVersionSsmParameter?

Type: string (optional, default: Discover SSM parameter by reading stack)

Name of SSM parameter with bootstrap stack version.

requiresBootstrapStackVersion?

Type: number (optional, default: No bootstrap stack required)

Version of bootstrap stack required to use this role.