@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
202 lines (201 loc) • 8.37 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Provides a SageMaker AI Space resource.
*
* ## Example Usage
*
* ### Basic usage
*
* ```typescript
* 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
*
* 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
* ```
*/
export declare class Space extends pulumi.CustomResource {
/**
* Get an existing Space resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: SpaceState, opts?: pulumi.CustomResourceOptions): Space;
/**
* Returns true if the given object is an instance of Space. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is Space;
/**
* The space's Amazon Resource Name (ARN).
*/
readonly arn: pulumi.Output<string>;
/**
* The ID of the associated Domain.
*/
readonly domainId: pulumi.Output<string>;
/**
* The ID of the space's profile in the Amazon Elastic File System volume.
*/
readonly homeEfsFileSystemUid: pulumi.Output<string>;
/**
* A collection of ownership settings. Required if `spaceSharingSettings` is set. See `ownershipSettings` Block below.
*/
readonly ownershipSettings: pulumi.Output<outputs.sagemaker.SpaceOwnershipSettings | undefined>;
/**
* 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.
*/
readonly region: pulumi.Output<string>;
/**
* The name of the space that appears in the SageMaker AI Studio UI.
*/
readonly spaceDisplayName: pulumi.Output<string | undefined>;
/**
* The name of the space.
*/
readonly spaceName: pulumi.Output<string>;
/**
* A collection of space settings. See `spaceSettings` Block below.
*/
readonly spaceSettings: pulumi.Output<outputs.sagemaker.SpaceSpaceSettings | undefined>;
/**
* A collection of space sharing settings. Required if `ownershipSettings` is set. See `spaceSharingSettings` Block below.
*/
readonly spaceSharingSettings: pulumi.Output<outputs.sagemaker.SpaceSpaceSharingSettings | undefined>;
/**
* 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.
*/
readonly tags: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
*/
readonly tagsAll: pulumi.Output<{
[key: string]: 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.
*/
readonly url: pulumi.Output<string>;
/**
* Create a Space resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: SpaceArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Space resources.
*/
export interface SpaceState {
/**
* The space's Amazon Resource Name (ARN).
*/
arn?: pulumi.Input<string>;
/**
* The ID of the associated Domain.
*/
domainId?: pulumi.Input<string>;
/**
* The ID of the space's profile in the Amazon Elastic File System volume.
*/
homeEfsFileSystemUid?: pulumi.Input<string>;
/**
* A collection of ownership settings. Required if `spaceSharingSettings` is set. See `ownershipSettings` Block below.
*/
ownershipSettings?: pulumi.Input<inputs.sagemaker.SpaceOwnershipSettings>;
/**
* 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.
*/
region?: pulumi.Input<string>;
/**
* The name of the space that appears in the SageMaker AI Studio UI.
*/
spaceDisplayName?: pulumi.Input<string>;
/**
* The name of the space.
*/
spaceName?: pulumi.Input<string>;
/**
* A collection of space settings. See `spaceSettings` Block below.
*/
spaceSettings?: pulumi.Input<inputs.sagemaker.SpaceSpaceSettings>;
/**
* A collection of space sharing settings. Required if `ownershipSettings` is set. See `spaceSharingSettings` Block below.
*/
spaceSharingSettings?: pulumi.Input<inputs.sagemaker.SpaceSpaceSharingSettings>;
/**
* 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.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
*/
tagsAll?: pulumi.Input<{
[key: string]: pulumi.Input<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.
*/
url?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a Space resource.
*/
export interface SpaceArgs {
/**
* The ID of the associated Domain.
*/
domainId: pulumi.Input<string>;
/**
* A collection of ownership settings. Required if `spaceSharingSettings` is set. See `ownershipSettings` Block below.
*/
ownershipSettings?: pulumi.Input<inputs.sagemaker.SpaceOwnershipSettings>;
/**
* 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.
*/
region?: pulumi.Input<string>;
/**
* The name of the space that appears in the SageMaker AI Studio UI.
*/
spaceDisplayName?: pulumi.Input<string>;
/**
* The name of the space.
*/
spaceName: pulumi.Input<string>;
/**
* A collection of space settings. See `spaceSettings` Block below.
*/
spaceSettings?: pulumi.Input<inputs.sagemaker.SpaceSpaceSettings>;
/**
* A collection of space sharing settings. Required if `ownershipSettings` is set. See `spaceSharingSettings` Block below.
*/
spaceSharingSettings?: pulumi.Input<inputs.sagemaker.SpaceSpaceSharingSettings>;
/**
* 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.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
}