Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Akamai
  3. API Docs
  4. NetworkList
Akamai v7.5.0 published on Friday, Oct 11, 2024 by Pulumi
pulumi/pulumi-akamai

akamai.NetworkList

Explore with Pulumi AI

akamai logo
Akamai v7.5.0 published on Friday, Oct 11, 2024 by Pulumi
pulumi/pulumi-akamai

    Create NetworkList Resource

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

    Constructor syntax

    new NetworkList(name: string, args: NetworkListArgs, opts?: CustomResourceOptions);
    @overload
def NetworkList(resource_name: str,
                args: NetworkListArgs,
                opts: Optional[ResourceOptions] = None)

@overload
def NetworkList(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                description: Optional[str] = None,
                mode: Optional[str] = None,
                type: Optional[str] = None,
                contract_id: Optional[str] = None,
                group_id: Optional[int] = None,
                lists: Optional[Sequence[str]] = None,
                name: Optional[str] = None)
    func NewNetworkList(ctx *Context, name string, args NetworkListArgs, opts ...ResourceOption) (*NetworkList, error)
    public NetworkList(string name, NetworkListArgs args, CustomResourceOptions? opts = null)
    public NetworkList(String name, NetworkListArgs args)
public NetworkList(String name, NetworkListArgs args, CustomResourceOptions options)

    type: akamai:NetworkList
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 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.
    name String
    The unique name of the resource.
    args NetworkListArgs
    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 networkListResource = new Akamai.NetworkList("networkListResource", new()
{
    Description = "string",
    Mode = "string",
    Type = "string",
    ContractId = "string",
    GroupId = 0,
    Lists = new[]
    {
        "string",
    },
    Name = "string",
});

    example, err := akamai.NewNetworkList(ctx, "networkListResource", &akamai.NetworkListArgs{
	Description: pulumi.String("string"),
	Mode:        pulumi.String("string"),
	Type:        pulumi.String("string"),
	ContractId:  pulumi.String("string"),
	GroupId:     pulumi.Int(0),
	Lists: pulumi.StringArray{
		pulumi.String("string"),
	},
	Name: pulumi.String("string"),
})

    var networkListResource = new NetworkList("networkListResource", NetworkListArgs.builder()
    .description("string")
    .mode("string")
    .type("string")
    .contractId("string")
    .groupId(0)
    .lists("string")
    .name("string")
    .build());

    network_list_resource = akamai.NetworkList("networkListResource",
    description="string",
    mode="string",
    type="string",
    contract_id="string",
    group_id=0,
    lists=["string"],
    name="string")

    const networkListResource = new akamai.NetworkList("networkListResource", {
    description: "string",
    mode: "string",
    type: "string",
    contractId: "string",
    groupId: 0,
    lists: ["string"],
    name: "string",
});

    type: akamai:NetworkList
properties:
    contractId: string
    description: string
    groupId: 0
    lists:
        - string
    mode: string
    name: string
    type: string

    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

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The NetworkList resource accepts the following input properties:

    Description string
    A description of the network list
    Mode string
    A string specifying the interpretation of the list parameter. Must be 'APPEND', 'REPLACE', or 'REMOVE'
    Type string
    The type of the network list; must be either 'IP' or 'GEO'
    ContractId string
    contract ID
    GroupId int
    group ID
    Lists List<string>
    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
    A description of the network list
    Mode string
    A string specifying the interpretation of the list parameter. Must be 'APPEND', 'REPLACE', or 'REMOVE'
    Type string
    The type of the network list; must be either 'IP' or 'GEO'
    ContractId string
    contract ID
    GroupId int
    group ID
    Lists []string
    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
    A description of the network list
    mode String
    A string specifying the interpretation of the list parameter. Must be 'APPEND', 'REPLACE', or 'REMOVE'
    type String
    The type of the network list; must be either 'IP' or 'GEO'
    contractId String
    contract ID
    groupId Integer
    group ID
    lists List<String>
    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
    A description of the network list
    mode string
    A string specifying the interpretation of the list parameter. Must be 'APPEND', 'REPLACE', or 'REMOVE'
    type string
    The type of the network list; must be either 'IP' or 'GEO'
    contractId string
    contract ID
    groupId number
    group ID
    lists string[]
    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
    A description of the network list
    mode str
    A string specifying the interpretation of the list parameter. Must be 'APPEND', 'REPLACE', or 'REMOVE'
    type str
    The type of the network list; must be either 'IP' or 'GEO'
    contract_id str
    contract ID
    group_id int
    group ID
    lists Sequence[str]
    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
    description String
    A description of the network list
    mode String
    A string specifying the interpretation of the list parameter. Must be 'APPEND', 'REPLACE', or 'REMOVE'
    type String
    The type of the network list; must be either 'IP' or 'GEO'
    contractId String
    contract ID
    groupId Number
    group ID
    lists List<String>
    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

    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
    network list ID
    SyncPoint int
    sync point
    Uniqueid string
    unique ID
    Id string
    The provider-assigned unique ID for this managed resource.
    NetworkListId string
    network list ID
    SyncPoint int
    sync point
    Uniqueid string
    unique ID
    id String
    The provider-assigned unique ID for this managed resource.
    networkListId String
    network list ID
    syncPoint Integer
    sync point
    uniqueid String
    unique ID
    id string
    The provider-assigned unique ID for this managed resource.
    networkListId string
    network list ID
    syncPoint number
    sync point
    uniqueid string
    unique ID
    id str
    The provider-assigned unique ID for this managed resource.
    network_list_id str
    network list ID
    sync_point int
    sync point
    uniqueid str
    unique ID
    id String
    The provider-assigned unique ID for this managed resource.
    networkListId String
    network list ID
    syncPoint Number
    sync point
    uniqueid String
    unique ID

    Look up 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)
    public static NetworkList get(String name, Output<String> id, NetworkListState 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.
    The following state arguments are supported:
    ContractId string
    contract ID
    Description string
    A description of the network list
    GroupId int
    group ID
    Lists List<string>
    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 'APPEND', 'REPLACE', or 'REMOVE'
    Name string
    The name to be assigned to the network list
    NetworkListId string
    network list ID
    SyncPoint int
    sync point
    Type string
    The type of the network list; must be either 'IP' or 'GEO'
    Uniqueid string
    unique ID
    ContractId string
    contract ID
    Description string
    A description of the network list
    GroupId int
    group ID
    Lists []string
    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 'APPEND', 'REPLACE', or 'REMOVE'
    Name string
    The name to be assigned to the network list
    NetworkListId string
    network list ID
    SyncPoint int
    sync point
    Type string
    The type of the network list; must be either 'IP' or 'GEO'
    Uniqueid string
    unique ID
    contractId String
    contract ID
    description String
    A description of the network list
    groupId Integer
    group ID
    lists List<String>
    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 'APPEND', 'REPLACE', or 'REMOVE'
    name String
    The name to be assigned to the network list
    networkListId String
    network list ID
    syncPoint Integer
    sync point
    type String
    The type of the network list; must be either 'IP' or 'GEO'
    uniqueid String
    unique ID
    contractId string
    contract ID
    description string
    A description of the network list
    groupId number
    group ID
    lists string[]
    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 'APPEND', 'REPLACE', or 'REMOVE'
    name string
    The name to be assigned to the network list
    networkListId string
    network list ID
    syncPoint number
    sync point
    type string
    The type of the network list; must be either 'IP' or 'GEO'
    uniqueid string
    unique ID
    contract_id str
    contract ID
    description str
    A description of the network list
    group_id int
    group ID
    lists Sequence[str]
    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 'APPEND', 'REPLACE', or 'REMOVE'
    name str
    The name to be assigned to the network list
    network_list_id str
    network list ID
    sync_point int
    sync point
    type str
    The type of the network list; must be either 'IP' or 'GEO'
    uniqueid str
    unique ID
    contractId String
    contract ID
    description String
    A description of the network list
    groupId Number
    group ID
    lists List<String>
    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 'APPEND', 'REPLACE', or 'REMOVE'
    name String
    The name to be assigned to the network list
    networkListId String
    network list ID
    syncPoint Number
    sync point
    type String
    The type of the network list; must be either 'IP' or 'GEO'
    uniqueid String
    unique ID

    Package Details

    Repository
    Akamai pulumi/pulumi-akamai
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the akamai Terraform Provider.
    akamai logo
    Akamai v7.5.0 published on Friday, Oct 11, 2024 by Pulumi
    pulumi/pulumi-akamai