Concepts

The following provides a roadmap of all the conceptual objects you deal with when interacting with the Cloudlets API.

  • Policies: For each Cloudlet instance on your contract, there can be any number of policies. A single policy is associated with a single property configuration. Policies are versioned. Within a policy version you define the rules that determine when the Cloudlet executes. Each policy is assigned a unique ID (policyId).

  • Properties: A property configuration includes all the rules for how to process end-user requests for either a specific web asset or a set of assets. For more information about properties, see the Property Manager API.

  • Policy version. A specific revision of a given policy (policyId). Policy version numbers start at 1 and increment as new versions are created for a policy. You may want to create a new version of a policy to support a different business requirement, or to test new functionality. When you activate a Cloudlet, you're activating a specific version of a Cloudlet policy. See the response object from the Get a policy version operation . If a policy version is being activated or has been activated it can't be modify it.

  • Groups: Within an account, there is a hierarchy of groups that control access to both properties and Cloudlets policies. If your Akamai username is not associated with the group (groupId) being used with this API, then the request fails. In addition, you can only associate a Cloudlet policy with a property that is in a compatible group, which can either be the same group, or be an ancestor of the policy's group.

  • Conditional Origins: A type of origin server that you can forward Cloudlets requests to. Conditional Origins are available for the following Cloudlets: Application Load Balancer, Audience Segmentation, Forward Rewrite, and Phased Release. The base rules for all Cloudlets Origins are set up in the Property Manager API. For Application Load Balancer, you use the Conditional Origin operations to set up and maintain load balancing configurations. For the other Cloudlets that support Conditional Origins, use List Associated Properties to view information about which Conditional Origins are associated with a particular Cloudlets policy version.