DBCluster - Amazon DocumentDB

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.

DBCluster

Informations détaillées sur un cluster.

Table des matières

Note

Dans la liste suivante, les paramètres requis sont décrits en premier.

AssociatedRoles.DBClusterRole.N

Fournit une liste des rôles AWS Identity and Access Management (IAM) associés au cluster. Les rôles (IAM) associés à un cluster autorisent le cluster à accéder à d'autres AWS services en votre nom.

Type : tableau d’objets DBClusterRole

Obligatoire : non

AvailabilityZones.AvailabilityZone.N

Fournit la liste des zones de EC2 disponibilité Amazon dans lesquelles les instances du cluster peuvent être créées.

Type : tableau de chaînes

Obligatoire : non

BackupRetentionPeriod

Spécifie le nombre de jours pendant lesquels les instantanés automatiques sont conservés.

Type : entier

Obligatoire : non

CloneGroupId

Identifie le groupe de clones auquel est associé le cluster de bases de données.

Type : chaîne

Obligatoire : non

ClusterCreateTime

Spécifie l'heure à laquelle le cluster a été créé, en temps universel coordonné (UTC).

Type : Timestamp

Obligatoire : non

DBClusterArn

Le nom de ressource Amazon (ARN) du cluster.

Type : chaîne

Obligatoire : non

DBClusterIdentifier

Contient un identifiant de cluster fourni par l'utilisateur. Cet identifiant est la clé unique qui identifie un cluster.

Type : chaîne

Obligatoire : non

DBClusterMembers.DBClusterMember.N

Fournit la liste des instances qui constituent le cluster.

Type : tableau d’objets DBClusterMember

Obligatoire : non

DBClusterParameterGroup

Spécifie le nom du groupe de paramètres de cluster pour le cluster.

Type : chaîne

Obligatoire : non

DbClusterResourceId

L'identifiant Région AWS unique et immuable du cluster. Cet identifiant se trouve dans les entrées du AWS CloudTrail journal chaque fois que l'on accède à la AWS KMS clé du cluster.

Type : chaîne

Obligatoire : non

DBSubnetGroup

Spécifie des informations sur le groupe de sous-réseaux associé au cluster, notamment le nom, la description et les sous-réseaux du groupe de sous-réseaux.

Type : chaîne

Obligatoire : non

DeletionProtection

Spécifie si ce cluster peut être supprimé. Si cette option DeletionProtection est activée, le cluster ne peut pas être supprimé sauf s'il DeletionProtection est modifié et désactivé. DeletionProtectionprotège les clusters contre la suppression accidentelle.

Type : booléen

Obligatoire : non

EarliestRestorableTime

Heure la plus proche à laquelle une base de données peut être restaurée par point-in-time restauration.

Type : Timestamp

Obligatoire : non

EnabledCloudwatchLogsExports.member.N

Liste des types de journaux que ce cluster est configuré pour exporter vers Amazon CloudWatch Logs.

Type : tableau de chaînes

Obligatoire : non

Endpoint

Spécifie le point de terminaison de connexion pour l'instance principale du cluster.

Type : chaîne

Obligatoire : non

Engine

Fournit le nom du moteur de base de données à utiliser pour ce cluster.

Type : chaîne

Obligatoire : non

EngineVersion

Indique la version du moteur de base de données.

Type : chaîne

Obligatoire : non

HostedZoneId

Spécifie l'ID attribué par Amazon Route 53 lorsque vous créez une zone hébergée.

Type : chaîne

Obligatoire : non

KmsKeyId

Si tel StorageEncrypted est le castrue, l'identifiant de AWS KMS clé du cluster chiffré.

Type : chaîne

Obligatoire : non

LatestRestorableTime

Spécifie l'heure limite à laquelle une base de données peut être restaurée à l'aide de la fonction de point-in-time restauration.

Type : Timestamp

Obligatoire : non

MasterUsername

Contient le nom d'utilisateur principal du cluster.

Type : chaîne

Obligatoire : non

MasterUserSecret

Le secret géré par Amazon DocumentDB dans AWS Secrets Manager pour le mot de passe de l'utilisateur principal.

Type : objet ClusterMasterUserSecret

Obligatoire : non

MultiAZ

Spécifie si le cluster possède des instances dans plusieurs zones de disponibilité.

Type : booléen

Obligatoire : non

PercentProgress

Spécifie la progression de l'opération sous forme de pourcentage.

Type : chaîne

Obligatoire : non

Port

Spécifie le port sur lequel le moteur de base de données est à l'écoute.

Type : entier

Obligatoire : non

PreferredBackupWindow

Spécifie la plage de temps quotidienne au cours de laquelle des sauvegardes automatiques sont créées si cette fonctionnalité est activée, comme déterminé par la propriété BackupRetentionPeriod.

Type : chaîne

Obligatoire : non

PreferredMaintenanceWindow

Spécifie l'intervalle de temps hebdomadaire, au format Universal Coordinated Time (UTC), pendant lequel a lieu la maintenance du système.

Type : chaîne

Obligatoire : non

ReaderEndpoint

Point de terminaison du lecteur pour le cluster. Le point de terminaison du lecteur d'un cluster équilibre la charge des connexions entre les répliques Amazon DocumentDB disponibles dans un cluster. Lorsque les clients demandent de nouvelles connexions au point de terminaison du lecteur, Amazon DocumentDB distribue les demandes de connexion entre les répliques Amazon DocumentDB du cluster. Cette fonctionnalité permet d'équilibrer votre charge de travail de lecture sur plusieurs répliques Amazon DocumentDB de votre cluster.

Si un basculement se produit et que la réplique Amazon DocumentDB à laquelle vous êtes connecté est promue instance principale, votre connexion est interrompue. Pour continuer à envoyer votre charge de travail de lecture à d'autres répliques Amazon DocumentDB du cluster, vous pouvez ensuite vous reconnecter au point de terminaison du lecteur.

Type : chaîne

Obligatoire : non

ReadReplicaIdentifiers.ReadReplicaIdentifier.N

Contient un ou plusieurs identifiants des clusters secondaires associés à ce cluster.

Type : tableau de chaînes

Obligatoire : non

ReplicationSourceIdentifier

Contient l'identifiant du cluster source s'il s'agit d'un cluster secondaire.

Type : chaîne

Obligatoire : non

Status

Spécifie l'état actuel de ce cluster.

Type : chaîne

Obligatoire : non

StorageEncrypted

Indique si le cluster est chiffré.

Type : booléen

Obligatoire : non

StorageType

Type de stockage associé à votre cluster

Pour plus d'informations sur les types de stockage pour les clusters Amazon DocumentDB, consultez la section Configurations de stockage des clusters dans le manuel Amazon DocumentDB Developer Guide.

Valeurs valides pour le type de stockage - standard | iopt1

La valeur par défaut est standard

Type : chaîne

Obligatoire : non

VpcSecurityGroups.VpcSecurityGroupMembership.N

Fournit une liste des groupes de sécurité du cloud privé virtuel (VPC) auxquels appartient le cluster.

Type : tableau d’objets VpcSecurityGroupMembership

Obligatoire : non

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 :