Akamai
Property
The akamai.Property
resource represents an Akamai property configuration.
This resource lets you to create, update, and activate properties on the
Akamai platform.
Akamai’s edge network caches your web assets near to servers that request them. A property provides the main way to control how edge servers respond to various kinds of requests for those assets. Properties apply rules to a set of hostnames, and you can only apply one property at a time to any given hostname. Each property is assigned to a product, which determines which behaviors you can use. Each property’s default rule needs a valid content provider (CP) code assigned to bill and report for the service.
Note In version 0.10 and earlier of this resource, it also controlled content provider (CP) codes, origin settings, rules, and hostname associations. Starting with version 1.0.0, this logic is broken out into individual resources.
Example Usage
using Pulumi;
using Akamai = Pulumi.Akamai;
class MyStack : Stack
{
public MyStack()
{
var example = new Akamai.Property("example", new Akamai.PropertyArgs
{
ProductId = "prd_SPM",
ContractId = @var.Contractid,
GroupId = @var.Groupid,
Hostnames =
{
new Akamai.Inputs.PropertyHostnameArgs
{
CnameFrom = "example.com",
CnameTo = "example.com.edgekey.net",
CertProvisioningType = "DEFAULT",
},
new Akamai.Inputs.PropertyHostnameArgs
{
CnameFrom = "www.example.com",
CnameTo = "example.com.edgesuite.net",
CertProvisioningType = "CPS_MANAGED",
},
},
RuleFormat = "v2020-03-04",
Rules = data.Akamai_property_rules_template.Example.Json,
});
}
}
package main
import (
"github.com/pulumi/pulumi-akamai/sdk/v2/go/akamai"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := akamai.NewProperty(ctx, "example", &akamai.PropertyArgs{
ProductId: pulumi.String("prd_SPM"),
ContractId: pulumi.Any(_var.Contractid),
GroupId: pulumi.Any(_var.Groupid),
Hostnames: PropertyHostnameArray{
&PropertyHostnameArgs{
CnameFrom: pulumi.String("example.com"),
CnameTo: pulumi.String("example.com.edgekey.net"),
CertProvisioningType: pulumi.String("DEFAULT"),
},
&PropertyHostnameArgs{
CnameFrom: pulumi.String("www.example.com"),
CnameTo: pulumi.String("example.com.edgesuite.net"),
CertProvisioningType: pulumi.String("CPS_MANAGED"),
},
},
RuleFormat: pulumi.String("v2020-03-04"),
Rules: pulumi.Any(data.Akamai_property_rules_template.Example.Json),
})
if err != nil {
return err
}
return nil
})
}
Coming soon!
import pulumi
import pulumi_akamai as akamai
example = akamai.Property("example",
product_id="prd_SPM",
contract_id=var["contractid"],
group_id=var["groupid"],
hostnames=[
akamai.PropertyHostnameArgs(
cname_from="example.com",
cname_to="example.com.edgekey.net",
cert_provisioning_type="DEFAULT",
),
akamai.PropertyHostnameArgs(
cname_from="www.example.com",
cname_to="example.com.edgesuite.net",
cert_provisioning_type="CPS_MANAGED",
),
],
rule_format="v2020-03-04",
rules=data["akamai_property_rules_template"]["example"]["json"])
import * as pulumi from "@pulumi/pulumi";
import * as akamai from "@pulumi/akamai";
const example = new akamai.Property("example", {
productId: "prd_SPM",
contractId: _var.contractid,
groupId: _var.groupid,
hostnames: [
{
cnameFrom: "example.com",
cnameTo: "example.com.edgekey.net",
certProvisioningType: "DEFAULT",
},
{
cnameFrom: "www.example.com",
cnameTo: "example.com.edgesuite.net",
certProvisioningType: "CPS_MANAGED",
},
],
ruleFormat: "v2020-03-04",
rules: data.akamai_property_rules_template.example.json,
});
Coming soon!
Create a Property Resource
new Property(name: string, args?: PropertyArgs, opts?: CustomResourceOptions);
@overload
def Property(resource_name: str,
opts: Optional[ResourceOptions] = None,
contacts: Optional[Sequence[str]] = None,
contract: Optional[str] = None,
contract_id: Optional[str] = None,
cp_code: Optional[str] = None,
group: Optional[str] = None,
group_id: Optional[str] = None,
hostnames: Optional[Sequence[PropertyHostnameArgs]] = None,
is_secure: Optional[bool] = None,
name: Optional[str] = None,
origins: Optional[Sequence[PropertyOriginArgs]] = None,
product: Optional[str] = None,
product_id: Optional[str] = None,
rule_format: Optional[str] = None,
rule_warnings: Optional[Sequence[PropertyRuleWarningArgs]] = None,
rules: Optional[str] = None,
variables: Optional[str] = None)
@overload
def Property(resource_name: str,
args: Optional[PropertyArgs] = None,
opts: Optional[ResourceOptions] = None)
func NewProperty(ctx *Context, name string, args *PropertyArgs, opts ...ResourceOption) (*Property, error)
public Property(string name, PropertyArgs? args = null, CustomResourceOptions? opts = null)
public Property(String name, PropertyArgs args)
public Property(String name, PropertyArgs args, CustomResourceOptions options)
type: akamai:Property
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args PropertyArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args PropertyArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args PropertyArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args PropertyArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args PropertyArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Property Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The Property resource accepts the following input properties:
- Contacts List<string>
The setting "contact" has been deprecated.
- Contract string
Replaced by
contract_id
. Maintained for legacy purposes.The setting "contract" has been deprecated.
- Contract
Id string - (Required) A contract's unique ID, including the
ctr_
prefix.- Cp
Code string The setting "cp_code" has been deprecated.
- Group string
Replaced by
group_id
. Maintained for legacy purposes.The setting "group" has been deprecated.
- Group
Id string - (Required) A group's unique ID, including the
grp_
prefix.- Hostnames
List<Property
Hostname Args> A mapping of public hostnames to edge hostnames. See the
akamai.getPropertyHostnames
data source for details on the necessary DNS configuration.- Is
Secure bool The setting "is_secure" has been deprecated.
- Name string
The property name.
- Origins
List<Property
Origin Args> The setting "origin" has been deprecated.
- Product string
Optional argument replaced by the now required
product_id
. Maintained for legacy purposes.The setting "product" has been deprecated.
- Product
Id string Product ID to be assigned to the Property
- Rule
Format string The rule format to use. Uses the latest rule format by default.
- Rule
Warnings List<PropertyRule Warning Args> Rule warnings will not be set in state anymore
- Rules string
A JSON-encoded rule tree for a given property. For this argument, you need to enter a complete JSON rule tree, unless you set up a series of JSON templates. See the
akamai.getPropertyRules
data source.- Variables string
The setting "variables" has been deprecated.
- Contacts []string
The setting "contact" has been deprecated.
- Contract string
Replaced by
contract_id
. Maintained for legacy purposes.The setting "contract" has been deprecated.
- Contract
Id string - (Required) A contract's unique ID, including the
ctr_
prefix.- Cp
Code string The setting "cp_code" has been deprecated.
- Group string
Replaced by
group_id
. Maintained for legacy purposes.The setting "group" has been deprecated.
- Group
Id string - (Required) A group's unique ID, including the
grp_
prefix.- Hostnames
[]Property
Hostname Args A mapping of public hostnames to edge hostnames. See the
akamai.getPropertyHostnames
data source for details on the necessary DNS configuration.- Is
Secure bool The setting "is_secure" has been deprecated.
- Name string
The property name.
- Origins
[]Property
Origin Args The setting "origin" has been deprecated.
- Product string
Optional argument replaced by the now required
product_id
. Maintained for legacy purposes.The setting "product" has been deprecated.
- Product
Id string Product ID to be assigned to the Property
- Rule
Format string The rule format to use. Uses the latest rule format by default.
- Rule
Warnings []PropertyRule Warning Args Rule warnings will not be set in state anymore
- Rules string
A JSON-encoded rule tree for a given property. For this argument, you need to enter a complete JSON rule tree, unless you set up a series of JSON templates. See the
akamai.getPropertyRules
data source.- Variables string
The setting "variables" has been deprecated.
- contacts
List
The setting "contact" has been deprecated.
- contract String
Replaced by
contract_id
. Maintained for legacy purposes.The setting "contract" has been deprecated.
- contract
Id String - (Required) A contract's unique ID, including the
ctr_
prefix.- cp
Code String The setting "cp_code" has been deprecated.
- group String
Replaced by
group_id
. Maintained for legacy purposes.The setting "group" has been deprecated.
- group
Id String - (Required) A group's unique ID, including the
grp_
prefix.- hostnames
List
Hostname Args> A mapping of public hostnames to edge hostnames. See the
akamai.getPropertyHostnames
data source for details on the necessary DNS configuration.- is
Secure Boolean The setting "is_secure" has been deprecated.
- name String
The property name.
- origins
List
Origin Args> The setting "origin" has been deprecated.
- product String
Optional argument replaced by the now required
product_id
. Maintained for legacy purposes.The setting "product" has been deprecated.
- product
Id String Product ID to be assigned to the Property
- rule
Format String The rule format to use. Uses the latest rule format by default.
- rule
Warnings ListRule Warning Args> Rule warnings will not be set in state anymore
- rules String
A JSON-encoded rule tree for a given property. For this argument, you need to enter a complete JSON rule tree, unless you set up a series of JSON templates. See the
akamai.getPropertyRules
data source.- variables String
The setting "variables" has been deprecated.
- contacts string[]
The setting "contact" has been deprecated.
- contract string
Replaced by
contract_id
. Maintained for legacy purposes.The setting "contract" has been deprecated.
- contract
Id string - (Required) A contract's unique ID, including the
ctr_
prefix.- cp
Code string The setting "cp_code" has been deprecated.
- group string
Replaced by
group_id
. Maintained for legacy purposes.The setting "group" has been deprecated.
- group
Id string - (Required) A group's unique ID, including the
grp_
prefix.- hostnames
Property
Hostname Args[] A mapping of public hostnames to edge hostnames. See the
akamai.getPropertyHostnames
data source for details on the necessary DNS configuration.- is
Secure boolean The setting "is_secure" has been deprecated.
- name string
The property name.
- origins
Property
Origin Args[] The setting "origin" has been deprecated.
- product string
Optional argument replaced by the now required
product_id
. Maintained for legacy purposes.The setting "product" has been deprecated.
- product
Id string Product ID to be assigned to the Property
- rule
Format string The rule format to use. Uses the latest rule format by default.
- rule
Warnings PropertyRule Warning Args[] Rule warnings will not be set in state anymore
- rules string
A JSON-encoded rule tree for a given property. For this argument, you need to enter a complete JSON rule tree, unless you set up a series of JSON templates. See the
akamai.getPropertyRules
data source.- variables string
The setting "variables" has been deprecated.
- contacts Sequence[str]
The setting "contact" has been deprecated.
- contract str
Replaced by
contract_id
. Maintained for legacy purposes.The setting "contract" has been deprecated.
- contract_
id str - (Required) A contract's unique ID, including the
ctr_
prefix.- cp_
code str The setting "cp_code" has been deprecated.
- group str
Replaced by
group_id
. Maintained for legacy purposes.The setting "group" has been deprecated.
- group_
id str - (Required) A group's unique ID, including the
grp_
prefix.- hostnames
Sequence[Property
Hostname Args] A mapping of public hostnames to edge hostnames. See the
akamai.getPropertyHostnames
data source for details on the necessary DNS configuration.- is_
secure bool The setting "is_secure" has been deprecated.
- name str
The property name.
- origins
Sequence[Property
Origin Args] The setting "origin" has been deprecated.
- product str
Optional argument replaced by the now required
product_id
. Maintained for legacy purposes.The setting "product" has been deprecated.
- product_
id str Product ID to be assigned to the Property
- rule_
format str The rule format to use. Uses the latest rule format by default.
- rule_
warnings Sequence[PropertyRule Warning Args] Rule warnings will not be set in state anymore
- rules str
A JSON-encoded rule tree for a given property. For this argument, you need to enter a complete JSON rule tree, unless you set up a series of JSON templates. See the
akamai.getPropertyRules
data source.- variables str
The setting "variables" has been deprecated.
- contacts
List
The setting "contact" has been deprecated.
- contract String
Replaced by
contract_id
. Maintained for legacy purposes.The setting "contract" has been deprecated.
- contract
Id String - (Required) A contract's unique ID, including the
ctr_
prefix.- cp
Code String The setting "cp_code" has been deprecated.
- group String
Replaced by
group_id
. Maintained for legacy purposes.The setting "group" has been deprecated.
- group
Id String - (Required) A group's unique ID, including the
grp_
prefix.- hostnames
List
A mapping of public hostnames to edge hostnames. See the
akamai.getPropertyHostnames
data source for details on the necessary DNS configuration.- is
Secure Boolean The setting "is_secure" has been deprecated.
- name String
The property name.
- origins
List
The setting "origin" has been deprecated.
- product String
Optional argument replaced by the now required
product_id
. Maintained for legacy purposes.The setting "product" has been deprecated.
- product
Id String Product ID to be assigned to the Property
- rule
Format String The rule format to use. Uses the latest rule format by default.
- rule
Warnings List Rule warnings will not be set in state anymore
- rules String
A JSON-encoded rule tree for a given property. For this argument, you need to enter a complete JSON rule tree, unless you set up a series of JSON templates. See the
akamai.getPropertyRules
data source.- variables String
The setting "variables" has been deprecated.
Outputs
All input properties are implicitly available as output properties. Additionally, the Property resource produces the following output properties:
- Id string
The provider-assigned unique ID for this managed resource.
- Latest
Version int The version of the property you've created or updated rules for. The Akamai Provider always uses the latest version or creates a new version if latest is not editable.
- Production
Version int The current version of the property active on the Akamai production network.
- Read
Version int Required property's version to be read
- Rule
Errors List<PropertyRule Error> The contents of
errors
field returned by the API. For more information see Errors in the PAPI documentation.- Staging
Version int The current version of the property active on the Akamai staging network.
- Id string
The provider-assigned unique ID for this managed resource.
- Latest
Version int The version of the property you've created or updated rules for. The Akamai Provider always uses the latest version or creates a new version if latest is not editable.
- Production
Version int The current version of the property active on the Akamai production network.
- Read
Version int Required property's version to be read
- Rule
Errors []PropertyRule Error The contents of
errors
field returned by the API. For more information see Errors in the PAPI documentation.- Staging
Version int The current version of the property active on the Akamai staging network.
- id String
The provider-assigned unique ID for this managed resource.
- latest
Version Integer The version of the property you've created or updated rules for. The Akamai Provider always uses the latest version or creates a new version if latest is not editable.
- production
Version Integer The current version of the property active on the Akamai production network.
- read
Version Integer Required property's version to be read
- rule
Errors ListRule Error> The contents of
errors
field returned by the API. For more information see Errors in the PAPI documentation.- staging
Version Integer The current version of the property active on the Akamai staging network.
- id string
The provider-assigned unique ID for this managed resource.
- latest
Version number The version of the property you've created or updated rules for. The Akamai Provider always uses the latest version or creates a new version if latest is not editable.
- production
Version number The current version of the property active on the Akamai production network.
- read
Version number Required property's version to be read
- rule
Errors PropertyRule Error[] The contents of
errors
field returned by the API. For more information see Errors in the PAPI documentation.- staging
Version number The current version of the property active on the Akamai staging network.
- id str
The provider-assigned unique ID for this managed resource.
- latest_
version int The version of the property you've created or updated rules for. The Akamai Provider always uses the latest version or creates a new version if latest is not editable.
- production_
version int The current version of the property active on the Akamai production network.
- read_
version int Required property's version to be read
- rule_
errors Sequence[PropertyRule Error] The contents of
errors
field returned by the API. For more information see Errors in the PAPI documentation.- staging_
version int The current version of the property active on the Akamai staging network.
- id String
The provider-assigned unique ID for this managed resource.
- latest
Version Number The version of the property you've created or updated rules for. The Akamai Provider always uses the latest version or creates a new version if latest is not editable.
- production
Version Number The current version of the property active on the Akamai production network.
- read
Version Number Required property's version to be read
- rule
Errors List The contents of
errors
field returned by the API. For more information see Errors in the PAPI documentation.- staging
Version Number The current version of the property active on the Akamai staging network.
Look up an Existing Property Resource
Get an existing Property resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: PropertyState, opts?: CustomResourceOptions): Property
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
contacts: Optional[Sequence[str]] = None,
contract: Optional[str] = None,
contract_id: Optional[str] = None,
cp_code: Optional[str] = None,
group: Optional[str] = None,
group_id: Optional[str] = None,
hostnames: Optional[Sequence[PropertyHostnameArgs]] = None,
is_secure: Optional[bool] = None,
latest_version: Optional[int] = None,
name: Optional[str] = None,
origins: Optional[Sequence[PropertyOriginArgs]] = None,
product: Optional[str] = None,
product_id: Optional[str] = None,
production_version: Optional[int] = None,
read_version: Optional[int] = None,
rule_errors: Optional[Sequence[PropertyRuleErrorArgs]] = None,
rule_format: Optional[str] = None,
rule_warnings: Optional[Sequence[PropertyRuleWarningArgs]] = None,
rules: Optional[str] = None,
staging_version: Optional[int] = None,
variables: Optional[str] = None) -> Property
func GetProperty(ctx *Context, name string, id IDInput, state *PropertyState, opts ...ResourceOption) (*Property, error)
public static Property Get(string name, Input<string> id, PropertyState? state, CustomResourceOptions? opts = null)
public static Property get(String name, Output<String> id, PropertyState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Contacts List<string>
The setting "contact" has been deprecated.
- Contract string
Replaced by
contract_id
. Maintained for legacy purposes.The setting "contract" has been deprecated.
- Contract
Id string - (Required) A contract's unique ID, including the
ctr_
prefix.- Cp
Code string The setting "cp_code" has been deprecated.
- Group string
Replaced by
group_id
. Maintained for legacy purposes.The setting "group" has been deprecated.
- Group
Id string - (Required) A group's unique ID, including the
grp_
prefix.- Hostnames
List<Property
Hostname Args> A mapping of public hostnames to edge hostnames. See the
akamai.getPropertyHostnames
data source for details on the necessary DNS configuration.- Is
Secure bool The setting "is_secure" has been deprecated.
- Latest
Version int The version of the property you've created or updated rules for. The Akamai Provider always uses the latest version or creates a new version if latest is not editable.
- Name string
The property name.
- Origins
List<Property
Origin Args> The setting "origin" has been deprecated.
- Product string
Optional argument replaced by the now required
product_id
. Maintained for legacy purposes.The setting "product" has been deprecated.
- Product
Id string Product ID to be assigned to the Property
- Production
Version int The current version of the property active on the Akamai production network.
- Read
Version int Required property's version to be read
- Rule
Errors List<PropertyRule Error Args> The contents of
errors
field returned by the API. For more information see Errors in the PAPI documentation.- Rule
Format string The rule format to use. Uses the latest rule format by default.
- Rule
Warnings List<PropertyRule Warning Args> Rule warnings will not be set in state anymore
- Rules string
A JSON-encoded rule tree for a given property. For this argument, you need to enter a complete JSON rule tree, unless you set up a series of JSON templates. See the
akamai.getPropertyRules
data source.- Staging
Version int The current version of the property active on the Akamai staging network.
- Variables string
The setting "variables" has been deprecated.
- Contacts []string
The setting "contact" has been deprecated.
- Contract string
Replaced by
contract_id
. Maintained for legacy purposes.The setting "contract" has been deprecated.
- Contract
Id string - (Required) A contract's unique ID, including the
ctr_
prefix.- Cp
Code string The setting "cp_code" has been deprecated.
- Group string
Replaced by
group_id
. Maintained for legacy purposes.The setting "group" has been deprecated.
- Group
Id string - (Required) A group's unique ID, including the
grp_
prefix.- Hostnames
[]Property
Hostname Args A mapping of public hostnames to edge hostnames. See the
akamai.getPropertyHostnames
data source for details on the necessary DNS configuration.- Is
Secure bool The setting "is_secure" has been deprecated.
- Latest
Version int The version of the property you've created or updated rules for. The Akamai Provider always uses the latest version or creates a new version if latest is not editable.
- Name string
The property name.
- Origins
[]Property
Origin Args The setting "origin" has been deprecated.
- Product string
Optional argument replaced by the now required
product_id
. Maintained for legacy purposes.The setting "product" has been deprecated.
- Product
Id string Product ID to be assigned to the Property
- Production
Version int The current version of the property active on the Akamai production network.
- Read
Version int Required property's version to be read
- Rule
Errors []PropertyRule Error Args The contents of
errors
field returned by the API. For more information see Errors in the PAPI documentation.- Rule
Format string The rule format to use. Uses the latest rule format by default.
- Rule
Warnings []PropertyRule Warning Args Rule warnings will not be set in state anymore
- Rules string
A JSON-encoded rule tree for a given property. For this argument, you need to enter a complete JSON rule tree, unless you set up a series of JSON templates. See the
akamai.getPropertyRules
data source.- Staging
Version int The current version of the property active on the Akamai staging network.
- Variables string
The setting "variables" has been deprecated.
- contacts
List
The setting "contact" has been deprecated.
- contract String
Replaced by
contract_id
. Maintained for legacy purposes.The setting "contract" has been deprecated.
- contract
Id String - (Required) A contract's unique ID, including the
ctr_
prefix.- cp
Code String The setting "cp_code" has been deprecated.
- group String
Replaced by
group_id
. Maintained for legacy purposes.The setting "group" has been deprecated.
- group
Id String - (Required) A group's unique ID, including the
grp_
prefix.- hostnames
List
Hostname Args> A mapping of public hostnames to edge hostnames. See the
akamai.getPropertyHostnames
data source for details on the necessary DNS configuration.- is
Secure Boolean The setting "is_secure" has been deprecated.
- latest
Version Integer The version of the property you've created or updated rules for. The Akamai Provider always uses the latest version or creates a new version if latest is not editable.
- name String
The property name.
- origins
List
Origin Args> The setting "origin" has been deprecated.
- product String
Optional argument replaced by the now required
product_id
. Maintained for legacy purposes.The setting "product" has been deprecated.
- product
Id String Product ID to be assigned to the Property
- production
Version Integer The current version of the property active on the Akamai production network.
- read
Version Integer Required property's version to be read
- rule
Errors ListRule Error Args> The contents of
errors
field returned by the API. For more information see Errors in the PAPI documentation.- rule
Format String The rule format to use. Uses the latest rule format by default.
- rule
Warnings ListRule Warning Args> Rule warnings will not be set in state anymore
- rules String
A JSON-encoded rule tree for a given property. For this argument, you need to enter a complete JSON rule tree, unless you set up a series of JSON templates. See the
akamai.getPropertyRules
data source.- staging
Version Integer The current version of the property active on the Akamai staging network.
- variables String
The setting "variables" has been deprecated.
- contacts string[]
The setting "contact" has been deprecated.
- contract string
Replaced by
contract_id
. Maintained for legacy purposes.The setting "contract" has been deprecated.
- contract
Id string - (Required) A contract's unique ID, including the
ctr_
prefix.- cp
Code string The setting "cp_code" has been deprecated.
- group string
Replaced by
group_id
. Maintained for legacy purposes.The setting "group" has been deprecated.
- group
Id string - (Required) A group's unique ID, including the
grp_
prefix.- hostnames
Property
Hostname Args[] A mapping of public hostnames to edge hostnames. See the
akamai.getPropertyHostnames
data source for details on the necessary DNS configuration.- is
Secure boolean The setting "is_secure" has been deprecated.
- latest
Version number The version of the property you've created or updated rules for. The Akamai Provider always uses the latest version or creates a new version if latest is not editable.
- name string
The property name.
- origins
Property
Origin Args[] The setting "origin" has been deprecated.
- product string
Optional argument replaced by the now required
product_id
. Maintained for legacy purposes.The setting "product" has been deprecated.
- product
Id string Product ID to be assigned to the Property
- production
Version number The current version of the property active on the Akamai production network.
- read
Version number Required property's version to be read
- rule
Errors PropertyRule Error Args[] The contents of
errors
field returned by the API. For more information see Errors in the PAPI documentation.- rule
Format string The rule format to use. Uses the latest rule format by default.
- rule
Warnings PropertyRule Warning Args[] Rule warnings will not be set in state anymore
- rules string
A JSON-encoded rule tree for a given property. For this argument, you need to enter a complete JSON rule tree, unless you set up a series of JSON templates. See the
akamai.getPropertyRules
data source.- staging
Version number The current version of the property active on the Akamai staging network.
- variables string
The setting "variables" has been deprecated.
- contacts Sequence[str]
The setting "contact" has been deprecated.
- contract str
Replaced by
contract_id
. Maintained for legacy purposes.The setting "contract" has been deprecated.
- contract_
id str - (Required) A contract's unique ID, including the
ctr_
prefix.- cp_
code str The setting "cp_code" has been deprecated.
- group str
Replaced by
group_id
. Maintained for legacy purposes.The setting "group" has been deprecated.
- group_
id str - (Required) A group's unique ID, including the
grp_
prefix.- hostnames
Sequence[Property
Hostname Args] A mapping of public hostnames to edge hostnames. See the
akamai.getPropertyHostnames
data source for details on the necessary DNS configuration.- is_
secure bool The setting "is_secure" has been deprecated.
- latest_
version int The version of the property you've created or updated rules for. The Akamai Provider always uses the latest version or creates a new version if latest is not editable.
- name str
The property name.
- origins
Sequence[Property
Origin Args] The setting "origin" has been deprecated.
- product str
Optional argument replaced by the now required
product_id
. Maintained for legacy purposes.The setting "product" has been deprecated.
- product_
id str Product ID to be assigned to the Property
- production_
version int The current version of the property active on the Akamai production network.
- read_
version int Required property's version to be read
- rule_
errors Sequence[PropertyRule Error Args] The contents of
errors
field returned by the API. For more information see Errors in the PAPI documentation.- rule_
format str The rule format to use. Uses the latest rule format by default.
- rule_
warnings Sequence[PropertyRule Warning Args] Rule warnings will not be set in state anymore
- rules str
A JSON-encoded rule tree for a given property. For this argument, you need to enter a complete JSON rule tree, unless you set up a series of JSON templates. See the
akamai.getPropertyRules
data source.- staging_
version int The current version of the property active on the Akamai staging network.
- variables str
The setting "variables" has been deprecated.
- contacts
List
The setting "contact" has been deprecated.
- contract String
Replaced by
contract_id
. Maintained for legacy purposes.The setting "contract" has been deprecated.
- contract
Id String - (Required) A contract's unique ID, including the
ctr_
prefix.- cp
Code String The setting "cp_code" has been deprecated.
- group String
Replaced by
group_id
. Maintained for legacy purposes.The setting "group" has been deprecated.
- group
Id String - (Required) A group's unique ID, including the
grp_
prefix.- hostnames
List
A mapping of public hostnames to edge hostnames. See the
akamai.getPropertyHostnames
data source for details on the necessary DNS configuration.- is
Secure Boolean The setting "is_secure" has been deprecated.
- latest
Version Number The version of the property you've created or updated rules for. The Akamai Provider always uses the latest version or creates a new version if latest is not editable.
- name String
The property name.
- origins
List
The setting "origin" has been deprecated.
- product String
Optional argument replaced by the now required
product_id
. Maintained for legacy purposes.The setting "product" has been deprecated.
- product
Id String Product ID to be assigned to the Property
- production
Version Number The current version of the property active on the Akamai production network.
- read
Version Number Required property's version to be read
- rule
Errors List The contents of
errors
field returned by the API. For more information see Errors in the PAPI documentation.- rule
Format String The rule format to use. Uses the latest rule format by default.
- rule
Warnings List Rule warnings will not be set in state anymore
- rules String
A JSON-encoded rule tree for a given property. For this argument, you need to enter a complete JSON rule tree, unless you set up a series of JSON templates. See the
akamai.getPropertyRules
data source.- staging
Version Number The current version of the property active on the Akamai staging network.
- variables String
The setting "variables" has been deprecated.
Supporting Types
PropertyHostname
- Cert
Provisioning stringType The certificate's provisioning type, either the default
CPS_MANAGED
type for the custom certificates you provision with the Certificate Provisioning System (CPS), orDEFAULT
for certificates provisioned automatically.- Cname
From string A string containing the original origin's hostname. For example,
"example.org"
.- Cname
To string A string containing the hostname for edge content. For example,
"example.org.edgesuite.net"
.- Cert
Statuses List<PropertyHostname Cert Status> - Cname
Type string - Edge
Hostname stringId
- Cert
Provisioning stringType The certificate's provisioning type, either the default
CPS_MANAGED
type for the custom certificates you provision with the Certificate Provisioning System (CPS), orDEFAULT
for certificates provisioned automatically.- Cname
From string A string containing the original origin's hostname. For example,
"example.org"
.- Cname
To string A string containing the hostname for edge content. For example,
"example.org.edgesuite.net"
.- Cert
Statuses []PropertyHostname Cert Status - Cname
Type string - Edge
Hostname stringId
- cert
Provisioning StringType The certificate's provisioning type, either the default
CPS_MANAGED
type for the custom certificates you provision with the Certificate Provisioning System (CPS), orDEFAULT
for certificates provisioned automatically.- cname
From String A string containing the original origin's hostname. For example,
"example.org"
.- cname
To String A string containing the hostname for edge content. For example,
"example.org.edgesuite.net"
.- cert
Statuses ListHostname Cert Status> - cname
Type String - edge
Hostname StringId
- cert
Provisioning stringType The certificate's provisioning type, either the default
CPS_MANAGED
type for the custom certificates you provision with the Certificate Provisioning System (CPS), orDEFAULT
for certificates provisioned automatically.- cname
From string A string containing the original origin's hostname. For example,
"example.org"
.- cname
To string A string containing the hostname for edge content. For example,
"example.org.edgesuite.net"
.- cert
Statuses PropertyHostname Cert Status[] - cname
Type string - edge
Hostname stringId
- cert_
provisioning_ strtype The certificate's provisioning type, either the default
CPS_MANAGED
type for the custom certificates you provision with the Certificate Provisioning System (CPS), orDEFAULT
for certificates provisioned automatically.- cname_
from str A string containing the original origin's hostname. For example,
"example.org"
.- cname_
to str A string containing the hostname for edge content. For example,
"example.org.edgesuite.net"
.- cert_
statuses Sequence[PropertyHostname Cert Status] - cname_
type str - edge_
hostname_ strid
- cert
Provisioning StringType The certificate's provisioning type, either the default
CPS_MANAGED
type for the custom certificates you provision with the Certificate Provisioning System (CPS), orDEFAULT
for certificates provisioned automatically.- cname
From String A string containing the original origin's hostname. For example,
"example.org"
.- cname
To String A string containing the hostname for edge content. For example,
"example.org.edgesuite.net"
.- cert
Statuses List - cname
Type String - edge
Hostname StringId
PropertyHostnameCertStatus
- Hostname string
- Production
Status string - Staging
Status string - Target string
- Hostname string
- Production
Status string - Staging
Status string - Target string
- hostname String
- production
Status String - staging
Status String - target String
- hostname string
- production
Status string - staging
Status string - target string
- hostname str
- production_
status str - staging_
status str - target str
- hostname String
- production
Status String - staging
Status String - target String
PropertyOrigin
- Cache
Key stringHostname - Compress bool
- Enable
True boolClient Ip - Forward
Hostname string - Hostname string
- Port int
- Cache
Key stringHostname - Compress bool
- Enable
True boolClient Ip - Forward
Hostname string - Hostname string
- Port int
- cache
Key StringHostname - compress Boolean
- enable
True BooleanClient Ip - forward
Hostname String - hostname String
- port Integer
- cache
Key stringHostname - compress boolean
- enable
True booleanClient Ip - forward
Hostname string - hostname string
- port number
- cache_
key_ strhostname - compress bool
- enable_
true_ boolclient_ ip - forward_
hostname str - hostname str
- port int
- cache
Key StringHostname - compress Boolean
- enable
True BooleanClient Ip - forward
Hostname String - hostname String
- port Number
PropertyRuleError
- Behavior
Name string - Detail string
- Error
Location string - Instance string
- Status
Code int - Title string
- Type string
- Behavior
Name string - Detail string
- Error
Location string - Instance string
- Status
Code int - Title string
- Type string
- behavior
Name String - detail String
- error
Location String - instance String
- status
Code Integer - title String
- type String
- behavior
Name string - detail string
- error
Location string - instance string
- status
Code number - title string
- type string
- behavior_
name str - detail str
- error_
location str - instance str
- status_
code int - title str
- type str
- behavior
Name String - detail String
- error
Location String - instance String
- status
Code Number - title String
- type String
PropertyRuleWarning
- Behavior
Name string - Detail string
- Error
Location string - Instance string
- Status
Code int - Title string
- Type string
- Behavior
Name string - Detail string
- Error
Location string - Instance string
- Status
Code int - Title string
- Type string
- behavior
Name String - detail String
- error
Location String - instance String
- status
Code Integer - title String
- type String
- behavior
Name string - detail string
- error
Location string - instance string
- status
Code number - title string
- type string
- behavior_
name str - detail str
- error_
location str - instance str
- status_
code int - title str
- type str
- behavior
Name String - detail String
- error
Location String - instance String
- status
Code Number - title String
- type String
Import
Basic Usagehcl resource “akamai_property” “example” {
(resource arguments)
} You can import the latest Akamai property version by using either the property_id
or a comma-delimited string of the property, contract, and group IDs. You’ll need to enter the string of IDs if the property belongs to multiple groups or contracts. If using the string of IDs, you need to enter them in this orderproperty_id,contract_id,group_id
To import a specific property version, pass additional parameters, either* LATEST
to import the latest version of the property, regardless of whether it’s active or not. This works the same as providing just the property_id
or a string of the property, contract, and group IDs, which is the default behavior. * PRODUCTION
, PROD
, or P
to import the latest version activated on the production environment. * STAGING
, STAGE
, STAG
, or S
to import the latest version activated on the staging environment. * Version number or version number with the ver_
prefix to import a specific property version. For example 3
and ver_3
correspond to the same version number. Here are some examples for the latest property version
$ pulumi import akamai:index/property:Property example prp_123
Or
$ pulumi import akamai:index/property:Property example prp_123,ctr_1-AB123,grp_123
Here are some examples for the latest active property version on the production network
$ pulumi import akamai:index/property:Property example prp_123,P
Or
$ pulumi import akamai:index/property:Property example prp_123,ctr_1-AB123,grp_123,PROD
Here are some examples for the specific property version
$ pulumi import akamai:index/property:Property example prp_123,3
Or
$ pulumi import akamai:index/property:Property example prp_123,ctr_1-AB123,grp_123,ver_3
Package Details
- Repository
- https://github.com/pulumi/pulumi-akamai
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
akamai
Terraform Provider.