View a markdown version of this page

AWS::QuickSight::Group - 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::Group

A group in Quick Sight consists of a set of users. You can use groups to make it easier to manage access and security.

Syntax

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

JSON

{
  "Type" : "AWS::QuickSight::Group",
  "Properties" : {
      "Description" : String,
      "GroupName" : String,
      "Namespace" : String
    }
}

YAML

Type: AWS::QuickSight::Group
Properties:
  Description: String
  GroupName: String
  Namespace: String

Properties

Description

The group description.

Required: No

Type: String

Minimum: 1

Maximum: 512

Update requires: No interruption

GroupName

The name of the group.

Required: Yes

Type: String

Pattern: ^[\u0020-\u00FF]+$

Minimum: 1

Update requires: Replacement

Namespace

The namespace that you want the group to be a part of.

Required: Yes

Type: String

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

Minimum: 0

Maximum: 64

Update requires: Replacement

Return values

Ref

Fn::GetAtt

Arn

The Amazon Resource Name (ARN) for the group.

PrincipalId

The principal ID of the group.