1. Packages
  2. Packages
  3. Akamai
  4. API Docs
  5. GtmProperty
Viewing docs for Akamai v11.1.0
published on Thursday, Apr 2, 2026 by Pulumi
akamai logo
Viewing docs for Akamai v11.1.0
published on Thursday, Apr 2, 2026 by Pulumi

    Create GtmProperty Resource

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

    Constructor syntax

    new GtmProperty(name: string, args: GtmPropertyArgs, opts?: CustomResourceOptions);
    @overload
    def GtmProperty(resource_name: str,
                    args: GtmPropertyArgs,
                    opts: Optional[ResourceOptions] = None)
    
    @overload
    def GtmProperty(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    domain: Optional[str] = None,
                    type: Optional[str] = None,
                    score_aggregation_type: Optional[str] = None,
                    handout_mode: Optional[str] = None,
                    handout_limit: Optional[int] = None,
                    liveness_tests: Optional[Sequence[GtmPropertyLivenessTestArgs]] = None,
                    map_name: Optional[str] = None,
                    failback_delay: Optional[int] = None,
                    failover_delay: Optional[int] = None,
                    ghost_demand_reporting: Optional[bool] = None,
                    comments: Optional[str] = None,
                    cname: Optional[str] = None,
                    health_max: Optional[float] = None,
                    health_multiplier: Optional[float] = None,
                    health_threshold: Optional[float] = None,
                    ipv6: Optional[bool] = None,
                    backup_cname: Optional[str] = None,
                    load_imbalance_percentage: Optional[float] = None,
                    dynamic_ttl: Optional[int] = None,
                    max_unreachable_penalty: Optional[int] = None,
                    min_live_fraction: Optional[float] = None,
                    name: Optional[str] = None,
                    balance_by_download_score: Optional[bool] = None,
                    state_change_notification_webhook: Optional[GtmPropertyStateChangeNotificationWebhookArgs] = None,
                    static_rr_sets: Optional[Sequence[GtmPropertyStaticRrSetArgs]] = None,
                    stickiness_bonus_constant: Optional[int] = None,
                    stickiness_bonus_percentage: Optional[int] = None,
                    traffic_targets: Optional[Sequence[GtmPropertyTrafficTargetArgs]] = None,
                    backup_ip: Optional[str] = None,
                    unreachable_threshold: Optional[float] = None,
                    use_computed_targets: Optional[bool] = None,
                    wait_on_complete: Optional[bool] = None)
    func NewGtmProperty(ctx *Context, name string, args GtmPropertyArgs, opts ...ResourceOption) (*GtmProperty, error)
    public GtmProperty(string name, GtmPropertyArgs args, CustomResourceOptions? opts = null)
    public GtmProperty(String name, GtmPropertyArgs args)
    public GtmProperty(String name, GtmPropertyArgs args, CustomResourceOptions options)
    
    type: akamai:GtmProperty
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args GtmPropertyArgs
    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 GtmPropertyArgs
    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 GtmPropertyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GtmPropertyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GtmPropertyArgs
    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 gtmPropertyResource = new Akamai.GtmProperty("gtmPropertyResource", new()
    {
        Domain = "string",
        Type = "string",
        ScoreAggregationType = "string",
        HandoutMode = "string",
        HandoutLimit = 0,
        LivenessTests = new[]
        {
            new Akamai.Inputs.GtmPropertyLivenessTestArgs
            {
                Name = "string",
                TestTimeout = 0,
                TestObjectProtocol = "string",
                TestInterval = 0,
                RecursionRequested = false,
                RequestString = "string",
                HttpError4xx = false,
                HttpError5xx = false,
                HttpHeaders = new[]
                {
                    new Akamai.Inputs.GtmPropertyLivenessTestHttpHeaderArgs
                    {
                        Name = "string",
                        Value = "string",
                    },
                },
                HttpMethod = "string",
                HttpRequestBody = "string",
                ErrorPenalty = 0,
                PeerCertificateVerification = false,
                Pre2023SecurityPosture = false,
                AlternateCaCertificates = new[]
                {
                    "string",
                },
                HttpError3xx = false,
                ResourceType = "string",
                ResponseString = "string",
                SslClientCertificate = "string",
                SslClientPrivateKey = "string",
                Disabled = false,
                TestObject = "string",
                TestObjectPassword = "string",
                TestObjectPort = 0,
                DisableNonstandardPortWarning = false,
                TestObjectUsername = "string",
                AnswersRequired = false,
                TimeoutPenalty = 0,
            },
        },
        MapName = "string",
        FailbackDelay = 0,
        FailoverDelay = 0,
        GhostDemandReporting = false,
        Comments = "string",
        Cname = "string",
        HealthMax = 0,
        HealthMultiplier = 0,
        HealthThreshold = 0,
        Ipv6 = false,
        BackupCname = "string",
        LoadImbalancePercentage = 0,
        DynamicTtl = 0,
        MaxUnreachablePenalty = 0,
        MinLiveFraction = 0,
        Name = "string",
        BalanceByDownloadScore = false,
        StateChangeNotificationWebhook = new Akamai.Inputs.GtmPropertyStateChangeNotificationWebhookArgs
        {
            Format = "string",
            Url = "string",
        },
        StaticRrSets = new[]
        {
            new Akamai.Inputs.GtmPropertyStaticRrSetArgs
            {
                Rdatas = new[]
                {
                    "string",
                },
                Ttl = 0,
                Type = "string",
            },
        },
        StickinessBonusConstant = 0,
        StickinessBonusPercentage = 0,
        TrafficTargets = new[]
        {
            new Akamai.Inputs.GtmPropertyTrafficTargetArgs
            {
                DatacenterId = 0,
                Enabled = false,
                HandoutCname = "string",
                Precedence = 0,
                Servers = new[]
                {
                    "string",
                },
                Weight = 0,
            },
        },
        BackupIp = "string",
        UnreachableThreshold = 0,
        UseComputedTargets = false,
        WaitOnComplete = false,
    });
    
    example, err := akamai.NewGtmProperty(ctx, "gtmPropertyResource", &akamai.GtmPropertyArgs{
    	Domain:               pulumi.String("string"),
    	Type:                 pulumi.String("string"),
    	ScoreAggregationType: pulumi.String("string"),
    	HandoutMode:          pulumi.String("string"),
    	HandoutLimit:         pulumi.Int(0),
    	LivenessTests: akamai.GtmPropertyLivenessTestArray{
    		&akamai.GtmPropertyLivenessTestArgs{
    			Name:               pulumi.String("string"),
    			TestTimeout:        pulumi.Float64(0),
    			TestObjectProtocol: pulumi.String("string"),
    			TestInterval:       pulumi.Int(0),
    			RecursionRequested: pulumi.Bool(false),
    			RequestString:      pulumi.String("string"),
    			HttpError4xx:       pulumi.Bool(false),
    			HttpError5xx:       pulumi.Bool(false),
    			HttpHeaders: akamai.GtmPropertyLivenessTestHttpHeaderArray{
    				&akamai.GtmPropertyLivenessTestHttpHeaderArgs{
    					Name:  pulumi.String("string"),
    					Value: pulumi.String("string"),
    				},
    			},
    			HttpMethod:                  pulumi.String("string"),
    			HttpRequestBody:             pulumi.String("string"),
    			ErrorPenalty:                pulumi.Float64(0),
    			PeerCertificateVerification: pulumi.Bool(false),
    			Pre2023SecurityPosture:      pulumi.Bool(false),
    			AlternateCaCertificates: pulumi.StringArray{
    				pulumi.String("string"),
    			},
    			HttpError3xx:                  pulumi.Bool(false),
    			ResourceType:                  pulumi.String("string"),
    			ResponseString:                pulumi.String("string"),
    			SslClientCertificate:          pulumi.String("string"),
    			SslClientPrivateKey:           pulumi.String("string"),
    			Disabled:                      pulumi.Bool(false),
    			TestObject:                    pulumi.String("string"),
    			TestObjectPassword:            pulumi.String("string"),
    			TestObjectPort:                pulumi.Int(0),
    			DisableNonstandardPortWarning: pulumi.Bool(false),
    			TestObjectUsername:            pulumi.String("string"),
    			AnswersRequired:               pulumi.Bool(false),
    			TimeoutPenalty:                pulumi.Float64(0),
    		},
    	},
    	MapName:                 pulumi.String("string"),
    	FailbackDelay:           pulumi.Int(0),
    	FailoverDelay:           pulumi.Int(0),
    	GhostDemandReporting:    pulumi.Bool(false),
    	Comments:                pulumi.String("string"),
    	Cname:                   pulumi.String("string"),
    	HealthMax:               pulumi.Float64(0),
    	HealthMultiplier:        pulumi.Float64(0),
    	HealthThreshold:         pulumi.Float64(0),
    	Ipv6:                    pulumi.Bool(false),
    	BackupCname:             pulumi.String("string"),
    	LoadImbalancePercentage: pulumi.Float64(0),
    	DynamicTtl:              pulumi.Int(0),
    	MaxUnreachablePenalty:   pulumi.Int(0),
    	MinLiveFraction:         pulumi.Float64(0),
    	Name:                    pulumi.String("string"),
    	BalanceByDownloadScore:  pulumi.Bool(false),
    	StateChangeNotificationWebhook: &akamai.GtmPropertyStateChangeNotificationWebhookArgs{
    		Format: pulumi.String("string"),
    		Url:    pulumi.String("string"),
    	},
    	StaticRrSets: akamai.GtmPropertyStaticRrSetArray{
    		&akamai.GtmPropertyStaticRrSetArgs{
    			Rdatas: pulumi.StringArray{
    				pulumi.String("string"),
    			},
    			Ttl:  pulumi.Int(0),
    			Type: pulumi.String("string"),
    		},
    	},
    	StickinessBonusConstant:   pulumi.Int(0),
    	StickinessBonusPercentage: pulumi.Int(0),
    	TrafficTargets: akamai.GtmPropertyTrafficTargetArray{
    		&akamai.GtmPropertyTrafficTargetArgs{
    			DatacenterId: pulumi.Int(0),
    			Enabled:      pulumi.Bool(false),
    			HandoutCname: pulumi.String("string"),
    			Precedence:   pulumi.Int(0),
    			Servers: pulumi.StringArray{
    				pulumi.String("string"),
    			},
    			Weight: pulumi.Float64(0),
    		},
    	},
    	BackupIp:             pulumi.String("string"),
    	UnreachableThreshold: pulumi.Float64(0),
    	UseComputedTargets:   pulumi.Bool(false),
    	WaitOnComplete:       pulumi.Bool(false),
    })
    
    var gtmPropertyResource = new GtmProperty("gtmPropertyResource", GtmPropertyArgs.builder()
        .domain("string")
        .type("string")
        .scoreAggregationType("string")
        .handoutMode("string")
        .handoutLimit(0)
        .livenessTests(GtmPropertyLivenessTestArgs.builder()
            .name("string")
            .testTimeout(0.0)
            .testObjectProtocol("string")
            .testInterval(0)
            .recursionRequested(false)
            .requestString("string")
            .httpError4xx(false)
            .httpError5xx(false)
            .httpHeaders(GtmPropertyLivenessTestHttpHeaderArgs.builder()
                .name("string")
                .value("string")
                .build())
            .httpMethod("string")
            .httpRequestBody("string")
            .errorPenalty(0.0)
            .peerCertificateVerification(false)
            .pre2023SecurityPosture(false)
            .alternateCaCertificates("string")
            .httpError3xx(false)
            .resourceType("string")
            .responseString("string")
            .sslClientCertificate("string")
            .sslClientPrivateKey("string")
            .disabled(false)
            .testObject("string")
            .testObjectPassword("string")
            .testObjectPort(0)
            .disableNonstandardPortWarning(false)
            .testObjectUsername("string")
            .answersRequired(false)
            .timeoutPenalty(0.0)
            .build())
        .mapName("string")
        .failbackDelay(0)
        .failoverDelay(0)
        .ghostDemandReporting(false)
        .comments("string")
        .cname("string")
        .healthMax(0.0)
        .healthMultiplier(0.0)
        .healthThreshold(0.0)
        .ipv6(false)
        .backupCname("string")
        .loadImbalancePercentage(0.0)
        .dynamicTtl(0)
        .maxUnreachablePenalty(0)
        .minLiveFraction(0.0)
        .name("string")
        .balanceByDownloadScore(false)
        .stateChangeNotificationWebhook(GtmPropertyStateChangeNotificationWebhookArgs.builder()
            .format("string")
            .url("string")
            .build())
        .staticRrSets(GtmPropertyStaticRrSetArgs.builder()
            .rdatas("string")
            .ttl(0)
            .type("string")
            .build())
        .stickinessBonusConstant(0)
        .stickinessBonusPercentage(0)
        .trafficTargets(GtmPropertyTrafficTargetArgs.builder()
            .datacenterId(0)
            .enabled(false)
            .handoutCname("string")
            .precedence(0)
            .servers("string")
            .weight(0.0)
            .build())
        .backupIp("string")
        .unreachableThreshold(0.0)
        .useComputedTargets(false)
        .waitOnComplete(false)
        .build());
    
    gtm_property_resource = akamai.GtmProperty("gtmPropertyResource",
        domain="string",
        type="string",
        score_aggregation_type="string",
        handout_mode="string",
        handout_limit=0,
        liveness_tests=[{
            "name": "string",
            "test_timeout": float(0),
            "test_object_protocol": "string",
            "test_interval": 0,
            "recursion_requested": False,
            "request_string": "string",
            "http_error4xx": False,
            "http_error5xx": False,
            "http_headers": [{
                "name": "string",
                "value": "string",
            }],
            "http_method": "string",
            "http_request_body": "string",
            "error_penalty": float(0),
            "peer_certificate_verification": False,
            "pre2023_security_posture": False,
            "alternate_ca_certificates": ["string"],
            "http_error3xx": False,
            "resource_type": "string",
            "response_string": "string",
            "ssl_client_certificate": "string",
            "ssl_client_private_key": "string",
            "disabled": False,
            "test_object": "string",
            "test_object_password": "string",
            "test_object_port": 0,
            "disable_nonstandard_port_warning": False,
            "test_object_username": "string",
            "answers_required": False,
            "timeout_penalty": float(0),
        }],
        map_name="string",
        failback_delay=0,
        failover_delay=0,
        ghost_demand_reporting=False,
        comments="string",
        cname="string",
        health_max=float(0),
        health_multiplier=float(0),
        health_threshold=float(0),
        ipv6=False,
        backup_cname="string",
        load_imbalance_percentage=float(0),
        dynamic_ttl=0,
        max_unreachable_penalty=0,
        min_live_fraction=float(0),
        name="string",
        balance_by_download_score=False,
        state_change_notification_webhook={
            "format": "string",
            "url": "string",
        },
        static_rr_sets=[{
            "rdatas": ["string"],
            "ttl": 0,
            "type": "string",
        }],
        stickiness_bonus_constant=0,
        stickiness_bonus_percentage=0,
        traffic_targets=[{
            "datacenter_id": 0,
            "enabled": False,
            "handout_cname": "string",
            "precedence": 0,
            "servers": ["string"],
            "weight": float(0),
        }],
        backup_ip="string",
        unreachable_threshold=float(0),
        use_computed_targets=False,
        wait_on_complete=False)
    
    const gtmPropertyResource = new akamai.GtmProperty("gtmPropertyResource", {
        domain: "string",
        type: "string",
        scoreAggregationType: "string",
        handoutMode: "string",
        handoutLimit: 0,
        livenessTests: [{
            name: "string",
            testTimeout: 0,
            testObjectProtocol: "string",
            testInterval: 0,
            recursionRequested: false,
            requestString: "string",
            httpError4xx: false,
            httpError5xx: false,
            httpHeaders: [{
                name: "string",
                value: "string",
            }],
            httpMethod: "string",
            httpRequestBody: "string",
            errorPenalty: 0,
            peerCertificateVerification: false,
            pre2023SecurityPosture: false,
            alternateCaCertificates: ["string"],
            httpError3xx: false,
            resourceType: "string",
            responseString: "string",
            sslClientCertificate: "string",
            sslClientPrivateKey: "string",
            disabled: false,
            testObject: "string",
            testObjectPassword: "string",
            testObjectPort: 0,
            disableNonstandardPortWarning: false,
            testObjectUsername: "string",
            answersRequired: false,
            timeoutPenalty: 0,
        }],
        mapName: "string",
        failbackDelay: 0,
        failoverDelay: 0,
        ghostDemandReporting: false,
        comments: "string",
        cname: "string",
        healthMax: 0,
        healthMultiplier: 0,
        healthThreshold: 0,
        ipv6: false,
        backupCname: "string",
        loadImbalancePercentage: 0,
        dynamicTtl: 0,
        maxUnreachablePenalty: 0,
        minLiveFraction: 0,
        name: "string",
        balanceByDownloadScore: false,
        stateChangeNotificationWebhook: {
            format: "string",
            url: "string",
        },
        staticRrSets: [{
            rdatas: ["string"],
            ttl: 0,
            type: "string",
        }],
        stickinessBonusConstant: 0,
        stickinessBonusPercentage: 0,
        trafficTargets: [{
            datacenterId: 0,
            enabled: false,
            handoutCname: "string",
            precedence: 0,
            servers: ["string"],
            weight: 0,
        }],
        backupIp: "string",
        unreachableThreshold: 0,
        useComputedTargets: false,
        waitOnComplete: false,
    });
    
    type: akamai:GtmProperty
    properties:
        backupCname: string
        backupIp: string
        balanceByDownloadScore: false
        cname: string
        comments: string
        domain: string
        dynamicTtl: 0
        failbackDelay: 0
        failoverDelay: 0
        ghostDemandReporting: false
        handoutLimit: 0
        handoutMode: string
        healthMax: 0
        healthMultiplier: 0
        healthThreshold: 0
        ipv6: false
        livenessTests:
            - alternateCaCertificates:
                - string
              answersRequired: false
              disableNonstandardPortWarning: false
              disabled: false
              errorPenalty: 0
              httpError3xx: false
              httpError4xx: false
              httpError5xx: false
              httpHeaders:
                - name: string
                  value: string
              httpMethod: string
              httpRequestBody: string
              name: string
              peerCertificateVerification: false
              pre2023SecurityPosture: false
              recursionRequested: false
              requestString: string
              resourceType: string
              responseString: string
              sslClientCertificate: string
              sslClientPrivateKey: string
              testInterval: 0
              testObject: string
              testObjectPassword: string
              testObjectPort: 0
              testObjectProtocol: string
              testObjectUsername: string
              testTimeout: 0
              timeoutPenalty: 0
        loadImbalancePercentage: 0
        mapName: string
        maxUnreachablePenalty: 0
        minLiveFraction: 0
        name: string
        scoreAggregationType: string
        stateChangeNotificationWebhook:
            format: string
            url: string
        staticRrSets:
            - rdatas:
                - string
              ttl: 0
              type: string
        stickinessBonusConstant: 0
        stickinessBonusPercentage: 0
        trafficTargets:
            - datacenterId: 0
              enabled: false
              handoutCname: string
              precedence: 0
              servers:
                - string
              weight: 0
        type: string
        unreachableThreshold: 0
        useComputedTargets: false
        waitOnComplete: false
    

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

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    WeightedHashBitsForIpv4 int
    WeightedHashBitsForIpv6 int
    Id string
    The provider-assigned unique ID for this managed resource.
    WeightedHashBitsForIpv4 int
    WeightedHashBitsForIpv6 int
    id String
    The provider-assigned unique ID for this managed resource.
    weightedHashBitsForIpv4 Integer
    weightedHashBitsForIpv6 Integer
    id string
    The provider-assigned unique ID for this managed resource.
    weightedHashBitsForIpv4 number
    weightedHashBitsForIpv6 number
    id str
    The provider-assigned unique ID for this managed resource.
    weighted_hash_bits_for_ipv4 int
    weighted_hash_bits_for_ipv6 int
    id String
    The provider-assigned unique ID for this managed resource.
    weightedHashBitsForIpv4 Number
    weightedHashBitsForIpv6 Number

    Look up Existing GtmProperty Resource

    Get an existing GtmProperty 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?: GtmPropertyState, opts?: CustomResourceOptions): GtmProperty
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            backup_cname: Optional[str] = None,
            backup_ip: Optional[str] = None,
            balance_by_download_score: Optional[bool] = None,
            cname: Optional[str] = None,
            comments: Optional[str] = None,
            domain: Optional[str] = None,
            dynamic_ttl: Optional[int] = None,
            failback_delay: Optional[int] = None,
            failover_delay: Optional[int] = None,
            ghost_demand_reporting: Optional[bool] = None,
            handout_limit: Optional[int] = None,
            handout_mode: Optional[str] = None,
            health_max: Optional[float] = None,
            health_multiplier: Optional[float] = None,
            health_threshold: Optional[float] = None,
            ipv6: Optional[bool] = None,
            liveness_tests: Optional[Sequence[GtmPropertyLivenessTestArgs]] = None,
            load_imbalance_percentage: Optional[float] = None,
            map_name: Optional[str] = None,
            max_unreachable_penalty: Optional[int] = None,
            min_live_fraction: Optional[float] = None,
            name: Optional[str] = None,
            score_aggregation_type: Optional[str] = None,
            state_change_notification_webhook: Optional[GtmPropertyStateChangeNotificationWebhookArgs] = None,
            static_rr_sets: Optional[Sequence[GtmPropertyStaticRrSetArgs]] = None,
            stickiness_bonus_constant: Optional[int] = None,
            stickiness_bonus_percentage: Optional[int] = None,
            traffic_targets: Optional[Sequence[GtmPropertyTrafficTargetArgs]] = None,
            type: Optional[str] = None,
            unreachable_threshold: Optional[float] = None,
            use_computed_targets: Optional[bool] = None,
            wait_on_complete: Optional[bool] = None,
            weighted_hash_bits_for_ipv4: Optional[int] = None,
            weighted_hash_bits_for_ipv6: Optional[int] = None) -> GtmProperty
    func GetGtmProperty(ctx *Context, name string, id IDInput, state *GtmPropertyState, opts ...ResourceOption) (*GtmProperty, error)
    public static GtmProperty Get(string name, Input<string> id, GtmPropertyState? state, CustomResourceOptions? opts = null)
    public static GtmProperty get(String name, Output<String> id, GtmPropertyState state, CustomResourceOptions options)
    resources:  _:    type: akamai:GtmProperty    get:      id: ${id}
    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.
    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:
    BackupCname string
    BackupIp string
    BalanceByDownloadScore bool
    Cname string
    Comments string
    Domain string
    DynamicTtl int
    FailbackDelay int
    FailoverDelay int
    GhostDemandReporting bool
    HandoutLimit int
    HandoutMode string
    HealthMax float64
    HealthMultiplier float64
    HealthThreshold float64
    Ipv6 bool
    LivenessTests []GtmPropertyLivenessTestArgs
    LoadImbalancePercentage float64
    MapName string
    MaxUnreachablePenalty int
    MinLiveFraction float64
    Name string
    ScoreAggregationType string
    StateChangeNotificationWebhook GtmPropertyStateChangeNotificationWebhookArgs
    StaticRrSets []GtmPropertyStaticRrSetArgs
    StickinessBonusConstant int
    StickinessBonusPercentage int
    TrafficTargets []GtmPropertyTrafficTargetArgs
    Type string
    UnreachableThreshold float64
    UseComputedTargets bool
    WaitOnComplete bool
    WeightedHashBitsForIpv4 int
    WeightedHashBitsForIpv6 int
    backupCname String
    backupIp String
    balanceByDownloadScore Boolean
    cname String
    comments String
    domain String
    dynamicTtl Integer
    failbackDelay Integer
    failoverDelay Integer
    ghostDemandReporting Boolean
    handoutLimit Integer
    handoutMode String
    healthMax Double
    healthMultiplier Double
    healthThreshold Double
    ipv6 Boolean
    livenessTests List<GtmPropertyLivenessTest>
    loadImbalancePercentage Double
    mapName String
    maxUnreachablePenalty Integer
    minLiveFraction Double
    name String
    scoreAggregationType String
    stateChangeNotificationWebhook GtmPropertyStateChangeNotificationWebhook
    staticRrSets List<GtmPropertyStaticRrSet>
    stickinessBonusConstant Integer
    stickinessBonusPercentage Integer
    trafficTargets List<GtmPropertyTrafficTarget>
    type String
    unreachableThreshold Double
    useComputedTargets Boolean
    waitOnComplete Boolean
    weightedHashBitsForIpv4 Integer
    weightedHashBitsForIpv6 Integer
    backupCname string
    backupIp string
    balanceByDownloadScore boolean
    cname string
    comments string
    domain string
    dynamicTtl number
    failbackDelay number
    failoverDelay number
    ghostDemandReporting boolean
    handoutLimit number
    handoutMode string
    healthMax number
    healthMultiplier number
    healthThreshold number
    ipv6 boolean
    livenessTests GtmPropertyLivenessTest[]
    loadImbalancePercentage number
    mapName string
    maxUnreachablePenalty number
    minLiveFraction number
    name string
    scoreAggregationType string
    stateChangeNotificationWebhook GtmPropertyStateChangeNotificationWebhook
    staticRrSets GtmPropertyStaticRrSet[]
    stickinessBonusConstant number
    stickinessBonusPercentage number
    trafficTargets GtmPropertyTrafficTarget[]
    type string
    unreachableThreshold number
    useComputedTargets boolean
    waitOnComplete boolean
    weightedHashBitsForIpv4 number
    weightedHashBitsForIpv6 number
    backup_cname str
    backup_ip str
    balance_by_download_score bool
    cname str
    comments str
    domain str
    dynamic_ttl int
    failback_delay int
    failover_delay int
    ghost_demand_reporting bool
    handout_limit int
    handout_mode str
    health_max float
    health_multiplier float
    health_threshold float
    ipv6 bool
    liveness_tests Sequence[GtmPropertyLivenessTestArgs]
    load_imbalance_percentage float
    map_name str
    max_unreachable_penalty int
    min_live_fraction float
    name str
    score_aggregation_type str
    state_change_notification_webhook GtmPropertyStateChangeNotificationWebhookArgs
    static_rr_sets Sequence[GtmPropertyStaticRrSetArgs]
    stickiness_bonus_constant int
    stickiness_bonus_percentage int
    traffic_targets Sequence[GtmPropertyTrafficTargetArgs]
    type str
    unreachable_threshold float
    use_computed_targets bool
    wait_on_complete bool
    weighted_hash_bits_for_ipv4 int
    weighted_hash_bits_for_ipv6 int

    Supporting Types

    GtmPropertyLivenessTest, GtmPropertyLivenessTestArgs

    name String
    testInterval Number
    testObjectProtocol String
    testTimeout Number
    alternateCaCertificates List<String>
    answersRequired Boolean
    disableNonstandardPortWarning Boolean
    disabled Boolean
    errorPenalty Number
    httpError3xx Boolean
    httpError4xx Boolean
    httpError5xx Boolean
    httpHeaders List<Property Map>
    httpMethod String
    httpRequestBody String
    peerCertificateVerification Boolean
    pre2023SecurityPosture Boolean
    Whether to enable backwards compatibility for liveness endpoints that use older TLS protocols
    recursionRequested Boolean
    requestString String
    resourceType String
    responseString String
    sslClientCertificate String
    sslClientPrivateKey String
    testObject String
    testObjectPassword String
    testObjectPort Number
    testObjectUsername String
    timeoutPenalty Number

    GtmPropertyLivenessTestHttpHeader, GtmPropertyLivenessTestHttpHeaderArgs

    Name string
    Value string
    Name string
    Value string
    name String
    value String
    name string
    value string
    name str
    value str
    name String
    value String

    GtmPropertyStateChangeNotificationWebhook, GtmPropertyStateChangeNotificationWebhookArgs

    Format string
    Url string
    Format string
    Url string
    format String
    url String
    format string
    url string
    format str
    url str
    format String
    url String

    GtmPropertyStaticRrSet, GtmPropertyStaticRrSetArgs

    Rdatas List<string>
    Ttl int
    Type string
    Rdatas []string
    Ttl int
    Type string
    rdatas List<String>
    ttl Integer
    type String
    rdatas string[]
    ttl number
    type string
    rdatas Sequence[str]
    ttl int
    type str
    rdatas List<String>
    ttl Number
    type String

    GtmPropertyTrafficTarget, GtmPropertyTrafficTargetArgs

    DatacenterId int
    Enabled bool
    HandoutCname string
    Precedence int
    Servers List<string>
    Weight double
    DatacenterId int
    Enabled bool
    HandoutCname string
    Precedence int
    Servers []string
    Weight float64
    datacenterId Integer
    enabled Boolean
    handoutCname String
    precedence Integer
    servers List<String>
    weight Double
    datacenterId number
    enabled boolean
    handoutCname string
    precedence number
    servers string[]
    weight number
    datacenterId Number
    enabled Boolean
    handoutCname String
    precedence Number
    servers List<String>
    weight Number

    Package Details

    Repository
    Akamai pulumi/pulumi-akamai
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the akamai Terraform Provider.
    akamai logo
    Viewing docs for Akamai v11.1.0
    published on Thursday, Apr 2, 2026 by Pulumi
      Try Pulumi Cloud free. Your team will thank you.