# BootstrapRole

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

- Source: [`node_modules/@aws-cdk/cloud-assembly-schema/lib/cloud-assembly/artifact-schema.d.ts`](https://github.com/aws/aws-cdk/blob/v2.274.0/packages/aws-cdk-lib/node_modules/@aws-cdk/cloud-assembly-schema/lib/cloud-assembly/artifact-schema.d.ts#L5)
- Type last changed: v2.160.0 · 24 Sep 2024

## Example

```ts
// 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`: string (required) — The ARN of the IAM role created as part of bootrapping e.g. lookupRoleArn.

- `assumeRoleAdditionalOptions`: { [key: string]: any } — Additional options to pass to STS when assuming the role.

  **Default:** No additional options.

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

- `assumeRoleExternalId`: string — External ID to use when assuming the bootstrap role.

  **Default:** No external ID

- `bootstrapStackVersionSsmParameter`: string — Name of SSM parameter with bootstrap stack version.

  **Default:** Discover SSM parameter by reading stack

- `requiresBootstrapStackVersion`: number — Version of bootstrap stack required to use this role.

  **Default:** No bootstrap stack required