Package software.amazon.awscdk.services.batch

Class ConsumableResource

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.batch.ConsumableResource

All Implemented Interfaces:

IConsumableResourceRef, IEnvironmentAware, IResource, IConsumableResource, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.140.0 (build 79fd58c)",
           date="2026-10-08T16:59:48.460Z")
@Stability(Stable)
public class ConsumableResource
extends Resource
implements IConsumableResource

A Batch Consumable Resource.

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

Example:

 ConsumableResource taggedResource = ConsumableResource.Builder.create(this, "TaggedResource")
         .totalQuantity(100)
         .tags(Map.of(
                 "Team", "batch"))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ConsumableResource.Builder	A fluent builder for ConsumableResource.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.batch.IConsumableResource

IConsumableResource.Jsii$Default, IConsumableResource.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource

IResource.Jsii$Default

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROPERTY_INJECTION_ID	Uniquely identifies this class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ConsumableResource(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	ConsumableResource(software.amazon.jsii.JsiiObjectRef objRef)
	ConsumableResource(software.constructs.Construct scope, String id, ConsumableResourceProps props)

Method Summary

Modifier and Type	Method	Description
static IConsumableResource	fromConsumableResourceArn(software.constructs.Construct scope, String id, String consumableResourceArn)	Import an existing consumable resource from its ARN.
String	getConsumableResourceArn()	The ARN of this consumable resource.
String	getConsumableResourceName()	The name of this consumable resource.
ConsumableResourceReference	getConsumableResourceRef()	A reference to a ConsumableResource resource.
ConsumableResourceGrants	getGrants()	Collection of grant methods for this consumable resource.

Methods inherited from class software.amazon.awscdk.Resource

applyCrossStackReferenceStrength, applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource, with

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode, with

Methods inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware

getEnv

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getStack

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

PROPERTY_INJECTION_ID

@Stability(Stable)
public static final String PROPERTY_INJECTION_ID

Uniquely identifies this class.

Constructor Details

ConsumableResource

protected ConsumableResource(software.amazon.jsii.JsiiObjectRef objRef)

ConsumableResource

protected ConsumableResource(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

ConsumableResource

@Stability(Stable)
public ConsumableResource(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 ConsumableResourceProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Details

fromConsumableResourceArn

@Stability(Stable)
@NotNull
public static IConsumableResource fromConsumableResourceArn(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 String consumableResourceArn)

Import an existing consumable resource from its ARN.

Parameters:

scope - This parameter is required.

id - This parameter is required.

consumableResourceArn - This parameter is required.

getConsumableResourceArn

@Stability(Stable)
@NotNull
public String getConsumableResourceArn()

The ARN of this consumable resource.

Specified by:

getConsumableResourceArn in interface IConsumableResource

getConsumableResourceName

@Stability(Stable)
@NotNull
public String getConsumableResourceName()

The name of this consumable resource.

Specified by:

getConsumableResourceName in interface IConsumableResource

getConsumableResourceRef

@Stability(Stable)
@NotNull
public ConsumableResourceReference getConsumableResourceRef()

A reference to a ConsumableResource resource.

Specified by:

getConsumableResourceRef in interface IConsumableResourceRef

getGrants

@Stability(Stable)
@NotNull
public ConsumableResourceGrants getGrants()

Collection of grant methods for this consumable resource.

Specified by:

getGrants in interface IConsumableResource