GtmDomain

Use the akamai.GtmDomain resource to create, configure, and import a GTM Domain, which is a basic building block of a traffic management configuration.

Note Import requires an ID with this format: existing_domain_name.

Argument reference

This resource supports these arguments:

  • contract - (Required) If creating a domain, the contract ID.
  • group - (Required) If creating a domain, the currently selected group ID.
  • name - (Required) The DNS name for a collection of GTM Properties.
  • type - (Required) Th type of GTM domain. Options include failover-only, static, weighted, basic, or full.
  • wait_on_complete - (Optional) A boolean that, if set to true, waits for transaction to complete.
  • comment - (Optional) A descriptive note about changes to the domain. The maximum is 4000 characters.
  • email_notification_list - (Optional) A list of email addresses to notify when a change is made to the domain.
  • default_timeout_penalty - (Optional) Specifies the timeout penalty score. Default is 25.
  • load_imbalance_percentage - (Optional) Indicates the percentage of load imbalance factor (LIF) for the domain.
  • default_ssl_client_private_key - (Optional) Specifies a Base64-encoded private key that corresponds with the TLS certificate for HTTPS, SMTPS, POPS, and TCPS liveness tests.
  • default_error_penalty - (Optional) Specifies the download penalty score. The default is 75. If the download encounters an error, the web agent computes a score that is either the download time in seconds or a penalty score.
  • cname_coalescing_enabled - (Optional) A boolean that if set to true, GTM collapses CNAME redirections in DNS answers when it knows the target of the CNAME.
  • load_feedback - (Optional) A boolean indicating whether one or more measurements of load (resources) are defined by you and supplied by each data center in real time to balance load.
  • default_ssl_client_certificate - (Optional) Specifies an optional Base64-encoded certificate that corresponds with the private key for TLS-based liveness tests (HTTPS, SMTPS, POPS, and TCPS).
  • end_user_mapping_enabled - (Optional) A boolean indicating whether whether the GTM Domain is using end user client subnet mapping.

Attribute reference

This resource returns these computed attributes in the state file:

  • default_unreachable_threshold
  • min_pingable_region_fraction
  • servermonitor_liveness_count
  • round_robin_prefix
  • servermonitor_load_count
  • ping_interval
  • max_ttl
  • default_health_max
  • map_update_interval
  • max_properties
  • max_resources
  • default_error_penalty
  • max_test_timeout
  • default_health_multiplier
  • servermonitor_pool
  • min_ttl
  • default_max_unreachable_penalty
  • default_health_threshold
  • min_test_interval
  • ping_packet_size

Schema reference

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

Example Usage

using Pulumi;
using Akamai = Pulumi.Akamai;

class MyStack : Stack
{
    public MyStack()
    {
        var demodomain = new Akamai.GtmDomain("demodomain", new Akamai.GtmDomainArgs
        {
            Comment = "some comment",
            Contract = "XXX",
            Group = "100",
            Type = "basic",
        });
    }

}
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.NewGtmDomain(ctx, "demodomain", &akamai.GtmDomainArgs{
			Comment:  pulumi.String("some comment"),
			Contract: pulumi.String("XXX"),
			Group:    pulumi.String("100"),
			Type:     pulumi.String("basic"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
import pulumi
import pulumi_akamai as akamai

demodomain = akamai.GtmDomain("demodomain",
    comment="some comment",
    contract="XXX",
    group="100",
    type="basic")
import * as pulumi from "@pulumi/pulumi";
import * as akamai from "@pulumi/akamai";

const demodomain = new akamai.GtmDomain("demodomain", {
    comment: "some comment",
    contract: "XXX",
    group: "100",
    type: "basic",
});

Create a GtmDomain Resource

new GtmDomain(name: string, args: GtmDomainArgs, opts?: CustomResourceOptions);
@overload
def GtmDomain(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              cname_coalescing_enabled: Optional[bool] = None,
              comment: Optional[str] = None,
              contract: Optional[str] = None,
              default_error_penalty: Optional[int] = None,
              default_ssl_client_certificate: Optional[str] = None,
              default_ssl_client_private_key: Optional[str] = None,
              default_timeout_penalty: Optional[int] = None,
              email_notification_lists: Optional[Sequence[str]] = None,
              end_user_mapping_enabled: Optional[bool] = None,
              group: Optional[str] = None,
              load_feedback: Optional[bool] = None,
              load_imbalance_percentage: Optional[float] = None,
              name: Optional[str] = None,
              type: Optional[str] = None,
              wait_on_complete: Optional[bool] = None)
@overload
def GtmDomain(resource_name: str,
              args: GtmDomainArgs,
              opts: Optional[ResourceOptions] = None)
func NewGtmDomain(ctx *Context, name string, args GtmDomainArgs, opts ...ResourceOption) (*GtmDomain, error)
public GtmDomain(string name, GtmDomainArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args GtmDomainArgs
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 GtmDomainArgs
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 GtmDomainArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args GtmDomainArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

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

Outputs

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

Look up an Existing GtmDomain Resource

Get an existing GtmDomain 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?: GtmDomainState, opts?: CustomResourceOptions): GtmDomain
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cname_coalescing_enabled: Optional[bool] = None,
        comment: Optional[str] = None,
        contract: Optional[str] = None,
        default_error_penalty: Optional[int] = None,
        default_health_max: Optional[float] = None,
        default_health_multiplier: Optional[float] = None,
        default_health_threshold: Optional[float] = None,
        default_max_unreachable_penalty: Optional[int] = None,
        default_ssl_client_certificate: Optional[str] = None,
        default_ssl_client_private_key: Optional[str] = None,
        default_timeout_penalty: Optional[int] = None,
        default_unreachable_threshold: Optional[float] = None,
        email_notification_lists: Optional[Sequence[str]] = None,
        end_user_mapping_enabled: Optional[bool] = None,
        group: Optional[str] = None,
        load_feedback: Optional[bool] = None,
        load_imbalance_percentage: Optional[float] = None,
        map_update_interval: Optional[int] = None,
        max_properties: Optional[int] = None,
        max_resources: Optional[int] = None,
        max_test_timeout: Optional[float] = None,
        max_ttl: Optional[int] = None,
        min_pingable_region_fraction: Optional[float] = None,
        min_test_interval: Optional[int] = None,
        min_ttl: Optional[int] = None,
        name: Optional[str] = None,
        ping_interval: Optional[int] = None,
        ping_packet_size: Optional[int] = None,
        round_robin_prefix: Optional[str] = None,
        servermonitor_liveness_count: Optional[int] = None,
        servermonitor_load_count: Optional[int] = None,
        servermonitor_pool: Optional[str] = None,
        type: Optional[str] = None,
        wait_on_complete: Optional[bool] = None) -> GtmDomain
func GetGtmDomain(ctx *Context, name string, id IDInput, state *GtmDomainState, opts ...ResourceOption) (*GtmDomain, error)
public static GtmDomain Get(string name, Input<string> id, GtmDomainState? 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:

cnameCoalescingEnabled boolean
comment string
contract string
defaultErrorPenalty number
defaultHealthMax number
defaultHealthMultiplier number
defaultHealthThreshold number
defaultMaxUnreachablePenalty number
defaultSslClientCertificate string
defaultSslClientPrivateKey string
defaultTimeoutPenalty number
defaultUnreachableThreshold number
emailNotificationLists string[]
endUserMappingEnabled boolean
group string
loadFeedback boolean
loadImbalancePercentage number
mapUpdateInterval number
maxProperties number
maxResources number
maxTestTimeout number
maxTtl number
minPingableRegionFraction number
minTestInterval number
minTtl number
name string
pingInterval number
pingPacketSize number
roundRobinPrefix string
servermonitorLivenessCount number
servermonitorLoadCount number
servermonitorPool string
type string
waitOnComplete boolean

Package Details

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