Space class

Provides a SageMaker AI Space resource.

Example Usage

Basic usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.sagemaker.Space("example", {
    domainId: test.id,
    spaceName: "example",
});
import pulumi
import pulumi_aws as aws

example = aws.sagemaker.Space("example",
    domain_id=test["id"],
    space_name="example")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.Sagemaker.Space("example", new()
    {
        DomainId = test.Id,
        SpaceName = "example",
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/sagemaker"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := sagemaker.NewSpace(ctx, "example", &sagemaker.SpaceArgs{
			DomainId:  pulumi.Any(test.Id),
			SpaceName: pulumi.String("example"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_sagemaker_space" "example" {
  domain_id  = test.id
  space_name = "example"
}
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());

    }
}
resources:
  example:
    type: aws:sagemaker:Space
    properties:
      domainId: ${test.id}
      spaceName: example

Import

Using pulumi import, import SageMaker AI Spaces using the id. For example:

$ pulumi import aws:sagemaker/space:Space test_space arn:aws:sagemaker:us-west-2:123456789012:space/domain-id/space-name

Constructors

Space(String name, {SpaceArgs? args, CustomResourceOptions? options})
Creates a new Space. name The Pulumi resource name. args Arguments used to configure this Space. The set of arguments for Space. options Resource options controlling this resource's behavior.
Space.reference(String urn)
Creates a typed reference to an existing Space resource.

Properties

arn ↔ Output<String>
Space's ARN.
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
domainId ↔ Output<String>
The ID of the associated Domain.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
homeEfsFileSystemUid ↔ Output<String>
The ID of the space's profile in the Amazon Elastic File System volume.
latefinal
id ↔ Output<String>
getter/setter pairinherited
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
ownershipSettings ↔ Output<SpaceOwnershipSettings?>
A collection of ownership settings. Required if spaceSharingSettings is set. See ownershipSettings Block below.
latefinal
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
spaceDisplayName ↔ Output<String?>
The name of the space that appears in the SageMaker AI Studio UI.
latefinal
spaceName ↔ Output<String>
The name of the space.
latefinal
spaceSettings ↔ Output<SpaceSpaceSettings?>
A collection of space settings. See spaceSettings Block below.
latefinal
spaceSharingSettings ↔ Output<SpaceSpaceSharingSettings?>
A collection of space sharing settings. Required if ownershipSettings is set. See spaceSharingSettings Block below.
latefinal
tags ↔ Output<Map<String, String>?>
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.
latefinal
tagsAll ↔ Output<Map<String, String>>
A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
url ↔ Output<String>
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.
latefinal
urn ↔ Output<String>
latefinalinherited

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {SpaceState? state, CustomResourceOptions? options}) → Space
Gets an existing Space resource's state with the given name and id.