Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. AiDocument
  5. Project
Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi
pulumi/pulumi-oci

oci.AiDocument.Project

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi
pulumi/pulumi-oci

    This resource provides the Project resource in Oracle Cloud Infrastructure Ai Document service.

    Create a new project.

    Example Usage

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

const testProject = new oci.aidocument.Project("test_project", {
    compartmentId: compartmentId,
    definedTags: projectDefinedTags,
    description: projectDescription,
    displayName: projectDisplayName,
    freeformTags: projectFreeformTags,
});

    import pulumi
import pulumi_oci as oci

test_project = oci.ai_document.Project("test_project",
    compartment_id=compartment_id,
    defined_tags=project_defined_tags,
    description=project_description,
    display_name=project_display_name,
    freeform_tags=project_freeform_tags)

    package main

import (
	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/AiDocument"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := AiDocument.NewProject(ctx, "test_project", &AiDocument.ProjectArgs{
			CompartmentId: pulumi.Any(compartmentId),
			DefinedTags:   pulumi.Any(projectDefinedTags),
			Description:   pulumi.Any(projectDescription),
			DisplayName:   pulumi.Any(projectDisplayName),
			FreeformTags:  pulumi.Any(projectFreeformTags),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testProject = new Oci.AiDocument.Project("test_project", new()
    {
        CompartmentId = compartmentId,
        DefinedTags = projectDefinedTags,
        Description = projectDescription,
        DisplayName = projectDisplayName,
        FreeformTags = projectFreeformTags,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.AiDocument.Project;
import com.pulumi.oci.AiDocument.ProjectArgs;
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 testProject = new Project("testProject", ProjectArgs.builder()
            .compartmentId(compartmentId)
            .definedTags(projectDefinedTags)
            .description(projectDescription)
            .displayName(projectDisplayName)
            .freeformTags(projectFreeformTags)
            .build());

    }
}

    resources:
  testProject:
    type: oci:AiDocument:Project
    name: test_project
    properties:
      compartmentId: ${compartmentId}
      definedTags: ${projectDefinedTags}
      description: ${projectDescription}
      displayName: ${projectDisplayName}
      freeformTags: ${projectFreeformTags}

    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,
            compartment_id: Optional[str] = None,
            defined_tags: Optional[Mapping[str, str]] = None,
            description: Optional[str] = None,
            display_name: Optional[str] = None,
            freeform_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: oci:AiDocument: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 ociProjectResource = new Oci.AiDocument.Project("ociProjectResource", new()
{
    CompartmentId = "string",
    DefinedTags = 
    {
        { "string", "string" },
    },
    Description = "string",
    DisplayName = "string",
    FreeformTags = 
    {
        { "string", "string" },
    },
});

    example, err := AiDocument.NewProject(ctx, "ociProjectResource", &AiDocument.ProjectArgs{
	CompartmentId: pulumi.String("string"),
	DefinedTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Description: pulumi.String("string"),
	DisplayName: pulumi.String("string"),
	FreeformTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var ociProjectResource = new Project("ociProjectResource", ProjectArgs.builder()
    .compartmentId("string")
    .definedTags(Map.of("string", "string"))
    .description("string")
    .displayName("string")
    .freeformTags(Map.of("string", "string"))
    .build());

    oci_project_resource = oci.ai_document.Project("ociProjectResource",
    compartment_id="string",
    defined_tags={
        "string": "string",
    },
    description="string",
    display_name="string",
    freeform_tags={
        "string": "string",
    })

    const ociProjectResource = new oci.aidocument.Project("ociProjectResource", {
    compartmentId: "string",
    definedTags: {
        string: "string",
    },
    description: "string",
    displayName: "string",
    freeformTags: {
        string: "string",
    },
});

    type: oci:AiDocument:Project
properties:
    compartmentId: string
    definedTags:
        string: string
    description: string
    displayName: string
    freeformTags:
        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

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Project resource accepts the following input properties:

    CompartmentId string
    (Updatable) The compartment identifier.
    DefinedTags Dictionary<string, string>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For example: {"foo-namespace": {"bar-key": "value"}}
    Description string
    (Updatable) An optional description of the project.
    DisplayName string
    (Updatable) A human-friendly name for the project, that can be changed.
    FreeformTags Dictionary<string, string>

    (Updatable) A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: {"bar-key": "value"}

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    CompartmentId string
    (Updatable) The compartment identifier.
    DefinedTags map[string]string
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For example: {"foo-namespace": {"bar-key": "value"}}
    Description string
    (Updatable) An optional description of the project.
    DisplayName string
    (Updatable) A human-friendly name for the project, that can be changed.
    FreeformTags map[string]string

    (Updatable) A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: {"bar-key": "value"}

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    compartmentId String
    (Updatable) The compartment identifier.
    definedTags Map<String,String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For example: {"foo-namespace": {"bar-key": "value"}}
    description String
    (Updatable) An optional description of the project.
    displayName String
    (Updatable) A human-friendly name for the project, that can be changed.
    freeformTags Map<String,String>

    (Updatable) A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: {"bar-key": "value"}

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    compartmentId string
    (Updatable) The compartment identifier.
    definedTags {[key: string]: string}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For example: {"foo-namespace": {"bar-key": "value"}}
    description string
    (Updatable) An optional description of the project.
    displayName string
    (Updatable) A human-friendly name for the project, that can be changed.
    freeformTags {[key: string]: string}

    (Updatable) A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: {"bar-key": "value"}

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    compartment_id str
    (Updatable) The compartment identifier.
    defined_tags Mapping[str, str]
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For example: {"foo-namespace": {"bar-key": "value"}}
    description str
    (Updatable) An optional description of the project.
    display_name str
    (Updatable) A human-friendly name for the project, that can be changed.
    freeform_tags Mapping[str, str]

    (Updatable) A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: {"bar-key": "value"}

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    compartmentId String
    (Updatable) The compartment identifier.
    definedTags Map<String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For example: {"foo-namespace": {"bar-key": "value"}}
    description String
    (Updatable) An optional description of the project.
    displayName String
    (Updatable) A human-friendly name for the project, that can be changed.
    freeformTags Map<String>

    (Updatable) A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: {"bar-key": "value"}

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    LifecycleDetails string
    A message describing the current state in more detail, that can provide actionable information if creation failed.
    State string
    The current state of the project.
    SystemTags Dictionary<string, string>
    Usage of system tag keys. These predefined keys are scoped to namespaces. For example: {"orcl-cloud": {"free-tier-retained": "true"}}
    TimeCreated string
    When the project was created, as an RFC3339 datetime string.
    TimeUpdated string
    When the project was updated, as an RFC3339 datetime string.
    Id string
    The provider-assigned unique ID for this managed resource.
    LifecycleDetails string
    A message describing the current state in more detail, that can provide actionable information if creation failed.
    State string
    The current state of the project.
    SystemTags map[string]string
    Usage of system tag keys. These predefined keys are scoped to namespaces. For example: {"orcl-cloud": {"free-tier-retained": "true"}}
    TimeCreated string
    When the project was created, as an RFC3339 datetime string.
    TimeUpdated string
    When the project was updated, as an RFC3339 datetime string.
    id String
    The provider-assigned unique ID for this managed resource.
    lifecycleDetails String
    A message describing the current state in more detail, that can provide actionable information if creation failed.
    state String
    The current state of the project.
    systemTags Map<String,String>
    Usage of system tag keys. These predefined keys are scoped to namespaces. For example: {"orcl-cloud": {"free-tier-retained": "true"}}
    timeCreated String
    When the project was created, as an RFC3339 datetime string.
    timeUpdated String
    When the project was updated, as an RFC3339 datetime string.
    id string
    The provider-assigned unique ID for this managed resource.
    lifecycleDetails string
    A message describing the current state in more detail, that can provide actionable information if creation failed.
    state string
    The current state of the project.
    systemTags {[key: string]: string}
    Usage of system tag keys. These predefined keys are scoped to namespaces. For example: {"orcl-cloud": {"free-tier-retained": "true"}}
    timeCreated string
    When the project was created, as an RFC3339 datetime string.
    timeUpdated string
    When the project was updated, as an RFC3339 datetime string.
    id str
    The provider-assigned unique ID for this managed resource.
    lifecycle_details str
    A message describing the current state in more detail, that can provide actionable information if creation failed.
    state str
    The current state of the project.
    system_tags Mapping[str, str]
    Usage of system tag keys. These predefined keys are scoped to namespaces. For example: {"orcl-cloud": {"free-tier-retained": "true"}}
    time_created str
    When the project was created, as an RFC3339 datetime string.
    time_updated str
    When the project was updated, as an RFC3339 datetime string.
    id String
    The provider-assigned unique ID for this managed resource.
    lifecycleDetails String
    A message describing the current state in more detail, that can provide actionable information if creation failed.
    state String
    The current state of the project.
    systemTags Map<String>
    Usage of system tag keys. These predefined keys are scoped to namespaces. For example: {"orcl-cloud": {"free-tier-retained": "true"}}
    timeCreated String
    When the project was created, as an RFC3339 datetime string.
    timeUpdated String
    When the project was updated, as an RFC3339 datetime string.

    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,
        compartment_id: Optional[str] = None,
        defined_tags: Optional[Mapping[str, str]] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, str]] = None,
        lifecycle_details: Optional[str] = None,
        state: Optional[str] = None,
        system_tags: Optional[Mapping[str, str]] = None,
        time_created: Optional[str] = None,
        time_updated: Optional[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:
    CompartmentId string
    (Updatable) The compartment identifier.
    DefinedTags Dictionary<string, string>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For example: {"foo-namespace": {"bar-key": "value"}}
    Description string
    (Updatable) An optional description of the project.
    DisplayName string
    (Updatable) A human-friendly name for the project, that can be changed.
    FreeformTags Dictionary<string, string>

    (Updatable) A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: {"bar-key": "value"}

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    LifecycleDetails string
    A message describing the current state in more detail, that can provide actionable information if creation failed.
    State string
    The current state of the project.
    SystemTags Dictionary<string, string>
    Usage of system tag keys. These predefined keys are scoped to namespaces. For example: {"orcl-cloud": {"free-tier-retained": "true"}}
    TimeCreated string
    When the project was created, as an RFC3339 datetime string.
    TimeUpdated string
    When the project was updated, as an RFC3339 datetime string.
    CompartmentId string
    (Updatable) The compartment identifier.
    DefinedTags map[string]string
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For example: {"foo-namespace": {"bar-key": "value"}}
    Description string
    (Updatable) An optional description of the project.
    DisplayName string
    (Updatable) A human-friendly name for the project, that can be changed.
    FreeformTags map[string]string

    (Updatable) A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: {"bar-key": "value"}

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    LifecycleDetails string
    A message describing the current state in more detail, that can provide actionable information if creation failed.
    State string
    The current state of the project.
    SystemTags map[string]string
    Usage of system tag keys. These predefined keys are scoped to namespaces. For example: {"orcl-cloud": {"free-tier-retained": "true"}}
    TimeCreated string
    When the project was created, as an RFC3339 datetime string.
    TimeUpdated string
    When the project was updated, as an RFC3339 datetime string.
    compartmentId String
    (Updatable) The compartment identifier.
    definedTags Map<String,String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For example: {"foo-namespace": {"bar-key": "value"}}
    description String
    (Updatable) An optional description of the project.
    displayName String
    (Updatable) A human-friendly name for the project, that can be changed.
    freeformTags Map<String,String>

    (Updatable) A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: {"bar-key": "value"}

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    lifecycleDetails String
    A message describing the current state in more detail, that can provide actionable information if creation failed.
    state String
    The current state of the project.
    systemTags Map<String,String>
    Usage of system tag keys. These predefined keys are scoped to namespaces. For example: {"orcl-cloud": {"free-tier-retained": "true"}}
    timeCreated String
    When the project was created, as an RFC3339 datetime string.
    timeUpdated String
    When the project was updated, as an RFC3339 datetime string.
    compartmentId string
    (Updatable) The compartment identifier.
    definedTags {[key: string]: string}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For example: {"foo-namespace": {"bar-key": "value"}}
    description string
    (Updatable) An optional description of the project.
    displayName string
    (Updatable) A human-friendly name for the project, that can be changed.
    freeformTags {[key: string]: string}

    (Updatable) A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: {"bar-key": "value"}

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    lifecycleDetails string
    A message describing the current state in more detail, that can provide actionable information if creation failed.
    state string
    The current state of the project.
    systemTags {[key: string]: string}
    Usage of system tag keys. These predefined keys are scoped to namespaces. For example: {"orcl-cloud": {"free-tier-retained": "true"}}
    timeCreated string
    When the project was created, as an RFC3339 datetime string.
    timeUpdated string
    When the project was updated, as an RFC3339 datetime string.
    compartment_id str
    (Updatable) The compartment identifier.
    defined_tags Mapping[str, str]
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For example: {"foo-namespace": {"bar-key": "value"}}
    description str
    (Updatable) An optional description of the project.
    display_name str
    (Updatable) A human-friendly name for the project, that can be changed.
    freeform_tags Mapping[str, str]

    (Updatable) A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: {"bar-key": "value"}

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    lifecycle_details str
    A message describing the current state in more detail, that can provide actionable information if creation failed.
    state str
    The current state of the project.
    system_tags Mapping[str, str]
    Usage of system tag keys. These predefined keys are scoped to namespaces. For example: {"orcl-cloud": {"free-tier-retained": "true"}}
    time_created str
    When the project was created, as an RFC3339 datetime string.
    time_updated str
    When the project was updated, as an RFC3339 datetime string.
    compartmentId String
    (Updatable) The compartment identifier.
    definedTags Map<String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For example: {"foo-namespace": {"bar-key": "value"}}
    description String
    (Updatable) An optional description of the project.
    displayName String
    (Updatable) A human-friendly name for the project, that can be changed.
    freeformTags Map<String>

    (Updatable) A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: {"bar-key": "value"}

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    lifecycleDetails String
    A message describing the current state in more detail, that can provide actionable information if creation failed.
    state String
    The current state of the project.
    systemTags Map<String>
    Usage of system tag keys. These predefined keys are scoped to namespaces. For example: {"orcl-cloud": {"free-tier-retained": "true"}}
    timeCreated String
    When the project was created, as an RFC3339 datetime string.
    timeUpdated String
    When the project was updated, as an RFC3339 datetime string.

    Import

    Projects can be imported using the id, e.g.

    $ pulumi import oci:AiDocument/project:Project test_project "id"

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

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi
    pulumi/pulumi-oci