Package software.amazon.awscdk.services.batch

Class CfnConsumableResource

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.batch.CfnConsumableResource
All Implemented Interfaces:
IInspectable, IConsumableResourceRef, IEnvironmentAware, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)", date="2025-12-18T18:20:05.648Z") @Stability(Stable) public class CfnConsumableResource extends CfnResource implements IInspectable, IConsumableResourceRef, ITaggableV2
The AWS::Batch::ConsumableResource resource specifies the parameters for an AWS Batch consumable resource.

For more information, see Resource-aware scheduling in the ** .

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.batch.*;
 CfnConsumableResource cfnConsumableResource = CfnConsumableResource.Builder.create(this, "MyCfnConsumableResource")
         .resourceType("resourceType")
         .totalQuantity(123)
         // the properties below are optional
         .consumableResourceName("consumableResourceName")
         .tags(Map.of(
                 "tagsKey", "tags"))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnConsumableResource

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

    • CfnConsumableResource

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

    • CfnConsumableResource

      @Stability(Stable) public CfnConsumableResource(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnConsumableResourceProps props)
      Create a new AWS::Batch::ConsumableResource.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • arnForConsumableResource

      @Stability(Stable) @NotNull public static String arnForConsumableResource(@NotNull IConsumableResourceRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnConsumableResource

      @Stability(Stable) @NotNull public static Boolean isCfnConsumableResource(@NotNull Object x)
      Checks whether the given object is a CfnConsumableResource.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrAvailableQuantity

      @Stability(Stable) @NotNull public Number getAttrAvailableQuantity()
      The amount of the consumable resource that is currently available to use.

    • getAttrConsumableResourceArn

      @Stability(Stable) @NotNull public String getAttrConsumableResourceArn()
      The Amazon Resource Name (ARN) of the consumable resource.

    • getAttrCreatedAt

      @Stability(Stable) @NotNull public Number getAttrCreatedAt()
      The Unix timestamp (in milliseconds) for when the consumable resource was created.

    • getAttrInUseQuantity

      @Stability(Stable) @NotNull public Number getAttrInUseQuantity()
      The amount of the consumable resource that is currently in use.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getConsumableResourceRef

      @Stability(Stable) @NotNull public ConsumableResourceReference getConsumableResourceRef()
      A reference to a ConsumableResource resource.
      Specified by:
      getConsumableResourceRef in interface IConsumableResourceRef

    • getResourceType

      @Stability(Stable) @NotNull public String getResourceType()
      Indicates whether the resource is available to be re-used after a job completes.

      Can be one of:.

    • setResourceType

      @Stability(Stable) public void setResourceType(@NotNull String value)
      Indicates whether the resource is available to be re-used after a job completes.

      Can be one of:.

    • getTotalQuantity

      @Stability(Stable) @NotNull public Number getTotalQuantity()
      The total amount of the consumable resource that is available.

    • setTotalQuantity

      @Stability(Stable) public void setTotalQuantity(@NotNull Number value)
      The total amount of the consumable resource that is available.

    • getConsumableResourceName

      @Stability(Stable) @Nullable public String getConsumableResourceName()
      The name of the consumable resource.

    • setConsumableResourceName

      @Stability(Stable) public void setConsumableResourceName(@Nullable String value)
      The name of the consumable resource.

    • getTags

      @Stability(Stable) @Nullable public Map<String,String> getTags()
      The tags that you apply to the consumable resource to help you categorize and organize your resources.

    • setTags

      @Stability(Stable) public void setTags(@Nullable Map<String,String> value)
      The tags that you apply to the consumable resource to help you categorize and organize your resources.