PHP Class Scalr\Service\Aws\Ec2\V20140615\Ec2Api

Implements Ec2 Low-Level API Actions.
Since: 5.0.0
Author: Vlad Dobrovolskiy ([email protected])
Inheritance: extends Scalr\Service\Aws\AbstractApi
Show file Open project: scalr/scalr

Protected Properties

Property Type Description
$ec2 Scalr\Service\Aws\Ec2
$versiondate string

Public Methods

Method Description
__construct ( Ec2 $ec2, Scalr\Service\Aws\Client\ClientInterface $client ) Constructor
allocateAddress ( string $domain = null ) : Scalr\Service\Aws\Ec2\DataType\AddressData AllocateAddress action
associateAddress ( Scalr\Service\Aws\Ec2\DataType\AssociateAddressRequestData $request ) : boolean | string AssociateAddress action
associateRouteTable ( string $routeTableId, string $subnetId ) : string AssociateRouteTable action
attachInternetGateway ( string $internetGatewayId, string $vpcId ) : boolean AttachInternetGateway action
attachNetworkInterface ( string $networkInterfaceId, string $instanceId, integer $deviceIndex ) : string AttachNetworkInterface action
attachVolume ( string $volumeId, string $instanceId, string $device ) : AttachmentSetResponseData AttachVolume action
authorizeSecurityGroupEgress ( Scalr\Service\Aws\Ec2\DataType\IpPermissionList $ipPermissions, string $groupId ) : boolean AuthorizeSecurityGroupEgress action
authorizeSecurityGroupIngress ( Scalr\Service\Aws\Ec2\DataType\IpPermissionList $ipPermissions, string $groupId = null, string $groupName = null ) : boolean AuthorizeSecurityGroupIngress action
copyImage ( string $srcRegion, string $srcImageId, string $name = null, string $description = null, string $clientToken = null, string $destRegion = null ) : string CopyImage action
copySnapshot ( string $srcRegion, string $srcSnapshotId, string $description = null, string $destRegion = null, string $presignedUrl = null ) : string CopySnapshot action
createImage ( Scalr\Service\Aws\Ec2\DataType\CreateImageRequestData $request ) : string CreateImage action
createInternetGateway ( ) : Scalr\Service\Aws\Ec2\DataType\InternetGatewayData CreateInternetGateway action
createKeyPair ( string $keyName ) : Scalr\Service\Aws\Ec2\DataType\KeyPairData CreateKeyPair action
createNetworkInterface ( Scalr\Service\Aws\Ec2\DataType\CreateNetworkInterfaceRequestData $request ) : Scalr\Service\Aws\Ec2\DataType\NetworkInterfaceData CreateNetworkInterface action
createPlacementGroup ( string $groupName, string $strategy = 'cluster' ) : boolean CreatePlacementGroup action
createRoute ( string $routeTableId, string $destinationCidrBlock, string $gatewayId = null, string $instanceId = null, string $networkInterfaceId = null, string $vpcPeeringConnectionId = null ) : boolean CreateRoute action
createRouteTable ( string $vpcId ) : Scalr\Service\Aws\Ec2\DataType\RouteTableData CreateRouteTable action
createSecurityGroup ( string $groupName, string $groupDescription, string $vpcId = null ) : string CreateSecurityGroup action
createSnapshot ( string $volumeId, string $description = null ) : SnapshotData CreateSnapshot action
createSubnet ( string $vpcId, string $cidrBlock, string $availabilityZone = null ) : Scalr\Service\Aws\Ec2\DataType\SubnetData CreateSubnet action
createTags ( ListDataType $resourceIdList, Scalr\Service\Aws\Ec2\DataType\ResourceTagSetList $tagList ) : boolean CreateTags action
createVolume ( CreateVolumeRequestData $request ) : VolumeData CreateVolume action
createVpc ( string $cidrBlock, string $instanceTenancy = null ) : Scalr\Service\Aws\Ec2\DataType\VpcData CreateVpc action
deleteInternetGateway ( string $internetGatewayId ) : boolean DeleteInternetGateway action
deleteKeyPair ( string $keyName ) : boolean DeleteKeyPair action
deleteNetworkInterface ( string $networkInterfaceId ) : boolean DeleteNetworkInterface action
deletePlacementGroup ( string $groupName ) : boolean DeletePlacementGroup action
deleteRoute ( string $routeTableId, string $destinationCidrBlock ) : boolean DeleteRoute action
deleteRouteTable ( string $routeTableId ) : boolean DeleteRouteTable action
deleteSecurityGroup ( string $groupId = null, string $groupName = null ) : boolean DeleteSecurityGroup action
deleteSnapshot ( string $snapshotId ) : boolean DeleteSnapshot action
deleteSubnet ( string $subnetId ) : boolean DeleteSubnet action
deleteTags ( ListDataType $resourceIdList, Scalr\Service\Aws\Ec2\DataType\ResourceTagSetList $tagList ) : boolean DeleteTags action
deleteVolume ( string $volumeId ) : boolean DeleteVolume action
deleteVpc ( string $vpcId ) : boolean DeleteVpc action
deregisterImage ( string $imageId ) : boolean DeregisterImage action
describeAccountAttributes ( ListDataType $attributeName ) : Scalr\Service\Aws\Ec2\DataType\AccountAttributeSetList DescribeAccountAttributes
describeAddresses ( ListDataType $publicIpList = null, ListDataType $allocationIdList = null, Scalr\Service\Aws\Ec2\DataType\AddressFilterList $filter = null ) : Scalr\Service\Aws\Ec2\DataType\AddressList DescribeAddresses action
describeAvailabilityZones ( ListDataType $zoneName = null, Scalr\Service\Aws\Ec2\DataType\AvailabilityZoneFilterList $filter = null ) : Scalr\Service\Aws\Ec2\DataType\AvailabilityZoneList DescribeAvailabilityZones action
describeImages ( ListDataType $imageIdList = null, ListDataType $ownerList = null, Scalr\Service\Aws\Ec2\DataType\ImageFilterList $filter = null, ListDataType $executableByList = null ) : Scalr\Service\Aws\Ec2\DataType\ImageList DescribeImages action
describeInstanceAttribute ( string $instanceId, Scalr\Service\Aws\Ec2\DataType\InstanceAttributeType $attribute ) : mixed DescribeInstanceAttribute action
describeInstanceStatus ( ListDataType $instanceIdList = null, boolean $includeAllInstances = null, Scalr\Service\Aws\Ec2\DataType\InstanceStatusFilterList $filter = null, string $nextToken = null, integer $maxResults = null ) : Scalr\Service\Aws\Ec2\DataType\InstanceStatusList DescribeInstanceStatus action
describeInstances ( ListDataType $instanceIdList = null, Scalr\Service\Aws\Ec2\DataType\InstanceFilterList $filter = null, string $nextToken = null, integer $maxResults = null ) : Scalr\Service\Aws\Ec2\DataType\ReservationList DescribeInstances action
describeInternetGateways ( ListDataType $internetGatewayIdList = null, Scalr\Service\Aws\Ec2\DataType\InternetGatewayFilterList $filter = null ) : Scalr\Service\Aws\Ec2\DataType\InternetGatewayList DescribeInternetGateways
describeKeyPairs ( ListDataType $keyNameList = null, array $filter = null ) : Scalr\Service\Aws\Ec2\DataType\KeyPairList DescribeKeyPairs action
describeNetworkInterfaceAttribute ( string $networkInterfaceId, Scalr\Service\Aws\Ec2\DataType\NetworkInterfaceAttributeType $attribute ) : mixed DescribeNetworkInterfaceAttribute action
describeNetworkInterfaces ( ListDataType $networkInterfaceIdList = null, Scalr\Service\Aws\Ec2\DataType\NetworkInterfaceFilterList $filter = null ) : Scalr\Service\Aws\Ec2\DataType\NetworkInterfaceList DescribeNetworkInterfaces action
describePlacementGroups ( ListDataType $groupNameList = null, Scalr\Service\Aws\Ec2\DataType\PlacementGroupFilterList $filter = null ) : Scalr\Service\Aws\Ec2\DataType\PlacementGroupList DescribePlacementGroups action
describeRegions ( ) : Scalr\Service\Aws\Ec2\DataType\RegionInfoList DescribeRegions action
describeReservedInstances ( ListDataType $reservedInstanceIdList = null, Scalr\Service\Aws\Ec2\DataType\ReservedInstanceFilterList $filter = null, Scalr\Service\Aws\Ec2\DataType\OfferingType $offefingType = null ) : Scalr\Service\Aws\Ec2\DataType\ReservedInstanceList DescribeReservedInstances action
describeRouteTables ( ListDataType $routeTableIdList = null, Scalr\Service\Aws\Ec2\DataType\RouteTableFilterList $filter = null ) : Scalr\Service\Aws\Ec2\DataType\RouteTableList DescribeRouteTables action
describeSecurityGroups ( ListDataType $groupName = null, ListDataType $groupId = null, Scalr\Service\Aws\Ec2\DataType\SecurityGroupFilterList $filter = null ) : Scalr\Service\Aws\Ec2\DataType\SecurityGroupList DescribeSecurityGroups action
describeSnapshots ( ListDataType $snapshotIdList = null, ListDataType $ownerList = null, Scalr\Service\Aws\Ec2\DataType\SnapshotFilterList $filter = null, ListDataType $restorableByList = null ) : Scalr\Service\Aws\Ec2\DataType\SnapshotList DescribeSnapshots action
describeSubnets ( ListDataType $subnetIdList = null, Scalr\Service\Aws\Ec2\DataType\SubnetFilterList $filter = null ) : Scalr\Service\Aws\Ec2\DataType\SubnetList DescribeSubnets action
describeVolumes ( ListDataType $volumeIdList = null, Scalr\Service\Aws\Ec2\DataType\VolumeFilterList $filter = null ) : Scalr\Service\Aws\Ec2\DataType\VolumeList DescribeVolumes action
describeVpcs ( ListDataType $vpcIdList = null, Scalr\Service\Aws\Ec2\DataType\VpcFilterList $filter = null ) : Scalr\Service\Aws\Ec2\DataType\VpcList DescribeVpcs action
detachInternetGateway ( string $internetGatewayId, string $vpcId ) : boolean DetachInternetGateway action
detachNetworkInterface ( string $attachmentId, boolean $force = null ) : boolean DetachNetworkInterface
detachVolume ( string $volumeId, string $instanceId = null, string $device = null, boolean $force = null ) : AttachmentSetResponseData DetachVolume action
disassociateAddress ( string $publicIp = null, string $associationId = null ) : boolean DisassociateAddress action
disassociateRouteTable ( string $associationId ) : boolean DisassociateRouteTable action
getConsoleOutput ( string $instanceId ) : GetConsoleOutputResponseData GetConsoleOutput action
getEntityManager ( ) : Scalr\Service\Aws\EntityManager Gets an entity manager
getInstanceIdListQuery ( ListDataType $instanceIdList, string $name = 'InstanceId' ) : array Type cast the list of the InstanceId into accepted state.
getPasswordData ( string $instanceId ) : GetPasswordDataResponseData GetPasswordData action
modifyInstanceAttribute ( string $instanceId, Scalr\Service\Aws\Ec2\DataType\InstanceAttributeType $attribute, mixed $value ) : boolean ModifyInstanceAttribute action
modifyNetworkInterfaceAttribute ( string $networkInterfaceId, Scalr\Service\Aws\Ec2\DataType\NetworkInterfaceAttributeType $attr, mixed $value ) : boolean ModifyNetworkInterfaceAttribute action
monitorInstances ( ListDataType $instanceIdList ) : Scalr\Service\Aws\Ec2\DataType\MonitorInstancesResponseSetList MonitorInstances action
rebootInstances ( ListDataType $instanceIdList ) : boolean RebootInstances action
registerImage ( Scalr\Service\Aws\Ec2\DataType\RegisterImageData $request ) : string RegisterImage action
releaseAddress ( string $publicIp = null, string $allocationId = null ) : boolean ReleaseAddress action
replaceRoute ( string $routeTableId, string $destinationCidrBlock, string $gatewayId = null, string $instanceId = null, string $networkInterfaceId = null, string $vpcPeeringConnectionId = null ) : boolean ReplaceRoute action
replaceRouteTableAssociation ( string $routeTableId, string $associationId ) : string ReplaceRouteTableAssociation action
resetNetworkInterfaceAttribute ( string $networkInterfaceId, Scalr\Service\Aws\Ec2\DataType\NetworkInterfaceAttributeType $attr ) : boolean ResetNetworkInterfaceAttribute action
revokeSecurityGroupEgress ( Scalr\Service\Aws\Ec2\DataType\IpPermissionList $ipPermissions, string $groupId ) : boolean RevokeSecurityGroupEgress action
revokeSecurityGroupIngress ( Scalr\Service\Aws\Ec2\DataType\IpPermissionList $ipPermissions, string $groupId = null, string $groupName = null ) : boolean RevokeSecurityGroupIngress action
runInstances ( Scalr\Service\Aws\Ec2\DataType\RunInstancesRequestData $request ) : Scalr\Service\Aws\Ec2\DataType\ReservationData RunInstances action
startInstances ( ListDataType $instanceIdList ) : Scalr\Service\Aws\Ec2\DataType\InstanceStateChangeList StartInstances action
stopInstances ( ListDataType $instanceIdList, boolean $force = null ) : Scalr\Service\Aws\Ec2\DataType\InstanceStateChangeList StopInstances action
terminateInstances ( ListDataType $instanceIdList ) : Scalr\Service\Aws\Ec2\DataType\InstanceStateChangeList TerminateInstances
unmonitorInstances ( ListDataType $instanceIdList ) : Scalr\Service\Aws\Ec2\DataType\MonitorInstancesResponseSetList UnmonitorInstances action

Protected Methods

Method Description
_loadAttachmentSetResponseList ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Ec2\DataType\AttachmentSetResponseList Loads AttachmentSetResponseList from simple xml object
_loadBlockDeviceMappingList ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Ec2\DataType\BlockDeviceMappingList Loads BlockDeviceMappingList from simple xml object
_loadEbsBlockDeviceData ( SimpleXMLElement $sxml ) : EbsBlockDeviceData Loads EbsBlockDeviceData from simple xml object
_loadEbsInstanceBlockDeviceMappingResponseData ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Ec2\DataType\EbsInstanceBlockDeviceMappingResponseData Loads EbsInstanceBlockDeviceMappingResponseData from simple xml object
_loadGroupList ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Ec2\DataType\GroupList Loads GroupList from simple xml object
_loadIamInstanceProfileResponseData ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Ec2\DataType\IamInstanceProfileResponseData Loads IamInstanceProfileResponseData from simple xml object
_loadInstanceBlockDeviceMappingResponseList ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Ec2\DataType\InstanceBlockDeviceMappingResponseList Loads InstanceBlockDeviceMappingResponseList from simple xml object
_loadInstanceList ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Ec2\DataType\InstanceList Loads InstanceList from simple xml object
_loadInstanceMonitoringStateData ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Ec2\DataType\InstanceMonitoringStateData Loads InstanceMonitoringStateData from simple xml object
_loadInstanceNetworkInterfaceAssociationData ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Ec2\DataType\InstanceNetworkInterfaceAssociationData Loads InstanceNetworkInterfaceAssociationData from simple xml object
_loadInstanceNetworkInterfaceAttachmentData ( SimpleXMLElement $sxml ) : InstanceNetworkInterfaceAttachmentData Loads InstanceNetworkInterfaceAttachmentData from simple xml object
_loadInstanceNetworkInterfaceSetData ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Ec2\DataType\InstanceNetworkInterfaceSetData Loads InstanceNetworkInterfaceSetData from simple xml object
_loadInstanceNetworkInterfaceSetList ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Ec2\DataType\InstanceNetworkInterfaceSetList Loads InstanceNetworkInterfaceSetList from simple xml object
_loadInstancePrivateIpAddressesSetList ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Ec2\DataType\InstancePrivateIpAddressesSetList Loads InstancePrivateIpAddressesSetList from simple xml object
_loadInstanceStateChangeData ( SimpleXMLElement $v ) : Scalr\Service\Aws\Ec2\DataType\InstanceStateChangeData Loads InstanceStateChangeData from simple xml object
_loadInstanceStateData ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Ec2\DataType\InstanceStateData Loads InstanceStateData from simple xml object
_loadInstanceStatusDetailsSetList ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Ec2\DataType\InstanceStatusDetailsSetList Loads InstanceStatusDetailsSetList from simple xml object
_loadInstanceStatusEventTypeData ( SimpleXMLElement $sxml ) : InstanceStatusEventTypeData Loads InstanceStatusEventTypeData from simple xml object
_loadInstanceStatusTypeData ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Ec2\DataType\InstanceStatusTypeData Loads InstanceStatusTypeData from simple xml object
_loadInternetGatewayAttachmentData ( SimpleXMLElement $v ) : Scalr\Service\Aws\Ec2\DataType\InternetGatewayAttachmentData Loads InternetGatewayAttachmentData from simple xml object
_loadInternetGatewayAttachmentList ( SimpleXMLElement $sxml, string $internetGatewayId = null ) : Scalr\Service\Aws\Ec2\DataType\InternetGatewayAttachmentList Loads InternetGatewayAttachmentList from simple xml object
_loadInternetGatewayData ( SimpleXMLElement $v ) : Scalr\Service\Aws\Ec2\DataType\InternetGatewayData Loads InternetGatewayData from simple xml object
_loadIpPermissionList ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Ec2\DataType\IpPermissionList Loads IpPermissionList from simple xml object
_loadIpRangeList ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Ec2\DataType\IpRangeList Loads IpRangeList from simple xml object
_loadListByName ( string $name, SimpleXMLElement $sxml ) : Scalr\Service\Aws\Ec2\Ec2ListDataType Loads lists from simple xml object
_loadMonitorInstancesResponseSetData ( SimpleXMLElement $v ) : Scalr\Service\Aws\Ec2\DataType\MonitorInstancesResponseSetData Loads MonitorInstancesResponseSetData from simple xml object
_loadNetworkInterfaceAssociationData ( SimpleXMLElement $v ) : Scalr\Service\Aws\Ec2\DataType\NetworkInterfaceAssociationData Loads NetworkInterfaceAssociationData from simple xml object
_loadNetworkInterfaceAttachmentData ( SimpleXMLElement $v ) : NetworkInterfaceAttachmentData Loads NetworkInterfaceAttachmentData from simple xml object
_loadNetworkInterfaceData ( SimpleXMLElement $v ) : Scalr\Service\Aws\Ec2\DataType\NetworkInterfaceData Loads NetworkInterfaceData from simple xml object
_loadNetworkInterfacePrivateIpAddressesSetData ( SimpleXMLElement $v ) : Scalr\Service\Aws\Ec2\DataType\NetworkInterfacePrivateIpAddressesSetData Loads NetworkInterfacePrivateIpAddressesSetData from simple xml object
_loadPlacementGroupData ( SimpleXMLElement $v ) : Scalr\Service\Aws\Ec2\DataType\PlacementGroupData Loads PlacementGroupData from simple xml object
_loadPlacementResponseData ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Ec2\DataType\PlacementResponseData Loads PlacementResponseData from simple xml object
_loadProductCodeSetList ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Ec2\DataType\ProductCodeSetList Loads ProductCodeSetList from simple xml object
_loadPropagatingVgwData ( SimpleXMLElement $v ) : Scalr\Service\Aws\Ec2\DataType\PropagatingVgwData Loads PropagatingVgwData from simple xml object
_loadRecurringChargesSetList ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Ec2\DataType\RecurringChargesSetList Loads RecurringChargesSetList from simple xml object
_loadResourceTagSetList ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Ec2\DataType\ResourceTagSetList Loads ResourceTagSetList from simple xml object
_loadRouteData ( SimpleXMLElement $v ) : Scalr\Service\Aws\Ec2\DataType\RouteData Loads RouteData from simple xml object
_loadRouteList ( SimpleXMLElement $sxml, string $routeTableId = null ) : Scalr\Service\Aws\Ec2\DataType\RouteList Loads RouteList from simple xml object
_loadRouteTableAssociationData ( SimpleXMLElement $v ) : Scalr\Service\Aws\Ec2\DataType\RouteTableAssociationData Loads RouteTableAssociationData from simple xml object
_loadRouteTableData ( SimpleXMLElement $v ) : Scalr\Service\Aws\Ec2\DataType\RouteTableData Loads RouteTableData from simple xml object
_loadSnapshotData ( SimpleXMLElement $v ) : SnapshotData Loads SnapshotData from simple xml object
_loadStateReasonData ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Ec2\DataType\StateReasonData Loads StateReasonData from simple xml object
_loadSubnetData ( SimpleXMLElement $v ) : Scalr\Service\Aws\Ec2\DataType\SubnetData Loads SubnetData from simple xml object
_loadUserIdGroupPairList ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Ec2\DataType\UserIdGroupPairList Loads UserIdGroupPairList from simple xml object
_loadVolumeData ( SimpleXMLElement $v ) : VolumeData Loads VolumeData from simple xml object
_loadVpcData ( SimpleXMLElement $v ) : Scalr\Service\Aws\Ec2\DataType\VpcData Loads VpcData from simple xml object

Method Details

__construct() public method

Constructor
public __construct ( Ec2 $ec2, Scalr\Service\Aws\Client\ClientInterface $client )
$ec2 Scalr\Service\Aws\Ec2 Ec2 instance
$client Scalr\Service\Aws\Client\ClientInterface Client Interface

_loadAttachmentSetResponseList() protected method

Loads AttachmentSetResponseList from simple xml object
protected _loadAttachmentSetResponseList ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Ec2\DataType\AttachmentSetResponseList
$sxml SimpleXMLElement
return Scalr\Service\Aws\Ec2\DataType\AttachmentSetResponseList Returns AttachmentSetResponseList

_loadBlockDeviceMappingList() protected method

Loads BlockDeviceMappingList from simple xml object
protected _loadBlockDeviceMappingList ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Ec2\DataType\BlockDeviceMappingList
$sxml SimpleXMLElement
return Scalr\Service\Aws\Ec2\DataType\BlockDeviceMappingList Returns BlockDeviceMappingList

_loadEbsBlockDeviceData() protected method

Loads EbsBlockDeviceData from simple xml object
protected _loadEbsBlockDeviceData ( SimpleXMLElement $sxml ) : EbsBlockDeviceData
$sxml SimpleXMLElement
return Scalr\Service\Aws\Ec2\DataType\EbsBlockDeviceData Returns EbsBlockDeviceData

_loadEbsInstanceBlockDeviceMappingResponseData() protected method

Loads EbsInstanceBlockDeviceMappingResponseData from simple xml object
protected _loadEbsInstanceBlockDeviceMappingResponseData ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Ec2\DataType\EbsInstanceBlockDeviceMappingResponseData
$sxml SimpleXMLElement
return Scalr\Service\Aws\Ec2\DataType\EbsInstanceBlockDeviceMappingResponseData Returns EbsInstanceBlockDeviceMappingResponseData

_loadGroupList() protected method

Loads GroupList from simple xml object
protected _loadGroupList ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Ec2\DataType\GroupList
$sxml SimpleXMLElement
return Scalr\Service\Aws\Ec2\DataType\GroupList Returns GroupList

_loadIamInstanceProfileResponseData() protected method

Loads IamInstanceProfileResponseData from simple xml object
protected _loadIamInstanceProfileResponseData ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Ec2\DataType\IamInstanceProfileResponseData
$sxml SimpleXMLElement
return Scalr\Service\Aws\Ec2\DataType\IamInstanceProfileResponseData Returns IamInstanceProfileResponseData

_loadInstanceBlockDeviceMappingResponseList() protected method

Loads InstanceBlockDeviceMappingResponseList from simple xml object
protected _loadInstanceBlockDeviceMappingResponseList ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Ec2\DataType\InstanceBlockDeviceMappingResponseList
$sxml SimpleXMLElement
return Scalr\Service\Aws\Ec2\DataType\InstanceBlockDeviceMappingResponseList Returns InstanceBlockDeviceMappingResponseList

_loadInstanceList() protected method

Loads InstanceList from simple xml object
protected _loadInstanceList ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Ec2\DataType\InstanceList
$sxml SimpleXMLElement
return Scalr\Service\Aws\Ec2\DataType\InstanceList Returns InstanceList

_loadInstanceMonitoringStateData() protected method

Loads InstanceMonitoringStateData from simple xml object
protected _loadInstanceMonitoringStateData ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Ec2\DataType\InstanceMonitoringStateData
$sxml SimpleXMLElement
return Scalr\Service\Aws\Ec2\DataType\InstanceMonitoringStateData Returns InstanceMonitoringStateData

_loadInstanceNetworkInterfaceAssociationData() protected method

Loads InstanceNetworkInterfaceAssociationData from simple xml object
protected _loadInstanceNetworkInterfaceAssociationData ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Ec2\DataType\InstanceNetworkInterfaceAssociationData
$sxml SimpleXMLElement
return Scalr\Service\Aws\Ec2\DataType\InstanceNetworkInterfaceAssociationData Returns InstanceNetworkInterfaceAssociationData

_loadInstanceNetworkInterfaceAttachmentData() protected method

Loads InstanceNetworkInterfaceAttachmentData from simple xml object
protected _loadInstanceNetworkInterfaceAttachmentData ( SimpleXMLElement $sxml ) : InstanceNetworkInterfaceAttachmentData
$sxml SimpleXMLElement
return Scalr\Service\Aws\Ec2\DataType\InstanceNetworkInterfaceAttachmentData Returns InstanceNetworkInterfaceAttachmentData

_loadInstanceNetworkInterfaceSetData() protected method

Loads InstanceNetworkInterfaceSetData from simple xml object
protected _loadInstanceNetworkInterfaceSetData ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Ec2\DataType\InstanceNetworkInterfaceSetData
$sxml SimpleXMLElement
return Scalr\Service\Aws\Ec2\DataType\InstanceNetworkInterfaceSetData Returns InstanceNetworkInterfaceSetData

_loadInstanceNetworkInterfaceSetList() protected method

Loads InstanceNetworkInterfaceSetList from simple xml object
protected _loadInstanceNetworkInterfaceSetList ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Ec2\DataType\InstanceNetworkInterfaceSetList
$sxml SimpleXMLElement
return Scalr\Service\Aws\Ec2\DataType\InstanceNetworkInterfaceSetList Returns InstanceNetworkInterfaceSetList

_loadInstancePrivateIpAddressesSetList() protected method

Loads InstancePrivateIpAddressesSetList from simple xml object
protected _loadInstancePrivateIpAddressesSetList ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Ec2\DataType\InstancePrivateIpAddressesSetList
$sxml SimpleXMLElement
return Scalr\Service\Aws\Ec2\DataType\InstancePrivateIpAddressesSetList Returns InstancePrivateIpAddressesSetList

_loadInstanceStateChangeData() protected method

Loads InstanceStateChangeData from simple xml object
protected _loadInstanceStateChangeData ( SimpleXMLElement $v ) : Scalr\Service\Aws\Ec2\DataType\InstanceStateChangeData
$v SimpleXMLElement
return Scalr\Service\Aws\Ec2\DataType\InstanceStateChangeData Returns InstanceStateChangeData

_loadInstanceStateData() protected method

Loads InstanceStateData from simple xml object
protected _loadInstanceStateData ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Ec2\DataType\InstanceStateData
$sxml SimpleXMLElement
return Scalr\Service\Aws\Ec2\DataType\InstanceStateData Returns InstanceStateData

_loadInstanceStatusDetailsSetList() protected method

Loads InstanceStatusDetailsSetList from simple xml object
protected _loadInstanceStatusDetailsSetList ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Ec2\DataType\InstanceStatusDetailsSetList
$sxml SimpleXMLElement
return Scalr\Service\Aws\Ec2\DataType\InstanceStatusDetailsSetList Returns InstanceStatusDetailsSetList

_loadInstanceStatusEventTypeData() protected method

Loads InstanceStatusEventTypeData from simple xml object
protected _loadInstanceStatusEventTypeData ( SimpleXMLElement $sxml ) : InstanceStatusEventTypeData
$sxml SimpleXMLElement
return Scalr\Service\Aws\Ec2\DataType\InstanceStatusEventTypeData Returns InstanceStatusEventTypeData

_loadInstanceStatusTypeData() protected method

Loads InstanceStatusTypeData from simple xml object
protected _loadInstanceStatusTypeData ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Ec2\DataType\InstanceStatusTypeData
$sxml SimpleXMLElement
return Scalr\Service\Aws\Ec2\DataType\InstanceStatusTypeData Returns InstanceStatusTypeData

_loadInternetGatewayAttachmentData() protected method

Loads InternetGatewayAttachmentData from simple xml object
protected _loadInternetGatewayAttachmentData ( SimpleXMLElement $v ) : Scalr\Service\Aws\Ec2\DataType\InternetGatewayAttachmentData
$v SimpleXMLElement
return Scalr\Service\Aws\Ec2\DataType\InternetGatewayAttachmentData Returns InternetGatewayAttachmentData

_loadInternetGatewayAttachmentList() protected method

Loads InternetGatewayAttachmentList from simple xml object
protected _loadInternetGatewayAttachmentList ( SimpleXMLElement $sxml, string $internetGatewayId = null ) : Scalr\Service\Aws\Ec2\DataType\InternetGatewayAttachmentList
$sxml SimpleXMLElement
$internetGatewayId string The ID of the Internet Gateway
return Scalr\Service\Aws\Ec2\DataType\InternetGatewayAttachmentList Returns InternetGatewayAttachmentList

_loadInternetGatewayData() protected method

Loads InternetGatewayData from simple xml object
protected _loadInternetGatewayData ( SimpleXMLElement $v ) : Scalr\Service\Aws\Ec2\DataType\InternetGatewayData
$v SimpleXMLElement
return Scalr\Service\Aws\Ec2\DataType\InternetGatewayData Returns InternetGatewayData

_loadIpPermissionList() protected method

Loads IpPermissionList from simple xml object
protected _loadIpPermissionList ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Ec2\DataType\IpPermissionList
$sxml SimpleXMLElement
return Scalr\Service\Aws\Ec2\DataType\IpPermissionList Returns IpPermissionList

_loadIpRangeList() protected method

Loads IpRangeList from simple xml object
protected _loadIpRangeList ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Ec2\DataType\IpRangeList
$sxml SimpleXMLElement
return Scalr\Service\Aws\Ec2\DataType\IpRangeList Returns IpRangeList

_loadListByName() protected method

Loads lists from simple xml object
protected _loadListByName ( string $name, SimpleXMLElement $sxml ) : Scalr\Service\Aws\Ec2\Ec2ListDataType
$name string The name of the ListDataType extended object without suffix "List"
$sxml SimpleXMLElement The simplexmlelement object
return Scalr\Service\Aws\Ec2\Ec2ListDataType Returns loaded object

_loadMonitorInstancesResponseSetData() protected method

Loads MonitorInstancesResponseSetData from simple xml object
protected _loadMonitorInstancesResponseSetData ( SimpleXMLElement $v ) : Scalr\Service\Aws\Ec2\DataType\MonitorInstancesResponseSetData
$v SimpleXMLElement
return Scalr\Service\Aws\Ec2\DataType\MonitorInstancesResponseSetData Returns MonitorInstancesResponseSetData

_loadNetworkInterfaceAssociationData() protected method

Loads NetworkInterfaceAssociationData from simple xml object
protected _loadNetworkInterfaceAssociationData ( SimpleXMLElement $v ) : Scalr\Service\Aws\Ec2\DataType\NetworkInterfaceAssociationData
$v SimpleXMLElement
return Scalr\Service\Aws\Ec2\DataType\NetworkInterfaceAssociationData Returns NetworkInterfaceAssociationData

_loadNetworkInterfaceAttachmentData() protected method

Loads NetworkInterfaceAttachmentData from simple xml object
protected _loadNetworkInterfaceAttachmentData ( SimpleXMLElement $v ) : NetworkInterfaceAttachmentData
$v SimpleXMLElement
return Scalr\Service\Aws\Ec2\DataType\NetworkInterfaceAttachmentData Returns NetworkInterfaceAttachmentData

_loadNetworkInterfaceData() protected method

Loads NetworkInterfaceData from simple xml object
protected _loadNetworkInterfaceData ( SimpleXMLElement $v ) : Scalr\Service\Aws\Ec2\DataType\NetworkInterfaceData
$v SimpleXMLElement
return Scalr\Service\Aws\Ec2\DataType\NetworkInterfaceData Returns NetworkInterfaceData

_loadNetworkInterfacePrivateIpAddressesSetData() protected method

Loads NetworkInterfacePrivateIpAddressesSetData from simple xml object
protected _loadNetworkInterfacePrivateIpAddressesSetData ( SimpleXMLElement $v ) : Scalr\Service\Aws\Ec2\DataType\NetworkInterfacePrivateIpAddressesSetData
$v SimpleXMLElement
return Scalr\Service\Aws\Ec2\DataType\NetworkInterfacePrivateIpAddressesSetData Returns NetworkInterfacePrivateIpAddressesSetData

_loadPlacementGroupData() protected method

Loads PlacementGroupData from simple xml object
protected _loadPlacementGroupData ( SimpleXMLElement $v ) : Scalr\Service\Aws\Ec2\DataType\PlacementGroupData
$v SimpleXMLElement
return Scalr\Service\Aws\Ec2\DataType\PlacementGroupData Returns PlacementGroupData

_loadPlacementResponseData() protected method

Loads PlacementResponseData from simple xml object
protected _loadPlacementResponseData ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Ec2\DataType\PlacementResponseData
$sxml SimpleXMLElement
return Scalr\Service\Aws\Ec2\DataType\PlacementResponseData Returns PlacementResponseData

_loadProductCodeSetList() protected method

Loads ProductCodeSetList from simple xml object
protected _loadProductCodeSetList ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Ec2\DataType\ProductCodeSetList
$sxml SimpleXMLElement
return Scalr\Service\Aws\Ec2\DataType\ProductCodeSetList Returns ProductCodeSetList

_loadPropagatingVgwData() protected method

Loads PropagatingVgwData from simple xml object
protected _loadPropagatingVgwData ( SimpleXMLElement $v ) : Scalr\Service\Aws\Ec2\DataType\PropagatingVgwData
$v SimpleXMLElement
return Scalr\Service\Aws\Ec2\DataType\PropagatingVgwData Returns PropagatingVgwData

_loadRecurringChargesSetList() protected method

Loads RecurringChargesSetList from simple xml object
protected _loadRecurringChargesSetList ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Ec2\DataType\RecurringChargesSetList
$sxml SimpleXMLElement
return Scalr\Service\Aws\Ec2\DataType\RecurringChargesSetList Returns RecurringChargesSetList

_loadResourceTagSetList() protected method

Loads ResourceTagSetList from simple xml object
protected _loadResourceTagSetList ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Ec2\DataType\ResourceTagSetList
$sxml SimpleXMLElement
return Scalr\Service\Aws\Ec2\DataType\ResourceTagSetList Returns ResourceTagSetList

_loadRouteData() protected method

Loads RouteData from simple xml object
protected _loadRouteData ( SimpleXMLElement $v ) : Scalr\Service\Aws\Ec2\DataType\RouteData
$v SimpleXMLElement
return Scalr\Service\Aws\Ec2\DataType\RouteData Returns RouteData

_loadRouteList() protected method

Loads RouteList from simple xml object
protected _loadRouteList ( SimpleXMLElement $sxml, string $routeTableId = null ) : Scalr\Service\Aws\Ec2\DataType\RouteList
$sxml SimpleXMLElement
$routeTableId string optional The ID of the Route table
return Scalr\Service\Aws\Ec2\DataType\RouteList Returns RouteList

_loadRouteTableAssociationData() protected method

Loads RouteTableAssociationData from simple xml object
protected _loadRouteTableAssociationData ( SimpleXMLElement $v ) : Scalr\Service\Aws\Ec2\DataType\RouteTableAssociationData
$v SimpleXMLElement
return Scalr\Service\Aws\Ec2\DataType\RouteTableAssociationData Returns RouteTableAssociationData

_loadRouteTableData() protected method

Loads RouteTableData from simple xml object
protected _loadRouteTableData ( SimpleXMLElement $v ) : Scalr\Service\Aws\Ec2\DataType\RouteTableData
$v SimpleXMLElement
return Scalr\Service\Aws\Ec2\DataType\RouteTableData Returns RouteTableData

_loadSnapshotData() protected method

Loads SnapshotData from simple xml object
protected _loadSnapshotData ( SimpleXMLElement $v ) : SnapshotData
$v SimpleXMLElement
return Scalr\Service\Aws\Ec2\DataType\SnapshotData Returns SnapshotData

_loadStateReasonData() protected method

Loads StateReasonData from simple xml object
protected _loadStateReasonData ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Ec2\DataType\StateReasonData
$sxml SimpleXMLElement
return Scalr\Service\Aws\Ec2\DataType\StateReasonData Returns StateReasonData

_loadSubnetData() protected method

Loads SubnetData from simple xml object
protected _loadSubnetData ( SimpleXMLElement $v ) : Scalr\Service\Aws\Ec2\DataType\SubnetData
$v SimpleXMLElement
return Scalr\Service\Aws\Ec2\DataType\SubnetData Returns SubnetData

_loadUserIdGroupPairList() protected method

Loads UserIdGroupPairList from simple xml object
protected _loadUserIdGroupPairList ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Ec2\DataType\UserIdGroupPairList
$sxml SimpleXMLElement
return Scalr\Service\Aws\Ec2\DataType\UserIdGroupPairList Returns UserIdGroupPairList

_loadVolumeData() protected method

Loads VolumeData from simple xml object
protected _loadVolumeData ( SimpleXMLElement $v ) : VolumeData
$v SimpleXMLElement
return Scalr\Service\Aws\Ec2\DataType\VolumeData Returns VolumeData

_loadVpcData() protected method

Loads VpcData from simple xml object
protected _loadVpcData ( SimpleXMLElement $v ) : Scalr\Service\Aws\Ec2\DataType\VpcData
$v SimpleXMLElement
return Scalr\Service\Aws\Ec2\DataType\VpcData Returns VpcData

allocateAddress() public method

Acquires an Elastic IP address for use with your instances.
public allocateAddress ( string $domain = null ) : Scalr\Service\Aws\Ec2\DataType\AddressData
$domain string optional Set to vpc to allocate the address for use with instances in a VPC. Valid values: vpc. Condition: Required when allocating an address for use with instances in a VPC
return Scalr\Service\Aws\Ec2\DataType\AddressData Returns AddressData on success

associateAddress() public method

Associates an Elastic IP address with an instance. This action applies to both EC2 and VPC Elastic IP addresses. EC2: If the IP address is currently assigned to another instance, the IP address is assigned to the new instance. VPC: If the IP address is currently assigned to another instance, Amazon EC2 returns an error unless you specify the AllowReassociation parameter This is an idempotent operation. If you enter it more than once, Amazon EC2 does not return an error
public associateAddress ( Scalr\Service\Aws\Ec2\DataType\AssociateAddressRequestData $request ) : boolean | string
$request Scalr\Service\Aws\Ec2\DataType\AssociateAddressRequestData
return boolean | string Returns associationId (for VPC Elastic IP addresses) or boolean TRUE (for others) on success.

associateRouteTable() public method

Associates a subnet with a route table. The subnet and route table must be in the same VPC. This association causes traffic originating from the subnet to be routed according to the routes in the route table. The action returns an association ID, which you need if you want to disassociate the route table from the subnet later. A route table can be associated with multiple subnets.
public associateRouteTable ( string $routeTableId, string $subnetId ) : string
$routeTableId string The ID of the Route Table.
$subnetId string The ID of the subnet.
return string Returns the ID of the association on success

attachInternetGateway() public method

Attaches an Internet gateway to a VPC, enabling connectivity between the Internet and the VPC
public attachInternetGateway ( string $internetGatewayId, string $vpcId ) : boolean
$internetGatewayId string The ID of the internet gateway
$vpcId string The ID of the VPC
return boolean Returns TRUE on success

attachNetworkInterface() public method

Attaches a network interface to an instance.
public attachNetworkInterface ( string $networkInterfaceId, string $instanceId, integer $deviceIndex ) : string
$networkInterfaceId string The ID of the network interface
$instanceId string The ID of the instance to attach to the network interface
$deviceIndex integer The index of the device for the network interface attachment.
return string Returns Attachment ID on success or throws an exception

attachVolume() public method

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 attachVolume ( string $volumeId, string $instanceId, string $device ) : AttachmentSetResponseData
$volumeId string The ID of the Amazon EBS volume. The volume and instance must be within the same Availability Zone
$instanceId string The ID of the Instance. The instance must be running.
$device string The device name as exposed to the instance
return Scalr\Service\Aws\Ec2\DataType\AttachmentSetResponseData Returns AttachmentSetResponseData on success

authorizeSecurityGroupEgress() public method

Adds one or more egress rules to a security group for use with a VPC. Specifically, this action permits instances to send traffic to one or more destination CIDR IP address ranges, or to one or more destination security groups for the same VPC. Important! You can have up to 50 rules per group (covering both ingress and egress rules). A security group is for use with instances either in the EC2-Classic platform or in a specific VPC. This action doesn't apply to security groups for EC2-Classic. Each rule consists of the protocol (for example, TCP), plus either a CIDR range or a source group. For the TCP and UDP protocols, you must also specify the destination port or port range. For the ICMP protocol, you must also specify the ICMP type and code. You can use -1 for the type or code to mean all types or all codes. Rule changes are propagated to affected instances as quickly as possible. However, a small delay might occur.
public authorizeSecurityGroupEgress ( Scalr\Service\Aws\Ec2\DataType\IpPermissionList $ipPermissions, string $groupId ) : boolean
$ipPermissions Scalr\Service\Aws\Ec2\DataType\IpPermissionList Ip permission list object
$groupId string optional The ID of the security group to modify.
return boolean Returns true on success

authorizeSecurityGroupIngress() public method

Adds one or more ingress rules to a security group. This action applies to both EC2 security groups and VPC security groups. For EC2 security groups, this action gives one or more CIDR IP address ranges permission to access a security group in your account, or gives one or more security groups (called the source groups) permission to access a security group in your account. A source group can be in your own AWS account, or another. For VPC security groups, this action gives one or more CIDR IP address ranges permission to access a security group in your VPC, or gives one or more other security groups (called the source groups) permission to access a security group in your VPC. The groups must all be in the same VPC. Each rule consists of the protocol (e.g., TCP), plus either a CIDR range or a source group. For the TCP and UDP protocols, you must also specify the destination port or port range. For the ICMP protocol, you must also specify the ICMP type and code.You can use -1 for the type or code to mean all types or all codes. Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.
public authorizeSecurityGroupIngress ( Scalr\Service\Aws\Ec2\DataType\IpPermissionList $ipPermissions, string $groupId = null, string $groupName = null ) : boolean
$ipPermissions Scalr\Service\Aws\Ec2\DataType\IpPermissionList Ip permission list object
$groupId string optional The ID of the EC2 or VPC security group to modify. The group must belong to your account.
$groupName string optional The name of the EC2 security group to modify. It can be used instead of group ID for EC2 security groups.
return boolean Returns true on success

copyImage() public method

Initiates the copy of an AMI from the specified source region to the region in which the API call is executed
public copyImage ( string $srcRegion, string $srcImageId, string $name = null, string $description = null, string $clientToken = null, string $destRegion = null ) : string
$srcRegion string The ID of the AWS region that contains the AMI to be copied.
$srcImageId string The ID of the Amazon EC2 AMI to copy.
$name string optional The name of the new Amazon EC2 AMI.
$description string optional A description of the new EC2 AMI in the destination region.
$clientToken string optional Unique, case-sensitive identifier you provide to ensure idempotency of the request
$destRegion string optional The ID of the destination region.
return string Returns ID of the created image on success.

copySnapshot() 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 copySnapshot ( string $srcRegion, string $srcSnapshotId, 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.
$srcSnapshotId string The ID of the Amazon EBS snapshot to copy.
$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.

createImage() public method

Creates an Amazon EBS-backed AMI from an Amazon EBS-backed instance that is either running or stopped. Note! If you customized your instance with instance store volumes or EBS volumes in addition to the root device volume, the new AMI contains block device mapping information for those volumes. When you launch an instance from this new AMI, the instance automatically launches with those additional volumes.
public createImage ( Scalr\Service\Aws\Ec2\DataType\CreateImageRequestData $request ) : string
$request Scalr\Service\Aws\Ec2\DataType\CreateImageRequestData Request object
return string Returns ID of the created image on success

createInternetGateway() public method

Creates a new Internet gateway for use with a VPC
public createInternetGateway ( ) : Scalr\Service\Aws\Ec2\DataType\InternetGatewayData
return Scalr\Service\Aws\Ec2\DataType\InternetGatewayData Returns InternetGatewayData on success

createKeyPair() public method

Creates a new 2048-bit RSA key pair with the specified name. The public key is stored by Amazon EC2 and the private key is returned to you. The private key is returned as an unencrypted PEM encoded PKCS#8 private key. If a key with the specified name already exists, Amazon EC2 returns an error. Tip! The key pair returned to you works only in the region you're using when you create the key pair. To create a key pair that works in all regions, use ImportKeyPair
public createKeyPair ( string $keyName ) : Scalr\Service\Aws\Ec2\DataType\KeyPairData
$keyName string A unique name for the key pair.
return Scalr\Service\Aws\Ec2\DataType\KeyPairData Returns KeyPairData on success

createNetworkInterface() public method

Creates a network interface in the specified subnet
public createNetworkInterface ( Scalr\Service\Aws\Ec2\DataType\CreateNetworkInterfaceRequestData $request ) : Scalr\Service\Aws\Ec2\DataType\NetworkInterfaceData
$request Scalr\Service\Aws\Ec2\DataType\CreateNetworkInterfaceRequestData Create Request
return Scalr\Service\Aws\Ec2\DataType\NetworkInterfaceData Returns created Network Interface

createPlacementGroup() public method

Creates a placement group that you launch cluster instances into.You must give the group a name unique within the scope of your account.
public createPlacementGroup ( string $groupName, string $strategy = 'cluster' ) : boolean
$groupName string The name of the placement group.
$strategy string optional The placement group strategy.
return boolean Returns True on success

createRoute() public method

Creates a route in a route table within a VPC. The route's target can be either a gateway attached to the VPC or a NAT instance in the VPC. When determining how to route traffic, we use the route with the most specific match. For example, let's say the traffic is destined for 192.0.2.3, and the route table includes the following two routes: 192.0.2.0/24 (goes to some target A) 192.0.2.0/28 (goes to some target B) Both routes apply to the traffic destined for 192.0.2.3. However, the second route in the list covers a smaller number of IP addresses and is therefore more specific, so we use that route to determine where to target the traffic. Condition:You must provide only one of the following: a GatewayId, InstanceId, or NetworkInterfaceId.
public createRoute ( string $routeTableId, string $destinationCidrBlock, string $gatewayId = null, string $instanceId = null, string $networkInterfaceId = null, string $vpcPeeringConnectionId = null ) : boolean
$routeTableId string The ID of the route table where the route will be added.
$destinationCidrBlock string The CIDR address block used for the destination match.
$gatewayId string optional The ID of a gataway attached to your VPC.
$instanceId string optional The ID of a NAT instance in your VPC.
$networkInterfaceId string optional Allows the routing of network interface IDs. Exactly one interface must be attached when specifying an instance ID or it fails.
$vpcPeeringConnectionId string optional The ID of a VPC peering connection.
return boolean Returns TRUE on success

createRouteTable() public method

Creates a route table within a VPC. After you create a new route table, you can add routes and associate the table with a subnet
public createRouteTable ( string $vpcId ) : Scalr\Service\Aws\Ec2\DataType\RouteTableData
$vpcId string The ID of the VPC
return Scalr\Service\Aws\Ec2\DataType\RouteTableData Returns the RouteTableData object on success

createSecurityGroup() public method

Creates a new security group.You can create either an EC2 security group (which works only with EC2), or a VPC security group (which works only with Amazon Virtual Private Cloud). The two types of groups have different capabilities When you create a security group, you give it a friendly name of your choice.You can have an EC2 security group with the same name as a VPC security group (each group has a unique security group ID separate from the name). Two standard groups can't have the same name, and two VPC groups can't have the same name. If you don't specify a security group when you launch an instance, the instance is launched into the default security group. This group (and only this group) includes a default rule that gives the instances in the group unrestricted network access to each other. You have a default EC2 security group for instances you launch with EC2 (i.e., outside a VPC), and a default VPC security group for instances you launch in your VPC.
public createSecurityGroup ( string $groupName, string $groupDescription, string $vpcId = null ) : string
$groupName string The name of the security group.
$groupDescription string A description of the security group. This is information only.
$vpcId string optional The ID of the VPC. (Required for VPC security groups)
return string Returns security group ID on success or throws an exception

createSnapshot() public method

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 $volumeId, string $description = null ) : SnapshotData
$volumeId string The ID of the Amazon EBS volume.
$description string optional A description of the Amazon EBS snapshot. (Up to 255 characters)
return Scalr\Service\Aws\Ec2\DataType\SnapshotData Returns the SnapshotData on success

createSubnet() public method

Creates a subnet in an existing VPC. You can create up to 20 subnets in a VPC. If you add more than one subnet to a VPC, they're set up in a star topology with a logical router in the middle.
public createSubnet ( string $vpcId, string $cidrBlock, string $availabilityZone = null ) : Scalr\Service\Aws\Ec2\DataType\SubnetData
$vpcId string The ID of the VPC.
$cidrBlock string The CIDR block for the subnet to cover (for example, 10.0.0.0/24).
$availabilityZone string optional The Availability Zone for the subnet. By default AWS selects a zone for you (recommended)
return Scalr\Service\Aws\Ec2\DataType\SubnetData Returns the SubnetData 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 ( ListDataType $resourceIdList, Scalr\Service\Aws\Ec2\DataType\ResourceTagSetList $tagList ) : boolean
$resourceIdList Scalr\Service\Aws\DataType\ListDataType The ID of a resource to tag. For example, ami-1a2b3c4d. You can specify multiple resources to assign the tags to.
$tagList Scalr\Service\Aws\Ec2\DataType\ResourceTagSetList The key/value pair list of the Tags.
return boolean Returns true on success or throws an exception otherwise

createVolume() public method

Creates an Amazon EBS volume that can be attached to any Amazon EC2 instance in the same Availability Zone. Any AWS Marketplace product codes from the snapshot are propagated to the volume
public createVolume ( CreateVolumeRequestData $request ) : VolumeData
$request Scalr\Service\Aws\Ec2\DataType\CreateVolumeRequestData Request that specifies parameters of the volume.
return Scalr\Service\Aws\Ec2\DataType\VolumeData Returns the VolumeData on success

createVpc() public method

Creates a VPC with the specified CIDR block. The smallest VPC you can create uses a /28 netmask (16 IP addresses), and the largest uses a /16 netmask (65,536 IP addresses). By default, each instance you launch in the VPC has the default DHCP options, which includes only a default DNS server that we provide (AmazonProvidedDNS)
public createVpc ( string $cidrBlock, string $instanceTenancy = null ) : Scalr\Service\Aws\Ec2\DataType\VpcData
$cidrBlock string The CIDR block you want the VPC to cover (for example, 10.0.0.0/16).
$instanceTenancy string optional The supported tenancy options for instances launched into the VPC. A value of default means that instances can be launched with any tenancy; a value of dedicated means all instances are launched as dedicated tenancy instances regardless of the tenancy assigned to the instance at launch. Setting the instance tenancy to dedicated runs your instance on single-tenant hardware.
return Scalr\Service\Aws\Ec2\DataType\VpcData Returns VpcData

deleteInternetGateway() public method

Deletes an Internet gateway from your AWS account. The gateway must not be attached to a VPC
public deleteInternetGateway ( string $internetGatewayId ) : boolean
$internetGatewayId string The ID of the Internet Gateway
return boolean Returns TRUE on success

deleteKeyPair() public method

Deletes the specified key pair, by removing the public key from Amazon EC2.You must own the key pair
public deleteKeyPair ( string $keyName ) : boolean
$keyName string A unique key name for the key pair.
return boolean Returns true on success

deleteNetworkInterface() public method

Deletes the specified network interface.
public deleteNetworkInterface ( string $networkInterfaceId ) : boolean
$networkInterfaceId string The ID of the network interface
return boolean Returns true on success or throws an exception

deletePlacementGroup() public method

Deletes a placement group from your account.You must terminate all instances in the placement group before deleting it.
public deletePlacementGroup ( string $groupName ) : boolean
$groupName string The name of the placement group.
return boolean Returns true on success

deleteRoute() public method

Deletes a route table from a VPC. The route table must not be associated with a subnet. You can't delete the main route table
public deleteRoute ( string $routeTableId, string $destinationCidrBlock ) : boolean
$routeTableId string The ID of the Route Table.
$destinationCidrBlock string The CIDR range for the route to delete.
return boolean Returns TRUE on success

deleteRouteTable() public method

Deletes a route table from a VPC. The route table must not be associated with a subnet. You can't delete the main route table
public deleteRouteTable ( string $routeTableId ) : boolean
$routeTableId string The ID of the Route Table
return boolean Returns TRUE on success

deleteSecurityGroup() public method

Deletes a security group. This action applies to both EC2 security groups and VPC security groups. For information about VPC security groups and how they differ from EC2 security groups, see Security Groups in the Amazon Virtual Private Cloud User Guide. Note! If you attempt to delete a security group that contains instances, or attempt to delete a security group that is referenced by another security group, an error is returned. For example, if security group B has a rule that allows access from security group A, security group A cannot be deleted until the rule is removed. The fault returned is InvalidGroup.InUse for EC2 security groups, or DependencyViolation for VPC security groups.
public deleteSecurityGroup ( string $groupId = null, string $groupName = null ) : boolean
$groupId string optional The ID of the security group to remove.
$groupName string optional The name of security group to remove.
return boolean Returns true on success or throws an exception.

deleteSnapshot() 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 deleteSnapshot ( string $snapshotId ) : boolean
$snapshotId string The ID of the Amazon EBS snapshot.
return boolean Returns TRUE on success

deleteSubnet() public method

Deletes a subnet from a VPC. You must terminate all running instances in the subnet before deleting it, otherwise Amazon VPC returns an error
public deleteSubnet ( string $subnetId ) : boolean
$subnetId string The ID of the subnet.
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 ( ListDataType $resourceIdList, Scalr\Service\Aws\Ec2\DataType\ResourceTagSetList $tagList ) : boolean
$resourceIdList Scalr\Service\Aws\DataType\ListDataType The ID of a resource to tag. For example, ami-1a2b3c4d. You can specify multiple resources to assign the tags to.
$tagList Scalr\Service\Aws\Ec2\DataType\ResourceTagSetList The key/value pair list of the Tags.
return boolean Returns true on success or throws an exception otherwise

deleteVolume() public method

Deletes an Amazon EBS volume. The volume must be in the available state (not attached to an instance)
public deleteVolume ( string $volumeId ) : boolean
$volumeId string The ID of the volume.
return boolean Returns true on success or throws an exception otherwise

deleteVpc() public method

Deletes a VPC.You must detach or delete all gateways or other objects that are dependent on the VPC first. For example, you must terminate all running instances, delete all security groups (except the default), delete all the route tables (except the default), and so on.
public deleteVpc ( string $vpcId ) : boolean
$vpcId string The ID of the VPC
return boolean Returns true on success or throws an exception

deregisterImage() public method

Deregisters the specified AMI. Once deregistered, the AMI cannot be used to launch new instances. Note! This command does not delete the AMI.
public deregisterImage ( string $imageId ) : boolean
$imageId string The ID of the AMI
return boolean Returns true on success

describeAccountAttributes() public method

Describes the specified attribute of your AWS account.
public describeAccountAttributes ( ListDataType $attributeName ) : Scalr\Service\Aws\Ec2\DataType\AccountAttributeSetList
$attributeName Scalr\Service\Aws\DataType\ListDataType List of the The following table lists the supported account attributes
return Scalr\Service\Aws\Ec2\DataType\AccountAttributeSetList Returns list of the names and values of the requested attributes

describeAddresses() public method

Describes one or more of the Elastic IP addresses allocated to your account. This action applies to both EC2 and VPC Elastic IP addresses.
public describeAddresses ( ListDataType $publicIpList = null, ListDataType $allocationIdList = null, Scalr\Service\Aws\Ec2\DataType\AddressFilterList $filter = null ) : Scalr\Service\Aws\Ec2\DataType\AddressList
$publicIpList Scalr\Service\Aws\DataType\ListDataType optional One or more EC2 Elastic IP addresses
$allocationIdList Scalr\Service\Aws\DataType\ListDataType optional One or more allocation IDs corresponding to the address or addresses to describe (VPC addresses only).
$filter Scalr\Service\Aws\Ec2\DataType\AddressFilterList optional The filter list.
return Scalr\Service\Aws\Ec2\DataType\AddressList Returns AddressList on success

describeAvailabilityZones() public method

Describes one or more of the Availability Zones that are currently available to the account. The results include zones only for the region you're currently using. Note! Availability Zones are not the same across accounts.The Availability Zone us-east-1a for account A is not necessarily the same as us-east-1a for account B. Zone assignments are mapped independently for each account.
public describeAvailabilityZones ( ListDataType $zoneName = null, Scalr\Service\Aws\Ec2\DataType\AvailabilityZoneFilterList $filter = null ) : Scalr\Service\Aws\Ec2\DataType\AvailabilityZoneList
$zoneName Scalr\Service\Aws\DataType\ListDataType optional Zone Name List to filter.
$filter Scalr\Service\Aws\Ec2\DataType\AvailabilityZoneFilterList optional Filter to apply.
return Scalr\Service\Aws\Ec2\DataType\AvailabilityZoneList Returns the list of Availability Zones

describeImages() public method

Describes the images (AMIs, AKIs, and ARIs) available to you. Images available to you include public images, private images that you own, and private images owned by other AWS accounts but for which you have explicit launch permissions.
public describeImages ( ListDataType $imageIdList = null, ListDataType $ownerList = null, Scalr\Service\Aws\Ec2\DataType\ImageFilterList $filter = null, ListDataType $executableByList = null ) : Scalr\Service\Aws\Ec2\DataType\ImageList
$imageIdList Scalr\Service\Aws\DataType\ListDataType optional One or more AMI IDs.
$ownerList Scalr\Service\Aws\DataType\ListDataType optional The AMIs owned by the specified owner. Multiple owner values can be specified. The IDs amazon, aws-marketplace, and self can be used to include AMIs owned by Amazon, AWS Marketplace, or AMIs owned by you, respectively. Valid values: amazon | aws-marketplace | self | AWS account ID | all
$filter Scalr\Service\Aws\Ec2\DataType\ImageFilterList optional Filter list
$executableByList Scalr\Service\Aws\DataType\ListDataType optional The AMIs for which the specified user ID has explicit launch permissions. The user ID can be an AWS account ID, self to return AMIs for which the sender of the request has explicit launch permissions, or all to return AMIs with public launch permissions.
return Scalr\Service\Aws\Ec2\DataType\ImageList Returns the list of Images on success or throws an exception otherwise

describeInstanceAttribute() public method

Describes an attribute of the specified instance
public describeInstanceAttribute ( string $instanceId, Scalr\Service\Aws\Ec2\DataType\InstanceAttributeType $attribute ) : mixed
$instanceId string The ID of the Instance.
$attribute Scalr\Service\Aws\Ec2\DataType\InstanceAttributeType The attribute.
return mixed Returns attribute value. It may be scalar value or stdClass object depends on attribute.

describeInstanceStatus() public method

DescribeInstanceStatus action
public describeInstanceStatus ( ListDataType $instanceIdList = null, boolean $includeAllInstances = null, Scalr\Service\Aws\Ec2\DataType\InstanceStatusFilterList $filter = null, string $nextToken = null, integer $maxResults = null ) : Scalr\Service\Aws\Ec2\DataType\InstanceStatusList
$instanceIdList Scalr\Service\Aws\DataType\ListDataType optional The list of the instance IDs
$includeAllInstances boolean optional When true, returns the health status for all instances (for example, running, stopped, pending, shutting down).When false, returns only the health status for running instances.
$filter Scalr\Service\Aws\Ec2\DataType\InstanceStatusFilterList optional A Filter
$nextToken string The next paginated set of results to return
$maxResults integer The maximum number of paginated instance items per response.
return Scalr\Service\Aws\Ec2\DataType\InstanceStatusList Returns the list of the InstanceStatusData objects

describeInstances() public method

Describes one or more of your instances. If you specify one or more instance IDs, Amazon EC2 returns information for those instances. If you do not specify instance IDs, Amazon EC2 returns information for all relevant instances. If you specify an invalid instance ID, an error is returned. If you specify an instance that you do not own, it is not included in the returned results. Recently terminated instances might appear in the returned results. This interval is usually less than one hour.
public describeInstances ( ListDataType $instanceIdList = null, Scalr\Service\Aws\Ec2\DataType\InstanceFilterList $filter = null, string $nextToken = null, integer $maxResults = null ) : Scalr\Service\Aws\Ec2\DataType\ReservationList
$instanceIdList Scalr\Service\Aws\DataType\ListDataType optional One or more instance IDs
$filter Scalr\Service\Aws\Ec2\DataType\InstanceFilterList optional A Filter list
$nextToken string The next paginated set of results to return
$maxResults integer The maximum number of paginated instance items per response.
return Scalr\Service\Aws\Ec2\DataType\ReservationList Returns List of the reservations on success

describeInternetGateways() public method

Describes one or more of your Internet gateways.
public describeInternetGateways ( ListDataType $internetGatewayIdList = null, Scalr\Service\Aws\Ec2\DataType\InternetGatewayFilterList $filter = null ) : Scalr\Service\Aws\Ec2\DataType\InternetGatewayList
$internetGatewayIdList Scalr\Service\Aws\DataType\ListDataType optional The list of Internet gateway identifiers.
$filter Scalr\Service\Aws\Ec2\DataType\InternetGatewayFilterList optional The filter list.
return Scalr\Service\Aws\Ec2\DataType\InternetGatewayList Returns InternetGatewayList on success

describeKeyPairs() public method

Describes one or more of your key pairs.
public describeKeyPairs ( ListDataType $keyNameList = null, array $filter = null ) : Scalr\Service\Aws\Ec2\DataType\KeyPairList
$keyNameList Scalr\Service\Aws\DataType\ListDataType The list of the names
$filter array Array of the key => value properties.
return Scalr\Service\Aws\Ec2\DataType\KeyPairList Returns KeyPairList on success

describeNetworkInterfaceAttribute() public method

Describes a network interface attribute.You can specify only one attribute at a time.
public describeNetworkInterfaceAttribute ( string $networkInterfaceId, Scalr\Service\Aws\Ec2\DataType\NetworkInterfaceAttributeType $attribute ) : mixed
$networkInterfaceId string The ID of the network interface.
$attribute Scalr\Service\Aws\Ec2\DataType\NetworkInterfaceAttributeType The attribute.
return mixed Returns attribute value. It can be string, boolean, NetworkInterfaceAttachmentData or GroupList depends on attribute value you provided.

describeNetworkInterfaces() public method

Describes one or more of your network interfaces.
public describeNetworkInterfaces ( ListDataType $networkInterfaceIdList = null, Scalr\Service\Aws\Ec2\DataType\NetworkInterfaceFilterList $filter = null ) : Scalr\Service\Aws\Ec2\DataType\NetworkInterfaceList
$networkInterfaceIdList Scalr\Service\Aws\DataType\ListDataType optional One or more network interface IDs
$filter Scalr\Service\Aws\Ec2\DataType\NetworkInterfaceFilterList optional Filter list
return Scalr\Service\Aws\Ec2\DataType\NetworkInterfaceList Returns the list of the Network Interfaces

describePlacementGroups() public method

Describes one or more of your placement groups.
public describePlacementGroups ( ListDataType $groupNameList = null, Scalr\Service\Aws\Ec2\DataType\PlacementGroupFilterList $filter = null ) : Scalr\Service\Aws\Ec2\DataType\PlacementGroupList
$groupNameList Scalr\Service\Aws\DataType\ListDataType optional One or more placement group names.
$filter Scalr\Service\Aws\Ec2\DataType\PlacementGroupFilterList optional The list of the filters.
return Scalr\Service\Aws\Ec2\DataType\PlacementGroupList Returns the list of the PlacementGroupData objects on success

describeRegions() public method

DescribeRegions action
public describeRegions ( ) : Scalr\Service\Aws\Ec2\DataType\RegionInfoList
return Scalr\Service\Aws\Ec2\DataType\RegionInfoList Returns the list of the RegionInfoData objects on success

describeReservedInstances() public method

Describes one or more of the Reserved Instances that you purchased. Starting with the 2011-11-01 API version, AWS expanded its offering of Amazon EC2 Reserved Instances to address a range of projected instance use. There are three types of Reserved Instances based on customer utilization levels: Heavy Utilization, Medium Utilization, and Light Utilization.You determine the type of the Reserved Instances offerings by including the optional offeringType parameter.The Medium Utilization offering type is equivalent to the Reserved Instance offering available before API version 2011-11-01. If you are using tools that predate the 2011-11-01 API version, you only have access to the Medium Utilization Reserved Instance offering type.
public describeReservedInstances ( ListDataType $reservedInstanceIdList = null, Scalr\Service\Aws\Ec2\DataType\ReservedInstanceFilterList $filter = null, Scalr\Service\Aws\Ec2\DataType\OfferingType $offefingType = null ) : Scalr\Service\Aws\Ec2\DataType\ReservedInstanceList
$reservedInstanceIdList Scalr\Service\Aws\DataType\ListDataType optional One or more instance IDs
$filter Scalr\Service\Aws\Ec2\DataType\ReservedInstanceFilterList optional A Filter list
$offefingType Scalr\Service\Aws\Ec2\DataType\OfferingType
return Scalr\Service\Aws\Ec2\DataType\ReservedInstanceList Returns reserved list of the reserved instances

describeRouteTables() public method

Describes one or more of your route tables.
public describeRouteTables ( ListDataType $routeTableIdList = null, Scalr\Service\Aws\Ec2\DataType\RouteTableFilterList $filter = null ) : Scalr\Service\Aws\Ec2\DataType\RouteTableList
$routeTableIdList Scalr\Service\Aws\DataType\ListDataType optional The list of Route Table IDs
$filter Scalr\Service\Aws\Ec2\DataType\RouteTableFilterList optional The filter list
return Scalr\Service\Aws\Ec2\DataType\RouteTableList Returns the list of the RouteTableData objects on success

describeSecurityGroups() public method

Describes one or more of your security groups. This includes both EC2 security groups and VPC security groups
public describeSecurityGroups ( ListDataType $groupName = null, ListDataType $groupId = null, Scalr\Service\Aws\Ec2\DataType\SecurityGroupFilterList $filter = null ) : Scalr\Service\Aws\Ec2\DataType\SecurityGroupList
$groupName Scalr\Service\Aws\DataType\ListDataType optional One or more security group names.
$groupId Scalr\Service\Aws\DataType\ListDataType optional One or more security group IDs.
$filter Scalr\Service\Aws\Ec2\DataType\SecurityGroupFilterList optional The name/value pairs list for the filter.
return Scalr\Service\Aws\Ec2\DataType\SecurityGroupList Returns SecurityGroupList

describeSnapshots() public method

Describes one or more of the Amazon EBS snapshots available to you. Snapshots available to you include public snapshots available for any AWS account to launch, private snapshots you own, and private snapshots owned by another AWS account but for which you've been given explicit create volume permissions.
public describeSnapshots ( ListDataType $snapshotIdList = null, ListDataType $ownerList = null, Scalr\Service\Aws\Ec2\DataType\SnapshotFilterList $filter = null, ListDataType $restorableByList = null ) : Scalr\Service\Aws\Ec2\DataType\SnapshotList
$snapshotIdList Scalr\Service\Aws\DataType\ListDataType optional One or more snapshot IDs. By default it describes snapshots for which you have launch permissions.
$ownerList Scalr\Service\Aws\DataType\ListDataType optional Returns the snapshots owned by the specified owner. Multiple owners can be specified. Valid values: self | amazon | AWS Account ID
$filter Scalr\Service\Aws\Ec2\DataType\SnapshotFilterList optional The list of filters.
$restorableByList Scalr\Service\Aws\DataType\ListDataType optional One or more AWS accounts IDs that can create volumes from the snapshot.
return Scalr\Service\Aws\Ec2\DataType\SnapshotList Returns the list of snapshots on success

describeSubnets() public method

Describes one or more of your subnets.
public describeSubnets ( ListDataType $subnetIdList = null, Scalr\Service\Aws\Ec2\DataType\SubnetFilterList $filter = null ) : Scalr\Service\Aws\Ec2\DataType\SubnetList
$subnetIdList Scalr\Service\Aws\DataType\ListDataType optional A subnet ID list.
$filter Scalr\Service\Aws\Ec2\DataType\SubnetFilterList optional The list of the filters.
return Scalr\Service\Aws\Ec2\DataType\SubnetList Returns the list of found subnets on success.

describeVolumes() public method

Describes one or more of your Amazon EBS volumes.
public describeVolumes ( ListDataType $volumeIdList = null, Scalr\Service\Aws\Ec2\DataType\VolumeFilterList $filter = null ) : Scalr\Service\Aws\Ec2\DataType\VolumeList
$volumeIdList Scalr\Service\Aws\DataType\ListDataType optional The list of Volume ID
$filter Scalr\Service\Aws\Ec2\DataType\VolumeFilterList optional The filter list
return Scalr\Service\Aws\Ec2\DataType\VolumeList Returns the list of the volumes

describeVpcs() public method

Describes one or more of your VPCs.
public describeVpcs ( ListDataType $vpcIdList = null, Scalr\Service\Aws\Ec2\DataType\VpcFilterList $filter = null ) : Scalr\Service\Aws\Ec2\DataType\VpcList
$vpcIdList Scalr\Service\Aws\DataType\ListDataType optional The list of the VpcID
$filter Scalr\Service\Aws\Ec2\DataType\VpcFilterList optional The filter list
return Scalr\Service\Aws\Ec2\DataType\VpcList Returns the list of the Vpcs

detachInternetGateway() public method

Detaches an Internet gateway from a VPC, disabling connectivity between the Internet and the VPC
public detachInternetGateway ( string $internetGatewayId, string $vpcId ) : boolean
$internetGatewayId string The ID of the internet gateway
$vpcId string The ID of the VPC
return boolean Returns TRUE on success

detachNetworkInterface() public method

Detaches a network interface from an instance
public detachNetworkInterface ( string $attachmentId, boolean $force = null ) : boolean
$attachmentId string The ID of the Attachment
$force boolean optional Set to TRUE to force a detachment
return boolean Returns TRUE on success or throws an exception

detachVolume() public method

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 detachVolume ( string $volumeId, string $instanceId = null, string $device = null, boolean $force = null ) : AttachmentSetResponseData
$volumeId string The ID of the EBS volume.
$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.
return Scalr\Service\Aws\Ec2\DataType\AttachmentSetResponseData Returns AttachmentSetResponseData on success

disassociateAddress() public method

Disassociates an Elastic IP address from the instance it's assigned to. This action applies to both EC2 Elastic IP addresses and VPC Elastic IP addresses. This is an idempotent action. If you enter it more than once, Amazon EC2 does not return an error
public disassociateAddress ( string $publicIp = null, string $associationId = null ) : boolean
$publicIp string optional The EC2 Elastic IP address. Condition: Required for EC2 Elastic IP addresses
$associationId string optional The association ID corresponding to the VPC Elastic IP Conditional address. Condition: Required for VPC Elastic IP addresses
return boolean Returns true on success

disassociateRouteTable() public method

Disassociates a subnet from a route table. After you perform this action, the subnet no longer uses the routes in the route table. Instead, it uses the routes in the VPC's main route table.
public disassociateRouteTable ( string $associationId ) : boolean
$associationId string The association ID representing the current association between the route table and subnet.
return boolean Returns TRUE on success

getConsoleOutput() public method

Retrieves console output for the specified instance. Instance console output is buffered and posted shortly after instance boot, reboot, and termination. Amazon EC2 preserves the most recent 64 KB output which will be available for at least one hour after the most recent post.
public getConsoleOutput ( string $instanceId ) : GetConsoleOutputResponseData
$instanceId string The ID of the EC2 instance.
return Scalr\Service\Aws\Ec2\DataType\GetConsoleOutputResponseData Returns object which represents console output.

getEntityManager() public method

Gets an entity manager
public getEntityManager ( ) : Scalr\Service\Aws\EntityManager
return Scalr\Service\Aws\EntityManager

getInstanceIdListQuery() public method

It transforms 'Instances.member.N.InstanceId' structure to acceptable 'InstancesId.N' structure
public getInstanceIdListQuery ( ListDataType $instanceIdList, string $name = 'InstanceId' ) : array
$instanceIdList Scalr\Service\Aws\DataType\ListDataType The list of the Instance ID
$name string optional URL parameter name
return array Returns array of the query parameters for the request

getPasswordData() public method

Retrieves the encrypted administrator password for an instance running Windows. Note! The Windows password is only generated the first time an AMI is launched. It is not generated for rebundled AMIs or after the password is changed on an instance. The password is encrypted using the key pair that you provided.
public getPasswordData ( string $instanceId ) : GetPasswordDataResponseData
$instanceId string A Windows instance ID.
return Scalr\Service\Aws\Ec2\DataType\GetPasswordDataResponseData Returns object which represents console output.

modifyInstanceAttribute() public method

Modifies the specified attribute of the specified instance. You can specify only one attribute at a time. To modify some attributes, the instance must be stopped.
public modifyInstanceAttribute ( string $instanceId, Scalr\Service\Aws\Ec2\DataType\InstanceAttributeType $attribute, mixed $value ) : boolean
$instanceId string The ID of the Instance.
$attribute Scalr\Service\Aws\Ec2\DataType\InstanceAttributeType The attribute name.
$value mixed The attribute value can be string, boolean, array or object depends on attribute name.
return boolean Returns TRUE on success

modifyNetworkInterfaceAttribute() public method

Modifies a network interface attribute.You can specify only one attribute at a time.
public modifyNetworkInterfaceAttribute ( string $networkInterfaceId, Scalr\Service\Aws\Ec2\DataType\NetworkInterfaceAttributeType $attr, mixed $value ) : boolean
$networkInterfaceId string The ID of the network interface.
$attr Scalr\Service\Aws\Ec2\DataType\NetworkInterfaceAttributeType The attribute name.
$value mixed The attribute value.
return boolean Returns TRUE on success

monitorInstances() public method

Enables monitoring for a running instance.
public monitorInstances ( ListDataType $instanceIdList ) : Scalr\Service\Aws\Ec2\DataType\MonitorInstancesResponseSetList
$instanceIdList Scalr\Service\Aws\DataType\ListDataType One or more instance IDs
return Scalr\Service\Aws\Ec2\DataType\MonitorInstancesResponseSetList Returns the MonitorInstancesResponseSetList

rebootInstances() public method

Requests a reboot of one or more instances. This operation is asynchronous; it only queues a request to reboot the specified instance(s). The operation will succeed if the instances are valid and belong to you. Requests to reboot terminated instances are ignored. Note! If a Linux/UNIX instance does not cleanly shut down within four minutes, Amazon EC2 will perform a hard reboot.
public rebootInstances ( ListDataType $instanceIdList ) : boolean
$instanceIdList Scalr\Service\Aws\DataType\ListDataType The list of the Instance IDs
return boolean Returns true on success or throws an exception otherwise

registerImage() public method

Registers a new AMI with Amazon EC2. When you're creating an AMI, this is the final step you must complete before you can launch an instance from the AMI
public registerImage ( Scalr\Service\Aws\Ec2\DataType\RegisterImageData $request ) : string
$request Scalr\Service\Aws\Ec2\DataType\RegisterImageData Register Image request
return string Returns the ID of the newly registered AMI

releaseAddress() public method

Releases an Elastic IP address allocated to your account. Important! After releasing an Elastic IP address, it is released to the IP address pool and might be unavailable to your account. Make sure to update your DNS records and any servers or devices that communicate with the address.
public releaseAddress ( string $publicIp = null, string $allocationId = null ) : boolean
$publicIp string optional The EC2 Elastic IP address
$allocationId string optional The allocation ID that AWS provided when you allocated the address for use with Amazon VPC.
return boolean Returns true on success

replaceRoute() public method

Replaces an existing route within a route table in a VPC Condition:You must provide only one of the following: a GatewayId, InstanceId, or NetworkInterfaceId.
public replaceRoute ( string $routeTableId, string $destinationCidrBlock, string $gatewayId = null, string $instanceId = null, string $networkInterfaceId = null, string $vpcPeeringConnectionId = null ) : boolean
$routeTableId string The ID of the route table where the route will be added.
$destinationCidrBlock string The CIDR address block used for the destination match.
$gatewayId string optional The ID of a gataway attached to your VPC.
$instanceId string optional The ID of a NAT instance in your VPC.
$networkInterfaceId string optional Allows the routing of network interface IDs. Exactly one interface must be attached when specifying an instance ID or it fails.
$vpcPeeringConnectionId string optional The ID of a VPC peering connection.
return boolean Returns TRUE on success

replaceRouteTableAssociation() public method

Changes the route table associated with a given subnet in a VPC. After you execute this action, the subnet uses the routes in the new route table it's associated with. You can also use this action to change which table is the main route table in the VPC. You just specify the main route table's association ID and the route table that you want to be the new main route table.
public replaceRouteTableAssociation ( string $routeTableId, string $associationId ) : string
$routeTableId string The ID of the new route table to associate with the subnet.
$associationId string The ID representing the current association between the original route table and the subnet.
return string Returns the ID of the new association on success

resetNetworkInterfaceAttribute() public method

Resets a network interface attribute.You can specify only one attribute at a time
public resetNetworkInterfaceAttribute ( string $networkInterfaceId, Scalr\Service\Aws\Ec2\DataType\NetworkInterfaceAttributeType $attr ) : boolean
$networkInterfaceId string The ID of the network interface.
$attr Scalr\Service\Aws\Ec2\DataType\NetworkInterfaceAttributeType The attribute name.
return boolean Returns TRUE on success

revokeSecurityGroupEgress() public method

Removes one or more egress rules from a security group for EC2-VPC. The values that you specify in the revoke request (for example, ports) must match the existing rule's values for the rule to be revoked. Each rule consists of the protocol and the CIDR range or destination security group. For the TCP and UDP protocols, you must also specify the destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type and code. Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.
public revokeSecurityGroupEgress ( Scalr\Service\Aws\Ec2\DataType\IpPermissionList $ipPermissions, string $groupId ) : boolean
$ipPermissions Scalr\Service\Aws\Ec2\DataType\IpPermissionList Ip permission list object
$groupId string optional The ID of the security group to modify.
return boolean Returns true on success

revokeSecurityGroupIngress() public method

This action applies to both EC2 security groups and VPC security groups. This action removes one or more ingress rules from a security group. The values that you specify in the revoke request (e.g., ports, etc.) must match the existing rule's values for the rule to be removed. Each rule consists of the protocol and the CIDR range or source security group. For the TCP and UDP protocols, you must also specify the destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type and code. Rule changes are propagated to instances within the security group as quickly as possible. However, depending on the number of instances, a small delay might occur
public revokeSecurityGroupIngress ( Scalr\Service\Aws\Ec2\DataType\IpPermissionList $ipPermissions, string $groupId = null, string $groupName = null ) : boolean
$ipPermissions Scalr\Service\Aws\Ec2\DataType\IpPermissionList Ip permission list object
$groupId string optional The ID of the EC2 or VPC security group to modify. The group must belong to your account.
$groupName string optional The name of the EC2 security group to modify. It can be used instead of group ID for EC2 security groups.
return boolean Returns true on success

runInstances() public method

Launches the specified number of instances of an AMI for which you have permissions. If Amazon EC2 cannot launch the minimum number of instances you request, no instances will be launched. If there is insufficient capacity to launch the maximum number of instances you request, Amazon EC2 launches the minimum number specified and allocates the remaining available instances using round robin. Note! Every instance is launched in a security group (created using the CreateSecurityGroup operation). If you don't specify a security group in the RunInstances request, the "default" security group is used.
public runInstances ( Scalr\Service\Aws\Ec2\DataType\RunInstancesRequestData $request ) : Scalr\Service\Aws\Ec2\DataType\ReservationData
$request Scalr\Service\Aws\Ec2\DataType\RunInstancesRequestData Request data
return Scalr\Service\Aws\Ec2\DataType\ReservationData Returns the ReservationData object

startInstances() public method

Starts an Amazon EBS-backed AMI that you've previously stopped. Instances that use Amazon EBS volumes as their root devices can be quickly stopped and started. When an instance is stopped, the compute resources are released and you are not billed for hourly instance usage. However, your root partition Amazon EBS volume remains, continues to persist your data, and you are charged for Amazon EBS volume usage. You can restart your instance at any time. Each time you transition an instance from stopped to started, we charge a full instance hour, even if transitions happen multiple times within a single hour. Note! Before stopping an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM. Performing this operation on an instance that uses an instance store as its root device returns an error.
public startInstances ( ListDataType $instanceIdList ) : Scalr\Service\Aws\Ec2\DataType\InstanceStateChangeList
$instanceIdList Scalr\Service\Aws\DataType\ListDataType One or more instance IDs.
return Scalr\Service\Aws\Ec2\DataType\InstanceStateChangeList Return the InstanceStateChangeList

stopInstances() public method

Stops an Amazon EBS-backed instance. Each time you transition an instance from stopped to started, we charge a full instance hour, even if transitions happen multiple times within a single hour. Important! Although Spot Instances can use Amazon EBS-backed AMIs, they don't support Stop/Start. In other words, you can't stop and start Spot Instances launched from an AMI with an Amazon EBS root device. Instances that use Amazon EBS volumes as their root devices can be quickly stopped and started.When an instance is stopped, the compute resources are released and you are not billed for hourly instance usage. However, your root partition Amazon EBS volume remains, continues to persist your data, and you are charged for Amazon EBS volume usage.You can restart your instance at any time. Note! Before stopping an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM. Performing this operation on an instance that uses an instance store as its root device returns an error. You can stop, start, and terminate EBS-backed instances.You can only terminate S3-backed instances. What happens to an instance differs if you stop it or terminate it. For example, when you stop an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, the root device and any other devices attached during the instance launch are automatically deleted
public stopInstances ( ListDataType $instanceIdList, boolean $force = null ) : Scalr\Service\Aws\Ec2\DataType\InstanceStateChangeList
$instanceIdList Scalr\Service\Aws\DataType\ListDataType One or more instance IDs.
$force boolean optional Forces the instance to stop. The instance will not 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. This option is not recommended for Windows instances.
return Scalr\Service\Aws\Ec2\DataType\InstanceStateChangeList Return the InstanceStateChangeList

terminateInstances() public method

Shuts down one or more instances. This operation is idempotent; if you terminate an instance more than once, each call will succeed. Terminated instances will remain visible after termination (approximately one hour). Note! By default, Amazon EC2 deletes all Amazon EBS volumes that were attached when the instance launched. Amazon EBS volumes attached after instance launch continue running. You can stop, start, and terminate EBS-backed instances.You can only terminate S3-backed instances. What happens to an instance differs if you stop it or terminate it. For example, when you stop an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, the root device and any other devices attached during the instance launch are automatically deleted.
public terminateInstances ( ListDataType $instanceIdList ) : Scalr\Service\Aws\Ec2\DataType\InstanceStateChangeList
$instanceIdList Scalr\Service\Aws\DataType\ListDataType
return Scalr\Service\Aws\Ec2\DataType\InstanceStateChangeList Returns the InstanceStateChangeList

unmonitorInstances() public method

Disables monitoring for a running instance
public unmonitorInstances ( ListDataType $instanceIdList ) : Scalr\Service\Aws\Ec2\DataType\MonitorInstancesResponseSetList
$instanceIdList Scalr\Service\Aws\DataType\ListDataType One or more instance IDs
return Scalr\Service\Aws\Ec2\DataType\MonitorInstancesResponseSetList Returns the MonitorInstancesResponseSetList

Property Details

$ec2 protected property

protected Ec2,Scalr\Service\Aws $ec2
return Scalr\Service\Aws\Ec2

$versiondate protected property

protected string $versiondate
return string