Package software.amazon.awscdk.services.batch

Class CfnQuotaShare

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.CfnQuotaShare
All Implemented Interfaces:
IInspectable, IQuotaShareRef, IEnvironmentAware, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)", date="2026-04-24T20:29:23.192Z") @Stability(Stable) public class CfnQuotaShare extends CfnResource implements IInspectable, IQuotaShareRef, ITaggableV2
Creates an AWS Batch quota share.

Each quota share operates as a virtual queue with a configured compute capacity, resource sharing strategy, and borrow limits.

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.*;
 CfnQuotaShare cfnQuotaShare = CfnQuotaShare.Builder.create(this, "MyCfnQuotaShare")
         .capacityLimits(List.of(QuotaShareCapacityLimitProperty.builder()
                 .capacityUnit("capacityUnit")
                 .maxCapacity(123)
                 .build()))
         .jobQueue("jobQueue")
         .preemptionConfiguration(QuotaSharePreemptionConfigurationProperty.builder()
                 .inSharePreemption("inSharePreemption")
                 .build())
         .quotaShareName("quotaShareName")
         .resourceSharingConfiguration(QuotaShareResourceSharingConfigurationProperty.builder()
                 .strategy("strategy")
                 // the properties below are optional
                 .borrowLimit(123)
                 .build())
         // the properties below are optional
         .state("state")
         .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

    • CfnQuotaShare

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

    • CfnQuotaShare

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

    • CfnQuotaShare

      @Stability(Stable) public CfnQuotaShare(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnQuotaShareProps props)
      Create a new AWS::Batch::QuotaShare.

      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

    • arnForQuotaShare

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

    • isCfnQuotaShare

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

      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.

    • getAttrQuotaShareArn

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

    • 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

    • getQuotaShareRef

      @Stability(Stable) @NotNull public QuotaShareReference getQuotaShareRef()
      A reference to a QuotaShare resource.
      Specified by:
      getQuotaShareRef in interface IQuotaShareRef

    • getCapacityLimits

      @Stability(Stable) @NotNull public Object getCapacityLimits()
      A list that specifies the quantity and type of compute capacity allocated to the quota share.

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnQuotaShare.QuotaShareCapacityLimitProperty>

    • setCapacityLimits

      @Stability(Stable) public void setCapacityLimits(@NotNull IResolvable value)
      A list that specifies the quantity and type of compute capacity allocated to the quota share.

    • setCapacityLimits

      @Stability(Stable) public void setCapacityLimits(@NotNull List<Object> value)
      A list that specifies the quantity and type of compute capacity allocated to the quota share.

    • getJobQueue

      @Stability(Stable) @NotNull public String getJobQueue()
      The AWS Batch job queue associated with the quota share.

    • setJobQueue

      @Stability(Stable) public void setJobQueue(@NotNull String value)
      The AWS Batch job queue associated with the quota share.

    • getPreemptionConfiguration

      @Stability(Stable) @NotNull public Object getPreemptionConfiguration()
      Returns union: either IResolvable or CfnQuotaShare.QuotaSharePreemptionConfigurationProperty

    • setPreemptionConfiguration

      @Stability(Stable) public void setPreemptionConfiguration(@NotNull IResolvable value)

    • setPreemptionConfiguration

      @Stability(Stable) public void setPreemptionConfiguration(@NotNull CfnQuotaShare.QuotaSharePreemptionConfigurationProperty value)

    • getQuotaShareName

      @Stability(Stable) @NotNull public String getQuotaShareName()
      The name of the quota share.

    • setQuotaShareName

      @Stability(Stable) public void setQuotaShareName(@NotNull String value)
      The name of the quota share.

    • getResourceSharingConfiguration

      @Stability(Stable) @NotNull public Object getResourceSharingConfiguration()
      Returns union: either IResolvable or CfnQuotaShare.QuotaShareResourceSharingConfigurationProperty

    • setResourceSharingConfiguration

      @Stability(Stable) public void setResourceSharingConfiguration(@NotNull IResolvable value)

    • setResourceSharingConfiguration

      @Stability(Stable) public void setResourceSharingConfiguration(@NotNull CfnQuotaShare.QuotaShareResourceSharingConfigurationProperty value)

    • getState

      @Stability(Stable) @Nullable public String getState()
      The state of the quota share.

    • setState

      @Stability(Stable) public void setState(@Nullable String value)
      The state of the quota share.

    • getTags

      @Stability(Stable) @Nullable public Map<String,String> getTags()
      The tags that you apply to the quota share 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 quota share to help you categorize and organize your resources.