Project class

Provides a SageMaker AI Project resource.

> Note: If you are trying to use SageMaker AI projects with SageMaker AI studio you will need to add a tag with the key sagemaker:studio-visibility with value true. For more on requirements to use projects and permission needed see AWS Docs.

Example Usage

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

const example = new aws.sagemaker.Project("example", {
    serviceCatalogProvisioningDetails: {
        productId: exampleAwsServicecatalogProduct.id,
    },
    projectName: "example",
});
import pulumi
import pulumi_aws as aws

example = aws.sagemaker.Project("example",
    service_catalog_provisioning_details={
        "product_id": example_aws_servicecatalog_product["id"],
    },
    project_name="example")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.Sagemaker.Project("example", new()
    {
        ServiceCatalogProvisioningDetails = new Aws.Sagemaker.Inputs.ProjectServiceCatalogProvisioningDetailsArgs
        {
            ProductId = exampleAwsServicecatalogProduct.Id,
        },
        ProjectName = "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.NewProject(ctx, "example", &sagemaker.ProjectArgs{
			ServiceCatalogProvisioningDetails: &sagemaker.ProjectServiceCatalogProvisioningDetailsArgs{
				ProductId: pulumi.Any(exampleAwsServicecatalogProduct.Id),
			},
			ProjectName: pulumi.String("example"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_sagemaker_project" "example" {
  service_catalog_provisioning_details = {
    product_id = exampleAwsServicecatalogProduct.id
  }
  project_name = "example"
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.sagemaker.Project;
import com.pulumi.aws.sagemaker.ProjectArgs;
import com.pulumi.aws.sagemaker.inputs.ProjectServiceCatalogProvisioningDetailsArgs;
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 Project("example", ProjectArgs.builder()
            .serviceCatalogProvisioningDetails(ProjectServiceCatalogProvisioningDetailsArgs.builder()
                .productId(exampleAwsServicecatalogProduct.id())
                .build())
            .projectName("example")
            .build());

    }
}
resources:
  example:
    type: aws:sagemaker:Project
    properties:
      serviceCatalogProvisioningDetails:
        productId: ${exampleAwsServicecatalogProduct.id}
      projectName: example

Import

Using pulumi import, import SageMaker AI Projects using the projectName. For example:

$ pulumi import aws:sagemaker/project:Project example example

Constructors

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

Properties

arn ↔ Output<String>
ARN assigned by AWS to this Project.
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
hashCode → int
The hash code for this object.
no setterinherited
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
projectDescription ↔ Output<String?>
A description for the project.
latefinal
projectId ↔ Output<String>
The ID of the project.
latefinal
projectName ↔ Output<String>
The name of the Project.
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
serviceCatalogProvisioningDetails ↔ Output<ProjectServiceCatalogProvisioningDetails>
The product ID and provisioning artifact ID to provision a service catalog. See Service Catalog Provisioning Details 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
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, {ProjectState? state, CustomResourceOptions? options}) → Project
Gets an existing Project resource's state with the given name and id.