View a markdown version of this page

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

Creates a new Q topic.

Syntax

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

JSON

{
  "Type" : "AWS::QuickSight::TopicV2",
  "Properties" : {
      "AwsAccountId" : String,
      "CustomInstructions" : CustomInstructions,
      "DataSetRelations" : [ DataSetRelation, ... ],
      "DataSets" : [ DataSetReference, ... ],
      "Description" : String,
      "FolderArns" : [ String, ... ],
      "Name" : String,
      "Permissions" : [ ResourcePermission, ... ],
      "Tags" : [ Tag, ... ],
      "TopicId" : String
    }
}

YAML

Type: AWS::QuickSight::TopicV2
Properties:
  AwsAccountId: String
  CustomInstructions: 
    CustomInstructions
  DataSetRelations: 
    - DataSetRelation
  DataSets: 
    - DataSetReference
  Description: String
  FolderArns: 
    - String
  Name: String
  Permissions: 
    - ResourcePermission
  Tags: 
    - Tag
  TopicId: String

Properties

AwsAccountId

Property description not available.

Required: No

Type: String

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

Minimum: 12

Maximum: 12

Update requires: Replacement

CustomInstructions

Property description not available.

Required: No

Type: CustomInstructions

Update requires: No interruption

DataSetRelations

The relations between the data sets that the topic is associated with.

Required: No

Type: Array of DataSetRelation

Minimum: 0

Maximum: 20

Update requires: No interruption

DataSets

The data sets that the topic is associated with.

Required: No

Type: Array of DataSetReference

Minimum: 1

Maximum: 20

Update requires: No interruption

Description

The description of the topic.

Required: No

Type: String

Minimum: 0

Maximum: 256

Update requires: No interruption

FolderArns

Property description not available.

Required: No

Type: Array of String

Minimum: 0

Maximum: 20

Update requires: Replacement

Name

The name of the topic.

Required: No

Type: String

Minimum: 1

Maximum: 128

Update requires: No interruption

Permissions

A list of permissions for the topics that you want to apply overrides to.

Required: No

Type: Array of ResourcePermission

Minimum: 1

Maximum: 64

Update requires: No interruption

Tags

A list of tags for the topics that you want to apply overrides to.

Required: No

Type: Array of Tag

Minimum: 1

Maximum: 200

Update requires: Replacement

TopicId

The ID of the topic. This ID is unique per Amazon Web Services Region for each Amazon account.

Required: No

Type: String

Pattern: ^[A-Za-z0-9-_.\\+]*$

Minimum: 0

Maximum: 256

Update requires: Replacement

Return values

Ref

Fn::GetAtt

Arn

The Amazon Resource Name (ARN) of the topic.