View a markdown version of this page

UpdateCluster - Amazon MemoryDB
Sintaxis de la solicitudParámetros de la solicitudSintaxis de la respuestaElementos de respuestaErroresVéase también

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

UpdateCluster

Modifica la configuración de un clúster. Puede usar esta operación para cambiar una o más opciones de configuración del clúster especificando las configuraciones y los nuevos valores.

Sintaxis de la solicitud

{
   "ACLName": "string",
   "ClusterName": "string",
   "Description": "string",
   "Engine": "string",
   "EngineVersion": "string",
   "IpDiscovery": "string",
   "MaintenanceWindow": "string",
   "NodeType": "string",
   "ParameterGroupName": "string",
   "ReplicaConfiguration": { 
      "ReplicaCount": number
   },
   "SecurityGroupIds": [ "string" ],
   "ShardConfiguration": { 
      "ShardCount": number
   },
   "SnapshotRetentionLimit": number,
   "SnapshotWindow": "string",
   "SnsTopicArn": "string",
   "SnsTopicStatus": "string"
}

Parámetros de la solicitud

Para obtener información sobre los parámetros comunes a todas las acciones, consulte Parámetros comunes.

La solicitud acepta los siguientes datos en formato JSON.

ACLName

La lista de control de acceso que está asociada al clúster.

Tipo: cadena

Limitaciones de longitud: longitud mínima de 1.

Patrón: [a-zA-Z][a-zA-Z0-9\-]*

Obligatorio: no

ClusterName

El nombre del clúster que se va a actualizar.

Tipo: cadena

Obligatorio: sí

Description

La descripción del clúster que se va a actualizar.

Tipo: cadena

Requerido: no

Engine

El nombre del motor que se utilizará en el clúster.

Tipo: cadena

Requerido: no

EngineVersion

La versión mejorada del motor que se ejecutará en los nodos. Puede actualizar a una versión de motor más reciente, pero no puede volver a una versión de motor anterior. Si desea usar una versión anterior del motor, deberá eliminar el clúster existente y crearlo de nuevo con la versión del motor más antigua.

Tipo: cadena

Requerido: no

IpDiscovery

El mecanismo para descubrir las direcciones IP para el protocolo de detección de clústeres. Los valores válidos son «ipv4» o «ipv6». Cuando se establece en «ipv4», las funciones de detección de clústeres, como las ranuras, los fragmentos de clústeres y los nodos de clústeres, devolverán las direcciones IPv4 de los nodos del clúster. Cuando se establece en «ipv6», las funciones de detección de clústeres devuelven las direcciones IPv6 de los nodos del clúster. El valor debe ser compatible con el NetworkType parámetro. Si no se especifica, el valor predeterminado es «ipv4».

Tipo: cadena

Valores válidos: ipv4 | ipv6

Obligatorio: no

MaintenanceWindow

Especifica el intervalo de tiempo semanal durante el cual se realiza el mantenimiento en el clúster. Se especifica como un intervalo en el formato ddd:hh24:mi-ddd:hh24:mi (UTC de reloj de 24 h). La ventana de mantenimiento mínima es un periodo de 60 minutos.

Los valores válidos para ddd son:

  • sun

  • mon

  • tue

  • wed

  • thu

  • fri

  • sat

Ejemplo: sun:23:00-mon:01:30

Tipo: cadena

Requerido: no

NodeType

Un tipo de nodo válido al que desee escalar o reducir verticalmente este clúster.

Tipo: cadena

Requerido: no

ParameterGroupName

El nombre del grupo de parámetros que se va a actualizar.

Tipo: cadena

Requerido: no

ReplicaConfiguration

El número de réplicas que residirán en cada fragmento.

Tipo: objeto ReplicaConfigurationRequest

Obligatorio: no

SecurityGroupIds

El que se va SecurityGroupIds a actualizar.

Tipo: matriz de cadenas

Obligatorio: no

ShardConfiguration

El número de fragmentos del clúster.

Tipo: objeto ShardConfigurationRequest

Obligatorio: no

SnapshotRetentionLimit

El número de días durante los que MemoryDB retiene instantáneas automáticas del clúster antes de eliminarlas. Por ejemplo, si se establece SnapshotRetentionLimit en 5, una instantánea que se haya tomado hoy se conservará durante 5 días antes de eliminarse.

Tipo: entero

Obligatorio: no

SnapshotWindow

El intervalo de tiempo diario (en UTC) durante el cual MemoryDB empieza a tomar una instantánea diaria de su clúster.

Tipo: cadena

Requerido: no

SnsTopicArn

El ARN del tema de SNS que se va a actualizar.

Tipo: cadena

Requerido: no

SnsTopicStatus

El estado del tema de notificación de Amazon SNS. Las notificaciones se envían solo si el estado está activo.

Tipo: cadena

Requerido: no

Sintaxis de la respuesta

{
   "Cluster": { 
      "ACLName": "string",
      "ARN": "string",
      "AutoMinorVersionUpgrade": boolean,
      "AvailabilityMode": "string",
      "ClusterEndpoint": { 
         "Address": "string",
         "Port": number
      },
      "DataTiering": "string",
      "Description": "string",
      "Engine": "string",
      "EnginePatchVersion": "string",
      "EngineVersion": "string",
      "IpDiscovery": "string",
      "KmsKeyId": "string",
      "MaintenanceWindow": "string",
      "MultiRegionClusterName": "string",
      "Name": "string",
      "NetworkType": "string",
      "NodeType": "string",
      "NumberOfShards": number,
      "ParameterGroupName": "string",
      "ParameterGroupStatus": "string",
      "PendingUpdates": { 
         "ACLs": { 
            "ACLToApply": "string"
         },
         "Resharding": { 
            "SlotMigration": { 
               "ProgressPercentage": number
            }
         },
         "ServiceUpdates": [ 
            { 
               "ServiceUpdateName": "string",
               "Status": "string"
            }
         ]
      },
      "SecurityGroups": [ 
         { 
            "SecurityGroupId": "string",
            "Status": "string"
         }
      ],
      "Shards": [ 
         { 
            "Name": "string",
            "Nodes": [ 
               { 
                  "AvailabilityZone": "string",
                  "CreateTime": number,
                  "Endpoint": { 
                     "Address": "string",
                     "Port": number
                  },
                  "Name": "string",
                  "Status": "string"
               }
            ],
            "NumberOfNodes": number,
            "Slots": "string",
            "Status": "string"
         }
      ],
      "SnapshotRetentionLimit": number,
      "SnapshotWindow": "string",
      "SnsTopicArn": "string",
      "SnsTopicStatus": "string",
      "Status": "string",
      "SubnetGroupName": "string",
      "TLSEnabled": boolean
   }
}

Elementos de respuesta

Si la acción se realiza correctamente, el servicio devuelve una respuesta HTTP 200.

El servicio devuelve los datos siguientes en formato JSON.

Cluster

El clúster actualizado.

Tipo: objeto Cluster

Errores

Para obtener información acerca de los errores comunes a todas las acciones, consulte Tipos de errores comunes.

ACLNotFoundFault

Código de estado HTTP: 400

ClusterNotFoundFault

Código de estado HTTP: 400

ClusterQuotaForCustomerExceededFault

Código de estado HTTP: 400

InvalidACLStateFault

Código de estado HTTP: 400

InvalidClusterStateFault

Código de estado HTTP: 400

InvalidKMSKeyFault

Código de estado HTTP: 400

InvalidNodeStateFault

Código de estado HTTP: 400

InvalidParameterCombinationException

Código de estado HTTP: 400

InvalidParameterValueException

Código de estado HTTP: 400

InvalidVPCNetworkStateFault

Código de estado HTTP: 400

NodeQuotaForClusterExceededFault

Código de estado HTTP: 400

NodeQuotaForCustomerExceededFault

Código de estado HTTP: 400

NoOperationFault

Código de estado HTTP: 400

ParameterGroupNotFoundFault

Código de estado HTTP: 400

ServiceLinkedRoleNotFoundFault

Código de estado HTTP: 400

ShardsPerClusterQuotaExceededFault

Código de estado HTTP: 400

Véase también

Para obtener más información sobre el uso de esta API en uno de los AWS SDK específicos del idioma, consulte lo siguiente: