Package software.amazon.awscdk.services.quicksight

Class CfnCustomPermissions

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.CfnCustomPermissions
All Implemented Interfaces:
IInspectable, IEnvironmentAware, ICustomPermissionsRef, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)", date="2025-11-20T23:37:27.001Z") @Stability(Stable) public class CfnCustomPermissions extends CfnResource implements IInspectable, ICustomPermissionsRef, ITaggableV2
Creates a custom permissions profile.

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.*;
 CfnCustomPermissions cfnCustomPermissions = CfnCustomPermissions.Builder.create(this, "MyCfnCustomPermissions")
         .awsAccountId("awsAccountId")
         .customPermissionsName("customPermissionsName")
         // the properties below are optional
         .capabilities(CapabilitiesProperty.builder()
                 .addOrRunAnomalyDetectionForAnalyses("addOrRunAnomalyDetectionForAnalyses")
                 .analysis("analysis")
                 .createAndUpdateDashboardEmailReports("createAndUpdateDashboardEmailReports")
                 .createAndUpdateDatasets("createAndUpdateDatasets")
                 .createAndUpdateDataSources("createAndUpdateDataSources")
                 .createAndUpdateThemes("createAndUpdateThemes")
                 .createAndUpdateThresholdAlerts("createAndUpdateThresholdAlerts")
                 .createSharedFolders("createSharedFolders")
                 .createSpiceDataset("createSpiceDataset")
                 .dashboard("dashboard")
                 .exportToCsv("exportToCsv")
                 .exportToCsvInScheduledReports("exportToCsvInScheduledReports")
                 .exportToExcel("exportToExcel")
                 .exportToExcelInScheduledReports("exportToExcelInScheduledReports")
                 .exportToPdf("exportToPdf")
                 .exportToPdfInScheduledReports("exportToPdfInScheduledReports")
                 .includeContentInScheduledReportsEmail("includeContentInScheduledReportsEmail")
                 .printReports("printReports")
                 .renameSharedFolders("renameSharedFolders")
                 .shareAnalyses("shareAnalyses")
                 .shareDashboards("shareDashboards")
                 .shareDatasets("shareDatasets")
                 .shareDataSources("shareDataSources")
                 .subscribeDashboardEmailReports("subscribeDashboardEmailReports")
                 .viewAccountSpiceCapacity("viewAccountSpiceCapacity")
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .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

    • CfnCustomPermissions

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

    • CfnCustomPermissions

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

    • CfnCustomPermissions

      @Stability(Stable) public CfnCustomPermissions(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnCustomPermissionsProps props)
      Create a new AWS::QuickSight::CustomPermissions.

      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. This parameter is required.

  • Method Details

    • arnForCustomPermissions

      @Stability(Stable) @NotNull public static String arnForCustomPermissions(@NotNull ICustomPermissionsRef resource)
      Parameters:
      resource - 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()
      The Amazon Resource Name (ARN) of the custom permissions profile.

    • 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

    • getCustomPermissionsRef

      @Stability(Stable) @NotNull public CustomPermissionsReference getCustomPermissionsRef()
      A reference to a CustomPermissions resource.
      Specified by:
      getCustomPermissionsRef in interface ICustomPermissionsRef

    • getAwsAccountId

      @Stability(Stable) @NotNull public String getAwsAccountId()
      The ID of the AWS account that contains the custom permission configuration that you want to update.

    • setAwsAccountId

      @Stability(Stable) public void setAwsAccountId(@NotNull String value)
      The ID of the AWS account that contains the custom permission configuration that you want to update.

    • getCustomPermissionsName

      @Stability(Stable) @NotNull public String getCustomPermissionsName()
      The name of the custom permissions profile.

    • setCustomPermissionsName

      @Stability(Stable) public void setCustomPermissionsName(@NotNull String value)
      The name of the custom permissions profile.

    • getCapabilities

      @Stability(Stable) @Nullable public Object getCapabilities()
      A set of actions in the custom permissions profile.

      Returns union: either IResolvable or CfnCustomPermissions.CapabilitiesProperty

    • setCapabilities

      @Stability(Stable) public void setCapabilities(@Nullable IResolvable value)
      A set of actions in the custom permissions profile.

    • setCapabilities

      @Stability(Stable) public void setCapabilities(@Nullable CfnCustomPermissions.CapabilitiesProperty value)
      A set of actions in the custom permissions profile.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      The tags to associate with the custom permissions profile.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      The tags to associate with the custom permissions profile.