PHP Class Scalr\Service\Aws\CloudFront\V20120701\CloudFrontApi

Implements CloudFront Low-Level API Actions.
Since: 01.02.2013
Author: Vitaliy Demidov ([email protected])
Inheritance: extends Scalr\Service\Aws\AbstractApi
Exibir arquivo Open project: scalr/scalr

Protected Properties

Property Type Description
$cloudFront Scalr\Service\Aws\CloudFront

Public Methods

Method Description
__construct ( Scalr\Service\Aws\CloudFront $cloudFront, Scalr\Service\Aws\Client\QueryClient\CloudFrontQueryClient $client ) Constructor
createDistribution ( Scalr\Service\Aws\CloudFront\DataType\DistributionConfigData | string $config ) : DistributionData POST Distribution action
deleteDistribution ( string $distributionId, string $eTag ) : boolean DELETE Distribution Config action
describeDistributions ( Scalr\Service\Aws\CloudFront\DataType\MarkerType $marker = null ) : Scalr\Service\Aws\CloudFront\DataType\DistributionList GET Distribution List action
getDistribution ( string $distributionId ) : DistributionData GET Distribution action
getDistributionConfig ( string $distributionId ) : Scalr\Service\Aws\CloudFront\DataType\DistributionConfigData GET Distribution Config action
getEntityManager ( ) : Scalr\Service\Aws\EntityManager Gets an EntityManager
setDistributionConfig ( string $distributionId, Scalr\Service\Aws\CloudFront\DataType\DistributionConfigData | string $config, string $eTag ) : DistributionData PUT Distribution Config action

Protected Methods

Method Description
_loadCacheBehaviorData ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\CloudFront\DataType\CacheBehaviorData Loads CacheBehaviorData from simple xml object
_loadCacheBehaviorList ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\CloudFront\DataType\CacheBehaviorList Parses CacheBehaviorList
_loadCustomOriginConfigData ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\CloudFront\DataType\CustomOriginConfigData Loads CustomOriginConfigData from simple xml object
_loadDistributionConfigAliasList ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\CloudFront\DataType\DistributionConfigAliasList Parses DistributionConfigAliasList
_loadDistributionConfigData ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\CloudFront\DataType\DistributionConfigData Loads DistributionConfigData from simple xml object
_loadDistributionConfigLoggingData ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\CloudFront\DataType\DistributionConfigLoggingData Loads DistributionConfigLoggingData from simple xml object
_loadDistributionConfigOriginList ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\CloudFront\DataType\DistributionConfigOriginList Parses DistributionConfigOriginList
_loadDistributionData ( SimpleXMLElement $v ) : DistributionData Loads DistributionData from simple xml object
_loadDistributionS3OriginConfigData ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\CloudFront\DataType\DistributionS3OriginConfigData Loads DistributionS3OriginConfigData from simple xml object
_loadForwardedValuesCookiesData ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\CloudFront\DataType\ForwardedValuesCookiesData Loads ForwardedValuesCookiesData from simple xml object
_loadForwardedValuesData ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\CloudFront\DataType\ForwardedValuesData Loads ForwardedValuesData from simple xml object
_loadKeyPairList ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\CloudFront\DataType\KeyPairList Parses KeyPairList
_loadTrustedSignerList ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\CloudFront\DataType\TrustedSignerList Parses TrustedSignerList
_loadWhitelistedCookieNamesList ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\CloudFront\DataType\WhitelistedCookieNamesList Parses WhitelistedCookieNamesList

Method Details

__construct() public method

Constructor
public __construct ( Scalr\Service\Aws\CloudFront $cloudFront, Scalr\Service\Aws\Client\QueryClient\CloudFrontQueryClient $client )
$cloudFront Scalr\Service\Aws\CloudFront CloudFront instance
$client Scalr\Service\Aws\Client\QueryClient\CloudFrontQueryClient Client Interface

_loadCacheBehaviorData() protected method

Loads CacheBehaviorData from simple xml object
protected _loadCacheBehaviorData ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\CloudFront\DataType\CacheBehaviorData
$sxml SimpleXMLElement
return Scalr\Service\Aws\CloudFront\DataType\CacheBehaviorData Returns CacheBehaviorData

_loadCacheBehaviorList() protected method

Parses CacheBehaviorList
protected _loadCacheBehaviorList ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\CloudFront\DataType\CacheBehaviorList
$sxml SimpleXMLElement
return Scalr\Service\Aws\CloudFront\DataType\CacheBehaviorList Returns CacheBehaviorList object

_loadCustomOriginConfigData() protected method

Loads CustomOriginConfigData from simple xml object
protected _loadCustomOriginConfigData ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\CloudFront\DataType\CustomOriginConfigData
$sxml SimpleXMLElement
return Scalr\Service\Aws\CloudFront\DataType\CustomOriginConfigData Returns CustomOriginConfigData

_loadDistributionConfigAliasList() protected method

Parses DistributionConfigAliasList
protected _loadDistributionConfigAliasList ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\CloudFront\DataType\DistributionConfigAliasList
$sxml SimpleXMLElement
return Scalr\Service\Aws\CloudFront\DataType\DistributionConfigAliasList Returns DistributionConfigAliasList object

_loadDistributionConfigData() protected method

Loads DistributionConfigData from simple xml object
protected _loadDistributionConfigData ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\CloudFront\DataType\DistributionConfigData
$sxml SimpleXMLElement
return Scalr\Service\Aws\CloudFront\DataType\DistributionConfigData Returns DistributionConfigData

_loadDistributionConfigLoggingData() protected method

Loads DistributionConfigLoggingData from simple xml object
protected _loadDistributionConfigLoggingData ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\CloudFront\DataType\DistributionConfigLoggingData
$sxml SimpleXMLElement
return Scalr\Service\Aws\CloudFront\DataType\DistributionConfigLoggingData Returns DistributionConfigLoggingData

_loadDistributionConfigOriginList() protected method

Parses DistributionConfigOriginList
protected _loadDistributionConfigOriginList ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\CloudFront\DataType\DistributionConfigOriginList
$sxml SimpleXMLElement
return Scalr\Service\Aws\CloudFront\DataType\DistributionConfigOriginList Returns DistributionConfigOriginList object

_loadDistributionData() protected method

Loads DistributionData from simple xml object
protected _loadDistributionData ( SimpleXMLElement $v ) : DistributionData
$v SimpleXMLElement
return Scalr\Service\Aws\CloudFront\DataType\DistributionData Returns DistributionData

_loadDistributionS3OriginConfigData() protected method

Loads DistributionS3OriginConfigData from simple xml object
protected _loadDistributionS3OriginConfigData ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\CloudFront\DataType\DistributionS3OriginConfigData
$sxml SimpleXMLElement
return Scalr\Service\Aws\CloudFront\DataType\DistributionS3OriginConfigData Returns DistributionS3OriginConfigData

_loadForwardedValuesCookiesData() protected method

Loads ForwardedValuesCookiesData from simple xml object
protected _loadForwardedValuesCookiesData ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\CloudFront\DataType\ForwardedValuesCookiesData
$sxml SimpleXMLElement
return Scalr\Service\Aws\CloudFront\DataType\ForwardedValuesCookiesData Returns ForwardedValuesCookiesData

_loadForwardedValuesData() protected method

Loads ForwardedValuesData from simple xml object
protected _loadForwardedValuesData ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\CloudFront\DataType\ForwardedValuesData
$sxml SimpleXMLElement
return Scalr\Service\Aws\CloudFront\DataType\ForwardedValuesData Returns ForwardedValuesData

_loadKeyPairList() protected method

Parses KeyPairList
protected _loadKeyPairList ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\CloudFront\DataType\KeyPairList
$sxml SimpleXMLElement
return Scalr\Service\Aws\CloudFront\DataType\KeyPairList Returns KeyPairList object

_loadTrustedSignerList() protected method

Parses TrustedSignerList
protected _loadTrustedSignerList ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\CloudFront\DataType\TrustedSignerList
$sxml SimpleXMLElement
return Scalr\Service\Aws\CloudFront\DataType\TrustedSignerList Returns TrustedSignerList object

_loadWhitelistedCookieNamesList() protected method

Parses WhitelistedCookieNamesList
protected _loadWhitelistedCookieNamesList ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\CloudFront\DataType\WhitelistedCookieNamesList
$sxml SimpleXMLElement
return Scalr\Service\Aws\CloudFront\DataType\WhitelistedCookieNamesList Returns WhitelistedCookieNamesList object

createDistribution() public method

This action creates a new download distribution. By default, you can create a combined total of up to 100 download and streaming distributions per AWS account
public createDistribution ( Scalr\Service\Aws\CloudFront\DataType\DistributionConfigData | string $config ) : DistributionData
$config Scalr\Service\Aws\CloudFront\DataType\DistributionConfigData | string distribution config object or XML document
return Scalr\Service\Aws\CloudFront\DataType\DistributionData Returns created distribution.

deleteDistribution() public method

DELETE Distribution Config action
public deleteDistribution ( string $distributionId, string $eTag ) : boolean
$distributionId string ID of the distribution.
$eTag string ETag that is retrieved from getDistributionConfig request.
return boolean Returns TRUE on success.

describeDistributions() public method

To list the distributions associated with your AWS account.
public describeDistributions ( Scalr\Service\Aws\CloudFront\DataType\MarkerType $marker = null ) : Scalr\Service\Aws\CloudFront\DataType\DistributionList
$marker Scalr\Service\Aws\CloudFront\DataType\MarkerType optional The query parameters.
return Scalr\Service\Aws\CloudFront\DataType\DistributionList Returns the list of Distributions.

getDistribution() public method

GET Distribution action
public getDistribution ( string $distributionId ) : DistributionData
$distributionId string ID of the distribution.
return Scalr\Service\Aws\CloudFront\DataType\DistributionData Returns distribution.

getDistributionConfig() public method

GET Distribution Config action
public getDistributionConfig ( string $distributionId ) : Scalr\Service\Aws\CloudFront\DataType\DistributionConfigData
$distributionId string ID of the distribution.
return Scalr\Service\Aws\CloudFront\DataType\DistributionConfigData Returns DistributionConfig object.

getEntityManager() public method

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

setDistributionConfig() public method

PUT Distribution Config action
public setDistributionConfig ( string $distributionId, Scalr\Service\Aws\CloudFront\DataType\DistributionConfigData | string $config, string $eTag ) : DistributionData
$distributionId string ID of the distribution.
$config Scalr\Service\Aws\CloudFront\DataType\DistributionConfigData | string Config for distribution. It accepts object or xml document.
$eTag string ETag that is retrieved from getDistributionConfig request.
return Scalr\Service\Aws\CloudFront\DataType\DistributionData Returns DistributionData object.

Property Details

$cloudFront protected_oe property

protected CloudFront,Scalr\Service\Aws $cloudFront
return Scalr\Service\Aws\CloudFront