Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Sysdig Provider
  3. API Docs
  4. AgentAccessKey
sysdig 1.56.0 published on Wednesday, Apr 30, 2025 by sysdiglabs
sysdiglabs/terraform-provider-sysdig

sysdig.AgentAccessKey

Explore with Pulumi AI

sysdig logo
sysdig 1.56.0 published on Wednesday, Apr 30, 2025 by sysdiglabs
sysdiglabs/terraform-provider-sysdig

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as sysdig from "@pulumi/sysdig";

const myAgentAccessKey = new sysdig.AgentAccessKey("myAgentAccessKey", {
    enabled: true,
    limit: 11,
    metadata: {
        environment: "development",
        team: "awesome_team",
        test: "yes",
    },
    reservation: 1,
    teamId: 50012099,
});

    import pulumi
import pulumi_sysdig as sysdig

my_agent_access_key = sysdig.AgentAccessKey("myAgentAccessKey",
    enabled=True,
    limit=11,
    metadata={
        "environment": "development",
        "team": "awesome_team",
        "test": "yes",
    },
    reservation=1,
    team_id=50012099)

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/sysdig/sysdig"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := sysdig.NewAgentAccessKey(ctx, "myAgentAccessKey", &sysdig.AgentAccessKeyArgs{
			Enabled: pulumi.Bool(true),
			Limit:   pulumi.Float64(11),
			Metadata: pulumi.StringMap{
				"environment": pulumi.String("development"),
				"team":        pulumi.String("awesome_team"),
				"test":        pulumi.String("yes"),
			},
			Reservation: pulumi.Float64(1),
			TeamId:      pulumi.Float64(50012099),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Sysdig = Pulumi.Sysdig;

return await Deployment.RunAsync(() => 
{
    var myAgentAccessKey = new Sysdig.AgentAccessKey("myAgentAccessKey", new()
    {
        Enabled = true,
        Limit = 11,
        Metadata = 
        {
            { "environment", "development" },
            { "team", "awesome_team" },
            { "test", "yes" },
        },
        Reservation = 1,
        TeamId = 50012099,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.sysdig.AgentAccessKey;
import com.pulumi.sysdig.AgentAccessKeyArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var myAgentAccessKey = new AgentAccessKey("myAgentAccessKey", AgentAccessKeyArgs.builder()
            .enabled(true)
            .limit(11)
            .metadata(Map.ofEntries(
                Map.entry("environment", "development"),
                Map.entry("team", "awesome_team"),
                Map.entry("test", "yes")
            ))
            .reservation(1)
            .teamId(50012099)
            .build());

    }
}

    resources:
  myAgentAccessKey:
    type: sysdig:AgentAccessKey
    properties:
      enabled: true
      limit: 11
      metadata:
        environment: development
        team: awesome_team
        test: yes
      reservation: 1
      teamId: 5.0012099e+07

    Create AgentAccessKey Resource

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

    Constructor syntax

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

@overload
def AgentAccessKey(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   agent_access_key_id: Optional[str] = None,
                   enabled: Optional[bool] = None,
                   limit: Optional[float] = None,
                   metadata: Optional[Mapping[str, str]] = None,
                   reservation: Optional[float] = None,
                   team_id: Optional[float] = None,
                   timeouts: Optional[AgentAccessKeyTimeoutsArgs] = None)
    func NewAgentAccessKey(ctx *Context, name string, args *AgentAccessKeyArgs, opts ...ResourceOption) (*AgentAccessKey, error)
    public AgentAccessKey(string name, AgentAccessKeyArgs? args = null, CustomResourceOptions? opts = null)
    public AgentAccessKey(String name, AgentAccessKeyArgs args)
public AgentAccessKey(String name, AgentAccessKeyArgs args, CustomResourceOptions options)

    type: sysdig:AgentAccessKey
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 AgentAccessKeyArgs
    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 AgentAccessKeyArgs
    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 AgentAccessKeyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AgentAccessKeyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AgentAccessKeyArgs
    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 agentAccessKeyResource = new Sysdig.AgentAccessKey("agentAccessKeyResource", new()
{
    AgentAccessKeyId = "string",
    Enabled = false,
    Limit = 0,
    Metadata = 
    {
        { "string", "string" },
    },
    Reservation = 0,
    TeamId = 0,
    Timeouts = new Sysdig.Inputs.AgentAccessKeyTimeoutsArgs
    {
        Create = "string",
        Delete = "string",
        Read = "string",
        Update = "string",
    },
});

    example, err := sysdig.NewAgentAccessKey(ctx, "agentAccessKeyResource", &sysdig.AgentAccessKeyArgs{
	AgentAccessKeyId: pulumi.String("string"),
	Enabled:          pulumi.Bool(false),
	Limit:            pulumi.Float64(0),
	Metadata: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Reservation: pulumi.Float64(0),
	TeamId:      pulumi.Float64(0),
	Timeouts: &sysdig.AgentAccessKeyTimeoutsArgs{
		Create: pulumi.String("string"),
		Delete: pulumi.String("string"),
		Read:   pulumi.String("string"),
		Update: pulumi.String("string"),
	},
})

    var agentAccessKeyResource = new AgentAccessKey("agentAccessKeyResource", AgentAccessKeyArgs.builder()
    .agentAccessKeyId("string")
    .enabled(false)
    .limit(0)
    .metadata(Map.of("string", "string"))
    .reservation(0)
    .teamId(0)
    .timeouts(AgentAccessKeyTimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .read("string")
        .update("string")
        .build())
    .build());

    agent_access_key_resource = sysdig.AgentAccessKey("agentAccessKeyResource",
    agent_access_key_id="string",
    enabled=False,
    limit=0,
    metadata={
        "string": "string",
    },
    reservation=0,
    team_id=0,
    timeouts={
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
    })

    const agentAccessKeyResource = new sysdig.AgentAccessKey("agentAccessKeyResource", {
    agentAccessKeyId: "string",
    enabled: false,
    limit: 0,
    metadata: {
        string: "string",
    },
    reservation: 0,
    teamId: 0,
    timeouts: {
        create: "string",
        "delete": "string",
        read: "string",
        update: "string",
    },
});

    type: sysdig:AgentAccessKey
properties:
    agentAccessKeyId: string
    enabled: false
    limit: 0
    metadata:
        string: string
    reservation: 0
    teamId: 0
    timeouts:
        create: string
        delete: string
        read: string
        update: string

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

    AgentAccessKeyId string
    Enabled bool
    Whether the agent access key is enabled or not. It is only used in update actions, an agent access keys can be deleted only if it's disabled.
    Limit double
    The limit of the agent access key.
    Metadata Dictionary<string, string>
    The metadata of agent access key.
    Reservation double
    The reservation of the agent access key.
    TeamId double
    The team id of the agent access key.
    Timeouts AgentAccessKeyTimeouts
    AgentAccessKeyId string
    Enabled bool
    Whether the agent access key is enabled or not. It is only used in update actions, an agent access keys can be deleted only if it's disabled.
    Limit float64
    The limit of the agent access key.
    Metadata map[string]string
    The metadata of agent access key.
    Reservation float64
    The reservation of the agent access key.
    TeamId float64
    The team id of the agent access key.
    Timeouts AgentAccessKeyTimeoutsArgs
    agentAccessKeyId String
    enabled Boolean
    Whether the agent access key is enabled or not. It is only used in update actions, an agent access keys can be deleted only if it's disabled.
    limit Double
    The limit of the agent access key.
    metadata Map<String,String>
    The metadata of agent access key.
    reservation Double
    The reservation of the agent access key.
    teamId Double
    The team id of the agent access key.
    timeouts AgentAccessKeyTimeouts
    agentAccessKeyId string
    enabled boolean
    Whether the agent access key is enabled or not. It is only used in update actions, an agent access keys can be deleted only if it's disabled.
    limit number
    The limit of the agent access key.
    metadata {[key: string]: string}
    The metadata of agent access key.
    reservation number
    The reservation of the agent access key.
    teamId number
    The team id of the agent access key.
    timeouts AgentAccessKeyTimeouts
    agent_access_key_id str
    enabled bool
    Whether the agent access key is enabled or not. It is only used in update actions, an agent access keys can be deleted only if it's disabled.
    limit float
    The limit of the agent access key.
    metadata Mapping[str, str]
    The metadata of agent access key.
    reservation float
    The reservation of the agent access key.
    team_id float
    The team id of the agent access key.
    timeouts AgentAccessKeyTimeoutsArgs
    agentAccessKeyId String
    enabled Boolean
    Whether the agent access key is enabled or not. It is only used in update actions, an agent access keys can be deleted only if it's disabled.
    limit Number
    The limit of the agent access key.
    metadata Map<String>
    The metadata of agent access key.
    reservation Number
    The reservation of the agent access key.
    teamId Number
    The team id of the agent access key.
    timeouts Property Map

    Outputs

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

    AccessKey string
    The agent access key.
    DateCreated string
    Date when the agent key was created.
    DateDisabled string
    Date when the agent key was last disabled.
    Id string
    The provider-assigned unique ID for this managed resource.
    AccessKey string
    The agent access key.
    DateCreated string
    Date when the agent key was created.
    DateDisabled string
    Date when the agent key was last disabled.
    Id string
    The provider-assigned unique ID for this managed resource.
    accessKey String
    The agent access key.
    dateCreated String
    Date when the agent key was created.
    dateDisabled String
    Date when the agent key was last disabled.
    id String
    The provider-assigned unique ID for this managed resource.
    accessKey string
    The agent access key.
    dateCreated string
    Date when the agent key was created.
    dateDisabled string
    Date when the agent key was last disabled.
    id string
    The provider-assigned unique ID for this managed resource.
    access_key str
    The agent access key.
    date_created str
    Date when the agent key was created.
    date_disabled str
    Date when the agent key was last disabled.
    id str
    The provider-assigned unique ID for this managed resource.
    accessKey String
    The agent access key.
    dateCreated String
    Date when the agent key was created.
    dateDisabled String
    Date when the agent key was last disabled.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing AgentAccessKey Resource

    Get an existing AgentAccessKey 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?: AgentAccessKeyState, opts?: CustomResourceOptions): AgentAccessKey
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        access_key: Optional[str] = None,
        agent_access_key_id: Optional[str] = None,
        date_created: Optional[str] = None,
        date_disabled: Optional[str] = None,
        enabled: Optional[bool] = None,
        limit: Optional[float] = None,
        metadata: Optional[Mapping[str, str]] = None,
        reservation: Optional[float] = None,
        team_id: Optional[float] = None,
        timeouts: Optional[AgentAccessKeyTimeoutsArgs] = None) -> AgentAccessKey
    func GetAgentAccessKey(ctx *Context, name string, id IDInput, state *AgentAccessKeyState, opts ...ResourceOption) (*AgentAccessKey, error)
    public static AgentAccessKey Get(string name, Input<string> id, AgentAccessKeyState? state, CustomResourceOptions? opts = null)
    public static AgentAccessKey get(String name, Output<String> id, AgentAccessKeyState state, CustomResourceOptions options)
    resources:  _:    type: sysdig:AgentAccessKey    get:      id: ${id}
    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:
    AccessKey string
    The agent access key.
    AgentAccessKeyId string
    DateCreated string
    Date when the agent key was created.
    DateDisabled string
    Date when the agent key was last disabled.
    Enabled bool
    Whether the agent access key is enabled or not. It is only used in update actions, an agent access keys can be deleted only if it's disabled.
    Limit double
    The limit of the agent access key.
    Metadata Dictionary<string, string>
    The metadata of agent access key.
    Reservation double
    The reservation of the agent access key.
    TeamId double
    The team id of the agent access key.
    Timeouts AgentAccessKeyTimeouts
    AccessKey string
    The agent access key.
    AgentAccessKeyId string
    DateCreated string
    Date when the agent key was created.
    DateDisabled string
    Date when the agent key was last disabled.
    Enabled bool
    Whether the agent access key is enabled or not. It is only used in update actions, an agent access keys can be deleted only if it's disabled.
    Limit float64
    The limit of the agent access key.
    Metadata map[string]string
    The metadata of agent access key.
    Reservation float64
    The reservation of the agent access key.
    TeamId float64
    The team id of the agent access key.
    Timeouts AgentAccessKeyTimeoutsArgs
    accessKey String
    The agent access key.
    agentAccessKeyId String
    dateCreated String
    Date when the agent key was created.
    dateDisabled String
    Date when the agent key was last disabled.
    enabled Boolean
    Whether the agent access key is enabled or not. It is only used in update actions, an agent access keys can be deleted only if it's disabled.
    limit Double
    The limit of the agent access key.
    metadata Map<String,String>
    The metadata of agent access key.
    reservation Double
    The reservation of the agent access key.
    teamId Double
    The team id of the agent access key.
    timeouts AgentAccessKeyTimeouts
    accessKey string
    The agent access key.
    agentAccessKeyId string
    dateCreated string
    Date when the agent key was created.
    dateDisabled string
    Date when the agent key was last disabled.
    enabled boolean
    Whether the agent access key is enabled or not. It is only used in update actions, an agent access keys can be deleted only if it's disabled.
    limit number
    The limit of the agent access key.
    metadata {[key: string]: string}
    The metadata of agent access key.
    reservation number
    The reservation of the agent access key.
    teamId number
    The team id of the agent access key.
    timeouts AgentAccessKeyTimeouts
    access_key str
    The agent access key.
    agent_access_key_id str
    date_created str
    Date when the agent key was created.
    date_disabled str
    Date when the agent key was last disabled.
    enabled bool
    Whether the agent access key is enabled or not. It is only used in update actions, an agent access keys can be deleted only if it's disabled.
    limit float
    The limit of the agent access key.
    metadata Mapping[str, str]
    The metadata of agent access key.
    reservation float
    The reservation of the agent access key.
    team_id float
    The team id of the agent access key.
    timeouts AgentAccessKeyTimeoutsArgs
    accessKey String
    The agent access key.
    agentAccessKeyId String
    dateCreated String
    Date when the agent key was created.
    dateDisabled String
    Date when the agent key was last disabled.
    enabled Boolean
    Whether the agent access key is enabled or not. It is only used in update actions, an agent access keys can be deleted only if it's disabled.
    limit Number
    The limit of the agent access key.
    metadata Map<String>
    The metadata of agent access key.
    reservation Number
    The reservation of the agent access key.
    teamId Number
    The team id of the agent access key.
    timeouts Property Map

    Supporting Types

    AgentAccessKeyTimeouts, AgentAccessKeyTimeoutsArgs

    Create string
    Delete string
    Read string
    Update string
    Create string
    Delete string
    Read string
    Update string
    create String
    delete String
    read String
    update String
    create string
    delete string
    read string
    update string
    create str
    delete str
    read str
    update str
    create String
    delete String
    read String
    update String

    Import

    Sysdig group mapping can be imported using the ID, e.g.

    $ pulumi import sysdig:index/agentAccessKey:AgentAccessKey my_agent_access_key "631123"

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    sysdig sysdiglabs/terraform-provider-sysdig
    License
    Notes
    This Pulumi package is based on the sysdig Terraform Provider.
    sysdig logo
    sysdig 1.56.0 published on Wednesday, Apr 30, 2025 by sysdiglabs
    sysdiglabs/terraform-provider-sysdig