PHP Class Scalr\Service\Aws\Ec2\DataType\SnapshotData

Since: 30.01.2013
Author: Vitaliy Demidov ([email protected])
Inheritance: extends Scalr\Service\Aws\Ec2\AbstractEc2DataType
Datei anzeigen Open project: scalr/scalr Class Usage Examples

Public Properties

Property Type Description
$description string The description of the snapshot
$encrypted boolean Indicates whether the snapshot is encrypted.
$ownerAlias string The AWS account alias (amazon, self, etc.) or AWS account ID that owns the AMI.
$ownerId string The ID of the AWS account that owns the snapshot
$progress string The progress of the snapshot, as a percentage
$snapshotId string The ID of the snapshot.
$startTime DateTime The time stamp when the snapshot was initiated
$status string The snapshot state pending | completed | error
$volumeId string The ID of the volume.
$volumeSize string The size of the volume, in GiB.

Protected Properties

Property Type Description
$_properties array List of the public properties which is managed by magic getter and setters internally.

Public Methods

Method Description
copy ( string $srcRegion, string $description = null, string $destRegion = null, string $presignedUrl = null ) : string CopySnapshot action
createTags ( Scalr\Service\Aws\Ec2\DataType\ResourceTagSetList | Scalr\Service\Aws\Ec2\DataType\ResourceTagSetData | array $tagList ) : boolean CreateTags action
delete ( ) : boolean DeleteSnapshot action
deleteTags ( Scalr\Service\Aws\Ec2\DataType\ResourceTagSetList | Scalr\Service\Aws\Ec2\DataType\ResourceTagSetData | array $tagList ) : boolean DeleteTags action
refresh ( ) : SnapshotData DescribeSnapshots action

Protected Methods

Method Description
throwExceptionIfNotInitialized ( )

Method Details

copy() public method

Copies a point-in-time snapshot of an Amazon Elastic Block Store (Amazon EBS) volume and stores it in Amazon Simple Storage Service (Amazon S3).You can copy the snapshot within the same region or from one region to another.You can use the snapshot to create new Amazon EBS volumes or Amazon Machine Images (AMIs)
public copy ( string $srcRegion, string $description = null, string $destRegion = null, string $presignedUrl = null ) : string
$srcRegion string The ID of the AWS region that contains the snapshot to be copied.
$description string optional A description of the new Amazon EBS snapshot.
$destRegion string optional The ID of the destination region.
$presignedUrl string optional The pre-signed URL that facilitates copying an encrypted snapshot. The PresignedUrl should use the snapshot source endpoint, the CopySnapshot action, and include the SourceRegion, SourceSnapshotId, and DestinationRegion parameters.
return string Returns ID of the created snapshot on success.

createTags() public method

Adds or overwrites one or more tags for the specified EC2 resource or resources. Each resource can have a maximum of 10 tags. Each tag consists of a key and optional value. Tag keys must be unique per resource.
public createTags ( Scalr\Service\Aws\Ec2\DataType\ResourceTagSetList | Scalr\Service\Aws\Ec2\DataType\ResourceTagSetData | array $tagList ) : boolean
$tagList Scalr\Service\Aws\Ec2\DataType\ResourceTagSetList | Scalr\Service\Aws\Ec2\DataType\ResourceTagSetData | array The key/value pair list of the Tags.
return boolean Returns true on success or throws an exception otherwise

delete() public method

Deletes a snapshot of an Amazon EBS volume. Note! If you make periodic snapshots of a volume, the snapshots are incremental so that only the blocks on the device that have changed since your last snapshot are incrementally saved in the new snapshot. Even though snapshots are saved incrementally, the snapshot deletion process is designed so that you need to retain only the most recent snapshot in order to restore the volume.
public delete ( ) : boolean
return boolean Returns TRUE on success

deleteTags() public method

Deletes a specific set of tags from a specific set of resources. This call is designed to follow a DescribeTags call. You first determine what tags a resource has, and then you call DeleteTags with the resource ID and the specific tags you want to delete.
public deleteTags ( Scalr\Service\Aws\Ec2\DataType\ResourceTagSetList | Scalr\Service\Aws\Ec2\DataType\ResourceTagSetData | array $tagList ) : boolean
$tagList Scalr\Service\Aws\Ec2\DataType\ResourceTagSetList | Scalr\Service\Aws\Ec2\DataType\ResourceTagSetData | array The key/value pair list of the Tags.
return boolean Returns true on success or throws an exception otherwise

refresh() public method

Refreshes current object using API request to AWS NOTE! It refreshes object itself only when EntityManager is enabled. Decision is to use $object = object->refresh() instead;
public refresh ( ) : SnapshotData
return SnapshotData

throwExceptionIfNotInitialized() protected method

protected throwExceptionIfNotInitialized ( )

Property Details

$_properties protected_oe property

List of the public properties which is managed by magic getter and setters internally.
protected array $_properties
return array

$description public_oe property

The description of the snapshot
public string $description
return string

$encrypted public_oe property

Indicates whether the snapshot is encrypted.
public bool $encrypted
return boolean

$ownerAlias public_oe property

The AWS account alias (amazon, self, etc.) or AWS account ID that owns the AMI.
public string $ownerAlias
return string

$ownerId public_oe property

The ID of the AWS account that owns the snapshot
public string $ownerId
return string

$progress public_oe property

The progress of the snapshot, as a percentage
public string $progress
return string

$snapshotId public_oe property

The ID of the snapshot.
public string $snapshotId
return string

$startTime public_oe property

The time stamp when the snapshot was initiated
public DateTime $startTime
return DateTime

$status public_oe property

The snapshot state pending | completed | error
public string $status
return string

$volumeId public_oe property

The ID of the volume.
public string $volumeId
return string

$volumeSize public_oe property

The size of the volume, in GiB.
public string $volumeSize
return string