# ConsumableResource

A Batch Consumable Resource.

Consumable resources are finite resources that are consumed by jobs,
such as third-party software licenses or API rate limits.

Extends: Construct › Resource › ConsumableResource
Implements: IResource, IConsumableResource, IEnvironmentAware, IConsumableResourceRef, IConstruct, IDependable

- CloudFormation: [`AWS::Batch::ConsumableResource`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-batch-consumableresource.html)
- L1 type: [`CfnConsumableResource`](/cdk/api/v2/docs/aws-cdk-lib.aws_batch.CfnConsumableResource.html)
- Source: [`aws-batch/lib/consumable-resource.ts`](https://github.com/aws/aws-cdk/blob/v2.274.0/packages/aws-cdk-lib/aws-batch/lib/consumable-resource.ts#L112)
- Type last changed: v2.273.0 · 8 Oct 2026

## Example

```ts
const taggedResource = new batch.ConsumableResource(this, 'TaggedResource', {
  totalQuantity: 100,
  tags: {
    Team: 'batch',
  },
});
```

## Initializer

```ts
new ConsumableResource(scope: Construct, id: string, props: ConsumableResourceProps)
```

## Construct Props

- `consumableResourceName`: string = CloudFormation-generated name — The name of the consumable resource.

  The name must be unique within the account and Region. Changing it replaces
  the resource.

- `resourceType`: [ConsumableResourceType](/cdk/api/v2/docs/aws-cdk-lib.aws_batch.ConsumableResourceType.html) = ConsumableResourceType.REPLENISHABLE — The type of consumable resource.

  Changing this property replaces the resource. Because the name must be unique
  within the account and Region, changing the type of a resource that has a
  `consumableResourceName` fails the deployment unless the name is changed as well.

  **Default:** ConsumableResourceType.REPLENISHABLE

- `tags`: { [key: string]: string } = no tags — Tags to apply to the consumable resource.

- `totalQuantity`: number (required) — The total quantity of the consumable resource.

  Must be a non-negative integer.

## Properties

- `consumableResourceArn`: string (required) — The ARN of this consumable resource.

- `consumableResourceName`: string (required) — The name of this consumable resource.

- `consumableResourceRef`: [ConsumableResourceReference](/cdk/api/v2/docs/aws-cdk-lib.interfaces.aws_batch.ConsumableResourceReference.html) (required) — A reference to a ConsumableResource resource.

- `env`: [ResourceEnvironment](/cdk/api/v2/docs/aws-cdk-lib.interfaces.ResourceEnvironment.html) (required) — The environment this resource belongs to.

  For resources that are created and managed in a Stack (those created by
  creating new class instances like `new Role()`, `new Bucket()`, etc.), this
  is always the same as the environment of the stack they belong to.

  For referenced resources (those obtained from referencing methods like
  `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they might be
  different than the stack they were imported into.

- `grants`: [ConsumableResourceGrants](/cdk/api/v2/docs/aws-cdk-lib.aws_batch.ConsumableResourceGrants.html) (required) — Collection of grant methods for this consumable resource.

- `node`: [Node](/cdk/api/v2/docs/constructs.Node.html) (required) — The tree node.

- `PROPERTY_INJECTION_ID`: string (required) (static) — Uniquely identifies this class.

- `stack`: [Stack](/cdk/api/v2/docs/aws-cdk-lib.Stack.html) (required) — The stack in which this resource is defined.

## Methods

- `applyCrossStackReferenceStrength(strength: ReferenceStrength): void` — Override the cross-stack reference strength for this resource.

  When set, any cross-stack reference to this resource will use the specified
  mechanism instead of the global default determined by the
  `@aws-cdk/core:defaultCrossStackReferences` context key. This is useful for
  selectively weakening specific references to avoid the "deadly embrace" problem
  without changing the app-wide default.

  **Parameters**

  - `strength` — - The reference strength to use for this resource.

- `applyRemovalPolicy(policy: RemovalPolicy): void` — Apply the given removal policy to this resource.

  The Removal Policy controls what happens to this resource when it stops
  being managed by CloudFormation, either because you've removed it from the
  CDK application or because you've made a change that requires the resource
  to be replaced.

  The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
  account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).

- `fromConsumableResourceArn(scope: Construct, id: string, consumableResourceArn: string): IConsumableResource` (static) — Import an existing consumable resource from its ARN.

- `isConstruct(x: any): boolean` (static) — Checks if `x` is a construct.

  Use this method instead of `instanceof` to properly detect `Construct`
  instances, even when the construct library is symlinked.

  Explanation: in JavaScript, multiple copies of the `constructs` library on
  disk are seen as independent, completely different libraries. As a
  consequence, the class `Construct` in each copy of the `constructs` library
  is seen as a different class, and an instance of one class will not test as
  `instanceof` the other class. `npm install` will not create installations
  like this, but users may manually symlink construct libraries together or
  use a monorepo tool: in those cases, multiple copies of the `constructs`
  library can be accidentally installed, and `instanceof` will behave
  unpredictably. It is safest to avoid using `instanceof`, and using
  this type-testing method instead.

  **Parameters**

  - `x` — Any object.

  **Returns:** true if `x` is an object created from a class which extends `Construct`.

- `isOwnedResource(construct: IConstruct): boolean` (static) — Returns true if the construct was created by CDK, and false otherwise.

- `isResource(construct: IConstruct): boolean` (static) — Check whether the given construct is a Resource.

- `toString(): string` — Returns a string representation of this construct.

- `with(...mixins: IMixin[]): IConstruct` — Applies one or more mixins to this construct.

  Mixins are applied in order. The list of constructs is captured at the
  start of the call, so constructs added by a mixin will not be visited.
  Use multiple `with()` calls if subsequent mixins should apply to added
  constructs.