Package software.amazon.awscdk.services.quicksight

Interface CfnCustomPermissionsProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnCustomPermissionsProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)",
           date="2025-10-29T11:15:45.452Z")
@Stability(Stable)
public interface CfnCustomPermissionsProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnCustomPermissions.

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.*;
 CfnCustomPermissionsProps cfnCustomPermissionsProps = CfnCustomPermissionsProps.builder()
         .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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-custompermissions.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnCustomPermissionsProps.Builder	A builder for CfnCustomPermissionsProps
static final class	CfnCustomPermissionsProps.Jsii$Proxy	An implementation for CfnCustomPermissionsProps

Method Summary

Modifier and Type	Method	Description
static CfnCustomPermissionsProps.Builder	builder()
String	getAwsAccountId()	The ID of the AWS account that contains the custom permission configuration that you want to update.
default Object	getCapabilities()	A set of actions in the custom permissions profile.
String	getCustomPermissionsName()	The name of the custom permissions profile.
default List<CfnTag>	getTags()	The tags to associate with the custom permissions profile.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAwsAccountId

@Stability(Stable)
@NotNull
String getAwsAccountId()

The ID of the AWS account that contains the custom permission configuration that you want to update.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-custompermissions.html#cfn-quicksight-custompermissions-awsaccountid

getCustomPermissionsName

@Stability(Stable)
@NotNull
String getCustomPermissionsName()

The name of the custom permissions profile.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-custompermissions.html#cfn-quicksight-custompermissions-custompermissionsname

getCapabilities

@Stability(Stable)
@Nullable
default Object getCapabilities()

A set of actions in the custom permissions profile.

Returns union: either IResolvable or CfnCustomPermissions.CapabilitiesProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-custompermissions.html#cfn-quicksight-custompermissions-capabilities

getTags

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

The tags to associate with the custom permissions profile.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-custompermissions.html#cfn-quicksight-custompermissions-tags

builder

@Stability(Stable)
static CfnCustomPermissionsProps.Builder builder()

Returns:

a CfnCustomPermissionsProps.Builder of CfnCustomPermissionsProps