AmazonS3BackupDestinationRequest Data Type

Data class for creating AmazonS3 Backup Destination

Properties
name data type constraints description
name string required, max size: 255, min size: 1
preAccessCmdArgs array of string max size: 255, min size: 0
postAccessCmdArgs array of string max size: 255, min size: 0
projects array of NameAndGuid required
nodeConfigs array of NameAndGuid  
preAccessCmdExecEnabled boolean required
postAccessCmdExecEnabled boolean required
preAccessCmdExecTimeout number max: 86400000, min: 1000
postAccessCmdExecTimeout number max: 86400000, min: 1000
dedupEnabled boolean required
bucketName string max size: 255, min size: 0
encryptionEnabled boolean required
bucketKey string max size: 255, min size: 0
visibleForAllVms boolean required
defaultBackupDestination boolean required
endpointUrl string max size: 255, min size: 0
backupDestinationForCloud boolean required
region string  
description string max size: 4095, min size: 0
recordBackupTimeAfterStore boolean required
resolveHostnameToIPBeforeConnection boolean required
initInfo BackupDestinationInitInfoDTO  
daysToKeepRetentionLock number required, max: 3652, min: 0
pathStyleAccess boolean required
proxyConfigurationEnabled boolean required
parallelDownloadEnabled boolean required
objectTaggingEnabled boolean required
clientProxyConfiguration ClientProxyConfigurationRequest  
glacierRetentionSettings BackupRetentionSettingsRequest  
deepArchiveRetentionSettings BackupRetentionSettingsRequest  
backupMode AmazonS3BackupMode required

Example

{
  "name" : "...",
  "preAccessCmdArgs" : [ "...", "..." ],
  "postAccessCmdArgs" : [ "...", "..." ],
  "projects" : [ {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  }, {
    "guid" : "...",
    "name" : "..."
  } ],
  "nodeConfigs" : [ {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  }, {
    "guid" : "...",
    "name" : "..."
  } ],
  "preAccessCmdExecEnabled" : true,
  "postAccessCmdExecEnabled" : true,
  "preAccessCmdExecTimeout" : 12345,
  "postAccessCmdExecTimeout" : 12345,
  "dedupEnabled" : true,
  "bucketName" : "...",
  "encryptionEnabled" : true,
  "bucketKey" : "...",
  "visibleForAllVms" : true,
  "defaultBackupDestination" : true,
  "endpointUrl" : "...",
  "backupDestinationForCloud" : true,
  "region" : "...",
  "description" : "...",
  "recordBackupTimeAfterStore" : true,
  "resolveHostnameToIPBeforeConnection" : true,
  "initInfo" : {
    "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
  },
  "daysToKeepRetentionLock" : 12345,
  "pathStyleAccess" : true,
  "proxyConfigurationEnabled" : true,
  "parallelDownloadEnabled" : true,
  "objectTaggingEnabled" : true,
  "clientProxyConfiguration" : {
    "clientProxyDomain" : "...",
    "clientProxyHost" : "...",
    "clientProxyUsername" : "...",
    "clientProxyPassword" : "...",
    "clientProxyWorkstation" : "...",
    "clientProxyProtocol" : "...",
    "clientProxyPort" : 12345,
    "clientProxyAuthenticationMethods" : [ "BASIC", "KERBEROS" ]
  },
  "glacierRetentionSettings" : {
    "retentionKeepLastNFull" : 12345,
    "retentionKeepFullNewerThan" : 12345,
    "retentionKeepLastNIncremental" : 12345,
    "retentionKeepIncrementalNewerThan" : 12345,
    "keepLastBackupWhenSourceStillExists" : true
  },
  "deepArchiveRetentionSettings" : {
    "retentionKeepLastNFull" : 12345,
    "retentionKeepFullNewerThan" : 12345,
    "retentionKeepLastNIncremental" : 12345,
    "retentionKeepIncrementalNewerThan" : 12345,
    "keepLastBackupWhenSourceStillExists" : true
  },
  "backupMode" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  }
}