1. Packages
  2. Packages
  3. AWS Cloud Control
  4. API Docs
  5. batch
  6. QuotaShare

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.63.0
published on Monday, May 4, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws-native

aws-native.batch.QuotaShare

aws-native logo

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.63.0
published on Monday, May 4, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws-native

    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.

    Create QuotaShare Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new QuotaShare(name: string, args: QuotaShareArgs, opts?: CustomResourceOptions);
    @overload
def QuotaShare(resource_name: str,
               args: QuotaShareArgs,
               opts: Optional[ResourceOptions] = None)

@overload
def QuotaShare(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               capacity_limits: Optional[Sequence[QuotaShareCapacityLimitArgs]] = None,
               job_queue: Optional[str] = None,
               preemption_configuration: Optional[QuotaSharePreemptionConfigurationArgs] = None,
               resource_sharing_configuration: Optional[QuotaShareResourceSharingConfigurationArgs] = None,
               quota_share_name: Optional[str] = None,
               state: Optional[QuotaShareState] = None,
               tags: Optional[Mapping[str, str]] = None)
    func NewQuotaShare(ctx *Context, name string, args QuotaShareArgs, opts ...ResourceOption) (*QuotaShare, error)
    public QuotaShare(string name, QuotaShareArgs args, CustomResourceOptions? opts = null)
    public QuotaShare(String name, QuotaShareArgs args)
public QuotaShare(String name, QuotaShareArgs args, CustomResourceOptions options)

    type: aws-native:batch:QuotaShare
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args QuotaShareArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args QuotaShareArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args QuotaShareArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args QuotaShareArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args QuotaShareArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    QuotaShare Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The QuotaShare resource accepts the following input properties:

    CapacityLimits List<Pulumi.AwsNative.Batch.Inputs.QuotaShareCapacityLimit>
    A list that specifies the quantity and type of compute capacity allocated to the quota share.
    JobQueue string
    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.
    PreemptionConfiguration Pulumi.AwsNative.Batch.Inputs.QuotaSharePreemptionConfiguration
    Specifies the preemption behavior for jobs in a quota share.
    ResourceSharingConfiguration Pulumi.AwsNative.Batch.Inputs.QuotaShareResourceSharingConfiguration
    Specifies whether a quota share reserves, lends, or both lends and borrows idle compute capacity.
    QuotaShareName string
    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 (_).
    State Pulumi.AwsNative.Batch.QuotaShareState
    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.
    Tags Dictionary<string, string>
    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.
    CapacityLimits []QuotaShareCapacityLimitArgs
    A list that specifies the quantity and type of compute capacity allocated to the quota share.
    JobQueue string
    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.
    PreemptionConfiguration QuotaSharePreemptionConfigurationArgs
    Specifies the preemption behavior for jobs in a quota share.
    ResourceSharingConfiguration QuotaShareResourceSharingConfigurationArgs
    Specifies whether a quota share reserves, lends, or both lends and borrows idle compute capacity.
    QuotaShareName string
    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 (_).
    State QuotaShareStateEnum
    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.
    Tags map[string]string
    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.
    capacityLimits List<QuotaShareCapacityLimit>
    A list that specifies the quantity and type of compute capacity allocated to the quota share.
    jobQueue String
    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.
    preemptionConfiguration QuotaSharePreemptionConfiguration
    Specifies the preemption behavior for jobs in a quota share.
    resourceSharingConfiguration QuotaShareResourceSharingConfiguration
    Specifies whether a quota share reserves, lends, or both lends and borrows idle compute capacity.
    quotaShareName String
    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 (_).
    state QuotaShareState
    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.
    tags Map<String,String>
    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.
    capacityLimits QuotaShareCapacityLimit[]
    A list that specifies the quantity and type of compute capacity allocated to the quota share.
    jobQueue string
    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.
    preemptionConfiguration QuotaSharePreemptionConfiguration
    Specifies the preemption behavior for jobs in a quota share.
    resourceSharingConfiguration QuotaShareResourceSharingConfiguration
    Specifies whether a quota share reserves, lends, or both lends and borrows idle compute capacity.
    quotaShareName string
    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 (_).
    state QuotaShareState
    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.
    tags {[key: string]: string}
    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.
    capacity_limits Sequence[QuotaShareCapacityLimitArgs]
    A list that specifies the quantity and type of compute capacity allocated to the quota share.
    job_queue str
    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.
    preemption_configuration QuotaSharePreemptionConfigurationArgs
    Specifies the preemption behavior for jobs in a quota share.
    resource_sharing_configuration QuotaShareResourceSharingConfigurationArgs
    Specifies whether a quota share reserves, lends, or both lends and borrows idle compute capacity.
    quota_share_name str
    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 (_).
    state QuotaShareState
    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.
    tags Mapping[str, str]
    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.
    capacityLimits List<Property Map>
    A list that specifies the quantity and type of compute capacity allocated to the quota share.
    jobQueue String
    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.
    preemptionConfiguration Property Map
    Specifies the preemption behavior for jobs in a quota share.
    resourceSharingConfiguration Property Map
    Specifies whether a quota share reserves, lends, or both lends and borrows idle compute capacity.
    quotaShareName String
    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 (_).
    state "ENABLED" | "DISABLED"
    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.
    tags Map<String>
    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.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the QuotaShare resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    QuotaShareArn string
    The Amazon Resource Name (ARN) of the quota share.
    Id string
    The provider-assigned unique ID for this managed resource.
    QuotaShareArn string
    The Amazon Resource Name (ARN) of the quota share.
    id String
    The provider-assigned unique ID for this managed resource.
    quotaShareArn String
    The Amazon Resource Name (ARN) of the quota share.
    id string
    The provider-assigned unique ID for this managed resource.
    quotaShareArn string
    The Amazon Resource Name (ARN) of the quota share.
    id str
    The provider-assigned unique ID for this managed resource.
    quota_share_arn str
    The Amazon Resource Name (ARN) of the quota share.
    id String
    The provider-assigned unique ID for this managed resource.
    quotaShareArn String
    The Amazon Resource Name (ARN) of the quota share.

    Supporting Types

    QuotaShareCapacityLimit, QuotaShareCapacityLimitArgs

    CapacityUnit string
    The unit of compute capacity for the capacityLimit. For example, ml.m5.large.
    MaxCapacity int
    The maximum capacity available for the quota share. This value represents the maximum quantity of a resource that can be allocated to jobs in the quota share without borrowing.
    CapacityUnit string
    The unit of compute capacity for the capacityLimit. For example, ml.m5.large.
    MaxCapacity int
    The maximum capacity available for the quota share. This value represents the maximum quantity of a resource that can be allocated to jobs in the quota share without borrowing.
    capacityUnit String
    The unit of compute capacity for the capacityLimit. For example, ml.m5.large.
    maxCapacity Integer
    The maximum capacity available for the quota share. This value represents the maximum quantity of a resource that can be allocated to jobs in the quota share without borrowing.
    capacityUnit string
    The unit of compute capacity for the capacityLimit. For example, ml.m5.large.
    maxCapacity number
    The maximum capacity available for the quota share. This value represents the maximum quantity of a resource that can be allocated to jobs in the quota share without borrowing.
    capacity_unit str
    The unit of compute capacity for the capacityLimit. For example, ml.m5.large.
    max_capacity int
    The maximum capacity available for the quota share. This value represents the maximum quantity of a resource that can be allocated to jobs in the quota share without borrowing.
    capacityUnit String
    The unit of compute capacity for the capacityLimit. For example, ml.m5.large.
    maxCapacity Number
    The maximum capacity available for the quota share. This value represents the maximum quantity of a resource that can be allocated to jobs in the quota share without borrowing.

    QuotaSharePreemptionConfiguration, QuotaSharePreemptionConfigurationArgs

    InSharePreemption Pulumi.AwsNative.Batch.QuotaSharePreemptionConfigurationInSharePreemption
    Specifies whether jobs within a quota share can be preempted by another, higher priority job in the same quota share.
    InSharePreemption QuotaSharePreemptionConfigurationInSharePreemption
    Specifies whether jobs within a quota share can be preempted by another, higher priority job in the same quota share.
    inSharePreemption QuotaSharePreemptionConfigurationInSharePreemption
    Specifies whether jobs within a quota share can be preempted by another, higher priority job in the same quota share.
    inSharePreemption QuotaSharePreemptionConfigurationInSharePreemption
    Specifies whether jobs within a quota share can be preempted by another, higher priority job in the same quota share.
    in_share_preemption QuotaSharePreemptionConfigurationInSharePreemption
    Specifies whether jobs within a quota share can be preempted by another, higher priority job in the same quota share.
    inSharePreemption "ENABLED" | "DISABLED"
    Specifies whether jobs within a quota share can be preempted by another, higher priority job in the same quota share.

    QuotaSharePreemptionConfigurationInSharePreemption, QuotaSharePreemptionConfigurationInSharePreemptionArgs

    Enabled
    ENABLED
    Disabled
    DISABLED
    QuotaSharePreemptionConfigurationInSharePreemptionEnabled
    ENABLED
    QuotaSharePreemptionConfigurationInSharePreemptionDisabled
    DISABLED
    Enabled
    ENABLED
    Disabled
    DISABLED
    Enabled
    ENABLED
    Disabled
    DISABLED
    ENABLED
    ENABLED
    DISABLED
    DISABLED
    "ENABLED"
    ENABLED
    "DISABLED"
    DISABLED

    QuotaShareResourceSharingConfiguration, QuotaShareResourceSharingConfigurationArgs

    Strategy Pulumi.AwsNative.Batch.QuotaShareResourceSharingConfigurationStrategy
    The resource sharing strategy for the quota share. The RESERVE strategy allows a quota share to reserve idle capacity for itself. LEND configures the share to lend its idle capacity to another share in need of capacity. The LEND_AND_BORROW strategy configures the share to borrow idle capacity from an underutilized share, as well as lend to another share.
    BorrowLimit int
    The maximum percentage of additional capacity that the quota share can borrow from other shares. BorrowLimit can only be applied to quota shares with a strategy of LEND_AND_BORROW. This value is expressed as a percentage of the quota share's configured CapacityLimits. The BorrowLimit is applied uniformly across all capacity units. For example, if the BorrowLimit is 200, the quota share can borrow up to 200% of its configured maxCapacity for each capacity unit. The default BorrowLimit is -1, which indicates unlimited borrowing.
    Strategy QuotaShareResourceSharingConfigurationStrategy
    The resource sharing strategy for the quota share. The RESERVE strategy allows a quota share to reserve idle capacity for itself. LEND configures the share to lend its idle capacity to another share in need of capacity. The LEND_AND_BORROW strategy configures the share to borrow idle capacity from an underutilized share, as well as lend to another share.
    BorrowLimit int
    The maximum percentage of additional capacity that the quota share can borrow from other shares. BorrowLimit can only be applied to quota shares with a strategy of LEND_AND_BORROW. This value is expressed as a percentage of the quota share's configured CapacityLimits. The BorrowLimit is applied uniformly across all capacity units. For example, if the BorrowLimit is 200, the quota share can borrow up to 200% of its configured maxCapacity for each capacity unit. The default BorrowLimit is -1, which indicates unlimited borrowing.
    strategy QuotaShareResourceSharingConfigurationStrategy
    The resource sharing strategy for the quota share. The RESERVE strategy allows a quota share to reserve idle capacity for itself. LEND configures the share to lend its idle capacity to another share in need of capacity. The LEND_AND_BORROW strategy configures the share to borrow idle capacity from an underutilized share, as well as lend to another share.
    borrowLimit Integer
    The maximum percentage of additional capacity that the quota share can borrow from other shares. BorrowLimit can only be applied to quota shares with a strategy of LEND_AND_BORROW. This value is expressed as a percentage of the quota share's configured CapacityLimits. The BorrowLimit is applied uniformly across all capacity units. For example, if the BorrowLimit is 200, the quota share can borrow up to 200% of its configured maxCapacity for each capacity unit. The default BorrowLimit is -1, which indicates unlimited borrowing.
    strategy QuotaShareResourceSharingConfigurationStrategy
    The resource sharing strategy for the quota share. The RESERVE strategy allows a quota share to reserve idle capacity for itself. LEND configures the share to lend its idle capacity to another share in need of capacity. The LEND_AND_BORROW strategy configures the share to borrow idle capacity from an underutilized share, as well as lend to another share.
    borrowLimit number
    The maximum percentage of additional capacity that the quota share can borrow from other shares. BorrowLimit can only be applied to quota shares with a strategy of LEND_AND_BORROW. This value is expressed as a percentage of the quota share's configured CapacityLimits. The BorrowLimit is applied uniformly across all capacity units. For example, if the BorrowLimit is 200, the quota share can borrow up to 200% of its configured maxCapacity for each capacity unit. The default BorrowLimit is -1, which indicates unlimited borrowing.
    strategy QuotaShareResourceSharingConfigurationStrategy
    The resource sharing strategy for the quota share. The RESERVE strategy allows a quota share to reserve idle capacity for itself. LEND configures the share to lend its idle capacity to another share in need of capacity. The LEND_AND_BORROW strategy configures the share to borrow idle capacity from an underutilized share, as well as lend to another share.
    borrow_limit int
    The maximum percentage of additional capacity that the quota share can borrow from other shares. BorrowLimit can only be applied to quota shares with a strategy of LEND_AND_BORROW. This value is expressed as a percentage of the quota share's configured CapacityLimits. The BorrowLimit is applied uniformly across all capacity units. For example, if the BorrowLimit is 200, the quota share can borrow up to 200% of its configured maxCapacity for each capacity unit. The default BorrowLimit is -1, which indicates unlimited borrowing.
    strategy "RESERVE" | "LEND" | "LEND_AND_BORROW"
    The resource sharing strategy for the quota share. The RESERVE strategy allows a quota share to reserve idle capacity for itself. LEND configures the share to lend its idle capacity to another share in need of capacity. The LEND_AND_BORROW strategy configures the share to borrow idle capacity from an underutilized share, as well as lend to another share.
    borrowLimit Number
    The maximum percentage of additional capacity that the quota share can borrow from other shares. BorrowLimit can only be applied to quota shares with a strategy of LEND_AND_BORROW. This value is expressed as a percentage of the quota share's configured CapacityLimits. The BorrowLimit is applied uniformly across all capacity units. For example, if the BorrowLimit is 200, the quota share can borrow up to 200% of its configured maxCapacity for each capacity unit. The default BorrowLimit is -1, which indicates unlimited borrowing.

    QuotaShareResourceSharingConfigurationStrategy, QuotaShareResourceSharingConfigurationStrategyArgs

    Reserve
    RESERVE
    Lend
    LEND
    LendAndBorrow
    LEND_AND_BORROW
    QuotaShareResourceSharingConfigurationStrategyReserve
    RESERVE
    QuotaShareResourceSharingConfigurationStrategyLend
    LEND
    QuotaShareResourceSharingConfigurationStrategyLendAndBorrow
    LEND_AND_BORROW
    Reserve
    RESERVE
    Lend
    LEND
    LendAndBorrow
    LEND_AND_BORROW
    Reserve
    RESERVE
    Lend
    LEND
    LendAndBorrow
    LEND_AND_BORROW
    RESERVE
    RESERVE
    LEND
    LEND
    LEND_AND_BORROW
    LEND_AND_BORROW
    "RESERVE"
    RESERVE
    "LEND"
    LEND
    "LEND_AND_BORROW"
    LEND_AND_BORROW

    QuotaShareState, QuotaShareStateArgs

    Enabled
    ENABLED
    Disabled
    DISABLED
    QuotaShareStateEnabled
    ENABLED
    QuotaShareStateDisabled
    DISABLED
    Enabled
    ENABLED
    Disabled
    DISABLED
    Enabled
    ENABLED
    Disabled
    DISABLED
    ENABLED
    ENABLED
    DISABLED
    DISABLED
    "ENABLED"
    ENABLED
    "DISABLED"
    DISABLED

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    Viewing docs for AWS Cloud Control v1.63.0
    published on Monday, May 4, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-aws-native
      Try Pulumi Cloud free. Your team will thank you.