1. Packages
  2. AWS Classic
  3. API Docs
  4. appautoscaling
  5. ScheduledAction

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.41.0 published on Tuesday, Jun 18, 2024 by Pulumi

aws.appautoscaling.ScheduledAction

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.41.0 published on Tuesday, Jun 18, 2024 by Pulumi

    Provides an Application AutoScaling ScheduledAction resource.

    Example Usage

    DynamoDB Table Autoscaling

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const dynamodb = new aws.appautoscaling.Target("dynamodb", {
        maxCapacity: 100,
        minCapacity: 5,
        resourceId: "table/tableName",
        scalableDimension: "dynamodb:table:ReadCapacityUnits",
        serviceNamespace: "dynamodb",
    });
    const dynamodbScheduledAction = new aws.appautoscaling.ScheduledAction("dynamodb", {
        name: "dynamodb",
        serviceNamespace: dynamodb.serviceNamespace,
        resourceId: dynamodb.resourceId,
        scalableDimension: dynamodb.scalableDimension,
        schedule: "at(2006-01-02T15:04:05)",
        scalableTargetAction: {
            minCapacity: 1,
            maxCapacity: 200,
        },
    });
    
    import pulumi
    import pulumi_aws as aws
    
    dynamodb = aws.appautoscaling.Target("dynamodb",
        max_capacity=100,
        min_capacity=5,
        resource_id="table/tableName",
        scalable_dimension="dynamodb:table:ReadCapacityUnits",
        service_namespace="dynamodb")
    dynamodb_scheduled_action = aws.appautoscaling.ScheduledAction("dynamodb",
        name="dynamodb",
        service_namespace=dynamodb.service_namespace,
        resource_id=dynamodb.resource_id,
        scalable_dimension=dynamodb.scalable_dimension,
        schedule="at(2006-01-02T15:04:05)",
        scalable_target_action=aws.appautoscaling.ScheduledActionScalableTargetActionArgs(
            min_capacity=1,
            max_capacity=200,
        ))
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/appautoscaling"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		dynamodb, err := appautoscaling.NewTarget(ctx, "dynamodb", &appautoscaling.TargetArgs{
    			MaxCapacity:       pulumi.Int(100),
    			MinCapacity:       pulumi.Int(5),
    			ResourceId:        pulumi.String("table/tableName"),
    			ScalableDimension: pulumi.String("dynamodb:table:ReadCapacityUnits"),
    			ServiceNamespace:  pulumi.String("dynamodb"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = appautoscaling.NewScheduledAction(ctx, "dynamodb", &appautoscaling.ScheduledActionArgs{
    			Name:              pulumi.String("dynamodb"),
    			ServiceNamespace:  dynamodb.ServiceNamespace,
    			ResourceId:        dynamodb.ResourceId,
    			ScalableDimension: dynamodb.ScalableDimension,
    			Schedule:          pulumi.String("at(2006-01-02T15:04:05)"),
    			ScalableTargetAction: &appautoscaling.ScheduledActionScalableTargetActionArgs{
    				MinCapacity: pulumi.Int(1),
    				MaxCapacity: pulumi.Int(200),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aws = Pulumi.Aws;
    
    return await Deployment.RunAsync(() => 
    {
        var dynamodb = new Aws.AppAutoScaling.Target("dynamodb", new()
        {
            MaxCapacity = 100,
            MinCapacity = 5,
            ResourceId = "table/tableName",
            ScalableDimension = "dynamodb:table:ReadCapacityUnits",
            ServiceNamespace = "dynamodb",
        });
    
        var dynamodbScheduledAction = new Aws.AppAutoScaling.ScheduledAction("dynamodb", new()
        {
            Name = "dynamodb",
            ServiceNamespace = dynamodb.ServiceNamespace,
            ResourceId = dynamodb.ResourceId,
            ScalableDimension = dynamodb.ScalableDimension,
            Schedule = "at(2006-01-02T15:04:05)",
            ScalableTargetAction = new Aws.AppAutoScaling.Inputs.ScheduledActionScalableTargetActionArgs
            {
                MinCapacity = 1,
                MaxCapacity = 200,
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.appautoscaling.Target;
    import com.pulumi.aws.appautoscaling.TargetArgs;
    import com.pulumi.aws.appautoscaling.ScheduledAction;
    import com.pulumi.aws.appautoscaling.ScheduledActionArgs;
    import com.pulumi.aws.appautoscaling.inputs.ScheduledActionScalableTargetActionArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var dynamodb = new Target("dynamodb", TargetArgs.builder()
                .maxCapacity(100)
                .minCapacity(5)
                .resourceId("table/tableName")
                .scalableDimension("dynamodb:table:ReadCapacityUnits")
                .serviceNamespace("dynamodb")
                .build());
    
            var dynamodbScheduledAction = new ScheduledAction("dynamodbScheduledAction", ScheduledActionArgs.builder()
                .name("dynamodb")
                .serviceNamespace(dynamodb.serviceNamespace())
                .resourceId(dynamodb.resourceId())
                .scalableDimension(dynamodb.scalableDimension())
                .schedule("at(2006-01-02T15:04:05)")
                .scalableTargetAction(ScheduledActionScalableTargetActionArgs.builder()
                    .minCapacity(1)
                    .maxCapacity(200)
                    .build())
                .build());
    
        }
    }
    
    resources:
      dynamodb:
        type: aws:appautoscaling:Target
        properties:
          maxCapacity: 100
          minCapacity: 5
          resourceId: table/tableName
          scalableDimension: dynamodb:table:ReadCapacityUnits
          serviceNamespace: dynamodb
      dynamodbScheduledAction:
        type: aws:appautoscaling:ScheduledAction
        name: dynamodb
        properties:
          name: dynamodb
          serviceNamespace: ${dynamodb.serviceNamespace}
          resourceId: ${dynamodb.resourceId}
          scalableDimension: ${dynamodb.scalableDimension}
          schedule: at(2006-01-02T15:04:05)
          scalableTargetAction:
            minCapacity: 1
            maxCapacity: 200
    

    ECS Service Autoscaling

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const ecs = new aws.appautoscaling.Target("ecs", {
        maxCapacity: 4,
        minCapacity: 1,
        resourceId: "service/clusterName/serviceName",
        scalableDimension: "ecs:service:DesiredCount",
        serviceNamespace: "ecs",
    });
    const ecsScheduledAction = new aws.appautoscaling.ScheduledAction("ecs", {
        name: "ecs",
        serviceNamespace: ecs.serviceNamespace,
        resourceId: ecs.resourceId,
        scalableDimension: ecs.scalableDimension,
        schedule: "at(2006-01-02T15:04:05)",
        scalableTargetAction: {
            minCapacity: 1,
            maxCapacity: 10,
        },
    });
    
    import pulumi
    import pulumi_aws as aws
    
    ecs = aws.appautoscaling.Target("ecs",
        max_capacity=4,
        min_capacity=1,
        resource_id="service/clusterName/serviceName",
        scalable_dimension="ecs:service:DesiredCount",
        service_namespace="ecs")
    ecs_scheduled_action = aws.appautoscaling.ScheduledAction("ecs",
        name="ecs",
        service_namespace=ecs.service_namespace,
        resource_id=ecs.resource_id,
        scalable_dimension=ecs.scalable_dimension,
        schedule="at(2006-01-02T15:04:05)",
        scalable_target_action=aws.appautoscaling.ScheduledActionScalableTargetActionArgs(
            min_capacity=1,
            max_capacity=10,
        ))
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/appautoscaling"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		ecs, err := appautoscaling.NewTarget(ctx, "ecs", &appautoscaling.TargetArgs{
    			MaxCapacity:       pulumi.Int(4),
    			MinCapacity:       pulumi.Int(1),
    			ResourceId:        pulumi.String("service/clusterName/serviceName"),
    			ScalableDimension: pulumi.String("ecs:service:DesiredCount"),
    			ServiceNamespace:  pulumi.String("ecs"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = appautoscaling.NewScheduledAction(ctx, "ecs", &appautoscaling.ScheduledActionArgs{
    			Name:              pulumi.String("ecs"),
    			ServiceNamespace:  ecs.ServiceNamespace,
    			ResourceId:        ecs.ResourceId,
    			ScalableDimension: ecs.ScalableDimension,
    			Schedule:          pulumi.String("at(2006-01-02T15:04:05)"),
    			ScalableTargetAction: &appautoscaling.ScheduledActionScalableTargetActionArgs{
    				MinCapacity: pulumi.Int(1),
    				MaxCapacity: pulumi.Int(10),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aws = Pulumi.Aws;
    
    return await Deployment.RunAsync(() => 
    {
        var ecs = new Aws.AppAutoScaling.Target("ecs", new()
        {
            MaxCapacity = 4,
            MinCapacity = 1,
            ResourceId = "service/clusterName/serviceName",
            ScalableDimension = "ecs:service:DesiredCount",
            ServiceNamespace = "ecs",
        });
    
        var ecsScheduledAction = new Aws.AppAutoScaling.ScheduledAction("ecs", new()
        {
            Name = "ecs",
            ServiceNamespace = ecs.ServiceNamespace,
            ResourceId = ecs.ResourceId,
            ScalableDimension = ecs.ScalableDimension,
            Schedule = "at(2006-01-02T15:04:05)",
            ScalableTargetAction = new Aws.AppAutoScaling.Inputs.ScheduledActionScalableTargetActionArgs
            {
                MinCapacity = 1,
                MaxCapacity = 10,
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.appautoscaling.Target;
    import com.pulumi.aws.appautoscaling.TargetArgs;
    import com.pulumi.aws.appautoscaling.ScheduledAction;
    import com.pulumi.aws.appautoscaling.ScheduledActionArgs;
    import com.pulumi.aws.appautoscaling.inputs.ScheduledActionScalableTargetActionArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var ecs = new Target("ecs", TargetArgs.builder()
                .maxCapacity(4)
                .minCapacity(1)
                .resourceId("service/clusterName/serviceName")
                .scalableDimension("ecs:service:DesiredCount")
                .serviceNamespace("ecs")
                .build());
    
            var ecsScheduledAction = new ScheduledAction("ecsScheduledAction", ScheduledActionArgs.builder()
                .name("ecs")
                .serviceNamespace(ecs.serviceNamespace())
                .resourceId(ecs.resourceId())
                .scalableDimension(ecs.scalableDimension())
                .schedule("at(2006-01-02T15:04:05)")
                .scalableTargetAction(ScheduledActionScalableTargetActionArgs.builder()
                    .minCapacity(1)
                    .maxCapacity(10)
                    .build())
                .build());
    
        }
    }
    
    resources:
      ecs:
        type: aws:appautoscaling:Target
        properties:
          maxCapacity: 4
          minCapacity: 1
          resourceId: service/clusterName/serviceName
          scalableDimension: ecs:service:DesiredCount
          serviceNamespace: ecs
      ecsScheduledAction:
        type: aws:appautoscaling:ScheduledAction
        name: ecs
        properties:
          name: ecs
          serviceNamespace: ${ecs.serviceNamespace}
          resourceId: ${ecs.resourceId}
          scalableDimension: ${ecs.scalableDimension}
          schedule: at(2006-01-02T15:04:05)
          scalableTargetAction:
            minCapacity: 1
            maxCapacity: 10
    

    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,
                        resource_id: Optional[str] = None,
                        scalable_dimension: Optional[str] = None,
                        scalable_target_action: Optional[ScheduledActionScalableTargetActionArgs] = None,
                        schedule: Optional[str] = None,
                        service_namespace: Optional[str] = None,
                        end_time: Optional[str] = None,
                        name: Optional[str] = None,
                        start_time: Optional[str] = None,
                        timezone: 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:appautoscaling: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.

    Example

    The following reference example uses placeholder values for all input properties.

    var scheduledActionResource = new Aws.AppAutoScaling.ScheduledAction("scheduledActionResource", new()
    {
        ResourceId = "string",
        ScalableDimension = "string",
        ScalableTargetAction = new Aws.AppAutoScaling.Inputs.ScheduledActionScalableTargetActionArgs
        {
            MaxCapacity = 0,
            MinCapacity = 0,
        },
        Schedule = "string",
        ServiceNamespace = "string",
        EndTime = "string",
        Name = "string",
        StartTime = "string",
        Timezone = "string",
    });
    
    example, err := appautoscaling.NewScheduledAction(ctx, "scheduledActionResource", &appautoscaling.ScheduledActionArgs{
    	ResourceId:        pulumi.String("string"),
    	ScalableDimension: pulumi.String("string"),
    	ScalableTargetAction: &appautoscaling.ScheduledActionScalableTargetActionArgs{
    		MaxCapacity: pulumi.Int(0),
    		MinCapacity: pulumi.Int(0),
    	},
    	Schedule:         pulumi.String("string"),
    	ServiceNamespace: pulumi.String("string"),
    	EndTime:          pulumi.String("string"),
    	Name:             pulumi.String("string"),
    	StartTime:        pulumi.String("string"),
    	Timezone:         pulumi.String("string"),
    })
    
    var scheduledActionResource = new ScheduledAction("scheduledActionResource", ScheduledActionArgs.builder()
        .resourceId("string")
        .scalableDimension("string")
        .scalableTargetAction(ScheduledActionScalableTargetActionArgs.builder()
            .maxCapacity(0)
            .minCapacity(0)
            .build())
        .schedule("string")
        .serviceNamespace("string")
        .endTime("string")
        .name("string")
        .startTime("string")
        .timezone("string")
        .build());
    
    scheduled_action_resource = aws.appautoscaling.ScheduledAction("scheduledActionResource",
        resource_id="string",
        scalable_dimension="string",
        scalable_target_action=aws.appautoscaling.ScheduledActionScalableTargetActionArgs(
            max_capacity=0,
            min_capacity=0,
        ),
        schedule="string",
        service_namespace="string",
        end_time="string",
        name="string",
        start_time="string",
        timezone="string")
    
    const scheduledActionResource = new aws.appautoscaling.ScheduledAction("scheduledActionResource", {
        resourceId: "string",
        scalableDimension: "string",
        scalableTargetAction: {
            maxCapacity: 0,
            minCapacity: 0,
        },
        schedule: "string",
        serviceNamespace: "string",
        endTime: "string",
        name: "string",
        startTime: "string",
        timezone: "string",
    });
    
    type: aws:appautoscaling:ScheduledAction
    properties:
        endTime: string
        name: string
        resourceId: string
        scalableDimension: string
        scalableTargetAction:
            maxCapacity: 0
            minCapacity: 0
        schedule: string
        serviceNamespace: string
        startTime: string
        timezone: string
    

    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

    The ScheduledAction resource accepts the following input properties:

    ResourceId string
    Identifier of the resource associated with the scheduled action. Documentation can be found in the ResourceId parameter at: AWS Application Auto Scaling API Reference
    ScalableDimension string
    Scalable dimension. Documentation can be found in the ScalableDimension parameter at: AWS Application Auto Scaling API Reference Example: ecs:service:DesiredCount
    ScalableTargetAction ScheduledActionScalableTargetAction
    New minimum and maximum capacity. You can set both values or just one. See below
    Schedule string
    Schedule for this action. The following formats are supported: At expressions - at(yyyy-mm-ddThh:mm:ss), Rate expressions - rate(valueunit), Cron expressions - cron(fields). Times for at expressions and cron expressions are evaluated using the time zone configured in timezone. Documentation can be found in the Timezone parameter at: AWS Application Auto Scaling API Reference
    ServiceNamespace string
    Namespace of the AWS service. Documentation can be found in the ServiceNamespace parameter at: AWS Application Auto Scaling API Reference Example: ecs
    EndTime string
    Date and time for the scheduled action to end in RFC 3339 format. The timezone is not affected by the setting of timezone.
    Name string
    Name of the scheduled action.
    StartTime string
    Date and time for the scheduled action to start in RFC 3339 format. The timezone is not affected by the setting of timezone.
    Timezone string
    Time zone used when setting a scheduled action by using an at or cron expression. Does not affect timezone for start_time and end_time. Valid values are the canonical names of the IANA time zones supported by Joda-Time, such as Etc/GMT+9 or Pacific/Tahiti. Default is UTC.
    ResourceId string
    Identifier of the resource associated with the scheduled action. Documentation can be found in the ResourceId parameter at: AWS Application Auto Scaling API Reference
    ScalableDimension string
    Scalable dimension. Documentation can be found in the ScalableDimension parameter at: AWS Application Auto Scaling API Reference Example: ecs:service:DesiredCount
    ScalableTargetAction ScheduledActionScalableTargetActionArgs
    New minimum and maximum capacity. You can set both values or just one. See below
    Schedule string
    Schedule for this action. The following formats are supported: At expressions - at(yyyy-mm-ddThh:mm:ss), Rate expressions - rate(valueunit), Cron expressions - cron(fields). Times for at expressions and cron expressions are evaluated using the time zone configured in timezone. Documentation can be found in the Timezone parameter at: AWS Application Auto Scaling API Reference
    ServiceNamespace string
    Namespace of the AWS service. Documentation can be found in the ServiceNamespace parameter at: AWS Application Auto Scaling API Reference Example: ecs
    EndTime string
    Date and time for the scheduled action to end in RFC 3339 format. The timezone is not affected by the setting of timezone.
    Name string
    Name of the scheduled action.
    StartTime string
    Date and time for the scheduled action to start in RFC 3339 format. The timezone is not affected by the setting of timezone.
    Timezone string
    Time zone used when setting a scheduled action by using an at or cron expression. Does not affect timezone for start_time and end_time. Valid values are the canonical names of the IANA time zones supported by Joda-Time, such as Etc/GMT+9 or Pacific/Tahiti. Default is UTC.
    resourceId String
    Identifier of the resource associated with the scheduled action. Documentation can be found in the ResourceId parameter at: AWS Application Auto Scaling API Reference
    scalableDimension String
    Scalable dimension. Documentation can be found in the ScalableDimension parameter at: AWS Application Auto Scaling API Reference Example: ecs:service:DesiredCount
    scalableTargetAction ScheduledActionScalableTargetAction
    New minimum and maximum capacity. You can set both values or just one. See below
    schedule String
    Schedule for this action. The following formats are supported: At expressions - at(yyyy-mm-ddThh:mm:ss), Rate expressions - rate(valueunit), Cron expressions - cron(fields). Times for at expressions and cron expressions are evaluated using the time zone configured in timezone. Documentation can be found in the Timezone parameter at: AWS Application Auto Scaling API Reference
    serviceNamespace String
    Namespace of the AWS service. Documentation can be found in the ServiceNamespace parameter at: AWS Application Auto Scaling API Reference Example: ecs
    endTime String
    Date and time for the scheduled action to end in RFC 3339 format. The timezone is not affected by the setting of timezone.
    name String
    Name of the scheduled action.
    startTime String
    Date and time for the scheduled action to start in RFC 3339 format. The timezone is not affected by the setting of timezone.
    timezone String
    Time zone used when setting a scheduled action by using an at or cron expression. Does not affect timezone for start_time and end_time. Valid values are the canonical names of the IANA time zones supported by Joda-Time, such as Etc/GMT+9 or Pacific/Tahiti. Default is UTC.
    resourceId string
    Identifier of the resource associated with the scheduled action. Documentation can be found in the ResourceId parameter at: AWS Application Auto Scaling API Reference
    scalableDimension string
    Scalable dimension. Documentation can be found in the ScalableDimension parameter at: AWS Application Auto Scaling API Reference Example: ecs:service:DesiredCount
    scalableTargetAction ScheduledActionScalableTargetAction
    New minimum and maximum capacity. You can set both values or just one. See below
    schedule string
    Schedule for this action. The following formats are supported: At expressions - at(yyyy-mm-ddThh:mm:ss), Rate expressions - rate(valueunit), Cron expressions - cron(fields). Times for at expressions and cron expressions are evaluated using the time zone configured in timezone. Documentation can be found in the Timezone parameter at: AWS Application Auto Scaling API Reference
    serviceNamespace string
    Namespace of the AWS service. Documentation can be found in the ServiceNamespace parameter at: AWS Application Auto Scaling API Reference Example: ecs
    endTime string
    Date and time for the scheduled action to end in RFC 3339 format. The timezone is not affected by the setting of timezone.
    name string
    Name of the scheduled action.
    startTime string
    Date and time for the scheduled action to start in RFC 3339 format. The timezone is not affected by the setting of timezone.
    timezone string
    Time zone used when setting a scheduled action by using an at or cron expression. Does not affect timezone for start_time and end_time. Valid values are the canonical names of the IANA time zones supported by Joda-Time, such as Etc/GMT+9 or Pacific/Tahiti. Default is UTC.
    resource_id str
    Identifier of the resource associated with the scheduled action. Documentation can be found in the ResourceId parameter at: AWS Application Auto Scaling API Reference
    scalable_dimension str
    Scalable dimension. Documentation can be found in the ScalableDimension parameter at: AWS Application Auto Scaling API Reference Example: ecs:service:DesiredCount
    scalable_target_action ScheduledActionScalableTargetActionArgs
    New minimum and maximum capacity. You can set both values or just one. See below
    schedule str
    Schedule for this action. The following formats are supported: At expressions - at(yyyy-mm-ddThh:mm:ss), Rate expressions - rate(valueunit), Cron expressions - cron(fields). Times for at expressions and cron expressions are evaluated using the time zone configured in timezone. Documentation can be found in the Timezone parameter at: AWS Application Auto Scaling API Reference
    service_namespace str
    Namespace of the AWS service. Documentation can be found in the ServiceNamespace parameter at: AWS Application Auto Scaling API Reference Example: ecs
    end_time str
    Date and time for the scheduled action to end in RFC 3339 format. The timezone is not affected by the setting of timezone.
    name str
    Name of the scheduled action.
    start_time str
    Date and time for the scheduled action to start in RFC 3339 format. The timezone is not affected by the setting of timezone.
    timezone str
    Time zone used when setting a scheduled action by using an at or cron expression. Does not affect timezone for start_time and end_time. Valid values are the canonical names of the IANA time zones supported by Joda-Time, such as Etc/GMT+9 or Pacific/Tahiti. Default is UTC.
    resourceId String
    Identifier of the resource associated with the scheduled action. Documentation can be found in the ResourceId parameter at: AWS Application Auto Scaling API Reference
    scalableDimension String
    Scalable dimension. Documentation can be found in the ScalableDimension parameter at: AWS Application Auto Scaling API Reference Example: ecs:service:DesiredCount
    scalableTargetAction Property Map
    New minimum and maximum capacity. You can set both values or just one. See below
    schedule String
    Schedule for this action. The following formats are supported: At expressions - at(yyyy-mm-ddThh:mm:ss), Rate expressions - rate(valueunit), Cron expressions - cron(fields). Times for at expressions and cron expressions are evaluated using the time zone configured in timezone. Documentation can be found in the Timezone parameter at: AWS Application Auto Scaling API Reference
    serviceNamespace String
    Namespace of the AWS service. Documentation can be found in the ServiceNamespace parameter at: AWS Application Auto Scaling API Reference Example: ecs
    endTime String
    Date and time for the scheduled action to end in RFC 3339 format. The timezone is not affected by the setting of timezone.
    name String
    Name of the scheduled action.
    startTime String
    Date and time for the scheduled action to start in RFC 3339 format. The timezone is not affected by the setting of timezone.
    timezone String
    Time zone used when setting a scheduled action by using an at or cron expression. Does not affect timezone for start_time and end_time. Valid values are the canonical names of the IANA time zones supported by Joda-Time, such as Etc/GMT+9 or Pacific/Tahiti. Default is UTC.

    Outputs

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

    Arn string
    ARN of the scheduled action.
    Id string
    The provider-assigned unique ID for this managed resource.
    Arn string
    ARN of the scheduled action.
    Id string
    The provider-assigned unique ID for this managed resource.
    arn String
    ARN of the scheduled action.
    id String
    The provider-assigned unique ID for this managed resource.
    arn string
    ARN of the scheduled action.
    id string
    The provider-assigned unique ID for this managed resource.
    arn str
    ARN of the scheduled action.
    id str
    The provider-assigned unique ID for this managed resource.
    arn String
    ARN of the scheduled action.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing ScheduledAction Resource

    Get an existing ScheduledAction resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ScheduledActionState, opts?: CustomResourceOptions): ScheduledAction
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            arn: Optional[str] = None,
            end_time: Optional[str] = None,
            name: Optional[str] = None,
            resource_id: Optional[str] = None,
            scalable_dimension: Optional[str] = None,
            scalable_target_action: Optional[ScheduledActionScalableTargetActionArgs] = None,
            schedule: Optional[str] = None,
            service_namespace: Optional[str] = None,
            start_time: Optional[str] = None,
            timezone: Optional[str] = None) -> ScheduledAction
    func GetScheduledAction(ctx *Context, name string, id IDInput, state *ScheduledActionState, opts ...ResourceOption) (*ScheduledAction, error)
    public static ScheduledAction Get(string name, Input<string> id, ScheduledActionState? state, CustomResourceOptions? opts = null)
    public static ScheduledAction get(String name, Output<String> id, ScheduledActionState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Arn string
    ARN of the scheduled action.
    EndTime string
    Date and time for the scheduled action to end in RFC 3339 format. The timezone is not affected by the setting of timezone.
    Name string
    Name of the scheduled action.
    ResourceId string
    Identifier of the resource associated with the scheduled action. Documentation can be found in the ResourceId parameter at: AWS Application Auto Scaling API Reference
    ScalableDimension string
    Scalable dimension. Documentation can be found in the ScalableDimension parameter at: AWS Application Auto Scaling API Reference Example: ecs:service:DesiredCount
    ScalableTargetAction ScheduledActionScalableTargetAction
    New minimum and maximum capacity. You can set both values or just one. See below
    Schedule string
    Schedule for this action. The following formats are supported: At expressions - at(yyyy-mm-ddThh:mm:ss), Rate expressions - rate(valueunit), Cron expressions - cron(fields). Times for at expressions and cron expressions are evaluated using the time zone configured in timezone. Documentation can be found in the Timezone parameter at: AWS Application Auto Scaling API Reference
    ServiceNamespace string
    Namespace of the AWS service. Documentation can be found in the ServiceNamespace parameter at: AWS Application Auto Scaling API Reference Example: ecs
    StartTime string
    Date and time for the scheduled action to start in RFC 3339 format. The timezone is not affected by the setting of timezone.
    Timezone string
    Time zone used when setting a scheduled action by using an at or cron expression. Does not affect timezone for start_time and end_time. Valid values are the canonical names of the IANA time zones supported by Joda-Time, such as Etc/GMT+9 or Pacific/Tahiti. Default is UTC.
    Arn string
    ARN of the scheduled action.
    EndTime string
    Date and time for the scheduled action to end in RFC 3339 format. The timezone is not affected by the setting of timezone.
    Name string
    Name of the scheduled action.
    ResourceId string
    Identifier of the resource associated with the scheduled action. Documentation can be found in the ResourceId parameter at: AWS Application Auto Scaling API Reference
    ScalableDimension string
    Scalable dimension. Documentation can be found in the ScalableDimension parameter at: AWS Application Auto Scaling API Reference Example: ecs:service:DesiredCount
    ScalableTargetAction ScheduledActionScalableTargetActionArgs
    New minimum and maximum capacity. You can set both values or just one. See below
    Schedule string
    Schedule for this action. The following formats are supported: At expressions - at(yyyy-mm-ddThh:mm:ss), Rate expressions - rate(valueunit), Cron expressions - cron(fields). Times for at expressions and cron expressions are evaluated using the time zone configured in timezone. Documentation can be found in the Timezone parameter at: AWS Application Auto Scaling API Reference
    ServiceNamespace string
    Namespace of the AWS service. Documentation can be found in the ServiceNamespace parameter at: AWS Application Auto Scaling API Reference Example: ecs
    StartTime string
    Date and time for the scheduled action to start in RFC 3339 format. The timezone is not affected by the setting of timezone.
    Timezone string
    Time zone used when setting a scheduled action by using an at or cron expression. Does not affect timezone for start_time and end_time. Valid values are the canonical names of the IANA time zones supported by Joda-Time, such as Etc/GMT+9 or Pacific/Tahiti. Default is UTC.
    arn String
    ARN of the scheduled action.
    endTime String
    Date and time for the scheduled action to end in RFC 3339 format. The timezone is not affected by the setting of timezone.
    name String
    Name of the scheduled action.
    resourceId String
    Identifier of the resource associated with the scheduled action. Documentation can be found in the ResourceId parameter at: AWS Application Auto Scaling API Reference
    scalableDimension String
    Scalable dimension. Documentation can be found in the ScalableDimension parameter at: AWS Application Auto Scaling API Reference Example: ecs:service:DesiredCount
    scalableTargetAction ScheduledActionScalableTargetAction
    New minimum and maximum capacity. You can set both values or just one. See below
    schedule String
    Schedule for this action. The following formats are supported: At expressions - at(yyyy-mm-ddThh:mm:ss), Rate expressions - rate(valueunit), Cron expressions - cron(fields). Times for at expressions and cron expressions are evaluated using the time zone configured in timezone. Documentation can be found in the Timezone parameter at: AWS Application Auto Scaling API Reference
    serviceNamespace String
    Namespace of the AWS service. Documentation can be found in the ServiceNamespace parameter at: AWS Application Auto Scaling API Reference Example: ecs
    startTime String
    Date and time for the scheduled action to start in RFC 3339 format. The timezone is not affected by the setting of timezone.
    timezone String
    Time zone used when setting a scheduled action by using an at or cron expression. Does not affect timezone for start_time and end_time. Valid values are the canonical names of the IANA time zones supported by Joda-Time, such as Etc/GMT+9 or Pacific/Tahiti. Default is UTC.
    arn string
    ARN of the scheduled action.
    endTime string
    Date and time for the scheduled action to end in RFC 3339 format. The timezone is not affected by the setting of timezone.
    name string
    Name of the scheduled action.
    resourceId string
    Identifier of the resource associated with the scheduled action. Documentation can be found in the ResourceId parameter at: AWS Application Auto Scaling API Reference
    scalableDimension string
    Scalable dimension. Documentation can be found in the ScalableDimension parameter at: AWS Application Auto Scaling API Reference Example: ecs:service:DesiredCount
    scalableTargetAction ScheduledActionScalableTargetAction
    New minimum and maximum capacity. You can set both values or just one. See below
    schedule string
    Schedule for this action. The following formats are supported: At expressions - at(yyyy-mm-ddThh:mm:ss), Rate expressions - rate(valueunit), Cron expressions - cron(fields). Times for at expressions and cron expressions are evaluated using the time zone configured in timezone. Documentation can be found in the Timezone parameter at: AWS Application Auto Scaling API Reference
    serviceNamespace string
    Namespace of the AWS service. Documentation can be found in the ServiceNamespace parameter at: AWS Application Auto Scaling API Reference Example: ecs
    startTime string
    Date and time for the scheduled action to start in RFC 3339 format. The timezone is not affected by the setting of timezone.
    timezone string
    Time zone used when setting a scheduled action by using an at or cron expression. Does not affect timezone for start_time and end_time. Valid values are the canonical names of the IANA time zones supported by Joda-Time, such as Etc/GMT+9 or Pacific/Tahiti. Default is UTC.
    arn str
    ARN of the scheduled action.
    end_time str
    Date and time for the scheduled action to end in RFC 3339 format. The timezone is not affected by the setting of timezone.
    name str
    Name of the scheduled action.
    resource_id str
    Identifier of the resource associated with the scheduled action. Documentation can be found in the ResourceId parameter at: AWS Application Auto Scaling API Reference
    scalable_dimension str
    Scalable dimension. Documentation can be found in the ScalableDimension parameter at: AWS Application Auto Scaling API Reference Example: ecs:service:DesiredCount
    scalable_target_action ScheduledActionScalableTargetActionArgs
    New minimum and maximum capacity. You can set both values or just one. See below
    schedule str
    Schedule for this action. The following formats are supported: At expressions - at(yyyy-mm-ddThh:mm:ss), Rate expressions - rate(valueunit), Cron expressions - cron(fields). Times for at expressions and cron expressions are evaluated using the time zone configured in timezone. Documentation can be found in the Timezone parameter at: AWS Application Auto Scaling API Reference
    service_namespace str
    Namespace of the AWS service. Documentation can be found in the ServiceNamespace parameter at: AWS Application Auto Scaling API Reference Example: ecs
    start_time str
    Date and time for the scheduled action to start in RFC 3339 format. The timezone is not affected by the setting of timezone.
    timezone str
    Time zone used when setting a scheduled action by using an at or cron expression. Does not affect timezone for start_time and end_time. Valid values are the canonical names of the IANA time zones supported by Joda-Time, such as Etc/GMT+9 or Pacific/Tahiti. Default is UTC.
    arn String
    ARN of the scheduled action.
    endTime String
    Date and time for the scheduled action to end in RFC 3339 format. The timezone is not affected by the setting of timezone.
    name String
    Name of the scheduled action.
    resourceId String
    Identifier of the resource associated with the scheduled action. Documentation can be found in the ResourceId parameter at: AWS Application Auto Scaling API Reference
    scalableDimension String
    Scalable dimension. Documentation can be found in the ScalableDimension parameter at: AWS Application Auto Scaling API Reference Example: ecs:service:DesiredCount
    scalableTargetAction Property Map
    New minimum and maximum capacity. You can set both values or just one. See below
    schedule String
    Schedule for this action. The following formats are supported: At expressions - at(yyyy-mm-ddThh:mm:ss), Rate expressions - rate(valueunit), Cron expressions - cron(fields). Times for at expressions and cron expressions are evaluated using the time zone configured in timezone. Documentation can be found in the Timezone parameter at: AWS Application Auto Scaling API Reference
    serviceNamespace String
    Namespace of the AWS service. Documentation can be found in the ServiceNamespace parameter at: AWS Application Auto Scaling API Reference Example: ecs
    startTime String
    Date and time for the scheduled action to start in RFC 3339 format. The timezone is not affected by the setting of timezone.
    timezone String
    Time zone used when setting a scheduled action by using an at or cron expression. Does not affect timezone for start_time and end_time. Valid values are the canonical names of the IANA time zones supported by Joda-Time, such as Etc/GMT+9 or Pacific/Tahiti. Default is UTC.

    Supporting Types

    ScheduledActionScalableTargetAction, ScheduledActionScalableTargetActionArgs

    maxCapacity Integer
    minCapacity Integer

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.41.0 published on Tuesday, Jun 18, 2024 by Pulumi