oci.AiLanguage.Project
Explore with Pulumi AI
This resource provides the Project resource in Oracle Cloud Infrastructure Ai Language service.
Creates a new Project.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testProject = new oci.ailanguage.Project("test_project", {
compartmentId: compartmentId,
definedTags: {
"foo-namespace.bar-key": "value",
},
description: projectDescription,
displayName: projectDisplayName,
freeformTags: {
"bar-key": "value",
},
});
import pulumi
import pulumi_oci as oci
test_project = oci.ai_language.Project("test_project",
compartment_id=compartment_id,
defined_tags={
"foo-namespace.bar-key": "value",
},
description=project_description,
display_name=project_display_name,
freeform_tags={
"bar-key": "value",
})
package main
import (
"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/AiLanguage"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := AiLanguage.NewProject(ctx, "test_project", &AiLanguage.ProjectArgs{
CompartmentId: pulumi.Any(compartmentId),
DefinedTags: pulumi.StringMap{
"foo-namespace.bar-key": pulumi.String("value"),
},
Description: pulumi.Any(projectDescription),
DisplayName: pulumi.Any(projectDisplayName),
FreeformTags: pulumi.StringMap{
"bar-key": pulumi.String("value"),
},
})
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.AiLanguage.Project("test_project", new()
{
CompartmentId = compartmentId,
DefinedTags =
{
{ "foo-namespace.bar-key", "value" },
},
Description = projectDescription,
DisplayName = projectDisplayName,
FreeformTags =
{
{ "bar-key", "value" },
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.AiLanguage.Project;
import com.pulumi.oci.AiLanguage.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(Map.of("foo-namespace.bar-key", "value"))
.description(projectDescription)
.displayName(projectDisplayName)
.freeformTags(Map.of("bar-key", "value"))
.build());
}
}
resources:
testProject:
type: oci:AiLanguage:Project
name: test_project
properties:
compartmentId: ${compartmentId}
definedTags:
foo-namespace.bar-key: value
description: ${projectDescription}
displayName: ${projectDisplayName}
freeformTags:
bar-key: value
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:AiLanguage: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 exampleprojectResourceResourceFromAiLanguageproject = new Oci.AiLanguage.Project("exampleprojectResourceResourceFromAiLanguageproject", new()
{
CompartmentId = "string",
DefinedTags =
{
{ "string", "string" },
},
Description = "string",
DisplayName = "string",
FreeformTags =
{
{ "string", "string" },
},
});
example, err := AiLanguage.NewProject(ctx, "exampleprojectResourceResourceFromAiLanguageproject", &AiLanguage.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 exampleprojectResourceResourceFromAiLanguageproject = new Project("exampleprojectResourceResourceFromAiLanguageproject", ProjectArgs.builder()
.compartmentId("string")
.definedTags(Map.of("string", "string"))
.description("string")
.displayName("string")
.freeformTags(Map.of("string", "string"))
.build());
exampleproject_resource_resource_from_ai_languageproject = oci.ai_language.Project("exampleprojectResourceResourceFromAiLanguageproject",
compartment_id="string",
defined_tags={
"string": "string",
},
description="string",
display_name="string",
freeform_tags={
"string": "string",
})
const exampleprojectResourceResourceFromAiLanguageproject = new oci.ailanguage.Project("exampleprojectResourceResourceFromAiLanguageproject", {
compartmentId: "string",
definedTags: {
string: "string",
},
description: "string",
displayName: "string",
freeformTags: {
string: "string",
},
});
type: oci:AiLanguage: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
The Project resource accepts the following input properties:
- Compartment
Id string - (Updatable) The OCID for the project's compartment.
- Dictionary<string, string>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- Description string
- (Updatable) A short description of the project.
- Display
Name string - (Updatable) A user-friendly display name for the resource. It does not have to be unique and can be modified. Avoid entering confidential information.
- Dictionary<string, string>
(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. 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 string - (Updatable) The OCID for the project's compartment.
- map[string]string
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- Description string
- (Updatable) A short description of the project.
- Display
Name string - (Updatable) A user-friendly display name for the resource. It does not have to be unique and can be modified. Avoid entering confidential information.
- map[string]string
(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. 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 String - (Updatable) The OCID for the project's compartment.
- Map<String,String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- description String
- (Updatable) A short description of the project.
- display
Name String - (Updatable) A user-friendly display name for the resource. It does not have to be unique and can be modified. Avoid entering confidential information.
- Map<String,String>
(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. 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 string - (Updatable) The OCID for the project's compartment.
- {[key: string]: string}
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- description string
- (Updatable) A short description of the project.
- display
Name string - (Updatable) A user-friendly display name for the resource. It does not have to be unique and can be modified. Avoid entering confidential information.
- {[key: string]: string}
(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. 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 OCID for the project's compartment.
- Mapping[str, str]
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- description str
- (Updatable) A short description of the project.
- display_
name str - (Updatable) A user-friendly display name for the resource. It does not have to be unique and can be modified. Avoid entering confidential information.
- Mapping[str, str]
(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. 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 String - (Updatable) The OCID for the project's compartment.
- Map<String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- description String
- (Updatable) A short description of the project.
- display
Name String - (Updatable) A user-friendly display name for the resource. It does not have to be unique and can be modified. Avoid entering confidential information.
- Map<String>
(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. 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.
- Lifecycle
Details string - A message describing the current state in more detail.
- State string
- The state of the project.
- Dictionary<string, string>
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"}
- Time
Created string - The date and time the resource was created in the timestamp format defined by RFC3339.
- Time
Updated string - The date and time the resource was updated in the timestamp format defined by RFC3339.
- Id string
- The provider-assigned unique ID for this managed resource.
- Lifecycle
Details string - A message describing the current state in more detail.
- State string
- The state of the project.
- map[string]string
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"}
- Time
Created string - The date and time the resource was created in the timestamp format defined by RFC3339.
- Time
Updated string - The date and time the resource was updated in the timestamp format defined by RFC3339.
- id String
- The provider-assigned unique ID for this managed resource.
- lifecycle
Details String - A message describing the current state in more detail.
- state String
- The state of the project.
- Map<String,String>
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"}
- time
Created String - The date and time the resource was created in the timestamp format defined by RFC3339.
- time
Updated String - The date and time the resource was updated in the timestamp format defined by RFC3339.
- id string
- The provider-assigned unique ID for this managed resource.
- lifecycle
Details string - A message describing the current state in more detail.
- state string
- The state of the project.
- {[key: string]: string}
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"}
- time
Created string - The date and time the resource was created in the timestamp format defined by RFC3339.
- time
Updated string - The date and time the resource was updated in the timestamp format defined by RFC3339.
- id str
- The provider-assigned unique ID for this managed resource.
- lifecycle_
details str - A message describing the current state in more detail.
- state str
- The state of the project.
- Mapping[str, str]
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"}
- time_
created str - The date and time the resource was created in the timestamp format defined by RFC3339.
- time_
updated str - The date and time the resource was updated in the timestamp format defined by RFC3339.
- id String
- The provider-assigned unique ID for this managed resource.
- lifecycle
Details String - A message describing the current state in more detail.
- state String
- The state of the project.
- Map<String>
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"}
- time
Created String - The date and time the resource was created in the timestamp format defined by RFC3339.
- time
Updated String - The date and time the resource was updated in the timestamp format defined by RFC3339.
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.
- Compartment
Id string - (Updatable) The OCID for the project's compartment.
- Dictionary<string, string>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- Description string
- (Updatable) A short description of the project.
- Display
Name string - (Updatable) A user-friendly display name for the resource. It does not have to be unique and can be modified. Avoid entering confidential information.
- Dictionary<string, string>
(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. 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 string - A message describing the current state in more detail.
- State string
- The state of the project.
- Dictionary<string, string>
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"}
- Time
Created string - The date and time the resource was created in the timestamp format defined by RFC3339.
- Time
Updated string - The date and time the resource was updated in the timestamp format defined by RFC3339.
- Compartment
Id string - (Updatable) The OCID for the project's compartment.
- map[string]string
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- Description string
- (Updatable) A short description of the project.
- Display
Name string - (Updatable) A user-friendly display name for the resource. It does not have to be unique and can be modified. Avoid entering confidential information.
- map[string]string
(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. 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 string - A message describing the current state in more detail.
- State string
- The state of the project.
- map[string]string
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"}
- Time
Created string - The date and time the resource was created in the timestamp format defined by RFC3339.
- Time
Updated string - The date and time the resource was updated in the timestamp format defined by RFC3339.
- compartment
Id String - (Updatable) The OCID for the project's compartment.
- Map<String,String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- description String
- (Updatable) A short description of the project.
- display
Name String - (Updatable) A user-friendly display name for the resource. It does not have to be unique and can be modified. Avoid entering confidential information.
- Map<String,String>
(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. 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 String - A message describing the current state in more detail.
- state String
- The state of the project.
- Map<String,String>
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"}
- time
Created String - The date and time the resource was created in the timestamp format defined by RFC3339.
- time
Updated String - The date and time the resource was updated in the timestamp format defined by RFC3339.
- compartment
Id string - (Updatable) The OCID for the project's compartment.
- {[key: string]: string}
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- description string
- (Updatable) A short description of the project.
- display
Name string - (Updatable) A user-friendly display name for the resource. It does not have to be unique and can be modified. Avoid entering confidential information.
- {[key: string]: string}
(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. 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 string - A message describing the current state in more detail.
- state string
- The state of the project.
- {[key: string]: string}
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"}
- time
Created string - The date and time the resource was created in the timestamp format defined by RFC3339.
- time
Updated string - The date and time the resource was updated in the timestamp format defined by RFC3339.
- compartment_
id str - (Updatable) The OCID for the project's compartment.
- Mapping[str, str]
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- description str
- (Updatable) A short description of the project.
- display_
name str - (Updatable) A user-friendly display name for the resource. It does not have to be unique and can be modified. Avoid entering confidential information.
- Mapping[str, str]
(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. 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.
- state str
- The state of the project.
- Mapping[str, str]
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"}
- time_
created str - The date and time the resource was created in the timestamp format defined by RFC3339.
- time_
updated str - The date and time the resource was updated in the timestamp format defined by RFC3339.
- compartment
Id String - (Updatable) The OCID for the project's compartment.
- Map<String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- description String
- (Updatable) A short description of the project.
- display
Name String - (Updatable) A user-friendly display name for the resource. It does not have to be unique and can be modified. Avoid entering confidential information.
- Map<String>
(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. 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 String - A message describing the current state in more detail.
- state String
- The state of the project.
- Map<String>
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"}
- time
Created String - The date and time the resource was created in the timestamp format defined by RFC3339.
- time
Updated String - The date and time the resource was updated in the timestamp format defined by RFC3339.
Import
Projects can be imported using the id
, e.g.
$ pulumi import oci:AiLanguage/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.