1. Packages
  2. AWS Native
  3. API Docs
  4. autoscaling
  5. getScheduledAction

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.111.0 published on Tuesday, Jul 9, 2024 by Pulumi

aws-native.autoscaling.getScheduledAction

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.111.0 published on Tuesday, Jul 9, 2024 by Pulumi

    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.

    Using getScheduledAction

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getScheduledAction(args: GetScheduledActionArgs, opts?: InvokeOptions): Promise<GetScheduledActionResult>
    function getScheduledActionOutput(args: GetScheduledActionOutputArgs, opts?: InvokeOptions): Output<GetScheduledActionResult>
    def get_scheduled_action(auto_scaling_group_name: Optional[str] = None,
                             scheduled_action_name: Optional[str] = None,
                             opts: Optional[InvokeOptions] = None) -> GetScheduledActionResult
    def get_scheduled_action_output(auto_scaling_group_name: Optional[pulumi.Input[str]] = None,
                             scheduled_action_name: Optional[pulumi.Input[str]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetScheduledActionResult]
    func LookupScheduledAction(ctx *Context, args *LookupScheduledActionArgs, opts ...InvokeOption) (*LookupScheduledActionResult, error)
    func LookupScheduledActionOutput(ctx *Context, args *LookupScheduledActionOutputArgs, opts ...InvokeOption) LookupScheduledActionResultOutput

    > Note: This function is named LookupScheduledAction in the Go SDK.

    public static class GetScheduledAction 
    {
        public static Task<GetScheduledActionResult> InvokeAsync(GetScheduledActionArgs args, InvokeOptions? opts = null)
        public static Output<GetScheduledActionResult> Invoke(GetScheduledActionInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetScheduledActionResult> getScheduledAction(GetScheduledActionArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: aws-native:autoscaling:getScheduledAction
      arguments:
        # arguments dictionary

    The following arguments are supported:

    AutoScalingGroupName string
    The name of the Auto Scaling group.
    ScheduledActionName string
    Auto-generated unique identifier
    AutoScalingGroupName string
    The name of the Auto Scaling group.
    ScheduledActionName string
    Auto-generated unique identifier
    autoScalingGroupName String
    The name of the Auto Scaling group.
    scheduledActionName String
    Auto-generated unique identifier
    autoScalingGroupName string
    The name of the Auto Scaling group.
    scheduledActionName string
    Auto-generated unique identifier
    auto_scaling_group_name str
    The name of the Auto Scaling group.
    scheduled_action_name str
    Auto-generated unique identifier
    autoScalingGroupName String
    The name of the Auto Scaling group.
    scheduledActionName String
    Auto-generated unique identifier

    getScheduledAction Result

    The following output properties are available:

    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.
    ScheduledActionName string
    Auto-generated unique identifier
    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.
    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.
    ScheduledActionName string
    Auto-generated unique identifier
    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.
    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.
    scheduledActionName String
    Auto-generated unique identifier
    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.
    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.
    scheduledActionName string
    Auto-generated unique identifier
    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.
    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.
    scheduled_action_name str
    Auto-generated unique identifier
    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.
    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.
    scheduledActionName String
    Auto-generated unique identifier
    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.

    Package Details

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

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.111.0 published on Tuesday, Jul 9, 2024 by Pulumi