Akamai
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
.
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
})
}
Coming soon!
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",
});
Coming soon!
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)
public GtmGeomap(String name, GtmGeomapArgs args)
public GtmGeomap(String name, GtmGeomapArgs args, CustomResourceOptions options)
type: akamai:GtmGeomap
properties: # The arguments to resource properties.
options: # 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.
- 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.
- name String
- The unique name of the resource.
- args GtmGeomapArgs
- The arguments to resource properties.
- options 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:
- Default
Datacenter GtmGeomap Default Datacenter Args A placeholder for all other geographic zones. Requires these additional arguments:
- Domain string
GTM Domain name for the Geographic Map.
- Assignments
List<Gtm
Geomap Assignment Args> Contains information about the geographic zone groupings of countries. You can have multiple
assignment
arguments. If used, requires these additional arguments:- Name string
A descriptive label for the Geographic map.
- Wait
On boolComplete A boolean indicating whether to wait for transaction to complete. Set to
true
by default.
- Default
Datacenter GtmGeomap Default Datacenter Args A placeholder for all other geographic zones. Requires these additional arguments:
- Domain string
GTM Domain name for the Geographic Map.
- Assignments
[]Gtm
Geomap Assignment Args Contains information about the geographic zone groupings of countries. You can have multiple
assignment
arguments. If used, requires these additional arguments:- Name string
A descriptive label for the Geographic map.
- Wait
On boolComplete A boolean indicating whether to wait for transaction to complete. Set to
true
by default.
- default
Datacenter GtmGeomap Default Datacenter Args A placeholder for all other geographic zones. Requires these additional arguments:
- domain String
GTM Domain name for the Geographic Map.
- assignments
List
Geomap Assignment Args> Contains information about the geographic zone groupings of countries. You can have multiple
assignment
arguments. If used, requires these additional arguments:- name String
A descriptive label for the Geographic map.
- wait
On BooleanComplete A boolean indicating whether to wait for transaction to complete. Set to
true
by default.
- default
Datacenter GtmGeomap Default Datacenter Args A placeholder for all other geographic zones. Requires these additional arguments:
- domain string
GTM Domain name for the Geographic Map.
- assignments
Gtm
Geomap Assignment Args[] Contains information about the geographic zone groupings of countries. You can have multiple
assignment
arguments. If used, requires these additional arguments:- name string
A descriptive label for the Geographic map.
- wait
On booleanComplete A boolean indicating whether to wait for transaction to complete. Set to
true
by default.
- default_
datacenter GtmGeomap Default Datacenter Args A placeholder for all other geographic zones. Requires these additional arguments:
- domain str
GTM Domain name for the Geographic Map.
- assignments
Sequence[Gtm
Geomap Assignment Args] Contains information about the geographic zone groupings of countries. You can have multiple
assignment
arguments. If used, requires these additional arguments:- name str
A descriptive label for the Geographic map.
- wait_
on_ boolcomplete A boolean indicating whether to wait for transaction to complete. Set to
true
by default.
- default
Datacenter Property Map A placeholder for all other geographic zones. Requires these additional arguments:
- domain String
GTM Domain name for the Geographic Map.
- assignments
List
Contains information about the geographic zone groupings of countries. You can have multiple
assignment
arguments. If used, requires these additional arguments:- name String
A descriptive label for the Geographic map.
- wait
On BooleanComplete A boolean indicating whether to wait for transaction to complete. Set to
true
by default.
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 string
The provider-assigned unique ID for this managed resource.
- id str
The provider-assigned unique ID for this managed resource.
- id String
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)
public static GtmGeomap get(String name, Output<String> id, GtmGeomapState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- 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.
- Assignments
List<Gtm
Geomap Assignment Args> Contains information about the geographic zone groupings of countries. You can have multiple
assignment
arguments. If used, requires these additional arguments:- Default
Datacenter GtmGeomap Default Datacenter Args A placeholder for all other geographic zones. Requires these additional arguments:
- Domain string
GTM Domain name for the Geographic Map.
- Name string
A descriptive label for the Geographic map.
- Wait
On boolComplete A boolean indicating whether to wait for transaction to complete. Set to
true
by default.
- Assignments
[]Gtm
Geomap Assignment Args Contains information about the geographic zone groupings of countries. You can have multiple
assignment
arguments. If used, requires these additional arguments:- Default
Datacenter GtmGeomap Default Datacenter Args A placeholder for all other geographic zones. Requires these additional arguments:
- Domain string
GTM Domain name for the Geographic Map.
- Name string
A descriptive label for the Geographic map.
- Wait
On boolComplete A boolean indicating whether to wait for transaction to complete. Set to
true
by default.
- assignments
List
Geomap Assignment Args> Contains information about the geographic zone groupings of countries. You can have multiple
assignment
arguments. If used, requires these additional arguments:- default
Datacenter GtmGeomap Default Datacenter Args A placeholder for all other geographic zones. Requires these additional arguments:
- domain String
GTM Domain name for the Geographic Map.
- name String
A descriptive label for the Geographic map.
- wait
On BooleanComplete A boolean indicating whether to wait for transaction to complete. Set to
true
by default.
- assignments
Gtm
Geomap Assignment Args[] Contains information about the geographic zone groupings of countries. You can have multiple
assignment
arguments. If used, requires these additional arguments:- default
Datacenter GtmGeomap Default Datacenter Args A placeholder for all other geographic zones. Requires these additional arguments:
- domain string
GTM Domain name for the Geographic Map.
- name string
A descriptive label for the Geographic map.
- wait
On booleanComplete A boolean indicating whether to wait for transaction to complete. Set to
true
by default.
- assignments
Sequence[Gtm
Geomap Assignment Args] Contains information about the geographic zone groupings of countries. You can have multiple
assignment
arguments. If used, requires these additional arguments:- default_
datacenter GtmGeomap Default Datacenter Args A placeholder for all other geographic zones. Requires these additional arguments:
- domain str
GTM Domain name for the Geographic Map.
- name str
A descriptive label for the Geographic map.
- wait_
on_ boolcomplete A boolean indicating whether to wait for transaction to complete. Set to
true
by default.
- assignments
List
Contains information about the geographic zone groupings of countries. You can have multiple
assignment
arguments. If used, requires these additional arguments:- default
Datacenter Property Map A placeholder for all other geographic zones. Requires these additional arguments:
- domain String
GTM Domain name for the Geographic Map.
- name String
A descriptive label for the Geographic map.
- wait
On BooleanComplete A boolean indicating whether to wait for transaction to complete. Set to
true
by default.
Supporting Types
GtmGeomapAssignment
- Datacenter
Id int A unique identifier for an existing data center in the domain.
- Nickname string
A descriptive label for the group.
- Countries List<string>
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.
- Datacenter
Id int A unique identifier for an existing data center in the domain.
- Nickname string
A descriptive label for the group.
- Countries []string
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.
- datacenter
Id Integer A unique identifier for an existing data center in the domain.
- nickname String
A descriptive label for the group.
- countries
List
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.
- datacenter
Id number A unique identifier for an existing data center in the domain.
- nickname string
A descriptive label for the group.
- countries string[]
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.
- datacenter_
id int A unique identifier for an existing data center in the domain.
- nickname str
A descriptive label for the group.
- countries Sequence[str]
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.
- datacenter
Id Number A unique identifier for an existing data center in the domain.
- nickname String
A descriptive label for the group.
- countries
List
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.
GtmGeomapDefaultDatacenter
- Datacenter
Id int A unique identifier for an existing data center in the domain.
- Nickname string
A descriptive label for the group.
- Datacenter
Id int A unique identifier for an existing data center in the domain.
- Nickname string
A descriptive label for the group.
- datacenter
Id Integer A unique identifier for an existing data center in the domain.
- nickname String
A descriptive label for the group.
- datacenter
Id number A unique identifier for an existing data center in the domain.
- nickname string
A descriptive label for the group.
- datacenter_
id int A unique identifier for an existing data center in the domain.
- nickname str
A descriptive label for the group.
- datacenter
Id Number A unique identifier for an existing data center in the domain.
- nickname String
A descriptive label for the group.
Package Details
- Repository
- https://github.com/pulumi/pulumi-akamai
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
akamai
Terraform Provider.