Package software.amazon.awscdk.services.quicksight

Interface CfnSpaceProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnSpaceProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.138.0 (build 0ca7ee8)",
           date="2026-08-10T14:51:09.422Z")
@Stability(Stable)
public interface CfnSpaceProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnSpace.

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.*;
 CfnSpaceProps cfnSpaceProps = CfnSpaceProps.builder()
         .awsAccountId("awsAccountId")
         .name("name")
         .spaceId("spaceId")
         // the properties below are optional
         .description("description")
         .permissions(List.of(ResourcePermissionProperty.builder()
                 .actions(List.of("actions"))
                 .principal("principal")
                 .build()))
         .resources(List.of(SpaceResourceProperty.builder()
                 .resourceArn("resourceArn")
                 .resourceType("resourceType")
                 .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-space.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnSpaceProps.Builder	builder()
String	getAwsAccountId()	The ID of the Amazon Web Services account where the space is being created.
default String	getDescription()	A description of the space.
String	getName()	The display name of the space.
default Object	getPermissions()	A list of permissions granted on the space.
default Object	getResources()	A list of QuickSight resources attached to the space.
String	getSpaceId()	The unique identifier for the space.
default List<CfnTag>	getTags()	A list of key-value pairs to associate with the space resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAwsAccountId

@Stability(Stable)
@NotNull
String getAwsAccountId()

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

See Also:

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

getName

@Stability(Stable)
@NotNull
String getName()

The display name of the space.

See Also:

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

getSpaceId

@Stability(Stable)
@NotNull
String getSpaceId()

The unique identifier for the space.

See Also:

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

getDescription

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

A description of the space.

See Also:

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

getPermissions

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

A list of permissions granted on the space.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnSpace.ResourcePermissionProperty>

See Also:

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

getResources

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

A list of QuickSight resources attached to the space.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnSpace.SpaceResourceProperty>

See Also:

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

getTags

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

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

See Also:

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

builder

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

Returns:

a CfnSpaceProps.Builder of CfnSpaceProps