BootstrapRole

class aws_cdk.cloud_assembly_schema.BootstrapRole(*, arn, assume_role_additional_options=None, assume_role_external_id=None, bootstrap_stack_version_ssm_parameter=None, requires_bootstrap_stack_version=None)

Bases: object

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

Parameters:

  • arn (str) – The ARN of the IAM role created as part of bootrapping e.g. lookupRoleArn.

  • assume_role_additional_options (Optional[Mapping[str, Any]]) – 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. Default: - No additional options.

  • assume_role_external_id (Optional[str]) – External ID to use when assuming the bootstrap role. Default: - No external ID

  • bootstrap_stack_version_ssm_parameter (Optional[str]) – Name of SSM parameter with bootstrap stack version. Default: - Discover SSM parameter by reading stack

  • requires_bootstrap_stack_version (Union[int, float, None]) – Version of bootstrap stack required to use this role. Default: - No bootstrap stack required

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.cloud_assembly_schema as cloud_assembly_schema

# assume_role_additional_options: Any

bootstrap_role = cloud_assembly_schema.BootstrapRole(
    arn="arn",

    # the properties below are optional
    assume_role_additional_options={
        "assume_role_additional_options_key": assume_role_additional_options
    },
    assume_role_external_id="assumeRoleExternalId",
    bootstrap_stack_version_ssm_parameter="bootstrapStackVersionSsmParameter",
    requires_bootstrap_stack_version=123
)

Attributes

arn

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

assume_role_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.

Default:

  • No additional options.

See:

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

assume_role_external_id

External ID to use when assuming the bootstrap role.

Default:

  • No external ID

bootstrap_stack_version_ssm_parameter

Name of SSM parameter with bootstrap stack version.

Default:

  • Discover SSM parameter by reading stack

requires_bootstrap_stack_version

Version of bootstrap stack required to use this role.

Default:

  • No bootstrap stack required