Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.
CreateLedger
Crée un nouveau registre Compte AWS dans votre région actuelle.
Syntaxe de la demande
POST /ledgers HTTP/1.1
Content-type: application/json
{
"DeletionProtection": boolean,
"KmsKey": "string",
"Name": "string",
"PermissionsMode": "string",
"Tags": {
"string" : "string"
}
}Paramètres de demande URI
La demande n’utilise pas de paramètres URI.
Corps de la demande
Cette demande accepte les données suivantes au format JSON.
- DeletionProtection
-
Spécifie si le registre est protégé contre la suppression par un utilisateur. À défaut de définition lors de la création du registre, cette fonctionnalité est activée (
true) par défaut.Si la protection contre la suppression est activée, vous devez commencer par la désactiver avant de pouvoir supprimer le registre. Vous pouvez la désactiver en appelant l'opération
UpdateLedgerpour définir ce paramètre surfalse.Type : booléen
Obligatoire : non
- KmsKey
-
La clé in AWS Key Management Service (AWS KMS) à utiliser pour le chiffrement des données au repos dans le registre. Pour plus d'informations, veuillez consulter la rubrique Chiffrement au repos dans le Guide du développeur Amazon QLDB.
Utilisez l'une des options suivantes pour spécifier ce paramètre :
-
AWS_OWNED_KMS_KEY: utilisez une AWS KMS clé détenue et gérée par AWS vous. -
Non défini : par défaut, utilisez une clé KMS AWS détenue.
-
Une clé KMS symétrique gérée par le client valide : utilisez la clé KMS de chiffrement symétrique spécifiée dans votre compte que vous créez, possédez et gérez.
Amazon QLDB ne prend pas en charge les clés asymétriques. Pour plus d'informations, consultez la section Utilisation de clés symétriques et asymétriques dans le manuel du AWS Key Management Service développeur.
Pour spécifier une clé KMS gérée par le client, utilisez son ID de clé, son Amazon Resource Name (ARN), son nom d'alias ou son ARN d'alias. Lorsque vous utilisez un nom d'alias, préfixez-le avec
"alias/". Pour spécifier une clé dans un autre Compte AWS, vous devez utiliser l'ARN de la clé ou l'alias ARN.Par exemple :
-
ID de clé :
1234abcd-12ab-34cd-56ef-1234567890ab -
ARN de clé :
arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab -
Nom d'alias :
alias/ExampleAlias -
ARN d'alias :
arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
Pour plus d'informations, consultez la section Identifiants clés (KeyId) dans le guide du AWS Key Management Service développeur.
Type : String
Contraintes de longueur : longueur maximale de 1600.
Obligatoire : non
-
- Name
-
Nom du registre que vous souhaitez créer. Le nom doit être unique parmi tous les registres de votre Compte AWS région actuelle.
Les contraintes de dénomination pour les noms de registre sont définies dans Quotas dans Amazon QLDB du Amazon QLDB Developer Guide.
Type : String
Contraintes de longueur : longueur minimum de 1. Longueur maximale de 32.
Modèle :
(?!^.*--)(?!^[0-9]+$)(?!^-)(?!.*-$)^[A-Za-z0-9-]+$Obligatoire : oui
- PermissionsMode
-
Mode d'autorisations à attribuer au registre que vous souhaitez créer. Ce paramètre peut avoir une des valeurs suivantes :
-
ALLOW_ALL: un mode d'autorisations hérité qui permet le contrôle d'accès avec une granularité au niveau de l'API pour les registres.Ce mode permet aux utilisateurs qui possèdent l'autorisation d'API
SendCommandpour ce registre d'exécuter toutes les commandes PartiQL (par conséquent,ALLOW_ALL) sur toutes les tables du registre spécifié. Ce mode ignore les politiques d'autorisations IAM au niveau de la table ou de la commande que vous créez pour le registre. -
STANDARD: (Recommandé) un mode d'autorisations qui permet le contrôle d'accès avec une granularité plus fine pour les registres, les tables et les commandes PartiQL.Par défaut, ce mode refuse toutes les demandes utilisateur d'exécuter des commandes PartiQL sur les tables de ce registre. Pour autoriser l'exécution des commandes PartiQL, vous devez créer des politiques d'autorisations IAM pour des ressources de table spécifiques et des actions PartiQL, en plus de l'autorisation d'API
SendCommandpour le registre. Pour plus d'informations, veuillez consulter la rubrique Premiers pas avec le mode d'autorisations standard dans le Guide du développeur Amazon QLDB.
Note
Nous vous recommandons vivement d'utiliser le mode d'autorisations
STANDARDpour optimiser la sécurité des données de votre registre.Type : String
Valeurs valides :
ALLOW_ALL | STANDARDObligatoire : oui
-
- Tags
-
Les paires clé-valeur à ajouter sous forme de balises au registre que vous souhaitez créer. Les clés de balises sont sensibles à la casse. Les valeurs des balises distinguent les majuscules et minuscules et peuvent être nulles.
Type : mappage chaîne/chaîne
Entrées cartographiques : nombre minimum de 0 éléments. Nombre maximum de 200 éléments.
Contraintes de longueur de clé : longueur minimale de 1. Longueur maximale de 128.
Contraintes de longueur de valeur : longueur minimale de 0. Longueur maximale de 256.
Obligatoire : non
Syntaxe de la réponse
HTTP/1.1 200
Content-type: application/json
{
"Arn": "string",
"CreationDateTime": number,
"DeletionProtection": boolean,
"KmsKeyArn": "string",
"Name": "string",
"PermissionsMode": "string",
"State": "string"
}Eléments de réponse
Si l’action aboutit, le service renvoie une réponse HTTP 200.
Les données suivantes sont renvoyées au format JSON par le service.
- Arn
-
Le nom de ressource Amazon (ARN) du registre.
Type : String
Contraintes de longueur : longueur minimale de 20. Longueur maximale de 1600.
- CreationDateTime
-
Date et heure, au format epoch time, auxquelles le registre a été créé. (Le format Epoch est le nombre de secondes écoulées depuis 00h00 le 1er janvier 1970 UTC.)
Type : Timestamp
- DeletionProtection
-
Spécifie si le registre est protégé contre la suppression par un utilisateur. À défaut de définition lors de la création du registre, cette fonctionnalité est activée (
true) par défaut.Si la protection contre la suppression est activée, vous devez commencer par la désactiver avant de pouvoir supprimer le registre. Vous pouvez la désactiver en appelant l'opération
UpdateLedgerpour définir ce paramètre surfalse.Type : booléen
- KmsKeyArn
-
L'ARN de la clé KMS gérée par le client que le registre utilise pour le chiffrement au repos. Si ce paramètre n'est pas défini, le registre utilise une clé KMS AWS détenue pour le chiffrement.
Type : String
Contraintes de longueur : longueur minimale de 20. Longueur maximale de 1600.
- Name
-
Nom du registre.
Type : String
Contraintes de longueur : longueur minimum de 1. Longueur maximale de 32.
Modèle :
(?!^.*--)(?!^[0-9]+$)(?!^-)(?!.*-$)^[A-Za-z0-9-]+$ - PermissionsMode
-
Mode d'autorisations du registre que vous avez créé.
Type : String
Valeurs valides :
ALLOW_ALL | STANDARD - State
-
État actuel du registre.
Type : String
Valeurs valides :
CREATING | ACTIVE | DELETING | DELETED
Erreurs
Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez Erreurs courantes.
- InvalidParameterException
-
Un ou plusieurs paramètres de la demande ne sont pas valides.
Code d’état HTTP : 400
- LimitExceededException
-
Vous avez atteint la limite du nombre maximum de ressources autorisées.
Code d’état HTTP : 400
- ResourceAlreadyExistsException
-
La ressource spécifiée existe déjà.
Code d’état HTTP : 409
- ResourceInUseException
-
La ressource spécifiée ne peut pas être modifiée pour le moment.
Code d’état HTTP : 409
consultez aussi
Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
