로컬 배포 및 구성 요소 관리

Greengrass CLI IPC 서비스를 사용하여 코어 디바이스에서 로컬 배포 및 Greengrass 구성 요소를 관리할 수 있습니다.

이러한 IPC 작업을 사용하려면 Greengrass CLI 구성 요소 버전 2.6.0 이상을 사용자 지정 구성 요소에 종속성으로 포함합니다. 그런 다음 사용자 지정 구성 요소에서 IPC 작업을 사용하여 다음을 수행할 수 있습니다.

최소 SDK 버전

다음 표에는 Greengrass CLI IPC 서비스와 상호 작용하는 데 사용할 수 있는 SDKs의 최소 버전이 나열되어 있습니다.

권한 부여

사용자 지정 구성 요소에서 Greengrass CLI IPC 서비스를 사용하려면 구성 요소가 로컬 배포 및 구성 요소를 관리할 수 있도록 허용하는 권한 부여 정책을 정의해야 합니다. 권한 부여 정책 정의에 대한 자세한 내용은 구성 요소에 IPC 작업을 수행할 수 있는 권한 부여 섹션을 참조하세요.

Greengrass CLI에 대한 권한 부여 정책에는 다음 속성이 있습니다.

IPC 서비스 식별자: aws.greengrass.Cli

{
  "accessControl": {
    "aws.greengrass.Cli": {
      "com.example.MyLocalManagerComponent:cli:1": {
        "policyDescription": "Allows access to create local deployments and view deployments and components.",
        "operations": [
          "aws.greengrass#CreateLocalDeployment",
          "aws.greengrass#ListLocalDeployments",
          "aws.greengrass#GetLocalDeploymentStatus",
          "aws.greengrass#ListComponents",
          "aws.greengrass#GetComponentDetails"
        ],
        "resources": [
          "*"
        ]
      }
    },
    "aws.greengrass.Cli": {
      "com.example.MyLocalManagerComponent:cli:2": {
        "policyDescription": "Allows access to restart and stop the Hello World component.",
        "operations": [
          "aws.greengrass#RestartComponent",
          "aws.greengrass#StopComponent"
        ],
        "resources": [
          "com.example.HelloWorld"
        ]
      }
    }
  }
}

CreateLocalDeployment

지정된 구성 요소 레시피, 아티팩트 및 런타임 인수를 사용하여 로컬 배포를 생성하거나 업데이트합니다.

이 작업은 Greengrass CLI의 deployment create 명령과 동일한 기능을 제공합니다.

요청

이 작업의 요청에서는 다음 파라미터를 사용합니다.

응답

이 작업의 응답에는 다음 정보가 포함됩니다.

ListLocalDeployments

마지막 10개 로컬 배포의 상태를 가져옵니다.

이 작업은 Greengrass CLI의 deployment list 명령과 동일한 기능을 제공합니다.

요청

이 작업의 요청에는 파라미터가 없습니다.

응답

이 작업의 응답에는 다음 정보가 포함됩니다.

GetLocalDeploymentStatus

로컬 배포의 상태를 가져옵니다.

이 작업은 Greengrass CLI의 deployment status 명령과 동일한 기능을 제공합니다.

요청

이 작업의 요청에서는 다음 파라미터를 사용합니다.

응답

이 작업의 응답에는 다음 정보가 포함됩니다.

ListComponents

코어 디바이스에서 각 루트 구성 요소의 이름, 버전, 상태 및 구성을 가져옵니다. 루트 구성 요소는 배포에서 지정하는 구성 요소입니다. 이 응답에는 다른 구성 요소의 종속성으로 설치된 구성 요소는 포함되지 않습니다.

이 작업은 Greengrass CLI의 component list 명령과 동일한 기능을 제공합니다.

요청

이 작업의 요청에는 파라미터가 없습니다.

응답

이 작업의 응답에는 다음 정보가 포함됩니다.

GetComponentDetails

코어 디바이스에서 구성 요소의 버전, 상태 및 구성을 가져옵니다.

이 작업은 Greengrass CLI의 component details 명령과 동일한 기능을 제공합니다.

요청

이 작업의 요청에서는 다음 파라미터를 사용합니다.

응답

이 작업의 응답에는 다음 정보가 포함됩니다.

RestartComponent

코어 디바이스에서 구성 요소를 다시 시작합니다.

이 작업은 Greengrass CLI의 component restart 명령과 동일한 기능을 제공합니다.

요청

이 작업의 요청에서는 다음 파라미터를 사용합니다.

응답

이 작업의 응답에는 다음 정보가 포함됩니다.

예제

다음 예제에서는 사용자 지정 구성 요소 코드에서 이 작업을 직접 호출하는 방법을 보여줍니다.

StopComponent

코어 디바이스에서 구성 요소의 프로세스를 중지합니다.

이 작업은 Greengrass CLI의 component stop 명령과 동일한 기능을 제공합니다.

요청

이 작업의 요청에서는 다음 파라미터를 사용합니다.

응답

이 작업의 응답에는 다음 정보가 포함됩니다.

CreateDebugPassword

로컬 디버그 콘솔 구성 요소에 로그인하는 데 사용할 수 있는 임의 암호를 생성합니다. 암호는 생성되고 8시간 후에 만료됩니다.

이 작업은 Greengrass CLI의 get-debug-password 명령과 동일한 기능을 제공합니다.

요청

이 작업의 요청에는 파라미터가 없습니다.

응답

이 작업의 응답에는 다음 정보가 포함됩니다.