software.amazon.awscdk.services.batch

Class CfnSchedulingPolicy

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.batch.CfnSchedulingPolicy

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:36.919Z")
 @Stability(value=Stable)
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 class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnSchedulingPolicy(software.constructs.Construct scope, String id) Create a new `AWS::Batch::SchedulingPolicy`.
	CfnSchedulingPolicy(software.constructs.Construct scope, 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
String	getAttrArn() Returns the scheduling policy ARN, such as `batch: *us-east-1* : *111122223333* :scheduling-policy/ *HighPriority*` .
protected Map<String,Object>	getCfnProperties()
Object	getFairsharePolicy() The fair share policy of the scheduling policy.
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 Map<String,Object>	renderProperties(Map<String,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(String value) The name of the scheduling policy.

Methods inherited from class software.amazon.awscdk.CfnResource

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

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final 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

@Stability(value=Stable)
public CfnSchedulingPolicy(@NotNull
                                                    software.constructs.Construct scope,
                                                    @NotNull
                                                    String id,
                                                    @Nullable
                                                    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

@Stability(value=Stable)
public CfnSchedulingPolicy(@NotNull
                                                    software.constructs.Construct scope,
                                                    @NotNull
                                                    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

@Stability(value=Stable)
public void inspect(@NotNull
                                             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

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(value=Stable)
 @NotNull
public String getAttrArn()

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

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
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

@Stability(value=Stable)
 @Nullable
public Object getFairsharePolicy()

The fair share policy of the scheduling policy.

setFairsharePolicy

@Stability(value=Stable)
public void setFairsharePolicy(@Nullable
                                                        CfnSchedulingPolicy.FairsharePolicyProperty value)

The fair share policy of the scheduling policy.

setFairsharePolicy

@Stability(value=Stable)
public void setFairsharePolicy(@Nullable
                                                        IResolvable value)

The fair share policy of the scheduling policy.

getName

@Stability(value=Stable)
 @Nullable
public 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

@Stability(value=Stable)
public void setName(@Nullable
                                             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 (_).