스케줄러 CLI

AWS 인스턴스 스케줄러 명령줄 인터페이스(CLI)를 사용하면 일정 및 기간을 구성하고 지정된 일정에 대한 비용 절감을 추정할 수 있습니다.

사전 조건

이 솔루션의 CLI에는 Python 3.8 이상과 최신 버전의 boto3가 필요합니다.

보안 인증 정보

스케줄러 CLI를 사용하기 위해서는 AWS CLI에 대한 자격 증명이 있어야 합니다. 자세한 내용은 AWS CLI 사용 설명서의 구성 및 자격 증명 파일 설정을 참조하세요.

다음과 같은 자격 증명이 있어야 합니다.

스케줄러 CLI 및 응답의 요청은 AdminCliRequestHandler-yyyymmdd 로그 스트림에 로깅됩니다.

스케줄러 CLI 설치

명령 구조

스케줄러 CLI는 명령줄에서 멀티파트 구조를 사용합니다. 다음 부분에서는 스케줄러 CLI python 스크립트를 지정합니다. 스케줄러 CLI에는 기간 및 일정에 대해 수행할 작업을 지정하는 명령이 있습니다. 작업의 특정 인수는 명령줄에 원하는 순서로 지정할 수 있습니다.

scheduler-cli <command> <arguments>

공통 인수

스케줄러 CLI는 모든 명령이 사용할 수 있는 다음과 같은 인수를 지원합니다.

가용 명령

create-period

설명

기간을 생성합니다. 기간에는 begintime, endtime, weekdays, months 또는 monthdays 항목 중 하나 이상이 포함되어야 합니다.

인수

예제

$ scheduler-cli create-period --name "weekdays" --begintime 09:00 --endtime 18:00 --weekdays mon-fri --stack Scheduler
{
   "Period": {
      "Name": "weekdays",
      "Endtime": "18:00",
      "Type": "period",
      "Begintime": "09:00",
      "Weekdays": [
         "mon-fri"
      ]
   }
    }

create-schedule

설명

일정을 생성합니다.

인수

예제

$ scheduler-cli create-schedule --name LondonOfficeHours --periods weekdays,weekends --timezone Europe/London --stack Scheduler
{
   "Schedule": {
      "Enforced": false,
      "Name": "LondonOfficeHours",
      "StopNewInstances": true,
      "Periods": [
         "weekends",
         "weekdays"
      ],
      "Timezone": "Europe/London",
      "Type": "schedule"
   }
}

delete-period

예제

$ scheduler-cli delete-period --name weekdays --stack Scheduler
{
   "Period": "weekdays"
}

delete-schedule

설명

기존 일정을 삭제합니다.

인수

예제

$ scheduler-cli delete-schedule --name LondonOfficeHours --stack Scheduler
{
   "Schedule": "LondonOfficeHours"
}

describe-periods

설명

인스턴스 스케줄러 스택에 대해 구성된 기간을 나열합니다.

인수

예제

$ scheduler-cli describe-periods --stack Scheduler
{
   "Periods": [
      {
         "Name": "first-monday-in-quarter",
         "Months": [
            "jan/3"
         ],
         "Type": "period",
         "Weekdays": [
            "mon#1"
         ],
         "Description": "Every first Monday of each quarter"
      },
      {
         "Description": "Office hours",
         "Weekdays": [
            "mon-fri"
         ],
         "Begintime": "09:00",
         "Endtime": "17:00",
         "Type": "period",
         "Name": "office-hours"
      },

      {
         "Name": "weekdays",
         "Endtime": "18:00",
         "Type": "period",
         "Weekdays": [
            "mon-fri"
         ],
         "Begintime": "09:00"
      },
      {
         "Name": "weekends",
         "Type": "period",
         "Weekdays": [
            "sat-sun"
         ],
         "Description": "Days in weekend"
      }
   ]
}

describe-schedules

설명

인스턴스 스케줄러 스택에 대해 구성된 일정을 나열합니다.

인수

예제

$ scheduler-cli describe-schedules --stack Scheduler

{
   "Schedules": [
      {
         "OverrideStatus": "running",
         "Type": "schedule",
         "Name": "Running",
         "UseMetrics": false
      },
      {
         "Timezone": "UTC",
         "Type": "schedule",
         "Periods": [
            "working-days@t2.micro",
            "weekends@t2.nano"
         ],
         "Name": "scale-up-down"
      },
      {
         "Timezone": "US/Pacific",
         "Type": "schedule",
         "Periods": [
            "office-hours"
         ],
         "Name": "seattle-office-hours"
      },
      {
         "OverrideStatus": "stopped",
         "Type": "schedule",
         "Name": "stopped",
         "UseMetrics": true
      }
   ]
}

describe-schedule-usage

설명

일정 내에서 실행되는 모든 기간을 나열하고 인스턴스의 청구 시간을 계산합니다. 이 명령을 사용하여 일정을 시뮬레이션해 잠재적 절감액과 일정을 생성하거나 업데이트한 후의 실행 기간을 계산합니다.

인수

예제

$ scheduler-cli describe-schedule-usage --stack InstanceScheduler --name seattle-office-hours
{
   "Usage": {
      "2017-12-04": {
         "BillingHours": 8,
         "RunningPeriods": {
            "Office-hours": {
               "Begin": "12/04/17 09:00:00",
               "End": "12/04/17 17:00:00",
               "BillingHours": 8,
               "BillingSeconds": 28800
            }
         },
         "BillingSeconds": 28800
      }
   },
   "Schedule": "seattle-office-hours"

update-period

설명

기존 프로필을 업데이트합니다.

인수

update-period 명령은 create-period 명령과 동일한 인수를 지원합니다. 인수에 대한 자세한 내용은 기간 생성 명령을 참조하세요.

update-schedule

설명

기존 일정을 업데이트합니다.

인수

update-schedule 명령은 create-schedule 명령과 동일한 인수를 지원합니다. 인수에 대한 자세한 내용은 create-schedule 명령을 참조하세요.

도움

설명

스케줄러 CLI에 대한 유효한 명령과 인수 목록을 표시합니다.

예제

$ scheduler-cli --help
usage: scheduler-cli [-h] [--version]
                     {create-period,create-schedule,delete-period,delete-schedule,describe-periods,describe-schedule-usage,describe-schedules,update-period,update-schedule}
                     ...

optional arguments:
  -h, --help            show this help message and exit
  --version             show program's version number and exit

subcommands:
  Valid subcommands

  {create-period,create-schedule,delete-period,delete-schedule,describe-periods,describe-schedule-usage,describe-schedules,update-period,update-schedule}
                        Commands help
    create-period       Creates a period
    create-schedule     Creates a schedule
    delete-period       Deletes a period
    delete-schedule     Deletes a schedule
    describe-periods    Describes configured periods
    describe-schedule-usage
                        Calculates periods and billing hours in which
                        instances are running
    describe-schedules  Described configured schedules
    update-period       Updates a period
    update-schedule     Updates a schedule

특정 명령과 함께 사용하면 --help 인수가 해당 명령에 유효한 하위 명령과 인수를 표시합니다.

특정 명령 예시

$ scheduler-cli describe-schedules --help
usage: scheduler-cli describe-schedules [-h] [--name NAME] [--query QUERY]
                                        [--region REGION] --stack STACK

optional arguments:
  -h, --help         show this help message and exit
  --name NAME        Name of the schedule
  --query QUERY      JMESPath query to transform or filter the result
  --region REGION    Region in which the Instance Scheduler stack is
                        deployed
  --stack STACK, -s STACK
                     Name of the Instance Scheduler stack