Package software.amazon.awscdk.services.quicksight

Interface CfnFolderProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnFolderProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-22T02:24:06.987Z")
@Stability(Stable)
public interface CfnFolderProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnFolder.

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.*;
 CfnFolderProps cfnFolderProps = CfnFolderProps.builder()
         .awsAccountId("awsAccountId")
         .folderId("folderId")
         .folderType("folderType")
         .name("name")
         .parentFolderArn("parentFolderArn")
         .permissions(List.of(ResourcePermissionProperty.builder()
                 .actions(List.of("actions"))
                 .principal("principal")
                 .build()))
         .sharingModel("sharingModel")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnFolderProps.Builder	builder()
default String	getAwsAccountId()	The ID for the AWS account where you want to create the folder.
default String	getFolderId()	The ID of the folder.
default String	getFolderType()	The type of folder it is.
default String	getName()	A display name for the folder.
default String	getParentFolderArn()	The Amazon Resource Name (ARN) for the folder.
default Object	getPermissions()	A structure that describes the principals and the resource-level permissions of a folder.
default String	getSharingModel()	The sharing scope of the folder.
default List<CfnTag>	getTags()	A list of tags for the folders that you want to apply overrides to.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAwsAccountId

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

The ID for the AWS account where you want to create the folder.

See Also:

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

getFolderId

@Stability(Stable)
@Nullable
default String getFolderId()

The ID of the folder.

See Also:

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

getFolderType

@Stability(Stable)
@Nullable
default String getFolderType()

The type of folder it is.

See Also:

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

getName

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

A display name for the folder.

See Also:

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

getParentFolderArn

@Stability(Stable)
@Nullable
default String getParentFolderArn()

The Amazon Resource Name (ARN) for the folder.

See Also:

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

getPermissions

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

A structure that describes the principals and the resource-level permissions of a folder.

To specify no permissions, omit Permissions .

See Also:

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

getSharingModel

@Stability(Stable)
@Nullable
default String getSharingModel()

The sharing scope of the folder.

See Also:

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

getTags

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

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

See Also:

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

builder

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

Returns:

a CfnFolderProps.Builder of CfnFolderProps