interface RoleOptions

Language	Type name
.NET	Amazon.CDK.RoleOptions
Go	github.com/aws/aws-cdk-go/awscdk/v2#RoleOptions
Java	software.amazon.awscdk.RoleOptions
Python	aws_cdk.RoleOptions
TypeScript (source)	aws-cdk-lib » RoleOptions

Options for specifying a role.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';

declare const assumeRoleAdditionalOptions: any;
const roleOptions: cdk.RoleOptions = {
  assumeRoleArn: 'assumeRoleArn',

  // the properties below are optional
  assumeRoleAdditionalOptions: {
    assumeRoleAdditionalOptionsKey: assumeRoleAdditionalOptions,
  },
  assumeRoleExternalId: 'assumeRoleExternalId',
};

Properties

Name	Type	Description
assumeRoleArn	string	ARN of the role to assume.
assumeRoleAdditionalOptions?	{ [string]: any }	Additional options to pass to STS when assuming the role for cloudformation deployments.
assumeRoleExternalId?	string	External ID to use when assuming the role.

---

assumeRoleArn

Type: string

ARN of the role to assume.

---

assumeRoleAdditionalOptions?

Type: { [string]: any } (optional, default: No 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.

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

---

assumeRoleExternalId?

Type: string (optional, default: No external ID)

External ID to use when assuming the role.