Package software.amazon.awscdk.cfnpropertymixins.services.batch

Interface CfnSchedulingPolicyPropsMixin.ShareAttributesProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnSchedulingPolicyPropsMixin.ShareAttributesProperty.Jsii$Proxy

Enclosing class:

CfnSchedulingPolicyPropsMixin

@Stability(Stable)
public static interface CfnSchedulingPolicyPropsMixin.ShareAttributesProperty
extends software.amazon.jsii.JsiiSerializable

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:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.batch.*;
 ShareAttributesProperty shareAttributesProperty = ShareAttributesProperty.builder()
         .shareIdentifier("shareIdentifier")
         .weightFactor(123)
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-schedulingpolicy-shareattributes.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnSchedulingPolicyPropsMixin.ShareAttributesProperty.Builder	A builder for CfnSchedulingPolicyPropsMixin.ShareAttributesProperty
static final class	CfnSchedulingPolicyPropsMixin.ShareAttributesProperty.Jsii$Proxy	An implementation for CfnSchedulingPolicyPropsMixin.ShareAttributesProperty

Method Summary

Modifier and Type	Method	Description
static CfnSchedulingPolicyPropsMixin.ShareAttributesProperty.Builder	builder()
default String	getShareIdentifier()	A share identifier or share identifier prefix.
default Number	getWeightFactor()	The weight factor for the share identifier.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getShareIdentifier

@Stability(Stable)
@Nullable
default String getShareIdentifier()

A share identifier or share identifier prefix.

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 (*).

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-schedulingpolicy-shareattributes.html#cfn-batch-schedulingpolicy-shareattributes-shareidentifier

getWeightFactor

@Stability(Stable)
@Nullable
default Number getWeightFactor()

The weight factor for the 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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-schedulingpolicy-shareattributes.html#cfn-batch-schedulingpolicy-shareattributes-weightfactor

builder

@Stability(Stable)
static CfnSchedulingPolicyPropsMixin.ShareAttributesProperty.Builder builder()

Returns:

a CfnSchedulingPolicyPropsMixin.ShareAttributesProperty.Builder of CfnSchedulingPolicyPropsMixin.ShareAttributesProperty