GtmDomain

akamai.GtmDomain provides the resource for creating, configuring and importing a gtm domain to integrate easily with your existing GTM infrastructure to provide a secure, high performance, highly available and scalable solution for Global Traffic Management. Note: Import requires an ID of the format: existing_domain_name

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 Programming Model docs.

Inputs

The GtmDomain resource accepts the following input properties:

Type string
Domain type
CnameCoalescingEnabled bool
Comment string
A descriptive comment
Contract string
The contract ID (if creating domain)
DefaultErrorPenalty int
DefaultSslClientCertificate string
DefaultSslClientPrivateKey string
DefaultTimeoutPenalty int
  • load_imbalance_percentage
  • default_ssl_client_private_key
EmailNotificationLists List<string>
EndUserMappingEnabled bool
Group string
The currently selected group ID (if creating domain)
LoadFeedback bool
  • default_ssl_client_certificate
LoadImbalancePercentage double
Name string
Domain name
WaitOnComplete bool
Wait for transaction to complete
Type string
Domain type
CnameCoalescingEnabled bool
Comment string
A descriptive comment
Contract string
The contract ID (if creating domain)
DefaultErrorPenalty int
DefaultSslClientCertificate string
DefaultSslClientPrivateKey string
DefaultTimeoutPenalty int
  • load_imbalance_percentage
  • default_ssl_client_private_key
EmailNotificationLists []string
EndUserMappingEnabled bool
Group string
The currently selected group ID (if creating domain)
LoadFeedback bool
  • default_ssl_client_certificate
LoadImbalancePercentage float64
Name string
Domain name
WaitOnComplete bool
Wait for transaction to complete
type string
Domain type
cnameCoalescingEnabled boolean
comment string
A descriptive comment
contract string
The contract ID (if creating domain)
defaultErrorPenalty number
defaultSslClientCertificate string
defaultSslClientPrivateKey string
defaultTimeoutPenalty number
  • load_imbalance_percentage
  • default_ssl_client_private_key
emailNotificationLists string[]
endUserMappingEnabled boolean
group string
The currently selected group ID (if creating domain)
loadFeedback boolean
  • default_ssl_client_certificate
loadImbalancePercentage number
name string
Domain name
waitOnComplete boolean
Wait for transaction to complete
type str
Domain type
cname_coalescing_enabled bool
comment str
A descriptive comment
contract str
The contract ID (if creating domain)
default_error_penalty int
default_ssl_client_certificate str
default_ssl_client_private_key str
default_timeout_penalty int
  • load_imbalance_percentage
  • default_ssl_client_private_key
email_notification_lists Sequence[str]
end_user_mapping_enabled bool
group str
The currently selected group ID (if creating domain)
load_feedback bool
  • default_ssl_client_certificate
load_imbalance_percentage float
name str
Domain name
wait_on_complete bool
Wait for transaction to complete

Outputs

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

DefaultHealthMax double
DefaultHealthMultiplier double
DefaultHealthThreshold double
DefaultMaxUnreachablePenalty int
DefaultUnreachableThreshold double
  • 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
Id string
The provider-assigned unique ID for this managed resource.
MapUpdateInterval int
MaxProperties int
MaxResources int
MaxTestTimeout double
MaxTtl int
MinPingableRegionFraction double
MinTestInterval int
MinTtl int
PingInterval int
PingPacketSize int
RoundRobinPrefix string
ServermonitorLivenessCount int
ServermonitorLoadCount int
ServermonitorPool string
DefaultHealthMax float64
DefaultHealthMultiplier float64
DefaultHealthThreshold float64
DefaultMaxUnreachablePenalty int
DefaultUnreachableThreshold float64
  • 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
Id string
The provider-assigned unique ID for this managed resource.
MapUpdateInterval int
MaxProperties int
MaxResources int
MaxTestTimeout float64
MaxTtl int
MinPingableRegionFraction float64
MinTestInterval int
MinTtl int
PingInterval int
PingPacketSize int
RoundRobinPrefix string
ServermonitorLivenessCount int
ServermonitorLoadCount int
ServermonitorPool string
defaultHealthMax number
defaultHealthMultiplier number
defaultHealthThreshold number
defaultMaxUnreachablePenalty number
defaultUnreachableThreshold number
  • 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
id string
The provider-assigned unique ID for this managed resource.
mapUpdateInterval number
maxProperties number
maxResources number
maxTestTimeout number
maxTtl number
minPingableRegionFraction number
minTestInterval number
minTtl number
pingInterval number
pingPacketSize number
roundRobinPrefix string
servermonitorLivenessCount number
servermonitorLoadCount number
servermonitorPool string
default_health_max float
default_health_multiplier float
default_health_threshold float
default_max_unreachable_penalty int
default_unreachable_threshold float
  • 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
id str
The provider-assigned unique ID for this managed resource.
map_update_interval int
max_properties int
max_resources int
max_test_timeout float
max_ttl int
min_pingable_region_fraction float
min_test_interval int
min_ttl int
ping_interval int
ping_packet_size int
round_robin_prefix str
servermonitor_liveness_count int
servermonitor_load_count int
servermonitor_pool str

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 bool
Comment string
A descriptive comment
Contract string
The contract ID (if creating domain)
DefaultErrorPenalty int
DefaultHealthMax double
DefaultHealthMultiplier double
DefaultHealthThreshold double
DefaultMaxUnreachablePenalty int
DefaultSslClientCertificate string
DefaultSslClientPrivateKey string
DefaultTimeoutPenalty int
  • load_imbalance_percentage
  • default_ssl_client_private_key
DefaultUnreachableThreshold double
  • 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
EmailNotificationLists List<string>
EndUserMappingEnabled bool
Group string
The currently selected group ID (if creating domain)
LoadFeedback bool
  • default_ssl_client_certificate
LoadImbalancePercentage double
MapUpdateInterval int
MaxProperties int
MaxResources int
MaxTestTimeout double
MaxTtl int
MinPingableRegionFraction double
MinTestInterval int
MinTtl int
Name string
Domain name
PingInterval int
PingPacketSize int
RoundRobinPrefix string
ServermonitorLivenessCount int
ServermonitorLoadCount int
ServermonitorPool string
Type string
Domain type
WaitOnComplete bool
Wait for transaction to complete
CnameCoalescingEnabled bool
Comment string
A descriptive comment
Contract string
The contract ID (if creating domain)
DefaultErrorPenalty int
DefaultHealthMax float64
DefaultHealthMultiplier float64
DefaultHealthThreshold float64
DefaultMaxUnreachablePenalty int
DefaultSslClientCertificate string
DefaultSslClientPrivateKey string
DefaultTimeoutPenalty int
  • load_imbalance_percentage
  • default_ssl_client_private_key
DefaultUnreachableThreshold float64
  • 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
EmailNotificationLists []string
EndUserMappingEnabled bool
Group string
The currently selected group ID (if creating domain)
LoadFeedback bool
  • default_ssl_client_certificate
LoadImbalancePercentage float64
MapUpdateInterval int
MaxProperties int
MaxResources int
MaxTestTimeout float64
MaxTtl int
MinPingableRegionFraction float64
MinTestInterval int
MinTtl int
Name string
Domain name
PingInterval int
PingPacketSize int
RoundRobinPrefix string
ServermonitorLivenessCount int
ServermonitorLoadCount int
ServermonitorPool string
Type string
Domain type
WaitOnComplete bool
Wait for transaction to complete
cnameCoalescingEnabled boolean
comment string
A descriptive comment
contract string
The contract ID (if creating domain)
defaultErrorPenalty number
defaultHealthMax number
defaultHealthMultiplier number
defaultHealthThreshold number
defaultMaxUnreachablePenalty number
defaultSslClientCertificate string
defaultSslClientPrivateKey string
defaultTimeoutPenalty number
  • load_imbalance_percentage
  • default_ssl_client_private_key
defaultUnreachableThreshold number
  • 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
emailNotificationLists string[]
endUserMappingEnabled boolean
group string
The currently selected group ID (if creating domain)
loadFeedback boolean
  • default_ssl_client_certificate
loadImbalancePercentage number
mapUpdateInterval number
maxProperties number
maxResources number
maxTestTimeout number
maxTtl number
minPingableRegionFraction number
minTestInterval number
minTtl number
name string
Domain name
pingInterval number
pingPacketSize number
roundRobinPrefix string
servermonitorLivenessCount number
servermonitorLoadCount number
servermonitorPool string
type string
Domain type
waitOnComplete boolean
Wait for transaction to complete
cname_coalescing_enabled bool
comment str
A descriptive comment
contract str
The contract ID (if creating domain)
default_error_penalty int
default_health_max float
default_health_multiplier float
default_health_threshold float
default_max_unreachable_penalty int
default_ssl_client_certificate str
default_ssl_client_private_key str
default_timeout_penalty int
  • load_imbalance_percentage
  • default_ssl_client_private_key
default_unreachable_threshold float
  • 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
email_notification_lists Sequence[str]
end_user_mapping_enabled bool
group str
The currently selected group ID (if creating domain)
load_feedback bool
  • default_ssl_client_certificate
load_imbalance_percentage float
map_update_interval int
max_properties int
max_resources int
max_test_timeout float
max_ttl int
min_pingable_region_fraction float
min_test_interval int
min_ttl int
name str
Domain name
ping_interval int
ping_packet_size int
round_robin_prefix str
servermonitor_liveness_count int
servermonitor_load_count int
servermonitor_pool str
type str
Domain type
wait_on_complete bool
Wait for transaction to complete

Package Details

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