@aws-cdk_aws-batch-alpha.ISchedulingPolicy

interface ISchedulingPolicy ๐Ÿ”น

LanguageType name
.NETAmazon.CDK.AWS.Batch.Alpha.ISchedulingPolicy
Gogithub.com/aws/aws-cdk-go/awscdkbatchalpha/v2#ISchedulingPolicy
Javasoftware.amazon.awscdk.services.batch.alpha.ISchedulingPolicy
Pythonaws_cdk.aws_batch_alpha.ISchedulingPolicy
TypeScript (source)@aws-cdk/aws-batch-alpha ยป ISchedulingPolicy

Implemented by FairshareSchedulingPolicy

Represents a Scheduling Policy.

Scheduling Policies tell the Batch Job Scheduler how to schedule incoming jobs.

Properties

NameTypeDescription
env๐Ÿ”นResourceEnvironmentThe environment this resource belongs to.
node๐Ÿ”นNodeThe tree node.
schedulingPolicyArn๐Ÿ”นstringThe arn of this scheduling policy.
schedulingPolicyName๐Ÿ”นstringThe name of this scheduling policy.
stack๐Ÿ”นStackThe stack in which this resource is defined.

env๐Ÿ”น

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.


node๐Ÿ”น

Type: Node

The tree node.


schedulingPolicyArn๐Ÿ”น

Type: string

The arn of this scheduling policy.


schedulingPolicyName๐Ÿ”น

Type: string

The name of this scheduling policy.


stack๐Ÿ”น

Type: Stack

The stack in which this resource is defined.

Methods

NameDescription
applyRemovalPolicy(policy)๐Ÿ”นApply the given removal policy to this resource.

applyRemovalPolicy(policy)๐Ÿ”น

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

  • policy RemovalPolicy

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).