1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. oci
  5. ApiPlatformApiPlatformInstance
Oracle Cloud Infrastructure v3.9.0 published on Wednesday, Sep 24, 2025 by Pulumi
pulumi/pulumi-oci

oci.oci.ApiPlatformApiPlatformInstance

Deploy with Pulumi
oci logo
Oracle Cloud Infrastructure v3.9.0 published on Wednesday, Sep 24, 2025 by Pulumi
pulumi/pulumi-oci

    This resource provides the Api Platform Instance resource in Oracle Cloud Infrastructure Api Platform service.

    Creates an API Platform Instance

    Example Usage

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

const testApiPlatformInstance = new oci.oci.ApiPlatformApiPlatformInstance("test_api_platform_instance", {
    compartmentId: compartmentId,
    name: apiPlatformInstanceName,
    definedTags: {
        "foo-namespace.bar-key": "value",
    },
    description: apiPlatformInstanceDescription,
    freeformTags: {
        "bar-key": "value",
    },
});

    import pulumi
import pulumi_oci as oci

test_api_platform_instance = oci.oci.ApiPlatformApiPlatformInstance("test_api_platform_instance",
    compartment_id=compartment_id,
    name=api_platform_instance_name,
    defined_tags={
        "foo-namespace.bar-key": "value",
    },
    description=api_platform_instance_description,
    freeform_tags={
        "bar-key": "value",
    })

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := oci.NewApiPlatformApiPlatformInstance(ctx, "test_api_platform_instance", &oci.ApiPlatformApiPlatformInstanceArgs{
			CompartmentId: pulumi.Any(compartmentId),
			Name:          pulumi.Any(apiPlatformInstanceName),
			DefinedTags: pulumi.StringMap{
				"foo-namespace.bar-key": pulumi.String("value"),
			},
			Description: pulumi.Any(apiPlatformInstanceDescription),
			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 testApiPlatformInstance = new Oci.Oci.ApiPlatformApiPlatformInstance("test_api_platform_instance", new()
    {
        CompartmentId = compartmentId,
        Name = apiPlatformInstanceName,
        DefinedTags = 
        {
            { "foo-namespace.bar-key", "value" },
        },
        Description = apiPlatformInstanceDescription,
        FreeformTags = 
        {
            { "bar-key", "value" },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.oci.ApiPlatformApiPlatformInstance;
import com.pulumi.oci.oci.ApiPlatformApiPlatformInstanceArgs;
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 testApiPlatformInstance = new ApiPlatformApiPlatformInstance("testApiPlatformInstance", ApiPlatformApiPlatformInstanceArgs.builder()
            .compartmentId(compartmentId)
            .name(apiPlatformInstanceName)
            .definedTags(Map.of("foo-namespace.bar-key", "value"))
            .description(apiPlatformInstanceDescription)
            .freeformTags(Map.of("bar-key", "value"))
            .build());

    }
}

    resources:
  testApiPlatformInstance:
    type: oci:oci:ApiPlatformApiPlatformInstance
    name: test_api_platform_instance
    properties:
      compartmentId: ${compartmentId}
      name: ${apiPlatformInstanceName}
      definedTags:
        foo-namespace.bar-key: value
      description: ${apiPlatformInstanceDescription}
      freeformTags:
        bar-key: value

    Create ApiPlatformApiPlatformInstance Resource

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

    Constructor syntax

    new ApiPlatformApiPlatformInstance(name: string, args: ApiPlatformApiPlatformInstanceArgs, opts?: CustomResourceOptions);
    @overload
def ApiPlatformApiPlatformInstance(resource_name: str,
                                   args: ApiPlatformApiPlatformInstanceArgs,
                                   opts: Optional[ResourceOptions] = None)

@overload
def ApiPlatformApiPlatformInstance(resource_name: str,
                                   opts: Optional[ResourceOptions] = None,
                                   compartment_id: Optional[str] = None,
                                   defined_tags: Optional[Mapping[str, str]] = None,
                                   description: Optional[str] = None,
                                   freeform_tags: Optional[Mapping[str, str]] = None,
                                   name: Optional[str] = None)
    func NewApiPlatformApiPlatformInstance(ctx *Context, name string, args ApiPlatformApiPlatformInstanceArgs, opts ...ResourceOption) (*ApiPlatformApiPlatformInstance, error)
    public ApiPlatformApiPlatformInstance(string name, ApiPlatformApiPlatformInstanceArgs args, CustomResourceOptions? opts = null)
    public ApiPlatformApiPlatformInstance(String name, ApiPlatformApiPlatformInstanceArgs args)
public ApiPlatformApiPlatformInstance(String name, ApiPlatformApiPlatformInstanceArgs args, CustomResourceOptions options)

    type: oci:oci:ApiPlatformApiPlatformInstance
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 ApiPlatformApiPlatformInstanceArgs
    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 ApiPlatformApiPlatformInstanceArgs
    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 ApiPlatformApiPlatformInstanceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ApiPlatformApiPlatformInstanceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ApiPlatformApiPlatformInstanceArgs
    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 apiPlatformApiPlatformInstanceResource = new Oci.Oci.ApiPlatformApiPlatformInstance("apiPlatformApiPlatformInstanceResource", new()
{
    CompartmentId = "string",
    DefinedTags = 
    {
        { "string", "string" },
    },
    Description = "string",
    FreeformTags = 
    {
        { "string", "string" },
    },
    Name = "string",
});

    example, err := oci.NewApiPlatformApiPlatformInstance(ctx, "apiPlatformApiPlatformInstanceResource", &oci.ApiPlatformApiPlatformInstanceArgs{
	CompartmentId: pulumi.String("string"),
	DefinedTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Description: pulumi.String("string"),
	FreeformTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Name: pulumi.String("string"),
})

    var apiPlatformApiPlatformInstanceResource = new ApiPlatformApiPlatformInstance("apiPlatformApiPlatformInstanceResource", ApiPlatformApiPlatformInstanceArgs.builder()
    .compartmentId("string")
    .definedTags(Map.of("string", "string"))
    .description("string")
    .freeformTags(Map.of("string", "string"))
    .name("string")
    .build());

    api_platform_api_platform_instance_resource = oci.oci.ApiPlatformApiPlatformInstance("apiPlatformApiPlatformInstanceResource",
    compartment_id="string",
    defined_tags={
        "string": "string",
    },
    description="string",
    freeform_tags={
        "string": "string",
    },
    name="string")

    const apiPlatformApiPlatformInstanceResource = new oci.oci.ApiPlatformApiPlatformInstance("apiPlatformApiPlatformInstanceResource", {
    compartmentId: "string",
    definedTags: {
        string: "string",
    },
    description: "string",
    freeformTags: {
        string: "string",
    },
    name: "string",
});

    type: oci:oci:ApiPlatformApiPlatformInstance
properties:
    compartmentId: string
    definedTags:
        string: string
    description: string
    freeformTags:
        string: string
    name: string

    ApiPlatformApiPlatformInstance 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 ApiPlatformApiPlatformInstance resource accepts the following input properties:

    CompartmentId string
    (Updatable) The OCID of the compartment to create the instance in.
    DefinedTags 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) User-provided changeable and non-unique description of the instance
    FreeformTags 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"}
    Name string

    A regionally unique, non-changeable instance name provided by the user during creation

    ** 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 OCID of the compartment to create the instance in.
    DefinedTags 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) User-provided changeable and non-unique description of the instance
    FreeformTags 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"}
    Name string

    A regionally unique, non-changeable instance name provided by the user during creation

    ** 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 OCID of the compartment to create the instance in.
    definedTags 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) User-provided changeable and non-unique description of the instance
    freeformTags 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"}
    name String

    A regionally unique, non-changeable instance name provided by the user during creation

    ** 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 OCID of the compartment to create the instance in.
    definedTags {[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) User-provided changeable and non-unique description of the instance
    freeformTags {[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"}
    name string

    A regionally unique, non-changeable instance name provided by the user during creation

    ** 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 of the compartment to create the instance in.
    defined_tags 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) User-provided changeable and non-unique description of the instance
    freeform_tags 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"}
    name str

    A regionally unique, non-changeable instance name provided by the user during creation

    ** 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 OCID of the compartment to create the instance in.
    definedTags 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) User-provided changeable and non-unique description of the instance
    freeformTags 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"}
    name String

    A regionally unique, non-changeable instance name provided by the user during creation

    ** 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 ApiPlatformApiPlatformInstance resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    IdcsApps List<ApiPlatformApiPlatformInstanceIdcsApp>
    IDCS app associated with the instance, that can be used to manage the roles of the users
    LifecycleDetails string
    A message that describes the current state of the instance in more detail. For example, can be used to provide actionable information for a resource in the Failed state
    State string
    The current state of the instance
    SystemTags Dictionary<string, string>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The date and time the instance was created, in the format defined by RFC 3339 Example: 2016-08-25T21:10:29.600Z
    TimeUpdated string
    The date and time the instance was updated, in the format defined by RFC 3339 Example: 2016-08-25T21:10:29.600Z
    Uris List<ApiPlatformApiPlatformInstanceUri>
    Service URIs pertaining to the instance
    Id string
    The provider-assigned unique ID for this managed resource.
    IdcsApps []ApiPlatformApiPlatformInstanceIdcsApp
    IDCS app associated with the instance, that can be used to manage the roles of the users
    LifecycleDetails string
    A message that describes the current state of the instance in more detail. For example, can be used to provide actionable information for a resource in the Failed state
    State string
    The current state of the instance
    SystemTags map[string]string
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The date and time the instance was created, in the format defined by RFC 3339 Example: 2016-08-25T21:10:29.600Z
    TimeUpdated string
    The date and time the instance was updated, in the format defined by RFC 3339 Example: 2016-08-25T21:10:29.600Z
    Uris []ApiPlatformApiPlatformInstanceUri
    Service URIs pertaining to the instance
    id String
    The provider-assigned unique ID for this managed resource.
    idcsApps List<ApiPlatformApiPlatformInstanceIdcsApp>
    IDCS app associated with the instance, that can be used to manage the roles of the users
    lifecycleDetails String
    A message that describes the current state of the instance in more detail. For example, can be used to provide actionable information for a resource in the Failed state
    state String
    The current state of the instance
    systemTags Map<String,String>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The date and time the instance was created, in the format defined by RFC 3339 Example: 2016-08-25T21:10:29.600Z
    timeUpdated String
    The date and time the instance was updated, in the format defined by RFC 3339 Example: 2016-08-25T21:10:29.600Z
    uris List<ApiPlatformApiPlatformInstanceUri>
    Service URIs pertaining to the instance
    id string
    The provider-assigned unique ID for this managed resource.
    idcsApps ApiPlatformApiPlatformInstanceIdcsApp[]
    IDCS app associated with the instance, that can be used to manage the roles of the users
    lifecycleDetails string
    A message that describes the current state of the instance in more detail. For example, can be used to provide actionable information for a resource in the Failed state
    state string
    The current state of the instance
    systemTags {[key: string]: string}
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated string
    The date and time the instance was created, in the format defined by RFC 3339 Example: 2016-08-25T21:10:29.600Z
    timeUpdated string
    The date and time the instance was updated, in the format defined by RFC 3339 Example: 2016-08-25T21:10:29.600Z
    uris ApiPlatformApiPlatformInstanceUri[]
    Service URIs pertaining to the instance
    id str
    The provider-assigned unique ID for this managed resource.
    idcs_apps Sequence[ApiPlatformApiPlatformInstanceIdcsApp]
    IDCS app associated with the instance, that can be used to manage the roles of the users
    lifecycle_details str
    A message that describes the current state of the instance in more detail. For example, can be used to provide actionable information for a resource in the Failed state
    state str
    The current state of the instance
    system_tags Mapping[str, str]
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    time_created str
    The date and time the instance was created, in the format defined by RFC 3339 Example: 2016-08-25T21:10:29.600Z
    time_updated str
    The date and time the instance was updated, in the format defined by RFC 3339 Example: 2016-08-25T21:10:29.600Z
    uris Sequence[ApiPlatformApiPlatformInstanceUri]
    Service URIs pertaining to the instance
    id String
    The provider-assigned unique ID for this managed resource.
    idcsApps List<Property Map>
    IDCS app associated with the instance, that can be used to manage the roles of the users
    lifecycleDetails String
    A message that describes the current state of the instance in more detail. For example, can be used to provide actionable information for a resource in the Failed state
    state String
    The current state of the instance
    systemTags Map<String>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The date and time the instance was created, in the format defined by RFC 3339 Example: 2016-08-25T21:10:29.600Z
    timeUpdated String
    The date and time the instance was updated, in the format defined by RFC 3339 Example: 2016-08-25T21:10:29.600Z
    uris List<Property Map>
    Service URIs pertaining to the instance

    Look up Existing ApiPlatformApiPlatformInstance Resource

    Get an existing ApiPlatformApiPlatformInstance 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?: ApiPlatformApiPlatformInstanceState, opts?: CustomResourceOptions): ApiPlatformApiPlatformInstance
    @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,
        freeform_tags: Optional[Mapping[str, str]] = None,
        idcs_apps: Optional[Sequence[ApiPlatformApiPlatformInstanceIdcsAppArgs]] = None,
        lifecycle_details: Optional[str] = None,
        name: Optional[str] = None,
        state: Optional[str] = None,
        system_tags: Optional[Mapping[str, str]] = None,
        time_created: Optional[str] = None,
        time_updated: Optional[str] = None,
        uris: Optional[Sequence[ApiPlatformApiPlatformInstanceUriArgs]] = None) -> ApiPlatformApiPlatformInstance
    func GetApiPlatformApiPlatformInstance(ctx *Context, name string, id IDInput, state *ApiPlatformApiPlatformInstanceState, opts ...ResourceOption) (*ApiPlatformApiPlatformInstance, error)
    public static ApiPlatformApiPlatformInstance Get(string name, Input<string> id, ApiPlatformApiPlatformInstanceState? state, CustomResourceOptions? opts = null)
    public static ApiPlatformApiPlatformInstance get(String name, Output<String> id, ApiPlatformApiPlatformInstanceState state, CustomResourceOptions options)
    resources:  _:    type: oci:oci:ApiPlatformApiPlatformInstance    get:      id: ${id}
    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 OCID of the compartment to create the instance in.
    DefinedTags 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) User-provided changeable and non-unique description of the instance
    FreeformTags 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"}
    IdcsApps List<ApiPlatformApiPlatformInstanceIdcsApp>
    IDCS app associated with the instance, that can be used to manage the roles of the users
    LifecycleDetails string
    A message that describes the current state of the instance in more detail. For example, can be used to provide actionable information for a resource in the Failed state
    Name string

    A regionally unique, non-changeable instance name provided by the user during creation

    ** 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

    State string
    The current state of the instance
    SystemTags Dictionary<string, string>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The date and time the instance was created, in the format defined by RFC 3339 Example: 2016-08-25T21:10:29.600Z
    TimeUpdated string
    The date and time the instance was updated, in the format defined by RFC 3339 Example: 2016-08-25T21:10:29.600Z
    Uris List<ApiPlatformApiPlatformInstanceUri>
    Service URIs pertaining to the instance
    CompartmentId string
    (Updatable) The OCID of the compartment to create the instance in.
    DefinedTags 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) User-provided changeable and non-unique description of the instance
    FreeformTags 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"}
    IdcsApps []ApiPlatformApiPlatformInstanceIdcsAppArgs
    IDCS app associated with the instance, that can be used to manage the roles of the users
    LifecycleDetails string
    A message that describes the current state of the instance in more detail. For example, can be used to provide actionable information for a resource in the Failed state
    Name string

    A regionally unique, non-changeable instance name provided by the user during creation

    ** 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

    State string
    The current state of the instance
    SystemTags map[string]string
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The date and time the instance was created, in the format defined by RFC 3339 Example: 2016-08-25T21:10:29.600Z
    TimeUpdated string
    The date and time the instance was updated, in the format defined by RFC 3339 Example: 2016-08-25T21:10:29.600Z
    Uris []ApiPlatformApiPlatformInstanceUriArgs
    Service URIs pertaining to the instance
    compartmentId String
    (Updatable) The OCID of the compartment to create the instance in.
    definedTags 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) User-provided changeable and non-unique description of the instance
    freeformTags 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"}
    idcsApps List<ApiPlatformApiPlatformInstanceIdcsApp>
    IDCS app associated with the instance, that can be used to manage the roles of the users
    lifecycleDetails String
    A message that describes the current state of the instance in more detail. For example, can be used to provide actionable information for a resource in the Failed state
    name String

    A regionally unique, non-changeable instance name provided by the user during creation

    ** 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

    state String
    The current state of the instance
    systemTags Map<String,String>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The date and time the instance was created, in the format defined by RFC 3339 Example: 2016-08-25T21:10:29.600Z
    timeUpdated String
    The date and time the instance was updated, in the format defined by RFC 3339 Example: 2016-08-25T21:10:29.600Z
    uris List<ApiPlatformApiPlatformInstanceUri>
    Service URIs pertaining to the instance
    compartmentId string
    (Updatable) The OCID of the compartment to create the instance in.
    definedTags {[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) User-provided changeable and non-unique description of the instance
    freeformTags {[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"}
    idcsApps ApiPlatformApiPlatformInstanceIdcsApp[]
    IDCS app associated with the instance, that can be used to manage the roles of the users
    lifecycleDetails string
    A message that describes the current state of the instance in more detail. For example, can be used to provide actionable information for a resource in the Failed state
    name string

    A regionally unique, non-changeable instance name provided by the user during creation

    ** 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

    state string
    The current state of the instance
    systemTags {[key: string]: string}
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated string
    The date and time the instance was created, in the format defined by RFC 3339 Example: 2016-08-25T21:10:29.600Z
    timeUpdated string
    The date and time the instance was updated, in the format defined by RFC 3339 Example: 2016-08-25T21:10:29.600Z
    uris ApiPlatformApiPlatformInstanceUri[]
    Service URIs pertaining to the instance
    compartment_id str
    (Updatable) The OCID of the compartment to create the instance in.
    defined_tags 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) User-provided changeable and non-unique description of the instance
    freeform_tags 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"}
    idcs_apps Sequence[ApiPlatformApiPlatformInstanceIdcsAppArgs]
    IDCS app associated with the instance, that can be used to manage the roles of the users
    lifecycle_details str
    A message that describes the current state of the instance in more detail. For example, can be used to provide actionable information for a resource in the Failed state
    name str

    A regionally unique, non-changeable instance name provided by the user during creation

    ** 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

    state str
    The current state of the instance
    system_tags Mapping[str, str]
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    time_created str
    The date and time the instance was created, in the format defined by RFC 3339 Example: 2016-08-25T21:10:29.600Z
    time_updated str
    The date and time the instance was updated, in the format defined by RFC 3339 Example: 2016-08-25T21:10:29.600Z
    uris Sequence[ApiPlatformApiPlatformInstanceUriArgs]
    Service URIs pertaining to the instance
    compartmentId String
    (Updatable) The OCID of the compartment to create the instance in.
    definedTags 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) User-provided changeable and non-unique description of the instance
    freeformTags 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"}
    idcsApps List<Property Map>
    IDCS app associated with the instance, that can be used to manage the roles of the users
    lifecycleDetails String
    A message that describes the current state of the instance in more detail. For example, can be used to provide actionable information for a resource in the Failed state
    name String

    A regionally unique, non-changeable instance name provided by the user during creation

    ** 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

    state String
    The current state of the instance
    systemTags Map<String>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The date and time the instance was created, in the format defined by RFC 3339 Example: 2016-08-25T21:10:29.600Z
    timeUpdated String
    The date and time the instance was updated, in the format defined by RFC 3339 Example: 2016-08-25T21:10:29.600Z
    uris List<Property Map>
    Service URIs pertaining to the instance

    Supporting Types

    ApiPlatformApiPlatformInstanceIdcsApp, ApiPlatformApiPlatformInstanceIdcsAppArgs

    Url string
    IDCS URL of the app
    Url string
    IDCS URL of the app
    url String
    IDCS URL of the app
    url string
    IDCS URL of the app
    url str
    IDCS URL of the app
    url String
    IDCS URL of the app

    ApiPlatformApiPlatformInstanceUri, ApiPlatformApiPlatformInstanceUriArgs

    DevelopersPortalUri string
    Developer's Portal URI of the instance (/developers)
    ManagementPortalUri string
    Management Portal URI of the instance (/apiplatform)
    DevelopersPortalUri string
    Developer's Portal URI of the instance (/developers)
    ManagementPortalUri string
    Management Portal URI of the instance (/apiplatform)
    developersPortalUri String
    Developer's Portal URI of the instance (/developers)
    managementPortalUri String
    Management Portal URI of the instance (/apiplatform)
    developersPortalUri string
    Developer's Portal URI of the instance (/developers)
    managementPortalUri string
    Management Portal URI of the instance (/apiplatform)
    developers_portal_uri str
    Developer's Portal URI of the instance (/developers)
    management_portal_uri str
    Management Portal URI of the instance (/apiplatform)
    developersPortalUri String
    Developer's Portal URI of the instance (/developers)
    managementPortalUri String
    Management Portal URI of the instance (/apiplatform)

    Import

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

    $ pulumi import oci:oci/apiPlatformApiPlatformInstance:ApiPlatformApiPlatformInstance test_api_platform_instance "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 v3.9.0 published on Wednesday, Sep 24, 2025 by Pulumi
    pulumi/pulumi-oci
      Meet Neo: Your AI Platform Teammate