New Relic v5.46.1, Jun 10 25

New Relic v5.46.1 published on Tuesday, Jun 10, 2025 by Pulumi

newrelic.ApiAccessKey

Explore with Pulumi AI

New Relic v5.46.1 published on Tuesday, Jun 10, 2025 by Pulumi

Import

Existing API access keys can be imported using a composite ID of <api_access_key_id>:<key_type>. <key_type> will be either INGEST or USER.

For example:

$ pulumi import newrelic:index/apiAccessKey:ApiAccessKey foobar "1234567:INGEST"

Create ApiAccessKey Resource

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

Constructor syntax

new ApiAccessKey(name: string, args: ApiAccessKeyArgs, opts?: CustomResourceOptions);

@overload
def ApiAccessKey(resource_name: str,
                 args: ApiAccessKeyArgs,
                 opts: Optional[ResourceOptions] = None)

@overload
def ApiAccessKey(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 account_id: Optional[str] = None,
                 key_type: Optional[str] = None,
                 ingest_type: Optional[str] = None,
                 name: Optional[str] = None,
                 notes: Optional[str] = None,
                 user_id: Optional[str] = None)

func NewApiAccessKey(ctx *Context, name string, args ApiAccessKeyArgs, opts ...ResourceOption) (*ApiAccessKey, error)

public ApiAccessKey(string name, ApiAccessKeyArgs args, CustomResourceOptions? opts = null)

public ApiAccessKey(String name, ApiAccessKeyArgs args)
public ApiAccessKey(String name, ApiAccessKeyArgs args, CustomResourceOptions options)

type: newrelic:ApiAccessKey
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 ApiAccessKeyArgs: 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 ApiAccessKeyArgs: 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 ApiAccessKeyArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ApiAccessKeyArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args ApiAccessKeyArgs: 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 apiAccessKeyResource = new NewRelic.ApiAccessKey("apiAccessKeyResource", new()
{
    AccountId = "string",
    KeyType = "string",
    IngestType = "string",
    Name = "string",
    Notes = "string",
    UserId = "string",
});

example, err := newrelic.NewApiAccessKey(ctx, "apiAccessKeyResource", &newrelic.ApiAccessKeyArgs{
	AccountId:  pulumi.String("string"),
	KeyType:    pulumi.String("string"),
	IngestType: pulumi.String("string"),
	Name:       pulumi.String("string"),
	Notes:      pulumi.String("string"),
	UserId:     pulumi.String("string"),
})

var apiAccessKeyResource = new ApiAccessKey("apiAccessKeyResource", ApiAccessKeyArgs.builder()
    .accountId("string")
    .keyType("string")
    .ingestType("string")
    .name("string")
    .notes("string")
    .userId("string")
    .build());

api_access_key_resource = newrelic.ApiAccessKey("apiAccessKeyResource",
    account_id="string",
    key_type="string",
    ingest_type="string",
    name="string",
    notes="string",
    user_id="string")

const apiAccessKeyResource = new newrelic.ApiAccessKey("apiAccessKeyResource", {
    accountId: "string",
    keyType: "string",
    ingestType: "string",
    name: "string",
    notes: "string",
    userId: "string",
});

type: newrelic:ApiAccessKey
properties:
    accountId: string
    ingestType: string
    keyType: string
    name: string
    notes: string
    userId: string

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

AccountId string: The New Relic account ID of the account you wish to create the API access key.
KeyType string: What type of API key to create. Valid options are INGEST or USER, case-sensitive.
IngestType string: Required if key_type = INGEST. Valid options are BROWSER or LICENSE, case-sensitive.
Name string: The name of the key.
Notes string: Any notes about this ingest key.
UserId string: Required if key_type = USER. The New Relic user ID yous wish to create the API access key for in an account.

AccountId string: The New Relic account ID of the account you wish to create the API access key.
KeyType string: What type of API key to create. Valid options are INGEST or USER, case-sensitive.
IngestType string: Required if key_type = INGEST. Valid options are BROWSER or LICENSE, case-sensitive.
Name string: The name of the key.
Notes string: Any notes about this ingest key.
UserId string: Required if key_type = USER. The New Relic user ID yous wish to create the API access key for in an account.

accountId String: The New Relic account ID of the account you wish to create the API access key.
keyType String: What type of API key to create. Valid options are INGEST or USER, case-sensitive.
ingestType String: Required if key_type = INGEST. Valid options are BROWSER or LICENSE, case-sensitive.
name String: The name of the key.
notes String: Any notes about this ingest key.
userId String: Required if key_type = USER. The New Relic user ID yous wish to create the API access key for in an account.

accountId string: The New Relic account ID of the account you wish to create the API access key.
keyType string: What type of API key to create. Valid options are INGEST or USER, case-sensitive.
ingestType string: Required if key_type = INGEST. Valid options are BROWSER or LICENSE, case-sensitive.
name string: The name of the key.
notes string: Any notes about this ingest key.
userId string: Required if key_type = USER. The New Relic user ID yous wish to create the API access key for in an account.

account_id str: The New Relic account ID of the account you wish to create the API access key.
key_type str: What type of API key to create. Valid options are INGEST or USER, case-sensitive.
ingest_type str: Required if key_type = INGEST. Valid options are BROWSER or LICENSE, case-sensitive.
name str: The name of the key.
notes str: Any notes about this ingest key.
user_id str: Required if key_type = USER. The New Relic user ID yous wish to create the API access key for in an account.

accountId String: The New Relic account ID of the account you wish to create the API access key.
keyType String: What type of API key to create. Valid options are INGEST or USER, case-sensitive.
ingestType String: Required if key_type = INGEST. Valid options are BROWSER or LICENSE, case-sensitive.
name String: The name of the key.
notes String: Any notes about this ingest key.
userId String: Required if key_type = USER. The New Relic user ID yous wish to create the API access key for in an account.

Outputs

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

Id string: The provider-assigned unique ID for this managed resource.
Key string: The actual API key. This attribute is masked and not be visible in your terminal, CI, etc.

Id string: The provider-assigned unique ID for this managed resource.
Key string: The actual API key. This attribute is masked and not be visible in your terminal, CI, etc.

id String: The provider-assigned unique ID for this managed resource.
key String: The actual API key. This attribute is masked and not be visible in your terminal, CI, etc.

id string: The provider-assigned unique ID for this managed resource.
key string: The actual API key. This attribute is masked and not be visible in your terminal, CI, etc.

id str: The provider-assigned unique ID for this managed resource.
key str: The actual API key. This attribute is masked and not be visible in your terminal, CI, etc.

id String: The provider-assigned unique ID for this managed resource.
key String: The actual API key. This attribute is masked and not be visible in your terminal, CI, etc.

Look up Existing ApiAccessKey Resource

Get an existing ApiAccessKey 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?: ApiAccessKeyState, opts?: CustomResourceOptions): ApiAccessKey

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        account_id: Optional[str] = None,
        ingest_type: Optional[str] = None,
        key: Optional[str] = None,
        key_type: Optional[str] = None,
        name: Optional[str] = None,
        notes: Optional[str] = None,
        user_id: Optional[str] = None) -> ApiAccessKey

func GetApiAccessKey(ctx *Context, name string, id IDInput, state *ApiAccessKeyState, opts ...ResourceOption) (*ApiAccessKey, error)

public static ApiAccessKey Get(string name, Input<string> id, ApiAccessKeyState? state, CustomResourceOptions? opts = null)

public static ApiAccessKey get(String name, Output<String> id, ApiAccessKeyState state, CustomResourceOptions options)

resources:  _:    type: newrelic:ApiAccessKey    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:

AccountId string: The New Relic account ID of the account you wish to create the API access key.
IngestType string: Required if key_type = INGEST. Valid options are BROWSER or LICENSE, case-sensitive.
Key string: The actual API key. This attribute is masked and not be visible in your terminal, CI, etc.
KeyType string: What type of API key to create. Valid options are INGEST or USER, case-sensitive.
Name string: The name of the key.
Notes string: Any notes about this ingest key.
UserId string: Required if key_type = USER. The New Relic user ID yous wish to create the API access key for in an account.

AccountId string: The New Relic account ID of the account you wish to create the API access key.
IngestType string: Required if key_type = INGEST. Valid options are BROWSER or LICENSE, case-sensitive.
Key string: The actual API key. This attribute is masked and not be visible in your terminal, CI, etc.
KeyType string: What type of API key to create. Valid options are INGEST or USER, case-sensitive.
Name string: The name of the key.
Notes string: Any notes about this ingest key.
UserId string: Required if key_type = USER. The New Relic user ID yous wish to create the API access key for in an account.

accountId String: The New Relic account ID of the account you wish to create the API access key.
ingestType String: Required if key_type = INGEST. Valid options are BROWSER or LICENSE, case-sensitive.
key String: The actual API key. This attribute is masked and not be visible in your terminal, CI, etc.
keyType String: What type of API key to create. Valid options are INGEST or USER, case-sensitive.
name String: The name of the key.
notes String: Any notes about this ingest key.
userId String: Required if key_type = USER. The New Relic user ID yous wish to create the API access key for in an account.

accountId string: The New Relic account ID of the account you wish to create the API access key.
ingestType string: Required if key_type = INGEST. Valid options are BROWSER or LICENSE, case-sensitive.
key string: The actual API key. This attribute is masked and not be visible in your terminal, CI, etc.
keyType string: What type of API key to create. Valid options are INGEST or USER, case-sensitive.
name string: The name of the key.
notes string: Any notes about this ingest key.
userId string: Required if key_type = USER. The New Relic user ID yous wish to create the API access key for in an account.

account_id str: The New Relic account ID of the account you wish to create the API access key.
ingest_type str: Required if key_type = INGEST. Valid options are BROWSER or LICENSE, case-sensitive.
key str: The actual API key. This attribute is masked and not be visible in your terminal, CI, etc.
key_type str: What type of API key to create. Valid options are INGEST or USER, case-sensitive.
name str: The name of the key.
notes str: Any notes about this ingest key.
user_id str: Required if key_type = USER. The New Relic user ID yous wish to create the API access key for in an account.

accountId String: The New Relic account ID of the account you wish to create the API access key.
ingestType String: Required if key_type = INGEST. Valid options are BROWSER or LICENSE, case-sensitive.
key String: The actual API key. This attribute is masked and not be visible in your terminal, CI, etc.
keyType String: What type of API key to create. Valid options are INGEST or USER, case-sensitive.
name String: The name of the key.
notes String: Any notes about this ingest key.
userId String: Required if key_type = USER. The New Relic user ID yous wish to create the API access key for in an account.

Package Details

Repository: New Relic pulumi/pulumi-newrelic
License: Apache-2.0
Notes: This Pulumi package is based on the newrelic Terraform Provider.

New Relic v5.46.1 published on Tuesday, Jun 10, 2025 by Pulumi

pulumi/pulumi-newrelic

newrelic.ApiAccessKey

On this page

On this page

Import

Create ApiAccessKey Resource

Constructor syntax

Parameters

Constructor example

ApiAccessKey Resource Properties

Inputs

Outputs

Look up Existing ApiAccessKey Resource

Package Details

On this page

On this page