Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Akamai
  3. API Docs
  4. GtmDomain
Akamai v8.0.0 published on Saturday, Mar 1, 2025 by Pulumi
pulumi/pulumi-akamai

akamai.GtmDomain

Explore with Pulumi AI

Akamai v8.0.0 published on Saturday, Mar 1, 2025 by Pulumi
pulumi/pulumi-akamai

Create GtmDomain Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new GtmDomain(name: string, args: GtmDomainArgs, opts?: CustomResourceOptions);
@overload
def GtmDomain(resource_name: str,
              args: GtmDomainArgs,
              opts: Optional[ResourceOptions] = None)

@overload
def GtmDomain(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              type: Optional[str] = None,
              end_user_mapping_enabled: Optional[bool] = None,
              email_notification_lists: Optional[Sequence[str]] = None,
              default_error_penalty: Optional[int] = None,
              default_ssl_client_certificate: Optional[str] = None,
              group: Optional[str] = None,
              default_timeout_penalty: Optional[int] = None,
              contract: Optional[str] = None,
              cname_coalescing_enabled: Optional[bool] = None,
              default_ssl_client_private_key: Optional[str] = None,
              load_feedback: Optional[bool] = None,
              load_imbalance_percentage: Optional[float] = None,
              name: Optional[str] = None,
              sign_and_serve: Optional[bool] = None,
              sign_and_serve_algorithm: Optional[str] = None,
              comment: Optional[str] = None,
              wait_on_complete: Optional[bool] = None)
func NewGtmDomain(ctx *Context, name string, args GtmDomainArgs, opts ...ResourceOption) (*GtmDomain, error)
public GtmDomain(string name, GtmDomainArgs args, CustomResourceOptions? opts = null)
public GtmDomain(String name, GtmDomainArgs args)
public GtmDomain(String name, GtmDomainArgs args, CustomResourceOptions options)

type: akamai:GtmDomain
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. GtmDomainArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. 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 This property is required. string
The unique name of the resource.
args This property is required. GtmDomainArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. GtmDomainArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. GtmDomainArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var gtmDomainResource = new Akamai.GtmDomain("gtmDomainResource", new()
{
    Type = "string",
    EndUserMappingEnabled = false,
    EmailNotificationLists = new[]
    {
        "string",
    },
    DefaultErrorPenalty = 0,
    DefaultSslClientCertificate = "string",
    Group = "string",
    DefaultTimeoutPenalty = 0,
    Contract = "string",
    CnameCoalescingEnabled = false,
    DefaultSslClientPrivateKey = "string",
    LoadFeedback = false,
    LoadImbalancePercentage = 0,
    Name = "string",
    SignAndServe = false,
    SignAndServeAlgorithm = "string",
    Comment = "string",
    WaitOnComplete = false,
});
Copy
example, err := akamai.NewGtmDomain(ctx, "gtmDomainResource", &akamai.GtmDomainArgs{
	Type:                  pulumi.String("string"),
	EndUserMappingEnabled: pulumi.Bool(false),
	EmailNotificationLists: pulumi.StringArray{
		pulumi.String("string"),
	},
	DefaultErrorPenalty:         pulumi.Int(0),
	DefaultSslClientCertificate: pulumi.String("string"),
	Group:                       pulumi.String("string"),
	DefaultTimeoutPenalty:       pulumi.Int(0),
	Contract:                    pulumi.String("string"),
	CnameCoalescingEnabled:      pulumi.Bool(false),
	DefaultSslClientPrivateKey:  pulumi.String("string"),
	LoadFeedback:                pulumi.Bool(false),
	LoadImbalancePercentage:     pulumi.Float64(0),
	Name:                        pulumi.String("string"),
	SignAndServe:                pulumi.Bool(false),
	SignAndServeAlgorithm:       pulumi.String("string"),
	Comment:                     pulumi.String("string"),
	WaitOnComplete:              pulumi.Bool(false),
})
Copy
var gtmDomainResource = new GtmDomain("gtmDomainResource", GtmDomainArgs.builder()
    .type("string")
    .endUserMappingEnabled(false)
    .emailNotificationLists("string")
    .defaultErrorPenalty(0)
    .defaultSslClientCertificate("string")
    .group("string")
    .defaultTimeoutPenalty(0)
    .contract("string")
    .cnameCoalescingEnabled(false)
    .defaultSslClientPrivateKey("string")
    .loadFeedback(false)
    .loadImbalancePercentage(0)
    .name("string")
    .signAndServe(false)
    .signAndServeAlgorithm("string")
    .comment("string")
    .waitOnComplete(false)
    .build());
Copy
gtm_domain_resource = akamai.GtmDomain("gtmDomainResource",
    type="string",
    end_user_mapping_enabled=False,
    email_notification_lists=["string"],
    default_error_penalty=0,
    default_ssl_client_certificate="string",
    group="string",
    default_timeout_penalty=0,
    contract="string",
    cname_coalescing_enabled=False,
    default_ssl_client_private_key="string",
    load_feedback=False,
    load_imbalance_percentage=0,
    name="string",
    sign_and_serve=False,
    sign_and_serve_algorithm="string",
    comment="string",
    wait_on_complete=False)
Copy
const gtmDomainResource = new akamai.GtmDomain("gtmDomainResource", {
    type: "string",
    endUserMappingEnabled: false,
    emailNotificationLists: ["string"],
    defaultErrorPenalty: 0,
    defaultSslClientCertificate: "string",
    group: "string",
    defaultTimeoutPenalty: 0,
    contract: "string",
    cnameCoalescingEnabled: false,
    defaultSslClientPrivateKey: "string",
    loadFeedback: false,
    loadImbalancePercentage: 0,
    name: "string",
    signAndServe: false,
    signAndServeAlgorithm: "string",
    comment: "string",
    waitOnComplete: false,
});
Copy
type: akamai:GtmDomain
properties:
    cnameCoalescingEnabled: false
    comment: string
    contract: string
    defaultErrorPenalty: 0
    defaultSslClientCertificate: string
    defaultSslClientPrivateKey: string
    defaultTimeoutPenalty: 0
    emailNotificationLists:
        - string
    endUserMappingEnabled: false
    group: string
    loadFeedback: false
    loadImbalancePercentage: 0
    name: string
    signAndServe: false
    signAndServeAlgorithm: string
    type: string
    waitOnComplete: false
Copy

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

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The GtmDomain resource accepts the following input properties:

Type This property is required. string
CnameCoalescingEnabled bool
Comment string
Contract string
DefaultErrorPenalty int
DefaultSslClientCertificate string
DefaultSslClientPrivateKey string
DefaultTimeoutPenalty int
EmailNotificationLists List<string>
EndUserMappingEnabled bool
Group string
LoadFeedback bool
LoadImbalancePercentage double
Name string
SignAndServe bool
If set (true) we will sign the domain's resource records so that they can be validated by a validating resolver.
SignAndServeAlgorithm string
The signing algorithm to use for signAndServe. One of the following values: RSA_SHA1, RSA_SHA256, RSA_SHA512, ECDSA_P256_SHA256, ECDSA_P384_SHA384, ED25519, ED448.
WaitOnComplete bool
Type This property is required. string
CnameCoalescingEnabled bool
Comment string
Contract string
DefaultErrorPenalty int
DefaultSslClientCertificate string
DefaultSslClientPrivateKey string
DefaultTimeoutPenalty int
EmailNotificationLists []string
EndUserMappingEnabled bool
Group string
LoadFeedback bool
LoadImbalancePercentage float64
Name string
SignAndServe bool
If set (true) we will sign the domain's resource records so that they can be validated by a validating resolver.
SignAndServeAlgorithm string
The signing algorithm to use for signAndServe. One of the following values: RSA_SHA1, RSA_SHA256, RSA_SHA512, ECDSA_P256_SHA256, ECDSA_P384_SHA384, ED25519, ED448.
WaitOnComplete bool
type This property is required. String
cnameCoalescingEnabled Boolean
comment String
contract String
defaultErrorPenalty Integer
defaultSslClientCertificate String
defaultSslClientPrivateKey String
defaultTimeoutPenalty Integer
emailNotificationLists List<String>
endUserMappingEnabled Boolean
group String
loadFeedback Boolean
loadImbalancePercentage Double
name String
signAndServe Boolean
If set (true) we will sign the domain's resource records so that they can be validated by a validating resolver.
signAndServeAlgorithm String
The signing algorithm to use for signAndServe. One of the following values: RSA_SHA1, RSA_SHA256, RSA_SHA512, ECDSA_P256_SHA256, ECDSA_P384_SHA384, ED25519, ED448.
waitOnComplete Boolean
type This property is required. string
cnameCoalescingEnabled boolean
comment string
contract string
defaultErrorPenalty number
defaultSslClientCertificate string
defaultSslClientPrivateKey string
defaultTimeoutPenalty number
emailNotificationLists string[]
endUserMappingEnabled boolean
group string
loadFeedback boolean
loadImbalancePercentage number
name string
signAndServe boolean
If set (true) we will sign the domain's resource records so that they can be validated by a validating resolver.
signAndServeAlgorithm string
The signing algorithm to use for signAndServe. One of the following values: RSA_SHA1, RSA_SHA256, RSA_SHA512, ECDSA_P256_SHA256, ECDSA_P384_SHA384, ED25519, ED448.
waitOnComplete boolean
type This property is required. str
cname_coalescing_enabled bool
comment str
contract str
default_error_penalty int
default_ssl_client_certificate str
default_ssl_client_private_key str
default_timeout_penalty int
email_notification_lists Sequence[str]
end_user_mapping_enabled bool
group str
load_feedback bool
load_imbalance_percentage float
name str
sign_and_serve bool
If set (true) we will sign the domain's resource records so that they can be validated by a validating resolver.
sign_and_serve_algorithm str
The signing algorithm to use for signAndServe. One of the following values: RSA_SHA1, RSA_SHA256, RSA_SHA512, ECDSA_P256_SHA256, ECDSA_P384_SHA384, ED25519, ED448.
wait_on_complete bool
type This property is required. String
cnameCoalescingEnabled Boolean
comment String
contract String
defaultErrorPenalty Number
defaultSslClientCertificate String
defaultSslClientPrivateKey String
defaultTimeoutPenalty Number
emailNotificationLists List<String>
endUserMappingEnabled Boolean
group String
loadFeedback Boolean
loadImbalancePercentage Number
name String
signAndServe Boolean
If set (true) we will sign the domain's resource records so that they can be validated by a validating resolver.
signAndServeAlgorithm String
The signing algorithm to use for signAndServe. One of the following values: RSA_SHA1, RSA_SHA256, RSA_SHA512, ECDSA_P256_SHA256, ECDSA_P384_SHA384, ED25519, ED448.
waitOnComplete Boolean

Outputs

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

Look up 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,
        sign_and_serve: Optional[bool] = None,
        sign_and_serve_algorithm: 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)
public static GtmDomain get(String name, Output<String> id, GtmDomainState state, CustomResourceOptions options)
resources:  _:    type: akamai:GtmDomain    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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
Contract string
DefaultErrorPenalty int
DefaultHealthMax double
DefaultHealthMultiplier double
DefaultHealthThreshold double
DefaultMaxUnreachablePenalty int
DefaultSslClientCertificate string
DefaultSslClientPrivateKey string
DefaultTimeoutPenalty int
DefaultUnreachableThreshold double
EmailNotificationLists List<string>
EndUserMappingEnabled bool
Group string
LoadFeedback bool
LoadImbalancePercentage double
MapUpdateInterval int
MaxProperties int
MaxResources int
MaxTestTimeout double
MaxTtl int
MinPingableRegionFraction double
MinTestInterval int
MinTtl int
Name string
PingInterval int
PingPacketSize int
RoundRobinPrefix string
ServermonitorLivenessCount int
ServermonitorLoadCount int
ServermonitorPool string
SignAndServe bool
If set (true) we will sign the domain's resource records so that they can be validated by a validating resolver.
SignAndServeAlgorithm string
The signing algorithm to use for signAndServe. One of the following values: RSA_SHA1, RSA_SHA256, RSA_SHA512, ECDSA_P256_SHA256, ECDSA_P384_SHA384, ED25519, ED448.
Type string
WaitOnComplete bool
CnameCoalescingEnabled bool
Comment string
Contract string
DefaultErrorPenalty int
DefaultHealthMax float64
DefaultHealthMultiplier float64
DefaultHealthThreshold float64
DefaultMaxUnreachablePenalty int
DefaultSslClientCertificate string
DefaultSslClientPrivateKey string
DefaultTimeoutPenalty int
DefaultUnreachableThreshold float64
EmailNotificationLists []string
EndUserMappingEnabled bool
Group string
LoadFeedback bool
LoadImbalancePercentage float64
MapUpdateInterval int
MaxProperties int
MaxResources int
MaxTestTimeout float64
MaxTtl int
MinPingableRegionFraction float64
MinTestInterval int
MinTtl int
Name string
PingInterval int
PingPacketSize int
RoundRobinPrefix string
ServermonitorLivenessCount int
ServermonitorLoadCount int
ServermonitorPool string
SignAndServe bool
If set (true) we will sign the domain's resource records so that they can be validated by a validating resolver.
SignAndServeAlgorithm string
The signing algorithm to use for signAndServe. One of the following values: RSA_SHA1, RSA_SHA256, RSA_SHA512, ECDSA_P256_SHA256, ECDSA_P384_SHA384, ED25519, ED448.
Type string
WaitOnComplete bool
cnameCoalescingEnabled Boolean
comment String
contract String
defaultErrorPenalty Integer
defaultHealthMax Double
defaultHealthMultiplier Double
defaultHealthThreshold Double
defaultMaxUnreachablePenalty Integer
defaultSslClientCertificate String
defaultSslClientPrivateKey String
defaultTimeoutPenalty Integer
defaultUnreachableThreshold Double
emailNotificationLists List<String>
endUserMappingEnabled Boolean
group String
loadFeedback Boolean
loadImbalancePercentage Double
mapUpdateInterval Integer
maxProperties Integer
maxResources Integer
maxTestTimeout Double
maxTtl Integer
minPingableRegionFraction Double
minTestInterval Integer
minTtl Integer
name String
pingInterval Integer
pingPacketSize Integer
roundRobinPrefix String
servermonitorLivenessCount Integer
servermonitorLoadCount Integer
servermonitorPool String
signAndServe Boolean
If set (true) we will sign the domain's resource records so that they can be validated by a validating resolver.
signAndServeAlgorithm String
The signing algorithm to use for signAndServe. One of the following values: RSA_SHA1, RSA_SHA256, RSA_SHA512, ECDSA_P256_SHA256, ECDSA_P384_SHA384, ED25519, ED448.
type String
waitOnComplete Boolean
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
signAndServe boolean
If set (true) we will sign the domain's resource records so that they can be validated by a validating resolver.
signAndServeAlgorithm string
The signing algorithm to use for signAndServe. One of the following values: RSA_SHA1, RSA_SHA256, RSA_SHA512, ECDSA_P256_SHA256, ECDSA_P384_SHA384, ED25519, ED448.
type string
waitOnComplete boolean
cname_coalescing_enabled bool
comment str
contract str
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
default_unreachable_threshold float
email_notification_lists Sequence[str]
end_user_mapping_enabled bool
group str
load_feedback bool
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
ping_interval int
ping_packet_size int
round_robin_prefix str
servermonitor_liveness_count int
servermonitor_load_count int
servermonitor_pool str
sign_and_serve bool
If set (true) we will sign the domain's resource records so that they can be validated by a validating resolver.
sign_and_serve_algorithm str
The signing algorithm to use for signAndServe. One of the following values: RSA_SHA1, RSA_SHA256, RSA_SHA512, ECDSA_P256_SHA256, ECDSA_P384_SHA384, ED25519, ED448.
type str
wait_on_complete bool
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 List<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
signAndServe Boolean
If set (true) we will sign the domain's resource records so that they can be validated by a validating resolver.
signAndServeAlgorithm String
The signing algorithm to use for signAndServe. One of the following values: RSA_SHA1, RSA_SHA256, RSA_SHA512, ECDSA_P256_SHA256, ECDSA_P384_SHA384, ED25519, ED448.
type String
waitOnComplete Boolean

Package Details

Repository
Akamai pulumi/pulumi-akamai
License
Apache-2.0
Notes
This Pulumi package is based on the akamai Terraform Provider.
Akamai v8.0.0 published on Saturday, Mar 1, 2025 by Pulumi
pulumi/pulumi-akamai