View a markdown version of this page

AWS::QuickSight::Assignment - Amazon CloudFormation
SyntaxPropertiesReturn values
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::QuickSight::Assignment

Creates an assignment with one specified IAM policy, identified by its Amazon Resource Name (ARN). This policy assignment is attached to the specified groups or users of Amazon Quick Sight. Assignment names are unique per Amazon account. To avoid overwriting rules in other namespaces, use assignment names that are unique.

Syntax

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

JSON

{
  "Type" : "AWS::QuickSight::Assignment",
  "Properties" : {
      "AssignmentName" : String,
      "AssignmentStatus" : String,
      "Identities" : {Key: Value, ...},
      "Namespace" : String,
      "PolicyArn" : String
    }
}

YAML

Type: AWS::QuickSight::Assignment
Properties:
  AssignmentName: String
  AssignmentStatus: String
  Identities: 
    Key: Value
  Namespace: String
  PolicyArn: String

Properties

AssignmentName

Assignment name.

Required: Yes

Type: String

Pattern: (?=^.{2,256}$)(?!.*\s)[0-9a-zA-Z-_.:=+@]*$

Minimum: 1

Update requires: Replacement

AssignmentStatus

Assignment status.

Required: Yes

Type: String

Allowed values: ENABLED | DRAFT | DISABLED

Update requires: No interruption

Identities

Identities.

Required: No

Type: Object of Array

Pattern: [\u0020-\u00FF]+

Update requires: No interruption

Namespace

Property description not available.

Required: Yes

Type: String

Pattern: ^[a-zA-Z0-9._-]*$

Maximum: 64

Update requires: Replacement

PolicyArn

The Amazon Resource Name (ARN) for the IAM policy.

Required: No

Type: String

Update requires: No interruption

Return values

Ref

Fn::GetAtt

Arn

Property description not available.

AssignmentId

Assignment ID.