RoleOptions Struct
Options for specifying a role.
| Source | core/lib/stack-synthesizers/asset-manifest-builder.ts |
|---|---|
| Type last changed |
Example
ts
// 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',
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk as cdk
# assume_role_additional_options: Any
role_options = cdk.RoleOptions(
assume_role_arn="assumeRoleArn",
# the properties below are optional
assume_role_additional_options={
"assume_role_additional_options_key": assume_role_additional_options
},
assume_role_external_id="assumeRoleExternalId"
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.*;
Object assumeRoleAdditionalOptions;
RoleOptions roleOptions = RoleOptions.builder()
.assumeRoleArn("assumeRoleArn")
// the properties below are optional
.assumeRoleAdditionalOptions(Map.of(
"assumeRoleAdditionalOptionsKey", assumeRoleAdditionalOptions))
.assumeRoleExternalId("assumeRoleExternalId")
.build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK;
var assumeRoleAdditionalOptions;
var roleOptions = new RoleOptions {
AssumeRoleArn = "assumeRoleArn",
// the properties below are optional
AssumeRoleAdditionalOptions = new Dictionary<string, object> {
{ "assumeRoleAdditionalOptionsKey", assumeRoleAdditionalOptions }
},
AssumeRoleExternalId = "assumeRoleExternalId"
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
var assumeRoleAdditionalOptions interface{}
roleOptions := &RoleOptions{
AssumeRoleArn: jsii.String("assumeRoleArn"),
// the properties below are optional
AssumeRoleAdditionalOptions: map[string]interface{}{
"assumeRoleAdditionalOptionsKey": assumeRoleAdditionalOptions,
},
AssumeRoleExternalId: jsii.String("assumeRoleExternalId"),
}
Properties
assumeRoleAdditionalOptionsoptional{ [key: string]: any }assume_role_additional_optionsoptionaltyping.Mapping[str, Any]assumeRoleAdditionalOptionsoptionalMap<String, Object>AssumeRoleAdditionalOptionsoptionalIDictionary<string, object>AssumeRoleAdditionalOptionsoptional*map[string]interface{} #Additional options to pass to STS when assuming the role for cloudformation deployments.
Default: No additional options.
notes
RoleArnshould not be used. Use the dedicatedassumeRoleArnproperty instead.ExternalIdshould not be used. Use the dedicatedassumeRoleExternalIdinstead.TransitiveTagKeysdefaults to use all keys (if any) specified inTags. E.g, all tags are transitive by default.
assumeRoleArnstringassume_role_arnstrassumeRoleArnStringAssumeRoleArnstringAssumeRoleArn*string required #ARN of the role to assume.
assumeRoleExternalIdoptionalstringassume_role_external_idoptionalstrassumeRoleExternalIdoptionalStringAssumeRoleExternalIdoptionalstringAssumeRoleExternalIdoptional*string #External ID to use when assuming the role.
Default: No external ID