aws-cdk-lib.RoleOptions

interface RoleOptions

LanguageType name
.NETAmazon.CDK.RoleOptions
Gogithub.com/aws/aws-cdk-go/awscdk/v2#RoleOptions
Javasoftware.amazon.awscdk.RoleOptions
Pythonaws_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';
const roleOptions: cdk.RoleOptions = {
  assumeRoleArn: 'assumeRoleArn',

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

Properties

NameTypeDescription
assumeRoleArnstringARN of the role to assume.
assumeRoleExternalId?stringExternal ID to use when assuming the role.

assumeRoleArn

Type: string

ARN of the role to assume.


assumeRoleExternalId?

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

External ID to use when assuming the role.