Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. autoscaling
  5. ScheduledAction

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.autoscaling.ScheduledAction

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-aws-native

    The AWS::AutoScaling::ScheduledAction resource specifies an Amazon EC2 Auto Scaling scheduled action so that the Auto Scaling group can change the number of instances available for your application in response to predictable load changes.

    Create ScheduledAction Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ScheduledAction(name: string, args: ScheduledActionArgs, opts?: CustomResourceOptions);
    @overload
def ScheduledAction(resource_name: str,
                    args: ScheduledActionArgs,
                    opts: Optional[ResourceOptions] = None)

@overload
def ScheduledAction(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    auto_scaling_group_name: Optional[str] = None,
                    desired_capacity: Optional[int] = None,
                    end_time: Optional[str] = None,
                    max_size: Optional[int] = None,
                    min_size: Optional[int] = None,
                    recurrence: Optional[str] = None,
                    start_time: Optional[str] = None,
                    time_zone: Optional[str] = None)
    func NewScheduledAction(ctx *Context, name string, args ScheduledActionArgs, opts ...ResourceOption) (*ScheduledAction, error)
    public ScheduledAction(string name, ScheduledActionArgs args, CustomResourceOptions? opts = null)
    public ScheduledAction(String name, ScheduledActionArgs args)
public ScheduledAction(String name, ScheduledActionArgs args, CustomResourceOptions options)

    type: aws-native:autoscaling:ScheduledAction
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args ScheduledActionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ScheduledActionArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ScheduledActionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ScheduledActionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ScheduledActionArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    ScheduledAction Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The ScheduledAction resource accepts the following input properties:

    AutoScalingGroupName string
    The name of the Auto Scaling group.
    DesiredCapacity int
    The desired capacity is the initial capacity of the Auto Scaling group after the scheduled action runs and the capacity it attempts to maintain.
    EndTime string
    The latest scheduled start time to return. If scheduled action names are provided, this parameter is ignored.
    MaxSize int
    The minimum size of the Auto Scaling group.
    MinSize int
    The minimum size of the Auto Scaling group.
    Recurrence string
    The recurring schedule for the action, in Unix cron syntax format. When StartTime and EndTime are specified with Recurrence , they form the boundaries of when the recurring action starts and stops.
    StartTime string
    The earliest scheduled start time to return. If scheduled action names are provided, this parameter is ignored.
    TimeZone string
    The time zone for the cron expression.
    AutoScalingGroupName string
    The name of the Auto Scaling group.
    DesiredCapacity int
    The desired capacity is the initial capacity of the Auto Scaling group after the scheduled action runs and the capacity it attempts to maintain.
    EndTime string
    The latest scheduled start time to return. If scheduled action names are provided, this parameter is ignored.
    MaxSize int
    The minimum size of the Auto Scaling group.
    MinSize int
    The minimum size of the Auto Scaling group.
    Recurrence string
    The recurring schedule for the action, in Unix cron syntax format. When StartTime and EndTime are specified with Recurrence , they form the boundaries of when the recurring action starts and stops.
    StartTime string
    The earliest scheduled start time to return. If scheduled action names are provided, this parameter is ignored.
    TimeZone string
    The time zone for the cron expression.
    autoScalingGroupName String
    The name of the Auto Scaling group.
    desiredCapacity Integer
    The desired capacity is the initial capacity of the Auto Scaling group after the scheduled action runs and the capacity it attempts to maintain.
    endTime String
    The latest scheduled start time to return. If scheduled action names are provided, this parameter is ignored.
    maxSize Integer
    The minimum size of the Auto Scaling group.
    minSize Integer
    The minimum size of the Auto Scaling group.
    recurrence String
    The recurring schedule for the action, in Unix cron syntax format. When StartTime and EndTime are specified with Recurrence , they form the boundaries of when the recurring action starts and stops.
    startTime String
    The earliest scheduled start time to return. If scheduled action names are provided, this parameter is ignored.
    timeZone String
    The time zone for the cron expression.
    autoScalingGroupName string
    The name of the Auto Scaling group.
    desiredCapacity number
    The desired capacity is the initial capacity of the Auto Scaling group after the scheduled action runs and the capacity it attempts to maintain.
    endTime string
    The latest scheduled start time to return. If scheduled action names are provided, this parameter is ignored.
    maxSize number
    The minimum size of the Auto Scaling group.
    minSize number
    The minimum size of the Auto Scaling group.
    recurrence string
    The recurring schedule for the action, in Unix cron syntax format. When StartTime and EndTime are specified with Recurrence , they form the boundaries of when the recurring action starts and stops.
    startTime string
    The earliest scheduled start time to return. If scheduled action names are provided, this parameter is ignored.
    timeZone string
    The time zone for the cron expression.
    auto_scaling_group_name str
    The name of the Auto Scaling group.
    desired_capacity int
    The desired capacity is the initial capacity of the Auto Scaling group after the scheduled action runs and the capacity it attempts to maintain.
    end_time str
    The latest scheduled start time to return. If scheduled action names are provided, this parameter is ignored.
    max_size int
    The minimum size of the Auto Scaling group.
    min_size int
    The minimum size of the Auto Scaling group.
    recurrence str
    The recurring schedule for the action, in Unix cron syntax format. When StartTime and EndTime are specified with Recurrence , they form the boundaries of when the recurring action starts and stops.
    start_time str
    The earliest scheduled start time to return. If scheduled action names are provided, this parameter is ignored.
    time_zone str
    The time zone for the cron expression.
    autoScalingGroupName String
    The name of the Auto Scaling group.
    desiredCapacity Number
    The desired capacity is the initial capacity of the Auto Scaling group after the scheduled action runs and the capacity it attempts to maintain.
    endTime String
    The latest scheduled start time to return. If scheduled action names are provided, this parameter is ignored.
    maxSize Number
    The minimum size of the Auto Scaling group.
    minSize Number
    The minimum size of the Auto Scaling group.
    recurrence String
    The recurring schedule for the action, in Unix cron syntax format. When StartTime and EndTime are specified with Recurrence , they form the boundaries of when the recurring action starts and stops.
    startTime String
    The earliest scheduled start time to return. If scheduled action names are provided, this parameter is ignored.
    timeZone String
    The time zone for the cron expression.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ScheduledAction resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    ScheduledActionName string
    Auto-generated unique identifier
    Id string
    The provider-assigned unique ID for this managed resource.
    ScheduledActionName string
    Auto-generated unique identifier
    id String
    The provider-assigned unique ID for this managed resource.
    scheduledActionName String
    Auto-generated unique identifier
    id string
    The provider-assigned unique ID for this managed resource.
    scheduledActionName string
    Auto-generated unique identifier
    id str
    The provider-assigned unique ID for this managed resource.
    scheduled_action_name str
    Auto-generated unique identifier
    id String
    The provider-assigned unique ID for this managed resource.
    scheduledActionName String
    Auto-generated unique identifier

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
    pulumi/pulumi-aws-native