1. Packages
  2. AWS Classic
  3. API Docs
  4. sagemaker
  5. Project

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.44.0 published on Monday, Jul 8, 2024 by Pulumi

aws.sagemaker.Project

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.44.0 published on Monday, Jul 8, 2024 by Pulumi

    Provides a SageMaker Project resource.

    Note: If you are trying to use SageMaker projects with SageMaker 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", {
        projectName: "example",
        serviceCatalogProvisioningDetails: {
            productId: exampleAwsServicecatalogProduct.id,
        },
    });
    
    import pulumi
    import pulumi_aws as aws
    
    example = aws.sagemaker.Project("example",
        project_name="example",
        service_catalog_provisioning_details={
            "productId": example_aws_servicecatalog_product["id"],
        })
    
    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.NewProject(ctx, "example", &sagemaker.ProjectArgs{
    			ProjectName: pulumi.String("example"),
    			ServiceCatalogProvisioningDetails: &sagemaker.ProjectServiceCatalogProvisioningDetailsArgs{
    				ProductId: pulumi.Any(exampleAwsServicecatalogProduct.Id),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    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()
        {
            ProjectName = "example",
            ServiceCatalogProvisioningDetails = new Aws.Sagemaker.Inputs.ProjectServiceCatalogProvisioningDetailsArgs
            {
                ProductId = exampleAwsServicecatalogProduct.Id,
            },
        });
    
    });
    
    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.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 Project("example", ProjectArgs.builder()
                .projectName("example")
                .serviceCatalogProvisioningDetails(ProjectServiceCatalogProvisioningDetailsArgs.builder()
                    .productId(exampleAwsServicecatalogProduct.id())
                    .build())
                .build());
    
        }
    }
    
    resources:
      example:
        type: aws:sagemaker:Project
        properties:
          projectName: example
          serviceCatalogProvisioningDetails:
            productId: ${exampleAwsServicecatalogProduct.id}
    

    Create Project Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Project(name: string, args: ProjectArgs, opts?: CustomResourceOptions);
    @overload
    def Project(resource_name: str,
                args: ProjectArgs,
                opts: Optional[ResourceOptions] = None)
    
    @overload
    def Project(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                project_name: Optional[str] = None,
                service_catalog_provisioning_details: Optional[ProjectServiceCatalogProvisioningDetailsArgs] = None,
                project_description: Optional[str] = None,
                tags: Optional[Mapping[str, str]] = None)
    func NewProject(ctx *Context, name string, args ProjectArgs, opts ...ResourceOption) (*Project, error)
    public Project(string name, ProjectArgs args, CustomResourceOptions? opts = null)
    public Project(String name, ProjectArgs args)
    public Project(String name, ProjectArgs args, CustomResourceOptions options)
    
    type: aws:sagemaker:Project
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args ProjectArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ProjectArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ProjectArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ProjectArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ProjectArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var exampleprojectResourceResourceFromSagemakerproject = new Aws.Sagemaker.Project("exampleprojectResourceResourceFromSagemakerproject", new()
    {
        ProjectName = "string",
        ServiceCatalogProvisioningDetails = new Aws.Sagemaker.Inputs.ProjectServiceCatalogProvisioningDetailsArgs
        {
            ProductId = "string",
            PathId = "string",
            ProvisioningArtifactId = "string",
            ProvisioningParameters = new[]
            {
                new Aws.Sagemaker.Inputs.ProjectServiceCatalogProvisioningDetailsProvisioningParameterArgs
                {
                    Key = "string",
                    Value = "string",
                },
            },
        },
        ProjectDescription = "string",
        Tags = 
        {
            { "string", "string" },
        },
    });
    
    example, err := sagemaker.NewProject(ctx, "exampleprojectResourceResourceFromSagemakerproject", &sagemaker.ProjectArgs{
    	ProjectName: pulumi.String("string"),
    	ServiceCatalogProvisioningDetails: &sagemaker.ProjectServiceCatalogProvisioningDetailsArgs{
    		ProductId:              pulumi.String("string"),
    		PathId:                 pulumi.String("string"),
    		ProvisioningArtifactId: pulumi.String("string"),
    		ProvisioningParameters: sagemaker.ProjectServiceCatalogProvisioningDetailsProvisioningParameterArray{
    			&sagemaker.ProjectServiceCatalogProvisioningDetailsProvisioningParameterArgs{
    				Key:   pulumi.String("string"),
    				Value: pulumi.String("string"),
    			},
    		},
    	},
    	ProjectDescription: pulumi.String("string"),
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    })
    
    var exampleprojectResourceResourceFromSagemakerproject = new Project("exampleprojectResourceResourceFromSagemakerproject", ProjectArgs.builder()
        .projectName("string")
        .serviceCatalogProvisioningDetails(ProjectServiceCatalogProvisioningDetailsArgs.builder()
            .productId("string")
            .pathId("string")
            .provisioningArtifactId("string")
            .provisioningParameters(ProjectServiceCatalogProvisioningDetailsProvisioningParameterArgs.builder()
                .key("string")
                .value("string")
                .build())
            .build())
        .projectDescription("string")
        .tags(Map.of("string", "string"))
        .build());
    
    exampleproject_resource_resource_from_sagemakerproject = aws.sagemaker.Project("exampleprojectResourceResourceFromSagemakerproject",
        project_name="string",
        service_catalog_provisioning_details={
            "productId": "string",
            "pathId": "string",
            "provisioningArtifactId": "string",
            "provisioningParameters": [{
                "key": "string",
                "value": "string",
            }],
        },
        project_description="string",
        tags={
            "string": "string",
        })
    
    const exampleprojectResourceResourceFromSagemakerproject = new aws.sagemaker.Project("exampleprojectResourceResourceFromSagemakerproject", {
        projectName: "string",
        serviceCatalogProvisioningDetails: {
            productId: "string",
            pathId: "string",
            provisioningArtifactId: "string",
            provisioningParameters: [{
                key: "string",
                value: "string",
            }],
        },
        projectDescription: "string",
        tags: {
            string: "string",
        },
    });
    
    type: aws:sagemaker:Project
    properties:
        projectDescription: string
        projectName: string
        serviceCatalogProvisioningDetails:
            pathId: string
            productId: string
            provisioningArtifactId: string
            provisioningParameters:
                - key: string
                  value: string
        tags:
            string: string
    

    Project Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Project resource accepts the following input properties:

    ProjectName string
    The name of the Project.
    ServiceCatalogProvisioningDetails Pulumi.Aws.Sagemaker.Inputs.ProjectServiceCatalogProvisioningDetails
    The product ID and provisioning artifact ID to provision a service catalog. See Service Catalog Provisioning Details below.
    ProjectDescription string
    A description for the project.
    Tags Dictionary<string, string>
    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.
    ProjectName string
    The name of the Project.
    ServiceCatalogProvisioningDetails ProjectServiceCatalogProvisioningDetailsArgs
    The product ID and provisioning artifact ID to provision a service catalog. See Service Catalog Provisioning Details below.
    ProjectDescription string
    A description for the project.
    Tags map[string]string
    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.
    projectName String
    The name of the Project.
    serviceCatalogProvisioningDetails ProjectServiceCatalogProvisioningDetails
    The product ID and provisioning artifact ID to provision a service catalog. See Service Catalog Provisioning Details below.
    projectDescription String
    A description for the project.
    tags Map<String,String>
    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.
    projectName string
    The name of the Project.
    serviceCatalogProvisioningDetails ProjectServiceCatalogProvisioningDetails
    The product ID and provisioning artifact ID to provision a service catalog. See Service Catalog Provisioning Details below.
    projectDescription string
    A description for the project.
    tags {[key: string]: string}
    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.
    project_name str
    The name of the Project.
    service_catalog_provisioning_details ProjectServiceCatalogProvisioningDetailsArgs
    The product ID and provisioning artifact ID to provision a service catalog. See Service Catalog Provisioning Details below.
    project_description str
    A description for the project.
    tags Mapping[str, str]
    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.
    projectName String
    The name of the Project.
    serviceCatalogProvisioningDetails Property Map
    The product ID and provisioning artifact ID to provision a service catalog. See Service Catalog Provisioning Details below.
    projectDescription String
    A description for the project.
    tags Map<String>
    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.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Project resource produces the following output properties:

    Arn string
    The Amazon Resource Name (ARN) assigned by AWS to this Project.
    Id string
    The provider-assigned unique ID for this managed resource.
    ProjectId string
    The ID of the project.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    The Amazon Resource Name (ARN) assigned by AWS to this Project.
    Id string
    The provider-assigned unique ID for this managed resource.
    ProjectId string
    The ID of the project.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    The Amazon Resource Name (ARN) assigned by AWS to this Project.
    id String
    The provider-assigned unique ID for this managed resource.
    projectId String
    The ID of the project.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    The Amazon Resource Name (ARN) assigned by AWS to this Project.
    id string
    The provider-assigned unique ID for this managed resource.
    projectId string
    The ID of the project.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    The Amazon Resource Name (ARN) assigned by AWS to this Project.
    id str
    The provider-assigned unique ID for this managed resource.
    project_id str
    The ID of the project.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    The Amazon Resource Name (ARN) assigned by AWS to this Project.
    id String
    The provider-assigned unique ID for this managed resource.
    projectId String
    The ID of the project.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Look up Existing Project Resource

    Get an existing Project resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ProjectState, opts?: CustomResourceOptions): Project
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            arn: Optional[str] = None,
            project_description: Optional[str] = None,
            project_id: Optional[str] = None,
            project_name: Optional[str] = None,
            service_catalog_provisioning_details: Optional[ProjectServiceCatalogProvisioningDetailsArgs] = None,
            tags: Optional[Mapping[str, str]] = None,
            tags_all: Optional[Mapping[str, str]] = None) -> Project
    func GetProject(ctx *Context, name string, id IDInput, state *ProjectState, opts ...ResourceOption) (*Project, error)
    public static Project Get(string name, Input<string> id, ProjectState? state, CustomResourceOptions? opts = null)
    public static Project get(String name, Output<String> id, ProjectState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Arn string
    The Amazon Resource Name (ARN) assigned by AWS to this Project.
    ProjectDescription string
    A description for the project.
    ProjectId string
    The ID of the project.
    ProjectName string
    The name of the Project.
    ServiceCatalogProvisioningDetails Pulumi.Aws.Sagemaker.Inputs.ProjectServiceCatalogProvisioningDetails
    The product ID and provisioning artifact ID to provision a service catalog. See Service Catalog Provisioning Details below.
    Tags Dictionary<string, string>
    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.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    The Amazon Resource Name (ARN) assigned by AWS to this Project.
    ProjectDescription string
    A description for the project.
    ProjectId string
    The ID of the project.
    ProjectName string
    The name of the Project.
    ServiceCatalogProvisioningDetails ProjectServiceCatalogProvisioningDetailsArgs
    The product ID and provisioning artifact ID to provision a service catalog. See Service Catalog Provisioning Details below.
    Tags map[string]string
    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.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    The Amazon Resource Name (ARN) assigned by AWS to this Project.
    projectDescription String
    A description for the project.
    projectId String
    The ID of the project.
    projectName String
    The name of the Project.
    serviceCatalogProvisioningDetails ProjectServiceCatalogProvisioningDetails
    The product ID and provisioning artifact ID to provision a service catalog. See Service Catalog Provisioning Details below.
    tags Map<String,String>
    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.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    The Amazon Resource Name (ARN) assigned by AWS to this Project.
    projectDescription string
    A description for the project.
    projectId string
    The ID of the project.
    projectName string
    The name of the Project.
    serviceCatalogProvisioningDetails ProjectServiceCatalogProvisioningDetails
    The product ID and provisioning artifact ID to provision a service catalog. See Service Catalog Provisioning Details below.
    tags {[key: string]: string}
    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.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    The Amazon Resource Name (ARN) assigned by AWS to this Project.
    project_description str
    A description for the project.
    project_id str
    The ID of the project.
    project_name str
    The name of the Project.
    service_catalog_provisioning_details ProjectServiceCatalogProvisioningDetailsArgs
    The product ID and provisioning artifact ID to provision a service catalog. See Service Catalog Provisioning Details below.
    tags Mapping[str, str]
    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.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    The Amazon Resource Name (ARN) assigned by AWS to this Project.
    projectDescription String
    A description for the project.
    projectId String
    The ID of the project.
    projectName String
    The name of the Project.
    serviceCatalogProvisioningDetails Property Map
    The product ID and provisioning artifact ID to provision a service catalog. See Service Catalog Provisioning Details below.
    tags Map<String>
    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.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Supporting Types

    ProjectServiceCatalogProvisioningDetails, ProjectServiceCatalogProvisioningDetailsArgs

    ProductId string
    The ID of the product to provision.
    PathId string
    The path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path.
    ProvisioningArtifactId string
    The ID of the provisioning artifact.
    ProvisioningParameters List<Pulumi.Aws.Sagemaker.Inputs.ProjectServiceCatalogProvisioningDetailsProvisioningParameter>
    A list of key value pairs that you specify when you provision a product. See Provisioning Parameter below.
    ProductId string
    The ID of the product to provision.
    PathId string
    The path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path.
    ProvisioningArtifactId string
    The ID of the provisioning artifact.
    ProvisioningParameters []ProjectServiceCatalogProvisioningDetailsProvisioningParameter
    A list of key value pairs that you specify when you provision a product. See Provisioning Parameter below.
    productId String
    The ID of the product to provision.
    pathId String
    The path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path.
    provisioningArtifactId String
    The ID of the provisioning artifact.
    provisioningParameters List<ProjectServiceCatalogProvisioningDetailsProvisioningParameter>
    A list of key value pairs that you specify when you provision a product. See Provisioning Parameter below.
    productId string
    The ID of the product to provision.
    pathId string
    The path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path.
    provisioningArtifactId string
    The ID of the provisioning artifact.
    provisioningParameters ProjectServiceCatalogProvisioningDetailsProvisioningParameter[]
    A list of key value pairs that you specify when you provision a product. See Provisioning Parameter below.
    product_id str
    The ID of the product to provision.
    path_id str
    The path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path.
    provisioning_artifact_id str
    The ID of the provisioning artifact.
    provisioning_parameters Sequence[ProjectServiceCatalogProvisioningDetailsProvisioningParameter]
    A list of key value pairs that you specify when you provision a product. See Provisioning Parameter below.
    productId String
    The ID of the product to provision.
    pathId String
    The path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path.
    provisioningArtifactId String
    The ID of the provisioning artifact.
    provisioningParameters List<Property Map>
    A list of key value pairs that you specify when you provision a product. See Provisioning Parameter below.

    ProjectServiceCatalogProvisioningDetailsProvisioningParameter, ProjectServiceCatalogProvisioningDetailsProvisioningParameterArgs

    Key string
    The key that identifies a provisioning parameter.
    Value string
    The value of the provisioning parameter.
    Key string
    The key that identifies a provisioning parameter.
    Value string
    The value of the provisioning parameter.
    key String
    The key that identifies a provisioning parameter.
    value String
    The value of the provisioning parameter.
    key string
    The key that identifies a provisioning parameter.
    value string
    The value of the provisioning parameter.
    key str
    The key that identifies a provisioning parameter.
    value str
    The value of the provisioning parameter.
    key String
    The key that identifies a provisioning parameter.
    value String
    The value of the provisioning parameter.

    Import

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

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

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.44.0 published on Monday, Jul 8, 2024 by Pulumi