DeleteCluster - Amazon MemoryDB
リクエストの構文リクエストパラメータレスポンスの構文レスポンス要素エラーその他の参照資料

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

DeleteCluster

クラスターを削除します。また、すべての関連するノードとノードエンドポイントも削除されます。

リクエストの構文

{
   "ClusterName": "string",
   "FinalSnapshotName": "string"
}

リクエストパラメータ

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

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

ClusterName

削除するクラスターの名前

型: 文字列

必須: はい

FinalSnapshotName

ユーザーが指定する、クラスターの最終スナップショットの名前。これは、スナップショットを識別する一意の名前です。MemoryDB はスナップショットを作成し、その直後にクラスターを削除します。

タイプ: 文字列

必須: いいえ

レスポンスの構文

{
   "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 オブジェクト

エラー

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

ClusterNotFoundFault

HTTP ステータスコード：400

InvalidClusterStateFault

HTTP ステータスコード：400

InvalidParameterCombinationException

HTTP ステータスコード：400

InvalidParameterValueException

HTTP ステータスコード：400

ServiceLinkedRoleNotFoundFault

HTTP ステータスコード：400

SnapshotAlreadyExistsFault

HTTP ステータスコード：400

その他の参照資料

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