GtmResource

The akamai.GtmResource lets you create, configure, and import a GTM resource. In GTM, a resource is anything you can measure whose scarcity affects load balancing. Examples of resources include bandwidth, CPU load average, database queries per second, or disk operations per second.

Note Import requires an ID with this format: existing_domain_name: existing_resource_name.

Argument reference

This resource supports these arguments:

  • domain - (Required) DNS name for the GTM Domain set that includes this property.
  • name - (Required) A descriptive label for the GTM resource.
  • aggregation_type - (Required) Specifies how GTM handles different load numbers when multiple load servers are used for a data center or property.
  • type - (Required) Indicates the kind of load_object format used to determine the load on the resource.
  • wait_on_complete - (Optional) A boolean indicating whether to wait for transaction to complete. Set to true by default.
  • resource_instance - (Optional) (multiple allowed) Contains information about the resources that constrain the properties within the data center. You can have multiple resource_instance entries. Requires these arguments:
    • datacenter_id - (Optional) A unique identifier for an existing data center in the domain.
    • load_object - (Optional) Identifies the load object file used to report real-time information about the current load, maximum allowable load, and target load on each resource.
    • load_object_port - (Optional) Specifies the TCP port of the load_object.
    • load_servers - (Optional) (List) Specifies a list of servers from which to request the load object.
    • use_default_load_object - (Optional) A boolean that indicates whether a default load_object is used for the resources.
  • host_header - (Optional) Optionally specifies the host header used when fetching the load object.
  • least_squares_decay - (Optional) For internal use only. Unless Akamai indicates otherwise, omit the value or set it to null.
  • upper_bound - (Optional) An optional sanity check that specifies the maximum allowed value for any component of the load object.
  • description - (Optional) A descriptive note to help you track what the resource constrains.
  • leader_string - (Optional) Specifies the text that comes before the load_object.
  • constrained_property - (Optional) Specifies the name of the property that this resource constrains, enter ** to constrain all properties.
  • load_imbalance_percent - (Optional) Indicates the percent of load imbalance factor (LIF) for the property.
  • max_u_multiplicative_increment - (Optional) For Akamai internal use only. You can omit the value or set it to null.
  • decay_rate - (Optional) For Akamai internal use only. You can omit the value or set it to null.

Schema reference

You can download the GTM Resource backing schema from the Global Traffic Management API page.

Example Usage

using Pulumi;
using Akamai = Pulumi.Akamai;

class MyStack : Stack
{
    public MyStack()
    {
        var demoResource = new Akamai.GtmResource("demoResource", new Akamai.GtmResourceArgs
        {
            AggregationType = "latest",
            Domain = "demo_domain.akadns.net",
            Type = "XML load object via HTTP",
        });
    }

}
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.NewGtmResource(ctx, "demoResource", &akamai.GtmResourceArgs{
			AggregationType: pulumi.String("latest"),
			Domain:          pulumi.String("demo_domain.akadns.net"),
			Type:            pulumi.String("XML load object via HTTP"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
import pulumi
import pulumi_akamai as akamai

demo_resource = akamai.GtmResource("demoResource",
    aggregation_type="latest",
    domain="demo_domain.akadns.net",
    type="XML load object via HTTP")
import * as pulumi from "@pulumi/pulumi";
import * as akamai from "@pulumi/akamai";

const demoResource = new akamai.GtmResource("demo_resource", {
    aggregationType: "latest",
    domain: "demo_domain.akadns.net",
    type: "XML load object via HTTP",
});

Create a GtmResource Resource

new GtmResource(name: string, args: GtmResourceArgs, opts?: CustomResourceOptions);
@overload
def GtmResource(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                aggregation_type: Optional[str] = None,
                constrained_property: Optional[str] = None,
                decay_rate: Optional[float] = None,
                description: Optional[str] = None,
                domain: Optional[str] = None,
                host_header: Optional[str] = None,
                leader_string: Optional[str] = None,
                least_squares_decay: Optional[float] = None,
                load_imbalance_percentage: Optional[float] = None,
                max_u_multiplicative_increment: Optional[float] = None,
                name: Optional[str] = None,
                resource_instances: Optional[Sequence[GtmResourceResourceInstanceArgs]] = None,
                type: Optional[str] = None,
                upper_bound: Optional[int] = None,
                wait_on_complete: Optional[bool] = None)
@overload
def GtmResource(resource_name: str,
                args: GtmResourceArgs,
                opts: Optional[ResourceOptions] = None)
func NewGtmResource(ctx *Context, name string, args GtmResourceArgs, opts ...ResourceOption) (*GtmResource, error)
public GtmResource(string name, GtmResourceArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args GtmResourceArgs
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 GtmResourceArgs
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 GtmResourceArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args GtmResourceArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

GtmResource 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 GtmResource resource accepts the following input properties:

Outputs

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

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

Look up an Existing GtmResource Resource

Get an existing GtmResource 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?: GtmResourceState, opts?: CustomResourceOptions): GtmResource
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        aggregation_type: Optional[str] = None,
        constrained_property: Optional[str] = None,
        decay_rate: Optional[float] = None,
        description: Optional[str] = None,
        domain: Optional[str] = None,
        host_header: Optional[str] = None,
        leader_string: Optional[str] = None,
        least_squares_decay: Optional[float] = None,
        load_imbalance_percentage: Optional[float] = None,
        max_u_multiplicative_increment: Optional[float] = None,
        name: Optional[str] = None,
        resource_instances: Optional[Sequence[GtmResourceResourceInstanceArgs]] = None,
        type: Optional[str] = None,
        upper_bound: Optional[int] = None,
        wait_on_complete: Optional[bool] = None) -> GtmResource
func GetGtmResource(ctx *Context, name string, id IDInput, state *GtmResourceState, opts ...ResourceOption) (*GtmResource, error)
public static GtmResource Get(string name, Input<string> id, GtmResourceState? 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:

Supporting Types

GtmResourceResourceInstance

Package Details

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