1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. oci
  5. BatchBatchTaskEnvironment
Oracle Cloud Infrastructure v3.16.0 published on Wednesday, Jan 28, 2026 by Pulumi
oci logo
Oracle Cloud Infrastructure v3.16.0 published on Wednesday, Jan 28, 2026 by Pulumi

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as oci from "@pulumi/oci";
    
    const testBatchTaskEnvironment = new oci.oci.BatchBatchTaskEnvironment("test_batch_task_environment", {
        compartmentId: compartmentId,
        imageUrl: batchTaskEnvironmentImageUrl,
        definedTags: {
            "Operations.CostCenter": "42",
        },
        description: batchTaskEnvironmentDescription,
        displayName: batchTaskEnvironmentDisplayName,
        freeformTags: {
            Department: "Finance",
        },
        securityContext: {
            fsGroup: batchTaskEnvironmentSecurityContextFsGroup,
            runAsGroup: batchTaskEnvironmentSecurityContextRunAsGroup,
            runAsUser: batchTaskEnvironmentSecurityContextRunAsUser,
        },
        volumes: [{
            localMountDirectoryPath: batchTaskEnvironmentVolumesLocalMountDirectoryPath,
            mountTargetExportPath: batchTaskEnvironmentVolumesMountTargetExportPath,
            mountTargetFqdn: batchTaskEnvironmentVolumesMountTargetFqdn,
            name: batchTaskEnvironmentVolumesName,
            type: batchTaskEnvironmentVolumesType,
        }],
        workingDirectory: batchTaskEnvironmentWorkingDirectory,
    });
    
    import pulumi
    import pulumi_oci as oci
    
    test_batch_task_environment = oci.oci.BatchBatchTaskEnvironment("test_batch_task_environment",
        compartment_id=compartment_id,
        image_url=batch_task_environment_image_url,
        defined_tags={
            "Operations.CostCenter": "42",
        },
        description=batch_task_environment_description,
        display_name=batch_task_environment_display_name,
        freeform_tags={
            "Department": "Finance",
        },
        security_context={
            "fs_group": batch_task_environment_security_context_fs_group,
            "run_as_group": batch_task_environment_security_context_run_as_group,
            "run_as_user": batch_task_environment_security_context_run_as_user,
        },
        volumes=[{
            "local_mount_directory_path": batch_task_environment_volumes_local_mount_directory_path,
            "mount_target_export_path": batch_task_environment_volumes_mount_target_export_path,
            "mount_target_fqdn": batch_task_environment_volumes_mount_target_fqdn,
            "name": batch_task_environment_volumes_name,
            "type": batch_task_environment_volumes_type,
        }],
        working_directory=batch_task_environment_working_directory)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-oci/sdk/v3/go/oci/oci"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := oci.NewBatchBatchTaskEnvironment(ctx, "test_batch_task_environment", &oci.BatchBatchTaskEnvironmentArgs{
    			CompartmentId: pulumi.Any(compartmentId),
    			ImageUrl:      pulumi.Any(batchTaskEnvironmentImageUrl),
    			DefinedTags: pulumi.StringMap{
    				"Operations.CostCenter": pulumi.String("42"),
    			},
    			Description: pulumi.Any(batchTaskEnvironmentDescription),
    			DisplayName: pulumi.Any(batchTaskEnvironmentDisplayName),
    			FreeformTags: pulumi.StringMap{
    				"Department": pulumi.String("Finance"),
    			},
    			SecurityContext: &oci.BatchBatchTaskEnvironmentSecurityContextArgs{
    				FsGroup:    pulumi.Any(batchTaskEnvironmentSecurityContextFsGroup),
    				RunAsGroup: pulumi.Any(batchTaskEnvironmentSecurityContextRunAsGroup),
    				RunAsUser:  pulumi.Any(batchTaskEnvironmentSecurityContextRunAsUser),
    			},
    			Volumes: oci.BatchBatchTaskEnvironmentVolumeArray{
    				&oci.BatchBatchTaskEnvironmentVolumeArgs{
    					LocalMountDirectoryPath: pulumi.Any(batchTaskEnvironmentVolumesLocalMountDirectoryPath),
    					MountTargetExportPath:   pulumi.Any(batchTaskEnvironmentVolumesMountTargetExportPath),
    					MountTargetFqdn:         pulumi.Any(batchTaskEnvironmentVolumesMountTargetFqdn),
    					Name:                    pulumi.Any(batchTaskEnvironmentVolumesName),
    					Type:                    pulumi.Any(batchTaskEnvironmentVolumesType),
    				},
    			},
    			WorkingDirectory: pulumi.Any(batchTaskEnvironmentWorkingDirectory),
    		})
    		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 testBatchTaskEnvironment = new Oci.Oci.BatchBatchTaskEnvironment("test_batch_task_environment", new()
        {
            CompartmentId = compartmentId,
            ImageUrl = batchTaskEnvironmentImageUrl,
            DefinedTags = 
            {
                { "Operations.CostCenter", "42" },
            },
            Description = batchTaskEnvironmentDescription,
            DisplayName = batchTaskEnvironmentDisplayName,
            FreeformTags = 
            {
                { "Department", "Finance" },
            },
            SecurityContext = new Oci.Oci.Inputs.BatchBatchTaskEnvironmentSecurityContextArgs
            {
                FsGroup = batchTaskEnvironmentSecurityContextFsGroup,
                RunAsGroup = batchTaskEnvironmentSecurityContextRunAsGroup,
                RunAsUser = batchTaskEnvironmentSecurityContextRunAsUser,
            },
            Volumes = new[]
            {
                new Oci.Oci.Inputs.BatchBatchTaskEnvironmentVolumeArgs
                {
                    LocalMountDirectoryPath = batchTaskEnvironmentVolumesLocalMountDirectoryPath,
                    MountTargetExportPath = batchTaskEnvironmentVolumesMountTargetExportPath,
                    MountTargetFqdn = batchTaskEnvironmentVolumesMountTargetFqdn,
                    Name = batchTaskEnvironmentVolumesName,
                    Type = batchTaskEnvironmentVolumesType,
                },
            },
            WorkingDirectory = batchTaskEnvironmentWorkingDirectory,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.oci.oci.BatchBatchTaskEnvironment;
    import com.pulumi.oci.oci.BatchBatchTaskEnvironmentArgs;
    import com.pulumi.oci.oci.inputs.BatchBatchTaskEnvironmentSecurityContextArgs;
    import com.pulumi.oci.oci.inputs.BatchBatchTaskEnvironmentVolumeArgs;
    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 testBatchTaskEnvironment = new BatchBatchTaskEnvironment("testBatchTaskEnvironment", BatchBatchTaskEnvironmentArgs.builder()
                .compartmentId(compartmentId)
                .imageUrl(batchTaskEnvironmentImageUrl)
                .definedTags(Map.of("Operations.CostCenter", "42"))
                .description(batchTaskEnvironmentDescription)
                .displayName(batchTaskEnvironmentDisplayName)
                .freeformTags(Map.of("Department", "Finance"))
                .securityContext(BatchBatchTaskEnvironmentSecurityContextArgs.builder()
                    .fsGroup(batchTaskEnvironmentSecurityContextFsGroup)
                    .runAsGroup(batchTaskEnvironmentSecurityContextRunAsGroup)
                    .runAsUser(batchTaskEnvironmentSecurityContextRunAsUser)
                    .build())
                .volumes(BatchBatchTaskEnvironmentVolumeArgs.builder()
                    .localMountDirectoryPath(batchTaskEnvironmentVolumesLocalMountDirectoryPath)
                    .mountTargetExportPath(batchTaskEnvironmentVolumesMountTargetExportPath)
                    .mountTargetFqdn(batchTaskEnvironmentVolumesMountTargetFqdn)
                    .name(batchTaskEnvironmentVolumesName)
                    .type(batchTaskEnvironmentVolumesType)
                    .build())
                .workingDirectory(batchTaskEnvironmentWorkingDirectory)
                .build());
    
        }
    }
    
    resources:
      testBatchTaskEnvironment:
        type: oci:oci:BatchBatchTaskEnvironment
        name: test_batch_task_environment
        properties:
          compartmentId: ${compartmentId}
          imageUrl: ${batchTaskEnvironmentImageUrl}
          definedTags:
            Operations.CostCenter: '42'
          description: ${batchTaskEnvironmentDescription}
          displayName: ${batchTaskEnvironmentDisplayName}
          freeformTags:
            Department: Finance
          securityContext:
            fsGroup: ${batchTaskEnvironmentSecurityContextFsGroup}
            runAsGroup: ${batchTaskEnvironmentSecurityContextRunAsGroup}
            runAsUser: ${batchTaskEnvironmentSecurityContextRunAsUser}
          volumes:
            - localMountDirectoryPath: ${batchTaskEnvironmentVolumesLocalMountDirectoryPath}
              mountTargetExportPath: ${batchTaskEnvironmentVolumesMountTargetExportPath}
              mountTargetFqdn: ${batchTaskEnvironmentVolumesMountTargetFqdn}
              name: ${batchTaskEnvironmentVolumesName}
              type: ${batchTaskEnvironmentVolumesType}
          workingDirectory: ${batchTaskEnvironmentWorkingDirectory}
    

    Create BatchBatchTaskEnvironment Resource

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

    Constructor syntax

    new BatchBatchTaskEnvironment(name: string, args: BatchBatchTaskEnvironmentArgs, opts?: CustomResourceOptions);
    @overload
    def BatchBatchTaskEnvironment(resource_name: str,
                                  args: BatchBatchTaskEnvironmentArgs,
                                  opts: Optional[ResourceOptions] = None)
    
    @overload
    def BatchBatchTaskEnvironment(resource_name: str,
                                  opts: Optional[ResourceOptions] = None,
                                  compartment_id: Optional[str] = None,
                                  image_url: Optional[str] = None,
                                  defined_tags: Optional[Mapping[str, str]] = None,
                                  description: Optional[str] = None,
                                  display_name: Optional[str] = None,
                                  freeform_tags: Optional[Mapping[str, str]] = None,
                                  security_context: Optional[BatchBatchTaskEnvironmentSecurityContextArgs] = None,
                                  volumes: Optional[Sequence[BatchBatchTaskEnvironmentVolumeArgs]] = None,
                                  working_directory: Optional[str] = None)
    func NewBatchBatchTaskEnvironment(ctx *Context, name string, args BatchBatchTaskEnvironmentArgs, opts ...ResourceOption) (*BatchBatchTaskEnvironment, error)
    public BatchBatchTaskEnvironment(string name, BatchBatchTaskEnvironmentArgs args, CustomResourceOptions? opts = null)
    public BatchBatchTaskEnvironment(String name, BatchBatchTaskEnvironmentArgs args)
    public BatchBatchTaskEnvironment(String name, BatchBatchTaskEnvironmentArgs args, CustomResourceOptions options)
    
    type: oci:oci:BatchBatchTaskEnvironment
    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 BatchBatchTaskEnvironmentArgs
    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 BatchBatchTaskEnvironmentArgs
    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 BatchBatchTaskEnvironmentArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BatchBatchTaskEnvironmentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args BatchBatchTaskEnvironmentArgs
    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 batchBatchTaskEnvironmentResource = new Oci.Oci.BatchBatchTaskEnvironment("batchBatchTaskEnvironmentResource", new()
    {
        CompartmentId = "string",
        ImageUrl = "string",
        DefinedTags = 
        {
            { "string", "string" },
        },
        Description = "string",
        DisplayName = "string",
        FreeformTags = 
        {
            { "string", "string" },
        },
        SecurityContext = new Oci.Oci.Inputs.BatchBatchTaskEnvironmentSecurityContextArgs
        {
            FsGroup = 0,
            RunAsGroup = 0,
            RunAsUser = 0,
        },
        Volumes = new[]
        {
            new Oci.Oci.Inputs.BatchBatchTaskEnvironmentVolumeArgs
            {
                LocalMountDirectoryPath = "string",
                MountTargetExportPath = "string",
                MountTargetFqdn = "string",
                Name = "string",
                Type = "string",
            },
        },
        WorkingDirectory = "string",
    });
    
    example, err := oci.NewBatchBatchTaskEnvironment(ctx, "batchBatchTaskEnvironmentResource", &oci.BatchBatchTaskEnvironmentArgs{
    	CompartmentId: pulumi.String("string"),
    	ImageUrl:      pulumi.String("string"),
    	DefinedTags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	Description: pulumi.String("string"),
    	DisplayName: pulumi.String("string"),
    	FreeformTags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	SecurityContext: &oci.BatchBatchTaskEnvironmentSecurityContextArgs{
    		FsGroup:    pulumi.Int(0),
    		RunAsGroup: pulumi.Int(0),
    		RunAsUser:  pulumi.Int(0),
    	},
    	Volumes: oci.BatchBatchTaskEnvironmentVolumeArray{
    		&oci.BatchBatchTaskEnvironmentVolumeArgs{
    			LocalMountDirectoryPath: pulumi.String("string"),
    			MountTargetExportPath:   pulumi.String("string"),
    			MountTargetFqdn:         pulumi.String("string"),
    			Name:                    pulumi.String("string"),
    			Type:                    pulumi.String("string"),
    		},
    	},
    	WorkingDirectory: pulumi.String("string"),
    })
    
    var batchBatchTaskEnvironmentResource = new BatchBatchTaskEnvironment("batchBatchTaskEnvironmentResource", BatchBatchTaskEnvironmentArgs.builder()
        .compartmentId("string")
        .imageUrl("string")
        .definedTags(Map.of("string", "string"))
        .description("string")
        .displayName("string")
        .freeformTags(Map.of("string", "string"))
        .securityContext(BatchBatchTaskEnvironmentSecurityContextArgs.builder()
            .fsGroup(0)
            .runAsGroup(0)
            .runAsUser(0)
            .build())
        .volumes(BatchBatchTaskEnvironmentVolumeArgs.builder()
            .localMountDirectoryPath("string")
            .mountTargetExportPath("string")
            .mountTargetFqdn("string")
            .name("string")
            .type("string")
            .build())
        .workingDirectory("string")
        .build());
    
    batch_batch_task_environment_resource = oci.oci.BatchBatchTaskEnvironment("batchBatchTaskEnvironmentResource",
        compartment_id="string",
        image_url="string",
        defined_tags={
            "string": "string",
        },
        description="string",
        display_name="string",
        freeform_tags={
            "string": "string",
        },
        security_context={
            "fs_group": 0,
            "run_as_group": 0,
            "run_as_user": 0,
        },
        volumes=[{
            "local_mount_directory_path": "string",
            "mount_target_export_path": "string",
            "mount_target_fqdn": "string",
            "name": "string",
            "type": "string",
        }],
        working_directory="string")
    
    const batchBatchTaskEnvironmentResource = new oci.oci.BatchBatchTaskEnvironment("batchBatchTaskEnvironmentResource", {
        compartmentId: "string",
        imageUrl: "string",
        definedTags: {
            string: "string",
        },
        description: "string",
        displayName: "string",
        freeformTags: {
            string: "string",
        },
        securityContext: {
            fsGroup: 0,
            runAsGroup: 0,
            runAsUser: 0,
        },
        volumes: [{
            localMountDirectoryPath: "string",
            mountTargetExportPath: "string",
            mountTargetFqdn: "string",
            name: "string",
            type: "string",
        }],
        workingDirectory: "string",
    });
    
    type: oci:oci:BatchBatchTaskEnvironment
    properties:
        compartmentId: string
        definedTags:
            string: string
        description: string
        displayName: string
        freeformTags:
            string: string
        imageUrl: string
        securityContext:
            fsGroup: 0
            runAsGroup: 0
            runAsUser: 0
        volumes:
            - localMountDirectoryPath: string
              mountTargetExportPath: string
              mountTargetFqdn: string
              name: string
              type: string
        workingDirectory: string
    

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

    CompartmentId string
    (Updatable) The OCID of the compartment.
    ImageUrl string
    The URL of the ocir image.
    DefinedTags Dictionary<string, string>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    Description string
    (Updatable) The batch task environment description.
    DisplayName string
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. If not specified or provided as null or empty string, it be generated as "", where timeCreated corresponds with the resource creation time in ISO 8601 basic format, i.e. omitting separating punctuation, at second-level precision and no UTC offset. Example: batchtaskenvironment20250914115623.
    FreeformTags Dictionary<string, string>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    SecurityContext BatchBatchTaskEnvironmentSecurityContext

    Security context for container runtime configuration.

    See also docs.

    Volumes List<BatchBatchTaskEnvironmentVolume>
    List of volumes attached to the image. The use cases of the volumes are but not limited to: read the input of the task and write the output.
    WorkingDirectory string

    Container's working directory.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    CompartmentId string
    (Updatable) The OCID of the compartment.
    ImageUrl string
    The URL of the ocir image.
    DefinedTags map[string]string
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    Description string
    (Updatable) The batch task environment description.
    DisplayName string
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. If not specified or provided as null or empty string, it be generated as "", where timeCreated corresponds with the resource creation time in ISO 8601 basic format, i.e. omitting separating punctuation, at second-level precision and no UTC offset. Example: batchtaskenvironment20250914115623.
    FreeformTags map[string]string
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    SecurityContext BatchBatchTaskEnvironmentSecurityContextArgs

    Security context for container runtime configuration.

    See also docs.

    Volumes []BatchBatchTaskEnvironmentVolumeArgs
    List of volumes attached to the image. The use cases of the volumes are but not limited to: read the input of the task and write the output.
    WorkingDirectory string

    Container's working directory.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    compartmentId String
    (Updatable) The OCID of the compartment.
    imageUrl String
    The URL of the ocir image.
    definedTags Map<String,String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description String
    (Updatable) The batch task environment description.
    displayName String
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. If not specified or provided as null or empty string, it be generated as "", where timeCreated corresponds with the resource creation time in ISO 8601 basic format, i.e. omitting separating punctuation, at second-level precision and no UTC offset. Example: batchtaskenvironment20250914115623.
    freeformTags Map<String,String>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    securityContext BatchBatchTaskEnvironmentSecurityContext

    Security context for container runtime configuration.

    See also docs.

    volumes List<BatchBatchTaskEnvironmentVolume>
    List of volumes attached to the image. The use cases of the volumes are but not limited to: read the input of the task and write the output.
    workingDirectory String

    Container's working directory.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    compartmentId string
    (Updatable) The OCID of the compartment.
    imageUrl string
    The URL of the ocir image.
    definedTags {[key: string]: string}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description string
    (Updatable) The batch task environment description.
    displayName string
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. If not specified or provided as null or empty string, it be generated as "", where timeCreated corresponds with the resource creation time in ISO 8601 basic format, i.e. omitting separating punctuation, at second-level precision and no UTC offset. Example: batchtaskenvironment20250914115623.
    freeformTags {[key: string]: string}
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    securityContext BatchBatchTaskEnvironmentSecurityContext

    Security context for container runtime configuration.

    See also docs.

    volumes BatchBatchTaskEnvironmentVolume[]
    List of volumes attached to the image. The use cases of the volumes are but not limited to: read the input of the task and write the output.
    workingDirectory string

    Container's working directory.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    compartment_id str
    (Updatable) The OCID of the compartment.
    image_url str
    The URL of the ocir image.
    defined_tags Mapping[str, str]
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description str
    (Updatable) The batch task environment description.
    display_name str
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. If not specified or provided as null or empty string, it be generated as "", where timeCreated corresponds with the resource creation time in ISO 8601 basic format, i.e. omitting separating punctuation, at second-level precision and no UTC offset. Example: batchtaskenvironment20250914115623.
    freeform_tags Mapping[str, str]
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    security_context BatchBatchTaskEnvironmentSecurityContextArgs

    Security context for container runtime configuration.

    See also docs.

    volumes Sequence[BatchBatchTaskEnvironmentVolumeArgs]
    List of volumes attached to the image. The use cases of the volumes are but not limited to: read the input of the task and write the output.
    working_directory str

    Container's working directory.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    compartmentId String
    (Updatable) The OCID of the compartment.
    imageUrl String
    The URL of the ocir image.
    definedTags Map<String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description String
    (Updatable) The batch task environment description.
    displayName String
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. If not specified or provided as null or empty string, it be generated as "", where timeCreated corresponds with the resource creation time in ISO 8601 basic format, i.e. omitting separating punctuation, at second-level precision and no UTC offset. Example: batchtaskenvironment20250914115623.
    freeformTags Map<String>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    securityContext Property Map

    Security context for container runtime configuration.

    See also docs.

    volumes List<Property Map>
    List of volumes attached to the image. The use cases of the volumes are but not limited to: read the input of the task and write the output.
    workingDirectory String

    Container's working directory.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    Outputs

    All input properties are implicitly available as output properties. Additionally, the BatchBatchTaskEnvironment resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    State string
    The current state of the batch task environment.
    SystemTags Dictionary<string, string>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The date and time the batch task environment was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    TimeUpdated string
    The date and time the batch task environment was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    Id string
    The provider-assigned unique ID for this managed resource.
    State string
    The current state of the batch task environment.
    SystemTags map[string]string
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The date and time the batch task environment was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    TimeUpdated string
    The date and time the batch task environment was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    id String
    The provider-assigned unique ID for this managed resource.
    state String
    The current state of the batch task environment.
    systemTags Map<String,String>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The date and time the batch task environment was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    timeUpdated String
    The date and time the batch task environment was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    id string
    The provider-assigned unique ID for this managed resource.
    state string
    The current state of the batch task environment.
    systemTags {[key: string]: string}
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated string
    The date and time the batch task environment was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    timeUpdated string
    The date and time the batch task environment was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    id str
    The provider-assigned unique ID for this managed resource.
    state str
    The current state of the batch task environment.
    system_tags Mapping[str, str]
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    time_created str
    The date and time the batch task environment was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    time_updated str
    The date and time the batch task environment was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    id String
    The provider-assigned unique ID for this managed resource.
    state String
    The current state of the batch task environment.
    systemTags Map<String>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The date and time the batch task environment was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    timeUpdated String
    The date and time the batch task environment was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z

    Look up Existing BatchBatchTaskEnvironment Resource

    Get an existing BatchBatchTaskEnvironment 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?: BatchBatchTaskEnvironmentState, opts?: CustomResourceOptions): BatchBatchTaskEnvironment
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            compartment_id: Optional[str] = None,
            defined_tags: Optional[Mapping[str, str]] = None,
            description: Optional[str] = None,
            display_name: Optional[str] = None,
            freeform_tags: Optional[Mapping[str, str]] = None,
            image_url: Optional[str] = None,
            security_context: Optional[BatchBatchTaskEnvironmentSecurityContextArgs] = None,
            state: Optional[str] = None,
            system_tags: Optional[Mapping[str, str]] = None,
            time_created: Optional[str] = None,
            time_updated: Optional[str] = None,
            volumes: Optional[Sequence[BatchBatchTaskEnvironmentVolumeArgs]] = None,
            working_directory: Optional[str] = None) -> BatchBatchTaskEnvironment
    func GetBatchBatchTaskEnvironment(ctx *Context, name string, id IDInput, state *BatchBatchTaskEnvironmentState, opts ...ResourceOption) (*BatchBatchTaskEnvironment, error)
    public static BatchBatchTaskEnvironment Get(string name, Input<string> id, BatchBatchTaskEnvironmentState? state, CustomResourceOptions? opts = null)
    public static BatchBatchTaskEnvironment get(String name, Output<String> id, BatchBatchTaskEnvironmentState state, CustomResourceOptions options)
    resources:  _:    type: oci:oci:BatchBatchTaskEnvironment    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    CompartmentId string
    (Updatable) The OCID of the compartment.
    DefinedTags Dictionary<string, string>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    Description string
    (Updatable) The batch task environment description.
    DisplayName string
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. If not specified or provided as null or empty string, it be generated as "", where timeCreated corresponds with the resource creation time in ISO 8601 basic format, i.e. omitting separating punctuation, at second-level precision and no UTC offset. Example: batchtaskenvironment20250914115623.
    FreeformTags Dictionary<string, string>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    ImageUrl string
    The URL of the ocir image.
    SecurityContext BatchBatchTaskEnvironmentSecurityContext

    Security context for container runtime configuration.

    See also docs.

    State string
    The current state of the batch task environment.
    SystemTags Dictionary<string, string>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The date and time the batch task environment was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    TimeUpdated string
    The date and time the batch task environment was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    Volumes List<BatchBatchTaskEnvironmentVolume>
    List of volumes attached to the image. The use cases of the volumes are but not limited to: read the input of the task and write the output.
    WorkingDirectory string

    Container's working directory.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    CompartmentId string
    (Updatable) The OCID of the compartment.
    DefinedTags map[string]string
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    Description string
    (Updatable) The batch task environment description.
    DisplayName string
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. If not specified or provided as null or empty string, it be generated as "", where timeCreated corresponds with the resource creation time in ISO 8601 basic format, i.e. omitting separating punctuation, at second-level precision and no UTC offset. Example: batchtaskenvironment20250914115623.
    FreeformTags map[string]string
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    ImageUrl string
    The URL of the ocir image.
    SecurityContext BatchBatchTaskEnvironmentSecurityContextArgs

    Security context for container runtime configuration.

    See also docs.

    State string
    The current state of the batch task environment.
    SystemTags map[string]string
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The date and time the batch task environment was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    TimeUpdated string
    The date and time the batch task environment was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    Volumes []BatchBatchTaskEnvironmentVolumeArgs
    List of volumes attached to the image. The use cases of the volumes are but not limited to: read the input of the task and write the output.
    WorkingDirectory string

    Container's working directory.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    compartmentId String
    (Updatable) The OCID of the compartment.
    definedTags Map<String,String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description String
    (Updatable) The batch task environment description.
    displayName String
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. If not specified or provided as null or empty string, it be generated as "", where timeCreated corresponds with the resource creation time in ISO 8601 basic format, i.e. omitting separating punctuation, at second-level precision and no UTC offset. Example: batchtaskenvironment20250914115623.
    freeformTags Map<String,String>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    imageUrl String
    The URL of the ocir image.
    securityContext BatchBatchTaskEnvironmentSecurityContext

    Security context for container runtime configuration.

    See also docs.

    state String
    The current state of the batch task environment.
    systemTags Map<String,String>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The date and time the batch task environment was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    timeUpdated String
    The date and time the batch task environment was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    volumes List<BatchBatchTaskEnvironmentVolume>
    List of volumes attached to the image. The use cases of the volumes are but not limited to: read the input of the task and write the output.
    workingDirectory String

    Container's working directory.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    compartmentId string
    (Updatable) The OCID of the compartment.
    definedTags {[key: string]: string}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description string
    (Updatable) The batch task environment description.
    displayName string
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. If not specified or provided as null or empty string, it be generated as "", where timeCreated corresponds with the resource creation time in ISO 8601 basic format, i.e. omitting separating punctuation, at second-level precision and no UTC offset. Example: batchtaskenvironment20250914115623.
    freeformTags {[key: string]: string}
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    imageUrl string
    The URL of the ocir image.
    securityContext BatchBatchTaskEnvironmentSecurityContext

    Security context for container runtime configuration.

    See also docs.

    state string
    The current state of the batch task environment.
    systemTags {[key: string]: string}
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated string
    The date and time the batch task environment was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    timeUpdated string
    The date and time the batch task environment was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    volumes BatchBatchTaskEnvironmentVolume[]
    List of volumes attached to the image. The use cases of the volumes are but not limited to: read the input of the task and write the output.
    workingDirectory string

    Container's working directory.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    compartment_id str
    (Updatable) The OCID of the compartment.
    defined_tags Mapping[str, str]
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description str
    (Updatable) The batch task environment description.
    display_name str
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. If not specified or provided as null or empty string, it be generated as "", where timeCreated corresponds with the resource creation time in ISO 8601 basic format, i.e. omitting separating punctuation, at second-level precision and no UTC offset. Example: batchtaskenvironment20250914115623.
    freeform_tags Mapping[str, str]
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    image_url str
    The URL of the ocir image.
    security_context BatchBatchTaskEnvironmentSecurityContextArgs

    Security context for container runtime configuration.

    See also docs.

    state str
    The current state of the batch task environment.
    system_tags Mapping[str, str]
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    time_created str
    The date and time the batch task environment was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    time_updated str
    The date and time the batch task environment was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    volumes Sequence[BatchBatchTaskEnvironmentVolumeArgs]
    List of volumes attached to the image. The use cases of the volumes are but not limited to: read the input of the task and write the output.
    working_directory str

    Container's working directory.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    compartmentId String
    (Updatable) The OCID of the compartment.
    definedTags Map<String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description String
    (Updatable) The batch task environment description.
    displayName String
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. If not specified or provided as null or empty string, it be generated as "", where timeCreated corresponds with the resource creation time in ISO 8601 basic format, i.e. omitting separating punctuation, at second-level precision and no UTC offset. Example: batchtaskenvironment20250914115623.
    freeformTags Map<String>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    imageUrl String
    The URL of the ocir image.
    securityContext Property Map

    Security context for container runtime configuration.

    See also docs.

    state String
    The current state of the batch task environment.
    systemTags Map<String>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The date and time the batch task environment was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    timeUpdated String
    The date and time the batch task environment was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    volumes List<Property Map>
    List of volumes attached to the image. The use cases of the volumes are but not limited to: read the input of the task and write the output.
    workingDirectory String

    Container's working directory.

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

    Supporting Types

    BatchBatchTaskEnvironmentSecurityContext, BatchBatchTaskEnvironmentSecurityContextArgs

    FsGroup int
    A special supplemental group ID that applies to all containers in a pod.
    RunAsGroup int
    Group ID for running processes inside the container.
    RunAsUser int
    User ID for running processes inside the container.
    FsGroup int
    A special supplemental group ID that applies to all containers in a pod.
    RunAsGroup int
    Group ID for running processes inside the container.
    RunAsUser int
    User ID for running processes inside the container.
    fsGroup Integer
    A special supplemental group ID that applies to all containers in a pod.
    runAsGroup Integer
    Group ID for running processes inside the container.
    runAsUser Integer
    User ID for running processes inside the container.
    fsGroup number
    A special supplemental group ID that applies to all containers in a pod.
    runAsGroup number
    Group ID for running processes inside the container.
    runAsUser number
    User ID for running processes inside the container.
    fs_group int
    A special supplemental group ID that applies to all containers in a pod.
    run_as_group int
    Group ID for running processes inside the container.
    run_as_user int
    User ID for running processes inside the container.
    fsGroup Number
    A special supplemental group ID that applies to all containers in a pod.
    runAsGroup Number
    Group ID for running processes inside the container.
    runAsUser Number
    User ID for running processes inside the container.

    BatchBatchTaskEnvironmentVolume, BatchBatchTaskEnvironmentVolumeArgs

    LocalMountDirectoryPath string
    The local path to mount the NFS share to.
    MountTargetExportPath string
    The path to the directory on the NFS server to be mounted.
    MountTargetFqdn string
    The FQDN of the NFS server to connect to.
    Name string
    The name of the NfsVolume.
    Type string
    Discriminator for sub-entities.
    LocalMountDirectoryPath string
    The local path to mount the NFS share to.
    MountTargetExportPath string
    The path to the directory on the NFS server to be mounted.
    MountTargetFqdn string
    The FQDN of the NFS server to connect to.
    Name string
    The name of the NfsVolume.
    Type string
    Discriminator for sub-entities.
    localMountDirectoryPath String
    The local path to mount the NFS share to.
    mountTargetExportPath String
    The path to the directory on the NFS server to be mounted.
    mountTargetFqdn String
    The FQDN of the NFS server to connect to.
    name String
    The name of the NfsVolume.
    type String
    Discriminator for sub-entities.
    localMountDirectoryPath string
    The local path to mount the NFS share to.
    mountTargetExportPath string
    The path to the directory on the NFS server to be mounted.
    mountTargetFqdn string
    The FQDN of the NFS server to connect to.
    name string
    The name of the NfsVolume.
    type string
    Discriminator for sub-entities.
    local_mount_directory_path str
    The local path to mount the NFS share to.
    mount_target_export_path str
    The path to the directory on the NFS server to be mounted.
    mount_target_fqdn str
    The FQDN of the NFS server to connect to.
    name str
    The name of the NfsVolume.
    type str
    Discriminator for sub-entities.
    localMountDirectoryPath String
    The local path to mount the NFS share to.
    mountTargetExportPath String
    The path to the directory on the NFS server to be mounted.
    mountTargetFqdn String
    The FQDN of the NFS server to connect to.
    name String
    The name of the NfsVolume.
    type String
    Discriminator for sub-entities.

    Import

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

    $ pulumi import oci:oci/batchBatchTaskEnvironment:BatchBatchTaskEnvironment test_batch_task_environment "id"
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v3.16.0 published on Wednesday, Jan 28, 2026 by Pulumi
      Meet Neo: Your AI Platform Teammate