Data class containing detailed settings about AmazonS3 Backup Destination
name | data type | constraints | description |
---|---|---|---|
name | string | ||
nodeConfigs | array of NameAndGuid | ||
bucketName | string | ||
bucketKey | string | ||
projects | array of NameAndGuid | ||
endpointUrl | string | ||
region | string | ||
recordBackupTimeAfterStore | boolean | required | |
totalAvailableSpace | number | ||
resolveHostnameToIPBeforeConnection | boolean | required | |
totalUsedSpace | number | ||
totalDedupUsedSpace | number | ||
pathStyleAccess | boolean | required | |
totalDedupAvailableSpace | number | ||
proxyConfigurationEnabled | boolean | required | |
preAccessCmdArgs | array of string | ||
parallelDownloadEnabled | boolean | required | |
postAccessCmdArgs | array of string | ||
clientProxyConfiguration | ClientProxyConfigurationDetails | ||
preAccessCmdExecEnabled | boolean | required | |
glacierRetentionSettings | BackupRetentionSettingsDetails | ||
postAccessCmdExecEnabled | boolean | required | |
deepArchiveRetentionSettings | BackupRetentionSettingsDetails | ||
preAccessCmdExecTimeout | number | ||
postAccessCmdExecTimeout | number | ||
backupMode | AmazonS3BackupMode | ||
backupDestinationInitInfos | array of BackupDestinationInitInfoDTO | ||
initRequired | boolean | required | |
dedupEnabled | boolean | required | |
encryptionEnabled | boolean | required | |
defaultBackupDestination | boolean | required | |
description | string | ||
daysToKeepRetentionLock | number | required | |
visibleForAllVms | boolean | required | |
backupDestinationForCloud | boolean | required | |
objectTaggingEnabled | boolean | required | |
trustAllCerts | boolean | required | |
backupDestinationState | BackupDestinationState | ||
guid | string | ||
type | BackupDestinationType | ||
modificationTime | number |
Example
{ "name" : "...", "nodeConfigs" : [ { "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67", "name" : "Entity name" }, { "guid" : "...", "name" : "..." } ], "bucketName" : "...", "bucketKey" : "...", "projects" : [ { "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67", "name" : "Entity name" }, { "guid" : "...", "name" : "..." } ], "endpointUrl" : "...", "region" : "...", "recordBackupTimeAfterStore" : true, "totalAvailableSpace" : 12345, "resolveHostnameToIPBeforeConnection" : true, "totalUsedSpace" : 12345, "totalDedupUsedSpace" : 12345, "pathStyleAccess" : true, "totalDedupAvailableSpace" : 12345, "proxyConfigurationEnabled" : true, "preAccessCmdArgs" : [ "...", "..." ], "parallelDownloadEnabled" : true, "postAccessCmdArgs" : [ "...", "..." ], "clientProxyConfiguration" : { "clientProxyDomain" : "...", "clientProxyHost" : "...", "clientProxyUsername" : "...", "clientProxyPassword" : "...", "clientProxyWorkstation" : "...", "clientProxyProtocol" : "...", "clientProxyPort" : 12345, "clientProxyAuthenticationMethods" : [ "NTLM", "SPNEGO" ] }, "preAccessCmdExecEnabled" : true, "glacierRetentionSettings" : { "retentionKeepLastNFull" : 12345, "retentionKeepFullNewerThan" : 12345, "retentionKeepLastNIncremental" : 12345, "retentionKeepIncrementalNewerThan" : 12345, "keepLastBackupWhenSourceStillExists" : true }, "postAccessCmdExecEnabled" : true, "deepArchiveRetentionSettings" : { "retentionKeepLastNFull" : 12345, "retentionKeepFullNewerThan" : 12345, "retentionKeepLastNIncremental" : 12345, "retentionKeepIncrementalNewerThan" : 12345, "keepLastBackupWhenSourceStillExists" : true }, "preAccessCmdExecTimeout" : 12345, "postAccessCmdExecTimeout" : 12345, "backupMode" : { "name" : "ENUM_NAME", "description" : "Enum description" }, "backupDestinationInitInfos" : [ { "node" : { "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67", "name" : "Entity name" }, "backupDestination" : { "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67", "name" : "Entity name" }, "initSuccessful" : true, "initError" : "...", "modificationTime" : 12345 }, { "node" : { "guid" : "...", "name" : "..." }, "backupDestination" : { "guid" : "...", "name" : "..." }, "initSuccessful" : true, "initError" : "...", "modificationTime" : 12345 } ], "initRequired" : true, "dedupEnabled" : true, "encryptionEnabled" : true, "defaultBackupDestination" : true, "description" : "...", "daysToKeepRetentionLock" : 12345, "visibleForAllVms" : true, "backupDestinationForCloud" : true, "objectTaggingEnabled" : true, "trustAllCerts" : true, "backupDestinationState" : "INITIALIZING", "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67", "type" : { "name" : "ENUM_NAME", "description" : "Enum description" }, "modificationTime" : 1451649601000 }