Interface ICfnQuotaShareProps

Properties for defining a CfnQuotaShare.

Namespace: Amazon.CDK.AWS.Batch

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface ICfnQuotaShareProps

Syntax (vb)

Public Interface ICfnQuotaShareProps

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Batch;

             var cfnQuotaShareProps = new CfnQuotaShareProps {
                 CapacityLimits = new [] { new QuotaShareCapacityLimitProperty {
                     CapacityUnit = "capacityUnit",
                     MaxCapacity = 123
                 } },
                 JobQueue = "jobQueue",
                 PreemptionConfiguration = new QuotaSharePreemptionConfigurationProperty {
                     InSharePreemption = "inSharePreemption"
                 },
                 QuotaShareName = "quotaShareName",
                 ResourceSharingConfiguration = new QuotaShareResourceSharingConfigurationProperty {
                     Strategy = "strategy",

                     // the properties below are optional
                     BorrowLimit = 123
                 },

                 // the properties below are optional
                 State = "state",
                 Tags = new Dictionary<string, string> {
                     { "tagsKey", "tags" }
                 }
             };

Synopsis

Properties

CapacityLimits	A list that specifies the quantity and type of compute capacity allocated to the quota share.
JobQueue	The AWS Batch job queue associated with the quota share.
PreemptionConfiguration	Properties for defining a `CfnQuotaShare`.
QuotaShareName	The name of the quota share.
ResourceSharingConfiguration	Properties for defining a `CfnQuotaShare`.
State	The state of the quota share.
Tags	The tags that you apply to the quota share to help you categorize and organize your resources.

Properties

CapacityLimits

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

object CapacityLimits { get; }

Property Value

object

Remarks

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

Type union: either IResolvable or (either IResolvable or CfnQuotaShare.IQuotaShareCapacityLimitProperty)[]

JobQueue

The AWS Batch job queue associated with the quota share.

string JobQueue { get; }

Property Value

string

Remarks

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

PreemptionConfiguration

Properties for defining a CfnQuotaShare.

object PreemptionConfiguration { get; }

Property Value

object

Remarks

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

Type union: either IResolvable or CfnQuotaShare.IQuotaSharePreemptionConfigurationProperty

QuotaShareName

The name of the quota share.

string QuotaShareName { get; }

Property Value

string

Remarks

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

ResourceSharingConfiguration

Properties for defining a CfnQuotaShare.

object ResourceSharingConfiguration { get; }

Property Value

object

Remarks

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

Type union: either IResolvable or CfnQuotaShare.IQuotaShareResourceSharingConfigurationProperty

State

The state of the quota share.

string? State { get; }

Property Value

string

Remarks

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