oci.Oce.Instance
Explore with Pulumi AI
This resource provides the Oce Instance resource in Oracle Cloud Infrastructure Content and Experience service.
Creates a new OceInstance.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testOceInstance = new oci.oce.Instance("test_oce_instance", {
    adminEmail: oceInstanceAdminEmail,
    compartmentId: compartmentId,
    idcsAccessToken: oceInstanceIdcsAccessToken,
    name: oceInstanceName,
    objectStorageNamespace: oceInstanceObjectStorageNamespace,
    tenancyId: testTenancy.id,
    tenancyName: testTenancy.name,
    addOnFeatures: oceInstanceAddOnFeatures,
    definedTags: {
        "foo-namespace.bar-key": "value",
    },
    description: oceInstanceDescription,
    drRegion: oceInstanceDrRegion,
    freeformTags: {
        "bar-key": "value",
    },
    instanceAccessType: oceInstanceInstanceAccessType,
    instanceLicenseType: oceInstanceInstanceLicenseType,
    instanceUsageType: oceInstanceInstanceUsageType,
    upgradeSchedule: oceInstanceUpgradeSchedule,
    wafPrimaryDomain: oceInstanceWafPrimaryDomain,
});
import pulumi
import pulumi_oci as oci
test_oce_instance = oci.oce.Instance("test_oce_instance",
    admin_email=oce_instance_admin_email,
    compartment_id=compartment_id,
    idcs_access_token=oce_instance_idcs_access_token,
    name=oce_instance_name,
    object_storage_namespace=oce_instance_object_storage_namespace,
    tenancy_id=test_tenancy["id"],
    tenancy_name=test_tenancy["name"],
    add_on_features=oce_instance_add_on_features,
    defined_tags={
        "foo-namespace.bar-key": "value",
    },
    description=oce_instance_description,
    dr_region=oce_instance_dr_region,
    freeform_tags={
        "bar-key": "value",
    },
    instance_access_type=oce_instance_instance_access_type,
    instance_license_type=oce_instance_instance_license_type,
    instance_usage_type=oce_instance_instance_usage_type,
    upgrade_schedule=oce_instance_upgrade_schedule,
    waf_primary_domain=oce_instance_waf_primary_domain)
package main
import (
	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/oce"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := oce.NewInstance(ctx, "test_oce_instance", &oce.InstanceArgs{
			AdminEmail:             pulumi.Any(oceInstanceAdminEmail),
			CompartmentId:          pulumi.Any(compartmentId),
			IdcsAccessToken:        pulumi.Any(oceInstanceIdcsAccessToken),
			Name:                   pulumi.Any(oceInstanceName),
			ObjectStorageNamespace: pulumi.Any(oceInstanceObjectStorageNamespace),
			TenancyId:              pulumi.Any(testTenancy.Id),
			TenancyName:            pulumi.Any(testTenancy.Name),
			AddOnFeatures:          pulumi.Any(oceInstanceAddOnFeatures),
			DefinedTags: pulumi.StringMap{
				"foo-namespace.bar-key": pulumi.String("value"),
			},
			Description: pulumi.Any(oceInstanceDescription),
			DrRegion:    pulumi.Any(oceInstanceDrRegion),
			FreeformTags: pulumi.StringMap{
				"bar-key": pulumi.String("value"),
			},
			InstanceAccessType:  pulumi.Any(oceInstanceInstanceAccessType),
			InstanceLicenseType: pulumi.Any(oceInstanceInstanceLicenseType),
			InstanceUsageType:   pulumi.Any(oceInstanceInstanceUsageType),
			UpgradeSchedule:     pulumi.Any(oceInstanceUpgradeSchedule),
			WafPrimaryDomain:    pulumi.Any(oceInstanceWafPrimaryDomain),
		})
		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 testOceInstance = new Oci.Oce.Instance("test_oce_instance", new()
    {
        AdminEmail = oceInstanceAdminEmail,
        CompartmentId = compartmentId,
        IdcsAccessToken = oceInstanceIdcsAccessToken,
        Name = oceInstanceName,
        ObjectStorageNamespace = oceInstanceObjectStorageNamespace,
        TenancyId = testTenancy.Id,
        TenancyName = testTenancy.Name,
        AddOnFeatures = oceInstanceAddOnFeatures,
        DefinedTags = 
        {
            { "foo-namespace.bar-key", "value" },
        },
        Description = oceInstanceDescription,
        DrRegion = oceInstanceDrRegion,
        FreeformTags = 
        {
            { "bar-key", "value" },
        },
        InstanceAccessType = oceInstanceInstanceAccessType,
        InstanceLicenseType = oceInstanceInstanceLicenseType,
        InstanceUsageType = oceInstanceInstanceUsageType,
        UpgradeSchedule = oceInstanceUpgradeSchedule,
        WafPrimaryDomain = oceInstanceWafPrimaryDomain,
    });
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Oce.Instance;
import com.pulumi.oci.Oce.InstanceArgs;
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 testOceInstance = new Instance("testOceInstance", InstanceArgs.builder()
            .adminEmail(oceInstanceAdminEmail)
            .compartmentId(compartmentId)
            .idcsAccessToken(oceInstanceIdcsAccessToken)
            .name(oceInstanceName)
            .objectStorageNamespace(oceInstanceObjectStorageNamespace)
            .tenancyId(testTenancy.id())
            .tenancyName(testTenancy.name())
            .addOnFeatures(oceInstanceAddOnFeatures)
            .definedTags(Map.of("foo-namespace.bar-key", "value"))
            .description(oceInstanceDescription)
            .drRegion(oceInstanceDrRegion)
            .freeformTags(Map.of("bar-key", "value"))
            .instanceAccessType(oceInstanceInstanceAccessType)
            .instanceLicenseType(oceInstanceInstanceLicenseType)
            .instanceUsageType(oceInstanceInstanceUsageType)
            .upgradeSchedule(oceInstanceUpgradeSchedule)
            .wafPrimaryDomain(oceInstanceWafPrimaryDomain)
            .build());
    }
}
resources:
  testOceInstance:
    type: oci:Oce:Instance
    name: test_oce_instance
    properties:
      adminEmail: ${oceInstanceAdminEmail}
      compartmentId: ${compartmentId}
      idcsAccessToken: ${oceInstanceIdcsAccessToken}
      name: ${oceInstanceName}
      objectStorageNamespace: ${oceInstanceObjectStorageNamespace}
      tenancyId: ${testTenancy.id}
      tenancyName: ${testTenancy.name}
      addOnFeatures: ${oceInstanceAddOnFeatures}
      definedTags:
        foo-namespace.bar-key: value
      description: ${oceInstanceDescription}
      drRegion: ${oceInstanceDrRegion}
      freeformTags:
        bar-key: value
      instanceAccessType: ${oceInstanceInstanceAccessType}
      instanceLicenseType: ${oceInstanceInstanceLicenseType}
      instanceUsageType: ${oceInstanceInstanceUsageType}
      upgradeSchedule: ${oceInstanceUpgradeSchedule}
      wafPrimaryDomain: ${oceInstanceWafPrimaryDomain}
Create Instance Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Instance(name: string, args: InstanceArgs, opts?: CustomResourceOptions);@overload
def Instance(resource_name: str,
             args: InstanceArgs,
             opts: Optional[ResourceOptions] = None)
@overload
def Instance(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             idcs_access_token: Optional[str] = None,
             admin_email: Optional[str] = None,
             compartment_id: Optional[str] = None,
             tenancy_name: Optional[str] = None,
             tenancy_id: Optional[str] = None,
             object_storage_namespace: Optional[str] = None,
             description: Optional[str] = None,
             freeform_tags: Optional[Mapping[str, str]] = None,
             instance_access_type: Optional[str] = None,
             instance_license_type: Optional[str] = None,
             instance_usage_type: Optional[str] = None,
             name: Optional[str] = None,
             dr_region: Optional[str] = None,
             add_on_features: Optional[Sequence[str]] = None,
             defined_tags: Optional[Mapping[str, str]] = None,
             upgrade_schedule: Optional[str] = None,
             waf_primary_domain: Optional[str] = None)func NewInstance(ctx *Context, name string, args InstanceArgs, opts ...ResourceOption) (*Instance, error)public Instance(string name, InstanceArgs args, CustomResourceOptions? opts = null)
public Instance(String name, InstanceArgs args)
public Instance(String name, InstanceArgs args, CustomResourceOptions options)
type: oci:Oce:Instance
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 InstanceArgs
- 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 InstanceArgs
- 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 InstanceArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args InstanceArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args InstanceArgs
- 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 ociInstanceResource = new Oci.Oce.Instance("ociInstanceResource", new()
{
    IdcsAccessToken = "string",
    AdminEmail = "string",
    CompartmentId = "string",
    TenancyName = "string",
    TenancyId = "string",
    ObjectStorageNamespace = "string",
    Description = "string",
    FreeformTags = 
    {
        { "string", "string" },
    },
    InstanceAccessType = "string",
    InstanceLicenseType = "string",
    InstanceUsageType = "string",
    Name = "string",
    DrRegion = "string",
    AddOnFeatures = new[]
    {
        "string",
    },
    DefinedTags = 
    {
        { "string", "string" },
    },
    UpgradeSchedule = "string",
    WafPrimaryDomain = "string",
});
example, err := oce.NewInstance(ctx, "ociInstanceResource", &oce.InstanceArgs{
	IdcsAccessToken:        pulumi.String("string"),
	AdminEmail:             pulumi.String("string"),
	CompartmentId:          pulumi.String("string"),
	TenancyName:            pulumi.String("string"),
	TenancyId:              pulumi.String("string"),
	ObjectStorageNamespace: pulumi.String("string"),
	Description:            pulumi.String("string"),
	FreeformTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	InstanceAccessType:  pulumi.String("string"),
	InstanceLicenseType: pulumi.String("string"),
	InstanceUsageType:   pulumi.String("string"),
	Name:                pulumi.String("string"),
	DrRegion:            pulumi.String("string"),
	AddOnFeatures: pulumi.StringArray{
		pulumi.String("string"),
	},
	DefinedTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	UpgradeSchedule:  pulumi.String("string"),
	WafPrimaryDomain: pulumi.String("string"),
})
var ociInstanceResource = new com.pulumi.oci.Oce.Instance("ociInstanceResource", com.pulumi.oci.Oce.InstanceArgs.builder()
    .idcsAccessToken("string")
    .adminEmail("string")
    .compartmentId("string")
    .tenancyName("string")
    .tenancyId("string")
    .objectStorageNamespace("string")
    .description("string")
    .freeformTags(Map.of("string", "string"))
    .instanceAccessType("string")
    .instanceLicenseType("string")
    .instanceUsageType("string")
    .name("string")
    .drRegion("string")
    .addOnFeatures("string")
    .definedTags(Map.of("string", "string"))
    .upgradeSchedule("string")
    .wafPrimaryDomain("string")
    .build());
oci_instance_resource = oci.oce.Instance("ociInstanceResource",
    idcs_access_token="string",
    admin_email="string",
    compartment_id="string",
    tenancy_name="string",
    tenancy_id="string",
    object_storage_namespace="string",
    description="string",
    freeform_tags={
        "string": "string",
    },
    instance_access_type="string",
    instance_license_type="string",
    instance_usage_type="string",
    name="string",
    dr_region="string",
    add_on_features=["string"],
    defined_tags={
        "string": "string",
    },
    upgrade_schedule="string",
    waf_primary_domain="string")
const ociInstanceResource = new oci.oce.Instance("ociInstanceResource", {
    idcsAccessToken: "string",
    adminEmail: "string",
    compartmentId: "string",
    tenancyName: "string",
    tenancyId: "string",
    objectStorageNamespace: "string",
    description: "string",
    freeformTags: {
        string: "string",
    },
    instanceAccessType: "string",
    instanceLicenseType: "string",
    instanceUsageType: "string",
    name: "string",
    drRegion: "string",
    addOnFeatures: ["string"],
    definedTags: {
        string: "string",
    },
    upgradeSchedule: "string",
    wafPrimaryDomain: "string",
});
type: oci:Oce:Instance
properties:
    addOnFeatures:
        - string
    adminEmail: string
    compartmentId: string
    definedTags:
        string: string
    description: string
    drRegion: string
    freeformTags:
        string: string
    idcsAccessToken: string
    instanceAccessType: string
    instanceLicenseType: string
    instanceUsageType: string
    name: string
    objectStorageNamespace: string
    tenancyId: string
    tenancyName: string
    upgradeSchedule: string
    wafPrimaryDomain: string
Instance 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 Instance resource accepts the following input properties:
- AdminEmail string
- Admin Email for Notification
- CompartmentId string
- (Updatable) Compartment Identifier
- IdcsAccess stringToken 
- Identity Cloud Service access token identifying a stripe and service administrator user
- ObjectStorage stringNamespace 
- Object Storage Namespace of Tenancy
- TenancyId string
- Tenancy Identifier
- TenancyName string
- Tenancy Name
- AddOn List<string>Features 
- (Updatable) a list of add-on features for the ocm instance
- Dictionary<string, string>
- (Updatable) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
- Description string
- (Updatable) OceInstance description
- DrRegion string
- (Updatable) disaster recovery paired ragion name
- 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"}
- InstanceAccess stringType 
- Flag indicating whether the instance access is private or public
- InstanceLicense stringType 
- (Updatable) Flag indicating whether the instance license is new cloud or bring your own license
- InstanceUsage stringType 
- (Updatable) Instance type based on its usage
- Name string
- OceInstance Name
- UpgradeSchedule string
- Upgrade schedule type representing service to be upgraded immediately whenever latest version is released or delay upgrade of the service to previous released version
- WafPrimary stringDomain 
- (Updatable) Web Application Firewall(WAF) primary domain - ** 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 
- AdminEmail string
- Admin Email for Notification
- CompartmentId string
- (Updatable) Compartment Identifier
- IdcsAccess stringToken 
- Identity Cloud Service access token identifying a stripe and service administrator user
- ObjectStorage stringNamespace 
- Object Storage Namespace of Tenancy
- TenancyId string
- Tenancy Identifier
- TenancyName string
- Tenancy Name
- AddOn []stringFeatures 
- (Updatable) a list of add-on features for the ocm instance
- map[string]string
- (Updatable) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
- Description string
- (Updatable) OceInstance description
- DrRegion string
- (Updatable) disaster recovery paired ragion name
- 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"}
- InstanceAccess stringType 
- Flag indicating whether the instance access is private or public
- InstanceLicense stringType 
- (Updatable) Flag indicating whether the instance license is new cloud or bring your own license
- InstanceUsage stringType 
- (Updatable) Instance type based on its usage
- Name string
- OceInstance Name
- UpgradeSchedule string
- Upgrade schedule type representing service to be upgraded immediately whenever latest version is released or delay upgrade of the service to previous released version
- WafPrimary stringDomain 
- (Updatable) Web Application Firewall(WAF) primary domain - ** 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 
- adminEmail String
- Admin Email for Notification
- compartmentId String
- (Updatable) Compartment Identifier
- idcsAccess StringToken 
- Identity Cloud Service access token identifying a stripe and service administrator user
- objectStorage StringNamespace 
- Object Storage Namespace of Tenancy
- tenancyId String
- Tenancy Identifier
- tenancyName String
- Tenancy Name
- addOn List<String>Features 
- (Updatable) a list of add-on features for the ocm instance
- Map<String,String>
- (Updatable) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
- description String
- (Updatable) OceInstance description
- drRegion String
- (Updatable) disaster recovery paired ragion name
- 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"}
- instanceAccess StringType 
- Flag indicating whether the instance access is private or public
- instanceLicense StringType 
- (Updatable) Flag indicating whether the instance license is new cloud or bring your own license
- instanceUsage StringType 
- (Updatable) Instance type based on its usage
- name String
- OceInstance Name
- upgradeSchedule String
- Upgrade schedule type representing service to be upgraded immediately whenever latest version is released or delay upgrade of the service to previous released version
- wafPrimary StringDomain 
- (Updatable) Web Application Firewall(WAF) primary domain - ** 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 
- adminEmail string
- Admin Email for Notification
- compartmentId string
- (Updatable) Compartment Identifier
- idcsAccess stringToken 
- Identity Cloud Service access token identifying a stripe and service administrator user
- objectStorage stringNamespace 
- Object Storage Namespace of Tenancy
- tenancyId string
- Tenancy Identifier
- tenancyName string
- Tenancy Name
- addOn string[]Features 
- (Updatable) a list of add-on features for the ocm instance
- {[key: string]: string}
- (Updatable) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
- description string
- (Updatable) OceInstance description
- drRegion string
- (Updatable) disaster recovery paired ragion name
- {[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"}
- instanceAccess stringType 
- Flag indicating whether the instance access is private or public
- instanceLicense stringType 
- (Updatable) Flag indicating whether the instance license is new cloud or bring your own license
- instanceUsage stringType 
- (Updatable) Instance type based on its usage
- name string
- OceInstance Name
- upgradeSchedule string
- Upgrade schedule type representing service to be upgraded immediately whenever latest version is released or delay upgrade of the service to previous released version
- wafPrimary stringDomain 
- (Updatable) Web Application Firewall(WAF) primary domain - ** 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 
- admin_email str
- Admin Email for Notification
- compartment_id str
- (Updatable) Compartment Identifier
- idcs_access_ strtoken 
- Identity Cloud Service access token identifying a stripe and service administrator user
- object_storage_ strnamespace 
- Object Storage Namespace of Tenancy
- tenancy_id str
- Tenancy Identifier
- tenancy_name str
- Tenancy Name
- add_on_ Sequence[str]features 
- (Updatable) a list of add-on features for the ocm instance
- Mapping[str, str]
- (Updatable) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
- description str
- (Updatable) OceInstance description
- dr_region str
- (Updatable) disaster recovery paired ragion name
- 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"}
- instance_access_ strtype 
- Flag indicating whether the instance access is private or public
- instance_license_ strtype 
- (Updatable) Flag indicating whether the instance license is new cloud or bring your own license
- instance_usage_ strtype 
- (Updatable) Instance type based on its usage
- name str
- OceInstance Name
- upgrade_schedule str
- Upgrade schedule type representing service to be upgraded immediately whenever latest version is released or delay upgrade of the service to previous released version
- waf_primary_ strdomain 
- (Updatable) Web Application Firewall(WAF) primary domain - ** 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 
- adminEmail String
- Admin Email for Notification
- compartmentId String
- (Updatable) Compartment Identifier
- idcsAccess StringToken 
- Identity Cloud Service access token identifying a stripe and service administrator user
- objectStorage StringNamespace 
- Object Storage Namespace of Tenancy
- tenancyId String
- Tenancy Identifier
- tenancyName String
- Tenancy Name
- addOn List<String>Features 
- (Updatable) a list of add-on features for the ocm instance
- Map<String>
- (Updatable) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
- description String
- (Updatable) OceInstance description
- drRegion String
- (Updatable) disaster recovery paired ragion name
- 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"}
- instanceAccess StringType 
- Flag indicating whether the instance access is private or public
- instanceLicense StringType 
- (Updatable) Flag indicating whether the instance license is new cloud or bring your own license
- instanceUsage StringType 
- (Updatable) Instance type based on its usage
- name String
- OceInstance Name
- upgradeSchedule String
- Upgrade schedule type representing service to be upgraded immediately whenever latest version is released or delay upgrade of the service to previous released version
- wafPrimary StringDomain 
- (Updatable) Web Application Firewall(WAF) primary domain - ** 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 Instance resource produces the following output properties:
- Guid string
- Unique GUID identifier that is immutable on creation
- Id string
- The provider-assigned unique ID for this managed resource.
- IdcsTenancy string
- IDCS Tenancy Identifier
- LifecycleDetails string
- Details of the current state of the instance lifecycle
- Service Dictionary<string, string>
- SERVICE data. Example: {"service": {"IDCS": "value"}}
- State string
- The current state of the instance lifecycle.
- StateMessage string
- An message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
- Dictionary<string, string>
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
- TimeCreated string
- The time the the OceInstance was created. An RFC3339 formatted datetime string
- TimeUpdated string
- The time the OceInstance was updated. An RFC3339 formatted datetime string
- Guid string
- Unique GUID identifier that is immutable on creation
- Id string
- The provider-assigned unique ID for this managed resource.
- IdcsTenancy string
- IDCS Tenancy Identifier
- LifecycleDetails string
- Details of the current state of the instance lifecycle
- Service map[string]string
- SERVICE data. Example: {"service": {"IDCS": "value"}}
- State string
- The current state of the instance lifecycle.
- StateMessage string
- An message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
- map[string]string
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
- TimeCreated string
- The time the the OceInstance was created. An RFC3339 formatted datetime string
- TimeUpdated string
- The time the OceInstance was updated. An RFC3339 formatted datetime string
- guid String
- Unique GUID identifier that is immutable on creation
- id String
- The provider-assigned unique ID for this managed resource.
- idcsTenancy String
- IDCS Tenancy Identifier
- lifecycleDetails String
- Details of the current state of the instance lifecycle
- service Map<String,String>
- SERVICE data. Example: {"service": {"IDCS": "value"}}
- state String
- The current state of the instance lifecycle.
- stateMessage String
- An message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
- Map<String,String>
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
- timeCreated String
- The time the the OceInstance was created. An RFC3339 formatted datetime string
- timeUpdated String
- The time the OceInstance was updated. An RFC3339 formatted datetime string
- guid string
- Unique GUID identifier that is immutable on creation
- id string
- The provider-assigned unique ID for this managed resource.
- idcsTenancy string
- IDCS Tenancy Identifier
- lifecycleDetails string
- Details of the current state of the instance lifecycle
- service {[key: string]: string}
- SERVICE data. Example: {"service": {"IDCS": "value"}}
- state string
- The current state of the instance lifecycle.
- stateMessage string
- An message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
- {[key: string]: string}
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
- timeCreated string
- The time the the OceInstance was created. An RFC3339 formatted datetime string
- timeUpdated string
- The time the OceInstance was updated. An RFC3339 formatted datetime string
- guid str
- Unique GUID identifier that is immutable on creation
- id str
- The provider-assigned unique ID for this managed resource.
- idcs_tenancy str
- IDCS Tenancy Identifier
- lifecycle_details str
- Details of the current state of the instance lifecycle
- service Mapping[str, str]
- SERVICE data. Example: {"service": {"IDCS": "value"}}
- state str
- The current state of the instance lifecycle.
- state_message str
- An message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
- 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 time the the OceInstance was created. An RFC3339 formatted datetime string
- time_updated str
- The time the OceInstance was updated. An RFC3339 formatted datetime string
- guid String
- Unique GUID identifier that is immutable on creation
- id String
- The provider-assigned unique ID for this managed resource.
- idcsTenancy String
- IDCS Tenancy Identifier
- lifecycleDetails String
- Details of the current state of the instance lifecycle
- service Map<String>
- SERVICE data. Example: {"service": {"IDCS": "value"}}
- state String
- The current state of the instance lifecycle.
- stateMessage String
- An message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
- Map<String>
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
- timeCreated String
- The time the the OceInstance was created. An RFC3339 formatted datetime string
- timeUpdated String
- The time the OceInstance was updated. An RFC3339 formatted datetime string
Look up Existing Instance Resource
Get an existing Instance 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?: InstanceState, opts?: CustomResourceOptions): Instance@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        add_on_features: Optional[Sequence[str]] = None,
        admin_email: Optional[str] = None,
        compartment_id: Optional[str] = None,
        defined_tags: Optional[Mapping[str, str]] = None,
        description: Optional[str] = None,
        dr_region: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, str]] = None,
        guid: Optional[str] = None,
        idcs_access_token: Optional[str] = None,
        idcs_tenancy: Optional[str] = None,
        instance_access_type: Optional[str] = None,
        instance_license_type: Optional[str] = None,
        instance_usage_type: Optional[str] = None,
        lifecycle_details: Optional[str] = None,
        name: Optional[str] = None,
        object_storage_namespace: Optional[str] = None,
        service: Optional[Mapping[str, str]] = None,
        state: Optional[str] = None,
        state_message: Optional[str] = None,
        system_tags: Optional[Mapping[str, str]] = None,
        tenancy_id: Optional[str] = None,
        tenancy_name: Optional[str] = None,
        time_created: Optional[str] = None,
        time_updated: Optional[str] = None,
        upgrade_schedule: Optional[str] = None,
        waf_primary_domain: Optional[str] = None) -> Instancefunc GetInstance(ctx *Context, name string, id IDInput, state *InstanceState, opts ...ResourceOption) (*Instance, error)public static Instance Get(string name, Input<string> id, InstanceState? state, CustomResourceOptions? opts = null)public static Instance get(String name, Output<String> id, InstanceState state, CustomResourceOptions options)resources:  _:    type: oci:Oce:Instance    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.
- AddOn List<string>Features 
- (Updatable) a list of add-on features for the ocm instance
- AdminEmail string
- Admin Email for Notification
- CompartmentId string
- (Updatable) Compartment Identifier
- Dictionary<string, string>
- (Updatable) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
- Description string
- (Updatable) OceInstance description
- DrRegion string
- (Updatable) disaster recovery paired ragion name
- 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"}
- Guid string
- Unique GUID identifier that is immutable on creation
- IdcsAccess stringToken 
- Identity Cloud Service access token identifying a stripe and service administrator user
- IdcsTenancy string
- IDCS Tenancy Identifier
- InstanceAccess stringType 
- Flag indicating whether the instance access is private or public
- InstanceLicense stringType 
- (Updatable) Flag indicating whether the instance license is new cloud or bring your own license
- InstanceUsage stringType 
- (Updatable) Instance type based on its usage
- LifecycleDetails string
- Details of the current state of the instance lifecycle
- Name string
- OceInstance Name
- ObjectStorage stringNamespace 
- Object Storage Namespace of Tenancy
- Service Dictionary<string, string>
- SERVICE data. Example: {"service": {"IDCS": "value"}}
- State string
- The current state of the instance lifecycle.
- StateMessage string
- An message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
- Dictionary<string, string>
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
- TenancyId string
- Tenancy Identifier
- TenancyName string
- Tenancy Name
- TimeCreated string
- The time the the OceInstance was created. An RFC3339 formatted datetime string
- TimeUpdated string
- The time the OceInstance was updated. An RFC3339 formatted datetime string
- UpgradeSchedule string
- Upgrade schedule type representing service to be upgraded immediately whenever latest version is released or delay upgrade of the service to previous released version
- WafPrimary stringDomain 
- (Updatable) Web Application Firewall(WAF) primary domain - ** 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 
- AddOn []stringFeatures 
- (Updatable) a list of add-on features for the ocm instance
- AdminEmail string
- Admin Email for Notification
- CompartmentId string
- (Updatable) Compartment Identifier
- map[string]string
- (Updatable) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
- Description string
- (Updatable) OceInstance description
- DrRegion string
- (Updatable) disaster recovery paired ragion name
- 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"}
- Guid string
- Unique GUID identifier that is immutable on creation
- IdcsAccess stringToken 
- Identity Cloud Service access token identifying a stripe and service administrator user
- IdcsTenancy string
- IDCS Tenancy Identifier
- InstanceAccess stringType 
- Flag indicating whether the instance access is private or public
- InstanceLicense stringType 
- (Updatable) Flag indicating whether the instance license is new cloud or bring your own license
- InstanceUsage stringType 
- (Updatable) Instance type based on its usage
- LifecycleDetails string
- Details of the current state of the instance lifecycle
- Name string
- OceInstance Name
- ObjectStorage stringNamespace 
- Object Storage Namespace of Tenancy
- Service map[string]string
- SERVICE data. Example: {"service": {"IDCS": "value"}}
- State string
- The current state of the instance lifecycle.
- StateMessage string
- An message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
- map[string]string
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
- TenancyId string
- Tenancy Identifier
- TenancyName string
- Tenancy Name
- TimeCreated string
- The time the the OceInstance was created. An RFC3339 formatted datetime string
- TimeUpdated string
- The time the OceInstance was updated. An RFC3339 formatted datetime string
- UpgradeSchedule string
- Upgrade schedule type representing service to be upgraded immediately whenever latest version is released or delay upgrade of the service to previous released version
- WafPrimary stringDomain 
- (Updatable) Web Application Firewall(WAF) primary domain - ** 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 
- addOn List<String>Features 
- (Updatable) a list of add-on features for the ocm instance
- adminEmail String
- Admin Email for Notification
- compartmentId String
- (Updatable) Compartment Identifier
- Map<String,String>
- (Updatable) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
- description String
- (Updatable) OceInstance description
- drRegion String
- (Updatable) disaster recovery paired ragion name
- 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"}
- guid String
- Unique GUID identifier that is immutable on creation
- idcsAccess StringToken 
- Identity Cloud Service access token identifying a stripe and service administrator user
- idcsTenancy String
- IDCS Tenancy Identifier
- instanceAccess StringType 
- Flag indicating whether the instance access is private or public
- instanceLicense StringType 
- (Updatable) Flag indicating whether the instance license is new cloud or bring your own license
- instanceUsage StringType 
- (Updatable) Instance type based on its usage
- lifecycleDetails String
- Details of the current state of the instance lifecycle
- name String
- OceInstance Name
- objectStorage StringNamespace 
- Object Storage Namespace of Tenancy
- service Map<String,String>
- SERVICE data. Example: {"service": {"IDCS": "value"}}
- state String
- The current state of the instance lifecycle.
- stateMessage String
- An message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
- Map<String,String>
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
- tenancyId String
- Tenancy Identifier
- tenancyName String
- Tenancy Name
- timeCreated String
- The time the the OceInstance was created. An RFC3339 formatted datetime string
- timeUpdated String
- The time the OceInstance was updated. An RFC3339 formatted datetime string
- upgradeSchedule String
- Upgrade schedule type representing service to be upgraded immediately whenever latest version is released or delay upgrade of the service to previous released version
- wafPrimary StringDomain 
- (Updatable) Web Application Firewall(WAF) primary domain - ** 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 
- addOn string[]Features 
- (Updatable) a list of add-on features for the ocm instance
- adminEmail string
- Admin Email for Notification
- compartmentId string
- (Updatable) Compartment Identifier
- {[key: string]: string}
- (Updatable) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
- description string
- (Updatable) OceInstance description
- drRegion string
- (Updatable) disaster recovery paired ragion name
- {[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"}
- guid string
- Unique GUID identifier that is immutable on creation
- idcsAccess stringToken 
- Identity Cloud Service access token identifying a stripe and service administrator user
- idcsTenancy string
- IDCS Tenancy Identifier
- instanceAccess stringType 
- Flag indicating whether the instance access is private or public
- instanceLicense stringType 
- (Updatable) Flag indicating whether the instance license is new cloud or bring your own license
- instanceUsage stringType 
- (Updatable) Instance type based on its usage
- lifecycleDetails string
- Details of the current state of the instance lifecycle
- name string
- OceInstance Name
- objectStorage stringNamespace 
- Object Storage Namespace of Tenancy
- service {[key: string]: string}
- SERVICE data. Example: {"service": {"IDCS": "value"}}
- state string
- The current state of the instance lifecycle.
- stateMessage string
- An message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
- {[key: string]: string}
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
- tenancyId string
- Tenancy Identifier
- tenancyName string
- Tenancy Name
- timeCreated string
- The time the the OceInstance was created. An RFC3339 formatted datetime string
- timeUpdated string
- The time the OceInstance was updated. An RFC3339 formatted datetime string
- upgradeSchedule string
- Upgrade schedule type representing service to be upgraded immediately whenever latest version is released or delay upgrade of the service to previous released version
- wafPrimary stringDomain 
- (Updatable) Web Application Firewall(WAF) primary domain - ** 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 
- add_on_ Sequence[str]features 
- (Updatable) a list of add-on features for the ocm instance
- admin_email str
- Admin Email for Notification
- compartment_id str
- (Updatable) Compartment Identifier
- Mapping[str, str]
- (Updatable) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
- description str
- (Updatable) OceInstance description
- dr_region str
- (Updatable) disaster recovery paired ragion name
- 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"}
- guid str
- Unique GUID identifier that is immutable on creation
- idcs_access_ strtoken 
- Identity Cloud Service access token identifying a stripe and service administrator user
- idcs_tenancy str
- IDCS Tenancy Identifier
- instance_access_ strtype 
- Flag indicating whether the instance access is private or public
- instance_license_ strtype 
- (Updatable) Flag indicating whether the instance license is new cloud or bring your own license
- instance_usage_ strtype 
- (Updatable) Instance type based on its usage
- lifecycle_details str
- Details of the current state of the instance lifecycle
- name str
- OceInstance Name
- object_storage_ strnamespace 
- Object Storage Namespace of Tenancy
- service Mapping[str, str]
- SERVICE data. Example: {"service": {"IDCS": "value"}}
- state str
- The current state of the instance lifecycle.
- state_message str
- An message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
- Mapping[str, str]
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
- tenancy_id str
- Tenancy Identifier
- tenancy_name str
- Tenancy Name
- time_created str
- The time the the OceInstance was created. An RFC3339 formatted datetime string
- time_updated str
- The time the OceInstance was updated. An RFC3339 formatted datetime string
- upgrade_schedule str
- Upgrade schedule type representing service to be upgraded immediately whenever latest version is released or delay upgrade of the service to previous released version
- waf_primary_ strdomain 
- (Updatable) Web Application Firewall(WAF) primary domain - ** 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 
- addOn List<String>Features 
- (Updatable) a list of add-on features for the ocm instance
- adminEmail String
- Admin Email for Notification
- compartmentId String
- (Updatable) Compartment Identifier
- Map<String>
- (Updatable) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
- description String
- (Updatable) OceInstance description
- drRegion String
- (Updatable) disaster recovery paired ragion name
- 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"}
- guid String
- Unique GUID identifier that is immutable on creation
- idcsAccess StringToken 
- Identity Cloud Service access token identifying a stripe and service administrator user
- idcsTenancy String
- IDCS Tenancy Identifier
- instanceAccess StringType 
- Flag indicating whether the instance access is private or public
- instanceLicense StringType 
- (Updatable) Flag indicating whether the instance license is new cloud or bring your own license
- instanceUsage StringType 
- (Updatable) Instance type based on its usage
- lifecycleDetails String
- Details of the current state of the instance lifecycle
- name String
- OceInstance Name
- objectStorage StringNamespace 
- Object Storage Namespace of Tenancy
- service Map<String>
- SERVICE data. Example: {"service": {"IDCS": "value"}}
- state String
- The current state of the instance lifecycle.
- stateMessage String
- An message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
- Map<String>
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
- tenancyId String
- Tenancy Identifier
- tenancyName String
- Tenancy Name
- timeCreated String
- The time the the OceInstance was created. An RFC3339 formatted datetime string
- timeUpdated String
- The time the OceInstance was updated. An RFC3339 formatted datetime string
- upgradeSchedule String
- Upgrade schedule type representing service to be upgraded immediately whenever latest version is released or delay upgrade of the service to previous released version
- wafPrimary StringDomain 
- (Updatable) Web Application Firewall(WAF) primary domain - ** 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 
Import
OceInstances can be imported using the id, e.g.
$ pulumi import oci:Oce/instance:Instance test_oce_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 ociTerraform Provider.