buildImage

AWS 리전에서 사용자 지정 AWS ParallelCluster 이미지를 만드세요.

요청 구문

POST /v3/images/custom
{
  "imageConfiguration": "string",
  "imageId": "string",
  "dryrun": boolean,
  "region": "string",
  "rollbackOnFailure": boolean,
  "supressValidators": [ "string" ],
  "validationFailureLevel": "string"
}

요청 본문

imageConfiguration

YAML 문서로서의 이미지 구성입니다.

유형: 문자열

필수 항목 여부: 예

imageId

빌드할 이미지의 ID입니다.

유형: 문자열

필수 항목 여부: 예

dryrun

true로 설정하면 리소스를 만들지 않고 요청 검증만 수행합니다. 이 파라미터를 사용하여 이미지 구성을 확인합니다. 기본값은 false입니다.

유형: boolean

필수 항목 여부: 아니요

region

이미지를 빌드하기 위해 명령을 실행하는 AWS 리전입니다.

유형: 문자열

필수 항목 여부: 아니요

rollbackOnFailure

true로 설정하면 이미지 생성에 실패할 경우 이미지 스택 롤백이 발생합니다. 기본값은 false입니다.

유형: boolean

필수 항목 여부: 아니요

suppressValidators

억제할 구성 유효성 검사기를 하나 이상 식별하세요.

유형: 문자열 목록

형식: (ALL|type:[A-Za-z0-9]+)

필수 항목 여부: 아니요

validationFailureLevel

이미지 빌드 실패를 유발하는 최소 검증 수준입니다. 기본값은 ERROR입니다.

유형: 문자열

유효한 값: INFO | WARNING | ERROR

필수 항목 여부: 아니요

응답 구문

{
  "image": {
    "imageId": "string",
    "ec2AmiInfo": {
      "amiId": "string"
    },
    "region": "string",
    "version": "string",
    "cloudformationStackArn": "string",
    "imageBuildStatus": "BUILD_IN_PROGRESS",
    "cloudformationStackStatus": "CREATE_IN_PROGRESS"
  },
  "validationMessages": [
    {
      "id": "string",
      "type": "string",
      "level": "INFO",
      "message": "string"
    }
  ]
}

응답 본문

image

imageId

이미지의 ID입니다.

유형: 문자열

CloudformationStackArn

메인 CloudFormation 스택의 Amazon 리소스 이름(ARN)입니다.

유형: 문자열

cloudformationStackStatus

CloudFormation 스택 상태입니다.

유형: 문자열

유효한 값: CREATE_IN_PROGRESS | CREATE_FAILED | CREATE_COMPLETE | ROLLBACK_IN_PROGRESS | ROLLBACK_FAILED | ROLLBACK_COMPLETE | DELETE_IN_PROGRESS | DELETE_FAILED | DELETE_COMPLETE | UPDATE_IN_PROGRESS | UPDATE_COMPLETE_CLEANUP_IN_PROGRESS | UPDATE_COMPLETE | UPDATE_ROLLBACK_IN_PROGRESS | UPDATE_ROLLBACK_FAILED | UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS | UPDATE_ROLLBACK_COMPLETE

ec2AmiInfo

ami_id

EC2 AMI ID입니다.

유형: 문자열

imageBuildStatus

이미지 빌드 상태입니다.

유형: 문자열

유효한 값: BUILD_IN_PROGRESS | BUILD_FAILED | BUILD_COMPLETE | DELETE_IN_PROGRESS | DELETE_FAILED | DELETE_COMPLETE

region

이미지가 빌드되어 있는 AWS 리전입니다.

유형: 문자열

version

이미지 빌드에 사용된 AWS ParallelCluster 버전입니다.

유형: 문자열

validationMessages

검증 수준이 validationFailureLevel보다 낮은 메시지 목록입니다. 메시지 목록은 구성 검증 중에 수집됩니다.

id

검사기의 ID입니다.

유형: 문자열

level

검증 수준입니다.

유형: 문자열

유효한 값: INFO | WARNING | ERROR

message

확인 메시지입니다.

유형: 문자열

type

검사기의 유형입니다.

유형: 문자열

예제

Python

요청

$ build_image(custom-image-id, custom-image-config.yaml)

200 응답

{
  'image': {
    'cloudformation_stack_arn': 'arn:aws:cloudformation:us-east-1:123456789012:stack/custom-image-id/711b76b0-af81-11ec-a29f-0ee549109f1f',
    'cloudformation_stack_status': 'CREATE_IN_PROGRESS',
    'image_build_status': 'BUILD_IN_PROGRESS',
    'image_id': 'custom-image-id',
    'region': 'us-east-1',
    'version': '3.2.1'
  }
}