You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::Batch::Types::RegisterJobDefinitionRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb

Overview

Note:

When making an API call, you may pass RegisterJobDefinitionRequest data as a hash:

{
  job_definition_name: "String", # required
  type: "container", # required, accepts container
  parameters: {
    "String" => "String",
  },
  container_properties: {
    image: "String", # required
    vcpus: 1, # required
    memory: 1, # required
    command: ["String"],
    job_role_arn: "String",
    volumes: [
      {
        host: {
          source_path: "String",
        },
        name: "String",
      },
    ],
    environment: [
      {
        name: "String",
        value: "String",
      },
    ],
    mount_points: [
      {
        container_path: "String",
        read_only: false,
        source_volume: "String",
      },
    ],
    readonly_root_filesystem: false,
    privileged: false,
    ulimits: [
      {
        hard_limit: 1, # required
        name: "String", # required
        soft_limit: 1, # required
      },
    ],
    user: "String",
  },
  retry_strategy: {
    attempts: 1,
  },
}

Instance Attribute Summary collapse

Instance Attribute Details

#container_propertiesTypes::ContainerProperties

An object with various properties specific for container-based jobs. This parameter is required if the type parameter is container.



1678
1679
1680
1681
1682
1683
1684
1685
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 1678

class RegisterJobDefinitionRequest < Struct.new(
  :job_definition_name,
  :type,
  :parameters,
  :container_properties,
  :retry_strategy)
  include Aws::Structure
end

#job_definition_nameString

The name of the job definition to register. Up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

Returns:

  • (String)


1678
1679
1680
1681
1682
1683
1684
1685
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 1678

class RegisterJobDefinitionRequest < Struct.new(
  :job_definition_name,
  :type,
  :parameters,
  :container_properties,
  :retry_strategy)
  include Aws::Structure
end

#parametersHash<String,String>

Default parameter substitution placeholders to set in the job definition. Parameters are specified as a key-value pair mapping. Parameters in a SubmitJob request override any corresponding parameter defaults from the job definition.

Returns:

  • (Hash<String,String>)


1678
1679
1680
1681
1682
1683
1684
1685
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 1678

class RegisterJobDefinitionRequest < Struct.new(
  :job_definition_name,
  :type,
  :parameters,
  :container_properties,
  :retry_strategy)
  include Aws::Structure
end

#retry_strategyTypes::RetryStrategy

The retry strategy to use for failed jobs that are submitted with this job definition. Any retry strategy that is specified during a SubmitJob operation overrides the retry strategy defined here.



1678
1679
1680
1681
1682
1683
1684
1685
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 1678

class RegisterJobDefinitionRequest < Struct.new(
  :job_definition_name,
  :type,
  :parameters,
  :container_properties,
  :retry_strategy)
  include Aws::Structure
end

#typeString

The type of job definition.

Returns:

  • (String)


1678
1679
1680
1681
1682
1683
1684
1685
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 1678

class RegisterJobDefinitionRequest < Struct.new(
  :job_definition_name,
  :type,
  :parameters,
  :container_properties,
  :retry_strategy)
  include Aws::Structure
end