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';
const roleOptions: cdk.RoleOptions = {
assumeRoleArn: 'assumeRoleArn',
// the properties below are optional
assumeRoleExternalId: 'assumeRoleExternalId',
};
Properties
Name | Type | Description |
---|---|---|
assume | string | ARN of the role to assume. |
assume | string | External 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.