software.amazon.awscdk.services.batch

Class CfnSchedulingPolicy

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.batch.CfnSchedulingPolicy

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.58.0 (build f8ba112)",
           date="2022-05-20T22:20:05.673Z")
public class CfnSchedulingPolicy
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Batch::SchedulingPolicy`.

The AWS::Batch::SchedulingPolicy resource specifies the parameters for an AWS Batch scheduling policy. For more information, see Scheduling Policies in the ** .

Example:

 // 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.*;
 CfnSchedulingPolicy cfnSchedulingPolicy = CfnSchedulingPolicy.Builder.create(this, "MyCfnSchedulingPolicy")
         .fairsharePolicy(FairsharePolicyProperty.builder()
                 .computeReservation(123)
                 .shareDecaySeconds(123)
                 .shareDistribution(List.of(ShareAttributesProperty.builder()
                         .shareIdentifier("shareIdentifier")
                         .weightFactor(123)
                         .build()))
                 .build())
         .name("name")
         .tags(Map.of(
                 "tagsKey", "tags"))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnSchedulingPolicy.Builder A fluent builder for CfnSchedulingPolicy.
static interface	CfnSchedulingPolicy.FairsharePolicyProperty The fair share policy for a scheduling policy.
static interface	CfnSchedulingPolicy.ShareAttributesProperty Specifies the weights for the fair share identifiers for the fair share policy.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnSchedulingPolicy(Construct scope, java.lang.String id) Create a new `AWS::Batch::SchedulingPolicy`.
	CfnSchedulingPolicy(Construct scope, java.lang.String id, CfnSchedulingPolicyProps props) Create a new `AWS::Batch::SchedulingPolicy`.
protected	CfnSchedulingPolicy(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnSchedulingPolicy(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAttrArn() Returns the scheduling policy ARN, such as `batch: *us-east-1* : *111122223333* :scheduling-policy/ *HighPriority*` .
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.Object	getFairsharePolicy() The fair share policy of the scheduling policy.
java.lang.String	getName() The name of the scheduling policy.
TagManager	getTags() The tags that you apply to the scheduling policy to help you categorize and organize your resources.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setFairsharePolicy(CfnSchedulingPolicy.FairsharePolicyProperty value) The fair share policy of the scheduling policy.
void	setFairsharePolicy(IResolvable value) The fair share policy of the scheduling policy.
void	setName(java.lang.String value) The name of the scheduling policy.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnSchedulingPolicy

protected CfnSchedulingPolicy(software.amazon.jsii.JsiiObjectRef objRef)

CfnSchedulingPolicy

protected CfnSchedulingPolicy(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnSchedulingPolicy

public CfnSchedulingPolicy(Construct scope,
                           java.lang.String id,
                           CfnSchedulingPolicyProps props)

Create a new `AWS::Batch::SchedulingPolicy`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties.

CfnSchedulingPolicy

public CfnSchedulingPolicy(Construct scope,
                           java.lang.String id)

Create a new `AWS::Batch::SchedulingPolicy`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

Method Detail

inspect

public void inspect(TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

public java.lang.String getAttrArn()

Returns the scheduling policy ARN, such as `batch: *us-east-1* : *111122223333* :scheduling-policy/ *HighPriority*` .

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

public TagManager getTags()

The tags that you apply to the scheduling policy to help you categorize and organize your resources.

Each tag consists of a key and an optional value. For more information, see Tagging AWS Resources in AWS General Reference .

These tags can be updated or removed using the TagResource and UntagResource API operations.

getFairsharePolicy

public java.lang.Object getFairsharePolicy()

The fair share policy of the scheduling policy.

setFairsharePolicy

public void setFairsharePolicy(IResolvable value)

The fair share policy of the scheduling policy.

setFairsharePolicy

public void setFairsharePolicy(CfnSchedulingPolicy.FairsharePolicyProperty value)

The fair share policy of the scheduling policy.

getName

public java.lang.String getName()

The name of the scheduling policy.

It can be up to 128 letters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).

setName

public void setName(java.lang.String value)

The name of the scheduling policy.

It can be up to 128 letters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).