com.pulumi.aws.sagemaker.kotlin.Space.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-aws-kotlin Show documentation
Show all versions of pulumi-aws-kotlin Show documentation
Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.aws.sagemaker.kotlin
import com.pulumi.aws.sagemaker.kotlin.outputs.SpaceOwnershipSettings
import com.pulumi.aws.sagemaker.kotlin.outputs.SpaceSpaceSettings
import com.pulumi.aws.sagemaker.kotlin.outputs.SpaceSpaceSharingSettings
import com.pulumi.core.Output
import com.pulumi.kotlin.KotlinCustomResource
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.ResourceMapper
import com.pulumi.kotlin.options.CustomResourceOptions
import com.pulumi.kotlin.options.CustomResourceOptionsBuilder
import com.pulumi.resources.Resource
import kotlin.Boolean
import kotlin.Deprecated
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.collections.Map
import com.pulumi.aws.sagemaker.kotlin.outputs.SpaceOwnershipSettings.Companion.toKotlin as spaceOwnershipSettingsToKotlin
import com.pulumi.aws.sagemaker.kotlin.outputs.SpaceSpaceSettings.Companion.toKotlin as spaceSpaceSettingsToKotlin
import com.pulumi.aws.sagemaker.kotlin.outputs.SpaceSpaceSharingSettings.Companion.toKotlin as spaceSpaceSharingSettingsToKotlin
/**
* Builder for [Space].
*/
@PulumiTagMarker
public class SpaceResourceBuilder internal constructor() {
public var name: String? = null
public var args: SpaceArgs = SpaceArgs()
public var opts: CustomResourceOptions = CustomResourceOptions()
/**
* @param name The _unique_ name of the resulting resource.
*/
public fun name(`value`: String) {
this.name = value
}
/**
* @param block The arguments to use to populate this resource's properties.
*/
public suspend fun args(block: suspend SpaceArgsBuilder.() -> Unit) {
val builder = SpaceArgsBuilder()
block(builder)
this.args = builder.build()
}
/**
* @param block A bag of options that control this resource's behavior.
*/
public suspend fun opts(block: suspend CustomResourceOptionsBuilder.() -> Unit) {
this.opts = com.pulumi.kotlin.options.CustomResourceOptions.opts(block)
}
internal fun build(): Space {
val builtJavaResource = com.pulumi.aws.sagemaker.Space(
this.name,
this.args.toJava(),
this.opts.toJava(),
)
return Space(builtJavaResource)
}
}
/**
* Provides a SageMaker 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",
* });
* ```
* ```python
* import pulumi
* import pulumi_aws as aws
* example = aws.sagemaker.Space("example",
* domain_id=test["id"],
* space_name="example")
* ```
* ```csharp
* 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",
* });
* });
* ```
* ```go
* package main
* import (
* "github.com/pulumi/pulumi-aws/sdk/v6/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
* })
* }
* ```
* ```java
* 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.List;
* import java.util.ArrayList;
* 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());
* }
* }
* ```
* ```yaml
* resources:
* example:
* type: aws:sagemaker:Space
* properties:
* domainId: ${test.id}
* spaceName: example
* ```
*
* ## Import
* Using `pulumi import`, import SageMaker 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
* ```
*/
public class Space internal constructor(
override val javaResource: com.pulumi.aws.sagemaker.Space,
) : KotlinCustomResource(javaResource, SpaceMapper) {
/**
* The space's Amazon Resource Name (ARN).
*/
public val arn: Output
get() = javaResource.arn().applyValue({ args0 -> args0 })
/**
* The ID of the associated Domain.
*/
public val domainId: Output
get() = javaResource.domainId().applyValue({ args0 -> args0 })
/**
* The ID of the space's profile in the Amazon Elastic File System volume.
*/
public val homeEfsFileSystemUid: Output
get() = javaResource.homeEfsFileSystemUid().applyValue({ args0 -> args0 })
/**
* A collection of ownership settings. Required if `space_sharing_settings` is set. See `ownership_settings` Block below.
*/
public val ownershipSettings: Output?
get() = javaResource.ownershipSettings().applyValue({ args0 ->
args0.map({ args0 ->
args0.let({ args0 -> spaceOwnershipSettingsToKotlin(args0) })
}).orElse(null)
})
/**
* The name of the space that appears in the SageMaker Studio UI.
*/
public val spaceDisplayName: Output?
get() = javaResource.spaceDisplayName().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* The name of the space.
*/
public val spaceName: Output
get() = javaResource.spaceName().applyValue({ args0 -> args0 })
/**
* A collection of space settings. See `space_settings` Block below.
*/
public val spaceSettings: Output?
get() = javaResource.spaceSettings().applyValue({ args0 ->
args0.map({ args0 ->
args0.let({ args0 -> spaceSpaceSettingsToKotlin(args0) })
}).orElse(null)
})
/**
* A collection of space sharing settings. Required if `ownership_settings` is set. See `space_sharing_settings` Block below.
*/
public val spaceSharingSettings: Output?
get() = javaResource.spaceSharingSettings().applyValue({ args0 ->
args0.map({ args0 ->
args0.let({ args0 -> spaceSpaceSharingSettingsToKotlin(args0) })
}).orElse(null)
})
/**
* A map of tags to assign to the resource. If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
public val tags: Output>?
get() = javaResource.tags().applyValue({ args0 ->
args0.map({ args0 ->
args0.map({ args0 ->
args0.key.to(args0.value)
}).toMap()
}).orElse(null)
})
/**
* A map of tags assigned to the resource, including those inherited from the provider `default_tags` configuration block.
*/
@Deprecated(
message = """
Please use `tags` instead.
""",
)
public val tagsAll: Output>
get() = javaResource.tagsAll().applyValue({ args0 ->
args0.map({ args0 ->
args0.key.to(args0.value)
}).toMap()
})
/**
* 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.
*/
public val url: Output
get() = javaResource.url().applyValue({ args0 -> args0 })
}
public object SpaceMapper : ResourceMapper {
override fun supportsMappingOfType(javaResource: Resource): Boolean =
com.pulumi.aws.sagemaker.Space::class == javaResource::class
override fun map(javaResource: Resource): Space = Space(
javaResource as
com.pulumi.aws.sagemaker.Space,
)
}
/**
* @see [Space].
* @param name The _unique_ name of the resulting resource.
* @param block Builder for [Space].
*/
public suspend fun space(name: String, block: suspend SpaceResourceBuilder.() -> Unit): Space {
val builder = SpaceResourceBuilder()
builder.name(name)
block(builder)
return builder.build()
}
/**
* @see [Space].
* @param name The _unique_ name of the resulting resource.
*/
public fun space(name: String): Space {
val builder = SpaceResourceBuilder()
builder.name(name)
return builder.build()
}