Options
All
  • Public
  • Public/Protected
  • All
Menu

Module BootVolumeBackup

A point-in-time copy of a boot volume that can then be used to create a new boot volume or recover a boot volume. For more information, see Overview of Boot Volume Backups To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.

*Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Properties

Optional bootVolumeId

bootVolumeId: undefined | string

The OCID of the boot volume.

compartmentId

compartmentId: string

The OCID of the compartment that contains the boot volume backup.

Optional definedTags

definedTags: undefined | object

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`

displayName

displayName: string

A user-friendly name for the boot volume backup. Does not have to be unique and it's changeable. Avoid entering confidential information.

Optional expirationTime

expirationTime: Date

The date and time the volume backup will expire and be automatically deleted. Format defined by RFC3339. This parameter will always be present for backups that were created automatically by a scheduled-backup policy. For manually created backups, it will be absent, signifying that there is no expiration time and the backup will last forever until manually deleted.

Optional freeformTags

freeformTags: undefined | object

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

Example: `{\"Department\": \"Finance\"}`

id

id: string

The OCID of the boot volume backup.

Optional imageId

imageId: undefined | string

The image OCID used to create the boot volume the backup is taken from.

Optional kmsKeyId

kmsKeyId: undefined | string

The OCID of the Key Management master encryption assigned to the boot volume backup. For more information about the Key Management service and encryption keys, see Overview of Key Management and Using Keys.

lifecycleState

lifecycleState: LifecycleState

The current state of a boot volume backup.

Optional sizeInGBs

sizeInGBs: undefined | number

The size of the boot volume, in GBs.

Optional sourceBootVolumeBackupId

sourceBootVolumeBackupId: undefined | string

The OCID of the source boot volume backup.

Optional sourceType

sourceType: SourceType

Specifies whether the backup was created manually, or via scheduled backup policy.

Optional systemTags

systemTags: undefined | object

System tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}

timeCreated

timeCreated: Date

The date and time the boot volume backup was created. This is the time the actual point-in-time image of the volume data was taken. Format defined by RFC3339.

Optional timeRequestReceived

timeRequestReceived: Date

The date and time the request to create the boot volume backup was received. Format defined by RFC3339.

Optional type

type: Type

The type of a volume backup.

Optional uniqueSizeInGBs

uniqueSizeInGBs: undefined | number

The size used by the backup, in GBs. It is typically smaller than sizeInGBs, depending on the space consumed on the boot volume and whether the backup is full or incremental.

Functions

getJsonObj