Oracle Cloud Infrastructure v2.31.0, Apr 17 25

Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi

oci.ContainerInstances.getContainerInstance

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi

Example Usage

TypeScript
Python
Go
C#
Java
YAML

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

const testContainerInstance = oci.ContainerInstances.getContainerInstance({
    containerInstanceId: testContainerInstanceOciContainerInstancesContainerInstance.id,
});

import pulumi
import pulumi_oci as oci

test_container_instance = oci.ContainerInstances.get_container_instance(container_instance_id=test_container_instance_oci_container_instances_container_instance["id"])

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := containerinstances.GetContainerInstance(ctx, &containerinstances.GetContainerInstanceArgs{
			ContainerInstanceId: testContainerInstanceOciContainerInstancesContainerInstance.Id,
		}, nil)
		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 testContainerInstance = Oci.ContainerInstances.GetContainerInstance.Invoke(new()
    {
        ContainerInstanceId = testContainerInstanceOciContainerInstancesContainerInstance.Id,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.ContainerInstances.ContainerInstancesFunctions;
import com.pulumi.oci.ContainerInstances.inputs.GetContainerInstanceArgs;
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) {
        final var testContainerInstance = ContainerInstancesFunctions.getContainerInstance(GetContainerInstanceArgs.builder()
            .containerInstanceId(testContainerInstanceOciContainerInstancesContainerInstance.id())
            .build());

    }
}

variables:
  testContainerInstance:
    fn::invoke:
      function: oci:ContainerInstances:getContainerInstance
      arguments:
        containerInstanceId: ${testContainerInstanceOciContainerInstancesContainerInstance.id}

Using getContainerInstance

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

TypeScript
Python
Go
C#
Java
YAML

function getContainerInstance(args: GetContainerInstanceArgs, opts?: InvokeOptions): Promise<GetContainerInstanceResult>
function getContainerInstanceOutput(args: GetContainerInstanceOutputArgs, opts?: InvokeOptions): Output<GetContainerInstanceResult>

def get_container_instance(container_instance_id: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetContainerInstanceResult
def get_container_instance_output(container_instance_id: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetContainerInstanceResult]

func GetContainerInstance(ctx *Context, args *GetContainerInstanceArgs, opts ...InvokeOption) (*GetContainerInstanceResult, error)
func GetContainerInstanceOutput(ctx *Context, args *GetContainerInstanceOutputArgs, opts ...InvokeOption) GetContainerInstanceResultOutput

> Note: This function is named GetContainerInstance in the Go SDK.

public static class GetContainerInstance 
{
    public static Task<GetContainerInstanceResult> InvokeAsync(GetContainerInstanceArgs args, InvokeOptions? opts = null)
    public static Output<GetContainerInstanceResult> Invoke(GetContainerInstanceInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetContainerInstanceResult> getContainerInstance(GetContainerInstanceArgs args, InvokeOptions options)
public static Output<GetContainerInstanceResult> getContainerInstance(GetContainerInstanceArgs args, InvokeOptions options)

fn::invoke:
  function: oci:ContainerInstances/getContainerInstance:getContainerInstance
  arguments:
    # arguments dictionary

The following arguments are supported:

ContainerInstanceId string: The OCID of the container instance.

ContainerInstanceId string: The OCID of the container instance.

containerInstanceId String: The OCID of the container instance.

containerInstanceId string: The OCID of the container instance.

container_instance_id str: The OCID of the container instance.

containerInstanceId String: The OCID of the container instance.

getContainerInstance Result

The following output properties are available:

AvailabilityDomain string: The availability domain to place the container instance.
CompartmentId string: The OCID of the compartment.
ContainerCount int: The number of containers on the container instance.
ContainerInstanceId string
ContainerRestartPolicy string: The container restart policy is applied for all containers in container instance.
Containers List<GetContainerInstanceContainer>: The containers on the container instance.
DefinedTags Dictionary<string, string>: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}.
DisplayName string: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
DnsConfigs List<GetContainerInstanceDnsConfig>: DNS settings for containers.
FaultDomain string: The fault domain to place the container instance.
FreeformTags Dictionary<string, string>: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
GracefulShutdownTimeoutInSeconds string: The amount of time that processes in a container have to gracefully end when the container must be stopped. For example, when you delete a container instance. After the timeout is reached, the processes are sent a signal to be deleted.
Id string: An OCID that cannot be changed.
ImagePullSecrets List<GetContainerInstanceImagePullSecret>: The image pulls secrets so you can access private registry to pull container images.
LifecycleDetails string: A message that describes the current state of the container in more detail. Can be used to provide actionable information.
Shape string: The shape of the container instance. The shape determines the number of OCPUs, amount of memory, and other resources that are allocated to a container instance.
ShapeConfigs List<GetContainerInstanceShapeConfig>: The shape configuration for a container instance. The shape configuration determines the resources thats are available to the container instance and its containers.
State string: The current state of the container instance.
SystemTags 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 container instance was created, in the format defined by RFC 3339.
TimeUpdated string: The time the container instance was updated, in the format defined by RFC 3339.
Vnics List<GetContainerInstanceVnic>: The virtual networks available to the containers in the container instance.
VolumeCount int: The number of volumes that are attached to the container instance.
Volumes List<GetContainerInstanceVolume>: A volume is a directory with data that is accessible across multiple containers in a container instance.

AvailabilityDomain string: The availability domain to place the container instance.
CompartmentId string: The OCID of the compartment.
ContainerCount int: The number of containers on the container instance.
ContainerInstanceId string
ContainerRestartPolicy string: The container restart policy is applied for all containers in container instance.
Containers []GetContainerInstanceContainer: The containers on the container instance.
DefinedTags map[string]string: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}.
DisplayName string: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
DnsConfigs []GetContainerInstanceDnsConfig: DNS settings for containers.
FaultDomain string: The fault domain to place the container instance.
FreeformTags map[string]string: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
GracefulShutdownTimeoutInSeconds string: The amount of time that processes in a container have to gracefully end when the container must be stopped. For example, when you delete a container instance. After the timeout is reached, the processes are sent a signal to be deleted.
Id string: An OCID that cannot be changed.
ImagePullSecrets []GetContainerInstanceImagePullSecret: The image pulls secrets so you can access private registry to pull container images.
LifecycleDetails string: A message that describes the current state of the container in more detail. Can be used to provide actionable information.
Shape string: The shape of the container instance. The shape determines the number of OCPUs, amount of memory, and other resources that are allocated to a container instance.
ShapeConfigs []GetContainerInstanceShapeConfig: The shape configuration for a container instance. The shape configuration determines the resources thats are available to the container instance and its containers.
State string: The current state of the container instance.
SystemTags 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 container instance was created, in the format defined by RFC 3339.
TimeUpdated string: The time the container instance was updated, in the format defined by RFC 3339.
Vnics []GetContainerInstanceVnic: The virtual networks available to the containers in the container instance.
VolumeCount int: The number of volumes that are attached to the container instance.
Volumes []GetContainerInstanceVolume: A volume is a directory with data that is accessible across multiple containers in a container instance.

availabilityDomain String: The availability domain to place the container instance.
compartmentId String: The OCID of the compartment.
containerCount Integer: The number of containers on the container instance.
containerInstanceId String
containerRestartPolicy String: The container restart policy is applied for all containers in container instance.
containers List<GetContainerInstanceContainer>: The containers on the container instance.
definedTags Map<String,String>: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}.
displayName String: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
dnsConfigs List<GetContainerInstanceDnsConfig>: DNS settings for containers.
faultDomain String: The fault domain to place the container instance.
freeformTags Map<String,String>: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
gracefulShutdownTimeoutInSeconds String: The amount of time that processes in a container have to gracefully end when the container must be stopped. For example, when you delete a container instance. After the timeout is reached, the processes are sent a signal to be deleted.
id String: An OCID that cannot be changed.
imagePullSecrets List<GetContainerInstanceImagePullSecret>: The image pulls secrets so you can access private registry to pull container images.
lifecycleDetails String: A message that describes the current state of the container in more detail. Can be used to provide actionable information.
shape String: The shape of the container instance. The shape determines the number of OCPUs, amount of memory, and other resources that are allocated to a container instance.
shapeConfigs List<GetContainerInstanceShapeConfig>: The shape configuration for a container instance. The shape configuration determines the resources thats are available to the container instance and its containers.
state String: The current state of the container instance.
systemTags 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 container instance was created, in the format defined by RFC 3339.
timeUpdated String: The time the container instance was updated, in the format defined by RFC 3339.
vnics List<GetContainerInstanceVnic>: The virtual networks available to the containers in the container instance.
volumeCount Integer: The number of volumes that are attached to the container instance.
volumes List<GetContainerInstanceVolume>: A volume is a directory with data that is accessible across multiple containers in a container instance.

availabilityDomain string: The availability domain to place the container instance.
compartmentId string: The OCID of the compartment.
containerCount number: The number of containers on the container instance.
containerInstanceId string
containerRestartPolicy string: The container restart policy is applied for all containers in container instance.
containers GetContainerInstanceContainer[]: The containers on the container instance.
definedTags {[key: string]: string}: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}.
displayName string: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
dnsConfigs GetContainerInstanceDnsConfig[]: DNS settings for containers.
faultDomain string: The fault domain to place the container instance.
freeformTags {[key: string]: string}: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
gracefulShutdownTimeoutInSeconds string: The amount of time that processes in a container have to gracefully end when the container must be stopped. For example, when you delete a container instance. After the timeout is reached, the processes are sent a signal to be deleted.
id string: An OCID that cannot be changed.
imagePullSecrets GetContainerInstanceImagePullSecret[]: The image pulls secrets so you can access private registry to pull container images.
lifecycleDetails string: A message that describes the current state of the container in more detail. Can be used to provide actionable information.
shape string: The shape of the container instance. The shape determines the number of OCPUs, amount of memory, and other resources that are allocated to a container instance.
shapeConfigs GetContainerInstanceShapeConfig[]: The shape configuration for a container instance. The shape configuration determines the resources thats are available to the container instance and its containers.
state string: The current state of the container instance.
systemTags {[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 container instance was created, in the format defined by RFC 3339.
timeUpdated string: The time the container instance was updated, in the format defined by RFC 3339.
vnics GetContainerInstanceVnic[]: The virtual networks available to the containers in the container instance.
volumeCount number: The number of volumes that are attached to the container instance.
volumes GetContainerInstanceVolume[]: A volume is a directory with data that is accessible across multiple containers in a container instance.

availability_domain str: The availability domain to place the container instance.
compartment_id str: The OCID of the compartment.
container_count int: The number of containers on the container instance.
container_instance_id str
container_restart_policy str: The container restart policy is applied for all containers in container instance.
containers Sequence[containerinstances.GetContainerInstanceContainer]: The containers on the container instance.
defined_tags Mapping[str, str]: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}.
display_name str: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
dns_configs Sequence[containerinstances.GetContainerInstanceDnsConfig]: DNS settings for containers.
fault_domain str: The fault domain to place the container instance.
freeform_tags Mapping[str, str]: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
graceful_shutdown_timeout_in_seconds str: The amount of time that processes in a container have to gracefully end when the container must be stopped. For example, when you delete a container instance. After the timeout is reached, the processes are sent a signal to be deleted.
id str: An OCID that cannot be changed.
image_pull_secrets Sequence[containerinstances.GetContainerInstanceImagePullSecret]: The image pulls secrets so you can access private registry to pull container images.
lifecycle_details str: A message that describes the current state of the container in more detail. Can be used to provide actionable information.
shape str: The shape of the container instance. The shape determines the number of OCPUs, amount of memory, and other resources that are allocated to a container instance.
shape_configs Sequence[containerinstances.GetContainerInstanceShapeConfig]: The shape configuration for a container instance. The shape configuration determines the resources thats are available to the container instance and its containers.
state str: The current state of the container instance.
system_tags 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 container instance was created, in the format defined by RFC 3339.
time_updated str: The time the container instance was updated, in the format defined by RFC 3339.
vnics Sequence[containerinstances.GetContainerInstanceVnic]: The virtual networks available to the containers in the container instance.
volume_count int: The number of volumes that are attached to the container instance.
volumes Sequence[containerinstances.GetContainerInstanceVolume]: A volume is a directory with data that is accessible across multiple containers in a container instance.

availabilityDomain String: The availability domain to place the container instance.
compartmentId String: The OCID of the compartment.
containerCount Number: The number of containers on the container instance.
containerInstanceId String
containerRestartPolicy String: The container restart policy is applied for all containers in container instance.
containers List<Property Map>: The containers on the container instance.
definedTags Map<String>: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}.
displayName String: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
dnsConfigs List<Property Map>: DNS settings for containers.
faultDomain String: The fault domain to place the container instance.
freeformTags Map<String>: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
gracefulShutdownTimeoutInSeconds String: The amount of time that processes in a container have to gracefully end when the container must be stopped. For example, when you delete a container instance. After the timeout is reached, the processes are sent a signal to be deleted.
id String: An OCID that cannot be changed.
imagePullSecrets List<Property Map>: The image pulls secrets so you can access private registry to pull container images.
lifecycleDetails String: A message that describes the current state of the container in more detail. Can be used to provide actionable information.
shape String: The shape of the container instance. The shape determines the number of OCPUs, amount of memory, and other resources that are allocated to a container instance.
shapeConfigs List<Property Map>: The shape configuration for a container instance. The shape configuration determines the resources thats are available to the container instance and its containers.
state String: The current state of the container instance.
systemTags 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 container instance was created, in the format defined by RFC 3339.
timeUpdated String: The time the container instance was updated, in the format defined by RFC 3339.
vnics List<Property Map>: The virtual networks available to the containers in the container instance.
volumeCount Number: The number of volumes that are attached to the container instance.
volumes List<Property Map>: A volume is a directory with data that is accessible across multiple containers in a container instance.

Supporting Types

GetContainerInstanceContainer

Arguments List<string>
AvailabilityDomain string: The availability domain to place the container instance.
Commands List<string>
CompartmentId string: The OCID of the compartment.
ContainerId string: The OCID of the container.
ContainerInstanceId string: The OCID of the container instance.
DefinedTags Dictionary<string, string>: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}.
DisplayName string: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
EnvironmentVariables Dictionary<string, string>
ExitCode int
FaultDomain string: The fault domain to place the container instance.
FreeformTags Dictionary<string, string>: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
HealthChecks List<GetContainerInstanceContainerHealthCheck>
ImageUrl string
IsResourcePrincipalDisabled bool
LifecycleDetails string: A message that describes the current state of the container in more detail. Can be used to provide actionable information.
ResourceConfigs List<GetContainerInstanceContainerResourceConfig>
SecurityContexts List<GetContainerInstanceContainerSecurityContext>
State string: The current state of the container instance.
SystemTags 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 container instance was created, in the format defined by RFC 3339.
TimeTerminated string
TimeUpdated string: The time the container instance was updated, in the format defined by RFC 3339.
VolumeMounts List<GetContainerInstanceContainerVolumeMount>
WorkingDirectory string

Arguments []string
AvailabilityDomain string: The availability domain to place the container instance.
Commands []string
CompartmentId string: The OCID of the compartment.
ContainerId string: The OCID of the container.
ContainerInstanceId string: The OCID of the container instance.
DefinedTags map[string]string: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}.
DisplayName string: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
EnvironmentVariables map[string]string
ExitCode int
FaultDomain string: The fault domain to place the container instance.
FreeformTags map[string]string: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
HealthChecks []GetContainerInstanceContainerHealthCheck
ImageUrl string
IsResourcePrincipalDisabled bool
LifecycleDetails string: A message that describes the current state of the container in more detail. Can be used to provide actionable information.
ResourceConfigs []GetContainerInstanceContainerResourceConfig
SecurityContexts []GetContainerInstanceContainerSecurityContext
State string: The current state of the container instance.
SystemTags 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 container instance was created, in the format defined by RFC 3339.
TimeTerminated string
TimeUpdated string: The time the container instance was updated, in the format defined by RFC 3339.
VolumeMounts []GetContainerInstanceContainerVolumeMount
WorkingDirectory string

arguments List<String>
availabilityDomain String: The availability domain to place the container instance.
commands List<String>
compartmentId String: The OCID of the compartment.
containerId String: The OCID of the container.
containerInstanceId String: The OCID of the container instance.
definedTags Map<String,String>: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}.
displayName String: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
environmentVariables Map<String,String>
exitCode Integer
faultDomain String: The fault domain to place the container instance.
freeformTags Map<String,String>: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
healthChecks List<GetContainerInstanceContainerHealthCheck>
imageUrl String
isResourcePrincipalDisabled Boolean
lifecycleDetails String: A message that describes the current state of the container in more detail. Can be used to provide actionable information.
resourceConfigs List<GetContainerInstanceContainerResourceConfig>
securityContexts List<GetContainerInstanceContainerSecurityContext>
state String: The current state of the container instance.
systemTags 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 container instance was created, in the format defined by RFC 3339.
timeTerminated String
timeUpdated String: The time the container instance was updated, in the format defined by RFC 3339.
volumeMounts List<GetContainerInstanceContainerVolumeMount>
workingDirectory String

arguments string[]
availabilityDomain string: The availability domain to place the container instance.
commands string[]
compartmentId string: The OCID of the compartment.
containerId string: The OCID of the container.
containerInstanceId string: The OCID of the container instance.
definedTags {[key: string]: string}: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}.
displayName string: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
environmentVariables {[key: string]: string}
exitCode number
faultDomain string: The fault domain to place the container instance.
freeformTags {[key: string]: string}: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
healthChecks GetContainerInstanceContainerHealthCheck[]
imageUrl string
isResourcePrincipalDisabled boolean
lifecycleDetails string: A message that describes the current state of the container in more detail. Can be used to provide actionable information.
resourceConfigs GetContainerInstanceContainerResourceConfig[]
securityContexts GetContainerInstanceContainerSecurityContext[]
state string: The current state of the container instance.
systemTags {[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 container instance was created, in the format defined by RFC 3339.
timeTerminated string
timeUpdated string: The time the container instance was updated, in the format defined by RFC 3339.
volumeMounts GetContainerInstanceContainerVolumeMount[]
workingDirectory string

arguments Sequence[str]
availability_domain str: The availability domain to place the container instance.
commands Sequence[str]
compartment_id str: The OCID of the compartment.
container_id str: The OCID of the container.
container_instance_id str: The OCID of the container instance.
defined_tags Mapping[str, str]: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}.
display_name str: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
environment_variables Mapping[str, str]
exit_code int
fault_domain str: The fault domain to place the container instance.
freeform_tags Mapping[str, str]: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
health_checks Sequence[containerinstances.GetContainerInstanceContainerHealthCheck]
image_url str
is_resource_principal_disabled bool
lifecycle_details str: A message that describes the current state of the container in more detail. Can be used to provide actionable information.
resource_configs Sequence[containerinstances.GetContainerInstanceContainerResourceConfig]
security_contexts Sequence[containerinstances.GetContainerInstanceContainerSecurityContext]
state str: The current state of the container instance.
system_tags 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 container instance was created, in the format defined by RFC 3339.
time_terminated str
time_updated str: The time the container instance was updated, in the format defined by RFC 3339.
volume_mounts Sequence[containerinstances.GetContainerInstanceContainerVolumeMount]
working_directory str

arguments List<String>
availabilityDomain String: The availability domain to place the container instance.
commands List<String>
compartmentId String: The OCID of the compartment.
containerId String: The OCID of the container.
containerInstanceId String: The OCID of the container instance.
definedTags Map<String>: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}.
displayName String: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
environmentVariables Map<String>
exitCode Number
faultDomain String: The fault domain to place the container instance.
freeformTags Map<String>: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
healthChecks List<Property Map>
imageUrl String
isResourcePrincipalDisabled Boolean
lifecycleDetails String: A message that describes the current state of the container in more detail. Can be used to provide actionable information.
resourceConfigs List<Property Map>
securityContexts List<Property Map>
state String: The current state of the container instance.
systemTags 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 container instance was created, in the format defined by RFC 3339.
timeTerminated String
timeUpdated String: The time the container instance was updated, in the format defined by RFC 3339.
volumeMounts List<Property Map>
workingDirectory String

GetContainerInstanceContainerHealthCheck

FailureAction string
FailureThreshold int
Headers List<GetContainerInstanceContainerHealthCheckHeader>
HealthCheckType string
InitialDelayInSeconds int
IntervalInSeconds int
Name string: The name of the volume. This must be unique within a single container instance.
Path string: (Optional) Relative path for this file inside the volume mount directory. By default, the file is presented at the root of the volume mount path.
Port int
Status string
StatusDetails string
SuccessThreshold int
TimeoutInSeconds int

FailureAction string
FailureThreshold int
Headers []GetContainerInstanceContainerHealthCheckHeader
HealthCheckType string
InitialDelayInSeconds int
IntervalInSeconds int
Name string: The name of the volume. This must be unique within a single container instance.
Path string: (Optional) Relative path for this file inside the volume mount directory. By default, the file is presented at the root of the volume mount path.
Port int
Status string
StatusDetails string
SuccessThreshold int
TimeoutInSeconds int

failureAction String
failureThreshold Integer
headers List<GetContainerInstanceContainerHealthCheckHeader>
healthCheckType String
initialDelayInSeconds Integer
intervalInSeconds Integer
name String: The name of the volume. This must be unique within a single container instance.
path String: (Optional) Relative path for this file inside the volume mount directory. By default, the file is presented at the root of the volume mount path.
port Integer
status String
statusDetails String
successThreshold Integer
timeoutInSeconds Integer

failureAction string
failureThreshold number
headers GetContainerInstanceContainerHealthCheckHeader[]
healthCheckType string
initialDelayInSeconds number
intervalInSeconds number
name string: The name of the volume. This must be unique within a single container instance.
path string: (Optional) Relative path for this file inside the volume mount directory. By default, the file is presented at the root of the volume mount path.
port number
status string
statusDetails string
successThreshold number
timeoutInSeconds number

failure_action str
failure_threshold int
headers Sequence[containerinstances.GetContainerInstanceContainerHealthCheckHeader]
health_check_type str
initial_delay_in_seconds int
interval_in_seconds int
name str: The name of the volume. This must be unique within a single container instance.
path str: (Optional) Relative path for this file inside the volume mount directory. By default, the file is presented at the root of the volume mount path.
port int
status str
status_details str
success_threshold int
timeout_in_seconds int

failureAction String
failureThreshold Number
headers List<Property Map>
healthCheckType String
initialDelayInSeconds Number
intervalInSeconds Number
name String: The name of the volume. This must be unique within a single container instance.
path String: (Optional) Relative path for this file inside the volume mount directory. By default, the file is presented at the root of the volume mount path.
port Number
status String
statusDetails String
successThreshold Number
timeoutInSeconds Number

GetContainerInstanceContainerHealthCheckHeader

Name string: The name of the volume. This must be unique within a single container instance.
Value string

Name string: The name of the volume. This must be unique within a single container instance.
Value string

name String: The name of the volume. This must be unique within a single container instance.
value String

name string: The name of the volume. This must be unique within a single container instance.
value string

name str: The name of the volume. This must be unique within a single container instance.
value str

name String: The name of the volume. This must be unique within a single container instance.
value String

GetContainerInstanceDnsConfig

Nameservers List<string>: IP address of the name server..
Options List<string>: Options allows certain internal resolver variables to be modified.
Searches List<string>: Search list for hostname lookup.

Nameservers []string: IP address of the name server..
Options []string: Options allows certain internal resolver variables to be modified.
Searches []string: Search list for hostname lookup.

nameservers List<String>: IP address of the name server..
options List<String>: Options allows certain internal resolver variables to be modified.
searches List<String>: Search list for hostname lookup.

nameservers string[]: IP address of the name server..
options string[]: Options allows certain internal resolver variables to be modified.
searches string[]: Search list for hostname lookup.

nameservers Sequence[str]: IP address of the name server..
options Sequence[str]: Options allows certain internal resolver variables to be modified.
searches Sequence[str]: Search list for hostname lookup.

nameservers List<String>: IP address of the name server..
options List<String>: Options allows certain internal resolver variables to be modified.
searches List<String>: Search list for hostname lookup.

GetContainerInstanceImagePullSecret

Password string
RegistryEndpoint string: The registry endpoint of the container image.
SecretId string: The OCID of the secret for registry credentials.
SecretType string: The type of ImagePullSecret.
Username string

Password string
RegistryEndpoint string: The registry endpoint of the container image.
SecretId string: The OCID of the secret for registry credentials.
SecretType string: The type of ImagePullSecret.
Username string

password String
registryEndpoint String: The registry endpoint of the container image.
secretId String: The OCID of the secret for registry credentials.
secretType String: The type of ImagePullSecret.
username String

password string
registryEndpoint string: The registry endpoint of the container image.
secretId string: The OCID of the secret for registry credentials.
secretType string: The type of ImagePullSecret.
username string

password str
registry_endpoint str: The registry endpoint of the container image.
secret_id str: The OCID of the secret for registry credentials.
secret_type str: The type of ImagePullSecret.
username str

password String
registryEndpoint String: The registry endpoint of the container image.
secretId String: The OCID of the secret for registry credentials.
secretType String: The type of ImagePullSecret.
username String

GetContainerInstanceShapeConfig

MemoryInGbs double: The total amount of memory available to the container instance, in gigabytes.
NetworkingBandwidthInGbps double: The networking bandwidth available to the container instance, in gigabits per second.
Ocpus double: The total number of OCPUs available to the container instance.
ProcessorDescription string: A short description of the container instance's processor (CPU).

MemoryInGbs float64: The total amount of memory available to the container instance, in gigabytes.
NetworkingBandwidthInGbps float64: The networking bandwidth available to the container instance, in gigabits per second.
Ocpus float64: The total number of OCPUs available to the container instance.
ProcessorDescription string: A short description of the container instance's processor (CPU).

memoryInGbs Double: The total amount of memory available to the container instance, in gigabytes.
networkingBandwidthInGbps Double: The networking bandwidth available to the container instance, in gigabits per second.
ocpus Double: The total number of OCPUs available to the container instance.
processorDescription String: A short description of the container instance's processor (CPU).

memoryInGbs number: The total amount of memory available to the container instance, in gigabytes.
networkingBandwidthInGbps number: The networking bandwidth available to the container instance, in gigabits per second.
ocpus number: The total number of OCPUs available to the container instance.
processorDescription string: A short description of the container instance's processor (CPU).

memory_in_gbs float: The total amount of memory available to the container instance, in gigabytes.
networking_bandwidth_in_gbps float: The networking bandwidth available to the container instance, in gigabits per second.
ocpus float: The total number of OCPUs available to the container instance.
processor_description str: A short description of the container instance's processor (CPU).

memoryInGbs Number: The total amount of memory available to the container instance, in gigabytes.
networkingBandwidthInGbps Number: The networking bandwidth available to the container instance, in gigabits per second.
ocpus Number: The total number of OCPUs available to the container instance.
processorDescription String: A short description of the container instance's processor (CPU).

GetContainerInstanceVnic

DefinedTags Dictionary<string, string>: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}.
DisplayName string: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
FreeformTags Dictionary<string, string>: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
HostnameLabel string
IsPublicIpAssigned bool
NsgIds List<string>
PrivateIp string
SkipSourceDestCheck bool
SubnetId string
VnicId string: The identifier of the virtual network interface card (VNIC) over which the containers accessing this network can communicate with the larger virtual cloud network.

DefinedTags map[string]string: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}.
DisplayName string: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
FreeformTags map[string]string: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
HostnameLabel string
IsPublicIpAssigned bool
NsgIds []string
PrivateIp string
SkipSourceDestCheck bool
SubnetId string
VnicId string: The identifier of the virtual network interface card (VNIC) over which the containers accessing this network can communicate with the larger virtual cloud network.

definedTags Map<String,String>: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}.
displayName String: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
freeformTags Map<String,String>: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
hostnameLabel String
isPublicIpAssigned Boolean
nsgIds List<String>
privateIp String
skipSourceDestCheck Boolean
subnetId String
vnicId String: The identifier of the virtual network interface card (VNIC) over which the containers accessing this network can communicate with the larger virtual cloud network.

definedTags {[key: string]: string}: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}.
displayName string: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
freeformTags {[key: string]: string}: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
hostnameLabel string
isPublicIpAssigned boolean
nsgIds string[]
privateIp string
skipSourceDestCheck boolean
subnetId string
vnicId string: The identifier of the virtual network interface card (VNIC) over which the containers accessing this network can communicate with the larger virtual cloud network.

defined_tags Mapping[str, str]: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}.
display_name str: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
freeform_tags Mapping[str, str]: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
hostname_label str
is_public_ip_assigned bool
nsg_ids Sequence[str]
private_ip str
skip_source_dest_check bool
subnet_id str
vnic_id str: The identifier of the virtual network interface card (VNIC) over which the containers accessing this network can communicate with the larger virtual cloud network.

definedTags Map<String>: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}.
displayName String: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
freeformTags Map<String>: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
hostnameLabel String
isPublicIpAssigned Boolean
nsgIds List<String>
privateIp String
skipSourceDestCheck Boolean
subnetId String
vnicId String: The identifier of the virtual network interface card (VNIC) over which the containers accessing this network can communicate with the larger virtual cloud network.

GetContainerInstanceVolume

BackingStore string: The volume type of the empty directory, can be either File Storage or Memory.
Configs List<GetContainerInstanceVolumeConfig>: Contains string key value pairs which can be mounted as individual files inside the container. The value needs to be base64 encoded. It is decoded to plain text before the mount.
Name string: The name of the volume. This must be unique within a single container instance.
VolumeType string: The type of volume.

BackingStore string: The volume type of the empty directory, can be either File Storage or Memory.
Configs []GetContainerInstanceVolumeConfig: Contains string key value pairs which can be mounted as individual files inside the container. The value needs to be base64 encoded. It is decoded to plain text before the mount.
Name string: The name of the volume. This must be unique within a single container instance.
VolumeType string: The type of volume.

backingStore String: The volume type of the empty directory, can be either File Storage or Memory.
configs List<GetContainerInstanceVolumeConfig>: Contains string key value pairs which can be mounted as individual files inside the container. The value needs to be base64 encoded. It is decoded to plain text before the mount.
name String: The name of the volume. This must be unique within a single container instance.
volumeType String: The type of volume.

backingStore string: The volume type of the empty directory, can be either File Storage or Memory.
configs GetContainerInstanceVolumeConfig[]: Contains string key value pairs which can be mounted as individual files inside the container. The value needs to be base64 encoded. It is decoded to plain text before the mount.
name string: The name of the volume. This must be unique within a single container instance.
volumeType string: The type of volume.

backing_store str: The volume type of the empty directory, can be either File Storage or Memory.
configs Sequence[containerinstances.GetContainerInstanceVolumeConfig]: Contains string key value pairs which can be mounted as individual files inside the container. The value needs to be base64 encoded. It is decoded to plain text before the mount.
name str: The name of the volume. This must be unique within a single container instance.
volume_type str: The type of volume.

backingStore String: The volume type of the empty directory, can be either File Storage or Memory.
configs List<Property Map>: Contains string key value pairs which can be mounted as individual files inside the container. The value needs to be base64 encoded. It is decoded to plain text before the mount.
name String: The name of the volume. This must be unique within a single container instance.
volumeType String: The type of volume.

GetContainerInstanceVolumeConfig

Data string: The base64 encoded contents of the file. The contents are decoded to plain text before mounted as a file to a container inside container instance.
FileName string: The name of the file. The fileName should be unique across the volume.
Path string: (Optional) Relative path for this file inside the volume mount directory. By default, the file is presented at the root of the volume mount path.

Data string: The base64 encoded contents of the file. The contents are decoded to plain text before mounted as a file to a container inside container instance.
FileName string: The name of the file. The fileName should be unique across the volume.
Path string: (Optional) Relative path for this file inside the volume mount directory. By default, the file is presented at the root of the volume mount path.

data String: The base64 encoded contents of the file. The contents are decoded to plain text before mounted as a file to a container inside container instance.
fileName String: The name of the file. The fileName should be unique across the volume.
path String: (Optional) Relative path for this file inside the volume mount directory. By default, the file is presented at the root of the volume mount path.

data string: The base64 encoded contents of the file. The contents are decoded to plain text before mounted as a file to a container inside container instance.
fileName string: The name of the file. The fileName should be unique across the volume.
path string: (Optional) Relative path for this file inside the volume mount directory. By default, the file is presented at the root of the volume mount path.

data str: The base64 encoded contents of the file. The contents are decoded to plain text before mounted as a file to a container inside container instance.
file_name str: The name of the file. The fileName should be unique across the volume.
path str: (Optional) Relative path for this file inside the volume mount directory. By default, the file is presented at the root of the volume mount path.

data String: The base64 encoded contents of the file. The contents are decoded to plain text before mounted as a file to a container inside container instance.
fileName String: The name of the file. The fileName should be unique across the volume.
path String: (Optional) Relative path for this file inside the volume mount directory. By default, the file is presented at the root of the volume mount path.

Package Details

Repository: oci pulumi/pulumi-oci
License: Apache-2.0
Notes: This Pulumi package is based on the oci Terraform Provider.

Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi

pulumi/pulumi-oci

oci.ContainerInstances.getContainerInstance

On this page

On this page

Example Usage

Using getContainerInstance

getContainerInstance Result

Supporting Types

GetContainerInstanceContainer

GetContainerInstanceContainerHealthCheck

GetContainerInstanceContainerHealthCheckHeader

GetContainerInstanceContainerResourceConfig

GetContainerInstanceContainerSecurityContext

GetContainerInstanceContainerSecurityContextCapability

GetContainerInstanceContainerVolumeMount

GetContainerInstanceDnsConfig

GetContainerInstanceImagePullSecret

GetContainerInstanceShapeConfig

GetContainerInstanceVnic

GetContainerInstanceVolume

GetContainerInstanceVolumeConfig

Package Details

On this page

On this page