Package software.amazon.awscdk.cfnpropertymixins.services.autoscaling

Class CfnScheduledActionPropsMixin.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.autoscaling.CfnScheduledActionPropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnScheduledActionPropsMixin>

Enclosing class:

CfnScheduledActionPropsMixin

@Stability(Stable)
public static final class CfnScheduledActionPropsMixin.Builder
extends Object
implements software.amazon.jsii.Builder<CfnScheduledActionPropsMixin>

A fluent builder for CfnScheduledActionPropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnScheduledActionPropsMixin.Builder	autoScalingGroupName(String autoScalingGroupName)	The name of the Auto Scaling group.
CfnScheduledActionPropsMixin.Builder	autoScalingGroupName(IAutoScalingGroupRef autoScalingGroupName)	The name of the Auto Scaling group.
CfnScheduledActionPropsMixin	build()
static CfnScheduledActionPropsMixin.Builder	create()
static CfnScheduledActionPropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnScheduledActionPropsMixin.Builder	desiredCapacity(Number desiredCapacity)	The desired capacity is the initial capacity of the Auto Scaling group after the scheduled action runs and the capacity it attempts to maintain.
CfnScheduledActionPropsMixin.Builder	endTime(String endTime)	The date and time for the recurring schedule to end, in UTC.
CfnScheduledActionPropsMixin.Builder	maxSize(Number maxSize)	The maximum size of the Auto Scaling group.
CfnScheduledActionPropsMixin.Builder	minSize(Number minSize)	The minimum size of the Auto Scaling group.
CfnScheduledActionPropsMixin.Builder	recurrence(String recurrence)	The recurring schedule for this action.
CfnScheduledActionPropsMixin.Builder	startTime(String startTime)	The date and time for this action to start, in YYYY-MM-DDThh:mm:ssZ format in UTC/GMT only and in quotes (for example, "2021-06-01T00:00:00Z" ).
CfnScheduledActionPropsMixin.Builder	timeZone(String timeZone)	Specifies the time zone for a cron expression.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static CfnScheduledActionPropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnScheduledActionPropsMixin.Builder.

create

@Stability(Stable)
public static CfnScheduledActionPropsMixin.Builder create()

Returns:

a new instance of CfnScheduledActionPropsMixin.Builder.

autoScalingGroupName

@Stability(Stable)
public CfnScheduledActionPropsMixin.Builder autoScalingGroupName(String autoScalingGroupName)

The name of the Auto Scaling group.

Parameters:

autoScalingGroupName - The name of the Auto Scaling group. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-scheduledaction.html#cfn-autoscaling-scheduledaction-autoscalinggroupname

autoScalingGroupName

@Stability(Stable)
public CfnScheduledActionPropsMixin.Builder autoScalingGroupName(IAutoScalingGroupRef autoScalingGroupName)

The name of the Auto Scaling group.

Parameters:

autoScalingGroupName - The name of the Auto Scaling group. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-scheduledaction.html#cfn-autoscaling-scheduledaction-autoscalinggroupname

desiredCapacity

@Stability(Stable)
public CfnScheduledActionPropsMixin.Builder desiredCapacity(Number desiredCapacity)

The desired capacity is the initial capacity of the Auto Scaling group after the scheduled action runs and the capacity it attempts to maintain.

It can scale beyond this capacity if you add more scaling conditions.

You must specify at least one of the following properties: MaxSize , MinSize , or DesiredCapacity .

Parameters:

desiredCapacity - The desired capacity is the initial capacity of the Auto Scaling group after the scheduled action runs and the capacity it attempts to maintain. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-scheduledaction.html#cfn-autoscaling-scheduledaction-desiredcapacity

endTime

@Stability(Stable)
public CfnScheduledActionPropsMixin.Builder endTime(String endTime)

The date and time for the recurring schedule to end, in UTC.

For example, "2021-06-01T00:00:00Z" .

Parameters:

endTime - The date and time for the recurring schedule to end, in UTC. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-scheduledaction.html#cfn-autoscaling-scheduledaction-endtime

maxSize

@Stability(Stable)
public CfnScheduledActionPropsMixin.Builder maxSize(Number maxSize)

The maximum size of the Auto Scaling group.

Parameters:

maxSize - The maximum size of the Auto Scaling group. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-scheduledaction.html#cfn-autoscaling-scheduledaction-maxsize

minSize

@Stability(Stable)
public CfnScheduledActionPropsMixin.Builder minSize(Number minSize)

The minimum size of the Auto Scaling group.

Parameters:

minSize - The minimum size of the Auto Scaling group. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-scheduledaction.html#cfn-autoscaling-scheduledaction-minsize

recurrence

@Stability(Stable)
public CfnScheduledActionPropsMixin.Builder recurrence(String recurrence)

The recurring schedule for this action.

This format consists of five fields separated by white spaces: [Minute] [Hour] [Day_of_Month] [Month_of_Year] [Day_of_Week]. The value must be in quotes (for example, "30 0 1 1,6,12 *" ). For more information about this format, see Crontab .

When StartTime and EndTime are specified with Recurrence , they form the boundaries of when the recurring action starts and stops.

Cron expressions use Universal Coordinated Time (UTC) by default.

Parameters:

recurrence - The recurring schedule for this action. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-scheduledaction.html#cfn-autoscaling-scheduledaction-recurrence

startTime

@Stability(Stable)
public CfnScheduledActionPropsMixin.Builder startTime(String startTime)

The date and time for this action to start, in YYYY-MM-DDThh:mm:ssZ format in UTC/GMT only and in quotes (for example, "2021-06-01T00:00:00Z" ).

If you specify Recurrence and StartTime , Amazon EC2 Auto Scaling performs the action at this time, and then performs the action based on the specified recurrence.

Parameters:

startTime - The date and time for this action to start, in YYYY-MM-DDThh:mm:ssZ format in UTC/GMT only and in quotes (for example, "2021-06-01T00:00:00Z" ). This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-scheduledaction.html#cfn-autoscaling-scheduledaction-starttime

timeZone

@Stability(Stable)
public CfnScheduledActionPropsMixin.Builder timeZone(String timeZone)

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 .

Parameters:

timeZone - Specifies the time zone for a cron expression. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-scheduledaction.html#cfn-autoscaling-scheduledaction-timezone

build

@Stability(Stable)
public CfnScheduledActionPropsMixin build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnScheduledActionPropsMixin>

Returns:

a newly built instance of CfnScheduledActionPropsMixin.