AWS CDK Reference

Appearance

v2.275.0

BootstrapRole Struct ​

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
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 ​

arnstringarnstrarnStringArnstringArn*stringrequired#
The ARN of the IAM role created as part of bootrapping e.g. lookupRoleArn.
assumeRoleAdditionalOptionsoptional{ [key: string]: any }assume_role_additional_optionsoptionaltyping.Mapping[str, Any]assumeRoleAdditionalOptionsoptionalMap<String, Object>AssumeRoleAdditionalOptionsoptionalIDictionary<string, object>AssumeRoleAdditionalOptionsoptional*map[string]interface{}#
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.
assumeRoleExternalIdoptionalstringassume_role_external_idoptionalstrassumeRoleExternalIdoptionalStringAssumeRoleExternalIdoptionalstringAssumeRoleExternalIdoptional*string#
External ID to use when assuming the bootstrap role.

Default: No external ID

bootstrapStackVersionSsmParameteroptionalstringbootstrap_stack_version_ssm_parameteroptionalstrbootstrapStackVersionSsmParameteroptionalStringBootstrapStackVersionSsmParameteroptionalstringBootstrapStackVersionSsmParameteroptional*string#
Name of SSM parameter with bootstrap stack version.

Default: Discover SSM parameter by reading stack

requiresBootstrapStackVersionoptionalnumberrequires_bootstrap_stack_versionoptionalint | floatrequiresBootstrapStackVersionoptionalNumberRequiresBootstrapStackVersionoptionaldoubleRequiresBootstrapStackVersionoptional*float64#
Version of bootstrap stack required to use this role.

Default: No bootstrap stack required