NetworkList

Use the akamai.NetworkList resource to create a network list, or to modify an existing list.

Example Usage

using Pulumi;
using Akamai = Pulumi.Akamai;

class MyStack : Stack
{
    public MyStack()
    {
        var networkList = new Akamai.NetworkList("networkList", new Akamai.NetworkListArgs
        {
            Type = "IP",
            Description = "network list description",
            Lists = @var.List,
            Mode = "APPEND",
            ContractId = "ABC-123",
            GroupId = 12345,
        });
    }

}
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.NewNetworkList(ctx, "networkList", &akamai.NetworkListArgs{
			Type:        pulumi.String("IP"),
			Description: pulumi.String("network list description"),
			Lists:       pulumi.Any(_var.List),
			Mode:        pulumi.String("APPEND"),
			ContractId:  pulumi.String("ABC-123"),
			GroupId:     pulumi.Int(12345),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
import pulumi
import pulumi_akamai as akamai

network_list = akamai.NetworkList("networkList",
    type="IP",
    description="network list description",
    lists=var["list"],
    mode="APPEND",
    contract_id="ABC-123",
    group_id=12345)
import * as pulumi from "@pulumi/pulumi";
import * as akamai from "@pulumi/akamai";

const networkList = new akamai.NetworkList("networkList", {
    type: "IP",
    description: "network list description",
    lists: _var.list,
    mode: "APPEND",
    contractId: "ABC-123",
    groupId: 12345,
});

Create a NetworkList Resource

new NetworkList(name: string, args: NetworkListArgs, opts?: CustomResourceOptions);
@overload
def NetworkList(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                contract_id: Optional[str] = None,
                description: Optional[str] = None,
                group_id: Optional[int] = None,
                lists: Optional[Sequence[str]] = None,
                mode: Optional[str] = None,
                name: Optional[str] = None,
                type: Optional[str] = None)
@overload
def NetworkList(resource_name: str,
                args: NetworkListArgs,
                opts: Optional[ResourceOptions] = None)
func NewNetworkList(ctx *Context, name string, args NetworkListArgs, opts ...ResourceOption) (*NetworkList, error)
public NetworkList(string name, NetworkListArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args NetworkListArgs
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 NetworkListArgs
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 NetworkListArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args NetworkListArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

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

Description string
The description to be assigned to the network list.
Mode string
A string specifying the interpretation of the list parameter. Must be one of the following:
Type string
The type of the network list; must be either “IP” or “GEO”.
ContractId string
The contract ID of the network list. If supplied, group_id must also be supplied. The contract_id value of an existing network list may not be modified.
GroupId int
The group ID of the network list. If supplied, contract_id must also be supplied. The group_id value of an existing network list may not be modified.
Lists List<string>
: (Optional) A list of IP addresses or locations to be included in the list, added to an existing list, or removed from an existing list.
Name string
The name to be assigned to the network list.
Description string
The description to be assigned to the network list.
Mode string
A string specifying the interpretation of the list parameter. Must be one of the following:
Type string
The type of the network list; must be either “IP” or “GEO”.
ContractId string
The contract ID of the network list. If supplied, group_id must also be supplied. The contract_id value of an existing network list may not be modified.
GroupId int
The group ID of the network list. If supplied, contract_id must also be supplied. The group_id value of an existing network list may not be modified.
Lists []string
: (Optional) A list of IP addresses or locations to be included in the list, added to an existing list, or removed from an existing list.
Name string
The name to be assigned to the network list.
description string
The description to be assigned to the network list.
mode string
A string specifying the interpretation of the list parameter. Must be one of the following:
type string
The type of the network list; must be either “IP” or “GEO”.
contractId string
The contract ID of the network list. If supplied, group_id must also be supplied. The contract_id value of an existing network list may not be modified.
groupId number
The group ID of the network list. If supplied, contract_id must also be supplied. The group_id value of an existing network list may not be modified.
lists string[]
: (Optional) A list of IP addresses or locations to be included in the list, added to an existing list, or removed from an existing list.
name string
The name to be assigned to the network list.
description str
The description to be assigned to the network list.
mode str
A string specifying the interpretation of the list parameter. Must be one of the following:
type str
The type of the network list; must be either “IP” or “GEO”.
contract_id str
The contract ID of the network list. If supplied, group_id must also be supplied. The contract_id value of an existing network list may not be modified.
group_id int
The group ID of the network list. If supplied, contract_id must also be supplied. The group_id value of an existing network list may not be modified.
lists Sequence[str]
: (Optional) A list of IP addresses or locations to be included in the list, added to an existing list, or removed from an existing list.
name str
The name to be assigned to the network list.

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
NetworkListId string
The ID of the network list.
SyncPoint int
An integer that identifies the current version of the network list; this value is incremented each time the list is modified.
Uniqueid string
uniqueId
Id string
The provider-assigned unique ID for this managed resource.
NetworkListId string
The ID of the network list.
SyncPoint int
An integer that identifies the current version of the network list; this value is incremented each time the list is modified.
Uniqueid string
uniqueId
id string
The provider-assigned unique ID for this managed resource.
networkListId string
The ID of the network list.
syncPoint number
An integer that identifies the current version of the network list; this value is incremented each time the list is modified.
uniqueid string
uniqueId
id str
The provider-assigned unique ID for this managed resource.
network_list_id str
The ID of the network list.
sync_point int
An integer that identifies the current version of the network list; this value is incremented each time the list is modified.
uniqueid str
uniqueId

Look up an Existing NetworkList Resource

Get an existing NetworkList 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?: NetworkListState, opts?: CustomResourceOptions): NetworkList
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        contract_id: Optional[str] = None,
        description: Optional[str] = None,
        group_id: Optional[int] = None,
        lists: Optional[Sequence[str]] = None,
        mode: Optional[str] = None,
        name: Optional[str] = None,
        network_list_id: Optional[str] = None,
        sync_point: Optional[int] = None,
        type: Optional[str] = None,
        uniqueid: Optional[str] = None) -> NetworkList
func GetNetworkList(ctx *Context, name string, id IDInput, state *NetworkListState, opts ...ResourceOption) (*NetworkList, error)
public static NetworkList Get(string name, Input<string> id, NetworkListState? 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:

ContractId string
The contract ID of the network list. If supplied, group_id must also be supplied. The contract_id value of an existing network list may not be modified.
Description string
The description to be assigned to the network list.
GroupId int
The group ID of the network list. If supplied, contract_id must also be supplied. The group_id value of an existing network list may not be modified.
Lists List<string>
: (Optional) A list of IP addresses or locations to be included in the list, added to an existing list, or removed from an existing list.
Mode string
A string specifying the interpretation of the list parameter. Must be one of the following:
Name string
The name to be assigned to the network list.
NetworkListId string
The ID of the network list.
SyncPoint int
An integer that identifies the current version of the network list; this value is incremented each time the list is modified.
Type string
The type of the network list; must be either “IP” or “GEO”.
Uniqueid string
uniqueId
ContractId string
The contract ID of the network list. If supplied, group_id must also be supplied. The contract_id value of an existing network list may not be modified.
Description string
The description to be assigned to the network list.
GroupId int
The group ID of the network list. If supplied, contract_id must also be supplied. The group_id value of an existing network list may not be modified.
Lists []string
: (Optional) A list of IP addresses or locations to be included in the list, added to an existing list, or removed from an existing list.
Mode string
A string specifying the interpretation of the list parameter. Must be one of the following:
Name string
The name to be assigned to the network list.
NetworkListId string
The ID of the network list.
SyncPoint int
An integer that identifies the current version of the network list; this value is incremented each time the list is modified.
Type string
The type of the network list; must be either “IP” or “GEO”.
Uniqueid string
uniqueId
contractId string
The contract ID of the network list. If supplied, group_id must also be supplied. The contract_id value of an existing network list may not be modified.
description string
The description to be assigned to the network list.
groupId number
The group ID of the network list. If supplied, contract_id must also be supplied. The group_id value of an existing network list may not be modified.
lists string[]
: (Optional) A list of IP addresses or locations to be included in the list, added to an existing list, or removed from an existing list.
mode string
A string specifying the interpretation of the list parameter. Must be one of the following:
name string
The name to be assigned to the network list.
networkListId string
The ID of the network list.
syncPoint number
An integer that identifies the current version of the network list; this value is incremented each time the list is modified.
type string
The type of the network list; must be either “IP” or “GEO”.
uniqueid string
uniqueId
contract_id str
The contract ID of the network list. If supplied, group_id must also be supplied. The contract_id value of an existing network list may not be modified.
description str
The description to be assigned to the network list.
group_id int
The group ID of the network list. If supplied, contract_id must also be supplied. The group_id value of an existing network list may not be modified.
lists Sequence[str]
: (Optional) A list of IP addresses or locations to be included in the list, added to an existing list, or removed from an existing list.
mode str
A string specifying the interpretation of the list parameter. Must be one of the following:
name str
The name to be assigned to the network list.
network_list_id str
The ID of the network list.
sync_point int
An integer that identifies the current version of the network list; this value is incremented each time the list is modified.
type str
The type of the network list; must be either “IP” or “GEO”.
uniqueid str
uniqueId

Package Details

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