Skip to content
v2.274.0

CfnSpaceProps Struct ​

Properties for defining a CfnSpace.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_quicksight as quicksight } from 'aws-cdk-lib';
const cfnSpaceProps: quicksight.CfnSpaceProps = {
  awsAccountId: 'awsAccountId',
  name: 'name',
  spaceId: 'spaceId',

  // the properties below are optional
  description: 'description',
  permissions: [{
    actions: ['actions'],
    principal: 'principal',
  }],
  resources: [{
    resourceArn: 'resourceArn',
    resourceType: 'resourceType',
  }],
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties ​

awsAccountIdstringaws_account_idstrawsAccountIdStringAwsAccountIdstringAwsAccountId*stringrequired#
The ID of the Amazon Web Services account where the space is being created.
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#
A description of the space.
namestringnamestrnameStringNamestringName*stringrequired#
The display name of the space.
permissionsoptionalIResolvable | IResolvable | CfnSpace.ResourcePermissionProperty[]permissionsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, ResourcePermissionProperty]]]permissionsoptionalIResolvablePermissionsoptionalIResolvablePermissionsoptionalinterface{}#
A list of permissions granted on the space.
resourcesoptionalIResolvable | IResolvable | CfnSpace.SpaceResourceProperty[]resourcesoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, SpaceResourceProperty]]]resourcesoptionalIResolvableResourcesoptionalIResolvableResourcesoptionalinterface{}#
A list of QuickSight resources attached to the space.
spaceIdstringspace_idstrspaceIdStringSpaceIdstringSpaceId*stringrequired#
The unique identifier for the space.
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#
A list of key-value pairs to associate with the space resource.