CfnQuotaSharePropsMixin

class aws_cdk.cfn_property_mixins.aws_batch.CfnQuotaSharePropsMixin(props, *, strategy=None)

Bases: Mixin

Resource Type definition for AWS::Batch::QuotaShare.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-quotashare.html
CloudformationResource:: AWS::Batch::QuotaShare
Mixin:: true
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.cfn_property_mixins import aws_batch as batch
import aws_cdk as cdk

# merge_strategy: cdk.IMergeStrategy

cfn_quota_share_props_mixin = batch.CfnQuotaSharePropsMixin(batch.CfnQuotaShareMixinProps(
    capacity_limits=[batch.CfnQuotaSharePropsMixin.QuotaShareCapacityLimitProperty(
        capacity_unit="capacityUnit",
        max_capacity=123
    )],
    job_queue="jobQueue",
    preemption_configuration=batch.CfnQuotaSharePropsMixin.QuotaSharePreemptionConfigurationProperty(
        in_share_preemption="inSharePreemption"
    ),
    quota_share_name="quotaShareName",
    resource_sharing_configuration=batch.CfnQuotaSharePropsMixin.QuotaShareResourceSharingConfigurationProperty(
        borrow_limit=123,
        strategy="strategy"
    ),
    state="state",
    tags={
        "tags_key": "tags"
    }
),
    strategy=merge_strategy
)

Create a mixin to apply properties to AWS::Batch::QuotaShare.

Parameters:

props (Union[CfnQuotaShareMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[IMergeStrategy]) – Strategy for merging nested properties. Default: - PropertyMergeStrategy.combine()

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: None

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['capacityLimits', 'jobQueue', 'preemptionConfiguration', 'quotaShareName', 'resourceSharingConfiguration', 'state', 'tags']

Static Methods

classmethod is_mixin(x)

Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.

QuotaShareCapacityLimitProperty

class CfnQuotaSharePropsMixin.QuotaShareCapacityLimitProperty(*, capacity_unit=None, max_capacity=None)

Bases: object

Parameters:

capacity_unit (Optional[str]) – The unit of compute capacity for the capacityLimit.
max_capacity (Union[int, float, None]) – The maximum capacity available for the quota share. This value represents the maximum amount of resources that can be allocated to jobs in the quota share without borrowing

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-quotashare-quotasharecapacitylimit.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.cfn_property_mixins import aws_batch as batch

quota_share_capacity_limit_property = batch.CfnQuotaSharePropsMixin.QuotaShareCapacityLimitProperty(
    capacity_unit="capacityUnit",
    max_capacity=123
)

Attributes

capacity_unit

The unit of compute capacity for the capacityLimit.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-quotashare-quotasharecapacitylimit.html#cfn-batch-quotashare-quotasharecapacitylimit-capacityunit

max_capacity

The maximum capacity available for the quota share.

This value represents the maximum amount of resources that can be allocated to jobs in the quota share without borrowing

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-quotashare-quotasharecapacitylimit.html#cfn-batch-quotashare-quotasharecapacitylimit-maxcapacity

QuotaSharePreemptionConfigurationProperty

class CfnQuotaSharePropsMixin.QuotaSharePreemptionConfigurationProperty(*, in_share_preemption=None)

Bases: object

Parameters:: in_share_preemption (Optional[str]) – Whether preemption is enabled within the quota share.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-quotashare-quotasharepreemptionconfiguration.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.cfn_property_mixins import aws_batch as batch

quota_share_preemption_configuration_property = batch.CfnQuotaSharePropsMixin.QuotaSharePreemptionConfigurationProperty(
    in_share_preemption="inSharePreemption"
)

Attributes

in_share_preemption

Whether preemption is enabled within the quota share.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-quotashare-quotasharepreemptionconfiguration.html#cfn-batch-quotashare-quotasharepreemptionconfiguration-insharepreemption

QuotaShareResourceSharingConfigurationProperty

class CfnQuotaSharePropsMixin.QuotaShareResourceSharingConfigurationProperty(*, borrow_limit=None, strategy=None)

Bases: object

Parameters:

borrow_limit (Union[int, float, None]) – The maximum amount of compute capacity that can be borrowed. Use -1 for unlimited borrowing.
strategy (Optional[str]) – The resource sharing strategy.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-quotashare-quotashareresourcesharingconfiguration.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.cfn_property_mixins import aws_batch as batch

quota_share_resource_sharing_configuration_property = batch.CfnQuotaSharePropsMixin.QuotaShareResourceSharingConfigurationProperty(
    borrow_limit=123,
    strategy="strategy"
)

Attributes

borrow_limit

The maximum amount of compute capacity that can be borrowed.

Use -1 for unlimited borrowing.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-quotashare-quotashareresourcesharingconfiguration.html#cfn-batch-quotashare-quotashareresourcesharingconfiguration-borrowlimit

strategy

The resource sharing strategy.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-quotashare-quotashareresourcesharingconfiguration.html#cfn-batch-quotashare-quotashareresourcesharingconfiguration-strategy