BootstrapRole¶
-
class
aws_cdk.cloud_assembly_schema.
BootstrapRole
(*, arn, 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_external_id (
Optional
[str
]) – External ID to use when assuming the bootstrap role. Default: - No external IDbootstrap_stack_version_ssm_parameter (
Optional
[str
]) – Name of SSM parameter with bootstrap stack version. Default: - Discover SSM parameter by reading stackrequires_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 bootstrap_role = cloud_assembly_schema.BootstrapRole( arn="arn", # the properties below are optional 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.
- Return type
str
-
assume_role_external_id
¶ External ID to use when assuming the bootstrap role.
- Default
No external ID
- Return type
Optional
[str
]
-
bootstrap_stack_version_ssm_parameter
¶ Name of SSM parameter with bootstrap stack version.
- Default
Discover SSM parameter by reading stack
- Return type
Optional
[str
]
-
requires_bootstrap_stack_version
¶ Version of bootstrap stack required to use this role.
- Default
No bootstrap stack required
- Return type
Union
[int
,float
,None
]