Package software.amazon.awscdk.services.quicksight

Class CfnSpace

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.quicksight.CfnSpace
All Implemented Interfaces:
IInspectable, IEnvironmentAware, ISpaceRef, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.138.0 (build 0ca7ee8)", date="2026-08-10T14:51:09.420Z") @Stability(Stable) public class CfnSpace extends CfnResource implements IInspectable, ISpaceRef, ITaggableV2
Resource Type definition for AWS::QuickSight::Space.

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.*;
 CfnSpace cfnSpace = CfnSpace.Builder.create(this, "MyCfnSpace")
         .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:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnSpace

      protected CfnSpace(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnSpace

      protected CfnSpace(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnSpace

      @Stability(Stable) public CfnSpace(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnSpaceProps props)
      Create a new AWS::QuickSight::Space.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • arnForSpace

      @Stability(Stable) @NotNull public static String arnForSpace(@NotNull ISpaceRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnSpace

      @Stability(Stable) @NotNull public static Boolean isCfnSpace(@NotNull Object x)
      Checks whether the given object is a CfnSpace.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) of the space.

    • getAttrCreatedAt

      @Stability(Stable) @NotNull public String getAttrCreatedAt()
      The date and time the space was created.

    • getAttrCreatedBy

      @Stability(Stable) @NotNull public String getAttrCreatedBy()
      The user name of the principal who created the space.

    • getAttrUpdatedAt

      @Stability(Stable) @NotNull public String getAttrUpdatedAt()
      The date and time the space was last updated.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getCfnPropertyNames

      @Stability(Stable) @NotNull protected Map<String,String> getCfnPropertyNames()
      Overrides:
      getCfnPropertyNames in class CfnResource

    • getSpaceRef

      @Stability(Stable) @NotNull public SpaceReference getSpaceRef()
      A reference to a Space resource.
      Specified by:
      getSpaceRef in interface ISpaceRef

    • getAwsAccountId

      @Stability(Stable) @NotNull public String getAwsAccountId()
      The ID of the Amazon Web Services account where the space is being created.

    • setAwsAccountId

      @Stability(Stable) public void setAwsAccountId(@NotNull String value)
      The ID of the Amazon Web Services account where the space is being created.

    • getName

      @Stability(Stable) @NotNull public String getName()
      The display name of the space.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The display name of the space.

    • getSpaceId

      @Stability(Stable) @NotNull public String getSpaceId()
      The unique identifier for the space.

    • setSpaceId

      @Stability(Stable) public void setSpaceId(@NotNull String value)
      The unique identifier for the space.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      A description of the space.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      A description of the space.

    • getPermissions

      @Stability(Stable) @Nullable public Object getPermissions()
      A list of permissions granted on the space.

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

    • setPermissions

      @Stability(Stable) public void setPermissions(@Nullable IResolvable value)
      A list of permissions granted on the space.

    • setPermissions

      @Stability(Stable) public void setPermissions(@Nullable List<Object> value)
      A list of permissions granted on the space.

    • getResources

      @Stability(Stable) @Nullable public Object getResources()
      A list of QuickSight resources attached to the space.

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

    • setResources

      @Stability(Stable) public void setResources(@Nullable IResolvable value)
      A list of QuickSight resources attached to the space.

    • setResources

      @Stability(Stable) public void setResources(@Nullable List<Object> value)
      A list of QuickSight resources attached to the space.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      A list of key-value pairs to associate with the space resource.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      A list of key-value pairs to associate with the space resource.