Package software.amazon.awscdk.services.batch

Interface ConsumableResourceProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ConsumableResourceProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.140.0 (build 79fd58c)",
           date="2026-10-08T16:59:48.461Z")
@Stability(Stable)
public interface ConsumableResourceProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a Batch Consumable Resource.

Example:

 ConsumableResource licenseResource = ConsumableResource.Builder.create(this, "LicenseResource")
         .totalQuantity(100)
         .build();
 User user = new User(this, "MyUser");
 // Describe the resource and list the jobs that use it
 licenseResource.grants.read(user);
 // Change the total quantity, e.g. to replenish a NON_REPLENISHABLE pool
 licenseResource.grants.update(user);
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	ConsumableResourceProps.Builder	A builder for ConsumableResourceProps
static final class	ConsumableResourceProps.Jsii$Proxy	An implementation for ConsumableResourceProps

Method Summary

Modifier and Type	Method	Description
static ConsumableResourceProps.Builder	builder()
default String	getConsumableResourceName()	The name of the consumable resource.
default ConsumableResourceType	getResourceType()	The type of consumable resource.
default Map<String,String>	getTags()	Tags to apply to the consumable resource.
Number	getTotalQuantity()	The total quantity of the consumable resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getTotalQuantity

@Stability(Stable)
@NotNull
Number getTotalQuantity()

The total quantity of the consumable resource.

Must be a non-negative integer.

getConsumableResourceName

@Stability(Stable)
@Nullable
default String getConsumableResourceName()

The name of the consumable resource.

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

Default: - CloudFormation-generated name

getResourceType

@Stability(Stable)
@Nullable
default ConsumableResourceType getResourceType()

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

getTags

@Stability(Stable)
@Nullable
default Map<String,String> getTags()

Tags to apply to the consumable resource.

Default: - no tags

builder

@Stability(Stable)
static ConsumableResourceProps.Builder builder()

Returns:

a ConsumableResourceProps.Builder of ConsumableResourceProps