Package software.amazon.awscdk.services.quicksight

Class CfnTopicV2

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.quicksight.CfnTopicV2
All Implemented Interfaces:
IInspectable, IEnvironmentAware, ITopicV2Ref, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.139.0 (build 26a6b54)", date="2026-09-02T11:03:17.104Z") @Stability(Stable) public class CfnTopicV2 extends CfnResource implements IInspectable, ITopicV2Ref, ITaggableV2
Definition of the AWS::QuickSight::TopicV2 Resource Type.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.quicksight.*;
 CfnTopicV2 cfnTopicV2 = CfnTopicV2.Builder.create(this, "MyCfnTopicV2")
         .awsAccountId("awsAccountId")
         .customInstructions(CustomInstructionsProperty.builder()
                 .customInstructionsString("customInstructionsString")
                 .build())
         .dataSetRelations(List.of(DataSetRelationProperty.builder()
                 .left(DataSetRelationEndpointProperty.builder()
                         .columnNames(List.of("columnNames"))
                         .dataSetArn("dataSetArn")
                         .build())
                 .right(DataSetRelationEndpointProperty.builder()
                         .columnNames(List.of("columnNames"))
                         .dataSetArn("dataSetArn")
                         .build())
                 .build()))
         .dataSets(List.of(DataSetReferenceProperty.builder()
                 .dataSetArn("dataSetArn")
                 // the properties below are optional
                 .dataSetName("dataSetName")
                 .build()))
         .description("description")
         .folderArns(List.of("folderArns"))
         .name("name")
         .permissions(List.of(ResourcePermissionProperty.builder()
                 .actions(List.of("actions"))
                 .principal("principal")
                 .build()))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .topicId("topicId")
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnTopicV2

      protected CfnTopicV2(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnTopicV2

      protected CfnTopicV2(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnTopicV2

      @Stability(Stable) public CfnTopicV2(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable CfnTopicV2Props props)
      Create a new AWS::QuickSight::TopicV2.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties.

    • CfnTopicV2

      @Stability(Stable) public CfnTopicV2(@NotNull software.constructs.Construct scope, @NotNull String id)
      Create a new AWS::QuickSight::TopicV2.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.

  • Method Details

    • arnForTopicV2

      @Stability(Stable) @NotNull public static String arnForTopicV2(@NotNull ITopicV2Ref resource)
      Parameters:
      resource - This parameter is required.

    • isCfnTopicV2

      @Stability(Stable) @NotNull public static Boolean isCfnTopicV2(@NotNull Object x)
      Checks whether the given object is a CfnTopicV2.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getCfnPropertyNames

      @Stability(Stable) @NotNull protected Map<String,String> getCfnPropertyNames()
      Overrides:
      getCfnPropertyNames in class CfnResource

    • getTopicV2Ref

      @Stability(Stable) @NotNull public TopicV2Reference getTopicV2Ref()
      A reference to a TopicV2 resource.
      Specified by:
      getTopicV2Ref in interface ITopicV2Ref

    • getAwsAccountId

      @Stability(Stable) @Nullable public String getAwsAccountId()

    • setAwsAccountId

      @Stability(Stable) public void setAwsAccountId(@Nullable String value)

    • getCustomInstructions

      @Stability(Stable) @Nullable public Object getCustomInstructions()
      Returns union: either IResolvable or CfnTopicV2.CustomInstructionsProperty

    • setCustomInstructions

      @Stability(Stable) public void setCustomInstructions(@Nullable IResolvable value)

    • setCustomInstructions

      @Stability(Stable) public void setCustomInstructions(@Nullable CfnTopicV2.CustomInstructionsProperty value)

    • getDataSetRelations

      @Stability(Stable) @Nullable public Object getDataSetRelations()
      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnTopicV2.DataSetRelationProperty>

    • setDataSetRelations

      @Stability(Stable) public void setDataSetRelations(@Nullable IResolvable value)

    • setDataSetRelations

      @Stability(Stable) public void setDataSetRelations(@Nullable List<Object> value)

    • getDataSets

      @Stability(Stable) @Nullable public Object getDataSets()
      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnTopicV2.DataSetReferenceProperty>

    • setDataSets

      @Stability(Stable) public void setDataSets(@Nullable IResolvable value)

    • setDataSets

      @Stability(Stable) public void setDataSets(@Nullable List<Object> value)

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)

    • getFolderArns

      @Stability(Stable) @Nullable public List<String> getFolderArns()

    • setFolderArns

      @Stability(Stable) public void setFolderArns(@Nullable List<String> value)

    • getName

      @Stability(Stable) @Nullable public String getName()

    • setName

      @Stability(Stable) public void setName(@Nullable String value)

    • getPermissions

      @Stability(Stable) @Nullable public Object getPermissions()
      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnTopicV2.ResourcePermissionProperty>

    • setPermissions

      @Stability(Stable) public void setPermissions(@Nullable IResolvable value)

    • setPermissions

      @Stability(Stable) public void setPermissions(@Nullable List<Object> value)

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)

    • getTopicId

      @Stability(Stable) @Nullable public String getTopicId()

    • setTopicId

      @Stability(Stable) public void setTopicId(@Nullable String value)