class ScheduledAction (construct)
This page is available in another version. Click here for the v2 documentation.
Language | Type name |
---|---|
.NET | Amazon.CDK.AWS.AutoScaling.ScheduledAction |
Java | software.amazon.awscdk.services.autoscaling.ScheduledAction |
Python | aws_cdk.aws_autoscaling.ScheduledAction |
TypeScript (source) | @aws-cdk/aws-autoscaling » ScheduledAction |
Implements
IConstruct
, IConstruct
, IDependable
, IResource
Define a scheduled scaling action.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as autoscaling from '@aws-cdk/aws-autoscaling';
declare const autoScalingGroup: autoscaling.AutoScalingGroup;
declare const schedule: autoscaling.Schedule;
const scheduledAction = new autoscaling.ScheduledAction(this, 'MyScheduledAction', {
autoScalingGroup: autoScalingGroup,
schedule: schedule,
// the properties below are optional
desiredCapacity: 123,
endTime: new Date(),
maxCapacity: 123,
minCapacity: 123,
startTime: new Date(),
timeZone: 'timeZone',
});
Initializer
new ScheduledAction(scope: Construct, id: string, props: ScheduledActionProps)
Parameters
- scope
Construct
- id
string
- props
Scheduled
Action Props
Construct Props
Name | Type | Description |
---|---|---|
auto | IAuto | The AutoScalingGroup to apply the scheduled actions to. |
schedule | Schedule | When to perform this action. |
desired | number | The new desired capacity. |
end | date | When this scheduled action expires. |
max | number | The new maximum capacity. |
min | number | The new minimum capacity. |
start | date | When this scheduled action becomes active. |
time | string | Specifies the time zone for a cron expression. |
autoScalingGroup
Type:
IAuto
The AutoScalingGroup to apply the scheduled actions to.
schedule
Type:
Schedule
When to perform this action.
Supports cron expressions.
For more information about cron expressions, see https://en.wikipedia.org/wiki/Cron.
desiredCapacity?
Type:
number
(optional, default: No new desired capacity.)
The new desired capacity.
At the scheduled time, set the desired capacity to the given capacity.
At least one of maxCapacity, minCapacity, or desiredCapacity must be supplied.
endTime?
Type:
date
(optional, default: The rule never expires.)
When this scheduled action expires.
maxCapacity?
Type:
number
(optional, default: No new maximum capacity.)
The new maximum capacity.
At the scheduled time, set the maximum capacity to the given capacity.
At least one of maxCapacity, minCapacity, or desiredCapacity must be supplied.
minCapacity?
Type:
number
(optional, default: No new minimum capacity.)
The new minimum capacity.
At the scheduled time, set the minimum capacity to the given capacity.
At least one of maxCapacity, minCapacity, or desiredCapacity must be supplied.
startTime?
Type:
date
(optional, default: The rule is activate immediately.)
When this scheduled action becomes active.
timeZone?
Type:
string
(optional, default: UTC)
Specifies the time zone for a cron expression.
If a time zone is not provided, UTC is used by default.
Valid values are the canonical names of the IANA time zones, derived from the IANA Time Zone Database (such as Etc/GMT+9 or Pacific/Tahiti).
For more information, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.
Properties
Name | Type | Description |
---|---|---|
env | Resource | The environment this resource belongs to. |
node | Construct | The construct tree node associated with this construct. |
scheduled | string | The name of the scheduled action. |
stack | Stack | The stack in which this resource is defined. |
env
Type:
Resource
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:
Construct
The construct tree node associated with this construct.
scheduledActionName
Type:
string
The name of the scheduled action.
stack
Type:
Stack
The stack in which this resource is defined.
Methods
Name | Description |
---|---|
apply | Apply the given removal policy to this resource. |
to | Returns a string representation of this construct. |
applyRemovalPolicy(policy)
public applyRemovalPolicy(policy: RemovalPolicy): void
Parameters
- policy
Removal
Policy
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
).
toString()
public toString(): string
Returns
string
Returns a string representation of this construct.