register-task-with-maintenance-windows 옵션 정보 - AWS Systems Manager

register-task-with-maintenance-windows 옵션 정보

register-task-with-maintenance-window 명령은 필요에 따라 작업을 구성하기 위한 몇 가지 옵션을 제공합니다. 일부는 필수 옵션이고 일부는 선택 옵션이며 일부는 단일 유지 관리 기간 작업 유형에만 적용됩니다.

이 주제에서는 이 자습서 단원의 샘플 작업에 도움이 되는 몇 가지 옵션에 대한 정보를 제공합니다. 모든 명령 옵션에 대한 자세한 내용은 AWS CLI Command Reference의 register-task-with-maintenance-window 섹션을 참조하세요.

--task-arn 옵션 정보

--task-arn 옵션은 태스크가 작업 중에 사용하는 리소스를 지정하는 데 사용됩니다. 지정하는 값은 다음 표에 설명된 대로 등록 중인 태스크 유형에 따라 달라집니다.

유지 관리 기간 작업을 위한 TaskArn 형식
유지 관리 기간 작업 유형 TaskArn 값

RUN_COMMAND 및 AUTOMATION

TaskArn은 SSM 문서 이름 또는 Amazon 리소스 이름(ARN)입니다. 예:

AWS-RunBatchShellScript

-또는-

arn:aws:ssm:region:111122223333:document/My-Document.

LAMBDA

TaskArn은 함수 이름 또는 ARN입니다. 예:

SSMMy-Lambda-Function

-또는-

arn:aws:lambda:region:111122223333:function:SSMMyLambdaFunction.

중요

Maintenance Windows의 IAM 정책에서는 Lambda 함수 이름(또는 별칭) 앞에 접두사 SSM을 추가해야 합니다. 이러한 유형의 태스크를 등록하기 전에 AWS Lambda에서 SSM을 포함하도록 이름을 업데이트합니다. 예를 들어 Lambda 함수 이름이 MyLambdaFunction인 경우 SSMMyLambdaFunction으로 변경합니다.

STEP_FUNCTIONS

TaskArn은 상태 시스템 ARN입니다. 예:

arn:aws:states:us-east-2:111122223333:stateMachine:SSMMyStateMachine.

중요

유지 관리 기간의 IAM 정책에서는 Step Functions 상태 시스템 이름 앞에 접두사 SSM을 추가해야 합니다. 이러한 유형의 작업을 등록하기 전에 AWS Step Functions에서 SSM을 포함하도록 이름을 업데이트해야 합니다. 예를 들어 상태 시스템 이름이 MyStateMachine인 경우 SSMMyStateMachine으로 변경합니다.
--service-role-arn 옵션 정보

유지 관리 기간 작업을 실행할 때 수임할 AWS Systems Manager 역할입니다.

자세한 내용은 Maintenance Windows 설정 단원을 참조하세요.

--task-invocation-parameters 옵션 정보

--task-invocation-parameters 옵션은 네 가지 작업 유형 각각에 고유한 파라미터를 지정하는 데 사용됩니다. 다음 표에서는 네 가지 작업 유형 각각에 대해 지원되는 파라미터를 설명합니다.

참고

{{TARGET_ID}} 등 --task-invocation-parameters 콘텐츠에서의 의사 파라미터 사용에 대한 자세한 내용은 유지 관리 기간 작업 등록 시 의사 파라미터 사용 섹션을 참조하세요.

유지 관리 기간 작업에 대한 작업 호출 파라미터 옵션

유지 관리 기간 작업 유형 사용 가능한 파라미터 예

RUN_COMMAND

설명

DocumentHash

DocumentHashType

NotificationConfig

OutputS3BucketName

OutputS3KeyPrefix

파라미터

ServiceRoleArn

TimeoutSeconds

 
"TaskInvocationParameters": {
        "RunCommand": {
            "Comment": "My Run Command task comment",
            "DocumentHash": "6554ed3d--truncated--5EXAMPLE",
            "DocumentHashType": "Sha256",
            "NotificationConfig": {
                "NotificationArn": "arn:aws:sns:region:123456789012:my-sns-topic-name",
                "NotificationEvents": [
                    "FAILURE"
                ],
                "NotificationType": "Invocation"
            },
            "OutputS3BucketName": "DOC-EXAMPLE-BUCKET",
            "OutputS3KeyPrefix": "S3-PREFIX",
            "Parameters": {
                "commands": [
                    "Get-ChildItem$env: temp-Recurse|Remove-Item-Recurse-force"
                ]
            },
            "ServiceRoleArn": "arn:aws:iam::123456789012:role/MyMaintenanceWindowServiceRole",
            "TimeoutSeconds": 3600
        }
    }

자동화

DocumentVersion

파라미터

 
"TaskInvocationParameters": {
        "Automation": {
            "DocumentVersion": "3",
            "Parameters": {
                "instanceid": [
                    "{{TARGET_ID}}"
                ]
            }
        }
    }

LAMBDA

ClientContext

페이로드

한정자

 
"TaskInvocationParameters": {
        "Lambda": {
            "ClientContext": "ew0KICAi--truncated--0KIEXAMPLE",
            "Payload": "{ \"targetId\": \"{{TARGET_ID}}\", \"targetType\": \"{{TARGET_TYPE}}\" }",
            "Qualifier": "$LATEST"
        }
    }

STEP_FUNCTIONS

Input

명칭

 
"TaskInvocationParameters": {
        "StepFunctions": {
            "Input": "{ \"targetId\": \"{{TARGET_ID}}\" }",
            "Name": "{{INVOCATION_ID}}"
        }
    }