aws-native.batch.JobDefinition

Explore with Pulumi AI

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.105.0 published on Thursday, May 2, 2024 by Pulumi

pulumi/pulumi-aws-native

Create JobDefinition Resource

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

Constructor syntax

new JobDefinition(name: string, args: JobDefinitionArgs, opts?: CustomResourceOptions);

@overload
def JobDefinition(resource_name: str,
                  args: JobDefinitionArgs,
                  opts: Optional[ResourceOptions] = None)

@overload
def JobDefinition(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  type: Optional[str] = None,
                  platform_capabilities: Optional[Sequence[str]] = None,
                  eks_properties: Optional[JobDefinitionEksPropertiesArgs] = None,
                  job_definition_name: Optional[str] = None,
                  node_properties: Optional[JobDefinitionNodePropertiesArgs] = None,
                  parameters: Optional[Any] = None,
                  container_properties: Optional[JobDefinitionContainerPropertiesArgs] = None,
                  propagate_tags: Optional[bool] = None,
                  retry_strategy: Optional[JobDefinitionRetryStrategyArgs] = None,
                  scheduling_priority: Optional[int] = None,
                  tags: Optional[Any] = None,
                  timeout: Optional[JobDefinitionTimeoutArgs] = None,
                  ecs_properties: Optional[JobDefinitionEcsPropertiesArgs] = None)

func NewJobDefinition(ctx *Context, name string, args JobDefinitionArgs, opts ...ResourceOption) (*JobDefinition, error)

public JobDefinition(string name, JobDefinitionArgs args, CustomResourceOptions? opts = null)

public JobDefinition(String name, JobDefinitionArgs args)
public JobDefinition(String name, JobDefinitionArgs args, CustomResourceOptions options)

type: aws-native:batch:JobDefinition
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 JobDefinitionArgs: 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 JobDefinitionArgs: 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 JobDefinitionArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args JobDefinitionArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args JobDefinitionArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Example

The following reference example uses placeholder values for all input properties.

Coming soon!

Coming soon!

Coming soon!

Coming soon!

const jobDefinitionResource = new aws_native.batch.JobDefinition("jobDefinitionResource", {
    type: "string",
    platformCapabilities: ["string"],
    eksProperties: {
        podProperties: {
            containers: [{
                image: "string",
                args: ["string"],
                command: ["string"],
                env: [{
                    name: "string",
                    value: "string",
                }],
                imagePullPolicy: "string",
                name: "string",
                resources: {
                    limits: "any",
                    requests: "any",
                },
                securityContext: {
                    allowPrivilegeEscalation: false,
                    privileged: false,
                    readOnlyRootFilesystem: false,
                    runAsGroup: 0,
                    runAsNonRoot: false,
                    runAsUser: 0,
                },
                volumeMounts: [{
                    mountPath: "string",
                    name: "string",
                    readOnly: false,
                }],
            }],
            dnsPolicy: "string",
            hostNetwork: false,
            imagePullSecrets: [{
                name: "string",
            }],
            initContainers: [{
                image: "string",
                args: ["string"],
                command: ["string"],
                env: [{
                    name: "string",
                    value: "string",
                }],
                imagePullPolicy: "string",
                name: "string",
                resources: {
                    limits: "any",
                    requests: "any",
                },
                securityContext: {
                    allowPrivilegeEscalation: false,
                    privileged: false,
                    readOnlyRootFilesystem: false,
                    runAsGroup: 0,
                    runAsNonRoot: false,
                    runAsUser: 0,
                },
                volumeMounts: [{
                    mountPath: "string",
                    name: "string",
                    readOnly: false,
                }],
            }],
            metadata: {
                labels: "any",
            },
            serviceAccountName: "string",
            shareProcessNamespace: false,
            volumes: [{
                name: "string",
                emptyDir: {
                    medium: "string",
                    sizeLimit: "string",
                },
                hostPath: {
                    path: "string",
                },
                secret: {
                    secretName: "string",
                    optional: false,
                },
            }],
        },
    },
    jobDefinitionName: "string",
    nodeProperties: {
        mainNode: 0,
        nodeRangeProperties: [{
            targetNodes: "string",
            container: {
                image: "string",
                memory: 0,
                executionRoleArn: "string",
                networkConfiguration: {
                    assignPublicIp: "string",
                },
                fargatePlatformConfiguration: {
                    platformVersion: "string",
                },
                environment: [{
                    name: "string",
                    value: "string",
                }],
                instanceType: "string",
                jobRoleArn: "string",
                linuxParameters: {
                    devices: [{
                        containerPath: "string",
                        hostPath: "string",
                        permissions: ["string"],
                    }],
                    initProcessEnabled: false,
                    maxSwap: 0,
                    sharedMemorySize: 0,
                    swappiness: 0,
                    tmpfs: [{
                        containerPath: "string",
                        size: 0,
                        mountOptions: ["string"],
                    }],
                },
                privileged: false,
                command: ["string"],
                volumes: [{
                    efsVolumeConfiguration: {
                        fileSystemId: "string",
                        authorizationConfig: {
                            accessPointId: "string",
                            iam: "string",
                        },
                        rootDirectory: "string",
                        transitEncryption: "string",
                        transitEncryptionPort: 0,
                    },
                    host: {
                        sourcePath: "string",
                    },
                    name: "string",
                }],
                ephemeralStorage: {
                    sizeInGiB: 0,
                },
                logConfiguration: {
                    logDriver: "string",
                    options: "any",
                    secretOptions: [{
                        name: "string",
                        valueFrom: "string",
                    }],
                },
                readonlyRootFilesystem: false,
                repositoryCredentials: {
                    credentialsParameter: "string",
                },
                resourceRequirements: [{
                    type: "string",
                    value: "string",
                }],
                runtimePlatform: {
                    cpuArchitecture: "string",
                    operatingSystemFamily: "string",
                },
                secrets: [{
                    name: "string",
                    valueFrom: "string",
                }],
                ulimits: [{
                    hardLimit: 0,
                    name: "string",
                    softLimit: 0,
                }],
                user: "string",
                vcpus: 0,
                mountPoints: [{
                    containerPath: "string",
                    readOnly: false,
                    sourceVolume: "string",
                }],
            },
            ecsProperties: {
                taskProperties: [{
                    containers: [{
                        image: "string",
                        name: "string",
                        privileged: false,
                        essential: false,
                        dependsOn: [{
                            condition: "string",
                            containerName: "string",
                        }],
                        linuxParameters: {
                            devices: [{
                                containerPath: "string",
                                hostPath: "string",
                                permissions: ["string"],
                            }],
                            initProcessEnabled: false,
                            maxSwap: 0,
                            sharedMemorySize: 0,
                            swappiness: 0,
                            tmpfs: [{
                                containerPath: "string",
                                size: 0,
                                mountOptions: ["string"],
                            }],
                        },
                        logConfiguration: {
                            logDriver: "string",
                            options: "any",
                            secretOptions: [{
                                name: "string",
                                valueFrom: "string",
                            }],
                        },
                        environment: [{
                            name: "string",
                            value: "string",
                        }],
                        command: ["string"],
                        mountPoints: [{
                            containerPath: "string",
                            readOnly: false,
                            sourceVolume: "string",
                        }],
                        readonlyRootFilesystem: false,
                        repositoryCredentials: {
                            credentialsParameter: "string",
                        },
                        resourceRequirements: [{
                            type: "string",
                            value: "string",
                        }],
                        secrets: [{
                            name: "string",
                            valueFrom: "string",
                        }],
                        ulimits: [{
                            hardLimit: 0,
                            name: "string",
                            softLimit: 0,
                        }],
                        user: "string",
                    }],
                    ephemeralStorage: {
                        sizeInGiB: 0,
                    },
                    executionRoleArn: "string",
                    ipcMode: "string",
                    networkConfiguration: {
                        assignPublicIp: "string",
                    },
                    pidMode: "string",
                    platformVersion: "string",
                    runtimePlatform: {
                        cpuArchitecture: "string",
                        operatingSystemFamily: "string",
                    },
                    taskRoleArn: "string",
                    volumes: [{
                        efsVolumeConfiguration: {
                            fileSystemId: "string",
                            authorizationConfig: {
                                accessPointId: "string",
                                iam: "string",
                            },
                            rootDirectory: "string",
                            transitEncryption: "string",
                            transitEncryptionPort: 0,
                        },
                        host: {
                            sourcePath: "string",
                        },
                        name: "string",
                    }],
                }],
            },
            instanceTypes: ["string"],
        }],
        numNodes: 0,
    },
    parameters: "any",
    containerProperties: {
        image: "string",
        memory: 0,
        executionRoleArn: "string",
        networkConfiguration: {
            assignPublicIp: "string",
        },
        fargatePlatformConfiguration: {
            platformVersion: "string",
        },
        environment: [{
            name: "string",
            value: "string",
        }],
        instanceType: "string",
        jobRoleArn: "string",
        linuxParameters: {
            devices: [{
                containerPath: "string",
                hostPath: "string",
                permissions: ["string"],
            }],
            initProcessEnabled: false,
            maxSwap: 0,
            sharedMemorySize: 0,
            swappiness: 0,
            tmpfs: [{
                containerPath: "string",
                size: 0,
                mountOptions: ["string"],
            }],
        },
        privileged: false,
        command: ["string"],
        volumes: [{
            efsVolumeConfiguration: {
                fileSystemId: "string",
                authorizationConfig: {
                    accessPointId: "string",
                    iam: "string",
                },
                rootDirectory: "string",
                transitEncryption: "string",
                transitEncryptionPort: 0,
            },
            host: {
                sourcePath: "string",
            },
            name: "string",
        }],
        ephemeralStorage: {
            sizeInGiB: 0,
        },
        logConfiguration: {
            logDriver: "string",
            options: "any",
            secretOptions: [{
                name: "string",
                valueFrom: "string",
            }],
        },
        readonlyRootFilesystem: false,
        repositoryCredentials: {
            credentialsParameter: "string",
        },
        resourceRequirements: [{
            type: "string",
            value: "string",
        }],
        runtimePlatform: {
            cpuArchitecture: "string",
            operatingSystemFamily: "string",
        },
        secrets: [{
            name: "string",
            valueFrom: "string",
        }],
        ulimits: [{
            hardLimit: 0,
            name: "string",
            softLimit: 0,
        }],
        user: "string",
        vcpus: 0,
        mountPoints: [{
            containerPath: "string",
            readOnly: false,
            sourceVolume: "string",
        }],
    },
    propagateTags: false,
    retryStrategy: {
        attempts: 0,
        evaluateOnExit: [{
            action: "string",
            onExitCode: "string",
            onReason: "string",
            onStatusReason: "string",
        }],
    },
    schedulingPriority: 0,
    tags: "any",
    timeout: {
        attemptDurationSeconds: 0,
    },
    ecsProperties: {
        taskProperties: [{
            containers: [{
                image: "string",
                name: "string",
                privileged: false,
                essential: false,
                dependsOn: [{
                    condition: "string",
                    containerName: "string",
                }],
                linuxParameters: {
                    devices: [{
                        containerPath: "string",
                        hostPath: "string",
                        permissions: ["string"],
                    }],
                    initProcessEnabled: false,
                    maxSwap: 0,
                    sharedMemorySize: 0,
                    swappiness: 0,
                    tmpfs: [{
                        containerPath: "string",
                        size: 0,
                        mountOptions: ["string"],
                    }],
                },
                logConfiguration: {
                    logDriver: "string",
                    options: "any",
                    secretOptions: [{
                        name: "string",
                        valueFrom: "string",
                    }],
                },
                environment: [{
                    name: "string",
                    value: "string",
                }],
                command: ["string"],
                mountPoints: [{
                    containerPath: "string",
                    readOnly: false,
                    sourceVolume: "string",
                }],
                readonlyRootFilesystem: false,
                repositoryCredentials: {
                    credentialsParameter: "string",
                },
                resourceRequirements: [{
                    type: "string",
                    value: "string",
                }],
                secrets: [{
                    name: "string",
                    valueFrom: "string",
                }],
                ulimits: [{
                    hardLimit: 0,
                    name: "string",
                    softLimit: 0,
                }],
                user: "string",
            }],
            ephemeralStorage: {
                sizeInGiB: 0,
            },
            executionRoleArn: "string",
            ipcMode: "string",
            networkConfiguration: {
                assignPublicIp: "string",
            },
            pidMode: "string",
            platformVersion: "string",
            runtimePlatform: {
                cpuArchitecture: "string",
                operatingSystemFamily: "string",
            },
            taskRoleArn: "string",
            volumes: [{
                efsVolumeConfiguration: {
                    fileSystemId: "string",
                    authorizationConfig: {
                        accessPointId: "string",
                        iam: "string",
                    },
                    rootDirectory: "string",
                    transitEncryption: "string",
                    transitEncryptionPort: 0,
                },
                host: {
                    sourcePath: "string",
                },
                name: "string",
            }],
        }],
    },
});

Coming soon!

JobDefinition Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The JobDefinition resource accepts the following input properties:

Type string
ContainerProperties Pulumi.AwsNative.Batch.Inputs.JobDefinitionContainerProperties
EcsProperties Pulumi.AwsNative.Batch.Inputs.JobDefinitionEcsProperties
EksProperties Pulumi.AwsNative.Batch.Inputs.JobDefinitionEksProperties
JobDefinitionName string
NodeProperties Pulumi.AwsNative.Batch.Inputs.JobDefinitionNodeProperties
Parameters object: Search the CloudFormation User Guide for AWS::Batch::JobDefinition for more information about the expected schema for this property.
PlatformCapabilities List<string>
PropagateTags bool
RetryStrategy Pulumi.AwsNative.Batch.Inputs.JobDefinitionRetryStrategy
SchedulingPriority int
Tags object: Search the CloudFormation User Guide for AWS::Batch::JobDefinition for more information about the expected schema for this property.
Timeout Pulumi.AwsNative.Batch.Inputs.JobDefinitionTimeout

Type string
ContainerProperties JobDefinitionContainerPropertiesArgs
EcsProperties JobDefinitionEcsPropertiesArgs
EksProperties JobDefinitionEksPropertiesArgs
JobDefinitionName string
NodeProperties JobDefinitionNodePropertiesArgs
Parameters interface{}: Search the CloudFormation User Guide for AWS::Batch::JobDefinition for more information about the expected schema for this property.
PlatformCapabilities []string
PropagateTags bool
RetryStrategy JobDefinitionRetryStrategyArgs
SchedulingPriority int
Tags interface{}: Search the CloudFormation User Guide for AWS::Batch::JobDefinition for more information about the expected schema for this property.
Timeout JobDefinitionTimeoutArgs

type String
containerProperties JobDefinitionContainerProperties
ecsProperties JobDefinitionEcsProperties
eksProperties JobDefinitionEksProperties
jobDefinitionName String
nodeProperties JobDefinitionNodeProperties
parameters Object: Search the CloudFormation User Guide for AWS::Batch::JobDefinition for more information about the expected schema for this property.
platformCapabilities List<String>
propagateTags Boolean
retryStrategy JobDefinitionRetryStrategy
schedulingPriority Integer
tags Object: Search the CloudFormation User Guide for AWS::Batch::JobDefinition for more information about the expected schema for this property.
timeout JobDefinitionTimeout

type string
containerProperties JobDefinitionContainerProperties
ecsProperties JobDefinitionEcsProperties
eksProperties JobDefinitionEksProperties
jobDefinitionName string
nodeProperties JobDefinitionNodeProperties
parameters any: Search the CloudFormation User Guide for AWS::Batch::JobDefinition for more information about the expected schema for this property.
platformCapabilities string[]
propagateTags boolean
retryStrategy JobDefinitionRetryStrategy
schedulingPriority number
tags any: Search the CloudFormation User Guide for AWS::Batch::JobDefinition for more information about the expected schema for this property.
timeout JobDefinitionTimeout

type str
container_properties JobDefinitionContainerPropertiesArgs
ecs_properties JobDefinitionEcsPropertiesArgs
eks_properties JobDefinitionEksPropertiesArgs
job_definition_name str
node_properties JobDefinitionNodePropertiesArgs
parameters Any: Search the CloudFormation User Guide for AWS::Batch::JobDefinition for more information about the expected schema for this property.
platform_capabilities Sequence[str]
propagate_tags bool
retry_strategy JobDefinitionRetryStrategyArgs
scheduling_priority int
tags Any: Search the CloudFormation User Guide for AWS::Batch::JobDefinition for more information about the expected schema for this property.
timeout JobDefinitionTimeoutArgs

type String
containerProperties Property Map
ecsProperties Property Map
eksProperties Property Map
jobDefinitionName String
nodeProperties Property Map
parameters Any: Search the CloudFormation User Guide for AWS::Batch::JobDefinition for more information about the expected schema for this property.
platformCapabilities List<String>
propagateTags Boolean
retryStrategy Property Map
schedulingPriority Number
tags Any: Search the CloudFormation User Guide for AWS::Batch::JobDefinition for more information about the expected schema for this property.
timeout Property Map

Outputs

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

AwsId string
Id string: The provider-assigned unique ID for this managed resource.