Package software.amazon.awscdk

Interface RoleOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

RoleOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-12-11T23:26:27.588Z")
@Stability(Stable)
public interface RoleOptions
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.*;
 Object assumeRoleAdditionalOptions;
 RoleOptions roleOptions = RoleOptions.builder()
         .assumeRoleArn("assumeRoleArn")
         // the properties below are optional
         .assumeRoleAdditionalOptions(Map.of(
                 "assumeRoleAdditionalOptionsKey", assumeRoleAdditionalOptions))
         .assumeRoleExternalId("assumeRoleExternalId")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	RoleOptions.Builder	A builder for RoleOptions
static final class	RoleOptions.Jsii$Proxy	An implementation for RoleOptions

Method Summary

Modifier and Type	Method	Description
static RoleOptions.Builder	builder()
default Map<String,Object>	getAssumeRoleAdditionalOptions()	Additional options to pass to STS when assuming the role for cloudformation deployments.
String	getAssumeRoleArn()	ARN of the role to assume.
default String	getAssumeRoleExternalId()	External ID to use when assuming the role.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAssumeRoleArn

@Stability(Stable)
@NotNull
String getAssumeRoleArn()

ARN of the role to assume.

getAssumeRoleAdditionalOptions

@Stability(Stable)
@Nullable
default Map<String,Object> getAssumeRoleAdditionalOptions()

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

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

Default: - No additional options.

See Also:

• https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/STS.html#assumeRole-property

getAssumeRoleExternalId

@Stability(Stable)
@Nullable
default String getAssumeRoleExternalId()

External ID to use when assuming the role.

Default: - No external ID

builder

@Stability(Stable)
static RoleOptions.Builder builder()

Returns:

a RoleOptions.Builder of RoleOptions