Docs Home
Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi
oci.ContainerEngine.ContainerInstance
Explore with Pulumi AI
This resource provides the Container Instance resource in Oracle Cloud Infrastructure Container Instances service.
Creates a container instance and deploys the containers on it.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testContainerInstance = new oci.containerengine.ContainerInstance("test_container_instance", {
availabilityDomain: containerInstanceAvailabilityDomain,
compartmentId: compartmentId,
containers: [{
imageUrl: containerInstanceContainersImageUrl,
arguments: containerInstanceContainersArguments,
commands: containerInstanceContainersCommand,
definedTags: containerInstanceContainersDefinedTags,
displayName: containerInstanceContainersDisplayName,
environmentVariables: containerInstanceContainersEnvironmentVariables,
freeformTags: containerInstanceContainersFreeformTags,
healthChecks: [{
healthCheckType: containerInstanceContainersHealthChecksHealthCheckType,
failureAction: containerInstanceContainersHealthChecksFailureAction,
failureThreshold: containerInstanceContainersHealthChecksFailureThreshold,
headers: [{
name: containerInstanceContainersHealthChecksHeadersName,
value: containerInstanceContainersHealthChecksHeadersValue,
}],
initialDelayInSeconds: containerInstanceContainersHealthChecksInitialDelayInSeconds,
intervalInSeconds: containerInstanceContainersHealthChecksIntervalInSeconds,
name: containerInstanceContainersHealthChecksName,
path: containerInstanceContainersHealthChecksPath,
port: containerInstanceContainersHealthChecksPort,
successThreshold: containerInstanceContainersHealthChecksSuccessThreshold,
timeoutInSeconds: containerInstanceContainersHealthChecksTimeoutInSeconds,
}],
isResourcePrincipalDisabled: containerInstanceContainersIsResourcePrincipalDisabled,
resourceConfig: {
memoryLimitInGbs: containerInstanceContainersResourceConfigMemoryLimitInGbs,
vcpusLimit: containerInstanceContainersResourceConfigVcpusLimit,
},
securityContext: {
capabilities: {
addCapabilities: containerInstanceContainersSecurityContextCapabilitiesAddCapabilities,
dropCapabilities: containerInstanceContainersSecurityContextCapabilitiesDropCapabilities,
},
isNonRootUserCheckEnabled: containerInstanceContainersSecurityContextIsNonRootUserCheckEnabled,
isRootFileSystemReadonly: containerInstanceContainersSecurityContextIsRootFileSystemReadonly,
runAsGroup: containerInstanceContainersSecurityContextRunAsGroup,
runAsUser: containerInstanceContainersSecurityContextRunAsUser,
securityContextType: containerInstanceContainersSecurityContextSecurityContextType,
},
volumeMounts: [{
mountPath: containerInstanceContainersVolumeMountsMountPath,
volumeName: containerInstanceContainersVolumeMountsVolumeName,
isReadOnly: containerInstanceContainersVolumeMountsIsReadOnly,
partition: containerInstanceContainersVolumeMountsPartition,
subPath: containerInstanceContainersVolumeMountsSubPath,
}],
workingDirectory: containerInstanceContainersWorkingDirectory,
}],
shape: containerInstanceShape,
shapeConfig: {
ocpus: containerInstanceShapeConfigOcpus,
memoryInGbs: containerInstanceShapeConfigMemoryInGbs,
},
vnics: [{
subnetId: testSubnet.id,
definedTags: containerInstanceVnicsDefinedTags,
displayName: containerInstanceVnicsDisplayName,
freeformTags: containerInstanceVnicsFreeformTags,
hostnameLabel: containerInstanceVnicsHostnameLabel,
isPublicIpAssigned: containerInstanceVnicsIsPublicIpAssigned,
nsgIds: containerInstanceVnicsNsgIds,
privateIp: containerInstanceVnicsPrivateIp,
skipSourceDestCheck: containerInstanceVnicsSkipSourceDestCheck,
}],
containerRestartPolicy: containerInstanceContainerRestartPolicy,
definedTags: {
"foo-namespace.bar-key": "value",
},
displayName: containerInstanceDisplayName,
dnsConfig: {
nameservers: containerInstanceDnsConfigNameservers,
options: containerInstanceDnsConfigOptions,
searches: containerInstanceDnsConfigSearches,
},
faultDomain: containerInstanceFaultDomain,
freeformTags: {
"bar-key": "value",
},
gracefulShutdownTimeoutInSeconds: containerInstanceGracefulShutdownTimeoutInSeconds,
imagePullSecrets: [{
registryEndpoint: containerInstanceImagePullSecretsRegistryEndpoint,
secretType: containerInstanceImagePullSecretsSecretType,
password: containerInstanceImagePullSecretsPassword,
secretId: testSecret.id,
username: containerInstanceImagePullSecretsUsername,
}],
volumes: [{
name: containerInstanceVolumesName,
volumeType: containerInstanceVolumesVolumeType,
backingStore: containerInstanceVolumesBackingStore,
configs: [{
data: containerInstanceVolumesConfigsData,
fileName: containerInstanceVolumesConfigsFileName,
path: containerInstanceVolumesConfigsPath,
}],
}],
});
import pulumi
import pulumi_oci as oci
test_container_instance = oci.container_engine.ContainerInstance("test_container_instance",
availability_domain=container_instance_availability_domain,
compartment_id=compartment_id,
containers=[{
"image_url": container_instance_containers_image_url,
"arguments": container_instance_containers_arguments,
"commands": container_instance_containers_command,
"defined_tags": container_instance_containers_defined_tags,
"display_name": container_instance_containers_display_name,
"environment_variables": container_instance_containers_environment_variables,
"freeform_tags": container_instance_containers_freeform_tags,
"health_checks": [{
"health_check_type": container_instance_containers_health_checks_health_check_type,
"failure_action": container_instance_containers_health_checks_failure_action,
"failure_threshold": container_instance_containers_health_checks_failure_threshold,
"headers": [{
"name": container_instance_containers_health_checks_headers_name,
"value": container_instance_containers_health_checks_headers_value,
}],
"initial_delay_in_seconds": container_instance_containers_health_checks_initial_delay_in_seconds,
"interval_in_seconds": container_instance_containers_health_checks_interval_in_seconds,
"name": container_instance_containers_health_checks_name,
"path": container_instance_containers_health_checks_path,
"port": container_instance_containers_health_checks_port,
"success_threshold": container_instance_containers_health_checks_success_threshold,
"timeout_in_seconds": container_instance_containers_health_checks_timeout_in_seconds,
}],
"is_resource_principal_disabled": container_instance_containers_is_resource_principal_disabled,
"resource_config": {
"memory_limit_in_gbs": container_instance_containers_resource_config_memory_limit_in_gbs,
"vcpus_limit": container_instance_containers_resource_config_vcpus_limit,
},
"security_context": {
"capabilities": {
"add_capabilities": container_instance_containers_security_context_capabilities_add_capabilities,
"drop_capabilities": container_instance_containers_security_context_capabilities_drop_capabilities,
},
"is_non_root_user_check_enabled": container_instance_containers_security_context_is_non_root_user_check_enabled,
"is_root_file_system_readonly": container_instance_containers_security_context_is_root_file_system_readonly,
"run_as_group": container_instance_containers_security_context_run_as_group,
"run_as_user": container_instance_containers_security_context_run_as_user,
"security_context_type": container_instance_containers_security_context_security_context_type,
},
"volume_mounts": [{
"mount_path": container_instance_containers_volume_mounts_mount_path,
"volume_name": container_instance_containers_volume_mounts_volume_name,
"is_read_only": container_instance_containers_volume_mounts_is_read_only,
"partition": container_instance_containers_volume_mounts_partition,
"sub_path": container_instance_containers_volume_mounts_sub_path,
}],
"working_directory": container_instance_containers_working_directory,
}],
shape=container_instance_shape,
shape_config={
"ocpus": container_instance_shape_config_ocpus,
"memory_in_gbs": container_instance_shape_config_memory_in_gbs,
},
vnics=[{
"subnet_id": test_subnet["id"],
"defined_tags": container_instance_vnics_defined_tags,
"display_name": container_instance_vnics_display_name,
"freeform_tags": container_instance_vnics_freeform_tags,
"hostname_label": container_instance_vnics_hostname_label,
"is_public_ip_assigned": container_instance_vnics_is_public_ip_assigned,
"nsg_ids": container_instance_vnics_nsg_ids,
"private_ip": container_instance_vnics_private_ip,
"skip_source_dest_check": container_instance_vnics_skip_source_dest_check,
}],
container_restart_policy=container_instance_container_restart_policy,
defined_tags={
"foo-namespace.bar-key": "value",
},
display_name=container_instance_display_name,
dns_config={
"nameservers": container_instance_dns_config_nameservers,
"options": container_instance_dns_config_options,
"searches": container_instance_dns_config_searches,
},
fault_domain=container_instance_fault_domain,
freeform_tags={
"bar-key": "value",
},
graceful_shutdown_timeout_in_seconds=container_instance_graceful_shutdown_timeout_in_seconds,
image_pull_secrets=[{
"registry_endpoint": container_instance_image_pull_secrets_registry_endpoint,
"secret_type": container_instance_image_pull_secrets_secret_type,
"password": container_instance_image_pull_secrets_password,
"secret_id": test_secret["id"],
"username": container_instance_image_pull_secrets_username,
}],
volumes=[{
"name": container_instance_volumes_name,
"volume_type": container_instance_volumes_volume_type,
"backing_store": container_instance_volumes_backing_store,
"configs": [{
"data": container_instance_volumes_configs_data,
"file_name": container_instance_volumes_configs_file_name,
"path": container_instance_volumes_configs_path,
}],
}])
package main
import (
"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/containerengine"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := containerengine.NewContainerInstance(ctx, "test_container_instance", &containerengine.ContainerInstanceArgs{
AvailabilityDomain: pulumi.Any(containerInstanceAvailabilityDomain),
CompartmentId: pulumi.Any(compartmentId),
Containers: containerengine.ContainerInstanceContainerArray{
&containerengine.ContainerInstanceContainerArgs{
ImageUrl: pulumi.Any(containerInstanceContainersImageUrl),
Arguments: pulumi.Any(containerInstanceContainersArguments),
Commands: pulumi.Any(containerInstanceContainersCommand),
DefinedTags: pulumi.Any(containerInstanceContainersDefinedTags),
DisplayName: pulumi.Any(containerInstanceContainersDisplayName),
EnvironmentVariables: pulumi.Any(containerInstanceContainersEnvironmentVariables),
FreeformTags: pulumi.Any(containerInstanceContainersFreeformTags),
HealthChecks: containerengine.ContainerInstanceContainerHealthCheckArray{
&containerengine.ContainerInstanceContainerHealthCheckArgs{
HealthCheckType: pulumi.Any(containerInstanceContainersHealthChecksHealthCheckType),
FailureAction: pulumi.Any(containerInstanceContainersHealthChecksFailureAction),
FailureThreshold: pulumi.Any(containerInstanceContainersHealthChecksFailureThreshold),
Headers: containerengine.ContainerInstanceContainerHealthCheckHeaderArray{
&containerengine.ContainerInstanceContainerHealthCheckHeaderArgs{
Name: pulumi.Any(containerInstanceContainersHealthChecksHeadersName),
Value: pulumi.Any(containerInstanceContainersHealthChecksHeadersValue),
},
},
InitialDelayInSeconds: pulumi.Any(containerInstanceContainersHealthChecksInitialDelayInSeconds),
IntervalInSeconds: pulumi.Any(containerInstanceContainersHealthChecksIntervalInSeconds),
Name: pulumi.Any(containerInstanceContainersHealthChecksName),
Path: pulumi.Any(containerInstanceContainersHealthChecksPath),
Port: pulumi.Any(containerInstanceContainersHealthChecksPort),
SuccessThreshold: pulumi.Any(containerInstanceContainersHealthChecksSuccessThreshold),
TimeoutInSeconds: pulumi.Any(containerInstanceContainersHealthChecksTimeoutInSeconds),
},
},
IsResourcePrincipalDisabled: pulumi.Any(containerInstanceContainersIsResourcePrincipalDisabled),
ResourceConfig: &containerengine.ContainerInstanceContainerResourceConfigArgs{
MemoryLimitInGbs: pulumi.Any(containerInstanceContainersResourceConfigMemoryLimitInGbs),
VcpusLimit: pulumi.Any(containerInstanceContainersResourceConfigVcpusLimit),
},
SecurityContext: &containerengine.ContainerInstanceContainerSecurityContextArgs{
Capabilities: &containerengine.ContainerInstanceContainerSecurityContextCapabilitiesArgs{
AddCapabilities: pulumi.Any(containerInstanceContainersSecurityContextCapabilitiesAddCapabilities),
DropCapabilities: pulumi.Any(containerInstanceContainersSecurityContextCapabilitiesDropCapabilities),
},
IsNonRootUserCheckEnabled: pulumi.Any(containerInstanceContainersSecurityContextIsNonRootUserCheckEnabled),
IsRootFileSystemReadonly: pulumi.Any(containerInstanceContainersSecurityContextIsRootFileSystemReadonly),
RunAsGroup: pulumi.Any(containerInstanceContainersSecurityContextRunAsGroup),
RunAsUser: pulumi.Any(containerInstanceContainersSecurityContextRunAsUser),
SecurityContextType: pulumi.Any(containerInstanceContainersSecurityContextSecurityContextType),
},
VolumeMounts: containerengine.ContainerInstanceContainerVolumeMountArray{
&containerengine.ContainerInstanceContainerVolumeMountArgs{
MountPath: pulumi.Any(containerInstanceContainersVolumeMountsMountPath),
VolumeName: pulumi.Any(containerInstanceContainersVolumeMountsVolumeName),
IsReadOnly: pulumi.Any(containerInstanceContainersVolumeMountsIsReadOnly),
Partition: pulumi.Any(containerInstanceContainersVolumeMountsPartition),
SubPath: pulumi.Any(containerInstanceContainersVolumeMountsSubPath),
},
},
WorkingDirectory: pulumi.Any(containerInstanceContainersWorkingDirectory),
},
},
Shape: pulumi.Any(containerInstanceShape),
ShapeConfig: &containerengine.ContainerInstanceShapeConfigArgs{
Ocpus: pulumi.Any(containerInstanceShapeConfigOcpus),
MemoryInGbs: pulumi.Any(containerInstanceShapeConfigMemoryInGbs),
},
Vnics: containerengine.ContainerInstanceVnicArray{
&containerengine.ContainerInstanceVnicArgs{
SubnetId: pulumi.Any(testSubnet.Id),
DefinedTags: pulumi.Any(containerInstanceVnicsDefinedTags),
DisplayName: pulumi.Any(containerInstanceVnicsDisplayName),
FreeformTags: pulumi.Any(containerInstanceVnicsFreeformTags),
HostnameLabel: pulumi.Any(containerInstanceVnicsHostnameLabel),
IsPublicIpAssigned: pulumi.Any(containerInstanceVnicsIsPublicIpAssigned),
NsgIds: pulumi.Any(containerInstanceVnicsNsgIds),
PrivateIp: pulumi.Any(containerInstanceVnicsPrivateIp),
SkipSourceDestCheck: pulumi.Any(containerInstanceVnicsSkipSourceDestCheck),
},
},
ContainerRestartPolicy: pulumi.Any(containerInstanceContainerRestartPolicy),
DefinedTags: pulumi.StringMap{
"foo-namespace.bar-key": pulumi.String("value"),
},
DisplayName: pulumi.Any(containerInstanceDisplayName),
DnsConfig: &containerengine.ContainerInstanceDnsConfigArgs{
Nameservers: pulumi.Any(containerInstanceDnsConfigNameservers),
Options: pulumi.Any(containerInstanceDnsConfigOptions),
Searches: pulumi.Any(containerInstanceDnsConfigSearches),
},
FaultDomain: pulumi.Any(containerInstanceFaultDomain),
FreeformTags: pulumi.StringMap{
"bar-key": pulumi.String("value"),
},
GracefulShutdownTimeoutInSeconds: pulumi.Any(containerInstanceGracefulShutdownTimeoutInSeconds),
ImagePullSecrets: containerengine.ContainerInstanceImagePullSecretArray{
&containerengine.ContainerInstanceImagePullSecretArgs{
RegistryEndpoint: pulumi.Any(containerInstanceImagePullSecretsRegistryEndpoint),
SecretType: pulumi.Any(containerInstanceImagePullSecretsSecretType),
Password: pulumi.Any(containerInstanceImagePullSecretsPassword),
SecretId: pulumi.Any(testSecret.Id),
Username: pulumi.Any(containerInstanceImagePullSecretsUsername),
},
},
Volumes: containerengine.ContainerInstanceVolumeArray{
&containerengine.ContainerInstanceVolumeArgs{
Name: pulumi.Any(containerInstanceVolumesName),
VolumeType: pulumi.Any(containerInstanceVolumesVolumeType),
BackingStore: pulumi.Any(containerInstanceVolumesBackingStore),
Configs: containerengine.ContainerInstanceVolumeConfigArray{
&containerengine.ContainerInstanceVolumeConfigArgs{
Data: pulumi.Any(containerInstanceVolumesConfigsData),
FileName: pulumi.Any(containerInstanceVolumesConfigsFileName),
Path: pulumi.Any(containerInstanceVolumesConfigsPath),
},
},
},
},
})
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 = new Oci.ContainerEngine.ContainerInstance("test_container_instance", new()
{
AvailabilityDomain = containerInstanceAvailabilityDomain,
CompartmentId = compartmentId,
Containers = new[]
{
new Oci.ContainerEngine.Inputs.ContainerInstanceContainerArgs
{
ImageUrl = containerInstanceContainersImageUrl,
Arguments = containerInstanceContainersArguments,
Commands = containerInstanceContainersCommand,
DefinedTags = containerInstanceContainersDefinedTags,
DisplayName = containerInstanceContainersDisplayName,
EnvironmentVariables = containerInstanceContainersEnvironmentVariables,
FreeformTags = containerInstanceContainersFreeformTags,
HealthChecks = new[]
{
new Oci.ContainerEngine.Inputs.ContainerInstanceContainerHealthCheckArgs
{
HealthCheckType = containerInstanceContainersHealthChecksHealthCheckType,
FailureAction = containerInstanceContainersHealthChecksFailureAction,
FailureThreshold = containerInstanceContainersHealthChecksFailureThreshold,
Headers = new[]
{
new Oci.ContainerEngine.Inputs.ContainerInstanceContainerHealthCheckHeaderArgs
{
Name = containerInstanceContainersHealthChecksHeadersName,
Value = containerInstanceContainersHealthChecksHeadersValue,
},
},
InitialDelayInSeconds = containerInstanceContainersHealthChecksInitialDelayInSeconds,
IntervalInSeconds = containerInstanceContainersHealthChecksIntervalInSeconds,
Name = containerInstanceContainersHealthChecksName,
Path = containerInstanceContainersHealthChecksPath,
Port = containerInstanceContainersHealthChecksPort,
SuccessThreshold = containerInstanceContainersHealthChecksSuccessThreshold,
TimeoutInSeconds = containerInstanceContainersHealthChecksTimeoutInSeconds,
},
},
IsResourcePrincipalDisabled = containerInstanceContainersIsResourcePrincipalDisabled,
ResourceConfig = new Oci.ContainerEngine.Inputs.ContainerInstanceContainerResourceConfigArgs
{
MemoryLimitInGbs = containerInstanceContainersResourceConfigMemoryLimitInGbs,
VcpusLimit = containerInstanceContainersResourceConfigVcpusLimit,
},
SecurityContext = new Oci.ContainerEngine.Inputs.ContainerInstanceContainerSecurityContextArgs
{
Capabilities = new Oci.ContainerEngine.Inputs.ContainerInstanceContainerSecurityContextCapabilitiesArgs
{
AddCapabilities = containerInstanceContainersSecurityContextCapabilitiesAddCapabilities,
DropCapabilities = containerInstanceContainersSecurityContextCapabilitiesDropCapabilities,
},
IsNonRootUserCheckEnabled = containerInstanceContainersSecurityContextIsNonRootUserCheckEnabled,
IsRootFileSystemReadonly = containerInstanceContainersSecurityContextIsRootFileSystemReadonly,
RunAsGroup = containerInstanceContainersSecurityContextRunAsGroup,
RunAsUser = containerInstanceContainersSecurityContextRunAsUser,
SecurityContextType = containerInstanceContainersSecurityContextSecurityContextType,
},
VolumeMounts = new[]
{
new Oci.ContainerEngine.Inputs.ContainerInstanceContainerVolumeMountArgs
{
MountPath = containerInstanceContainersVolumeMountsMountPath,
VolumeName = containerInstanceContainersVolumeMountsVolumeName,
IsReadOnly = containerInstanceContainersVolumeMountsIsReadOnly,
Partition = containerInstanceContainersVolumeMountsPartition,
SubPath = containerInstanceContainersVolumeMountsSubPath,
},
},
WorkingDirectory = containerInstanceContainersWorkingDirectory,
},
},
Shape = containerInstanceShape,
ShapeConfig = new Oci.ContainerEngine.Inputs.ContainerInstanceShapeConfigArgs
{
Ocpus = containerInstanceShapeConfigOcpus,
MemoryInGbs = containerInstanceShapeConfigMemoryInGbs,
},
Vnics = new[]
{
new Oci.ContainerEngine.Inputs.ContainerInstanceVnicArgs
{
SubnetId = testSubnet.Id,
DefinedTags = containerInstanceVnicsDefinedTags,
DisplayName = containerInstanceVnicsDisplayName,
FreeformTags = containerInstanceVnicsFreeformTags,
HostnameLabel = containerInstanceVnicsHostnameLabel,
IsPublicIpAssigned = containerInstanceVnicsIsPublicIpAssigned,
NsgIds = containerInstanceVnicsNsgIds,
PrivateIp = containerInstanceVnicsPrivateIp,
SkipSourceDestCheck = containerInstanceVnicsSkipSourceDestCheck,
},
},
ContainerRestartPolicy = containerInstanceContainerRestartPolicy,
DefinedTags =
{
{ "foo-namespace.bar-key", "value" },
},
DisplayName = containerInstanceDisplayName,
DnsConfig = new Oci.ContainerEngine.Inputs.ContainerInstanceDnsConfigArgs
{
Nameservers = containerInstanceDnsConfigNameservers,
Options = containerInstanceDnsConfigOptions,
Searches = containerInstanceDnsConfigSearches,
},
FaultDomain = containerInstanceFaultDomain,
FreeformTags =
{
{ "bar-key", "value" },
},
GracefulShutdownTimeoutInSeconds = containerInstanceGracefulShutdownTimeoutInSeconds,
ImagePullSecrets = new[]
{
new Oci.ContainerEngine.Inputs.ContainerInstanceImagePullSecretArgs
{
RegistryEndpoint = containerInstanceImagePullSecretsRegistryEndpoint,
SecretType = containerInstanceImagePullSecretsSecretType,
Password = containerInstanceImagePullSecretsPassword,
SecretId = testSecret.Id,
Username = containerInstanceImagePullSecretsUsername,
},
},
Volumes = new[]
{
new Oci.ContainerEngine.Inputs.ContainerInstanceVolumeArgs
{
Name = containerInstanceVolumesName,
VolumeType = containerInstanceVolumesVolumeType,
BackingStore = containerInstanceVolumesBackingStore,
Configs = new[]
{
new Oci.ContainerEngine.Inputs.ContainerInstanceVolumeConfigArgs
{
Data = containerInstanceVolumesConfigsData,
FileName = containerInstanceVolumesConfigsFileName,
Path = containerInstanceVolumesConfigsPath,
},
},
},
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.ContainerEngine.ContainerInstance;
import com.pulumi.oci.ContainerEngine.ContainerInstanceArgs;
import com.pulumi.oci.ContainerEngine.inputs.ContainerInstanceContainerArgs;
import com.pulumi.oci.ContainerEngine.inputs.ContainerInstanceContainerResourceConfigArgs;
import com.pulumi.oci.ContainerEngine.inputs.ContainerInstanceContainerSecurityContextArgs;
import com.pulumi.oci.ContainerEngine.inputs.ContainerInstanceContainerSecurityContextCapabilitiesArgs;
import com.pulumi.oci.ContainerEngine.inputs.ContainerInstanceShapeConfigArgs;
import com.pulumi.oci.ContainerEngine.inputs.ContainerInstanceVnicArgs;
import com.pulumi.oci.ContainerEngine.inputs.ContainerInstanceDnsConfigArgs;
import com.pulumi.oci.ContainerEngine.inputs.ContainerInstanceImagePullSecretArgs;
import com.pulumi.oci.ContainerEngine.inputs.ContainerInstanceVolumeArgs;
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 testContainerInstance = new ContainerInstance("testContainerInstance", ContainerInstanceArgs.builder()
.availabilityDomain(containerInstanceAvailabilityDomain)
.compartmentId(compartmentId)
.containers(ContainerInstanceContainerArgs.builder()
.imageUrl(containerInstanceContainersImageUrl)
.arguments(containerInstanceContainersArguments)
.commands(containerInstanceContainersCommand)
.definedTags(containerInstanceContainersDefinedTags)
.displayName(containerInstanceContainersDisplayName)
.environmentVariables(containerInstanceContainersEnvironmentVariables)
.freeformTags(containerInstanceContainersFreeformTags)
.healthChecks(ContainerInstanceContainerHealthCheckArgs.builder()
.healthCheckType(containerInstanceContainersHealthChecksHealthCheckType)
.failureAction(containerInstanceContainersHealthChecksFailureAction)
.failureThreshold(containerInstanceContainersHealthChecksFailureThreshold)
.headers(ContainerInstanceContainerHealthCheckHeaderArgs.builder()
.name(containerInstanceContainersHealthChecksHeadersName)
.value(containerInstanceContainersHealthChecksHeadersValue)
.build())
.initialDelayInSeconds(containerInstanceContainersHealthChecksInitialDelayInSeconds)
.intervalInSeconds(containerInstanceContainersHealthChecksIntervalInSeconds)
.name(containerInstanceContainersHealthChecksName)
.path(containerInstanceContainersHealthChecksPath)
.port(containerInstanceContainersHealthChecksPort)
.successThreshold(containerInstanceContainersHealthChecksSuccessThreshold)
.timeoutInSeconds(containerInstanceContainersHealthChecksTimeoutInSeconds)
.build())
.isResourcePrincipalDisabled(containerInstanceContainersIsResourcePrincipalDisabled)
.resourceConfig(ContainerInstanceContainerResourceConfigArgs.builder()
.memoryLimitInGbs(containerInstanceContainersResourceConfigMemoryLimitInGbs)
.vcpusLimit(containerInstanceContainersResourceConfigVcpusLimit)
.build())
.securityContext(ContainerInstanceContainerSecurityContextArgs.builder()
.capabilities(ContainerInstanceContainerSecurityContextCapabilitiesArgs.builder()
.addCapabilities(containerInstanceContainersSecurityContextCapabilitiesAddCapabilities)
.dropCapabilities(containerInstanceContainersSecurityContextCapabilitiesDropCapabilities)
.build())
.isNonRootUserCheckEnabled(containerInstanceContainersSecurityContextIsNonRootUserCheckEnabled)
.isRootFileSystemReadonly(containerInstanceContainersSecurityContextIsRootFileSystemReadonly)
.runAsGroup(containerInstanceContainersSecurityContextRunAsGroup)
.runAsUser(containerInstanceContainersSecurityContextRunAsUser)
.securityContextType(containerInstanceContainersSecurityContextSecurityContextType)
.build())
.volumeMounts(ContainerInstanceContainerVolumeMountArgs.builder()
.mountPath(containerInstanceContainersVolumeMountsMountPath)
.volumeName(containerInstanceContainersVolumeMountsVolumeName)
.isReadOnly(containerInstanceContainersVolumeMountsIsReadOnly)
.partition(containerInstanceContainersVolumeMountsPartition)
.subPath(containerInstanceContainersVolumeMountsSubPath)
.build())
.workingDirectory(containerInstanceContainersWorkingDirectory)
.build())
.shape(containerInstanceShape)
.shapeConfig(ContainerInstanceShapeConfigArgs.builder()
.ocpus(containerInstanceShapeConfigOcpus)
.memoryInGbs(containerInstanceShapeConfigMemoryInGbs)
.build())
.vnics(ContainerInstanceVnicArgs.builder()
.subnetId(testSubnet.id())
.definedTags(containerInstanceVnicsDefinedTags)
.displayName(containerInstanceVnicsDisplayName)
.freeformTags(containerInstanceVnicsFreeformTags)
.hostnameLabel(containerInstanceVnicsHostnameLabel)
.isPublicIpAssigned(containerInstanceVnicsIsPublicIpAssigned)
.nsgIds(containerInstanceVnicsNsgIds)
.privateIp(containerInstanceVnicsPrivateIp)
.skipSourceDestCheck(containerInstanceVnicsSkipSourceDestCheck)
.build())
.containerRestartPolicy(containerInstanceContainerRestartPolicy)
.definedTags(Map.of("foo-namespace.bar-key", "value"))
.displayName(containerInstanceDisplayName)
.dnsConfig(ContainerInstanceDnsConfigArgs.builder()
.nameservers(containerInstanceDnsConfigNameservers)
.options(containerInstanceDnsConfigOptions)
.searches(containerInstanceDnsConfigSearches)
.build())
.faultDomain(containerInstanceFaultDomain)
.freeformTags(Map.of("bar-key", "value"))
.gracefulShutdownTimeoutInSeconds(containerInstanceGracefulShutdownTimeoutInSeconds)
.imagePullSecrets(ContainerInstanceImagePullSecretArgs.builder()
.registryEndpoint(containerInstanceImagePullSecretsRegistryEndpoint)
.secretType(containerInstanceImagePullSecretsSecretType)
.password(containerInstanceImagePullSecretsPassword)
.secretId(testSecret.id())
.username(containerInstanceImagePullSecretsUsername)
.build())
.volumes(ContainerInstanceVolumeArgs.builder()
.name(containerInstanceVolumesName)
.volumeType(containerInstanceVolumesVolumeType)
.backingStore(containerInstanceVolumesBackingStore)
.configs(ContainerInstanceVolumeConfigArgs.builder()
.data(containerInstanceVolumesConfigsData)
.fileName(containerInstanceVolumesConfigsFileName)
.path(containerInstanceVolumesConfigsPath)
.build())
.build())
.build());
}
}
resources:
testContainerInstance:
type: oci:ContainerEngine:ContainerInstance
name: test_container_instance
properties:
availabilityDomain: ${containerInstanceAvailabilityDomain}
compartmentId: ${compartmentId}
containers:
- imageUrl: ${containerInstanceContainersImageUrl}
arguments: ${containerInstanceContainersArguments}
commands: ${containerInstanceContainersCommand}
definedTags: ${containerInstanceContainersDefinedTags}
displayName: ${containerInstanceContainersDisplayName}
environmentVariables: ${containerInstanceContainersEnvironmentVariables}
freeformTags: ${containerInstanceContainersFreeformTags}
healthChecks:
- healthCheckType: ${containerInstanceContainersHealthChecksHealthCheckType}
failureAction: ${containerInstanceContainersHealthChecksFailureAction}
failureThreshold: ${containerInstanceContainersHealthChecksFailureThreshold}
headers:
- name: ${containerInstanceContainersHealthChecksHeadersName}
value: ${containerInstanceContainersHealthChecksHeadersValue}
initialDelayInSeconds: ${containerInstanceContainersHealthChecksInitialDelayInSeconds}
intervalInSeconds: ${containerInstanceContainersHealthChecksIntervalInSeconds}
name: ${containerInstanceContainersHealthChecksName}
path: ${containerInstanceContainersHealthChecksPath}
port: ${containerInstanceContainersHealthChecksPort}
successThreshold: ${containerInstanceContainersHealthChecksSuccessThreshold}
timeoutInSeconds: ${containerInstanceContainersHealthChecksTimeoutInSeconds}
isResourcePrincipalDisabled: ${containerInstanceContainersIsResourcePrincipalDisabled}
resourceConfig:
memoryLimitInGbs: ${containerInstanceContainersResourceConfigMemoryLimitInGbs}
vcpusLimit: ${containerInstanceContainersResourceConfigVcpusLimit}
securityContext:
capabilities:
addCapabilities: ${containerInstanceContainersSecurityContextCapabilitiesAddCapabilities}
dropCapabilities: ${containerInstanceContainersSecurityContextCapabilitiesDropCapabilities}
isNonRootUserCheckEnabled: ${containerInstanceContainersSecurityContextIsNonRootUserCheckEnabled}
isRootFileSystemReadonly: ${containerInstanceContainersSecurityContextIsRootFileSystemReadonly}
runAsGroup: ${containerInstanceContainersSecurityContextRunAsGroup}
runAsUser: ${containerInstanceContainersSecurityContextRunAsUser}
securityContextType: ${containerInstanceContainersSecurityContextSecurityContextType}
volumeMounts:
- mountPath: ${containerInstanceContainersVolumeMountsMountPath}
volumeName: ${containerInstanceContainersVolumeMountsVolumeName}
isReadOnly: ${containerInstanceContainersVolumeMountsIsReadOnly}
partition: ${containerInstanceContainersVolumeMountsPartition}
subPath: ${containerInstanceContainersVolumeMountsSubPath}
workingDirectory: ${containerInstanceContainersWorkingDirectory}
shape: ${containerInstanceShape}
shapeConfig:
ocpus: ${containerInstanceShapeConfigOcpus}
memoryInGbs: ${containerInstanceShapeConfigMemoryInGbs}
vnics:
- subnetId: ${testSubnet.id}
definedTags: ${containerInstanceVnicsDefinedTags}
displayName: ${containerInstanceVnicsDisplayName}
freeformTags: ${containerInstanceVnicsFreeformTags}
hostnameLabel: ${containerInstanceVnicsHostnameLabel}
isPublicIpAssigned: ${containerInstanceVnicsIsPublicIpAssigned}
nsgIds: ${containerInstanceVnicsNsgIds}
privateIp: ${containerInstanceVnicsPrivateIp}
skipSourceDestCheck: ${containerInstanceVnicsSkipSourceDestCheck}
containerRestartPolicy: ${containerInstanceContainerRestartPolicy}
definedTags:
foo-namespace.bar-key: value
displayName: ${containerInstanceDisplayName}
dnsConfig:
nameservers: ${containerInstanceDnsConfigNameservers}
options: ${containerInstanceDnsConfigOptions}
searches: ${containerInstanceDnsConfigSearches}
faultDomain: ${containerInstanceFaultDomain}
freeformTags:
bar-key: value
gracefulShutdownTimeoutInSeconds: ${containerInstanceGracefulShutdownTimeoutInSeconds}
imagePullSecrets:
- registryEndpoint: ${containerInstanceImagePullSecretsRegistryEndpoint}
secretType: ${containerInstanceImagePullSecretsSecretType}
password: ${containerInstanceImagePullSecretsPassword}
secretId: ${testSecret.id}
username: ${containerInstanceImagePullSecretsUsername}
volumes:
- name: ${containerInstanceVolumesName}
volumeType: ${containerInstanceVolumesVolumeType}
backingStore: ${containerInstanceVolumesBackingStore}
configs:
- data: ${containerInstanceVolumesConfigsData}
fileName: ${containerInstanceVolumesConfigsFileName}
path: ${containerInstanceVolumesConfigsPath}
Create ContainerInstance Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new ContainerInstance(name: string, args: ContainerInstanceArgs, opts?: CustomResourceOptions);@overload
def ContainerInstance(resource_name: str,
args: ContainerInstanceArgs,
opts: Optional[ResourceOptions] = None)
@overload
def ContainerInstance(resource_name: str,
opts: Optional[ResourceOptions] = None,
shape: Optional[str] = None,
compartment_id: Optional[str] = None,
vnics: Optional[Sequence[ContainerInstanceVnicArgs]] = None,
containers: Optional[Sequence[ContainerInstanceContainerArgs]] = None,
availability_domain: Optional[str] = None,
shape_config: Optional[ContainerInstanceShapeConfigArgs] = None,
defined_tags: Optional[Mapping[str, str]] = None,
fault_domain: Optional[str] = None,
freeform_tags: Optional[Mapping[str, str]] = None,
graceful_shutdown_timeout_in_seconds: Optional[str] = None,
image_pull_secrets: Optional[Sequence[ContainerInstanceImagePullSecretArgs]] = None,
dns_config: Optional[ContainerInstanceDnsConfigArgs] = None,
display_name: Optional[str] = None,
state: Optional[str] = None,
container_restart_policy: Optional[str] = None,
volumes: Optional[Sequence[ContainerInstanceVolumeArgs]] = None)func NewContainerInstance(ctx *Context, name string, args ContainerInstanceArgs, opts ...ResourceOption) (*ContainerInstance, error)public ContainerInstance(string name, ContainerInstanceArgs args, CustomResourceOptions? opts = null)
public ContainerInstance(String name, ContainerInstanceArgs args)
public ContainerInstance(String name, ContainerInstanceArgs args, CustomResourceOptions options)
type: oci:ContainerEngine:ContainerInstance
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 ContainerInstanceArgs
- 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 ContainerInstanceArgs
- 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 ContainerInstanceArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ContainerInstanceArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ContainerInstanceArgs
- 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 containerInstanceResource = new Oci.ContainerEngine.ContainerInstance("containerInstanceResource", new()
{
Shape = "string",
CompartmentId = "string",
Vnics = new[]
{
new Oci.ContainerEngine.Inputs.ContainerInstanceVnicArgs
{
SubnetId = "string",
DefinedTags =
{
{ "string", "string" },
},
DisplayName = "string",
FreeformTags =
{
{ "string", "string" },
},
HostnameLabel = "string",
IsPublicIpAssigned = false,
NsgIds = new[]
{
"string",
},
PrivateIp = "string",
SkipSourceDestCheck = false,
VnicId = "string",
},
},
Containers = new[]
{
new Oci.ContainerEngine.Inputs.ContainerInstanceContainerArgs
{
ImageUrl = "string",
HealthChecks = new[]
{
new Oci.ContainerEngine.Inputs.ContainerInstanceContainerHealthCheckArgs
{
HealthCheckType = "string",
Name = "string",
Headers = new[]
{
new Oci.ContainerEngine.Inputs.ContainerInstanceContainerHealthCheckHeaderArgs
{
Name = "string",
Value = "string",
},
},
FailureThreshold = 0,
InitialDelayInSeconds = 0,
IntervalInSeconds = 0,
FailureAction = "string",
Path = "string",
Port = 0,
Status = "string",
StatusDetails = "string",
SuccessThreshold = 0,
TimeoutInSeconds = 0,
},
},
DisplayName = "string",
CompartmentId = "string",
ContainerId = "string",
ContainerInstanceId = "string",
DefinedTags =
{
{ "string", "string" },
},
Arguments = new[]
{
"string",
},
EnvironmentVariables =
{
{ "string", "string" },
},
ExitCode = 0,
FaultDomain = "string",
Commands = new[]
{
"string",
},
FreeformTags =
{
{ "string", "string" },
},
SecurityContext = new Oci.ContainerEngine.Inputs.ContainerInstanceContainerSecurityContextArgs
{
Capabilities = new Oci.ContainerEngine.Inputs.ContainerInstanceContainerSecurityContextCapabilitiesArgs
{
AddCapabilities = new[]
{
"string",
},
DropCapabilities = new[]
{
"string",
},
},
IsNonRootUserCheckEnabled = false,
IsRootFileSystemReadonly = false,
RunAsGroup = 0,
RunAsUser = 0,
SecurityContextType = "string",
},
IsResourcePrincipalDisabled = false,
LifecycleDetails = "string",
ResourceConfig = new Oci.ContainerEngine.Inputs.ContainerInstanceContainerResourceConfigArgs
{
MemoryLimitInGbs = 0,
VcpusLimit = 0,
},
AvailabilityDomain = "string",
State = "string",
SystemTags =
{
{ "string", "string" },
},
TimeCreated = "string",
TimeTerminated = "string",
TimeUpdated = "string",
VolumeMounts = new[]
{
new Oci.ContainerEngine.Inputs.ContainerInstanceContainerVolumeMountArgs
{
MountPath = "string",
VolumeName = "string",
IsReadOnly = false,
Partition = 0,
SubPath = "string",
},
},
WorkingDirectory = "string",
},
},
AvailabilityDomain = "string",
ShapeConfig = new Oci.ContainerEngine.Inputs.ContainerInstanceShapeConfigArgs
{
Ocpus = 0,
MemoryInGbs = 0,
NetworkingBandwidthInGbps = 0,
ProcessorDescription = "string",
},
DefinedTags =
{
{ "string", "string" },
},
FaultDomain = "string",
FreeformTags =
{
{ "string", "string" },
},
GracefulShutdownTimeoutInSeconds = "string",
ImagePullSecrets = new[]
{
new Oci.ContainerEngine.Inputs.ContainerInstanceImagePullSecretArgs
{
RegistryEndpoint = "string",
SecretType = "string",
Password = "string",
SecretId = "string",
Username = "string",
},
},
DnsConfig = new Oci.ContainerEngine.Inputs.ContainerInstanceDnsConfigArgs
{
Nameservers = new[]
{
"string",
},
Options = new[]
{
"string",
},
Searches = new[]
{
"string",
},
},
DisplayName = "string",
State = "string",
ContainerRestartPolicy = "string",
Volumes = new[]
{
new Oci.ContainerEngine.Inputs.ContainerInstanceVolumeArgs
{
Name = "string",
VolumeType = "string",
BackingStore = "string",
Configs = new[]
{
new Oci.ContainerEngine.Inputs.ContainerInstanceVolumeConfigArgs
{
Data = "string",
FileName = "string",
Path = "string",
},
},
},
},
});
example, err := containerengine.NewContainerInstance(ctx, "containerInstanceResource", &containerengine.ContainerInstanceArgs{
Shape: pulumi.String("string"),
CompartmentId: pulumi.String("string"),
Vnics: containerengine.ContainerInstanceVnicArray{
&containerengine.ContainerInstanceVnicArgs{
SubnetId: pulumi.String("string"),
DefinedTags: pulumi.StringMap{
"string": pulumi.String("string"),
},
DisplayName: pulumi.String("string"),
FreeformTags: pulumi.StringMap{
"string": pulumi.String("string"),
},
HostnameLabel: pulumi.String("string"),
IsPublicIpAssigned: pulumi.Bool(false),
NsgIds: pulumi.StringArray{
pulumi.String("string"),
},
PrivateIp: pulumi.String("string"),
SkipSourceDestCheck: pulumi.Bool(false),
VnicId: pulumi.String("string"),
},
},
Containers: containerengine.ContainerInstanceContainerArray{
&containerengine.ContainerInstanceContainerArgs{
ImageUrl: pulumi.String("string"),
HealthChecks: containerengine.ContainerInstanceContainerHealthCheckArray{
&containerengine.ContainerInstanceContainerHealthCheckArgs{
HealthCheckType: pulumi.String("string"),
Name: pulumi.String("string"),
Headers: containerengine.ContainerInstanceContainerHealthCheckHeaderArray{
&containerengine.ContainerInstanceContainerHealthCheckHeaderArgs{
Name: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
FailureThreshold: pulumi.Int(0),
InitialDelayInSeconds: pulumi.Int(0),
IntervalInSeconds: pulumi.Int(0),
FailureAction: pulumi.String("string"),
Path: pulumi.String("string"),
Port: pulumi.Int(0),
Status: pulumi.String("string"),
StatusDetails: pulumi.String("string"),
SuccessThreshold: pulumi.Int(0),
TimeoutInSeconds: pulumi.Int(0),
},
},
DisplayName: pulumi.String("string"),
CompartmentId: pulumi.String("string"),
ContainerId: pulumi.String("string"),
ContainerInstanceId: pulumi.String("string"),
DefinedTags: pulumi.StringMap{
"string": pulumi.String("string"),
},
Arguments: pulumi.StringArray{
pulumi.String("string"),
},
EnvironmentVariables: pulumi.StringMap{
"string": pulumi.String("string"),
},
ExitCode: pulumi.Int(0),
FaultDomain: pulumi.String("string"),
Commands: pulumi.StringArray{
pulumi.String("string"),
},
FreeformTags: pulumi.StringMap{
"string": pulumi.String("string"),
},
SecurityContext: &containerengine.ContainerInstanceContainerSecurityContextArgs{
Capabilities: &containerengine.ContainerInstanceContainerSecurityContextCapabilitiesArgs{
AddCapabilities: pulumi.StringArray{
pulumi.String("string"),
},
DropCapabilities: pulumi.StringArray{
pulumi.String("string"),
},
},
IsNonRootUserCheckEnabled: pulumi.Bool(false),
IsRootFileSystemReadonly: pulumi.Bool(false),
RunAsGroup: pulumi.Int(0),
RunAsUser: pulumi.Int(0),
SecurityContextType: pulumi.String("string"),
},
IsResourcePrincipalDisabled: pulumi.Bool(false),
LifecycleDetails: pulumi.String("string"),
ResourceConfig: &containerengine.ContainerInstanceContainerResourceConfigArgs{
MemoryLimitInGbs: pulumi.Float64(0),
VcpusLimit: pulumi.Float64(0),
},
AvailabilityDomain: pulumi.String("string"),
State: pulumi.String("string"),
SystemTags: pulumi.StringMap{
"string": pulumi.String("string"),
},
TimeCreated: pulumi.String("string"),
TimeTerminated: pulumi.String("string"),
TimeUpdated: pulumi.String("string"),
VolumeMounts: containerengine.ContainerInstanceContainerVolumeMountArray{
&containerengine.ContainerInstanceContainerVolumeMountArgs{
MountPath: pulumi.String("string"),
VolumeName: pulumi.String("string"),
IsReadOnly: pulumi.Bool(false),
Partition: pulumi.Int(0),
SubPath: pulumi.String("string"),
},
},
WorkingDirectory: pulumi.String("string"),
},
},
AvailabilityDomain: pulumi.String("string"),
ShapeConfig: &containerengine.ContainerInstanceShapeConfigArgs{
Ocpus: pulumi.Float64(0),
MemoryInGbs: pulumi.Float64(0),
NetworkingBandwidthInGbps: pulumi.Float64(0),
ProcessorDescription: pulumi.String("string"),
},
DefinedTags: pulumi.StringMap{
"string": pulumi.String("string"),
},
FaultDomain: pulumi.String("string"),
FreeformTags: pulumi.StringMap{
"string": pulumi.String("string"),
},
GracefulShutdownTimeoutInSeconds: pulumi.String("string"),
ImagePullSecrets: containerengine.ContainerInstanceImagePullSecretArray{
&containerengine.ContainerInstanceImagePullSecretArgs{
RegistryEndpoint: pulumi.String("string"),
SecretType: pulumi.String("string"),
Password: pulumi.String("string"),
SecretId: pulumi.String("string"),
Username: pulumi.String("string"),
},
},
DnsConfig: &containerengine.ContainerInstanceDnsConfigArgs{
Nameservers: pulumi.StringArray{
pulumi.String("string"),
},
Options: pulumi.StringArray{
pulumi.String("string"),
},
Searches: pulumi.StringArray{
pulumi.String("string"),
},
},
DisplayName: pulumi.String("string"),
State: pulumi.String("string"),
ContainerRestartPolicy: pulumi.String("string"),
Volumes: containerengine.ContainerInstanceVolumeArray{
&containerengine.ContainerInstanceVolumeArgs{
Name: pulumi.String("string"),
VolumeType: pulumi.String("string"),
BackingStore: pulumi.String("string"),
Configs: containerengine.ContainerInstanceVolumeConfigArray{
&containerengine.ContainerInstanceVolumeConfigArgs{
Data: pulumi.String("string"),
FileName: pulumi.String("string"),
Path: pulumi.String("string"),
},
},
},
},
})
var containerInstanceResource = new ContainerInstance("containerInstanceResource", ContainerInstanceArgs.builder()
.shape("string")
.compartmentId("string")
.vnics(ContainerInstanceVnicArgs.builder()
.subnetId("string")
.definedTags(Map.of("string", "string"))
.displayName("string")
.freeformTags(Map.of("string", "string"))
.hostnameLabel("string")
.isPublicIpAssigned(false)
.nsgIds("string")
.privateIp("string")
.skipSourceDestCheck(false)
.vnicId("string")
.build())
.containers(ContainerInstanceContainerArgs.builder()
.imageUrl("string")
.healthChecks(ContainerInstanceContainerHealthCheckArgs.builder()
.healthCheckType("string")
.name("string")
.headers(ContainerInstanceContainerHealthCheckHeaderArgs.builder()
.name("string")
.value("string")
.build())
.failureThreshold(0)
.initialDelayInSeconds(0)
.intervalInSeconds(0)
.failureAction("string")
.path("string")
.port(0)
.status("string")
.statusDetails("string")
.successThreshold(0)
.timeoutInSeconds(0)
.build())
.displayName("string")
.compartmentId("string")
.containerId("string")
.containerInstanceId("string")
.definedTags(Map.of("string", "string"))
.arguments("string")
.environmentVariables(Map.of("string", "string"))
.exitCode(0)
.faultDomain("string")
.commands("string")
.freeformTags(Map.of("string", "string"))
.securityContext(ContainerInstanceContainerSecurityContextArgs.builder()
.capabilities(ContainerInstanceContainerSecurityContextCapabilitiesArgs.builder()
.addCapabilities("string")
.dropCapabilities("string")
.build())
.isNonRootUserCheckEnabled(false)
.isRootFileSystemReadonly(false)
.runAsGroup(0)
.runAsUser(0)
.securityContextType("string")
.build())
.isResourcePrincipalDisabled(false)
.lifecycleDetails("string")
.resourceConfig(ContainerInstanceContainerResourceConfigArgs.builder()
.memoryLimitInGbs(0.0)
.vcpusLimit(0.0)
.build())
.availabilityDomain("string")
.state("string")
.systemTags(Map.of("string", "string"))
.timeCreated("string")
.timeTerminated("string")
.timeUpdated("string")
.volumeMounts(ContainerInstanceContainerVolumeMountArgs.builder()
.mountPath("string")
.volumeName("string")
.isReadOnly(false)
.partition(0)
.subPath("string")
.build())
.workingDirectory("string")
.build())
.availabilityDomain("string")
.shapeConfig(ContainerInstanceShapeConfigArgs.builder()
.ocpus(0.0)
.memoryInGbs(0.0)
.networkingBandwidthInGbps(0.0)
.processorDescription("string")
.build())
.definedTags(Map.of("string", "string"))
.faultDomain("string")
.freeformTags(Map.of("string", "string"))
.gracefulShutdownTimeoutInSeconds("string")
.imagePullSecrets(ContainerInstanceImagePullSecretArgs.builder()
.registryEndpoint("string")
.secretType("string")
.password("string")
.secretId("string")
.username("string")
.build())
.dnsConfig(ContainerInstanceDnsConfigArgs.builder()
.nameservers("string")
.options("string")
.searches("string")
.build())
.displayName("string")
.state("string")
.containerRestartPolicy("string")
.volumes(ContainerInstanceVolumeArgs.builder()
.name("string")
.volumeType("string")
.backingStore("string")
.configs(ContainerInstanceVolumeConfigArgs.builder()
.data("string")
.fileName("string")
.path("string")
.build())
.build())
.build());
container_instance_resource = oci.container_engine.ContainerInstance("containerInstanceResource",
shape="string",
compartment_id="string",
vnics=[{
"subnet_id": "string",
"defined_tags": {
"string": "string",
},
"display_name": "string",
"freeform_tags": {
"string": "string",
},
"hostname_label": "string",
"is_public_ip_assigned": False,
"nsg_ids": ["string"],
"private_ip": "string",
"skip_source_dest_check": False,
"vnic_id": "string",
}],
containers=[{
"image_url": "string",
"health_checks": [{
"health_check_type": "string",
"name": "string",
"headers": [{
"name": "string",
"value": "string",
}],
"failure_threshold": 0,
"initial_delay_in_seconds": 0,
"interval_in_seconds": 0,
"failure_action": "string",
"path": "string",
"port": 0,
"status": "string",
"status_details": "string",
"success_threshold": 0,
"timeout_in_seconds": 0,
}],
"display_name": "string",
"compartment_id": "string",
"container_id": "string",
"container_instance_id": "string",
"defined_tags": {
"string": "string",
},
"arguments": ["string"],
"environment_variables": {
"string": "string",
},
"exit_code": 0,
"fault_domain": "string",
"commands": ["string"],
"freeform_tags": {
"string": "string",
},
"security_context": {
"capabilities": {
"add_capabilities": ["string"],
"drop_capabilities": ["string"],
},
"is_non_root_user_check_enabled": False,
"is_root_file_system_readonly": False,
"run_as_group": 0,
"run_as_user": 0,
"security_context_type": "string",
},
"is_resource_principal_disabled": False,
"lifecycle_details": "string",
"resource_config": {
"memory_limit_in_gbs": 0,
"vcpus_limit": 0,
},
"availability_domain": "string",
"state": "string",
"system_tags": {
"string": "string",
},
"time_created": "string",
"time_terminated": "string",
"time_updated": "string",
"volume_mounts": [{
"mount_path": "string",
"volume_name": "string",
"is_read_only": False,
"partition": 0,
"sub_path": "string",
}],
"working_directory": "string",
}],
availability_domain="string",
shape_config={
"ocpus": 0,
"memory_in_gbs": 0,
"networking_bandwidth_in_gbps": 0,
"processor_description": "string",
},
defined_tags={
"string": "string",
},
fault_domain="string",
freeform_tags={
"string": "string",
},
graceful_shutdown_timeout_in_seconds="string",
image_pull_secrets=[{
"registry_endpoint": "string",
"secret_type": "string",
"password": "string",
"secret_id": "string",
"username": "string",
}],
dns_config={
"nameservers": ["string"],
"options": ["string"],
"searches": ["string"],
},
display_name="string",
state="string",
container_restart_policy="string",
volumes=[{
"name": "string",
"volume_type": "string",
"backing_store": "string",
"configs": [{
"data": "string",
"file_name": "string",
"path": "string",
}],
}])
const containerInstanceResource = new oci.containerengine.ContainerInstance("containerInstanceResource", {
shape: "string",
compartmentId: "string",
vnics: [{
subnetId: "string",
definedTags: {
string: "string",
},
displayName: "string",
freeformTags: {
string: "string",
},
hostnameLabel: "string",
isPublicIpAssigned: false,
nsgIds: ["string"],
privateIp: "string",
skipSourceDestCheck: false,
vnicId: "string",
}],
containers: [{
imageUrl: "string",
healthChecks: [{
healthCheckType: "string",
name: "string",
headers: [{
name: "string",
value: "string",
}],
failureThreshold: 0,
initialDelayInSeconds: 0,
intervalInSeconds: 0,
failureAction: "string",
path: "string",
port: 0,
status: "string",
statusDetails: "string",
successThreshold: 0,
timeoutInSeconds: 0,
}],
displayName: "string",
compartmentId: "string",
containerId: "string",
containerInstanceId: "string",
definedTags: {
string: "string",
},
arguments: ["string"],
environmentVariables: {
string: "string",
},
exitCode: 0,
faultDomain: "string",
commands: ["string"],
freeformTags: {
string: "string",
},
securityContext: {
capabilities: {
addCapabilities: ["string"],
dropCapabilities: ["string"],
},
isNonRootUserCheckEnabled: false,
isRootFileSystemReadonly: false,
runAsGroup: 0,
runAsUser: 0,
securityContextType: "string",
},
isResourcePrincipalDisabled: false,
lifecycleDetails: "string",
resourceConfig: {
memoryLimitInGbs: 0,
vcpusLimit: 0,
},
availabilityDomain: "string",
state: "string",
systemTags: {
string: "string",
},
timeCreated: "string",
timeTerminated: "string",
timeUpdated: "string",
volumeMounts: [{
mountPath: "string",
volumeName: "string",
isReadOnly: false,
partition: 0,
subPath: "string",
}],
workingDirectory: "string",
}],
availabilityDomain: "string",
shapeConfig: {
ocpus: 0,
memoryInGbs: 0,
networkingBandwidthInGbps: 0,
processorDescription: "string",
},
definedTags: {
string: "string",
},
faultDomain: "string",
freeformTags: {
string: "string",
},
gracefulShutdownTimeoutInSeconds: "string",
imagePullSecrets: [{
registryEndpoint: "string",
secretType: "string",
password: "string",
secretId: "string",
username: "string",
}],
dnsConfig: {
nameservers: ["string"],
options: ["string"],
searches: ["string"],
},
displayName: "string",
state: "string",
containerRestartPolicy: "string",
volumes: [{
name: "string",
volumeType: "string",
backingStore: "string",
configs: [{
data: "string",
fileName: "string",
path: "string",
}],
}],
});
type: oci:ContainerEngine:ContainerInstance
properties:
availabilityDomain: string
compartmentId: string
containerRestartPolicy: string
containers:
- arguments:
- string
availabilityDomain: string
commands:
- string
compartmentId: string
containerId: string
containerInstanceId: string
definedTags:
string: string
displayName: string
environmentVariables:
string: string
exitCode: 0
faultDomain: string
freeformTags:
string: string
healthChecks:
- failureAction: string
failureThreshold: 0
headers:
- name: string
value: string
healthCheckType: string
initialDelayInSeconds: 0
intervalInSeconds: 0
name: string
path: string
port: 0
status: string
statusDetails: string
successThreshold: 0
timeoutInSeconds: 0
imageUrl: string
isResourcePrincipalDisabled: false
lifecycleDetails: string
resourceConfig:
memoryLimitInGbs: 0
vcpusLimit: 0
securityContext:
capabilities:
addCapabilities:
- string
dropCapabilities:
- string
isNonRootUserCheckEnabled: false
isRootFileSystemReadonly: false
runAsGroup: 0
runAsUser: 0
securityContextType: string
state: string
systemTags:
string: string
timeCreated: string
timeTerminated: string
timeUpdated: string
volumeMounts:
- isReadOnly: false
mountPath: string
partition: 0
subPath: string
volumeName: string
workingDirectory: string
definedTags:
string: string
displayName: string
dnsConfig:
nameservers:
- string
options:
- string
searches:
- string
faultDomain: string
freeformTags:
string: string
gracefulShutdownTimeoutInSeconds: string
imagePullSecrets:
- password: string
registryEndpoint: string
secretId: string
secretType: string
username: string
shape: string
shapeConfig:
memoryInGbs: 0
networkingBandwidthInGbps: 0
ocpus: 0
processorDescription: string
state: string
vnics:
- definedTags:
string: string
displayName: string
freeformTags:
string: string
hostnameLabel: string
isPublicIpAssigned: false
nsgIds:
- string
privateIp: string
skipSourceDestCheck: false
subnetId: string
vnicId: string
volumes:
- backingStore: string
configs:
- data: string
fileName: string
path: string
name: string
volumeType: string
ContainerInstance 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 ContainerInstance resource accepts the following input properties:
- Availability
Domain string - The availability domain where the container instance runs.
- Compartment
Id string - (Updatable) The compartment OCID.
- Containers
List<Container
Instance Container> - The containers to create on this container instance.
- Shape string
- The shape of the container instance. The shape determines the resources available to the container instance.
- Shape
Config ContainerInstance Shape Config - The size and amount of resources available to the container instance.
- Vnics
List<Container
Instance Vnic> - The networks available to containers on this container instance.
- Container
Restart stringPolicy - Container restart policy
- Dictionary<string, string>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}. - Display
Name string - (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. If you don't provide a name, a name is generated automatically.
- Dns
Config ContainerInstance Dns Config - Allow customers to define DNS settings for containers. If this is not provided, the containers use the default DNS settings of the subnet.
- Fault
Domain string - The fault domain where the container instance runs.
- 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"} - Graceful
Shutdown stringTimeout In Seconds - 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.
- Image
Pull List<ContainerSecrets Instance Image Pull Secret> - The image pulls secrets so you can access private registry to pull container images.
- State string
(Updatable) The target state for the Container Instance. Could be set to
ACTIVEorINACTIVE.** 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
- Volumes
List<Container
Instance Volume> A volume is a directory with data that is accessible across multiple containers in a container instance.
You can attach up to 32 volumes to single container instance.
- Availability
Domain string - The availability domain where the container instance runs.
- Compartment
Id string - (Updatable) The compartment OCID.
- Containers
[]Container
Instance Container Args - The containers to create on this container instance.
- Shape string
- The shape of the container instance. The shape determines the resources available to the container instance.
- Shape
Config ContainerInstance Shape Config Args - The size and amount of resources available to the container instance.
- Vnics
[]Container
Instance Vnic Args - The networks available to containers on this container instance.
- Container
Restart stringPolicy - Container restart policy
- map[string]string
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}. - Display
Name string - (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. If you don't provide a name, a name is generated automatically.
- Dns
Config ContainerInstance Dns Config Args - Allow customers to define DNS settings for containers. If this is not provided, the containers use the default DNS settings of the subnet.
- Fault
Domain string - The fault domain where the container instance runs.
- 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"} - Graceful
Shutdown stringTimeout In Seconds - 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.
- Image
Pull []ContainerSecrets Instance Image Pull Secret Args - The image pulls secrets so you can access private registry to pull container images.
- State string
(Updatable) The target state for the Container Instance. Could be set to
ACTIVEorINACTIVE.** 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
- Volumes
[]Container
Instance Volume Args A volume is a directory with data that is accessible across multiple containers in a container instance.
You can attach up to 32 volumes to single container instance.
- availability
Domain String - The availability domain where the container instance runs.
- compartment
Id String - (Updatable) The compartment OCID.
- containers
List<Container
Instance Container> - The containers to create on this container instance.
- shape String
- The shape of the container instance. The shape determines the resources available to the container instance.
- shape
Config ContainerInstance Shape Config - The size and amount of resources available to the container instance.
- vnics
List<Container
Instance Vnic> - The networks available to containers on this container instance.
- container
Restart StringPolicy - Container restart policy
- Map<String,String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}. - display
Name String - (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. If you don't provide a name, a name is generated automatically.
- dns
Config ContainerInstance Dns Config - Allow customers to define DNS settings for containers. If this is not provided, the containers use the default DNS settings of the subnet.
- fault
Domain String - The fault domain where the container instance runs.
- 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"} - graceful
Shutdown StringTimeout In Seconds - 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.
- image
Pull List<ContainerSecrets Instance Image Pull Secret> - The image pulls secrets so you can access private registry to pull container images.
- state String
(Updatable) The target state for the Container Instance. Could be set to
ACTIVEorINACTIVE.** 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
- volumes
List<Container
Instance Volume> A volume is a directory with data that is accessible across multiple containers in a container instance.
You can attach up to 32 volumes to single container instance.
- availability
Domain string - The availability domain where the container instance runs.
- compartment
Id string - (Updatable) The compartment OCID.
- containers
Container
Instance Container[] - The containers to create on this container instance.
- shape string
- The shape of the container instance. The shape determines the resources available to the container instance.
- shape
Config ContainerInstance Shape Config - The size and amount of resources available to the container instance.
- vnics
Container
Instance Vnic[] - The networks available to containers on this container instance.
- container
Restart stringPolicy - Container restart policy
- {[key: string]: string}
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}. - display
Name string - (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. If you don't provide a name, a name is generated automatically.
- dns
Config ContainerInstance Dns Config - Allow customers to define DNS settings for containers. If this is not provided, the containers use the default DNS settings of the subnet.
- fault
Domain string - The fault domain where the container instance runs.
- {[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"} - graceful
Shutdown stringTimeout In Seconds - 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.
- image
Pull ContainerSecrets Instance Image Pull Secret[] - The image pulls secrets so you can access private registry to pull container images.
- state string
(Updatable) The target state for the Container Instance. Could be set to
ACTIVEorINACTIVE.** 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
- volumes
Container
Instance Volume[] A volume is a directory with data that is accessible across multiple containers in a container instance.
You can attach up to 32 volumes to single container instance.
- availability_
domain str - The availability domain where the container instance runs.
- compartment_
id str - (Updatable) The compartment OCID.
- containers
Sequence[Container
Instance Container Args] - The containers to create on this container instance.
- shape str
- The shape of the container instance. The shape determines the resources available to the container instance.
- shape_
config ContainerInstance Shape Config Args - The size and amount of resources available to the container instance.
- vnics
Sequence[Container
Instance Vnic Args] - The networks available to containers on this container instance.
- container_
restart_ strpolicy - Container restart policy
- Mapping[str, str]
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}. - display_
name str - (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. If you don't provide a name, a name is generated automatically.
- dns_
config ContainerInstance Dns Config Args - Allow customers to define DNS settings for containers. If this is not provided, the containers use the default DNS settings of the subnet.
- fault_
domain str - The fault domain where the container instance runs.
- 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"} - graceful_
shutdown_ strtimeout_ in_ seconds - 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.
- image_
pull_ Sequence[Containersecrets Instance Image Pull Secret Args] - The image pulls secrets so you can access private registry to pull container images.
- state str
(Updatable) The target state for the Container Instance. Could be set to
ACTIVEorINACTIVE.** 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
- volumes
Sequence[Container
Instance Volume Args] A volume is a directory with data that is accessible across multiple containers in a container instance.
You can attach up to 32 volumes to single container instance.
- availability
Domain String - The availability domain where the container instance runs.
- compartment
Id String - (Updatable) The compartment OCID.
- containers List<Property Map>
- The containers to create on this container instance.
- shape String
- The shape of the container instance. The shape determines the resources available to the container instance.
- shape
Config Property Map - The size and amount of resources available to the container instance.
- vnics List<Property Map>
- The networks available to containers on this container instance.
- container
Restart StringPolicy - Container restart policy
- Map<String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}. - display
Name String - (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. If you don't provide a name, a name is generated automatically.
- dns
Config Property Map - Allow customers to define DNS settings for containers. If this is not provided, the containers use the default DNS settings of the subnet.
- fault
Domain String - The fault domain where the container instance runs.
- 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"} - graceful
Shutdown StringTimeout In Seconds - 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.
- image
Pull List<Property Map>Secrets - The image pulls secrets so you can access private registry to pull container images.
- state String
(Updatable) The target state for the Container Instance. Could be set to
ACTIVEorINACTIVE.** 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
- volumes List<Property Map>
A volume is a directory with data that is accessible across multiple containers in a container instance.
You can attach up to 32 volumes to single container instance.
Outputs
All input properties are implicitly available as output properties. Additionally, the ContainerInstance resource produces the following output properties:
- Container
Count int - The number of containers on the container instance.
- Id string
- The provider-assigned unique ID for this managed resource.
- Lifecycle
Details string - A message that describes the current state of the container in more detail. Can be used to provide actionable information.
- Dictionary<string, string>
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"}. - Time
Created string - The time the container instance was created, in the format defined by RFC 3339.
- Time
Updated string - The time the container instance was updated, in the format defined by RFC 3339.
- Volume
Count int - The number of volumes that are attached to the container instance.
- Container
Count int - The number of containers on the container instance.
- Id string
- The provider-assigned unique ID for this managed resource.
- Lifecycle
Details string - A message that describes the current state of the container in more detail. Can be used to provide actionable information.
- map[string]string
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"}. - Time
Created string - The time the container instance was created, in the format defined by RFC 3339.
- Time
Updated string - The time the container instance was updated, in the format defined by RFC 3339.
- Volume
Count int - The number of volumes that are attached to the container instance.
- container
Count Integer - The number of containers on the container instance.
- id String
- The provider-assigned unique ID for this managed resource.
- lifecycle
Details String - A message that describes the current state of the container in more detail. Can be used to provide actionable information.
- Map<String,String>
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"}. - time
Created String - The time the container instance was created, in the format defined by RFC 3339.
- time
Updated String - The time the container instance was updated, in the format defined by RFC 3339.
- volume
Count Integer - The number of volumes that are attached to the container instance.
- container
Count number - The number of containers on the container instance.
- id string
- The provider-assigned unique ID for this managed resource.
- lifecycle
Details string - A message that describes the current state of the container in more detail. Can be used to provide actionable information.
- {[key: string]: string}
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"}. - time
Created string - The time the container instance was created, in the format defined by RFC 3339.
- time
Updated string - The time the container instance was updated, in the format defined by RFC 3339.
- volume
Count number - The number of volumes that are attached to the container instance.
- container_
count int - The number of containers on the container instance.
- id str
- The provider-assigned unique ID for this managed resource.
- lifecycle_
details str - A message that describes the current state of the container in more detail. Can be used to provide actionable information.
- 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.
- volume_
count int - The number of volumes that are attached to the container instance.
- container
Count Number - The number of containers on the container instance.
- id String
- The provider-assigned unique ID for this managed resource.
- lifecycle
Details String - A message that describes the current state of the container in more detail. Can be used to provide actionable information.
- Map<String>
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"}. - time
Created String - The time the container instance was created, in the format defined by RFC 3339.
- time
Updated String - The time the container instance was updated, in the format defined by RFC 3339.
- volume
Count Number - The number of volumes that are attached to the container instance.
Look up Existing ContainerInstance Resource
Get an existing ContainerInstance 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?: ContainerInstanceState, opts?: CustomResourceOptions): ContainerInstance@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
availability_domain: Optional[str] = None,
compartment_id: Optional[str] = None,
container_count: Optional[int] = None,
container_restart_policy: Optional[str] = None,
containers: Optional[Sequence[ContainerInstanceContainerArgs]] = None,
defined_tags: Optional[Mapping[str, str]] = None,
display_name: Optional[str] = None,
dns_config: Optional[ContainerInstanceDnsConfigArgs] = None,
fault_domain: Optional[str] = None,
freeform_tags: Optional[Mapping[str, str]] = None,
graceful_shutdown_timeout_in_seconds: Optional[str] = None,
image_pull_secrets: Optional[Sequence[ContainerInstanceImagePullSecretArgs]] = None,
lifecycle_details: Optional[str] = None,
shape: Optional[str] = None,
shape_config: Optional[ContainerInstanceShapeConfigArgs] = None,
state: Optional[str] = None,
system_tags: Optional[Mapping[str, str]] = None,
time_created: Optional[str] = None,
time_updated: Optional[str] = None,
vnics: Optional[Sequence[ContainerInstanceVnicArgs]] = None,
volume_count: Optional[int] = None,
volumes: Optional[Sequence[ContainerInstanceVolumeArgs]] = None) -> ContainerInstancefunc GetContainerInstance(ctx *Context, name string, id IDInput, state *ContainerInstanceState, opts ...ResourceOption) (*ContainerInstance, error)public static ContainerInstance Get(string name, Input<string> id, ContainerInstanceState? state, CustomResourceOptions? opts = null)public static ContainerInstance get(String name, Output<String> id, ContainerInstanceState state, CustomResourceOptions options)resources: _: type: oci:ContainerEngine:ContainerInstance 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.
- Availability
Domain string - The availability domain where the container instance runs.
- Compartment
Id string - (Updatable) The compartment OCID.
- Container
Count int - The number of containers on the container instance.
- Container
Restart stringPolicy - Container restart policy
- Containers
List<Container
Instance Container> - The containers to create on this container instance.
- Dictionary<string, string>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}. - Display
Name string - (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. If you don't provide a name, a name is generated automatically.
- Dns
Config ContainerInstance Dns Config - Allow customers to define DNS settings for containers. If this is not provided, the containers use the default DNS settings of the subnet.
- Fault
Domain string - The fault domain where the container instance runs.
- 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"} - Graceful
Shutdown stringTimeout In Seconds - 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.
- Image
Pull List<ContainerSecrets Instance Image Pull Secret> - The image pulls secrets so you can access private registry to pull container images.
- Lifecycle
Details 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 resources available to the container instance.
- Shape
Config ContainerInstance Shape Config - The size and amount of resources available to the container instance.
- State string
(Updatable) The target state for the Container Instance. Could be set to
ACTIVEorINACTIVE.** 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
- Dictionary<string, string>
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"}. - Time
Created string - The time the container instance was created, in the format defined by RFC 3339.
- Time
Updated string - The time the container instance was updated, in the format defined by RFC 3339.
- Vnics
List<Container
Instance Vnic> - The networks available to containers on this container instance.
- Volume
Count int - The number of volumes that are attached to the container instance.
- Volumes
List<Container
Instance Volume> A volume is a directory with data that is accessible across multiple containers in a container instance.
You can attach up to 32 volumes to single container instance.
- Availability
Domain string - The availability domain where the container instance runs.
- Compartment
Id string - (Updatable) The compartment OCID.
- Container
Count int - The number of containers on the container instance.
- Container
Restart stringPolicy - Container restart policy
- Containers
[]Container
Instance Container Args - The containers to create on this container instance.
- map[string]string
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}. - Display
Name string - (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. If you don't provide a name, a name is generated automatically.
- Dns
Config ContainerInstance Dns Config Args - Allow customers to define DNS settings for containers. If this is not provided, the containers use the default DNS settings of the subnet.
- Fault
Domain string - The fault domain where the container instance runs.
- 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"} - Graceful
Shutdown stringTimeout In Seconds - 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.
- Image
Pull []ContainerSecrets Instance Image Pull Secret Args - The image pulls secrets so you can access private registry to pull container images.
- Lifecycle
Details 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 resources available to the container instance.
- Shape
Config ContainerInstance Shape Config Args - The size and amount of resources available to the container instance.
- State string
(Updatable) The target state for the Container Instance. Could be set to
ACTIVEorINACTIVE.** 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
- map[string]string
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"}. - Time
Created string - The time the container instance was created, in the format defined by RFC 3339.
- Time
Updated string - The time the container instance was updated, in the format defined by RFC 3339.
- Vnics
[]Container
Instance Vnic Args - The networks available to containers on this container instance.
- Volume
Count int - The number of volumes that are attached to the container instance.
- Volumes
[]Container
Instance Volume Args A volume is a directory with data that is accessible across multiple containers in a container instance.
You can attach up to 32 volumes to single container instance.
- availability
Domain String - The availability domain where the container instance runs.
- compartment
Id String - (Updatable) The compartment OCID.
- container
Count Integer - The number of containers on the container instance.
- container
Restart StringPolicy - Container restart policy
- containers
List<Container
Instance Container> - The containers to create on this container instance.
- Map<String,String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}. - display
Name String - (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. If you don't provide a name, a name is generated automatically.
- dns
Config ContainerInstance Dns Config - Allow customers to define DNS settings for containers. If this is not provided, the containers use the default DNS settings of the subnet.
- fault
Domain String - The fault domain where the container instance runs.
- 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"} - graceful
Shutdown StringTimeout In Seconds - 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.
- image
Pull List<ContainerSecrets Instance Image Pull Secret> - The image pulls secrets so you can access private registry to pull container images.
- lifecycle
Details 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 resources available to the container instance.
- shape
Config ContainerInstance Shape Config - The size and amount of resources available to the container instance.
- state String
(Updatable) The target state for the Container Instance. Could be set to
ACTIVEorINACTIVE.** 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
- Map<String,String>
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"}. - time
Created String - The time the container instance was created, in the format defined by RFC 3339.
- time
Updated String - The time the container instance was updated, in the format defined by RFC 3339.
- vnics
List<Container
Instance Vnic> - The networks available to containers on this container instance.
- volume
Count Integer - The number of volumes that are attached to the container instance.
- volumes
List<Container
Instance Volume> A volume is a directory with data that is accessible across multiple containers in a container instance.
You can attach up to 32 volumes to single container instance.
- availability
Domain string - The availability domain where the container instance runs.
- compartment
Id string - (Updatable) The compartment OCID.
- container
Count number - The number of containers on the container instance.
- container
Restart stringPolicy - Container restart policy
- containers
Container
Instance Container[] - The containers to create on this container instance.
- {[key: string]: string}
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}. - display
Name string - (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. If you don't provide a name, a name is generated automatically.
- dns
Config ContainerInstance Dns Config - Allow customers to define DNS settings for containers. If this is not provided, the containers use the default DNS settings of the subnet.
- fault
Domain string - The fault domain where the container instance runs.
- {[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"} - graceful
Shutdown stringTimeout In Seconds - 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.
- image
Pull ContainerSecrets Instance Image Pull Secret[] - The image pulls secrets so you can access private registry to pull container images.
- lifecycle
Details 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 resources available to the container instance.
- shape
Config ContainerInstance Shape Config - The size and amount of resources available to the container instance.
- state string
(Updatable) The target state for the Container Instance. Could be set to
ACTIVEorINACTIVE.** 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
- {[key: string]: string}
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"}. - time
Created string - The time the container instance was created, in the format defined by RFC 3339.
- time
Updated string - The time the container instance was updated, in the format defined by RFC 3339.
- vnics
Container
Instance Vnic[] - The networks available to containers on this container instance.
- volume
Count number - The number of volumes that are attached to the container instance.
- volumes
Container
Instance Volume[] A volume is a directory with data that is accessible across multiple containers in a container instance.
You can attach up to 32 volumes to single container instance.
- availability_
domain str - The availability domain where the container instance runs.
- compartment_
id str - (Updatable) The compartment OCID.
- container_
count int - The number of containers on the container instance.
- container_
restart_ strpolicy - Container restart policy
- containers
Sequence[Container
Instance Container Args] - The containers to create on this container instance.
- Mapping[str, str]
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}. - display_
name str - (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. If you don't provide a name, a name is generated automatically.
- dns_
config ContainerInstance Dns Config Args - Allow customers to define DNS settings for containers. If this is not provided, the containers use the default DNS settings of the subnet.
- fault_
domain str - The fault domain where the container instance runs.
- 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"} - graceful_
shutdown_ strtimeout_ in_ seconds - 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.
- image_
pull_ Sequence[Containersecrets Instance Image Pull Secret Args] - 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 resources available to the container instance.
- shape_
config ContainerInstance Shape Config Args - The size and amount of resources available to the container instance.
- state str
(Updatable) The target state for the Container Instance. Could be set to
ACTIVEorINACTIVE.** 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
- 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[Container
Instance Vnic Args] - The networks available to containers on this container instance.
- volume_
count int - The number of volumes that are attached to the container instance.
- volumes
Sequence[Container
Instance Volume Args] A volume is a directory with data that is accessible across multiple containers in a container instance.
You can attach up to 32 volumes to single container instance.
- availability
Domain String - The availability domain where the container instance runs.
- compartment
Id String - (Updatable) The compartment OCID.
- container
Count Number - The number of containers on the container instance.
- container
Restart StringPolicy - Container restart policy
- containers List<Property Map>
- The containers to create on this container instance.
- Map<String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}. - display
Name String - (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. If you don't provide a name, a name is generated automatically.
- dns
Config Property Map - Allow customers to define DNS settings for containers. If this is not provided, the containers use the default DNS settings of the subnet.
- fault
Domain String - The fault domain where the container instance runs.
- 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"} - graceful
Shutdown StringTimeout In Seconds - 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.
- image
Pull List<Property Map>Secrets - The image pulls secrets so you can access private registry to pull container images.
- lifecycle
Details 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 resources available to the container instance.
- shape
Config Property Map - The size and amount of resources available to the container instance.
- state String
(Updatable) The target state for the Container Instance. Could be set to
ACTIVEorINACTIVE.** 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
- Map<String>
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"}. - time
Created String - The time the container instance was created, in the format defined by RFC 3339.
- time
Updated String - The time the container instance was updated, in the format defined by RFC 3339.
- vnics List<Property Map>
- The networks available to containers on this container instance.
- volume
Count 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.
You can attach up to 32 volumes to single container instance.
Supporting Types
ContainerInstanceContainer, ContainerInstanceContainerArgs
- Image
Url string A URL identifying the image that the container runs in, such as docker.io/library/busybox:latest. If you do not provide a tag, the tag will default to latest.
If no registry is provided, will default the registry to public docker hub
docker.io/library.The registry used for container image must be reachable over the Container Instance's VNIC.
- Arguments List<string>
A list of string arguments for a container's ENTRYPOINT process.
Many containers use an ENTRYPOINT process pointing to a shell (/bin/bash). For those containers, this argument list specifies the main command in the container process.
The total size of all arguments combined must be 64 KB or smaller.
- Availability
Domain string - The availability domain where the container instance runs.
- Commands List<string>
- An optional command that overrides the ENTRYPOINT process. If you do not provide a value, the existing ENTRYPOINT process defined in the image is used.
- Compartment
Id string - (Updatable) The compartment OCID.
- Container
Id string - The OCID of the container.
- Container
Instance stringId - Dictionary<string, string>
- Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}. - Display
Name string - A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. If you don't provide a name, a name is generated automatically.
- Environment
Variables Dictionary<string, string> A map of additional environment variables to set in the environment of the container's ENTRYPOINT process. These variables are in addition to any variables already defined in the container's image.
The total size of all environment variables combined, name and values, must be 64 KB or smaller.
- Exit
Code int - Fault
Domain string - The fault domain where the container instance runs.
- 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"} - Health
Checks List<ContainerInstance Container Health Check> - list of container health checks to check container status and take appropriate action if container status is failed. There are two types of health checks that we currently support HTTP and TCP.
- Is
Resource boolPrincipal Disabled Determines if the container will have access to the container instance resource principal.
This method utilizes resource principal version 2.2. For information on how to use the exposed resource principal elements, see https://docs.oracle.com/en-us/iaas/Content/API/Concepts/sdk_authentication_methods.htm#sdk_authentication_methods_resource_principal.
- Lifecycle
Details string - A message that describes the current state of the container in more detail. Can be used to provide actionable information.
- Resource
Config ContainerInstance Container Resource Config - The size and amount of resources available to the container.
- Security
Context ContainerInstance Container Security Context - Security context for container.
- State string
(Updatable) The target state for the Container Instance. Could be set to
ACTIVEorINACTIVE.** 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
- Dictionary<string, string>
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"}. - Time
Created string - The time the container instance was created, in the format defined by RFC 3339.
- Time
Terminated string - Time
Updated string - The time the container instance was updated, in the format defined by RFC 3339.
- Volume
Mounts List<ContainerInstance Container Volume Mount> - List of the volume mounts.
- Working
Directory string - The working directory within the container's filesystem for the container process. If not specified, the default working directory from the image is used.
- Image
Url string A URL identifying the image that the container runs in, such as docker.io/library/busybox:latest. If you do not provide a tag, the tag will default to latest.
If no registry is provided, will default the registry to public docker hub
docker.io/library.The registry used for container image must be reachable over the Container Instance's VNIC.
- Arguments []string
A list of string arguments for a container's ENTRYPOINT process.
Many containers use an ENTRYPOINT process pointing to a shell (/bin/bash). For those containers, this argument list specifies the main command in the container process.
The total size of all arguments combined must be 64 KB or smaller.
- Availability
Domain string - The availability domain where the container instance runs.
- Commands []string
- An optional command that overrides the ENTRYPOINT process. If you do not provide a value, the existing ENTRYPOINT process defined in the image is used.
- Compartment
Id string - (Updatable) The compartment OCID.
- Container
Id string - The OCID of the container.
- Container
Instance stringId - map[string]string
- Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}. - Display
Name string - A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. If you don't provide a name, a name is generated automatically.
- Environment
Variables map[string]string A map of additional environment variables to set in the environment of the container's ENTRYPOINT process. These variables are in addition to any variables already defined in the container's image.
The total size of all environment variables combined, name and values, must be 64 KB or smaller.
- Exit
Code int - Fault
Domain string - The fault domain where the container instance runs.
- 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"} - Health
Checks []ContainerInstance Container Health Check - list of container health checks to check container status and take appropriate action if container status is failed. There are two types of health checks that we currently support HTTP and TCP.
- Is
Resource boolPrincipal Disabled Determines if the container will have access to the container instance resource principal.
This method utilizes resource principal version 2.2. For information on how to use the exposed resource principal elements, see https://docs.oracle.com/en-us/iaas/Content/API/Concepts/sdk_authentication_methods.htm#sdk_authentication_methods_resource_principal.
- Lifecycle
Details string - A message that describes the current state of the container in more detail. Can be used to provide actionable information.
- Resource
Config ContainerInstance Container Resource Config - The size and amount of resources available to the container.
- Security
Context ContainerInstance Container Security Context - Security context for container.
- State string
(Updatable) The target state for the Container Instance. Could be set to
ACTIVEorINACTIVE.** 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
- map[string]string
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"}. - Time
Created string - The time the container instance was created, in the format defined by RFC 3339.
- Time
Terminated string - Time
Updated string - The time the container instance was updated, in the format defined by RFC 3339.
- Volume
Mounts []ContainerInstance Container Volume Mount - List of the volume mounts.
- Working
Directory string - The working directory within the container's filesystem for the container process. If not specified, the default working directory from the image is used.
- image
Url String A URL identifying the image that the container runs in, such as docker.io/library/busybox:latest. If you do not provide a tag, the tag will default to latest.
If no registry is provided, will default the registry to public docker hub
docker.io/library.The registry used for container image must be reachable over the Container Instance's VNIC.
- arguments List<String>
A list of string arguments for a container's ENTRYPOINT process.
Many containers use an ENTRYPOINT process pointing to a shell (/bin/bash). For those containers, this argument list specifies the main command in the container process.
The total size of all arguments combined must be 64 KB or smaller.
- availability
Domain String - The availability domain where the container instance runs.
- commands List<String>
- An optional command that overrides the ENTRYPOINT process. If you do not provide a value, the existing ENTRYPOINT process defined in the image is used.
- compartment
Id String - (Updatable) The compartment OCID.
- container
Id String - The OCID of the container.
- container
Instance StringId - Map<String,String>
- Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}. - display
Name String - A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. If you don't provide a name, a name is generated automatically.
- environment
Variables Map<String,String> A map of additional environment variables to set in the environment of the container's ENTRYPOINT process. These variables are in addition to any variables already defined in the container's image.
The total size of all environment variables combined, name and values, must be 64 KB or smaller.
- exit
Code Integer - fault
Domain String - The fault domain where the container instance runs.
- 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"} - health
Checks List<ContainerInstance Container Health Check> - list of container health checks to check container status and take appropriate action if container status is failed. There are two types of health checks that we currently support HTTP and TCP.
- is
Resource BooleanPrincipal Disabled Determines if the container will have access to the container instance resource principal.
This method utilizes resource principal version 2.2. For information on how to use the exposed resource principal elements, see https://docs.oracle.com/en-us/iaas/Content/API/Concepts/sdk_authentication_methods.htm#sdk_authentication_methods_resource_principal.
- lifecycle
Details String - A message that describes the current state of the container in more detail. Can be used to provide actionable information.
- resource
Config ContainerInstance Container Resource Config - The size and amount of resources available to the container.
- security
Context ContainerInstance Container Security Context - Security context for container.
- state String
(Updatable) The target state for the Container Instance. Could be set to
ACTIVEorINACTIVE.** 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
- Map<String,String>
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"}. - time
Created String - The time the container instance was created, in the format defined by RFC 3339.
- time
Terminated String - time
Updated String - The time the container instance was updated, in the format defined by RFC 3339.
- volume
Mounts List<ContainerInstance Container Volume Mount> - List of the volume mounts.
- working
Directory String - The working directory within the container's filesystem for the container process. If not specified, the default working directory from the image is used.
- image
Url string A URL identifying the image that the container runs in, such as docker.io/library/busybox:latest. If you do not provide a tag, the tag will default to latest.
If no registry is provided, will default the registry to public docker hub
docker.io/library.The registry used for container image must be reachable over the Container Instance's VNIC.
- arguments string[]
A list of string arguments for a container's ENTRYPOINT process.
Many containers use an ENTRYPOINT process pointing to a shell (/bin/bash). For those containers, this argument list specifies the main command in the container process.
The total size of all arguments combined must be 64 KB or smaller.
- availability
Domain string - The availability domain where the container instance runs.
- commands string[]
- An optional command that overrides the ENTRYPOINT process. If you do not provide a value, the existing ENTRYPOINT process defined in the image is used.
- compartment
Id string - (Updatable) The compartment OCID.
- container
Id string - The OCID of the container.
- container
Instance stringId - {[key: string]: string}
- Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}. - display
Name string - A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. If you don't provide a name, a name is generated automatically.
- environment
Variables {[key: string]: string} A map of additional environment variables to set in the environment of the container's ENTRYPOINT process. These variables are in addition to any variables already defined in the container's image.
The total size of all environment variables combined, name and values, must be 64 KB or smaller.
- exit
Code number - fault
Domain string - The fault domain where the container instance runs.
- {[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"} - health
Checks ContainerInstance Container Health Check[] - list of container health checks to check container status and take appropriate action if container status is failed. There are two types of health checks that we currently support HTTP and TCP.
- is
Resource booleanPrincipal Disabled Determines if the container will have access to the container instance resource principal.
This method utilizes resource principal version 2.2. For information on how to use the exposed resource principal elements, see https://docs.oracle.com/en-us/iaas/Content/API/Concepts/sdk_authentication_methods.htm#sdk_authentication_methods_resource_principal.
- lifecycle
Details string - A message that describes the current state of the container in more detail. Can be used to provide actionable information.
- resource
Config ContainerInstance Container Resource Config - The size and amount of resources available to the container.
- security
Context ContainerInstance Container Security Context - Security context for container.
- state string
(Updatable) The target state for the Container Instance. Could be set to
ACTIVEorINACTIVE.** 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
- {[key: string]: string}
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"}. - time
Created string - The time the container instance was created, in the format defined by RFC 3339.
- time
Terminated string - time
Updated string - The time the container instance was updated, in the format defined by RFC 3339.
- volume
Mounts ContainerInstance Container Volume Mount[] - List of the volume mounts.
- working
Directory string - The working directory within the container's filesystem for the container process. If not specified, the default working directory from the image is used.
- image_
url str A URL identifying the image that the container runs in, such as docker.io/library/busybox:latest. If you do not provide a tag, the tag will default to latest.
If no registry is provided, will default the registry to public docker hub
docker.io/library.The registry used for container image must be reachable over the Container Instance's VNIC.
- arguments Sequence[str]
A list of string arguments for a container's ENTRYPOINT process.
Many containers use an ENTRYPOINT process pointing to a shell (/bin/bash). For those containers, this argument list specifies the main command in the container process.
The total size of all arguments combined must be 64 KB or smaller.
- availability_
domain str - The availability domain where the container instance runs.
- commands Sequence[str]
- An optional command that overrides the ENTRYPOINT process. If you do not provide a value, the existing ENTRYPOINT process defined in the image is used.
- compartment_
id str - (Updatable) The compartment OCID.
- container_
id str - The OCID of the container.
- container_
instance_ strid - 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. If you don't provide a name, a name is generated automatically.
- environment_
variables Mapping[str, str] A map of additional environment variables to set in the environment of the container's ENTRYPOINT process. These variables are in addition to any variables already defined in the container's image.
The total size of all environment variables combined, name and values, must be 64 KB or smaller.
- exit_
code int - fault_
domain str - The fault domain where the container instance runs.
- 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[ContainerInstance Container Health Check] - list of container health checks to check container status and take appropriate action if container status is failed. There are two types of health checks that we currently support HTTP and TCP.
- is_
resource_ boolprincipal_ disabled Determines if the container will have access to the container instance resource principal.
This method utilizes resource principal version 2.2. For information on how to use the exposed resource principal elements, see https://docs.oracle.com/en-us/iaas/Content/API/Concepts/sdk_authentication_methods.htm#sdk_authentication_methods_resource_principal.
- lifecycle_
details str - A message that describes the current state of the container in more detail. Can be used to provide actionable information.
- resource_
config ContainerInstance Container Resource Config - The size and amount of resources available to the container.
- security_
context ContainerInstance Container Security Context - Security context for container.
- state str
(Updatable) The target state for the Container Instance. Could be set to
ACTIVEorINACTIVE.** 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
- 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[ContainerInstance Container Volume Mount] - List of the volume mounts.
- working_
directory str - The working directory within the container's filesystem for the container process. If not specified, the default working directory from the image is used.
- image
Url String A URL identifying the image that the container runs in, such as docker.io/library/busybox:latest. If you do not provide a tag, the tag will default to latest.
If no registry is provided, will default the registry to public docker hub
docker.io/library.The registry used for container image must be reachable over the Container Instance's VNIC.
- arguments List<String>
A list of string arguments for a container's ENTRYPOINT process.
Many containers use an ENTRYPOINT process pointing to a shell (/bin/bash). For those containers, this argument list specifies the main command in the container process.
The total size of all arguments combined must be 64 KB or smaller.
- availability
Domain String - The availability domain where the container instance runs.
- commands List<String>
- An optional command that overrides the ENTRYPOINT process. If you do not provide a value, the existing ENTRYPOINT process defined in the image is used.
- compartment
Id String - (Updatable) The compartment OCID.
- container
Id String - The OCID of the container.
- container
Instance StringId - Map<String>
- Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}. - display
Name String - A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. If you don't provide a name, a name is generated automatically.
- environment
Variables Map<String> A map of additional environment variables to set in the environment of the container's ENTRYPOINT process. These variables are in addition to any variables already defined in the container's image.
The total size of all environment variables combined, name and values, must be 64 KB or smaller.
- exit
Code Number - fault
Domain String - The fault domain where the container instance runs.
- 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"} - health
Checks List<Property Map> - list of container health checks to check container status and take appropriate action if container status is failed. There are two types of health checks that we currently support HTTP and TCP.
- is
Resource BooleanPrincipal Disabled Determines if the container will have access to the container instance resource principal.
This method utilizes resource principal version 2.2. For information on how to use the exposed resource principal elements, see https://docs.oracle.com/en-us/iaas/Content/API/Concepts/sdk_authentication_methods.htm#sdk_authentication_methods_resource_principal.
- lifecycle
Details String - A message that describes the current state of the container in more detail. Can be used to provide actionable information.
- resource
Config Property Map - The size and amount of resources available to the container.
- security
Context Property Map - Security context for container.
- state String
(Updatable) The target state for the Container Instance. Could be set to
ACTIVEorINACTIVE.** 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
- Map<String>
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"}. - time
Created String - The time the container instance was created, in the format defined by RFC 3339.
- time
Terminated String - time
Updated String - The time the container instance was updated, in the format defined by RFC 3339.
- volume
Mounts List<Property Map> - List of the volume mounts.
- working
Directory String - The working directory within the container's filesystem for the container process. If not specified, the default working directory from the image is used.
ContainerInstanceContainerHealthCheck, ContainerInstanceContainerHealthCheckArgs
- Health
Check stringType - Container health check type.
- Failure
Action string - The action will be triggered when the container health check fails. There are two types of action: KILL or NONE. The default action is KILL. If failure action is KILL, the container will be subject to the container restart policy.
- Failure
Threshold int - Number of consecutive failures at which we consider the check failed.
- Headers
List<Container
Instance Container Health Check Header> - Container health check HTTP headers.
- Initial
Delay intIn Seconds - The initial delay in seconds before start checking container health status.
- Interval
In intSeconds - Number of seconds between two consecutive runs for checking container health.
- Name string
- Health check name.
- Path string
- Container health check HTTP path.
- Port int
- Container health check HTTP port.
- Status string
- Status
Details string - Success
Threshold int - Number of consecutive successes at which we consider the check succeeded again after it was in failure state.
- Timeout
In intSeconds - Length of waiting time in seconds before marking health check failed.
- Health
Check stringType - Container health check type.
- Failure
Action string - The action will be triggered when the container health check fails. There are two types of action: KILL or NONE. The default action is KILL. If failure action is KILL, the container will be subject to the container restart policy.
- Failure
Threshold int - Number of consecutive failures at which we consider the check failed.
- Headers
[]Container
Instance Container Health Check Header - Container health check HTTP headers.
- Initial
Delay intIn Seconds - The initial delay in seconds before start checking container health status.
- Interval
In intSeconds - Number of seconds between two consecutive runs for checking container health.
- Name string
- Health check name.
- Path string
- Container health check HTTP path.
- Port int
- Container health check HTTP port.
- Status string
- Status
Details string - Success
Threshold int - Number of consecutive successes at which we consider the check succeeded again after it was in failure state.
- Timeout
In intSeconds - Length of waiting time in seconds before marking health check failed.
- health
Check StringType - Container health check type.
- failure
Action String - The action will be triggered when the container health check fails. There are two types of action: KILL or NONE. The default action is KILL. If failure action is KILL, the container will be subject to the container restart policy.
- failure
Threshold Integer - Number of consecutive failures at which we consider the check failed.
- headers
List<Container
Instance Container Health Check Header> - Container health check HTTP headers.
- initial
Delay IntegerIn Seconds - The initial delay in seconds before start checking container health status.
- interval
In IntegerSeconds - Number of seconds between two consecutive runs for checking container health.
- name String
- Health check name.
- path String
- Container health check HTTP path.
- port Integer
- Container health check HTTP port.
- status String
- status
Details String - success
Threshold Integer - Number of consecutive successes at which we consider the check succeeded again after it was in failure state.
- timeout
In IntegerSeconds - Length of waiting time in seconds before marking health check failed.
- health
Check stringType - Container health check type.
- failure
Action string - The action will be triggered when the container health check fails. There are two types of action: KILL or NONE. The default action is KILL. If failure action is KILL, the container will be subject to the container restart policy.
- failure
Threshold number - Number of consecutive failures at which we consider the check failed.
- headers
Container
Instance Container Health Check Header[] - Container health check HTTP headers.
- initial
Delay numberIn Seconds - The initial delay in seconds before start checking container health status.
- interval
In numberSeconds - Number of seconds between two consecutive runs for checking container health.
- name string
- Health check name.
- path string
- Container health check HTTP path.
- port number
- Container health check HTTP port.
- status string
- status
Details string - success
Threshold number - Number of consecutive successes at which we consider the check succeeded again after it was in failure state.
- timeout
In numberSeconds - Length of waiting time in seconds before marking health check failed.
- health_
check_ strtype - Container health check type.
- failure_
action str - The action will be triggered when the container health check fails. There are two types of action: KILL or NONE. The default action is KILL. If failure action is KILL, the container will be subject to the container restart policy.
- failure_
threshold int - Number of consecutive failures at which we consider the check failed.
- headers
Sequence[Container
Instance Container Health Check Header] - Container health check HTTP headers.
- initial_
delay_ intin_ seconds - The initial delay in seconds before start checking container health status.
- interval_
in_ intseconds - Number of seconds between two consecutive runs for checking container health.
- name str
- Health check name.
- path str
- Container health check HTTP path.
- port int
- Container health check HTTP port.
- status str
- status_
details str - success_
threshold int - Number of consecutive successes at which we consider the check succeeded again after it was in failure state.
- timeout_
in_ intseconds - Length of waiting time in seconds before marking health check failed.
- health
Check StringType - Container health check type.
- failure
Action String - The action will be triggered when the container health check fails. There are two types of action: KILL or NONE. The default action is KILL. If failure action is KILL, the container will be subject to the container restart policy.
- failure
Threshold Number - Number of consecutive failures at which we consider the check failed.
- headers List<Property Map>
- Container health check HTTP headers.
- initial
Delay NumberIn Seconds - The initial delay in seconds before start checking container health status.
- interval
In NumberSeconds - Number of seconds between two consecutive runs for checking container health.
- name String
- Health check name.
- path String
- Container health check HTTP path.
- port Number
- Container health check HTTP port.
- status String
- status
Details String - success
Threshold Number - Number of consecutive successes at which we consider the check succeeded again after it was in failure state.
- timeout
In NumberSeconds - Length of waiting time in seconds before marking health check failed.
ContainerInstanceContainerHealthCheckHeader, ContainerInstanceContainerHealthCheckHeaderArgs
ContainerInstanceContainerResourceConfig, ContainerInstanceContainerResourceConfigArgs
- Memory
Limit doubleIn Gbs The maximum amount of memory that can be consumed by the container's process.
If you do not set a value, then the process may use all available memory on the instance.
- Vcpus
Limit double The maximum amount of CPUs that can be consumed by the container's process.
If you do not set a value, then the process can use all available CPU resources on the instance.
CPU usage is defined in terms of logical CPUs. This means that the maximum possible value on an E3 ContainerInstance with 1 OCPU is 2.0.
A container with a 2.0 vcpusLimit could consume up to 100% of the CPU resources available on the container instance. Values can be fractional. A value of "1.5" means that the container can consume at most the equivalent of 1 and a half logical CPUs worth of CPU capacity.
- Memory
Limit float64In Gbs The maximum amount of memory that can be consumed by the container's process.
If you do not set a value, then the process may use all available memory on the instance.
- Vcpus
Limit float64 The maximum amount of CPUs that can be consumed by the container's process.
If you do not set a value, then the process can use all available CPU resources on the instance.
CPU usage is defined in terms of logical CPUs. This means that the maximum possible value on an E3 ContainerInstance with 1 OCPU is 2.0.
A container with a 2.0 vcpusLimit could consume up to 100% of the CPU resources available on the container instance. Values can be fractional. A value of "1.5" means that the container can consume at most the equivalent of 1 and a half logical CPUs worth of CPU capacity.
- memory
Limit DoubleIn Gbs The maximum amount of memory that can be consumed by the container's process.
If you do not set a value, then the process may use all available memory on the instance.
- vcpus
Limit Double The maximum amount of CPUs that can be consumed by the container's process.
If you do not set a value, then the process can use all available CPU resources on the instance.
CPU usage is defined in terms of logical CPUs. This means that the maximum possible value on an E3 ContainerInstance with 1 OCPU is 2.0.
A container with a 2.0 vcpusLimit could consume up to 100% of the CPU resources available on the container instance. Values can be fractional. A value of "1.5" means that the container can consume at most the equivalent of 1 and a half logical CPUs worth of CPU capacity.
- memory
Limit numberIn Gbs The maximum amount of memory that can be consumed by the container's process.
If you do not set a value, then the process may use all available memory on the instance.
- vcpus
Limit number The maximum amount of CPUs that can be consumed by the container's process.
If you do not set a value, then the process can use all available CPU resources on the instance.
CPU usage is defined in terms of logical CPUs. This means that the maximum possible value on an E3 ContainerInstance with 1 OCPU is 2.0.
A container with a 2.0 vcpusLimit could consume up to 100% of the CPU resources available on the container instance. Values can be fractional. A value of "1.5" means that the container can consume at most the equivalent of 1 and a half logical CPUs worth of CPU capacity.
- memory_
limit_ floatin_ gbs The maximum amount of memory that can be consumed by the container's process.
If you do not set a value, then the process may use all available memory on the instance.
- vcpus_
limit float The maximum amount of CPUs that can be consumed by the container's process.
If you do not set a value, then the process can use all available CPU resources on the instance.
CPU usage is defined in terms of logical CPUs. This means that the maximum possible value on an E3 ContainerInstance with 1 OCPU is 2.0.
A container with a 2.0 vcpusLimit could consume up to 100% of the CPU resources available on the container instance. Values can be fractional. A value of "1.5" means that the container can consume at most the equivalent of 1 and a half logical CPUs worth of CPU capacity.
- memory
Limit NumberIn Gbs The maximum amount of memory that can be consumed by the container's process.
If you do not set a value, then the process may use all available memory on the instance.
- vcpus
Limit Number The maximum amount of CPUs that can be consumed by the container's process.
If you do not set a value, then the process can use all available CPU resources on the instance.
CPU usage is defined in terms of logical CPUs. This means that the maximum possible value on an E3 ContainerInstance with 1 OCPU is 2.0.
A container with a 2.0 vcpusLimit could consume up to 100% of the CPU resources available on the container instance. Values can be fractional. A value of "1.5" means that the container can consume at most the equivalent of 1 and a half logical CPUs worth of CPU capacity.
ContainerInstanceContainerSecurityContext, ContainerInstanceContainerSecurityContextArgs
- Capabilities
Container
Instance Container Security Context Capabilities - Linux Container capabilities to configure capabilities of container.
- Is
Non boolRoot User Check Enabled - Indicates if the container must run as a non-root user. If true, the service validates the container image at runtime to ensure that it is not going to run with UID 0 (root) and fails the container instance creation if the validation fails.
- Is
Root boolFile System Readonly - Determines if the container will have a read-only root file system. Default value is false.
- Run
As intGroup - The group ID (GID) to run the entrypoint process of the container. Uses runtime default if not provided.
- Run
As intUser - The user ID (UID) to run the entrypoint process of the container. Defaults to user specified UID in container image metadata if not provided. This must be provided if runAsGroup is provided.
- Security
Context stringType - The type of security context
- Capabilities
Container
Instance Container Security Context Capabilities - Linux Container capabilities to configure capabilities of container.
- Is
Non boolRoot User Check Enabled - Indicates if the container must run as a non-root user. If true, the service validates the container image at runtime to ensure that it is not going to run with UID 0 (root) and fails the container instance creation if the validation fails.
- Is
Root boolFile System Readonly - Determines if the container will have a read-only root file system. Default value is false.
- Run
As intGroup - The group ID (GID) to run the entrypoint process of the container. Uses runtime default if not provided.
- Run
As intUser - The user ID (UID) to run the entrypoint process of the container. Defaults to user specified UID in container image metadata if not provided. This must be provided if runAsGroup is provided.
- Security
Context stringType - The type of security context
- capabilities
Container
Instance Container Security Context Capabilities - Linux Container capabilities to configure capabilities of container.
- is
Non BooleanRoot User Check Enabled - Indicates if the container must run as a non-root user. If true, the service validates the container image at runtime to ensure that it is not going to run with UID 0 (root) and fails the container instance creation if the validation fails.
- is
Root BooleanFile System Readonly - Determines if the container will have a read-only root file system. Default value is false.
- run
As IntegerGroup - The group ID (GID) to run the entrypoint process of the container. Uses runtime default if not provided.
- run
As IntegerUser - The user ID (UID) to run the entrypoint process of the container. Defaults to user specified UID in container image metadata if not provided. This must be provided if runAsGroup is provided.
- security
Context StringType - The type of security context
- capabilities
Container
Instance Container Security Context Capabilities - Linux Container capabilities to configure capabilities of container.
- is
Non booleanRoot User Check Enabled - Indicates if the container must run as a non-root user. If true, the service validates the container image at runtime to ensure that it is not going to run with UID 0 (root) and fails the container instance creation if the validation fails.
- is
Root booleanFile System Readonly - Determines if the container will have a read-only root file system. Default value is false.
- run
As numberGroup - The group ID (GID) to run the entrypoint process of the container. Uses runtime default if not provided.
- run
As numberUser - The user ID (UID) to run the entrypoint process of the container. Defaults to user specified UID in container image metadata if not provided. This must be provided if runAsGroup is provided.
- security
Context stringType - The type of security context
- capabilities
Container
Instance Container Security Context Capabilities - Linux Container capabilities to configure capabilities of container.
- is_
non_ boolroot_ user_ check_ enabled - Indicates if the container must run as a non-root user. If true, the service validates the container image at runtime to ensure that it is not going to run with UID 0 (root) and fails the container instance creation if the validation fails.
- is_
root_ boolfile_ system_ readonly - Determines if the container will have a read-only root file system. Default value is false.
- run_
as_ intgroup - The group ID (GID) to run the entrypoint process of the container. Uses runtime default if not provided.
- run_
as_ intuser - The user ID (UID) to run the entrypoint process of the container. Defaults to user specified UID in container image metadata if not provided. This must be provided if runAsGroup is provided.
- security_
context_ strtype - The type of security context
- capabilities Property Map
- Linux Container capabilities to configure capabilities of container.
- is
Non BooleanRoot User Check Enabled - Indicates if the container must run as a non-root user. If true, the service validates the container image at runtime to ensure that it is not going to run with UID 0 (root) and fails the container instance creation if the validation fails.
- is
Root BooleanFile System Readonly - Determines if the container will have a read-only root file system. Default value is false.
- run
As NumberGroup - The group ID (GID) to run the entrypoint process of the container. Uses runtime default if not provided.
- run
As NumberUser - The user ID (UID) to run the entrypoint process of the container. Defaults to user specified UID in container image metadata if not provided. This must be provided if runAsGroup is provided.
- security
Context StringType - The type of security context
ContainerInstanceContainerSecurityContextCapabilities, ContainerInstanceContainerSecurityContextCapabilitiesArgs
- Add
Capabilities List<string> - A list of additional configurable container capabilities.
- Drop
Capabilities List<string> - A list of container capabilities that can be dropped.
- Add
Capabilities []string - A list of additional configurable container capabilities.
- Drop
Capabilities []string - A list of container capabilities that can be dropped.
- add
Capabilities List<String> - A list of additional configurable container capabilities.
- drop
Capabilities List<String> - A list of container capabilities that can be dropped.
- add
Capabilities string[] - A list of additional configurable container capabilities.
- drop
Capabilities string[] - A list of container capabilities that can be dropped.
- add_
capabilities Sequence[str] - A list of additional configurable container capabilities.
- drop_
capabilities Sequence[str] - A list of container capabilities that can be dropped.
- add
Capabilities List<String> - A list of additional configurable container capabilities.
- drop
Capabilities List<String> - A list of container capabilities that can be dropped.
ContainerInstanceContainerVolumeMount, ContainerInstanceContainerVolumeMountArgs
- Mount
Path string - The volume access path.
- Volume
Name string - The name of the volume. Avoid entering confidential information.
- Is
Read boolOnly - Whether the volume was mounted in read-only mode. By default, the volume is not read-only.
- Partition int
- If there is more than one partition in the volume, reference this number of partitions. Here is an example: Number Start End Size File system Name Flags 1 1049kB 106MB 105MB fat16 EFI System Partition boot, esp 2 106MB 1180MB 1074MB xfs 3 1180MB 50.0GB 48.8GB lvm
- Sub
Path string - A subpath inside the referenced volume.
- Mount
Path string - The volume access path.
- Volume
Name string - The name of the volume. Avoid entering confidential information.
- Is
Read boolOnly - Whether the volume was mounted in read-only mode. By default, the volume is not read-only.
- Partition int
- If there is more than one partition in the volume, reference this number of partitions. Here is an example: Number Start End Size File system Name Flags 1 1049kB 106MB 105MB fat16 EFI System Partition boot, esp 2 106MB 1180MB 1074MB xfs 3 1180MB 50.0GB 48.8GB lvm
- Sub
Path string - A subpath inside the referenced volume.
- mount
Path String - The volume access path.
- volume
Name String - The name of the volume. Avoid entering confidential information.
- is
Read BooleanOnly - Whether the volume was mounted in read-only mode. By default, the volume is not read-only.
- partition Integer
- If there is more than one partition in the volume, reference this number of partitions. Here is an example: Number Start End Size File system Name Flags 1 1049kB 106MB 105MB fat16 EFI System Partition boot, esp 2 106MB 1180MB 1074MB xfs 3 1180MB 50.0GB 48.8GB lvm
- sub
Path String - A subpath inside the referenced volume.
- mount
Path string - The volume access path.
- volume
Name string - The name of the volume. Avoid entering confidential information.
- is
Read booleanOnly - Whether the volume was mounted in read-only mode. By default, the volume is not read-only.
- partition number
- If there is more than one partition in the volume, reference this number of partitions. Here is an example: Number Start End Size File system Name Flags 1 1049kB 106MB 105MB fat16 EFI System Partition boot, esp 2 106MB 1180MB 1074MB xfs 3 1180MB 50.0GB 48.8GB lvm
- sub
Path string - A subpath inside the referenced volume.
- mount_
path str - The volume access path.
- volume_
name str - The name of the volume. Avoid entering confidential information.
- is_
read_ boolonly - Whether the volume was mounted in read-only mode. By default, the volume is not read-only.
- partition int
- If there is more than one partition in the volume, reference this number of partitions. Here is an example: Number Start End Size File system Name Flags 1 1049kB 106MB 105MB fat16 EFI System Partition boot, esp 2 106MB 1180MB 1074MB xfs 3 1180MB 50.0GB 48.8GB lvm
- sub_
path str - A subpath inside the referenced volume.
- mount
Path String - The volume access path.
- volume
Name String - The name of the volume. Avoid entering confidential information.
- is
Read BooleanOnly - Whether the volume was mounted in read-only mode. By default, the volume is not read-only.
- partition Number
- If there is more than one partition in the volume, reference this number of partitions. Here is an example: Number Start End Size File system Name Flags 1 1049kB 106MB 105MB fat16 EFI System Partition boot, esp 2 106MB 1180MB 1074MB xfs 3 1180MB 50.0GB 48.8GB lvm
- sub
Path String - A subpath inside the referenced volume.
ContainerInstanceDnsConfig, ContainerInstanceDnsConfigArgs
- Nameservers List<string>
- IP address of a name server that the resolver should query, either an IPv4 address (in dot notation), or an IPv6 address in colon (and possibly dot) notation. If null, uses nameservers from subnet dhcpDnsOptions.
- Options List<string>
- Options allows certain internal resolver variables to be modified. Options are a list of objects in https://man7.org/linux/man-pages/man5/resolv.conf.5.html. Examples: ["ndots:n", "edns0"].
- Searches List<string>
- Search list for host-name lookup. If null, we will use searches from subnet dhcpDnsOptios.
- Nameservers []string
- IP address of a name server that the resolver should query, either an IPv4 address (in dot notation), or an IPv6 address in colon (and possibly dot) notation. If null, uses nameservers from subnet dhcpDnsOptions.
- Options []string
- Options allows certain internal resolver variables to be modified. Options are a list of objects in https://man7.org/linux/man-pages/man5/resolv.conf.5.html. Examples: ["ndots:n", "edns0"].
- Searches []string
- Search list for host-name lookup. If null, we will use searches from subnet dhcpDnsOptios.
- nameservers List<String>
- IP address of a name server that the resolver should query, either an IPv4 address (in dot notation), or an IPv6 address in colon (and possibly dot) notation. If null, uses nameservers from subnet dhcpDnsOptions.
- options List<String>
- Options allows certain internal resolver variables to be modified. Options are a list of objects in https://man7.org/linux/man-pages/man5/resolv.conf.5.html. Examples: ["ndots:n", "edns0"].
- searches List<String>
- Search list for host-name lookup. If null, we will use searches from subnet dhcpDnsOptios.
- nameservers string[]
- IP address of a name server that the resolver should query, either an IPv4 address (in dot notation), or an IPv6 address in colon (and possibly dot) notation. If null, uses nameservers from subnet dhcpDnsOptions.
- options string[]
- Options allows certain internal resolver variables to be modified. Options are a list of objects in https://man7.org/linux/man-pages/man5/resolv.conf.5.html. Examples: ["ndots:n", "edns0"].
- searches string[]
- Search list for host-name lookup. If null, we will use searches from subnet dhcpDnsOptios.
- nameservers Sequence[str]
- IP address of a name server that the resolver should query, either an IPv4 address (in dot notation), or an IPv6 address in colon (and possibly dot) notation. If null, uses nameservers from subnet dhcpDnsOptions.
- options Sequence[str]
- Options allows certain internal resolver variables to be modified. Options are a list of objects in https://man7.org/linux/man-pages/man5/resolv.conf.5.html. Examples: ["ndots:n", "edns0"].
- searches Sequence[str]
- Search list for host-name lookup. If null, we will use searches from subnet dhcpDnsOptios.
- nameservers List<String>
- IP address of a name server that the resolver should query, either an IPv4 address (in dot notation), or an IPv6 address in colon (and possibly dot) notation. If null, uses nameservers from subnet dhcpDnsOptions.
- options List<String>
- Options allows certain internal resolver variables to be modified. Options are a list of objects in https://man7.org/linux/man-pages/man5/resolv.conf.5.html. Examples: ["ndots:n", "edns0"].
- searches List<String>
- Search list for host-name lookup. If null, we will use searches from subnet dhcpDnsOptios.
ContainerInstanceImagePullSecret, ContainerInstanceImagePullSecretArgs
- Registry
Endpoint string - The registry endpoint of the container image.
- Secret
Type string - The type of ImagePullSecret.
- Password string
- The password which should be used with the registry for authentication. The value is expected in base64 format.
- Secret
Id string - The OCID of the secret for registry credentials.
- Username string
- The username which should be used with the registry for authentication. The value is expected in base64 format.
- Registry
Endpoint string - The registry endpoint of the container image.
- Secret
Type string - The type of ImagePullSecret.
- Password string
- The password which should be used with the registry for authentication. The value is expected in base64 format.
- Secret
Id string - The OCID of the secret for registry credentials.
- Username string
- The username which should be used with the registry for authentication. The value is expected in base64 format.
- registry
Endpoint String - The registry endpoint of the container image.
- secret
Type String - The type of ImagePullSecret.
- password String
- The password which should be used with the registry for authentication. The value is expected in base64 format.
- secret
Id String - The OCID of the secret for registry credentials.
- username String
- The username which should be used with the registry for authentication. The value is expected in base64 format.
- registry
Endpoint string - The registry endpoint of the container image.
- secret
Type string - The type of ImagePullSecret.
- password string
- The password which should be used with the registry for authentication. The value is expected in base64 format.
- secret
Id string - The OCID of the secret for registry credentials.
- username string
- The username which should be used with the registry for authentication. The value is expected in base64 format.
- registry_
endpoint str - The registry endpoint of the container image.
- secret_
type str - The type of ImagePullSecret.
- password str
- The password which should be used with the registry for authentication. The value is expected in base64 format.
- secret_
id str - The OCID of the secret for registry credentials.
- username str
- The username which should be used with the registry for authentication. The value is expected in base64 format.
- registry
Endpoint String - The registry endpoint of the container image.
- secret
Type String - The type of ImagePullSecret.
- password String
- The password which should be used with the registry for authentication. The value is expected in base64 format.
- secret
Id String - The OCID of the secret for registry credentials.
- username String
- The username which should be used with the registry for authentication. The value is expected in base64 format.
ContainerInstanceShapeConfig, ContainerInstanceShapeConfigArgs
- Ocpus double
- The total number of OCPUs available to the container instance.
- Memory
In doubleGbs - The total amount of memory available to the container instance (GB).
- Networking
Bandwidth doubleIn Gbps - The networking bandwidth available to the container instance, in gigabits per second.
- Processor
Description string - A short description of the container instance's processor (CPU).
- Ocpus float64
- The total number of OCPUs available to the container instance.
- Memory
In float64Gbs - The total amount of memory available to the container instance (GB).
- Networking
Bandwidth float64In Gbps - The networking bandwidth available to the container instance, in gigabits per second.
- Processor
Description string - A short description of the container instance's processor (CPU).
- ocpus Double
- The total number of OCPUs available to the container instance.
- memory
In DoubleGbs - The total amount of memory available to the container instance (GB).
- networking
Bandwidth DoubleIn Gbps - The networking bandwidth available to the container instance, in gigabits per second.
- processor
Description String - A short description of the container instance's processor (CPU).
- ocpus number
- The total number of OCPUs available to the container instance.
- memory
In numberGbs - The total amount of memory available to the container instance (GB).
- networking
Bandwidth numberIn Gbps - The networking bandwidth available to the container instance, in gigabits per second.
- processor
Description string - A short description of the container instance's processor (CPU).
- ocpus float
- The total number of OCPUs available to the container instance.
- memory_
in_ floatgbs - The total amount of memory available to the container instance (GB).
- networking_
bandwidth_ floatin_ gbps - The networking bandwidth available to the container instance, in gigabits per second.
- processor_
description str - A short description of the container instance's processor (CPU).
- ocpus Number
- The total number of OCPUs available to the container instance.
- memory
In NumberGbs - The total amount of memory available to the container instance (GB).
- networking
Bandwidth NumberIn Gbps - The networking bandwidth available to the container instance, in gigabits per second.
- processor
Description String - A short description of the container instance's processor (CPU).
ContainerInstanceVnic, ContainerInstanceVnicArgs
- Subnet
Id string - The OCID of the subnet to create the VNIC in.
- Dictionary<string, string>
- Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}. - Display
Name string - A user-friendly name for the VNIC. Does not have to be unique. Avoid entering confidential information.
- 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"} - Hostname
Label string - The hostname for the VNIC's primary private IP. Used for DNS.
- Is
Public boolIp Assigned - Whether the VNIC should be assigned a public IP address.
- Nsg
Ids List<string> - A list of the OCIDs of the network security groups (NSGs) to add the VNIC to.
- Private
Ip string - A private IP address of your choice to assign to the VNIC. Must be an available IP address within the subnet's CIDR.
- Skip
Source boolDest Check - Whether the source/destination check is disabled on the VNIC.
- Vnic
Id 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.
- Subnet
Id string - The OCID of the subnet to create the VNIC in.
- map[string]string
- Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}. - Display
Name string - A user-friendly name for the VNIC. Does not have to be unique. Avoid entering confidential information.
- 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"} - Hostname
Label string - The hostname for the VNIC's primary private IP. Used for DNS.
- Is
Public boolIp Assigned - Whether the VNIC should be assigned a public IP address.
- Nsg
Ids []string - A list of the OCIDs of the network security groups (NSGs) to add the VNIC to.
- Private
Ip string - A private IP address of your choice to assign to the VNIC. Must be an available IP address within the subnet's CIDR.
- Skip
Source boolDest Check - Whether the source/destination check is disabled on the VNIC.
- Vnic
Id 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.
- subnet
Id String - The OCID of the subnet to create the VNIC in.
- Map<String,String>
- Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}. - display
Name String - A user-friendly name for the VNIC. Does not have to be unique. Avoid entering confidential information.
- 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"} - hostname
Label String - The hostname for the VNIC's primary private IP. Used for DNS.
- is
Public BooleanIp Assigned - Whether the VNIC should be assigned a public IP address.
- nsg
Ids List<String> - A list of the OCIDs of the network security groups (NSGs) to add the VNIC to.
- private
Ip String - A private IP address of your choice to assign to the VNIC. Must be an available IP address within the subnet's CIDR.
- skip
Source BooleanDest Check - Whether the source/destination check is disabled on the VNIC.
- vnic
Id 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.
- subnet
Id string - The OCID of the subnet to create the VNIC in.
- {[key: string]: string}
- Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}. - display
Name string - A user-friendly name for the VNIC. Does not have to be unique. Avoid entering confidential information.
- {[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"} - hostname
Label string - The hostname for the VNIC's primary private IP. Used for DNS.
- is
Public booleanIp Assigned - Whether the VNIC should be assigned a public IP address.
- nsg
Ids string[] - A list of the OCIDs of the network security groups (NSGs) to add the VNIC to.
- private
Ip string - A private IP address of your choice to assign to the VNIC. Must be an available IP address within the subnet's CIDR.
- skip
Source booleanDest Check - Whether the source/destination check is disabled on the VNIC.
- vnic
Id 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.
- subnet_
id str - The OCID of the subnet to create the VNIC in.
- 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 for the VNIC. Does not have to be unique. Avoid entering confidential information.
- 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 - The hostname for the VNIC's primary private IP. Used for DNS.
- is_
public_ boolip_ assigned - Whether the VNIC should be assigned a public IP address.
- nsg_
ids Sequence[str] - A list of the OCIDs of the network security groups (NSGs) to add the VNIC to.
- private_
ip str - A private IP address of your choice to assign to the VNIC. Must be an available IP address within the subnet's CIDR.
- skip_
source_ booldest_ check - Whether the source/destination check is disabled on the VNIC.
- 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.
- subnet
Id String - The OCID of the subnet to create the VNIC in.
- Map<String>
- Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}. - display
Name String - A user-friendly name for the VNIC. Does not have to be unique. Avoid entering confidential information.
- 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"} - hostname
Label String - The hostname for the VNIC's primary private IP. Used for DNS.
- is
Public BooleanIp Assigned - Whether the VNIC should be assigned a public IP address.
- nsg
Ids List<String> - A list of the OCIDs of the network security groups (NSGs) to add the VNIC to.
- private
Ip String - A private IP address of your choice to assign to the VNIC. Must be an available IP address within the subnet's CIDR.
- skip
Source BooleanDest Check - Whether the source/destination check is disabled on the VNIC.
- vnic
Id 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.
ContainerInstanceVolume, ContainerInstanceVolumeArgs
- Name string
- The name of the volume. This must be unique within a single container instance.
- Volume
Type string - The type of volume.
- Backing
Store string - The volume type of the empty directory, can be either File Storage or Memory.
- Configs
List<Container
Instance Volume Config> - Contains 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.
- Volume
Type string - The type of volume.
- Backing
Store string - The volume type of the empty directory, can be either File Storage or Memory.
- Configs
[]Container
Instance Volume Config - Contains 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.
- volume
Type String - The type of volume.
- backing
Store String - The volume type of the empty directory, can be either File Storage or Memory.
- configs
List<Container
Instance Volume Config> - Contains 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.
- volume
Type string - The type of volume.
- backing
Store string - The volume type of the empty directory, can be either File Storage or Memory.
- configs
Container
Instance Volume Config[] - Contains 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.
- backing_
store str - The volume type of the empty directory, can be either File Storage or Memory.
- configs
Sequence[Container
Instance Volume Config] - Contains 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.
- volume
Type String - The type of volume.
- backing
Store String - The volume type of the empty directory, can be either File Storage or Memory.
- configs List<Property Map>
- Contains 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.
ContainerInstanceVolumeConfig, ContainerInstanceVolumeConfigArgs
- 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.
- File
Name 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.
- File
Name 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.
- file
Name 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.
- file
Name 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.
- file
Name 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.
Import
ContainerInstances can be imported using the id, e.g.
$ pulumi import oci:ContainerEngine/containerInstance:ContainerInstance test_container_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.