PHP 클래스 Scalr\Service\Aws\Ec2\DataType\VolumeData

부터: 21.01.2013

저자: Vitaliy Demidov ([email protected])

상속: extends Scalr\Service\Aws\Ec2\AbstractEc2DataType

공개 프로퍼티들

프로퍼티	타입	설명
$availabilityZone	string	The Availability Zone in which the volume was created.
$createTime	DateTime	The time stamp when volume creation was initiated.
$encrypted	boolean	Specifies whether the volume should be encrypted.
$iops	integer	Valid values: Range is 100 to 2000. Condition: Required when the volume type is io1; not used with standard volumes.
$kmsKeyId	string	The full ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the volume encryption key for the volume.
$size	string	The size of the volume, in GiBs.
$snapshotId	string	The snapshot from which the volume was created (optional).
$status	string	Valid values: creating \| available \| in-use \| deleting \| deleted \| error
$volumeId	string	The ID of the volume.
$volumeType	string	The volume type standard \| io1 \| gp2 \| sc1 \| st1

보호된 프로퍼티들

프로퍼티	타입	설명
$_properties	array	List of the public properties which is managed by magic getter and setters internally.

공개 메소드들

메소드	설명
attach ( string $instanceId, string $device ) : AttachmentSetResponseData	AttachVolume action
createSnapshot ( string $description = null ) : SnapshotData	CreateSnapshot action
createTags ( Scalr\Service\Aws\Ec2\DataType\ResourceTagSetList \| Scalr\Service\Aws\Ec2\DataType\ResourceTagSetData \| array $tagList ) : boolean	CreateTags action
delete ( ) : boolean	DeleteVolume action
deleteTags ( Scalr\Service\Aws\Ec2\DataType\ResourceTagSetList \| Scalr\Service\Aws\Ec2\DataType\ResourceTagSetData \| array $tagList ) : boolean	DeleteTags action
detach ( string $instanceId = null, string $device = null, boolean $force = null ) : AttachmentSetResponseData	DetachVolume action
refresh ( ) : VolumeData	DescribeVolumes action

보호된 메소드들

메소드	설명
throwExceptionIfNotInitialized ( )

메소드 상세

attach() 공개 메소드

Attaches an Amazon EBS volume to a running instance and exposes it to the instance with the specified device name. For a list of supported device names, see Attaching the Volume to an Instance. Any device names that aren't reserved for instance store volumes can be used for Amazon EBS volumes. Note! If a volume has an AWS Marketplace product code: -The volume can only be attached to the root device of a stopped instance. -You must be subscribed to the AWS Marketplace code that is on the volume. -The configuration (instance type, operating system) of the instance must support that specific AWS Marketplace code. For example, you cannot take a volume from a Windows instance and attach it to a Linux instance. -AWS Marketplace product codes are copied from the volume to the instance.

public attach ( string $instanceId, string $device ) : AttachmentSetResponseData
$instanceId	string	The ID of the Instance. The instance must be running.
$device	string	The device name as exposed to the instance
리턴	AttachmentSetResponseData	Returns AttachmentSetResponseData on success

createSnapshot() 공개 메소드

Creates a snapshot of an Amazon EBS volume and stores it in Amazon S3.You can use snapshots for backups, to make copies of instance store volumes, and to save data before shutting down an instance.

public createSnapshot ( string $description = null ) : SnapshotData
$description	string	optional A description of the Amazon EBS snapshot. (Up to 255 characters)
리턴	SnapshotData	Returns the SnapshotData on success

createTags() 공개 메소드

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.
리턴	boolean	Returns true on success or throws an exception otherwise

delete() 공개 메소드

Deletes an Amazon EBS volume. The volume must be in the available state (not attached to an instance)

public delete ( ) : boolean
리턴	boolean	Returns true on success or throws an exception otherwise

deleteTags() 공개 메소드

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.
리턴	boolean	Returns true on success or throws an exception otherwise

detach() 공개 메소드

Detaches an Amazon EBS volume from an instance. Make sure to unmount any file systems on the device within your operating system before detaching the volume. Failure to do so will result in volume being stuck in "busy" state while detaching. Note! If an Amazon EBS volume is the root device of an instance, it cannot be detached while the instance is in the "running" state. To detach the root volume, stop the instance first. If the root volume is detached from an instance with an AWS Marketplace product code, then the AWS Marketplace product codes from that volume are no longer associated with the instance.

public detach ( string $instanceId = null, string $device = null, boolean $force = null ) : AttachmentSetResponseData
$instanceId	string	optional The ID of the Instance.
$device	string	optional The device name.
$force	boolean	optional Forces detachment if the previous detachment attempt did not occur cleanly (logging into an instance, unmounting the volume, and detaching normally). This option can lead to data loss or a corrupted file system. Use this option only as a last resort to detach a volume from a failed instance. The instance won't have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures.
리턴	AttachmentSetResponseData	Returns AttachmentSetResponseData on success

refresh() 공개 메소드

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

public refresh ( ) : VolumeData
리턴	VolumeData

throwExceptionIfNotInitialized() 보호된 메소드

protected throwExceptionIfNotInitialized ( )

프로퍼티 상세

$_properties 보호되어 있는 프로퍼티

List of the public properties which is managed by magic getter and setters internally.

protected array $_properties
리턴	array

$availabilityZone 공개적으로 프로퍼티

The Availability Zone in which the volume was created.

public string $availabilityZone
리턴	string

$createTime 공개적으로 프로퍼티

The time stamp when volume creation was initiated.

public DateTime $createTime
리턴	DateTime

$encrypted 공개적으로 프로퍼티

Specifies whether the volume should be encrypted.

public bool $encrypted
리턴	boolean

$iops 공개적으로 프로퍼티

Valid values: Range is 100 to 2000. Condition: Required when the volume type is io1; not used with standard volumes.

public int $iops
리턴	integer

$kmsKeyId 공개적으로 프로퍼티

The full ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the volume encryption key for the volume.

public string $kmsKeyId
리턴	string

$size 공개적으로 프로퍼티

The size of the volume, in GiBs.

public string $size
리턴	string

$snapshotId 공개적으로 프로퍼티

The snapshot from which the volume was created (optional).

public string $snapshotId
리턴	string

$status 공개적으로 프로퍼티

public string $status
리턴	string

$volumeId 공개적으로 프로퍼티

The ID of the volume.

public string $volumeId
리턴	string

$volumeType 공개적으로 프로퍼티

The volume type standard | io1 | gp2 | sc1 | st1

public string $volumeType
리턴	string