com.pulumi.aws.sagemaker.kotlin.Model.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.ModelContainer
import com.pulumi.aws.sagemaker.kotlin.outputs.ModelInferenceExecutionConfig
import com.pulumi.aws.sagemaker.kotlin.outputs.ModelPrimaryContainer
import com.pulumi.aws.sagemaker.kotlin.outputs.ModelVpcConfig
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.List
import kotlin.collections.Map
import com.pulumi.aws.sagemaker.kotlin.outputs.ModelContainer.Companion.toKotlin as modelContainerToKotlin
import com.pulumi.aws.sagemaker.kotlin.outputs.ModelInferenceExecutionConfig.Companion.toKotlin as modelInferenceExecutionConfigToKotlin
import com.pulumi.aws.sagemaker.kotlin.outputs.ModelPrimaryContainer.Companion.toKotlin as modelPrimaryContainerToKotlin
import com.pulumi.aws.sagemaker.kotlin.outputs.ModelVpcConfig.Companion.toKotlin as modelVpcConfigToKotlin
/**
* Builder for [Model].
*/
@PulumiTagMarker
public class ModelResourceBuilder internal constructor() {
public var name: String? = null
public var args: ModelArgs = ModelArgs()
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 ModelArgsBuilder.() -> Unit) {
val builder = ModelArgsBuilder()
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(): Model {
val builtJavaResource = com.pulumi.aws.sagemaker.Model(
this.name,
this.args.toJava(),
this.opts.toJava(),
)
return Model(builtJavaResource)
}
}
/**
* Provides a SageMaker model resource.
* ## Example Usage
* Basic usage:
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
* const assumeRole = aws.iam.getPolicyDocument({
* statements: [{
* actions: ["sts:AssumeRole"],
* principals: [{
* type: "Service",
* identifiers: ["sagemaker.amazonaws.com"],
* }],
* }],
* });
* const exampleRole = new aws.iam.Role("example", {assumeRolePolicy: assumeRole.then(assumeRole => assumeRole.json)});
* const test = aws.sagemaker.getPrebuiltEcrImage({
* repositoryName: "kmeans",
* });
* const example = new aws.sagemaker.Model("example", {
* name: "my-model",
* executionRoleArn: exampleRole.arn,
* primaryContainer: {
* image: test.then(test => test.registryPath),
* },
* });
* ```
* ```python
* import pulumi
* import pulumi_aws as aws
* assume_role = aws.iam.get_policy_document(statements=[{
* "actions": ["sts:AssumeRole"],
* "principals": [{
* "type": "Service",
* "identifiers": ["sagemaker.amazonaws.com"],
* }],
* }])
* example_role = aws.iam.Role("example", assume_role_policy=assume_role.json)
* test = aws.sagemaker.get_prebuilt_ecr_image(repository_name="kmeans")
* example = aws.sagemaker.Model("example",
* name="my-model",
* execution_role_arn=example_role.arn,
* primary_container={
* "image": test.registry_path,
* })
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using Aws = Pulumi.Aws;
* return await Deployment.RunAsync(() =>
* {
* var assumeRole = Aws.Iam.GetPolicyDocument.Invoke(new()
* {
* Statements = new[]
* {
* new Aws.Iam.Inputs.GetPolicyDocumentStatementInputArgs
* {
* Actions = new[]
* {
* "sts:AssumeRole",
* },
* Principals = new[]
* {
* new Aws.Iam.Inputs.GetPolicyDocumentStatementPrincipalInputArgs
* {
* Type = "Service",
* Identifiers = new[]
* {
* "sagemaker.amazonaws.com",
* },
* },
* },
* },
* },
* });
* var exampleRole = new Aws.Iam.Role("example", new()
* {
* AssumeRolePolicy = assumeRole.Apply(getPolicyDocumentResult => getPolicyDocumentResult.Json),
* });
* var test = Aws.Sagemaker.GetPrebuiltEcrImage.Invoke(new()
* {
* RepositoryName = "kmeans",
* });
* var example = new Aws.Sagemaker.Model("example", new()
* {
* Name = "my-model",
* ExecutionRoleArn = exampleRole.Arn,
* PrimaryContainer = new Aws.Sagemaker.Inputs.ModelPrimaryContainerArgs
* {
* Image = test.Apply(getPrebuiltEcrImageResult => getPrebuiltEcrImageResult.RegistryPath),
* },
* });
* });
* ```
* ```go
* package main
* import (
* "github.com/pulumi/pulumi-aws/sdk/v6/go/aws/iam"
* "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 {
* assumeRole, err := iam.GetPolicyDocument(ctx, &iam.GetPolicyDocumentArgs{
* Statements: []iam.GetPolicyDocumentStatement{
* {
* Actions: []string{
* "sts:AssumeRole",
* },
* Principals: []iam.GetPolicyDocumentStatementPrincipal{
* {
* Type: "Service",
* Identifiers: []string{
* "sagemaker.amazonaws.com",
* },
* },
* },
* },
* },
* }, nil)
* if err != nil {
* return err
* }
* exampleRole, err := iam.NewRole(ctx, "example", &iam.RoleArgs{
* AssumeRolePolicy: pulumi.String(assumeRole.Json),
* })
* if err != nil {
* return err
* }
* test, err := sagemaker.GetPrebuiltEcrImage(ctx, &sagemaker.GetPrebuiltEcrImageArgs{
* RepositoryName: "kmeans",
* }, nil)
* if err != nil {
* return err
* }
* _, err = sagemaker.NewModel(ctx, "example", &sagemaker.ModelArgs{
* Name: pulumi.String("my-model"),
* ExecutionRoleArn: exampleRole.Arn,
* PrimaryContainer: &sagemaker.ModelPrimaryContainerArgs{
* Image: pulumi.String(test.RegistryPath),
* },
* })
* 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.iam.IamFunctions;
* import com.pulumi.aws.iam.inputs.GetPolicyDocumentArgs;
* import com.pulumi.aws.iam.Role;
* import com.pulumi.aws.iam.RoleArgs;
* import com.pulumi.aws.sagemaker.SagemakerFunctions;
* import com.pulumi.aws.sagemaker.inputs.GetPrebuiltEcrImageArgs;
* import com.pulumi.aws.sagemaker.Model;
* import com.pulumi.aws.sagemaker.ModelArgs;
* import com.pulumi.aws.sagemaker.inputs.ModelPrimaryContainerArgs;
* 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) {
* final var assumeRole = IamFunctions.getPolicyDocument(GetPolicyDocumentArgs.builder()
* .statements(GetPolicyDocumentStatementArgs.builder()
* .actions("sts:AssumeRole")
* .principals(GetPolicyDocumentStatementPrincipalArgs.builder()
* .type("Service")
* .identifiers("sagemaker.amazonaws.com")
* .build())
* .build())
* .build());
* var exampleRole = new Role("exampleRole", RoleArgs.builder()
* .assumeRolePolicy(assumeRole.applyValue(getPolicyDocumentResult -> getPolicyDocumentResult.json()))
* .build());
* final var test = SagemakerFunctions.getPrebuiltEcrImage(GetPrebuiltEcrImageArgs.builder()
* .repositoryName("kmeans")
* .build());
* var example = new Model("example", ModelArgs.builder()
* .name("my-model")
* .executionRoleArn(exampleRole.arn())
* .primaryContainer(ModelPrimaryContainerArgs.builder()
* .image(test.applyValue(getPrebuiltEcrImageResult -> getPrebuiltEcrImageResult.registryPath()))
* .build())
* .build());
* }
* }
* ```
* ```yaml
* resources:
* example:
* type: aws:sagemaker:Model
* properties:
* name: my-model
* executionRoleArn: ${exampleRole.arn}
* primaryContainer:
* image: ${test.registryPath}
* exampleRole:
* type: aws:iam:Role
* name: example
* properties:
* assumeRolePolicy: ${assumeRole.json}
* variables:
* assumeRole:
* fn::invoke:
* Function: aws:iam:getPolicyDocument
* Arguments:
* statements:
* - actions:
* - sts:AssumeRole
* principals:
* - type: Service
* identifiers:
* - sagemaker.amazonaws.com
* test:
* fn::invoke:
* Function: aws:sagemaker:getPrebuiltEcrImage
* Arguments:
* repositoryName: kmeans
* ```
*
* ## Inference Execution Config
* * `mode` - (Required) How containers in a multi-container are run. The following values are valid `Serial` and `Direct`.
* ## Import
* Using `pulumi import`, import models using the `name`. For example:
* ```sh
* $ pulumi import aws:sagemaker/model:Model test_model model-foo
* ```
*/
public class Model internal constructor(
override val javaResource: com.pulumi.aws.sagemaker.Model,
) : KotlinCustomResource(javaResource, ModelMapper) {
/**
* The Amazon Resource Name (ARN) assigned by AWS to this model.
*/
public val arn: Output
get() = javaResource.arn().applyValue({ args0 -> args0 })
/**
* Specifies containers in the inference pipeline. If not specified, the `primary_container` argument is required. Fields are documented below.
*/
public val containers: Output>?
get() = javaResource.containers().applyValue({ args0 ->
args0.map({ args0 ->
args0.map({ args0 ->
args0.let({ args0 -> modelContainerToKotlin(args0) })
})
}).orElse(null)
})
/**
* Isolates the model container. No inbound or outbound network calls can be made to or from the model container.
*/
public val enableNetworkIsolation: Output?
get() = javaResource.enableNetworkIsolation().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* A role that SageMaker can assume to access model artifacts and docker images for deployment.
*/
public val executionRoleArn: Output
get() = javaResource.executionRoleArn().applyValue({ args0 -> args0 })
/**
* Specifies details of how containers in a multi-container endpoint are called. see Inference Execution Config.
*/
public val inferenceExecutionConfig: Output
get() = javaResource.inferenceExecutionConfig().applyValue({ args0 ->
args0.let({ args0 ->
modelInferenceExecutionConfigToKotlin(args0)
})
})
/**
* The name of the model (must be unique). If omitted, this provider will assign a random, unique name.
*/
public val name: Output
get() = javaResource.name().applyValue({ args0 -> args0 })
/**
* The primary docker image containing inference code that is used when the model is deployed for predictions. If not specified, the `container` argument is required. Fields are documented below.
*/
public val primaryContainer: Output?
get() = javaResource.primaryContainer().applyValue({ args0 ->
args0.map({ args0 ->
args0.let({ args0 -> modelPrimaryContainerToKotlin(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()
})
/**
* Specifies the VPC that you want your model to connect to. VpcConfig is used in hosting services and in batch transform.
*/
public val vpcConfig: Output?
get() = javaResource.vpcConfig().applyValue({ args0 ->
args0.map({ args0 ->
args0.let({ args0 ->
modelVpcConfigToKotlin(args0)
})
}).orElse(null)
})
}
public object ModelMapper : ResourceMapper {
override fun supportsMappingOfType(javaResource: Resource): Boolean =
com.pulumi.aws.sagemaker.Model::class == javaResource::class
override fun map(javaResource: Resource): Model = Model(
javaResource as
com.pulumi.aws.sagemaker.Model,
)
}
/**
* @see [Model].
* @param name The _unique_ name of the resulting resource.
* @param block Builder for [Model].
*/
public suspend fun model(name: String, block: suspend ModelResourceBuilder.() -> Unit): Model {
val builder = ModelResourceBuilder()
builder.name(name)
block(builder)
return builder.build()
}
/**
* @see [Model].
* @param name The _unique_ name of the resulting resource.
*/
public fun model(name: String): Model {
val builder = ModelResourceBuilder()
builder.name(name)
return builder.build()
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy