AWS Fundamentals Logo
AWS Fundamentals
AWS::Batch::ConsumableResource

Batch ConsumableResource

Resource Type definition for AWS::Batch::ConsumableResource

Properties

4 configurable properties. 2 required. Click a row to see details.

Filter:
PropertyTypeFlags
ResourceType
string
RequiredCreate-only
TotalQuantity
integer
Required
ConsumableResourceName
string
Create-only
Tags
object
Create-only

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

AttributeTypeDescription
AvailableQuantityintegerAvailable Quantity of ConsumableResource.
ConsumableResourceArnstring-
CreatedAtinteger-
InUseQuantityintegerIn-use Quantity of ConsumableResource.

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml
AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::Batch::ConsumableResource

Resources:
  MyResource:
    Type: AWS::Batch::ConsumableResource
    Properties:
      ResourceType: "value"
      TotalQuantity: 1
      Tags:
        - Key: Environment
          Value: Production

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

Batch:CreateConsumableResourceBatch:TagResource

read

Batch:DescribeConsumableResource

update

Batch:UpdateConsumableResourceBatch:TagResourceBatch:UnTagResource

delete

Batch:DescribeConsumableResourceBatch:DeleteConsumableResource

list

Batch:ListConsumableResources

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

ServiceBatch
Properties8
Required2
TaggingSupported
Primary IDConsumableResourceArn

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

ConsumableResourceNameResourceTypeTags

Related Resources

External Links