Oggetti di risposta di risorse personalizzate - AWS CloudFormation

Oggetti di risposta di risorse personalizzate

Questo argomento descrive le proprietà dell’oggetto risposta per una risorsa personalizzata CloudFormation.

Per un’introduzione alle risorse personalizzate e al loro funzionamento, consulta Creare una logica di provisioning personalizzata con risorse personalizzate.

Campi di risposta del provider di risorse personalizzate

Di seguito sono elencate le proprietà del provider di risorse personalizzate durante l’invio del file alla JSON all’URL prefirmato. Per ulteriori informazioni sul caricamento di oggetti utilizzando URL prefirmati, consulta Uploading objects with presigned URLs nella Guida per l’utente di Amazon Simple Storage Service.

Nota

La dimensione totale del corpo della risposta non può superare 4096 byte.

Status

Il valore dello stato inviato dal provider di risorse personalizzate in risposta a una richiesta generata da CloudFormation.

Deve essere SUCCESS o FAILED.

Campo obbligatorio: sì

Tipo: stringa

Reason

Descrive il motivo di una risposta con esito negativo.

Campo obbligatorio: richiesto se Status è FAILED. Altrimenti, è facoltativo.

Tipo: stringa

PhysicalResourceId

Questo valore deve essere un identificativo univoco per il fornitore di risorse personalizzate e può avere una dimensione massima di 1 KB. Il valore deve essere una stringa non vuota e deve essere identico per tutte le risposte per la stessa risorsa.

Il valore restituito per un PhysicalResourceId può modificare le operazioni personalizzate di aggiornamento delle risorse. Se il valore restituito è lo stesso, viene considerato un aggiornamento normale. Se il valore restituito è diverso, CloudFormation riconosce l’aggiornamento come sostituzione e invia una richiesta di eliminazione alla vecchia risorsa. Per ulteriori informazioni, consulta AWS::CloudFormation::CustomResource.

Campo obbligatorio: sì

Tipo: stringa

StackId

Il nome della risorsa Amazon (ARN) che identifica lo stack che contiene la risorsa personalizzata. Questo valore di risposta deve essere copiato parola per parola dalla richiesta.

Campo obbligatorio: sì

Tipo: stringa

RequestId

Un ID univoco per la richiesta. Questo valore di risposta deve essere copiato parola per parola dalla richiesta.

Campo obbligatorio: sì

Tipo: stringa

LogicalResourceId

Il nome (ID logico) scelto dallo sviluppatore del modello della risorsa personalizzata nel modello CloudFormation. Questo valore di risposta deve essere copiato parola per parola dalla richiesta.

Campo obbligatorio: sì

Tipo: stringa

NoEcho

Facoltativo. Indica se nascondere o meno l’output della risorsa personalizzata quando viene recuperata utilizzando la funzione Fn::GetAtt. Se impostato su true, tutti i valori restituiti vengono nascosti con degli asterischi (*****), ad eccezione di quelli archiviati nella sezione del modello Metadata. CloudFormation non trasforma, modifica o omette le informazioni incluse nella sezione Metadata. Il valore predefinito è false.

Per ulteriori informazioni sull’utilizzo di NoEcho per mascherare le informazioni sensibili, consulta la best practice Do not embed credentials in your templates.

Required: No

Tipo: Booleano

Data

Facoltativo. Le coppie nome-valore definite dal provider di risorse personalizzate da inviare con la risposta. Puoi accedere ai valori forniti qui in base al nome nel modello con Fn::GetAtt.

Importante

Se le coppie nome-valore contengono informazioni riservate, è necessario utilizzare il campo NoEcho per mascherare l’output della risorsa personalizzata. In caso contrario, i valori sono visibili tramite API che visualizzano i valori delle proprietà (ad esempio DescribeStackEvents).

Required: No

Tipo: JSON object