Class CfnRole

Namespace: Amazon.CDK.AWS.IAM

Assembly: Amazon.CDK.AWS.IAM.dll

A CloudFormation AWS::IAM::Role.

public class CfnRole : CfnResource, IInspectable

Inheritance: object

CfnRole

Implements: IInspectable

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.IAM;

             var assumeRolePolicyDocument;
             var policyDocument;

             var cfnRole = new CfnRole(this, "MyCfnRole", new CfnRoleProps {
                 AssumeRolePolicyDocument = assumeRolePolicyDocument,

                 // the properties below are optional
                 Description = "description",
                 ManagedPolicyArns = new [] { "managedPolicyArns" },
                 MaxSessionDuration = 123,
                 Path = "path",
                 PermissionsBoundary = "permissionsBoundary",
                 Policies = new [] { new PolicyProperty {
                     PolicyDocument = policyDocument,
                     PolicyName = "policyName"
                 } },
                 RoleName = "roleName",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             });

Remarks

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 .

CloudformationResource: AWS::IAM::Role

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html

ExampleMetadata: fixture=_generated

Constructors

CfnRole(Construct, string, ICfnRoleProps)

Create a new AWS::IAM::Role.

public CfnRole(Construct scope, string id, ICfnRoleProps props)

Parameters

scope Construct

scope in which this resource is defined.

id string

scoped id of the resource.

props ICfnRoleProps

resource properties.

Properties

AssumeRolePolicyDocument

The trust policy that is associated with this role.

public virtual object AssumeRolePolicyDocument { get; set; }

Property Value

object

Remarks

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 .

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html#cfn-iam-role-assumerolepolicydocument

AttrArn

Returns the Amazon Resource Name (ARN) for the role. For example:.

public virtual string AttrArn { get; }

Property Value

string

Remarks

{"Fn::GetAtt" : ["MyRole", "Arn"] }

This will return a value such as arn:aws:iam::1234567890:role/MyRole-AJJHDSKSDF .

CloudformationAttribute: Arn

AttrRoleId

Returns the stable and unique string identifying the role. For example, AIDAJQABLZS4A3QDU576Q .

public virtual string AttrRoleId { get; }

Property Value

string

Remarks

For more information about IDs, see IAM Identifiers in the IAM User Guide .

CloudformationAttribute: RoleId

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

CfnProperties

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

Description

A description of the role that you provide.

public virtual string? Description { get; set; }

Property Value

string

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html#cfn-iam-role-description

ManagedPolicyArns

A list of Amazon Resource Names (ARNs) of the IAM managed policies that you want to attach to the role.

public virtual string[]? ManagedPolicyArns { get; set; }

Property Value

string[]

Remarks

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference .

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html#cfn-iam-role-managepolicyarns

MaxSessionDuration

The maximum session duration (in seconds) that you want to set for the specified role.

public virtual double? MaxSessionDuration { get; set; }

Property Value

double?

Remarks

If you do not specify a value for this setting, the default value of one hour is applied. This setting can have a value from 1 hour to 12 hours.

Anyone who assumes the role from the AWS CLI or API can use the DurationSeconds API parameter or the duration-seconds AWS 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* AWS 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 .

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html#cfn-iam-role-maxsessionduration

Path

The path to the role. For more information about paths, see IAM Identifiers in the IAM User Guide .

public virtual string? Path { get; set; }

Property Value

string

Remarks

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.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html#cfn-iam-role-path

PermissionsBoundary

The ARN of the policy used to set the permissions boundary for the role.

public virtual string? PermissionsBoundary { get; set; }

Property Value

string

Remarks

For more information about permissions boundaries, see Permissions boundaries for IAM identities in the IAM User Guide .

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html#cfn-iam-role-permissionsboundary

Policies

Adds or updates an inline policy document that is embedded in the specified IAM role.

public virtual object? Policies { get; set; }

Property Value

object

Remarks

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 <code>AWS::IAM::Policy</code> or <code>AWS::IAM::ManagedPolicy</code> ) has a <code>Ref</code> to a role and if a resource (such as <code>AWS::ECS::Service</code> ) also has a <code>Ref</code> to the same role, add a <code>DependsOn</code> 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 <code>AWS::ECS::Service</code> resource, the <code>DependsOn</code> attribute ensures that AWS CloudFormation deletes the <code>AWS::ECS::Service</code> resource before deleting its role's policy.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html#cfn-iam-role-policies

RoleName

A name for the IAM role, up to 64 characters in length.

public virtual string? RoleName { get; set; }

Property Value

string

Remarks

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 <code>Fn::Join</code> and <code>AWS::Region</code> to create a Region-specific name, as in the following example: <code>{"Fn::Join": ["", [{"Ref": "AWS::Region"}, {"Ref": "MyResourceName"}]]}</code> .

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html#cfn-iam-role-rolename

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)

Parameters

inspector TreeInspector

tree inspector to collect and process attributes.

RenderProperties(IDictionary<string, object>)

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Table of Contents

Class CfnRole

Examples

Remarks

Constructors

CfnRole(Construct, string, ICfnRoleProps)

Parameters

Properties

AssumeRolePolicyDocument

Property Value

Remarks

AttrArn

Property Value

Remarks

AttrRoleId

Property Value

Remarks

CFN_RESOURCE_TYPE_NAME

Property Value

CfnProperties

Property Value

Description

Property Value

Remarks

ManagedPolicyArns

Property Value

Remarks

MaxSessionDuration

Property Value

Remarks

Path

Property Value

Remarks

PermissionsBoundary

Property Value

Remarks

Policies

Property Value

Remarks

RoleName

Property Value

Remarks

Tags

Property Value

Remarks

Methods

Inspect(TreeInspector)

Parameters

RenderProperties(IDictionary<string, object>)

Parameters

Returns