Package software.amazon.awscdk.services.batch

Interface CfnQuotaShareProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnQuotaShareProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.130.0 (build 048a5ee)",
           date="2026-05-20T12:39:41.115Z")
@Stability(Stable)
public interface CfnQuotaShareProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnQuotaShare.

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.*;
 CfnQuotaShareProps cfnQuotaShareProps = CfnQuotaShareProps.builder()
         .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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-quotashare.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnQuotaShareProps.Builder	builder()
Object	getCapacityLimits()	A list that specifies the quantity and type of compute capacity allocated to the quota share.
String	getJobQueue()	The AWS Batch job queue associated with the quota share.
Object	getPreemptionConfiguration()	Returns union: either IResolvable or CfnQuotaShare.QuotaSharePreemptionConfigurationProperty
String	getQuotaShareName()	The name of the quota share.
Object	getResourceSharingConfiguration()	Returns union: either IResolvable or CfnQuotaShare.QuotaShareResourceSharingConfigurationProperty
default String	getState()	The state of the quota share.
default Map<String,String>	getTags()	The tags that you apply to the quota share to help you categorize and organize your resources.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCapacityLimits

@Stability(Stable)
@NotNull
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>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-quotashare.html#cfn-batch-quotashare-capacitylimits

getJobQueue

@Stability(Stable)
@NotNull
String getJobQueue()

The AWS Batch job queue associated with the quota share.

This can be the job queue name or ARN. A job queue must be in the VALID state before you can associate it with a quota share.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-quotashare.html#cfn-batch-quotashare-jobqueue

getPreemptionConfiguration

@Stability(Stable)
@NotNull
Object getPreemptionConfiguration()

Returns union: either IResolvable or CfnQuotaShare.QuotaSharePreemptionConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-quotashare.html#cfn-batch-quotashare-preemptionconfiguration

getQuotaShareName

@Stability(Stable)
@NotNull
String getQuotaShareName()

The name of the quota share.

It can be up to 128 characters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-quotashare.html#cfn-batch-quotashare-quotasharename

getResourceSharingConfiguration

@Stability(Stable)
@NotNull
Object getResourceSharingConfiguration()

Returns union: either IResolvable or CfnQuotaShare.QuotaShareResourceSharingConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-quotashare.html#cfn-batch-quotashare-resourcesharingconfiguration

getState

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

The state of the quota share.

If the quota share is ENABLED, it is able to accept jobs. If the quota share is DISABLED, new jobs won't be accepted but jobs already submitted can finish. The default state is ENABLED.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-quotashare.html#cfn-batch-quotashare-state

getTags

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

The tags that you apply to the quota share to help you categorize and organize your resources.

Each tag consists of a key and an optional value.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-quotashare.html#cfn-batch-quotashare-tags

builder

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

Returns:

a CfnQuotaShareProps.Builder of CfnQuotaShareProps