Get started with Pulumi in a free one hour introductory workshop. Register Now
  1. Docs
  2. Reference
  3. API
  4. akamai
  5. properties
  6. PropertyVariables

PropertyVariables

The akamai.properties.PropertyVariables allows you to implement dynamic functionality. You can perform conditional logic based on the variable’s value, and catch any unforeseen errors that execute on the edge at runtime.

Typical uses for variables include:

  • Simplify configurations by reducing the number of rules and behaviors.
  • Improve self serviceability by replacing or extending advanced metadata.
  • Automate redirects, forward path rewrites, HTTP header and cookie manipulation.
  • Move origin functionality to the edge.

Example Usage

Basic usage:

using Pulumi;
using Akamai = Pulumi.Akamai;

class MyStack : Stack
{
    public MyStack()
    {
        var origin = new Akamai.Properties.PropertyVariables("origin", new Akamai.Properties.PropertyVariablesArgs
        {
            Variables = 
            {
                new Akamai.Properties.Inputs.PropertyVariablesVariableArgs
                {
                    Variables = 
                    {
                        new Akamai.Properties.Inputs.PropertyVariablesVariableVariableArgs
                        {
                            Description = "Origin Hostname",
                            Hidden = true,
                            Name = "PMUSER_ORIGIN",
                            Sensitive = true,
                            Value = "origin.example.org",
                        },
                    },
                },
            },
        });
    }

}

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.NewPropertyVariables(ctx, "origin", &properties.PropertyVariablesArgs{
            Variables: properties.PropertyVariablesVariableArray{
                &properties.PropertyVariablesVariableArgs{
                    Variables: properties.PropertyVariablesVariableVariableArray{
                        &properties.PropertyVariablesVariableVariableArgs{
                            Description: pulumi.String("Origin Hostname"),
                            Hidden:      pulumi.Bool(true),
                            Name:        pulumi.String("PMUSER_ORIGIN"),
                            Sensitive:   pulumi.Bool(true),
                            Value:       pulumi.String("origin.example.org"),
                        },
                    },
                },
            },
        })
        if err != nil {
            return err
        }
        return nil
    })
}
import pulumi
import pulumi_akamai as akamai

origin = akamai.properties.PropertyVariables("origin", variables=[{
    "variables": [{
        "description": "Origin Hostname",
        "hidden": True,
        "name": "PMUSER_ORIGIN",
        "sensitive": True,
        "value": "origin.example.org",
    }],
}])
import * as pulumi from "@pulumi/pulumi";
import * as akamai from "@pulumi/akamai";

const origin = new akamai.properties.PropertyVariables("origin", {
    variables: [{
        variables: [{
            description: "Origin Hostname",
            hidden: true,
            name: "PMUSER_ORIGIN",
            sensitive: true,
            value: "origin.example.org",
        }],
    }],
});

Create a PropertyVariables Resource

new PropertyVariables(name: string, args?: PropertyVariablesArgs, opts?: CustomResourceOptions);
def PropertyVariables(resource_name, opts=None, variables=None, __props__=None)
func NewPropertyVariables(ctx *Context, name string, args *PropertyVariablesArgs, opts ...ResourceOption) (*PropertyVariables, error)
public PropertyVariables(string name, PropertyVariablesArgs? args = null, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args PropertyVariablesArgs
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 PropertyVariablesArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args PropertyVariablesArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

PropertyVariables Resource Properties

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

Inputs

The PropertyVariables resource accepts the following input properties:

Variables List<PropertyVariablesVariableArgs>
Variables []PropertyVariablesVariable
variables PropertyVariablesVariable[]
variables List[PropertyVariablesVariable]

Outputs

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

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

JSON variables representation

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

JSON variables representation

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

JSON variables representation

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

JSON variables representation

Look up an Existing PropertyVariables Resource

Get an existing PropertyVariables 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?: PropertyVariablesState, opts?: CustomResourceOptions): PropertyVariables
static get(resource_name, id, opts=None, json=None, variables=None, __props__=None)
func GetPropertyVariables(ctx *Context, name string, id IDInput, state *PropertyVariablesState, opts ...ResourceOption) (*PropertyVariables, error)
public static PropertyVariables Get(string name, Input<string> id, PropertyVariablesState? 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:

Json string

JSON variables representation

Variables List<PropertyVariablesVariableArgs>
Json string

JSON variables representation

Variables []PropertyVariablesVariable
json string

JSON variables representation

variables PropertyVariablesVariable[]
json str

JSON variables representation

variables List[PropertyVariablesVariable]

Supporting Types

PropertyVariablesVariable

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.

Variables List<PropertyVariablesVariableVariableArgs>
Variables []PropertyVariablesVariableVariable
variables PropertyVariablesVariableVariable[]
variables List[PropertyVariablesVariableVariable]

PropertyVariablesVariableVariable

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.

Hidden bool

— (Required) Whether to hide the variable when debugging requests

Name string

— (Required) The name of the variable.

Sensitive bool

— (Required) Whether to obscure the value when debugging requests

Description string

— (Optional) A human-readable description

Value string

— (Required) The default value to assign to the variable

Hidden bool

— (Required) Whether to hide the variable when debugging requests

Name string

— (Required) The name of the variable.

Sensitive bool

— (Required) Whether to obscure the value when debugging requests

Description string

— (Optional) A human-readable description

Value string

— (Required) The default value to assign to the variable

hidden boolean

— (Required) Whether to hide the variable when debugging requests

name string

— (Required) The name of the variable.

sensitive boolean

— (Required) Whether to obscure the value when debugging requests

description string

— (Optional) A human-readable description

value string

— (Required) The default value to assign to the variable

hidden bool

— (Required) Whether to hide the variable when debugging requests

name str

— (Required) The name of the variable.

sensitive bool

— (Required) Whether to obscure the value when debugging requests

description str

— (Optional) A human-readable description

value str

— (Required) The default value to assign to the variable

Package Details

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