aws-cdk-lib.RoleOptions

RoleOptions Struct

Options for specifying a role.

Source

core/lib/stack-synthesizers/asset-manifest-builder.ts

Type last changed

v2.160.0 · 24 Sep 2024

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

assumeRoleAdditionalOptions?optional{ [key: string]: any }assume_role_additional_options?optionaltyping.Mapping[str, Any]assumeRoleAdditionalOptions?optionalMap<String, Object>AssumeRoleAdditionalOptions?optionalIDictionary<string, object>AssumeRoleAdditionalOptions?optional*map[string]interface{}#

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

Default: No additional options.

notes

• 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.

assumeRoleArnstringassume_role_arnstrassumeRoleArnStringAssumeRoleArnstringAssumeRoleArn*stringrequired#

ARN of the role to assume.

assumeRoleExternalId?optionalstringassume_role_external_id?optionalstrassumeRoleExternalId?optionalStringAssumeRoleExternalId?optionalstringAssumeRoleExternalId?optional*string#

External ID to use when assuming the role.

Default: No external ID