CfnRole (software.amazon.awscdk:aws-cdk-lib 2.42.1 API)

java.lang.Object
- software.amazon.jsii.JsiiObject
- - software.constructs.Construct
  - - software.amazon.awscdk.CfnElement
    - - software.amazon.awscdk.CfnRefElement
      - software.amazon.awscdk.CfnResource
        
        software.amazon.awscdk.services.iam.CfnRole

All Implemented Interfaces:: IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:39.737Z")
 @Stability(value=Stable)
public class CfnRole
extends CfnResource
implements IInspectable

A CloudFormation `AWS::IAM::Role`.

Creates a new role for your AWS account . For more information about roles, see IAM roles . For information about quotas for role names and the number of roles you can create, see IAM and AWS STS quotas in the IAM User Guide .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.iam.*;
 Object assumeRolePolicyDocument;
 Object policyDocument;
 CfnRole cfnRole = CfnRole.Builder.create(this, "MyCfnRole")
         .assumeRolePolicyDocument(assumeRolePolicyDocument)
         // the properties below are optional
         .description("description")
         .managedPolicyArns(List.of("managedPolicyArns"))
         .maxSessionDuration(123)
         .path("path")
         .permissionsBoundary("permissionsBoundary")
         .policies(List.of(PolicyProperty.builder()
                 .policyDocument(policyDocument)
                 .policyName("policyName")
                 .build()))
         .roleName("roleName")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`CfnRole.Builder` A fluent builder for `CfnRole`.
`static interface`	`CfnRole.PolicyProperty` Contains information about an attached policy.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default

Field Summary

Fields
Modifier and Type Field and Description

static String CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.

Fields
Modifier and Type	Field and Description
`static String`	`CFN_RESOURCE_TYPE_NAME` The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors
Modifier	Constructor and Description
	`CfnRole(software.constructs.Construct scope, String id, CfnRoleProps props)` Create a new `AWS::IAM::Role`.
`protected`	`CfnRole(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)`
`protected`	`CfnRole(software.amazon.jsii.JsiiObjectRef objRef)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Object`	`getAssumeRolePolicyDocument()` The trust policy that is associated with this role.
`String`	`getAttrArn()` Returns the Amazon Resource Name (ARN) for the role.
`String`	`getAttrRoleId()` Returns the stable and unique string identifying the role.
`protected Map<String,Object>`	`getCfnProperties()`
`String`	`getDescription()` A description of the role that you provide.
`List<String>`	`getManagedPolicyArns()` A list of Amazon Resource Names (ARNs) of the IAM managed policies that you want to attach to the role.
`Number`	`getMaxSessionDuration()` The maximum session duration (in seconds) that you want to set for the specified role.
`String`	`getPath()` The path to the role.
`String`	`getPermissionsBoundary()` The ARN of the policy used to set the permissions boundary for the role.
`Object`	`getPolicies()` Adds or updates an inline policy document that is embedded in the specified IAM role.
`String`	`getRoleName()` A name for the IAM role, up to 64 characters in length.
`TagManager`	`getTags()` A list of tags that are attached to the role.
`void`	`inspect(TreeInspector inspector)` Examines the CloudFormation resource and discloses attributes.
`protected Map<String,Object>`	`renderProperties(Map<String,Object> props)`
`void`	`setAssumeRolePolicyDocument(Object value)` The trust policy that is associated with this role.
`void`	`setDescription(String value)` A description of the role that you provide.
`void`	`setManagedPolicyArns(List<String> value)` A list of Amazon Resource Names (ARNs) of the IAM managed policies that you want to attach to the role.
`void`	`setMaxSessionDuration(Number value)` The maximum session duration (in seconds) that you want to set for the specified role.
`void`	`setPath(String value)` The path to the role.
`void`	`setPermissionsBoundary(String value)` The ARN of the policy used to set the permissions boundary for the role.
`void`	`setPolicies(IResolvable value)` Adds or updates an inline policy document that is embedded in the specified IAM role.
`void`	`setPolicies(List<Object> value)` Adds or updates an inline policy document that is embedded in the specified IAM role.
`void`	`setRoleName(String value)` A name for the IAM role, up to 64 characters in length.

Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement
getRef

Methods inherited from class software.amazon.awscdk.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct
getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson

- Field Detail
  - CFN_RESOURCE_TYPE_NAME
```
@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME
```
    The CloudFormation resource type name for this resource class.
- Constructor Detail
  - CfnRole
```
protected CfnRole(software.amazon.jsii.JsiiObjectRef objRef)
```
  - CfnRole
```
protected CfnRole(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
```
  - CfnRole
```
@Stability(value=Stable)
public CfnRole(@NotNull
                                        software.constructs.Construct scope,
                                        @NotNull
                                        String id,
                                        @NotNull
                                        CfnRoleProps props)
```
    Create a new `AWS::IAM::Role`.
    
    Parameters:
    
    scope - - scope in which this resource is defined. This parameter is required.
    
    id - - scoped id of the resource. This parameter is required.
    
    props - - resource properties. This parameter is required.
- Method Detail
  - inspect
```
@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)
```
    Examines the CloudFormation resource and discloses attributes.
    
    Specified by:
    
    inspect in interface IInspectable
    
    Parameters:
    
    inspector - - tree inspector to collect and process attributes. This parameter is required.
  - renderProperties
```
@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)
```
    Overrides:
    
    renderProperties in class CfnResource
    
    Parameters:
    
    props - This parameter is required.
  - getAttrArn
```
@Stability(value=Stable)
 @NotNull
public String getAttrArn()
```
    Returns the Amazon Resource Name (ARN) for the role. For example:.
    {"Fn::GetAtt" : ["MyRole", "Arn"] }
    This will return a value such as arn:aws:iam::1234567890:role/MyRole-AJJHDSKSDF .
  - getAttrRoleId
```
@Stability(value=Stable)
 @NotNull
public String getAttrRoleId()
```
    Returns the stable and unique string identifying the role. For example, `AIDAJQABLZS4A3QDU576Q` .
    For more information about IDs, see IAM Identifiers in the IAM User Guide .
  - getCfnProperties
```
@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()
```
    Overrides:
    
    getCfnProperties in class CfnResource
  - getTags
```
@Stability(value=Stable)
 @NotNull
public TagManager getTags()
```
    A list of tags that are attached to the role.
    For more information about tagging, see Tagging IAM resources in the IAM User Guide .
  - getAssumeRolePolicyDocument
```
@Stability(value=Stable)
 @NotNull
public Object getAssumeRolePolicyDocument()
```
    The trust policy that is associated with this role.
    Trust policies define which entities can assume the role. You can associate only one trust policy with a role. For an example of a policy that can be used to assume a role, see Template Examples . For more information about the elements that you can use in an IAM policy, see IAM Policy Elements Reference in the IAM User Guide .
  - setAssumeRolePolicyDocument
```
@Stability(value=Stable)
public void setAssumeRolePolicyDocument(@NotNull
                                                                 Object value)
```
    The trust policy that is associated with this role.
    Trust policies define which entities can assume the role. You can associate only one trust policy with a role. For an example of a policy that can be used to assume a role, see Template Examples . For more information about the elements that you can use in an IAM policy, see IAM Policy Elements Reference in the IAM User Guide .
  - getDescription
```
@Stability(value=Stable)
 @Nullable
public String getDescription()
```
    A description of the role that you provide.
  - setDescription
```
@Stability(value=Stable)
public void setDescription(@Nullable
                                                    String value)
```
    A description of the role that you provide.
  - getManagedPolicyArns
```
@Stability(value=Stable)
 @Nullable
public List<String> getManagedPolicyArns()
```
    A list of Amazon Resource Names (ARNs) of the IAM managed policies that you want to attach to the role.
    For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference .
  - setManagedPolicyArns
```
@Stability(value=Stable)
public void setManagedPolicyArns(@Nullable
                                                          List<String> value)
```
    A list of Amazon Resource Names (ARNs) of the IAM managed policies that you want to attach to the role.
    For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference .
  - getMaxSessionDuration
```
@Stability(value=Stable)
 @Nullable
public Number getMaxSessionDuration()
```
    The maximum session duration (in seconds) that you want to set for the specified role.
    If you do not specify a value for this setting, the default maximum of one hour is applied. This setting can have a value from 1 hour to 12 hours.
    Anyone who assumes the role from the 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. For more information, see Using IAM roles in the IAM User Guide .
  - setMaxSessionDuration
```
@Stability(value=Stable)
public void setMaxSessionDuration(@Nullable
                                                           Number value)
```
    The maximum session duration (in seconds) that you want to set for the specified role.
    If you do not specify a value for this setting, the default maximum of one hour is applied. This setting can have a value from 1 hour to 12 hours.
    Anyone who assumes the role from the 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. For more information, see Using IAM roles in the IAM User Guide .
  - getPath
```
@Stability(value=Stable)
 @Nullable
public String getPath()
```
    The path to the role. For more information about paths, see [IAM Identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the *IAM User Guide* .
    This parameter is optional. If it is not included, it defaults to a slash (/).
    This parameter allows (through its regex pattern ) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! ( \ u0021 ) through the DEL character ( \ u007F ), including most punctuation characters, digits, and upper and lowercased letters.
  - setPath
```
@Stability(value=Stable)
public void setPath(@Nullable
                                             String value)
```
    The path to the role. For more information about paths, see [IAM Identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the *IAM User Guide* .
    This parameter is optional. If it is not included, it defaults to a slash (/).
    This parameter allows (through its regex pattern ) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! ( \ u0021 ) through the DEL character ( \ u007F ), including most punctuation characters, digits, and upper and lowercased letters.
  - getPermissionsBoundary
```
@Stability(value=Stable)
 @Nullable
public String getPermissionsBoundary()
```
    The ARN of the policy used to set the permissions boundary for the role.
    For more information about permissions boundaries, see Permissions boundaries for IAM identities in the IAM User Guide .
  - setPermissionsBoundary
```
@Stability(value=Stable)
public void setPermissionsBoundary(@Nullable
                                                            String value)
```
    The ARN of the policy used to set the permissions boundary for the role.
    For more information about permissions boundaries, see Permissions boundaries for IAM identities in the IAM User Guide .
  - getPolicies
```
@Stability(value=Stable)
 @Nullable
public Object getPolicies()
```
    Adds or updates an inline policy document that is embedded in the specified IAM role.
    When you embed an inline policy in a role, the inline policy is used as part of the role's access (permissions) policy. The role's trust policy is created at the same time as the role. You can update a role's trust policy later. For more information about IAM roles, go to Using Roles to Delegate Permissions and Federate Identities .
    A role can also have an attached managed policy. For information about policies, see Managed Policies and Inline Policies in the IAM User Guide .
    For information about limits on the number of inline policies that you can embed with a role, see Limitations on IAM Entities in the IAM User Guide .
    
    If an external policy (such as AWS::IAM::Policy or AWS::IAM::ManagedPolicy ) has a Ref to a role and if a resource (such as AWS::ECS::Service ) also has a Ref to the same role, add a DependsOn attribute to the resource to make the resource depend on the external policy. This dependency ensures that the role's policy is available throughout the resource's lifecycle. For example, when you delete a stack with an AWS::ECS::Service resource, the DependsOn attribute ensures that AWS CloudFormation deletes the AWS::ECS::Service resource before deleting its role's policy.
  - setPolicies
```
@Stability(value=Stable)
public void setPolicies(@Nullable
                                                 IResolvable value)
```
    Adds or updates an inline policy document that is embedded in the specified IAM role.
    When you embed an inline policy in a role, the inline policy is used as part of the role's access (permissions) policy. The role's trust policy is created at the same time as the role. You can update a role's trust policy later. For more information about IAM roles, go to Using Roles to Delegate Permissions and Federate Identities .
    A role can also have an attached managed policy. For information about policies, see Managed Policies and Inline Policies in the IAM User Guide .
    For information about limits on the number of inline policies that you can embed with a role, see Limitations on IAM Entities in the IAM User Guide .
    
    If an external policy (such as AWS::IAM::Policy or AWS::IAM::ManagedPolicy ) has a Ref to a role and if a resource (such as AWS::ECS::Service ) also has a Ref to the same role, add a DependsOn attribute to the resource to make the resource depend on the external policy. This dependency ensures that the role's policy is available throughout the resource's lifecycle. For example, when you delete a stack with an AWS::ECS::Service resource, the DependsOn attribute ensures that AWS CloudFormation deletes the AWS::ECS::Service resource before deleting its role's policy.
  - setPolicies
```
@Stability(value=Stable)
public void setPolicies(@Nullable
                                                 List<Object> value)
```
    Adds or updates an inline policy document that is embedded in the specified IAM role.
    When you embed an inline policy in a role, the inline policy is used as part of the role's access (permissions) policy. The role's trust policy is created at the same time as the role. You can update a role's trust policy later. For more information about IAM roles, go to Using Roles to Delegate Permissions and Federate Identities .
    A role can also have an attached managed policy. For information about policies, see Managed Policies and Inline Policies in the IAM User Guide .
    For information about limits on the number of inline policies that you can embed with a role, see Limitations on IAM Entities in the IAM User Guide .
    
    If an external policy (such as AWS::IAM::Policy or AWS::IAM::ManagedPolicy ) has a Ref to a role and if a resource (such as AWS::ECS::Service ) also has a Ref to the same role, add a DependsOn attribute to the resource to make the resource depend on the external policy. This dependency ensures that the role's policy is available throughout the resource's lifecycle. For example, when you delete a stack with an AWS::ECS::Service resource, the DependsOn attribute ensures that AWS CloudFormation deletes the AWS::ECS::Service resource before deleting its role's policy.
  - getRoleName
```
@Stability(value=Stable)
 @Nullable
public String getRoleName()
```
    A name for the IAM role, up to 64 characters in length.
    For valid values, see the RoleName parameter for the CreateRole action in the IAM User Guide .
    This parameter allows (per its regex pattern ) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-. The role name must be unique within the account. Role names are not distinguished by case. For example, you cannot create roles named both "Role1" and "role1".
    If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the role 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 .
    
    Naming an IAM resource can cause an unrecoverable error if you reuse the same template in multiple Regions. To prevent this, we recommend using Fn::Join and AWS::Region to create a Region-specific name, as in the following example: {"Fn::Join": ["", [{"Ref": "AWS::Region"}, {"Ref": "MyResourceName"}]]} .
  - setRoleName
```
@Stability(value=Stable)
public void setRoleName(@Nullable
                                                 String value)
```
    A name for the IAM role, up to 64 characters in length.
    For valid values, see the RoleName parameter for the CreateRole action in the IAM User Guide .
    This parameter allows (per its regex pattern ) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-. The role name must be unique within the account. Role names are not distinguished by case. For example, you cannot create roles named both "Role1" and "role1".
    If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the role 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 .
    
    Naming an IAM resource can cause an unrecoverable error if you reuse the same template in multiple Regions. To prevent this, we recommend using Fn::Join and AWS::Region to create a Region-specific name, as in the following example: {"Fn::Join": ["", [{"Ref": "AWS::Region"}, {"Ref": "MyResourceName"}]]} .

Class CfnRole

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

Nested classes/interfaces inherited from interface software.constructs.IConstruct

Field Summary

Constructor Summary

Method Summary

Methods inherited from class software.amazon.awscdk.CfnResource

Methods inherited from class software.amazon.awscdk.CfnRefElement

Methods inherited from class software.amazon.awscdk.CfnElement

Methods inherited from class software.constructs.Construct

Methods inherited from class software.amazon.jsii.JsiiObject

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Field Detail

CFN_RESOURCE_TYPE_NAME

Constructor Detail

CfnRole

CfnRole

CfnRole

Method Detail

inspect

renderProperties

getAttrArn

getAttrRoleId

getCfnProperties

getTags

getAssumeRolePolicyDocument

setAssumeRolePolicyDocument

getDescription

setDescription

getManagedPolicyArns

setManagedPolicyArns

getMaxSessionDuration

setMaxSessionDuration

getPath

setPath

getPermissionsBoundary

setPermissionsBoundary

getPolicies

setPolicies

setPolicies

getRoleName

setRoleName