Cluster
Devuelve información sobre un clúster elástico específico.
Contenido
nota
Los parámetros obligatorios se describen primero en la siguiente tabla.
- adminUserName
-
El nombre del administrador de los clústeres elásticos.
Tipo: cadena
Obligatorio: sí
- authType
-
El tipo de autenticación del clúster elástico.
Tipo: cadena
Valores válidos:
PLAIN_TEXT | SECRET_ARNObligatorio: sí
- clusterArn
-
El identificador ARN del clúster elástico.
Tipo: cadena
Obligatorio: sí
- clusterEndpoint
-
La URL que se usa para conectarse al clúster elástico.
Tipo: cadena
Obligatorio: sí
- clusterName
-
El nombre del clúster elástico.
Tipo: cadena
Obligatorio: sí
- createTime
-
La hora a la que se creó el clúster elástico, en tiempo universal coordinado (UTC).
Tipo: cadena
Obligatorio: sí
- kmsKeyId
-
El identificador de clave de KMS que se debe utilizar para cifrar el clúster elástico.
Tipo: cadena
Obligatorio: sí
- preferredMaintenanceWindow
-
El intervalo de tiempo semanal durante el cual puede llevarse a cabo el mantenimiento del sistema, en tiempo universal coordinado (UTC).
Formato:
ddd:hh24:mi-ddd:hh24:miTipo: cadena
Obligatorio: sí
- shardCapacity
-
La cantidad de vCPU asignadas a cada partición de clúster elástico. El máximo es 64. Los valores permitidos son 2, 4, 8, 16, 32, 64.
Tipo: entero
Obligatorio: sí
- shardCount
-
El número de particiones asignadas al clúster elástico. El máximo es 32.
Tipo: entero
Obligatorio: sí
- status
-
Estado del clúster elástico.
Tipo: cadena
Valores válidos:
CREATING | ACTIVE | DELETING | UPDATING | VPC_ENDPOINT_LIMIT_EXCEEDED | IP_ADDRESS_LIMIT_EXCEEDED | INVALID_SECURITY_GROUP_ID | INVALID_SUBNET_ID | INACCESSIBLE_ENCRYPTION_CREDS | INACCESSIBLE_SECRET_ARN | INACCESSIBLE_VPC_ENDPOINT | INCOMPATIBLE_NETWORK | MERGING | MODIFYING | SPLITTING | COPYING | STARTING | STOPPING | STOPPEDObligatorio: sí
- subnetIds
-
Los ID de subredes de Amazon EC2 para el clúster elástico.
Tipo: matriz de cadenas
Obligatorio: sí
- vpcSecurityGroupIds
-
Una lista de grupos de seguridad de VPC de EC2 para asociar a este clúster elástico.
Tipo: matriz de cadenas
Obligatorio: sí
- backupRetentionPeriod
-
El número de días durante los que se conservan las instantáneas de base de datos automáticas.
Tipo: entero
Requerido: no
- preferredBackupWindow
-
El intervalo de tiempo diario durante el que se crean las copias de seguridad automatizadas si las copias de seguridad automatizadas están habilitadas según lo determina
backupRetentionPeriod.Tipo: cadena
Requerido: no
- shardInstanceCount
-
El número de instancias de réplica que se aplica a todas las particiones del clúster. Un valor de
shardInstanceCountigual a 1 significa que hay una instancia de escritura y las instancias adicionales son réplicas que se pueden usar para llevar a cabo lecturas y mejorar la disponibilidad.Tipo: entero
Requerido: no
- shards
-
El número total de particiones en el clúster.
Tipo: matriz de objetos Shard
Requerido: no
Véase también
Para obtener más información sobre el uso de esta API en un SDK de AWS de un idioma específico, consulte:
