Skip to content
v2.277.0

ShareAttributesProperty Struct ​

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

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

Example ​

ts
// 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,
};
python
# 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

share_attributes_property = batch.CfnSchedulingPolicy.ShareAttributesProperty(
    share_identifier="shareIdentifier",
    weight_factor=123
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.batch.*;

ShareAttributesProperty shareAttributesProperty = ShareAttributesProperty.builder()
        .shareIdentifier("shareIdentifier")
        .weightFactor(123)
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// 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 shareAttributesProperty = new ShareAttributesProperty {
    ShareIdentifier = "shareIdentifier",
    WeightFactor = 123
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

shareAttributesProperty := &ShareAttributesProperty{
	ShareIdentifier: jsii.String("shareIdentifier"),
	WeightFactor: jsii.Number(123),
}

Properties ​

shareIdentifieroptionalstringshare_identifieroptionalstrshareIdentifieroptionalStringShareIdentifieroptionalstringShareIdentifieroptional*string #
A share identifier or share identifier prefix.
notes

If the string ends with an asterisk (*), this entry specifies the weight factor to use for share identifiers that start with that prefix. The list of 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 UserA1 .

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

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

weightFactoroptionalnumberweight_factoroptionalint | floatweightFactoroptionalNumberWeightFactoroptionaldoubleWeightFactoroptional*float64 #
The weight factor for the share identifier.
notes

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.