Akamai
GtmCidrmap
Use the akamai.GtmCidrmap
resource to create, configure, and import a GTM Classless Inter-Domain Routing (CIDR) map. CIDR mapping uses the IP addresses of the requesting name server to provide IP-specific CNAME entries. CNAMEs let you direct internal users to a specific environment or direct them to the origin. This lets you provide different responses to an internal corporate DNS infrastructure, such as internal test environments and another answer for all other name servers (default_datacenter
).
CIDR maps split the Internet into multiple CIDR block zones. Properties that use a map can specify a handout CNAME for each zone on the property’s editing page. To configure a property for CIDR mapping, your domain needs at least one CIDR map defined.
Note Import requires an ID with this format:
existing_domain_name
:existing_map_name
.
Schema reference
You can download the GTM CIDR Map backing schema from the Global Traffic Management API page.
Example Usage
using Pulumi;
using Akamai = Pulumi.Akamai;
class MyStack : Stack
{
public MyStack()
{
var demoCidrmap = new Akamai.GtmCidrmap("demoCidrmap", new Akamai.GtmCidrmapArgs
{
DefaultDatacenter = new Akamai.Inputs.GtmCidrmapDefaultDatacenterArgs
{
DatacenterId = 5400,
Nickname = "All Other CIDR Blocks",
},
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.NewGtmCidrmap(ctx, "demoCidrmap", &akamai.GtmCidrmapArgs{
DefaultDatacenter: &GtmCidrmapDefaultDatacenterArgs{
DatacenterId: pulumi.Int(5400),
Nickname: pulumi.String("All Other CIDR Blocks"),
},
Domain: pulumi.String("demo_domain.akadns.net"),
})
if err != nil {
return err
}
return nil
})
}
Coming soon!
import pulumi
import pulumi_akamai as akamai
demo_cidrmap = akamai.GtmCidrmap("demoCidrmap",
default_datacenter=akamai.GtmCidrmapDefaultDatacenterArgs(
datacenter_id=5400,
nickname="All Other CIDR Blocks",
),
domain="demo_domain.akadns.net")
import * as pulumi from "@pulumi/pulumi";
import * as akamai from "@pulumi/akamai";
const demoCidrmap = new akamai.GtmCidrmap("demo_cidrmap", {
defaultDatacenter: {
datacenterId: 5400,
nickname: "All Other CIDR Blocks",
},
domain: "demo_domain.akadns.net",
});
Coming soon!
Create a GtmCidrmap Resource
new GtmCidrmap(name: string, args: GtmCidrmapArgs, opts?: CustomResourceOptions);
@overload
def GtmCidrmap(resource_name: str,
opts: Optional[ResourceOptions] = None,
assignments: Optional[Sequence[GtmCidrmapAssignmentArgs]] = None,
default_datacenter: Optional[GtmCidrmapDefaultDatacenterArgs] = None,
domain: Optional[str] = None,
name: Optional[str] = None,
wait_on_complete: Optional[bool] = None)
@overload
def GtmCidrmap(resource_name: str,
args: GtmCidrmapArgs,
opts: Optional[ResourceOptions] = None)
func NewGtmCidrmap(ctx *Context, name string, args GtmCidrmapArgs, opts ...ResourceOption) (*GtmCidrmap, error)
public GtmCidrmap(string name, GtmCidrmapArgs args, CustomResourceOptions? opts = null)
public GtmCidrmap(String name, GtmCidrmapArgs args)
public GtmCidrmap(String name, GtmCidrmapArgs args, CustomResourceOptions options)
type: akamai:GtmCidrmap
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args GtmCidrmapArgs
- 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 GtmCidrmapArgs
- 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 GtmCidrmapArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args GtmCidrmapArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args GtmCidrmapArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
GtmCidrmap 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 GtmCidrmap resource accepts the following input properties:
- Default
Datacenter GtmCidrmap Default Datacenter Args A placeholder for all other CIDR zones not found in these CIDR zones. Requires these additional arguments:
- Domain string
GTM Domain name for the AS Map.
- Assignments
List<Gtm
Cidrmap Assignment Args> Contains information about the CIDR zone groupings of CIDR blocks. You can have multiple entries with this argument. If used, requires these additional arguments:
- Name string
A descriptive label for the CIDR map, up to 255 characters.
- Wait
On boolComplete A boolean that, if set to
true
, waits for transaction to complete.
- Default
Datacenter GtmCidrmap Default Datacenter Args A placeholder for all other CIDR zones not found in these CIDR zones. Requires these additional arguments:
- Domain string
GTM Domain name for the AS Map.
- Assignments
[]Gtm
Cidrmap Assignment Args Contains information about the CIDR zone groupings of CIDR blocks. You can have multiple entries with this argument. If used, requires these additional arguments:
- Name string
A descriptive label for the CIDR map, up to 255 characters.
- Wait
On boolComplete A boolean that, if set to
true
, waits for transaction to complete.
- default
Datacenter GtmCidrmap Default Datacenter Args A placeholder for all other CIDR zones not found in these CIDR zones. Requires these additional arguments:
- domain String
GTM Domain name for the AS Map.
- assignments
List
Cidrmap Assignment Args> Contains information about the CIDR zone groupings of CIDR blocks. You can have multiple entries with this argument. If used, requires these additional arguments:
- name String
A descriptive label for the CIDR map, up to 255 characters.
- wait
On BooleanComplete A boolean that, if set to
true
, waits for transaction to complete.
- default
Datacenter GtmCidrmap Default Datacenter Args A placeholder for all other CIDR zones not found in these CIDR zones. Requires these additional arguments:
- domain string
GTM Domain name for the AS Map.
- assignments
Gtm
Cidrmap Assignment Args[] Contains information about the CIDR zone groupings of CIDR blocks. You can have multiple entries with this argument. If used, requires these additional arguments:
- name string
A descriptive label for the CIDR map, up to 255 characters.
- wait
On booleanComplete A boolean that, if set to
true
, waits for transaction to complete.
- default_
datacenter GtmCidrmap Default Datacenter Args A placeholder for all other CIDR zones not found in these CIDR zones. Requires these additional arguments:
- domain str
GTM Domain name for the AS Map.
- assignments
Sequence[Gtm
Cidrmap Assignment Args] Contains information about the CIDR zone groupings of CIDR blocks. You can have multiple entries with this argument. If used, requires these additional arguments:
- name str
A descriptive label for the CIDR map, up to 255 characters.
- wait_
on_ boolcomplete A boolean that, if set to
true
, waits for transaction to complete.
- default
Datacenter Property Map A placeholder for all other CIDR zones not found in these CIDR zones. Requires these additional arguments:
- domain String
GTM Domain name for the AS Map.
- assignments
List
Contains information about the CIDR zone groupings of CIDR blocks. You can have multiple entries with this argument. If used, requires these additional arguments:
- name String
A descriptive label for the CIDR map, up to 255 characters.
- wait
On BooleanComplete A boolean that, if set to
true
, waits for transaction to complete.
Outputs
All input properties are implicitly available as output properties. Additionally, the GtmCidrmap 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 GtmCidrmap Resource
Get an existing GtmCidrmap 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?: GtmCidrmapState, opts?: CustomResourceOptions): GtmCidrmap
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
assignments: Optional[Sequence[GtmCidrmapAssignmentArgs]] = None,
default_datacenter: Optional[GtmCidrmapDefaultDatacenterArgs] = None,
domain: Optional[str] = None,
name: Optional[str] = None,
wait_on_complete: Optional[bool] = None) -> GtmCidrmap
func GetGtmCidrmap(ctx *Context, name string, id IDInput, state *GtmCidrmapState, opts ...ResourceOption) (*GtmCidrmap, error)
public static GtmCidrmap Get(string name, Input<string> id, GtmCidrmapState? state, CustomResourceOptions? opts = null)
public static GtmCidrmap get(String name, Output<String> id, GtmCidrmapState 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
Cidrmap Assignment Args> Contains information about the CIDR zone groupings of CIDR blocks. You can have multiple entries with this argument. If used, requires these additional arguments:
- Default
Datacenter GtmCidrmap Default Datacenter Args A placeholder for all other CIDR zones not found in these CIDR zones. Requires these additional arguments:
- Domain string
GTM Domain name for the AS Map.
- Name string
A descriptive label for the CIDR map, up to 255 characters.
- Wait
On boolComplete A boolean that, if set to
true
, waits for transaction to complete.
- Assignments
[]Gtm
Cidrmap Assignment Args Contains information about the CIDR zone groupings of CIDR blocks. You can have multiple entries with this argument. If used, requires these additional arguments:
- Default
Datacenter GtmCidrmap Default Datacenter Args A placeholder for all other CIDR zones not found in these CIDR zones. Requires these additional arguments:
- Domain string
GTM Domain name for the AS Map.
- Name string
A descriptive label for the CIDR map, up to 255 characters.
- Wait
On boolComplete A boolean that, if set to
true
, waits for transaction to complete.
- assignments
List
Cidrmap Assignment Args> Contains information about the CIDR zone groupings of CIDR blocks. You can have multiple entries with this argument. If used, requires these additional arguments:
- default
Datacenter GtmCidrmap Default Datacenter Args A placeholder for all other CIDR zones not found in these CIDR zones. Requires these additional arguments:
- domain String
GTM Domain name for the AS Map.
- name String
A descriptive label for the CIDR map, up to 255 characters.
- wait
On BooleanComplete A boolean that, if set to
true
, waits for transaction to complete.
- assignments
Gtm
Cidrmap Assignment Args[] Contains information about the CIDR zone groupings of CIDR blocks. You can have multiple entries with this argument. If used, requires these additional arguments:
- default
Datacenter GtmCidrmap Default Datacenter Args A placeholder for all other CIDR zones not found in these CIDR zones. Requires these additional arguments:
- domain string
GTM Domain name for the AS Map.
- name string
A descriptive label for the CIDR map, up to 255 characters.
- wait
On booleanComplete A boolean that, if set to
true
, waits for transaction to complete.
- assignments
Sequence[Gtm
Cidrmap Assignment Args] Contains information about the CIDR zone groupings of CIDR blocks. You can have multiple entries with this argument. If used, requires these additional arguments:
- default_
datacenter GtmCidrmap Default Datacenter Args A placeholder for all other CIDR zones not found in these CIDR zones. Requires these additional arguments:
- domain str
GTM Domain name for the AS Map.
- name str
A descriptive label for the CIDR map, up to 255 characters.
- wait_
on_ boolcomplete A boolean that, if set to
true
, waits for transaction to complete.
- assignments
List
Contains information about the CIDR zone groupings of CIDR blocks. You can have multiple entries with this argument. If used, requires these additional arguments:
- default
Datacenter Property Map A placeholder for all other CIDR zones not found in these CIDR zones. Requires these additional arguments:
- domain String
GTM Domain name for the AS Map.
- name String
A descriptive label for the CIDR map, up to 255 characters.
- wait
On BooleanComplete A boolean that, if set to
true
, waits for transaction to complete.
Supporting Types
GtmCidrmapAssignment
- Datacenter
Id int A unique identifier for an existing data center in the domain.
- Nickname string
A descriptive label for the CIDR zone group, up to 256 characters.
- Blocks List<string>
Specifies an array of CIDR blocks.
- Datacenter
Id int A unique identifier for an existing data center in the domain.
- Nickname string
A descriptive label for the CIDR zone group, up to 256 characters.
- Blocks []string
Specifies an array of CIDR blocks.
- datacenter
Id Integer A unique identifier for an existing data center in the domain.
- nickname String
A descriptive label for the CIDR zone group, up to 256 characters.
- blocks
List
Specifies an array of CIDR blocks.
- datacenter
Id number A unique identifier for an existing data center in the domain.
- nickname string
A descriptive label for the CIDR zone group, up to 256 characters.
- blocks string[]
Specifies an array of CIDR blocks.
- datacenter_
id int A unique identifier for an existing data center in the domain.
- nickname str
A descriptive label for the CIDR zone group, up to 256 characters.
- blocks Sequence[str]
Specifies an array of CIDR blocks.
- datacenter
Id Number A unique identifier for an existing data center in the domain.
- nickname String
A descriptive label for the CIDR zone group, up to 256 characters.
- blocks
List
Specifies an array of CIDR blocks.
GtmCidrmapDefaultDatacenter
- Datacenter
Id int A unique identifier for an existing data center in the domain.
- Nickname string
A descriptive label for the CIDR zone group, up to 256 characters.
- Datacenter
Id int A unique identifier for an existing data center in the domain.
- Nickname string
A descriptive label for the CIDR zone group, up to 256 characters.
- datacenter
Id Integer A unique identifier for an existing data center in the domain.
- nickname String
A descriptive label for the CIDR zone group, up to 256 characters.
- datacenter
Id number A unique identifier for an existing data center in the domain.
- nickname string
A descriptive label for the CIDR zone group, up to 256 characters.
- datacenter_
id int A unique identifier for an existing data center in the domain.
- nickname str
A descriptive label for the CIDR zone group, up to 256 characters.
- datacenter
Id Number A unique identifier for an existing data center in the domain.
- nickname String
A descriptive label for the CIDR zone group, up to 256 characters.
Package Details
- Repository
- https://github.com/pulumi/pulumi-akamai
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
akamai
Terraform Provider.