GuideReference
TrainingSupportCommunity
Guide

Property

akamai_property

Create, update, or remove a property configuration.

Pass the minimum arguments required in the declaration to create a property with a default set of rules. The defaults provide basic services and protections that you can either activate or edit.

To use the defaults:

  • Add a CP code and an origin hostname to the rules.
  • An edge hostname argument in an update to your property using this resource.
  • Activate your property.

To remove a configuration, run terraform destroy.

resource "akamai_property" "my_property" {
    name    	= "MyProperty"
    product_id  = "prd_Object_Delivery"
    contract_id = "C-0N7RAC7"
    group_id    = "12345"
}
resource "akamai_property" "my_property" {
    name    	= "MyProperty"
    product_id  = "prd_Object_Delivery"
    contract_id = "C-0N7RAC7"
    group_id    = "12345"
    rule_format = "v2023-05-30"
    rules       = file("${path.root}/property-snippets/main.json")
    hostnames {
      cname_from             = "example.com"
      cname_to 	             = "example.com.edgekey.net"
      cert_provisioning_type = "DEFAULT"
    }
}

Arguments

Pass at least a name for your property and your contract and product IDs to create a new property.

ArgumentRequiredDescription
name✔️A human-readable name you give to identify your property.
contract_id✔️Your contract ID.
group_id✔️Your group ID.
product_id✔️A product ID including the prd_ prefix. See Common identifiers for a list of product IDs.
hostnamesA mapping of public hostnames to edge hostnames. If used, include these additional required arguments:
  • cname_from. Your origin's hostname.
  • cname_to. The hostname for edge content.
  • cert_provisioning_type. Your certificate's provisioning type. Either CPS_MANAGED for custom certificates you provision or DEFAULT for certificates provisioned automatically.
rulesThe location of your rules. Use the path to a local file or a variable that represents the output of the Rules builder or Rules template data source.
rule_formatA versioned rule schema and set of available behaviors and criteria. If not provided, we apply the latest rule format by default.

Attributes

If you've not set an output method, the response only provides a property ID in the success message.

Setting an output method returns the property details you provided on create along with these additions.

AttributeDescription
idYour property's ID.
contract_idYour contract ID.
group_idYour group ID.
hostnamesA list of hostnames associated with your property.
nameThe name of your property.
product_idThe property's product ID.
property_idYour property's ID.
read_versionThe version of your property read.
rule_errorsAny errors returned by the API.
rule_warningsA list of any rule validation warnings.
rule_formatThe property rules' versioned rule schema and set of behaviors and criteria.
rulesA set of your property's rules.
version_notesA human-readable description about the returned property version.
latest_versionThe version of the property you've created or updated rules for. We use the latest version or create a new version if latest is not editable.
production_versionThe current property version active on the Akamai production network.
staging_versionThe current property version active on the Akamai staging network.
version_notesAdditional information about a property version.