CfnSpaceProps

class aws_cdk.aws_quicksight.CfnSpaceProps(*, aws_account_id, name, space_id, description=None, permissions=None, resources=None, tags=None)

Bases: object

Properties for defining a CfnSpace.

Parameters:
  • aws_account_id (str) – The ID of the Amazon Web Services account where the space is being created.

  • name (str) – The display name of the space.

  • space_id (str) – The unique identifier for the space.

  • description (Optional[str]) – A description of the space.

  • permissions (Union[IResolvable, Sequence[Union[IResolvable, ResourcePermissionProperty, Dict[str, Any]]], None]) – A list of permissions granted on the space.

  • resources (Union[IResolvable, Sequence[Union[IResolvable, SpaceResourceProperty, Dict[str, Any]]], None]) – A list of QuickSight resources attached to the space.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – A list of key-value pairs to associate with the space resource.

See:

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

ExampleMetadata:

fixture=_generated

Example:

from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_quicksight as quicksight

cfn_space_props = quicksight.CfnSpaceProps(
    aws_account_id="awsAccountId",
    name="name",
    space_id="spaceId",

    # the properties below are optional
    description="description",
    permissions=[quicksight.CfnSpace.ResourcePermissionProperty(
        actions=["actions"],
        principal="principal"
    )],
    resources=[quicksight.CfnSpace.SpaceResourceProperty(
        resource_arn="resourceArn",
        resource_type="resourceType"
    )],
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

aws_account_id

The ID of the Amazon Web Services account where the space is being created.

See:

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

description

A description of the space.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-space.html#cfn-quicksight-space-description

name

The display name of the space.

See:

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

permissions

A list of permissions granted on the space.

See:

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

resources

A list of QuickSight resources attached to the space.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-space.html#cfn-quicksight-space-resources

space_id

The unique identifier for the space.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-space.html#cfn-quicksight-space-spaceid

tags

A list of key-value pairs to associate with the space resource.

See:

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