Step 1: Launch the instance scheduler hub stack - Instance Scheduler on AWS

Step 1: Launch the instance scheduler hub stack

Follow the step-by-step instructions in this section to deploy the solution into your account.

Time to deploy: Approximately five minutes

Launch solution

  1. Sign in to the AWS Management Console and select the button to launch the* instance-scheduler-on-aws.template* AWS CloudFormation template.

  2. The template launches in the US East (N. Virginia) Region by default. To launch the solution in a different AWS Region, use the Region selector in the console navigation bar.

  3. On the Create stack page, verify that the correct template URL is in the Amazon S3 URL text box and choose Next.

  4. On the Specify stack details page, assign a name to your solution stack. For information about naming character limitations, see IAM and AWS STS quotas in the AWS Identity and Access Management User Guide.

  5. Under Parameters, review the parameters for this solution template and modify them as necessary. This solution uses the following default values.

    Parameter Default Description

    Infrastructure

    Namespace

    default

    Provide a unique identifier to differentiate between multiple solution deployments (no spaces). Example: Dev.

    Use AWS Organizations

    No

    Use AWS Organizations to automate spoke account registration.

    Organization ID/Remote Account IDs

    <Optional Input>

    If you’re using AWS Organizations this field is required. Provide the Organization ID, for example, o-xxxxyyy. Otherwise, provide a comma separated list of trusted spoke Account IDs that can register themselves for scheduling (maximum 40), such as 1111111111, 2222222222

    Schedule tag key

    Schedule

    The tag key that the solution reads to determine the schedule for a resource. The value on a resource specifies the name of the schedule. If you choose to modify the default value, assign a name that is easy to apply consistently and correctly across all necessary instances. Note: The tag key is case sensitive.

    Retain data and logs

    Enabled

    Enable deletion protection for DynamoDB tables used by the solution. This causes the tables to be retained when deleting this stack. To delete the tables when deleting this stack, first disable this parameter.

    Global Settings

    Enable scheduling

    Yes

    Set to No to suspend all scheduling operations.

    Default time zone

    UTC

    Default IANA (International assigned Numbers Authority) time zone identifier for schedules that do not specify a time zone. For a list of valid time zone identifiers, refer to the TZ identifier column of the List of tz database time zones.

    Scheduling interval (minutes)

    5

    Interval in minutes between scheduler runs. Shorter intervals increase accuracy and responsiveness but also increase costs. Production deployments require a minimum of 5 minutes for stable operation; shorter values are for small-scale testing only.

    Enable EC2 SSM maintenance windows

    No

    Allow schedules to specify one or more Systems Manger maintenance window names. Instance Scheduler on AWS will then ensure that instances tagged with that schedule are started at least ten minutes before associated maintenance windows.

    Create RDS instance snapshots on stop

    No

    Choose whether to create a snapshot before stopping RDS DB instances. Note: Snapshots are not available for Amazon Aurora clusters.

    ASG action name prefix

    IS-

    The prefix that the solution uses when naming Scheduled Scaling actions for Auto Scaling groups. Actions with this prefix will be added and removed by the solution as needed.

    ASG scheduled tag key

    scheduled

    Deprecated. This parameter exists for migration purposes only and should not be edited.

    Hub-Account Scheduling

    Region(s)

    <Optional Input>

    List of Regions where instances will be scheduled. For example, us-east-1,us-west-1. NOTE: If you leave this parameter blank, the solution will use the current Region.

    KMS Key ARNs for EC2

    <Optional Input>

    Comma-separated list of KMS ARNs to grant Instance Scheduler on AWS kms:CreateGrant permissions to provide the EC2 service with decrypt permissions for encrypted EBS volumes. This allows the scheduler to start EC2 instances with attached encrypted EBS volumes. Provide (*) to give limited access to all KMS keys; leave blank to disable. For details on the created policy, refer to Encrypted EC2 EBS Volumes.

    License Manager ARNs for EC2

    <Optional Input>

    Comma-separated list of License Manager configuration ARNs to grant Instance Scheduler permissions to start EC2 instances managed by License Manager. Leave blank to disable. For details, refer to EC2 License Manager.

    Monitoring

    Enable CloudWatch Debug Logs

    No

    Enable debug-level logging in CloudWatch logs.

    Log retention period (days)

    30

    The log retention period for CloudWatch logs in days.

    Operational Monitoring

    Enabled

    Deploy an operational insights dashboard to CloudWatch and gather custom metric data on the solution’s operation. The dashboard can be disabled to reduce associated costs if desired.

    Other

    SchedulingRequestHandler Memory size (MB)

    512

    The memory size of the AWS Lambda function that schedules resources. Increase if you are experiencing high memory usage or timeouts.

    Orchestrator Memory size (MB)

    512

    The memory size of the orchestrator Lambda function. Increase if you are experiencing high memory usage or timeouts.

  6. Choose Next.

  7. On the Configure stack options page, choose Next.

  8. On the Review and create page, review and confirm the settings. Check the box acknowledging that the template will create IAM resources.

  9. Choose Submit to deploy the stack.

You can view the status of the stack in the AWS CloudFormation console in the Status column. You should receive a CREATE_COMPLETE status in approximately five minutes.