Bild erstellen

Erstellen Sie ein benutzerdefiniertesAWS ParallelClusterBild in einemAWS-Region.

Erforderliche Syntax

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

Anforderungstext

Image-Konfiguration

Die Image-Konfiguration als YAML-Dokument.

Typ: Zeichenfolge

Erforderlich: Ja

imageId

Die ID des zu erstellenden Images.

Typ: Zeichenfolge

Erforderlich: Ja

Trockenlauf

Wenn gesetzt auftrueführt nur eine Anforderungsvalidierung durch, ohne eine Ressource zu erstellen. Verwenden Sie diesen Parameter, um die Image-Konfiguration zu validieren. Der Standardwert ist false.

Typ: boolescher Wert

Required: No

region

DerAWS-Regionin dem Sie den Befehl ausführen, in dem das Image erstellt wird.

Typ: Zeichenkette

Required: No

rollbackOnFailure

Wenn gesetzt auftrueerfolgt ein Rollback des Image-Stacks, wenn das Image nicht erstellt werden kann. Der Standardwert ist false.

Typ: boolescher Wert

Required: No

Unterdrücken Sie Validatoren

Identifizieren Sie einen oder mehrere Konfigurationsvalidatoren, die unterdrückt werden sollen.

Typ: Liste von Zeichenketten

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

Required: No

validationFailureLevel

Die Mindestvalidierungsstufe, die dazu führt, dass die Image-Erstellung fehlschlägt. Der Standardwert ist ERROR.

Typ: Zeichenfolge

Zulässige Werte: INFO | WARNING | ERROR

Required: No

Antwortsyntax

{
  "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"
    }
  ]
}

Antworttext

Image

imageId

Die ID des Bildes.

Typ: Zeichenfolge

cloudformationStackArn

Der Amazon-Ressourcenname (ARN) der Haupt-Ressource CloudFormation Stapel.

Typ: Zeichenfolge

cloudformationStackStatus

Der CloudFormation Status des Stapels.

Typ: Zeichenfolge

Zulässige Werte: 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

Die EC2-AMI-ID.

Typ: Zeichenfolge

imageBuildStatus

Der Status der Image-Erstellung.

Typ: Zeichenfolge

Zulässige Werte: BUILD_IN_PROGRESS | BUILD_FAILED | BUILD_COMPLETE | DELETE_IN_PROGRESS | DELETE_FAILED | DELETE_COMPLETE

region

DieAWS-Regiondass das Bild eingebaut ist.

Typ: Zeichenfolge

Version

DasAWS ParallelClusterVersion, die zum Erstellen des Images verwendet wurde.

Typ: Zeichenfolge

Bestätigungsnachrichten

Eine Liste von Nachrichten mit einer Validierungsstufe untervalidationFailureLevel. Die Liste der Nachrichten wird während der Konfigurationsvalidierung gesammelt.

ID

Die Validator-ID.

Typ: Zeichenfolge

level

Die Validierungsebene.

Typ: Zeichenfolge

Zulässige Werte: INFO | WARNING | ERROR

Nachricht

Eine Bestätigungsnachricht.

Typ: Zeichenfolge

type

Der Typ des Validators.

Typ: Zeichenfolge

Beispiel

Python

Anforderung

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

200 Antwort

{
  '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'
  }
}