interface CfnQuotaShareProps

Language	Type name
.NET	Amazon.CDK.AWS.Batch.CfnQuotaShareProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsbatch#CfnQuotaShareProps
Java	software.amazon.awscdk.services.batch.CfnQuotaShareProps
Python	aws_cdk.aws_batch.CfnQuotaShareProps
TypeScript	aws-cdk-lib » aws_batch » CfnQuotaShareProps

Properties for defining a CfnQuotaShare.

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_batch as batch } from 'aws-cdk-lib';
const cfnQuotaShareProps: batch.CfnQuotaShareProps = {
  capacityLimits: [{
    capacityUnit: 'capacityUnit',
    maxCapacity: 123,
  }],
  jobQueue: 'jobQueue',
  preemptionConfiguration: {
    inSharePreemption: 'inSharePreemption',
  },
  quotaShareName: 'quotaShareName',
  resourceSharingConfiguration: {
    strategy: 'strategy',

    // the properties below are optional
    borrowLimit: 123,
  },

  // the properties below are optional
  state: 'state',
  tags: {
    tagsKey: 'tags',
  },
};

Properties

Name	Type	Description
capacityLimits	IResolvable | (IResolvable | QuotaShareCapacityLimitProperty)[]	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.
preemptionConfiguration	IResolvable | QuotaSharePreemptionConfigurationProperty
quotaShareName	string	The name of the quota share.
resourceSharingConfiguration	IResolvable | QuotaShareResourceSharingConfigurationProperty
state?	string	The state of the quota share.
tags?	{ [string]: string }	The tags that you apply to the quota share to help you categorize and organize your resources.

---

capacityLimits

Type: IResolvable | (IResolvable | QuotaShareCapacityLimitProperty)[]

A list that specifies the quantity and type of compute capacity allocated to the quota share.

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

---

jobQueue

Type: 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.

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

---

preemptionConfiguration

Type: IResolvable | QuotaSharePreemptionConfigurationProperty

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

---

quotaShareName

Type: 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 (_).

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

---

resourceSharingConfiguration

Type: IResolvable | QuotaShareResourceSharingConfigurationProperty

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

---

state?

Type: string (optional)

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

---

tags?

Type: { [string]: string } (optional)

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