interface RoleOptions
Language | Type name |
---|---|
![]() | Amazon.CDK.RoleOptions |
![]() | github.com/aws/aws-cdk-go/awscdk/v2#RoleOptions |
![]() | software.amazon.awscdk.RoleOptions |
![]() | aws_cdk.RoleOptions |
![]() | 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 |
---|---|---|
assume | string | ARN of the role to assume. |
assume | { [string]: any } | Additional options to pass to STS when assuming the role for cloudformation deployments. |
assume | 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 dedicatedassumeRoleArn
property instead.ExternalId
should not be used. Use the dedicatedassumeRoleExternalId
instead.TransitiveTagKeys
defaults to use all keys (if any) specified inTags
. E.g, all tags are transitive by default.
assumeRoleExternalId?
Type:
string
(optional, default: No external ID)
External ID to use when assuming the role.