CfnQuotaShareProps

class aws_cdk.aws_batch.CfnQuotaShareProps(*, capacity_limits, job_queue, preemption_configuration, quota_share_name, resource_sharing_configuration, state=None, tags=None)

Bases: object

Properties for defining a CfnQuotaShare.

Parameters:

capacity_limits (Union[IResolvable, Sequence[Union[IResolvable, QuotaShareCapacityLimitProperty, Dict[str, Any]]]]) – 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 (Union[IResolvable, QuotaSharePreemptionConfigurationProperty, Dict[str, Any]])
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 (_).
resource_sharing_configuration (Union[IResolvable, QuotaShareResourceSharingConfigurationProperty, Dict[str, Any]])
state (Optional[str]) – 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 (Optional[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.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_batch as batch

cfn_quota_share_props = batch.CfnQuotaShareProps(
    capacity_limits=[batch.CfnQuotaShare.QuotaShareCapacityLimitProperty(
        capacity_unit="capacityUnit",
        max_capacity=123
    )],
    job_queue="jobQueue",
    preemption_configuration=batch.CfnQuotaShare.QuotaSharePreemptionConfigurationProperty(
        in_share_preemption="inSharePreemption"
    ),
    quota_share_name="quotaShareName",
    resource_sharing_configuration=batch.CfnQuotaShare.QuotaShareResourceSharingConfigurationProperty(
        strategy="strategy",

        # the properties below are optional
        borrow_limit=123
    ),

    # the properties below are optional
    state="state",
    tags={
        "tags_key": "tags"
    }
)

Attributes

capacity_limits

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

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

job_queue

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:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-quotashare.html#cfn-batch-quotashare-jobqueue

preemption_configuration

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

Type:: see

quota_share_name

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:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-quotashare.html#cfn-batch-quotashare-quotasharename

resource_sharing_configuration

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

Type:: see

state

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:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-quotashare.html#cfn-batch-quotashare-state

tags

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:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-quotashare.html#cfn-batch-quotashare-tags