Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Coralogix Provider
  3. API Docs
  4. ApiKey
coralogix 2.0.17 published on Tuesday, Apr 22, 2025 by coralogix
coralogix/terraform-provider-coralogix

coralogix.ApiKey

Explore with Pulumi AI

coralogix logo
coralogix 2.0.17 published on Tuesday, Apr 22, 2025 by coralogix
coralogix/terraform-provider-coralogix

    Coralogix Api keys.

    Example Usage

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.coralogix.ApiKey;
import com.pulumi.coralogix.ApiKeyArgs;
import com.pulumi.coralogix.inputs.ApiKeyOwnerArgs;
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 example = new ApiKey("example", ApiKeyArgs.builder()
            .owner(ApiKeyOwnerArgs.builder()
                .team_id("4013254")
                .build())
            .active(true)
            .presets("APM")
            .permissions("livetail:Read")
            .build());

    }
}

    resources:
  example:
    type: coralogix:ApiKey
    properties:
      owner:
        team_id: '4013254'
      active: true
      presets:
        - APM
      permissions:
        - livetail:Read

    Create ApiKey Resource

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

    Constructor syntax

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

@overload
def ApiKey(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           owner: Optional[ApiKeyOwnerArgs] = None,
           permissions: Optional[Sequence[str]] = None,
           presets: Optional[Sequence[str]] = None,
           active: Optional[bool] = None,
           name: Optional[str] = None)
    func NewApiKey(ctx *Context, name string, args ApiKeyArgs, opts ...ResourceOption) (*ApiKey, error)
    public ApiKey(string name, ApiKeyArgs args, CustomResourceOptions? opts = null)
    public ApiKey(String name, ApiKeyArgs args)
public ApiKey(String name, ApiKeyArgs args, CustomResourceOptions options)

    type: coralogix:ApiKey
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 ApiKeyArgs
    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 ApiKeyArgs
    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 ApiKeyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ApiKeyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ApiKeyArgs
    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 apiKeyResource = new Coralogix.ApiKey("apiKeyResource", new()
{
    Owner = new Coralogix.Inputs.ApiKeyOwnerArgs
    {
        OrganisationId = "string",
        TeamId = "string",
        UserId = "string",
    },
    Permissions = new[]
    {
        "string",
    },
    Presets = new[]
    {
        "string",
    },
    Active = false,
    Name = "string",
});

    example, err := coralogix.NewApiKey(ctx, "apiKeyResource", &coralogix.ApiKeyArgs{
	Owner: &coralogix.ApiKeyOwnerArgs{
		OrganisationId: pulumi.String("string"),
		TeamId:         pulumi.String("string"),
		UserId:         pulumi.String("string"),
	},
	Permissions: pulumi.StringArray{
		pulumi.String("string"),
	},
	Presets: pulumi.StringArray{
		pulumi.String("string"),
	},
	Active: pulumi.Bool(false),
	Name:   pulumi.String("string"),
})

    var apiKeyResource = new ApiKey("apiKeyResource", ApiKeyArgs.builder()
    .owner(ApiKeyOwnerArgs.builder()
        .organisationId("string")
        .teamId("string")
        .userId("string")
        .build())
    .permissions("string")
    .presets("string")
    .active(false)
    .name("string")
    .build());

    api_key_resource = coralogix.ApiKey("apiKeyResource",
    owner={
        "organisation_id": "string",
        "team_id": "string",
        "user_id": "string",
    },
    permissions=["string"],
    presets=["string"],
    active=False,
    name="string")

    const apiKeyResource = new coralogix.ApiKey("apiKeyResource", {
    owner: {
        organisationId: "string",
        teamId: "string",
        userId: "string",
    },
    permissions: ["string"],
    presets: ["string"],
    active: false,
    name: "string",
});

    type: coralogix:ApiKey
properties:
    active: false
    name: string
    owner:
        organisationId: string
        teamId: string
        userId: string
    permissions:
        - string
    presets:
        - string

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

    Owner ApiKeyOwner
    Api Key Owner. It can either be a teamid, organisationid, or a user_id
    Permissions List<string>
    Api Key Permissions
    Presets List<string>
    Api Key Presets
    Active bool
    Api Key Is Active.
    Name string
    Api Key name.
    Owner ApiKeyOwnerArgs
    Api Key Owner. It can either be a teamid, organisationid, or a user_id
    Permissions []string
    Api Key Permissions
    Presets []string
    Api Key Presets
    Active bool
    Api Key Is Active.
    Name string
    Api Key name.
    owner ApiKeyOwner
    Api Key Owner. It can either be a teamid, organisationid, or a user_id
    permissions List<String>
    Api Key Permissions
    presets List<String>
    Api Key Presets
    active Boolean
    Api Key Is Active.
    name String
    Api Key name.
    owner ApiKeyOwner
    Api Key Owner. It can either be a teamid, organisationid, or a user_id
    permissions string[]
    Api Key Permissions
    presets string[]
    Api Key Presets
    active boolean
    Api Key Is Active.
    name string
    Api Key name.
    owner ApiKeyOwnerArgs
    Api Key Owner. It can either be a teamid, organisationid, or a user_id
    permissions Sequence[str]
    Api Key Permissions
    presets Sequence[str]
    Api Key Presets
    active bool
    Api Key Is Active.
    name str
    Api Key name.
    owner Property Map
    Api Key Owner. It can either be a teamid, organisationid, or a user_id
    permissions List<String>
    Api Key Permissions
    presets List<String>
    Api Key Presets
    active Boolean
    Api Key Is Active.
    name String
    Api Key name.

    Outputs

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

    Hashed bool
    Api Key Is Hashed.
    Id string
    The provider-assigned unique ID for this managed resource.
    Value string
    Api Key value.
    Hashed bool
    Api Key Is Hashed.
    Id string
    The provider-assigned unique ID for this managed resource.
    Value string
    Api Key value.
    hashed Boolean
    Api Key Is Hashed.
    id String
    The provider-assigned unique ID for this managed resource.
    value String
    Api Key value.
    hashed boolean
    Api Key Is Hashed.
    id string
    The provider-assigned unique ID for this managed resource.
    value string
    Api Key value.
    hashed bool
    Api Key Is Hashed.
    id str
    The provider-assigned unique ID for this managed resource.
    value str
    Api Key value.
    hashed Boolean
    Api Key Is Hashed.
    id String
    The provider-assigned unique ID for this managed resource.
    value String
    Api Key value.

    Look up Existing ApiKey Resource

    Get an existing ApiKey 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?: ApiKeyState, opts?: CustomResourceOptions): ApiKey
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        active: Optional[bool] = None,
        hashed: Optional[bool] = None,
        name: Optional[str] = None,
        owner: Optional[ApiKeyOwnerArgs] = None,
        permissions: Optional[Sequence[str]] = None,
        presets: Optional[Sequence[str]] = None,
        value: Optional[str] = None) -> ApiKey
    func GetApiKey(ctx *Context, name string, id IDInput, state *ApiKeyState, opts ...ResourceOption) (*ApiKey, error)
    public static ApiKey Get(string name, Input<string> id, ApiKeyState? state, CustomResourceOptions? opts = null)
    public static ApiKey get(String name, Output<String> id, ApiKeyState state, CustomResourceOptions options)
    resources:  _:    type: coralogix:ApiKey    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:
    Active bool
    Api Key Is Active.
    Hashed bool
    Api Key Is Hashed.
    Name string
    Api Key name.
    Owner ApiKeyOwner
    Api Key Owner. It can either be a teamid, organisationid, or a user_id
    Permissions List<string>
    Api Key Permissions
    Presets List<string>
    Api Key Presets
    Value string
    Api Key value.
    Active bool
    Api Key Is Active.
    Hashed bool
    Api Key Is Hashed.
    Name string
    Api Key name.
    Owner ApiKeyOwnerArgs
    Api Key Owner. It can either be a teamid, organisationid, or a user_id
    Permissions []string
    Api Key Permissions
    Presets []string
    Api Key Presets
    Value string
    Api Key value.
    active Boolean
    Api Key Is Active.
    hashed Boolean
    Api Key Is Hashed.
    name String
    Api Key name.
    owner ApiKeyOwner
    Api Key Owner. It can either be a teamid, organisationid, or a user_id
    permissions List<String>
    Api Key Permissions
    presets List<String>
    Api Key Presets
    value String
    Api Key value.
    active boolean
    Api Key Is Active.
    hashed boolean
    Api Key Is Hashed.
    name string
    Api Key name.
    owner ApiKeyOwner
    Api Key Owner. It can either be a teamid, organisationid, or a user_id
    permissions string[]
    Api Key Permissions
    presets string[]
    Api Key Presets
    value string
    Api Key value.
    active bool
    Api Key Is Active.
    hashed bool
    Api Key Is Hashed.
    name str
    Api Key name.
    owner ApiKeyOwnerArgs
    Api Key Owner. It can either be a teamid, organisationid, or a user_id
    permissions Sequence[str]
    Api Key Permissions
    presets Sequence[str]
    Api Key Presets
    value str
    Api Key value.
    active Boolean
    Api Key Is Active.
    hashed Boolean
    Api Key Is Hashed.
    name String
    Api Key name.
    owner Property Map
    Api Key Owner. It can either be a teamid, organisationid, or a user_id
    permissions List<String>
    Api Key Permissions
    presets List<String>
    Api Key Presets
    value String
    Api Key value.

    Supporting Types

    ApiKeyOwner, ApiKeyOwnerArgs

    OrganisationId string
    TeamId string
    UserId string
    OrganisationId string
    TeamId string
    UserId string
    organisationId String
    teamId String
    userId String
    organisationId string
    teamId string
    userId string
    organisationId String
    teamId String
    userId String

    Package Details

    Repository
    coralogix coralogix/terraform-provider-coralogix
    License
    Notes
    This Pulumi package is based on the coralogix Terraform Provider.
    coralogix logo
    coralogix 2.0.17 published on Tuesday, Apr 22, 2025 by coralogix
    coralogix/terraform-provider-coralogix