CreateLedger - Database Amazon Quantum Ledger (Amazon) QLDB
Sintassi della richiestaParametri della richiesta URI:Corpo della richiestaSintassi della rispostaElementi di rispostaErroriVedi anche

Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.

CreateLedger

Crea un nuovo registro Account AWS nella tua regione corrente.

Sintassi della richiesta

POST /ledgers HTTP/1.1
Content-type: application/json

{
   "DeletionProtection": boolean,
   "KmsKey": "string",
   "Name": "string",
   "PermissionsMode": "string",
   "Tags": { 
      "string" : "string" 
   }
}

Parametri della richiesta URI:

La richiesta non utilizza parametri URI.

Corpo della richiesta

La richiesta accetta i seguenti dati in formato JSON.

DeletionProtection

Specifica se il libro mastro è protetto dall'eliminazione da parte di un utente qualsiasi. Se non definita al momento della creazione del libro mastro, questa caratteristica è abilitata (true) per impostazione predefinita.

Se la protezione dall'eliminazione è abilitata, è necessario innanzitutto disabilitarla prima di poter eliminare il libro mastro. Puoi disabilitarla chiamando l'operazione UpdateLedger per impostare questo parametro su false.

Tipo: Booleano

Campo obbligatorio: no

KmsKey

La chiave in AWS Key Management Service (AWS KMS) da usare per la crittografia dei dati inattivi nel registro. Per ulteriori informazioni, consulta Crittografia dei dati inattivi nella Guida per gli sviluppatori di Amazon QLDB.

Per specificare questo parametro, puoi utilizzare una delle opzioni seguenti:

  • AWS_OWNED_KMS_KEY: utilizza una AWS KMS chiave posseduta e gestita da per tuo AWS conto.

  • Non definito: per impostazione predefinita, utilizza una chiave KMS AWS di proprietà.

  • Una chiave KMS simmetrica valida gestita dal cliente: usa le chiave KMS di crittografia simmetrica specificata nell'account che crei, possiedi e gestisci.

    Amazon QLDB non supporta le chiavi asimmetriche. Per ulteriori informazioni, consulta Uso delle chiavi simmetriche e asimmetriche nella Guida per gli sviluppatori. AWS Key Management Service

Per specificare una chiave KMS gestita dal cliente, utilizza il relativo ID chiave, il nome della risorsa Amazon (ARN), il nome dell'alias o l'ARN dell'alias. Quando utilizzi un nome alias, aggiungi il prefisso "alias/". Per specificare una chiave in un'altra Account AWS, è necessario utilizzare la chiave ARN o l'alias ARN.

Per esempio:

  • ID chiave: 1234abcd-12ab-34cd-56ef-1234567890ab

  • ARN chiave: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

  • Nome alias: alias/ExampleAlias

  • ARN alias: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

Per ulteriori informazioni, consulta Key identifiers (KeyId) nella Developer Guide. AWS Key Management Service

▬Tipo: stringa

Vincoli di lunghezza: lunghezza massima di 1600.

Campo obbligatorio: no

Name

Il nome della contabilità che desideri creare. Il nome deve essere univoco tra tutti i registri della regione Account AWS corrente.

I vincoli di denominazione per i nomi dei libri contabili sono definiti in Quote in Amazon QLDB nella Guida per gli sviluppatori di Amazon QLDB.

▬Tipo: stringa

Limitazioni di lunghezza: lunghezza minima pari a 1. La lunghezza massima è 32 caratteri.

Modello: (?!^.*--)(?!^[0-9]+$)(?!^-)(?!.*-$)^[A-Za-z0-9-]+$

Campo obbligatorio: sì

PermissionsMode

Le autorizzazioni da assegnare alla contabilità che si desidera creare. Questo parametro può avere uno dei seguenti valori:

  • ALLOW_ALL: una modalità di autorizzazione legacy che consente il controllo degli accessi con granularità a livello di API per i libri mastri.

    Questa modalità consente agli utenti che dispongono dell'autorizzazione API SendCommand per questo libro mastro per eseguire tutti i comandi PartiQL (quindi, ALLOW_ALL) su qualsiasi tabella nel libro mastro specificato. Questa modalità ignora tutte le policy di autorizzazione IAM a livello di tabella o di comando create per il libro mastro.

  • STANDARD: (impostazione consigliata) una modalità di autorizzazione che consente il controllo degli accessi con una granularità più fine per libri mastri, tabelle e comandi PartiQL.

    Per impostazione predefinita, questa modalità nega tutte le richieste degli utenti di eseguire qualsiasi comando PartiQL su qualsiasi tabella in questo libro mastro. Per consentire l'esecuzione dei comandi PartiQL, devi creare le policy di autorizzazione IAM per risorse di tabelle e operazioni PartiQL specifiche, oltre all'autorizzazione API SendCommand per il libro mastro. Per informazioni, consulta Getting started with the standard permissions mode (Nozioni di base sulla modalità di autorizzazione standard) nella Guida per gli sviluppatori di Amazon QLDB.

Nota

Ti consigliamo di utilizzare la modalità di autorizzazione STANDARD per incrementare la sicurezza dei dati nel libro mastro.

▬Tipo: stringa

Valori validi: ALLOW_ALL | STANDARD

Campo obbligatorio: sì

Tags

Le coppie chiave-valore da aggiungere come tag al libro mastro che si desidera creare. Le chiavi dei tag prevedono una distinzione tra lettere maiuscole e minuscole. I valori dei tag fanno distinzione tra maiuscole e minuscole e possono essere nulli.

Tipo: mappatura stringa a stringa

Voci sulla mappa: numero minimo di 0 elementi. Numero massimo di 200 elementi.

Limitazioni di lunghezza della chiave: la lunghezza minima è 1. La lunghezza massima è 128 caratteri.

Limiti di lunghezza del valore: lunghezza minima di 0. La lunghezza massima è 256 caratteri.

Campo obbligatorio: no

Sintassi della risposta

HTTP/1.1 200
Content-type: application/json

{
   "Arn": "string",
   "CreationDateTime": number,
   "DeletionProtection": boolean,
   "KmsKeyArn": "string",
   "Name": "string",
   "PermissionsMode": "string",
   "State": "string"
}

Elementi di risposta

Se l'operazione riesce, il servizio restituisce una risposta HTTP 200.

I dati seguenti vengono restituiti in formato JSON mediante il servizio.

Arn

L'Amazon Resource Name (ARN) per il registro.

▬Tipo: stringa

Limitazioni di lunghezza: lunghezza minima di 20. La lunghezza massima è 1600 caratteri.

CreationDateTime

La data e l'ora, in formato epoch time, in cui è stato creato il libro mastro. (Il formato dell'ora epoch è il numero di secondi trascorsi dalle 00:00 del 1° gennaio 1970 UTC.)

Tipo: Timestamp

DeletionProtection

Specifica se il libro mastro è protetto dall'eliminazione da parte di un utente qualsiasi. Se non definita al momento della creazione del libro mastro, questa caratteristica è abilitata (true) per impostazione predefinita.

Se la protezione dall'eliminazione è abilitata, è necessario innanzitutto disabilitarla prima di poter eliminare il libro mastro. Puoi disabilitarla chiamando l'operazione UpdateLedger per impostare questo parametro su false.

Tipo: Booleano

KmsKeyArn

L'ARN della chiave KMS gestita dal cliente che il registro utilizza per la crittografia a riposo. Se questo parametro non è definito, il registro utilizza una chiave KMS AWS proprietaria per la crittografia.

▬Tipo: stringa

Limitazioni di lunghezza: lunghezza minima di 20. La lunghezza massima è 1600 caratteri.

Name

Il nome del libro mastro.

▬Tipo: stringa

Limitazioni di lunghezza: lunghezza minima pari a 1. La lunghezza massima è 32 caratteri.

Modello: (?!^.*--)(?!^[0-9]+$)(?!^-)(?!.*-$)^[A-Za-z0-9-]+$

PermissionsMode

La modalità di autorizzazione del libro mastro che hai creato.

▬Tipo: stringa

Valori validi: ALLOW_ALL | STANDARD

State

Lo stato attuale del libro mastro.

▬Tipo: stringa

Valori validi: CREATING | ACTIVE | DELETING | DELETED

Errori

Per informazioni sugli errori comuni a tutte le operazioni, consultare Errori comuni.

InvalidParameterException

Uno o più parametri nella richiesta non sono validi.

Codice di stato HTTP: 400

LimitExceededException

Hai raggiunto il limite del numero massimo di risorse consentite.

Codice di stato HTTP: 400

ResourceAlreadyExistsException

La risorsa specificata esiste già.

Codice di stato HTTP: 409

ResourceInUseException

La risorsa specificata non può essere modificata in questo momento.

Codice di stato HTTP: 409

Vedi anche

Per ulteriori informazioni sull'utilizzo di questa API in uno degli AWS SDK specifici della lingua, consulta quanto segue: