GtmGeomap

Use the akamai.GtmGeomap resource to create, configure, and import a GTM Geographic map. Geographic mapping lets you configure a property that returns a CNAME based on the geographic location of the request.

You can reuse maps for multiple properties or create new ones. To configure a property for geographic mapping, you need to define at least one geographic map for your domain. Each map needs at least two definitions. For example, you can have one definition that maps a set of countries to a specific data center, and a second definition that routes all other traffic.

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

Argument reference

This resource supports these arguments:

  • domain - (Required) GTM Domain name for the Geographic Map.
  • name - (Required) A descriptive label for the Geographic map.
  • default_datacenter - (Required) A placeholder for all other geographic zones. Requires these additional arguments:
    • datacenter_id - (Required) For each property, an identifier for all other geographic zones.
    • nickname - (Required) A descriptive label for all other geographic zones.
  • wait_on_complete - (Optional) A boolean indicating whether to wait for transaction to complete. Set to true by default.
  • assignment - (Optional) Contains information about the geographic zone groupings of countries. You can have multiple assignment arguments. If used, requires these additional arguments:
    • datacenter_id - (Optional) A unique identifier for an existing data center in the domain.
    • nickname - (Optional) A descriptive label for the group.
    • countries - (Optional) Specifies an array of two-letter ISO 3166 country codes, or for finer subdivisions, the two-letter country code and the two-letter stateOrProvince code separated by a forward slash.

Schema reference

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

Example Usage

using Pulumi;
using Akamai = Pulumi.Akamai;

class MyStack : Stack
{
    public MyStack()
    {
        var demoGeomap = new Akamai.GtmGeomap("demoGeomap", new Akamai.GtmGeomapArgs
        {
            DefaultDatacenter = new Akamai.Inputs.GtmGeomapDefaultDatacenterArgs
            {
                DatacenterId = 5400,
                Nickname = "All Others",
            },
            Domain = "demo_domain.akadns.net",
        });
    }

}
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.NewGtmGeomap(ctx, "demoGeomap", &akamai.GtmGeomapArgs{
			DefaultDatacenter: &GtmGeomapDefaultDatacenterArgs{
				DatacenterId: pulumi.Int(5400),
				Nickname:     pulumi.String("All Others"),
			},
			Domain: pulumi.String("demo_domain.akadns.net"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
import pulumi
import pulumi_akamai as akamai

demo_geomap = akamai.GtmGeomap("demoGeomap",
    default_datacenter=akamai.GtmGeomapDefaultDatacenterArgs(
        datacenter_id=5400,
        nickname="All Others",
    ),
    domain="demo_domain.akadns.net")
import * as pulumi from "@pulumi/pulumi";
import * as akamai from "@pulumi/akamai";

const demoGeomap = new akamai.GtmGeomap("demo_geomap", {
    defaultDatacenter: {
        datacenterId: 5400,
        nickname: "All Others",
    },
    domain: "demo_domain.akadns.net",
});

Create a GtmGeomap Resource

new GtmGeomap(name: string, args: GtmGeomapArgs, opts?: CustomResourceOptions);
@overload
def GtmGeomap(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              assignments: Optional[Sequence[GtmGeomapAssignmentArgs]] = None,
              default_datacenter: Optional[GtmGeomapDefaultDatacenterArgs] = None,
              domain: Optional[str] = None,
              name: Optional[str] = None,
              wait_on_complete: Optional[bool] = None)
@overload
def GtmGeomap(resource_name: str,
              args: GtmGeomapArgs,
              opts: Optional[ResourceOptions] = None)
func NewGtmGeomap(ctx *Context, name string, args GtmGeomapArgs, opts ...ResourceOption) (*GtmGeomap, error)
public GtmGeomap(string name, GtmGeomapArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args GtmGeomapArgs
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 GtmGeomapArgs
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 GtmGeomapArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args GtmGeomapArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

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

Outputs

All input properties are implicitly available as output properties. Additionally, the GtmGeomap 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 GtmGeomap Resource

Get an existing GtmGeomap 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?: GtmGeomapState, opts?: CustomResourceOptions): GtmGeomap
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        assignments: Optional[Sequence[GtmGeomapAssignmentArgs]] = None,
        default_datacenter: Optional[GtmGeomapDefaultDatacenterArgs] = None,
        domain: Optional[str] = None,
        name: Optional[str] = None,
        wait_on_complete: Optional[bool] = None) -> GtmGeomap
func GetGtmGeomap(ctx *Context, name string, id IDInput, state *GtmGeomapState, opts ...ResourceOption) (*GtmGeomap, error)
public static GtmGeomap Get(string name, Input<string> id, GtmGeomapState? 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

GtmGeomapAssignment

DatacenterId int
Nickname string
Countries List<string>
DatacenterId int
Nickname string
Countries []string
datacenterId number
nickname string
countries string[]
datacenter_id int
nickname str
countries Sequence[str]

GtmGeomapDefaultDatacenter

datacenterId number
nickname string

Package Details

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