Skip to main content

Aws/batch

@swamp/aws/batchv2026.11.14.1· AGPL-3.0-or-later· 7d agoBEHAVIORS
01README

AWS BATCH infrastructure models

02Release Notes
  • Updated: job_definition
03Behaviors7
@swamp/aws/batch/compute-environmentv2026.11.08.2compute_environment.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?stringAWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?stringAWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?stringAWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?stringAWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
Context?string
UpdatePolicy?object
UnmanagedvCpus?number
Type?string
ReplaceComputeEnvironment?boolean
ServiceRole?string
EksConfiguration?object
ComputeEnvironmentName?string
ComputeResources?object
State?string
EcsSettings?object
Tags?recordA key-value pair to associate with a resource.
fn create()
Create a Batch ComputeEnvironment
fn get(identifier: string)
Get a Batch ComputeEnvironment
ArgumentTypeDescription
identifierstringThe primary identifier of the Batch ComputeEnvironment
fn update()
Update a Batch ComputeEnvironment
fn delete(identifier: string)
Delete a Batch ComputeEnvironment
ArgumentTypeDescription
identifierstringThe primary identifier of the Batch ComputeEnvironment
fn sync()
Sync Batch ComputeEnvironment state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Batch ComputeEnvironment resources
ArgumentTypeDescription
maxPages?numberMaximum number of pages to fetch (default: 10)
resourceModel?stringJSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

state(infinite)— Batch ComputeEnvironment resource state
@swamp/aws/batch/consumable-resourcev2026.11.08.2consumable_resource.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?stringAWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?stringAWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?stringAWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?stringAWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
ConsumableResourceName?stringName of ConsumableResource.
TotalQuantity?numberTotal Quantity of ConsumableResource.
ResourceType?enumType of Consumable Resource.
Tags?recordA key-value pair to associate with a resource.
fn create()
Create a Batch ConsumableResource
fn get(identifier: string)
Get a Batch ConsumableResource
ArgumentTypeDescription
identifierstringThe primary identifier of the Batch ConsumableResource
fn update()
Update a Batch ConsumableResource
fn delete(identifier: string)
Delete a Batch ConsumableResource
ArgumentTypeDescription
identifierstringThe primary identifier of the Batch ConsumableResource
fn sync()
Sync Batch ConsumableResource state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Batch ConsumableResource resources
ArgumentTypeDescription
maxPages?numberMaximum number of pages to fetch (default: 10)
resourceModel?stringJSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

state(infinite)— Batch ConsumableResource resource state
@swamp/aws/batch/job-definitionv2026.11.14.1job_definition.ts

Global Arguments

ArgumentTypeDescription
accessKeyId?stringAWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?stringAWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?stringAWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?stringAWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
ContainerProperties?object
EcsProperties?object
NodeProperties?object
JobDefinitionName?string
SchedulingPriority?number
Parameters?record
PlatformCapabilities?array
PropagateTags?boolean
RetryStrategy?object
ResourceRetentionPolicy?object
Timeout?object
Type?string
Tags?recordA key-value pair to associate with a resource.
EksProperties?object
ConsumableResourceProperties?object
fn create()
Create a Batch JobDefinition
fn get(identifier: string)
Get a Batch JobDefinition
ArgumentTypeDescription
identifierstringThe primary identifier of the Batch JobDefinition
fn update()
Update a Batch JobDefinition
fn delete(identifier: string)
Delete a Batch JobDefinition
ArgumentTypeDescription
identifierstringThe primary identifier of the Batch JobDefinition
fn sync()
Sync Batch JobDefinition state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Batch JobDefinition resources
ArgumentTypeDescription
maxPages?numberMaximum number of pages to fetch (default: 10)
resourceModel?stringJSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

state(infinite)— Batch JobDefinition resource state
@swamp/aws/batch/job-queuev2026.11.08.2job_queue.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?stringAWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?stringAWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?stringAWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?stringAWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
JobQueueName?string
JobQueueType?string
ComputeEnvironmentOrder?array
ServiceEnvironmentOrder?array
JobStateTimeLimitActions?array
Priority?number
State?enum
SchedulingPolicyArn?string
Tags?recordA key-value pair to associate with a resource.
fn create()
Create a Batch JobQueue
fn get(identifier: string)
Get a Batch JobQueue
ArgumentTypeDescription
identifierstringThe primary identifier of the Batch JobQueue
fn update()
Update a Batch JobQueue
fn delete(identifier: string)
Delete a Batch JobQueue
ArgumentTypeDescription
identifierstringThe primary identifier of the Batch JobQueue
fn sync()
Sync Batch JobQueue state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Batch JobQueue resources
ArgumentTypeDescription
maxPages?numberMaximum number of pages to fetch (default: 10)
resourceModel?stringJSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

state(infinite)— Batch JobQueue resource state
@swamp/aws/batch/quota-sharev2026.11.08.2quota_share.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?stringAWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?stringAWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?stringAWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?stringAWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
QuotaShareName?stringThe name of the quota share. It can be up to 128 characters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).
JobQueue?stringThe AWS Batch job queue associated with the quota share. This can be the job queue name or ARN. A job queue must be in the `VALID` state before you can associate it with a quota share.
CapacityLimits?arrayA list that specifies the quantity and type of compute capacity allocated to the quota share.
ResourceSharingConfiguration?objectSpecifies whether a quota share reserves, lends, or both lends and borrows idle compute capacity.
PreemptionConfiguration?objectSpecifies the preemption behavior for jobs in a quota share.
State?enumThe state of the quota share. If the quota share is `ENABLED`, it is able to accept jobs. If the quota share is `DISABLED`, new jobs won't be accepted but jobs already submitted can finish. The default state is `ENABLED`.
Tags?recordThe tags that you apply to the quota share to help you categorize and organize your resources. Each tag consists of a key and an optional value.
fn create()
Create a Batch QuotaShare
fn get(identifier: string)
Get a Batch QuotaShare
ArgumentTypeDescription
identifierstringThe primary identifier of the Batch QuotaShare
fn update()
Update a Batch QuotaShare
fn delete(identifier: string)
Delete a Batch QuotaShare
ArgumentTypeDescription
identifierstringThe primary identifier of the Batch QuotaShare
fn sync()
Sync Batch QuotaShare state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Batch QuotaShare resources
ArgumentTypeDescription
maxPages?numberMaximum number of pages to fetch (default: 10)
resourceModel?stringJSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

state(infinite)— Batch QuotaShare resource state
@swamp/aws/batch/scheduling-policyv2026.11.08.1scheduling_policy.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?stringAWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?stringAWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?stringAWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?stringAWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
Name?stringName of Scheduling Policy.
FairsharePolicy?objectFair Share Policy for the Job Queue.
QuotaSharePolicy?objectQuota Share Policy for the Job Queue.
Tags?recordA key-value pair to associate with a resource.
fn create()
Create a Batch SchedulingPolicy
fn get(identifier: string)
Get a Batch SchedulingPolicy
ArgumentTypeDescription
identifierstringThe primary identifier of the Batch SchedulingPolicy
fn update()
Update a Batch SchedulingPolicy
fn delete(identifier: string)
Delete a Batch SchedulingPolicy
ArgumentTypeDescription
identifierstringThe primary identifier of the Batch SchedulingPolicy
fn sync()
Sync Batch SchedulingPolicy state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Batch SchedulingPolicy resources
ArgumentTypeDescription
maxPages?numberMaximum number of pages to fetch (default: 10)
resourceModel?stringJSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

state(infinite)— Batch SchedulingPolicy resource state
@swamp/aws/batch/service-environmentv2026.11.08.2service_environment.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?stringAWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?stringAWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?stringAWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?stringAWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
ServiceEnvironmentName?string
State?string
ServiceEnvironmentType?string
CapacityLimits?array
Tags?recordA key-value pair to associate with a resource.
fn create()
Create a Batch ServiceEnvironment
fn get(identifier: string)
Get a Batch ServiceEnvironment
ArgumentTypeDescription
identifierstringThe primary identifier of the Batch ServiceEnvironment
fn update()
Update a Batch ServiceEnvironment
fn delete(identifier: string)
Delete a Batch ServiceEnvironment
ArgumentTypeDescription
identifierstringThe primary identifier of the Batch ServiceEnvironment
fn sync()
Sync Batch ServiceEnvironment state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Batch ServiceEnvironment resources
ArgumentTypeDescription
maxPages?numberMaximum number of pages to fetch (default: 10)
resourceModel?stringJSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

state(infinite)— Batch ServiceEnvironment resource state
04Previous Versions19
2026.11.08.2AGPL-3.0-or-later
  • Updated: compute_environment, consumable_resource, job_definition, job_queue, quota_share, scheduling_policy, service_environment
2026.11.08.1AGPL-3.0-or-later
  • Updated: compute_environment, consumable_resource, job_definition, job_queue, quota_share, service_environment
2026.11.02.1AGPL-3.0-or-later
2026.10.29.1AGPL-3.0-or-later
  • Updated: compute_environment, quota_share
2026.10.25.1AGPL-3.0-or-later
  • Updated: compute_environment
2026.10.24.1AGPL-3.0-or-later
2026.10.23.2AGPL-3.0-or-later(was none)
  • Updated: compute_environment, consumable_resource, job_definition, job_queue, quota_share, scheduling_policy, service_environment
2026.10.13.1
  • Updated: compute_environment, consumable_resource, job_definition, job_queue, quota_share, scheduling_policy, service_environment
2026.10.08.1
2026.10.06.1
2026.10.04.1
2026.10.03.1
2026.10.02.1
2026.10.01.1
2026.09.30.1
2026.09.29.1
  • Updated: compute_environment
2026.09.28.1
2026.09.27.1
2026.09.26.1
05Stats
A
100 / 100
Downloads
52
Archive size
1.4 MB
Verified by Swamp
  • Has README or module doc2/2earned
  • README has a code example1/1earned
  • README is substantive1/1earned
  • Most symbols documented1/1earned
  • No slow types (deprecated)1/1earned
  • Dependencies pass trust audit2/2earned
  • Docs keep secrets in a vault1/1earned
  • Has description1/1earned
  • Platform support declared (or universal)2/2earned
  • License2/2earned
  • Verified public repository2/2earned
06Platforms
07Labels