We recommend new projects start with resources from the AWS provider.
aws-native.batch.SchedulingPolicy
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
Resource Type schema for AWS::Batch::SchedulingPolicy
Create SchedulingPolicy Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new SchedulingPolicy(name: string, args?: SchedulingPolicyArgs, opts?: CustomResourceOptions);
@overload
def SchedulingPolicy(resource_name: str,
args: Optional[SchedulingPolicyArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def SchedulingPolicy(resource_name: str,
opts: Optional[ResourceOptions] = None,
fairshare_policy: Optional[SchedulingPolicyFairsharePolicyArgs] = None,
name: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None)
func NewSchedulingPolicy(ctx *Context, name string, args *SchedulingPolicyArgs, opts ...ResourceOption) (*SchedulingPolicy, error)
public SchedulingPolicy(string name, SchedulingPolicyArgs? args = null, CustomResourceOptions? opts = null)
public SchedulingPolicy(String name, SchedulingPolicyArgs args)
public SchedulingPolicy(String name, SchedulingPolicyArgs args, CustomResourceOptions options)
type: aws-native:batch:SchedulingPolicy
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args SchedulingPolicyArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args SchedulingPolicyArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args SchedulingPolicyArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args SchedulingPolicyArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args SchedulingPolicyArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
SchedulingPolicy Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The SchedulingPolicy resource accepts the following input properties:
- Pulumi.
Aws Native. Batch. Inputs. Scheduling Policy Fairshare Policy - The fair share policy of the scheduling policy.
- Name string
- Name of Scheduling Policy.
- Dictionary<string, string>
- A key-value pair to associate with a resource.
- Scheduling
Policy Fairshare Policy Args - The fair share policy of the scheduling policy.
- Name string
- Name of Scheduling Policy.
- map[string]string
- A key-value pair to associate with a resource.
- Scheduling
Policy Fairshare Policy - The fair share policy of the scheduling policy.
- name String
- Name of Scheduling Policy.
- Map<String,String>
- A key-value pair to associate with a resource.
- Scheduling
Policy Fairshare Policy - The fair share policy of the scheduling policy.
- name string
- Name of Scheduling Policy.
- {[key: string]: string}
- A key-value pair to associate with a resource.
- Scheduling
Policy Fairshare Policy Args - The fair share policy of the scheduling policy.
- name str
- Name of Scheduling Policy.
- Mapping[str, str]
- A key-value pair to associate with a resource.
- Property Map
- The fair share policy of the scheduling policy.
- name String
- Name of Scheduling Policy.
- Map<String>
- A key-value pair to associate with a resource.
Outputs
All input properties are implicitly available as output properties. Additionally, the SchedulingPolicy resource produces the following output properties:
Supporting Types
SchedulingPolicyFairsharePolicy, SchedulingPolicyFairsharePolicyArgs
- Compute
Reservation double A value used to reserve some of the available maximum vCPU for fair share identifiers that aren't already used.
The reserved ratio is
( *computeReservation* /100)^ *ActiveFairShares*
where*ActiveFairShares*
is the number of active fair share identifiers.For example, a
computeReservation
value of 50 indicates that AWS Batch reserves 50% of the maximum available vCPU if there's only one fair share identifier. It reserves 25% if there are two fair share identifiers. It reserves 12.5% if there are three fair share identifiers. AcomputeReservation
value of 25 indicates that AWS Batch should reserve 25% of the maximum available vCPU if there's only one fair share identifier, 6.25% if there are two fair share identifiers, and 1.56% if there are three fair share identifiers.The minimum value is 0 and the maximum value is 99.
- double
- The amount of time (in seconds) to use to calculate a fair share percentage for each fair share identifier in use. A value of zero (0) indicates that only current usage is measured. The decay allows for more recently run jobs to have more weight than jobs that ran earlier. The maximum supported value is 604800 (1 week).
- List<Pulumi.
Aws Native. Batch. Inputs. Scheduling Policy Share Attributes> - List of Share Attributes
- Compute
Reservation float64 A value used to reserve some of the available maximum vCPU for fair share identifiers that aren't already used.
The reserved ratio is
( *computeReservation* /100)^ *ActiveFairShares*
where*ActiveFairShares*
is the number of active fair share identifiers.For example, a
computeReservation
value of 50 indicates that AWS Batch reserves 50% of the maximum available vCPU if there's only one fair share identifier. It reserves 25% if there are two fair share identifiers. It reserves 12.5% if there are three fair share identifiers. AcomputeReservation
value of 25 indicates that AWS Batch should reserve 25% of the maximum available vCPU if there's only one fair share identifier, 6.25% if there are two fair share identifiers, and 1.56% if there are three fair share identifiers.The minimum value is 0 and the maximum value is 99.
- float64
- The amount of time (in seconds) to use to calculate a fair share percentage for each fair share identifier in use. A value of zero (0) indicates that only current usage is measured. The decay allows for more recently run jobs to have more weight than jobs that ran earlier. The maximum supported value is 604800 (1 week).
- []Scheduling
Policy Share Attributes - List of Share Attributes
- compute
Reservation Double A value used to reserve some of the available maximum vCPU for fair share identifiers that aren't already used.
The reserved ratio is
( *computeReservation* /100)^ *ActiveFairShares*
where*ActiveFairShares*
is the number of active fair share identifiers.For example, a
computeReservation
value of 50 indicates that AWS Batch reserves 50% of the maximum available vCPU if there's only one fair share identifier. It reserves 25% if there are two fair share identifiers. It reserves 12.5% if there are three fair share identifiers. AcomputeReservation
value of 25 indicates that AWS Batch should reserve 25% of the maximum available vCPU if there's only one fair share identifier, 6.25% if there are two fair share identifiers, and 1.56% if there are three fair share identifiers.The minimum value is 0 and the maximum value is 99.
- Double
- The amount of time (in seconds) to use to calculate a fair share percentage for each fair share identifier in use. A value of zero (0) indicates that only current usage is measured. The decay allows for more recently run jobs to have more weight than jobs that ran earlier. The maximum supported value is 604800 (1 week).
- List<Scheduling
Policy Share Attributes> - List of Share Attributes
- compute
Reservation number A value used to reserve some of the available maximum vCPU for fair share identifiers that aren't already used.
The reserved ratio is
( *computeReservation* /100)^ *ActiveFairShares*
where*ActiveFairShares*
is the number of active fair share identifiers.For example, a
computeReservation
value of 50 indicates that AWS Batch reserves 50% of the maximum available vCPU if there's only one fair share identifier. It reserves 25% if there are two fair share identifiers. It reserves 12.5% if there are three fair share identifiers. AcomputeReservation
value of 25 indicates that AWS Batch should reserve 25% of the maximum available vCPU if there's only one fair share identifier, 6.25% if there are two fair share identifiers, and 1.56% if there are three fair share identifiers.The minimum value is 0 and the maximum value is 99.
- number
- The amount of time (in seconds) to use to calculate a fair share percentage for each fair share identifier in use. A value of zero (0) indicates that only current usage is measured. The decay allows for more recently run jobs to have more weight than jobs that ran earlier. The maximum supported value is 604800 (1 week).
- Scheduling
Policy Share Attributes[] - List of Share Attributes
- compute_
reservation float A value used to reserve some of the available maximum vCPU for fair share identifiers that aren't already used.
The reserved ratio is
( *computeReservation* /100)^ *ActiveFairShares*
where*ActiveFairShares*
is the number of active fair share identifiers.For example, a
computeReservation
value of 50 indicates that AWS Batch reserves 50% of the maximum available vCPU if there's only one fair share identifier. It reserves 25% if there are two fair share identifiers. It reserves 12.5% if there are three fair share identifiers. AcomputeReservation
value of 25 indicates that AWS Batch should reserve 25% of the maximum available vCPU if there's only one fair share identifier, 6.25% if there are two fair share identifiers, and 1.56% if there are three fair share identifiers.The minimum value is 0 and the maximum value is 99.
- float
- The amount of time (in seconds) to use to calculate a fair share percentage for each fair share identifier in use. A value of zero (0) indicates that only current usage is measured. The decay allows for more recently run jobs to have more weight than jobs that ran earlier. The maximum supported value is 604800 (1 week).
- Sequence[Scheduling
Policy Share Attributes] - List of Share Attributes
- compute
Reservation Number A value used to reserve some of the available maximum vCPU for fair share identifiers that aren't already used.
The reserved ratio is
( *computeReservation* /100)^ *ActiveFairShares*
where*ActiveFairShares*
is the number of active fair share identifiers.For example, a
computeReservation
value of 50 indicates that AWS Batch reserves 50% of the maximum available vCPU if there's only one fair share identifier. It reserves 25% if there are two fair share identifiers. It reserves 12.5% if there are three fair share identifiers. AcomputeReservation
value of 25 indicates that AWS Batch should reserve 25% of the maximum available vCPU if there's only one fair share identifier, 6.25% if there are two fair share identifiers, and 1.56% if there are three fair share identifiers.The minimum value is 0 and the maximum value is 99.
- Number
- The amount of time (in seconds) to use to calculate a fair share percentage for each fair share identifier in use. A value of zero (0) indicates that only current usage is measured. The decay allows for more recently run jobs to have more weight than jobs that ran earlier. The maximum supported value is 604800 (1 week).
- List<Property Map>
- List of Share Attributes
SchedulingPolicyShareAttributes, SchedulingPolicyShareAttributesArgs
- string
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
ofUserA*
and another that specifies ashareIdentifier
ofUserA-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 (*).
- Weight
Factor double 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.
- string
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
ofUserA*
and another that specifies ashareIdentifier
ofUserA-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 (*).
- Weight
Factor float64 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.
- String
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
ofUserA*
and another that specifies ashareIdentifier
ofUserA-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 (*).
- weight
Factor Double 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.
- string
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
ofUserA*
and another that specifies ashareIdentifier
ofUserA-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 (*).
- weight
Factor number 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.
- str
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
ofUserA*
and another that specifies ashareIdentifier
ofUserA-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 (*).
- weight_
factor float 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.
- String
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
ofUserA*
and another that specifies ashareIdentifier
ofUserA-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 (*).
- weight
Factor Number 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.
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.