RoleProps.Builder, RoleProps.Jsii$Proxy
Modifier | Constructor and Description |
---|---|
protected |
Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
Constructor that initializes the object based on values retrieved from the JsiiObject.
|
Modifier and Type | Method and Description |
---|---|
com.fasterxml.jackson.databind.JsonNode |
$jsii$toJson() |
boolean |
equals(java.lang.Object o) |
IPrincipal |
getAssumedBy()
The IAM principal (i.e.
|
java.lang.String |
getDescription()
A description of the role.
|
java.lang.String |
getExternalId()
(deprecated) ID that the role assumer needs to provide when assuming this role.
|
java.util.List<java.lang.String> |
getExternalIds()
List of IDs that the role assumer needs to provide one of when assuming this role.
|
java.util.Map<java.lang.String,PolicyDocument> |
getInlinePolicies()
A list of named policies to inline into this role.
|
java.util.List<IManagedPolicy> |
getManagedPolicies()
A list of managed policies associated with this role.
|
Duration |
getMaxSessionDuration()
The maximum session duration that you want to set for the specified role.
|
java.lang.String |
getPath()
The path associated with this role.
|
IManagedPolicy |
getPermissionsBoundary()
AWS supports permissions boundaries for IAM entities (users or roles).
|
java.lang.String |
getRoleName()
A name for the IAM role.
|
int |
hashCode() |
protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
objRef
- Reference to the JSII managed object.public final IPrincipal getAssumedBy()
RoleProps
You can later modify the assume role policy document by accessing it via
the assumeRolePolicy
property.
getAssumedBy
in interface RoleProps
public final java.lang.String getDescription()
RoleProps
It can be up to 1000 characters long.
Default: - No description.
getDescription
in interface RoleProps
public final java.lang.String getExternalId()
RoleProps
If the configured and provided external IDs do not match, the AssumeRole operation will fail.
Default: No external ID required
getExternalId
in interface RoleProps
public final java.util.List<java.lang.String> getExternalIds()
RoleProps
If the configured and provided external IDs do not match, the AssumeRole operation will fail.
Default: No external ID required
getExternalIds
in interface RoleProps
public final java.util.Map<java.lang.String,PolicyDocument> getInlinePolicies()
RoleProps
These policies will be
created with the role, whereas those added by addToPolicy
are added
using a separate CloudFormation resource (allowing a way around circular
dependencies that could otherwise be introduced).
Default: - No policy is inlined in the Role resource.
getInlinePolicies
in interface RoleProps
public final java.util.List<IManagedPolicy> getManagedPolicies()
RoleProps
You can add managed policies later using
addManagedPolicy(ManagedPolicy.fromAwsManagedPolicyName(policyName))
.
Default: - No managed policies.
getManagedPolicies
in interface RoleProps
public final Duration getMaxSessionDuration()
RoleProps
This setting can have a value from 1 hour (3600sec) to 12 (43200sec) hours.
Anyone who assumes the role from the AWS CLI or API can use the DurationSeconds API parameter or the duration-seconds CLI parameter to request a longer session. The MaxSessionDuration setting determines the maximum duration that can be requested using the DurationSeconds parameter.
If users don't specify a value for the DurationSeconds parameter, their security credentials are valid for one hour by default. This applies when you use the AssumeRole* API operations or the assume-role* CLI operations but does not apply when you use those operations to create a console URL.
Default: Duration.hours(1)
getMaxSessionDuration
in interface RoleProps
public final java.lang.String getPath()
RoleProps
For information about IAM paths, see Friendly Names and Paths in IAM User Guide.
Default: /
public final IManagedPolicy getPermissionsBoundary()
RoleProps
A permissions boundary is an advanced feature for using a managed policy to set the maximum permissions that an identity-based policy can grant to an IAM entity. An entity's permissions boundary allows it to perform only the actions that are allowed by both its identity-based policies and its permissions boundaries.
Default: - No permissions boundary.
getPermissionsBoundary
in interface RoleProps
public final java.lang.String getRoleName()
RoleProps
For valid values, see the RoleName parameter for the CreateRole action in the IAM API Reference.
IMPORTANT: If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
If you specify a name, you must specify the CAPABILITY_NAMED_IAM value to acknowledge your template's capabilities. For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.
Default: - AWS CloudFormation generates a unique physical ID and uses that ID for the role name.
getRoleName
in interface RoleProps
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
public final boolean equals(java.lang.Object o)
public final int hashCode()