aws-cdk-lib.aws_batch.CfnSchedulingPolicy.ShareAttributesProperty

interface ShareAttributesProperty

LanguageType name
.NETAmazon.CDK.AWS.Batch.CfnSchedulingPolicy.ShareAttributesProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsbatch#CfnSchedulingPolicy_ShareAttributesProperty
Javasoftware.amazon.awscdk.services.batch.CfnSchedulingPolicy.ShareAttributesProperty
Pythonaws_cdk.aws_batch.CfnSchedulingPolicy.ShareAttributesProperty
TypeScript aws-cdk-lib » aws_batch » CfnSchedulingPolicy » ShareAttributesProperty

Specifies the weights for the fair share identifiers for the fair share policy.

Fair share identifiers that aren't included have a default weight of 1.0 .

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 shareAttributesProperty: batch.CfnSchedulingPolicy.ShareAttributesProperty = {
  shareIdentifier: 'shareIdentifier',
  weightFactor: 123,
};

Properties

NameTypeDescription
shareIdentifier?stringA fair share identifier or fair share identifier prefix.
weightFactor?numberThe weight factor for the fair share identifier.

shareIdentifier?

Type: string (optional)

A fair share identifier or fair share identifier prefix.

If the string ends with an asterisk (*), this entry specifies the weight factor to use for fair share identifiers that start with that prefix. The list of fair share identifiers in a fair share policy can't overlap. For example, you can't have one that specifies a shareIdentifier of UserA* and another that specifies a shareIdentifier of UserA-1 .

There can be no more than 500 fair share identifiers active in a job queue.

The string is limited to 255 alphanumeric characters, and can be followed by an asterisk (*).


weightFactor?

Type: number (optional)

The weight factor for the fair share identifier.

The default value is 1.0. A lower value has a higher priority for compute resources. For example, jobs that use a share identifier with a weight factor of 0.125 (1/8) get 8 times the compute resources of jobs that use a share identifier with a weight factor of 1.

The smallest supported value is 0.0001, and the largest supported value is 999.9999.