Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. quicksight
  5. Folder

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.quicksight.Folder

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-aws-native

    Definition of the AWS::QuickSight::Folder Resource Type.

    Create Folder Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Folder(name: string, args?: FolderArgs, opts?: CustomResourceOptions);
    @overload
def Folder(resource_name: str,
           args: Optional[FolderArgs] = None,
           opts: Optional[ResourceOptions] = None)

@overload
def Folder(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           aws_account_id: Optional[str] = None,
           folder_id: Optional[str] = None,
           folder_type: Optional[FolderType] = None,
           name: Optional[str] = None,
           parent_folder_arn: Optional[str] = None,
           permissions: Optional[Sequence[FolderResourcePermissionArgs]] = None,
           sharing_model: Optional[FolderSharingModel] = None,
           tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
    func NewFolder(ctx *Context, name string, args *FolderArgs, opts ...ResourceOption) (*Folder, error)
    public Folder(string name, FolderArgs? args = null, CustomResourceOptions? opts = null)
    public Folder(String name, FolderArgs args)
public Folder(String name, FolderArgs args, CustomResourceOptions options)

    type: aws-native:quicksight:Folder
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args FolderArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args FolderArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args FolderArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args FolderArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args FolderArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Folder Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Folder resource accepts the following input properties:

    AwsAccountId string
    The ID for the AWS account where you want to create the folder.
    FolderId string
    The ID of the folder.
    FolderType Pulumi.AwsNative.QuickSight.FolderType
    The type of folder it is.
    Name string
    A display name for the folder.
    ParentFolderArn string
    The Amazon Resource Name (ARN) for the folder.
    Permissions List<Pulumi.AwsNative.QuickSight.Inputs.FolderResourcePermission>

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

    To specify no permissions, omit Permissions .

    SharingModel Pulumi.AwsNative.QuickSight.FolderSharingModel
    The sharing scope of the folder.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    A list of tags for the folders that you want to apply overrides to.
    AwsAccountId string
    The ID for the AWS account where you want to create the folder.
    FolderId string
    The ID of the folder.
    FolderType FolderType
    The type of folder it is.
    Name string
    A display name for the folder.
    ParentFolderArn string
    The Amazon Resource Name (ARN) for the folder.
    Permissions []FolderResourcePermissionArgs

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

    To specify no permissions, omit Permissions .

    SharingModel FolderSharingModel
    The sharing scope of the folder.
    Tags TagArgs
    A list of tags for the folders that you want to apply overrides to.
    awsAccountId String
    The ID for the AWS account where you want to create the folder.
    folderId String
    The ID of the folder.
    folderType FolderType
    The type of folder it is.
    name String
    A display name for the folder.
    parentFolderArn String
    The Amazon Resource Name (ARN) for the folder.
    permissions List<FolderResourcePermission>

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

    To specify no permissions, omit Permissions .

    sharingModel FolderSharingModel
    The sharing scope of the folder.
    tags List<Tag>
    A list of tags for the folders that you want to apply overrides to.
    awsAccountId string
    The ID for the AWS account where you want to create the folder.
    folderId string
    The ID of the folder.
    folderType FolderType
    The type of folder it is.
    name string
    A display name for the folder.
    parentFolderArn string
    The Amazon Resource Name (ARN) for the folder.
    permissions FolderResourcePermission[]

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

    To specify no permissions, omit Permissions .

    sharingModel FolderSharingModel
    The sharing scope of the folder.
    tags Tag[]
    A list of tags for the folders that you want to apply overrides to.
    aws_account_id str
    The ID for the AWS account where you want to create the folder.
    folder_id str
    The ID of the folder.
    folder_type FolderType
    The type of folder it is.
    name str
    A display name for the folder.
    parent_folder_arn str
    The Amazon Resource Name (ARN) for the folder.
    permissions Sequence[FolderResourcePermissionArgs]

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

    To specify no permissions, omit Permissions .

    sharing_model FolderSharingModel
    The sharing scope of the folder.
    tags Sequence[TagArgs]
    A list of tags for the folders that you want to apply overrides to.
    awsAccountId String
    The ID for the AWS account where you want to create the folder.
    folderId String
    The ID of the folder.
    folderType "SHARED" | "RESTRICTED"
    The type of folder it is.
    name String
    A display name for the folder.
    parentFolderArn String
    The Amazon Resource Name (ARN) for the folder.
    permissions List<Property Map>

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

    To specify no permissions, omit Permissions .

    sharingModel "ACCOUNT" | "NAMESPACE"
    The sharing scope of the folder.
    tags List<Property Map>
    A list of tags for the folders that you want to apply overrides to.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Folder resource produces the following output properties:

    Arn string
    CreatedTime string
    Id string
    The provider-assigned unique ID for this managed resource.
    LastUpdatedTime string
    Arn string
    CreatedTime string
    Id string
    The provider-assigned unique ID for this managed resource.
    LastUpdatedTime string
    arn String
    createdTime String
    id String
    The provider-assigned unique ID for this managed resource.
    lastUpdatedTime String
    arn string
    createdTime string
    id string
    The provider-assigned unique ID for this managed resource.
    lastUpdatedTime string
    arn str
    created_time str
    id str
    The provider-assigned unique ID for this managed resource.
    last_updated_time str
    arn String
    createdTime String
    id String
    The provider-assigned unique ID for this managed resource.
    lastUpdatedTime String

    Supporting Types

    FolderResourcePermission, FolderResourcePermissionArgs

    Actions List<string>
    Principal string
    Actions []string
    Principal string
    actions List<String>
    principal String
    actions string[]
    principal string
    actions Sequence[str]
    principal str
    actions List<String>
    principal String

    FolderSharingModel, FolderSharingModelArgs

    Account
    ACCOUNT
    Namespace
    NAMESPACE
    FolderSharingModelAccount
    ACCOUNT
    FolderSharingModelNamespace
    NAMESPACE
    Account
    ACCOUNT
    Namespace
    NAMESPACE
    Account
    ACCOUNT
    Namespace
    NAMESPACE
    ACCOUNT
    ACCOUNT
    NAMESPACE
    NAMESPACE
    "ACCOUNT"
    ACCOUNT
    "NAMESPACE"
    NAMESPACE

    FolderType, FolderTypeArgs

    Shared
    SHARED
    Restricted
    RESTRICTED
    FolderTypeShared
    SHARED
    FolderTypeRestricted
    RESTRICTED
    Shared
    SHARED
    Restricted
    RESTRICTED
    Shared
    SHARED
    Restricted
    RESTRICTED
    SHARED
    SHARED
    RESTRICTED
    RESTRICTED
    "SHARED"
    SHARED
    "RESTRICTED"
    RESTRICTED

    Tag, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
    pulumi/pulumi-aws-native