Get started with Pulumi in a free one hour introductory workshop. Register Now

Property

The akamai.properties.Property resource represents an Akamai property configuration, allowing you to create, update, and activate properties on the Akamai platform.

Example Usage

Basic usage:

using Pulumi;
using Akamai = Pulumi.Akamai;

class MyStack : Stack
{
    public MyStack()
    {
        var example = new Akamai.Properties.Property("example", new Akamai.Properties.PropertyArgs
        {
            Contacts = 
            {
                "user@example.org",
            },
            Contract = "ctr_####",
            CpCode = "cpc_#####",
            Group = "grp_####",
            Hostnames = 
            {
                { "example.org", "example.org.edgesuite.net" },
                { "sub.example.org", "sub.example.org.edgesuite.net" },
                { "www.example.org", "example.org.edgesuite.net" },
            },
            Product = "prd_SPM",
            RuleFormat = "v2018-02-27",
            Rules = data.Local_file.Terraform_demo.Content,
            Variables = akamai_property_variables.Origin.Json,
        });
    }

}
package main

import (
    "github.com/pulumi/pulumi-akamai/sdk/go/akamai/properties"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        _, err := properties.NewProperty(ctx, "example", &properties.PropertyArgs{
            Contacts: pulumi.StringArray{
                pulumi.String("user@example.org"),
            },
            Contract: pulumi.String("ctr_####"),
            CpCode:   pulumi.String("cpc_#####"),
            Group:    pulumi.String("grp_####"),
            Hostnames: pulumi.StringMap{
                "example.org":     pulumi.String("example.org.edgesuite.net"),
                "sub.example.org": pulumi.String("sub.example.org.edgesuite.net"),
                "www.example.org": pulumi.String("example.org.edgesuite.net"),
            },
            Product:    pulumi.String("prd_SPM"),
            RuleFormat: pulumi.String("v2018-02-27"),
            Rules:      pulumi.Any(data.Local_file.Terraform - demo.Content),
            Variables:  pulumi.Any(akamai_property_variables.Origin.Json),
        })
        if err != nil {
            return err
        }
        return nil
    })
}
import pulumi
import pulumi_akamai as akamai

example = akamai.properties.Property("example",
    contacts=["user@example.org"],
    contract="ctr_####",
    cp_code="cpc_#####",
    group="grp_####",
    hostnames={
        "example.org": "example.org.edgesuite.net",
        "sub.example.org": "sub.example.org.edgesuite.net",
        "www.example.org": "example.org.edgesuite.net",
    },
    product="prd_SPM",
    rule_format="v2018-02-27",
    rules=data["local_file"]["terraform-demo"]["content"],
    variables=akamai_property_variables["origin"]["json"])
import * as pulumi from "@pulumi/pulumi";
import * as akamai from "@pulumi/akamai";

const example = new akamai.properties.Property("example", {
    contacts: ["user@example.org"],
    contract: "ctr_####",
    cpCode: "cpc_#####",
    group: "grp_####",
    hostnames: {
        "example.org": "example.org.edgesuite.net",
        "sub.example.org": "sub.example.org.edgesuite.net",
        "www.example.org": "example.org.edgesuite.net",
    },
    product: "prd_SPM",
    ruleFormat: "v2018-02-27",
    rules: local_file_terraform_demo.content,
    variables: akamai_property_variables_origin.json,
});

Create a Property Resource

def Property(resource_name, opts=None, contacts=None, contract=None, cp_code=None, group=None, hostnames=None, is_secure=None, name=None, origins=None, product=None, rule_format=None, rules=None, variables=None, __props__=None)
func NewProperty(ctx *Context, name string, args PropertyArgs, opts ...ResourceOption) (*Property, error)
public Property(string name, PropertyArgs args, CustomResourceOptions? opts = null)
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.
opts ResourceOptions
A bag of options that control this 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.

Property Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The Property resource accepts the following input properties:

Contacts List<string>

— (Required) One or more email addresses to inform about activation changes.

Hostnames Dictionary<string, string>

— (Required) A map of public hostnames to edge hostnames (e.g. {"example.org" = "example.org.edgesuite.net"})

Contract string

— (Optional) The contract ID.

CpCode string

— (Optional) The CP Code id or name to use (or create). Required unless a cpCode behavior is present in the default rule.

Group string

— (Optional) The group ID.

IsSecure bool

— (Optional) Whether the property is a secure (Enhanced TLS) property or not.

Name string

— (Required) The property name.

Origins List<PropertyOriginArgs>

— (Optional) The property origin (an origin must be specified to activate a property, but may be defined in your rules block).

Product string

— (Optional) The product ID. (Default: prd_SPM for Ion)

RuleFormat string

— (Optional) The rule format to use (more).

Rules string

— (Required) A JSON encoded string of property rules (see: akamai.properties.PropertyRules)

Variables string

— (Optional) A JSON encoded string of property manager variable definitions (see: akamai.properties.PropertyVariables)

Contacts []string

— (Required) One or more email addresses to inform about activation changes.

Hostnames map[string]string

— (Required) A map of public hostnames to edge hostnames (e.g. {"example.org" = "example.org.edgesuite.net"})

Contract string

— (Optional) The contract ID.

CpCode string

— (Optional) The CP Code id or name to use (or create). Required unless a cpCode behavior is present in the default rule.

Group string

— (Optional) The group ID.

IsSecure bool

— (Optional) Whether the property is a secure (Enhanced TLS) property or not.

Name string

— (Required) The property name.

Origins []PropertyOrigin

— (Optional) The property origin (an origin must be specified to activate a property, but may be defined in your rules block).

Product string

— (Optional) The product ID. (Default: prd_SPM for Ion)

RuleFormat string

— (Optional) The rule format to use (more).

Rules string

— (Required) A JSON encoded string of property rules (see: akamai.properties.PropertyRules)

Variables string

— (Optional) A JSON encoded string of property manager variable definitions (see: akamai.properties.PropertyVariables)

contacts string[]

— (Required) One or more email addresses to inform about activation changes.

hostnames {[key: string]: string}

— (Required) A map of public hostnames to edge hostnames (e.g. {"example.org" = "example.org.edgesuite.net"})

contract string

— (Optional) The contract ID.

cpCode string

— (Optional) The CP Code id or name to use (or create). Required unless a cpCode behavior is present in the default rule.

group string

— (Optional) The group ID.

isSecure boolean

— (Optional) Whether the property is a secure (Enhanced TLS) property or not.

name string

— (Required) The property name.

origins PropertyOrigin[]

— (Optional) The property origin (an origin must be specified to activate a property, but may be defined in your rules block).

product string

— (Optional) The product ID. (Default: prd_SPM for Ion)

ruleFormat string

— (Optional) The rule format to use (more).

rules string

— (Required) A JSON encoded string of property rules (see: akamai.properties.PropertyRules)

variables string

— (Optional) A JSON encoded string of property manager variable definitions (see: akamai.properties.PropertyVariables)

contacts List[str]

— (Required) One or more email addresses to inform about activation changes.

hostnames Dict[str, str]

— (Required) A map of public hostnames to edge hostnames (e.g. {"example.org" = "example.org.edgesuite.net"})

contract str

— (Optional) The contract ID.

cp_code str

— (Optional) The CP Code id or name to use (or create). Required unless a cpCode behavior is present in the default rule.

group str

— (Optional) The group ID.

is_secure bool

— (Optional) Whether the property is a secure (Enhanced TLS) property or not.

name str

— (Required) The property name.

origins List[PropertyOrigin]

— (Optional) The property origin (an origin must be specified to activate a property, but may be defined in your rules block).

product str

— (Optional) The product ID. (Default: prd_SPM for Ion)

rule_format str

— (Optional) The rule format to use (more).

rules str

— (Required) A JSON encoded string of property rules (see: akamai.properties.PropertyRules)

variables str

— (Optional) A JSON encoded string of property manager variable definitions (see: akamai.properties.PropertyVariables)

Outputs

All input properties are implicitly available as output properties. Additionally, the Property resource produces the following output properties:

Account string

— the Account ID under which the property is created.

EdgeHostnames Dictionary<string, string>

— the final public hostname to edge hostname map

Id string
The provider-assigned unique ID for this managed resource.
ProductionVersion int

— the current version of the property active on the production network.

Rulessha string
StagingVersion int

— the current version of the property active on the staging network.

Version int

— the current version of the property config.

Account string

— the Account ID under which the property is created.

EdgeHostnames map[string]string

— the final public hostname to edge hostname map

Id string
The provider-assigned unique ID for this managed resource.
ProductionVersion int

— the current version of the property active on the production network.

Rulessha string
StagingVersion int

— the current version of the property active on the staging network.

Version int

— the current version of the property config.

account string

— the Account ID under which the property is created.

edgeHostnames {[key: string]: string}

— the final public hostname to edge hostname map

id string
The provider-assigned unique ID for this managed resource.
productionVersion number

— the current version of the property active on the production network.

rulessha string
stagingVersion number

— the current version of the property active on the staging network.

version number

— the current version of the property config.

account str

— the Account ID under which the property is created.

edge_hostnames Dict[str, str]

— the final public hostname to edge hostname map

id str
The provider-assigned unique ID for this managed resource.
production_version float

— the current version of the property active on the production network.

rulessha str
staging_version float

— the current version of the property active on the staging network.

version float

— the current version of the property config.

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
static get(resource_name, id, opts=None, account=None, contacts=None, contract=None, cp_code=None, edge_hostnames=None, group=None, hostnames=None, is_secure=None, name=None, origins=None, product=None, production_version=None, rule_format=None, rules=None, rulessha=None, staging_version=None, variables=None, version=None, __props__=None)
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)
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.

The following state arguments are supported:

Account string

— the Account ID under which the property is created.

Contacts List<string>

— (Required) One or more email addresses to inform about activation changes.

Contract string

— (Optional) The contract ID.

CpCode string

— (Optional) The CP Code id or name to use (or create). Required unless a cpCode behavior is present in the default rule.

EdgeHostnames Dictionary<string, string>

— the final public hostname to edge hostname map

Group string

— (Optional) The group ID.

Hostnames Dictionary<string, string>

— (Required) A map of public hostnames to edge hostnames (e.g. {"example.org" = "example.org.edgesuite.net"})

IsSecure bool

— (Optional) Whether the property is a secure (Enhanced TLS) property or not.

Name string

— (Required) The property name.

Origins List<PropertyOriginArgs>

— (Optional) The property origin (an origin must be specified to activate a property, but may be defined in your rules block).

Product string

— (Optional) The product ID. (Default: prd_SPM for Ion)

ProductionVersion int

— the current version of the property active on the production network.

RuleFormat string

— (Optional) The rule format to use (more).

Rules string

— (Required) A JSON encoded string of property rules (see: akamai.properties.PropertyRules)

Rulessha string
StagingVersion int

— the current version of the property active on the staging network.

Variables string

— (Optional) A JSON encoded string of property manager variable definitions (see: akamai.properties.PropertyVariables)

Version int

— the current version of the property config.

Account string

— the Account ID under which the property is created.

Contacts []string

— (Required) One or more email addresses to inform about activation changes.

Contract string

— (Optional) The contract ID.

CpCode string

— (Optional) The CP Code id or name to use (or create). Required unless a cpCode behavior is present in the default rule.

EdgeHostnames map[string]string

— the final public hostname to edge hostname map

Group string

— (Optional) The group ID.

Hostnames map[string]string

— (Required) A map of public hostnames to edge hostnames (e.g. {"example.org" = "example.org.edgesuite.net"})

IsSecure bool

— (Optional) Whether the property is a secure (Enhanced TLS) property or not.

Name string

— (Required) The property name.

Origins []PropertyOrigin

— (Optional) The property origin (an origin must be specified to activate a property, but may be defined in your rules block).

Product string

— (Optional) The product ID. (Default: prd_SPM for Ion)

ProductionVersion int

— the current version of the property active on the production network.

RuleFormat string

— (Optional) The rule format to use (more).

Rules string

— (Required) A JSON encoded string of property rules (see: akamai.properties.PropertyRules)

Rulessha string
StagingVersion int

— the current version of the property active on the staging network.

Variables string

— (Optional) A JSON encoded string of property manager variable definitions (see: akamai.properties.PropertyVariables)

Version int

— the current version of the property config.

account string

— the Account ID under which the property is created.

contacts string[]

— (Required) One or more email addresses to inform about activation changes.

contract string

— (Optional) The contract ID.

cpCode string

— (Optional) The CP Code id or name to use (or create). Required unless a cpCode behavior is present in the default rule.

edgeHostnames {[key: string]: string}

— the final public hostname to edge hostname map

group string

— (Optional) The group ID.

hostnames {[key: string]: string}

— (Required) A map of public hostnames to edge hostnames (e.g. {"example.org" = "example.org.edgesuite.net"})

isSecure boolean

— (Optional) Whether the property is a secure (Enhanced TLS) property or not.

name string

— (Required) The property name.

origins PropertyOrigin[]

— (Optional) The property origin (an origin must be specified to activate a property, but may be defined in your rules block).

product string

— (Optional) The product ID. (Default: prd_SPM for Ion)

productionVersion number

— the current version of the property active on the production network.

ruleFormat string

— (Optional) The rule format to use (more).

rules string

— (Required) A JSON encoded string of property rules (see: akamai.properties.PropertyRules)

rulessha string
stagingVersion number

— the current version of the property active on the staging network.

variables string

— (Optional) A JSON encoded string of property manager variable definitions (see: akamai.properties.PropertyVariables)

version number

— the current version of the property config.

account str

— the Account ID under which the property is created.

contacts List[str]

— (Required) One or more email addresses to inform about activation changes.

contract str

— (Optional) The contract ID.

cp_code str

— (Optional) The CP Code id or name to use (or create). Required unless a cpCode behavior is present in the default rule.

edge_hostnames Dict[str, str]

— the final public hostname to edge hostname map

group str

— (Optional) The group ID.

hostnames Dict[str, str]

— (Required) A map of public hostnames to edge hostnames (e.g. {"example.org" = "example.org.edgesuite.net"})

is_secure bool

— (Optional) Whether the property is a secure (Enhanced TLS) property or not.

name str

— (Required) The property name.

origins List[PropertyOrigin]

— (Optional) The property origin (an origin must be specified to activate a property, but may be defined in your rules block).

product str

— (Optional) The product ID. (Default: prd_SPM for Ion)

production_version float

— the current version of the property active on the production network.

rule_format str

— (Optional) The rule format to use (more).

rules str

— (Required) A JSON encoded string of property rules (see: akamai.properties.PropertyRules)

rulessha str
staging_version float

— the current version of the property active on the staging network.

variables str

— (Optional) A JSON encoded string of property manager variable definitions (see: akamai.properties.PropertyVariables)

version float

— the current version of the property config.

Supporting Types

PropertyOrigin

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

Hostname string

— (Required) The origin hostname.

CacheKeyHostname string

— (Optional) The hostname uses for the cache key. (default: ORIGIN_HOSTNAME).

Compress bool

— (Optional, boolean) Whether origin supports gzip compression (default: false).

EnableTrueClientIp bool

— (Optional, boolean) Whether the X-True-Client-IP header should be sent to origin (default: false).

ForwardHostname string

— (Optional) The value for the Hostname header sent to origin. (default: ORIGIN_HOSTNAME).

Port int

— (Optional) The origin port to connect to (default: 80).

Hostname string

— (Required) The origin hostname.

CacheKeyHostname string

— (Optional) The hostname uses for the cache key. (default: ORIGIN_HOSTNAME).

Compress bool

— (Optional, boolean) Whether origin supports gzip compression (default: false).

EnableTrueClientIp bool

— (Optional, boolean) Whether the X-True-Client-IP header should be sent to origin (default: false).

ForwardHostname string

— (Optional) The value for the Hostname header sent to origin. (default: ORIGIN_HOSTNAME).

Port int

— (Optional) The origin port to connect to (default: 80).

hostname string

— (Required) The origin hostname.

cacheKeyHostname string

— (Optional) The hostname uses for the cache key. (default: ORIGIN_HOSTNAME).

compress boolean

— (Optional, boolean) Whether origin supports gzip compression (default: false).

enableTrueClientIp boolean

— (Optional, boolean) Whether the X-True-Client-IP header should be sent to origin (default: false).

forwardHostname string

— (Optional) The value for the Hostname header sent to origin. (default: ORIGIN_HOSTNAME).

port number

— (Optional) The origin port to connect to (default: 80).

hostname str

— (Required) The origin hostname.

cacheKeyHostname str

— (Optional) The hostname uses for the cache key. (default: ORIGIN_HOSTNAME).

compress bool

— (Optional, boolean) Whether origin supports gzip compression (default: false).

enableTrueClientIp bool

— (Optional, boolean) Whether the X-True-Client-IP header should be sent to origin (default: false).

forwardHostname str

— (Optional) The value for the Hostname header sent to origin. (default: ORIGIN_HOSTNAME).

port float

— (Optional) The origin port to connect to (default: 80).

Package Details

Repository
https://github.com/pulumi/pulumi-akamai
License
Apache-2.0
Notes
This Pulumi package is based on the akamai Terraform Provider.