Package com.pulumi.aws.sagemaker

Class Space

  • public class Space
extends com.pulumi.resources.CustomResource
    Provides a SageMaker AI Space resource. ## Example Usage ### Basic usage 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.sagemaker.Space;
 import com.pulumi.aws.sagemaker.SpaceArgs;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Map;
 import java.io.File;
 import java.nio.file.Files;
 import java.nio.file.Paths;
 
 public class App {
     public static void main(String[] args) {
         Pulumi.run(App::stack);
     }
 
     public static void stack(Context ctx) {
         var example = new Space("example", SpaceArgs.builder()
             .domainId(test.id())
             .spaceName("example")
             .build());
 
     }
 }
    ## Import Using `pulumi import`, import SageMaker AI Spaces using the `id`. For example: ```sh $ pulumi import aws:sagemaker/space:Space test_space arn:aws:sagemaker:us-west-2:123456789012:space/domain-id/space-name ```

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal

      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Constructor Summary

      Constructors 
      Constructor Description
      Space​(java.lang.String name)  
      Space​(java.lang.String name, SpaceArgs args)  
      Space​(java.lang.String name, SpaceArgs args, com.pulumi.resources.CustomResourceOptions options)  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.lang.String> arn()  
      com.pulumi.core.Output<java.lang.String> domainId()  
      static Space get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, SpaceState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.lang.String> homeEfsFileSystemUid()  
      com.pulumi.core.Output<java.util.Optional<SpaceOwnershipSettings>> ownershipSettings()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> spaceDisplayName()  
      com.pulumi.core.Output<java.lang.String> spaceName()  
      com.pulumi.core.Output<java.util.Optional<SpaceSpaceSettings>> spaceSettings()  
      com.pulumi.core.Output<java.util.Optional<SpaceSpaceSharingSettings>> spaceSharingSettings()  
      com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()  
      com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()  
      com.pulumi.core.Output<java.lang.String> url()  

      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture

      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • Space

        public Space​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • Space

        public Space​(java.lang.String name,
             SpaceArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • Space

        public Space​(java.lang.String name,
             SpaceArgs args,
             @Nullable
             com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.

    • Method Detail

      • arn

        public com.pulumi.core.Output<java.lang.String> arn()
        Returns:
        Space's ARN.

      • domainId

        public com.pulumi.core.Output<java.lang.String> domainId()
        Returns:
        The ID of the associated Domain.

      • homeEfsFileSystemUid

        public com.pulumi.core.Output<java.lang.String> homeEfsFileSystemUid()
        Returns:
        The ID of the space's profile in the Amazon Elastic File System volume.

      • ownershipSettings

        public com.pulumi.core.Output<java.util.Optional<SpaceOwnershipSettings>> ownershipSettings()
        Returns:
        A collection of ownership settings. Required if `spaceSharingSettings` is set. See `ownershipSettings` Block below.

      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

      • spaceDisplayName

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> spaceDisplayName()
        Returns:
        The name of the space that appears in the SageMaker AI Studio UI.

      • spaceName

        public com.pulumi.core.Output<java.lang.String> spaceName()
        Returns:
        The name of the space.

      • spaceSettings

        public com.pulumi.core.Output<java.util.Optional<SpaceSpaceSettings>> spaceSettings()
        Returns:
        A collection of space settings. See `spaceSettings` Block below.

      • spaceSharingSettings

        public com.pulumi.core.Output<java.util.Optional<SpaceSpaceSharingSettings>> spaceSharingSettings()
        Returns:
        A collection of space sharing settings. Required if `ownershipSettings` is set. See `spaceSharingSettings` Block below.

      • tags

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        A map of tags to assign to the resource. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.

      • tagsAll

        public com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()
        Returns:
        A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.

      • url

        public com.pulumi.core.Output<java.lang.String> url()
        Returns:
        Returns the URL of the space. If the space is created with Amazon Web Services IAM Identity Center (Successor to Amazon Web Services Single Sign-On) authentication, users can navigate to the URL after appending the respective redirect parameter for the application type to be federated through Amazon Web Services IAM Identity Center.

      • get

        public static Space get​(java.lang.String name,
                        com.pulumi.core.Output<java.lang.String> id,
                        @Nullable
                        SpaceState state,
                        @Nullable
                        com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.