ClusterSnapshot - Amazon DocumentDB

本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。

ClusterSnapshot

傳回特定彈性叢集快照的相關資訊。

目錄

注意

在下列清單中,會先說明所需的參數。

adminUserName

彈性叢集管理員的名稱。

類型:字串

必要:是

clusterArn

彈性叢集的ARN識別碼。

類型:字串

必要:是

clusterCreationTime

彈性叢集在 Universal Coordinated Time () 中建立的時間UTC。

類型:字串

必要:是

kmsKeyId

KMS 金鑰識別符是KMS加密金鑰的 Amazon Resource Name (ARN)。如果您要使用擁有此KMS加密金鑰的相同 Amazon 帳戶建立叢集,您可以使用KMS金鑰別名,而不是 ARN作為KMS加密金鑰。如果此處未指定加密金鑰,Amazon DocumentDB 會使用為您的帳戶KMS建立的預設加密金鑰。您的帳戶在每個 Amazon 區域都有不同的預設加密金鑰。

類型:字串

必要:是

snapshotArn

彈性叢集快照的ARN識別符。

類型:字串

必要:是

snapshotCreationTime

在通用協調時間 () 中建立彈性叢集快照的時間UTC。

類型:字串

必要:是

snapshotName

彈性叢集快照的名稱。

類型:字串

必要:是

status

彈性叢集快照的狀態。

類型:字串

有效值: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 | STOPPED | MAINTENANCE | INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE

必要:是

subnetIds

彈性叢集IDs的 Amazon EC2子網路。

類型:字串陣列

必要:是

vpcSecurityGroupIds

要與彈性叢集建立關聯的EC2VPC安全群組清單。

類型:字串陣列

必要:是

snapshotType

要傳回的叢集快照類型。您可以指定下列其中一個值:

  • automated - 傳回 Amazon DocumentDB 為 AWS 您的帳戶自動建立的所有叢集快照。

  • manual - 傳回您為 AWS 帳戶手動建立的所有叢集快照。

類型:字串

有效值:MANUAL | AUTOMATED

必要:否

另請參閱

如需在其中一種語言特定的 API中使用此功能的詳細資訊 AWS SDKs,請參閱下列內容: