UpdateCluster - Amazon MemoryDB

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

UpdateCluster

クラスターの設定を変更します。この操作では、設定と新しい値を指定することで、1 つ以上のクラスター設定の設定内容を変更できます。

リクエストの構文

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

リクエストパラメータ

すべてのアクションに共通のパラメータの詳細については、「共通パラメータ」を参照してください。

リクエストは以下の JSON 形式のデータを受け入れます。

ACLName

クラスターに関連付けられているアクセスコントロールリスト

型: 文字列

長さの制限:最小長は 1 です。

Pattern: [a-zA-Z][a-zA-Z0-9\-]*

必須: いいえ

ClusterName

更新するクラスターの名前

型: 文字列

必須: はい

Description

更新するクラスターの説明

タイプ: 文字列

必須: いいえ

EngineVersion

ノードで実行されるエンジンのアップグレードバージョン。より新しいエンジンバージョンにアップグレードできますが、以前のエンジンバージョンにダウングレードすることはできません。以前のエンジンバージョンを使用する場合は、既存のクラスターを削除し、新たにそれを以前のエンジンバージョンで作成する必要があります。

タイプ: 文字列

必須: いいえ

MaintenanceWindow

クラスターの週次メンテナンスを実行する時間範囲を指定します。範囲は ddd:hh24:mi-ddd:hh24:mi (UTC 24 時間制) の形式で指定します。最短メンテナンス期間は 60 分です。

ddd の有効値は、次のとおりです。

  • sun

  • mon

  • tue

  • wed

  • thu

  • fri

  • sat

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

タイプ: 文字列

必須: いいえ

NodeType

このクラスターをスケールアップまたはスケールダウンする有効なノードタイプ。

タイプ: 文字列

必須: いいえ

ParameterGroupName

更新するパラメータグループの名前

タイプ: 文字列

必須: いいえ

ReplicaConfiguration

各シャードに配置するレプリカの数

タイプ:ReplicaConfigurationRequest オブジェクト

必須: いいえ

SecurityGroupIds

更新 SecurityGroupIds する

タイプ:文字列の配列

必須: いいえ

ShardConfiguration

クラスター内のシャードの数

タイプ:ShardConfigurationRequest オブジェクト

必須: いいえ

SnapshotRetentionLimit

MemoryDB によって自動クラスタースナップショットが保持される日数。この日数を超えると、自動スナップショットは削除されます。例えば、 SnapshotRetentionLimit を 5 に設定した場合、今日作成されたスナップショットは 5 日間保持され、その後削除されます。

タイプ: 整数

必須: いいえ

SnapshotWindow

MemoryDB が、クラスターの毎日のスナップショットの取得を開始する毎日の時間範囲 (UTC)。

タイプ: 文字列

必須: いいえ

SnsTopicArn

更新する SNS トピック ARN

タイプ: 文字列

必須: いいえ

SnsTopicStatus

Amazon SNS 通知トピックのステータス。通知はステータスがアクティブな場合にのみ送信されます。

タイプ: 文字列

必須: いいえ

レスポンスの構文

{ "Cluster": { "ACLName": "string", "ARN": "string", "AutoMinorVersionUpgrade": boolean, "AvailabilityMode": "string", "ClusterEndpoint": { "Address": "string", "Port": number }, "DataTiering": "string", "Description": "string", "EnginePatchVersion": "string", "EngineVersion": "string", "KmsKeyId": "string", "MaintenanceWindow": "string", "Name": "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 } }

レスポンス要素

アクションが成功すると、サービスは HTTP 200 レスポンスを返します。

サービスから以下のデータが JSON 形式で返されます。

Cluster

更新されたクラスター

型: Cluster オブジェクト

エラー

すべてのアクションに共通のエラーについては、共通エラー を参照してください。

ACLNotFoundFault

HTTP ステータスコード:400

ClusterNotFoundFault

HTTP ステータスコード:400

ClusterQuotaForCustomerExceededFault

HTTP ステータスコード:400

InvalidACLStateFault

HTTP ステータスコード:400

InvalidClusterStateFault

HTTP ステータスコード:400

InvalidKMSKeyFault

HTTP ステータスコード:400

InvalidNodeStateFault

HTTP ステータスコード:400

InvalidParameterCombinationException

HTTP ステータスコード:400

InvalidParameterValueException

HTTP ステータスコード:400

InvalidVPCNetworkStateFault

HTTP ステータスコード:400

NodeQuotaForClusterExceededFault

HTTP ステータスコード:400

NodeQuotaForCustomerExceededFault

HTTP ステータスコード:400

NoOperationFault

HTTP ステータスコード:400

ParameterGroupNotFoundFault

HTTP ステータスコード:400

ServiceLinkedRoleNotFoundFault

HTTP ステータスコード:400

ShardsPerClusterQuotaExceededFault

HTTP ステータスコード:400

その他の参照資料

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。