RoleOptions

class aws_cdk.RoleOptions(*, assume_role_arn, assume_role_additional_options=None, assume_role_external_id=None)

Bases: object

Options for specifying a role.

Parameters:

assume_role_arn (str) – ARN of the role to assume.
assume_role_additional_options (Optional[Mapping[str, Any]]) – Additional options to pass to STS when assuming the role for cloudformation deployments. - RoleArn should not be used. Use the dedicated assumeRoleArn property instead. - ExternalId should not be used. Use the dedicated assumeRoleExternalId instead. - TransitiveTagKeys defaults to use all keys (if any) specified in Tags. E.g, all tags are transitive by default. Default: - No additional options.
assume_role_external_id (Optional[str]) – External ID to use when assuming the role. Default: - No external ID

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 as cdk

# assume_role_additional_options: Any

role_options = cdk.RoleOptions(
    assume_role_arn="assumeRoleArn",

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

Attributes

assume_role_additional_options

Additional options to pass to STS when assuming the role for cloudformation deployments.

RoleArn should not be used. Use the dedicated assumeRoleArn property instead.
ExternalId should not be used. Use the dedicated assumeRoleExternalId instead.
TransitiveTagKeys defaults to use all keys (if any) specified in Tags. E.g, all tags are transitive by default.

Default:

No additional options.

See:

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

assume_role_arn: ARN of the role to assume.

assume_role_external_id

External ID to use when assuming the role.

Default:

No external ID