1. Packages
  2. Akamai
  3. API Docs
  4. ClientlistList
Akamai v8.1.0 published on Friday, Apr 11, 2025 by Pulumi

akamai.ClientlistList

Explore with Pulumi AI

Create ClientlistList Resource

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

Constructor syntax

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

@overload
def ClientlistList(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   contract_id: Optional[str] = None,
                   group_id: Optional[int] = None,
                   type: Optional[str] = None,
                   items: Optional[Sequence[ClientlistListItemArgs]] = None,
                   name: Optional[str] = None,
                   notes: Optional[str] = None,
                   tags: Optional[Sequence[str]] = None)
func NewClientlistList(ctx *Context, name string, args ClientlistListArgs, opts ...ResourceOption) (*ClientlistList, error)
public ClientlistList(string name, ClientlistListArgs args, CustomResourceOptions? opts = null)
public ClientlistList(String name, ClientlistListArgs args)
public ClientlistList(String name, ClientlistListArgs args, CustomResourceOptions options)
type: akamai:ClientlistList
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. ClientlistListArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. ClientlistListArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. ClientlistListArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ClientlistListArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ClientlistListArgs
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 clientlistListResource = new Akamai.ClientlistList("clientlistListResource", new()
{
    ContractId = "string",
    GroupId = 0,
    Type = "string",
    Items = new[]
    {
        new Akamai.Inputs.ClientlistListItemArgs
        {
            Value = "string",
            Description = "string",
            ExpirationDate = "string",
            Tags = new[]
            {
                "string",
            },
        },
    },
    Name = "string",
    Notes = "string",
    Tags = new[]
    {
        "string",
    },
});
Copy
example, err := akamai.NewClientlistList(ctx, "clientlistListResource", &akamai.ClientlistListArgs{
	ContractId: pulumi.String("string"),
	GroupId:    pulumi.Int(0),
	Type:       pulumi.String("string"),
	Items: akamai.ClientlistListItemArray{
		&akamai.ClientlistListItemArgs{
			Value:          pulumi.String("string"),
			Description:    pulumi.String("string"),
			ExpirationDate: pulumi.String("string"),
			Tags: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
	},
	Name:  pulumi.String("string"),
	Notes: pulumi.String("string"),
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
})
Copy
var clientlistListResource = new ClientlistList("clientlistListResource", ClientlistListArgs.builder()
    .contractId("string")
    .groupId(0)
    .type("string")
    .items(ClientlistListItemArgs.builder()
        .value("string")
        .description("string")
        .expirationDate("string")
        .tags("string")
        .build())
    .name("string")
    .notes("string")
    .tags("string")
    .build());
Copy
clientlist_list_resource = akamai.ClientlistList("clientlistListResource",
    contract_id="string",
    group_id=0,
    type="string",
    items=[{
        "value": "string",
        "description": "string",
        "expiration_date": "string",
        "tags": ["string"],
    }],
    name="string",
    notes="string",
    tags=["string"])
Copy
const clientlistListResource = new akamai.ClientlistList("clientlistListResource", {
    contractId: "string",
    groupId: 0,
    type: "string",
    items: [{
        value: "string",
        description: "string",
        expirationDate: "string",
        tags: ["string"],
    }],
    name: "string",
    notes: "string",
    tags: ["string"],
});
Copy
type: akamai:ClientlistList
properties:
    contractId: string
    groupId: 0
    items:
        - description: string
          expirationDate: string
          tags:
            - string
          value: string
    name: string
    notes: string
    tags:
        - string
    type: string
Copy

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

ContractId
This property is required.
Changes to this property will trigger replacement.
string
Contract ID for which client list is assigned.
GroupId
This property is required.
Changes to this property will trigger replacement.
int
Group ID for which client list is assigned.
Type
This property is required.
Changes to this property will trigger replacement.
string
The type of the client list. Valid types: [IP GEO ASN TLS_FINGERPRINT FILE_HASH]
Items List<ClientlistListItem>
Set of items containing item information.
Name string
The name of the client list.
Notes string
The client list notes.
Tags List<string>
The client list tags.
ContractId
This property is required.
Changes to this property will trigger replacement.
string
Contract ID for which client list is assigned.
GroupId
This property is required.
Changes to this property will trigger replacement.
int
Group ID for which client list is assigned.
Type
This property is required.
Changes to this property will trigger replacement.
string
The type of the client list. Valid types: [IP GEO ASN TLS_FINGERPRINT FILE_HASH]
Items []ClientlistListItemArgs
Set of items containing item information.
Name string
The name of the client list.
Notes string
The client list notes.
Tags []string
The client list tags.
contractId
This property is required.
Changes to this property will trigger replacement.
String
Contract ID for which client list is assigned.
groupId
This property is required.
Changes to this property will trigger replacement.
Integer
Group ID for which client list is assigned.
type
This property is required.
Changes to this property will trigger replacement.
String
The type of the client list. Valid types: [IP GEO ASN TLS_FINGERPRINT FILE_HASH]
items List<ClientlistListItem>
Set of items containing item information.
name String
The name of the client list.
notes String
The client list notes.
tags List<String>
The client list tags.
contractId
This property is required.
Changes to this property will trigger replacement.
string
Contract ID for which client list is assigned.
groupId
This property is required.
Changes to this property will trigger replacement.
number
Group ID for which client list is assigned.
type
This property is required.
Changes to this property will trigger replacement.
string
The type of the client list. Valid types: [IP GEO ASN TLS_FINGERPRINT FILE_HASH]
items ClientlistListItem[]
Set of items containing item information.
name string
The name of the client list.
notes string
The client list notes.
tags string[]
The client list tags.
contract_id
This property is required.
Changes to this property will trigger replacement.
str
Contract ID for which client list is assigned.
group_id
This property is required.
Changes to this property will trigger replacement.
int
Group ID for which client list is assigned.
type
This property is required.
Changes to this property will trigger replacement.
str
The type of the client list. Valid types: [IP GEO ASN TLS_FINGERPRINT FILE_HASH]
items Sequence[ClientlistListItemArgs]
Set of items containing item information.
name str
The name of the client list.
notes str
The client list notes.
tags Sequence[str]
The client list tags.
contractId
This property is required.
Changes to this property will trigger replacement.
String
Contract ID for which client list is assigned.
groupId
This property is required.
Changes to this property will trigger replacement.
Number
Group ID for which client list is assigned.
type
This property is required.
Changes to this property will trigger replacement.
String
The type of the client list. Valid types: [IP GEO ASN TLS_FINGERPRINT FILE_HASH]
items List<Property Map>
Set of items containing item information.
name String
The name of the client list.
notes String
The client list notes.
tags List<String>
The client list tags.

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
ItemsCount int
The number of items that a client list contains.
ListId string
The ID of the client list.
Version int
The current version of the client list.
Id string
The provider-assigned unique ID for this managed resource.
ItemsCount int
The number of items that a client list contains.
ListId string
The ID of the client list.
Version int
The current version of the client list.
id String
The provider-assigned unique ID for this managed resource.
itemsCount Integer
The number of items that a client list contains.
listId String
The ID of the client list.
version Integer
The current version of the client list.
id string
The provider-assigned unique ID for this managed resource.
itemsCount number
The number of items that a client list contains.
listId string
The ID of the client list.
version number
The current version of the client list.
id str
The provider-assigned unique ID for this managed resource.
items_count int
The number of items that a client list contains.
list_id str
The ID of the client list.
version int
The current version of the client list.
id String
The provider-assigned unique ID for this managed resource.
itemsCount Number
The number of items that a client list contains.
listId String
The ID of the client list.
version Number
The current version of the client list.

Look up Existing ClientlistList Resource

Get an existing ClientlistList 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?: ClientlistListState, opts?: CustomResourceOptions): ClientlistList
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        contract_id: Optional[str] = None,
        group_id: Optional[int] = None,
        items: Optional[Sequence[ClientlistListItemArgs]] = None,
        items_count: Optional[int] = None,
        list_id: Optional[str] = None,
        name: Optional[str] = None,
        notes: Optional[str] = None,
        tags: Optional[Sequence[str]] = None,
        type: Optional[str] = None,
        version: Optional[int] = None) -> ClientlistList
func GetClientlistList(ctx *Context, name string, id IDInput, state *ClientlistListState, opts ...ResourceOption) (*ClientlistList, error)
public static ClientlistList Get(string name, Input<string> id, ClientlistListState? state, CustomResourceOptions? opts = null)
public static ClientlistList get(String name, Output<String> id, ClientlistListState state, CustomResourceOptions options)
resources:  _:    type: akamai:ClientlistList    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 Changes to this property will trigger replacement. string
Contract ID for which client list is assigned.
GroupId Changes to this property will trigger replacement. int
Group ID for which client list is assigned.
Items List<ClientlistListItem>
Set of items containing item information.
ItemsCount int
The number of items that a client list contains.
ListId string
The ID of the client list.
Name string
The name of the client list.
Notes string
The client list notes.
Tags List<string>
The client list tags.
Type Changes to this property will trigger replacement. string
The type of the client list. Valid types: [IP GEO ASN TLS_FINGERPRINT FILE_HASH]
Version int
The current version of the client list.
ContractId Changes to this property will trigger replacement. string
Contract ID for which client list is assigned.
GroupId Changes to this property will trigger replacement. int
Group ID for which client list is assigned.
Items []ClientlistListItemArgs
Set of items containing item information.
ItemsCount int
The number of items that a client list contains.
ListId string
The ID of the client list.
Name string
The name of the client list.
Notes string
The client list notes.
Tags []string
The client list tags.
Type Changes to this property will trigger replacement. string
The type of the client list. Valid types: [IP GEO ASN TLS_FINGERPRINT FILE_HASH]
Version int
The current version of the client list.
contractId Changes to this property will trigger replacement. String
Contract ID for which client list is assigned.
groupId Changes to this property will trigger replacement. Integer
Group ID for which client list is assigned.
items List<ClientlistListItem>
Set of items containing item information.
itemsCount Integer
The number of items that a client list contains.
listId String
The ID of the client list.
name String
The name of the client list.
notes String
The client list notes.
tags List<String>
The client list tags.
type Changes to this property will trigger replacement. String
The type of the client list. Valid types: [IP GEO ASN TLS_FINGERPRINT FILE_HASH]
version Integer
The current version of the client list.
contractId Changes to this property will trigger replacement. string
Contract ID for which client list is assigned.
groupId Changes to this property will trigger replacement. number
Group ID for which client list is assigned.
items ClientlistListItem[]
Set of items containing item information.
itemsCount number
The number of items that a client list contains.
listId string
The ID of the client list.
name string
The name of the client list.
notes string
The client list notes.
tags string[]
The client list tags.
type Changes to this property will trigger replacement. string
The type of the client list. Valid types: [IP GEO ASN TLS_FINGERPRINT FILE_HASH]
version number
The current version of the client list.
contract_id Changes to this property will trigger replacement. str
Contract ID for which client list is assigned.
group_id Changes to this property will trigger replacement. int
Group ID for which client list is assigned.
items Sequence[ClientlistListItemArgs]
Set of items containing item information.
items_count int
The number of items that a client list contains.
list_id str
The ID of the client list.
name str
The name of the client list.
notes str
The client list notes.
tags Sequence[str]
The client list tags.
type Changes to this property will trigger replacement. str
The type of the client list. Valid types: [IP GEO ASN TLS_FINGERPRINT FILE_HASH]
version int
The current version of the client list.
contractId Changes to this property will trigger replacement. String
Contract ID for which client list is assigned.
groupId Changes to this property will trigger replacement. Number
Group ID for which client list is assigned.
items List<Property Map>
Set of items containing item information.
itemsCount Number
The number of items that a client list contains.
listId String
The ID of the client list.
name String
The name of the client list.
notes String
The client list notes.
tags List<String>
The client list tags.
type Changes to this property will trigger replacement. String
The type of the client list. Valid types: [IP GEO ASN TLS_FINGERPRINT FILE_HASH]
version Number
The current version of the client list.

Supporting Types

ClientlistListItem
, ClientlistListItemArgs

Value This property is required. string
Value of the item. (i.e. IP address, AS Number, GEO, ...etc)
Description string
A description of the item.
ExpirationDate string
The item expiration date.
Tags List<string>
The item tags.
Value This property is required. string
Value of the item. (i.e. IP address, AS Number, GEO, ...etc)
Description string
A description of the item.
ExpirationDate string
The item expiration date.
Tags []string
The item tags.
value This property is required. String
Value of the item. (i.e. IP address, AS Number, GEO, ...etc)
description String
A description of the item.
expirationDate String
The item expiration date.
tags List<String>
The item tags.
value This property is required. string
Value of the item. (i.e. IP address, AS Number, GEO, ...etc)
description string
A description of the item.
expirationDate string
The item expiration date.
tags string[]
The item tags.
value This property is required. str
Value of the item. (i.e. IP address, AS Number, GEO, ...etc)
description str
A description of the item.
expiration_date str
The item expiration date.
tags Sequence[str]
The item tags.
value This property is required. String
Value of the item. (i.e. IP address, AS Number, GEO, ...etc)
description String
A description of the item.
expirationDate String
The item expiration date.
tags List<String>
The item tags.

Package Details

Repository
Akamai pulumi/pulumi-akamai
License
Apache-2.0
Notes
This Pulumi package is based on the akamai Terraform Provider.