View a markdown version of this page

AWS::AccountAccess::Entitlement PrincipalRoleEntitlement - Amazon CloudFormation
SyntaxProperties
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

AWS::AccountAccess::Entitlement PrincipalRoleEntitlement

Specifies a principal-to-role entitlement that grants an IAM Identity Center principal permission to assume an IAM role.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "Account" : String,
  "Principal" : Principal,
  "RoleArn" : String
}

YAML

  Account: String
  Principal: 
    Principal
  RoleArn: String

Properties

Account

The 12-digit Amazon Web Services account ID where the IAM role resides.

Required: No

Type: String

Pattern: ^[0-9]{12}$

Minimum: 12

Maximum: 12

Update requires: Replacement

Principal

The principal (user or group) that is granted access to assume the IAM role.

Required: Yes

Type: Principal

Update requires: Replacement

RoleArn

The ARN of the IAM role that the principal can assume.

Required: Yes

Type: String

Pattern: ^arn:[a-z0-9-]+:iam::[0-9]{12}:role\/([a-zA-Z0-9+=,.@_-]+\/)*[a-zA-Z0-9+=,.@_-]+$

Update requires: Replacement