software.amazon.awscdk.services.iam

Interface FromRoleArnOptions

All Known Implementing Classes:

FromRoleArnOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-11-18T02:14:04.666Z")
public interface FromRoleArnOptions

Options allowing customizing the behavior of Role.fromRoleArn.

Example:

 IRole role = Role.fromRoleArn(this, "Role", "arn:aws:iam::123456789012:role/MyExistingRole", FromRoleArnOptions.builder()
         // Set 'mutable' to 'false' to use the role as-is and prevent adding new
         // policies to it. The default is 'true', which means the role may be
         // modified as part of the deployment.
         .mutable(false)
         .build());
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static FromRoleArnOptions.Builder	builder()
default java.lang.Boolean	getAddGrantsToResources() For immutable roles: add grants to resources instead of dropping them.
default java.lang.Boolean	getMutable() Whether the imported role can be modified by attaching policy resources to it.

Method Detail

getAddGrantsToResources

default java.lang.Boolean getAddGrantsToResources()

For immutable roles: add grants to resources instead of dropping them.

If this is false or not specified, grant permissions added to this role are ignored. It is your own responsibility to make sure the role has the required permissions.

If this is true, any grant permissions will be added to the resource instead.

Default: false

getMutable

default java.lang.Boolean getMutable()

Whether the imported role can be modified by attaching policy resources to it.

Default: true

builder

static FromRoleArnOptions.Builder builder()

Returns:

a FromRoleArnOptions.Builder of FromRoleArnOptions