This package is deprecated. We recommend using the new Equinix package.
equinix-metal.UserApiKey
Explore with Pulumi AI
This package is deprecated. We recommend using the new Equinix package.
Example Usage
using Pulumi;
using EquinixMetal = Pulumi.EquinixMetal;
class MyStack : Stack
{
public MyStack()
{
var test = new EquinixMetal.UserApiKey("test", new EquinixMetal.UserApiKeyArgs
{
Description = "Read-only user key",
ReadOnly = true,
});
}
}
package main
import (
"github.com/pulumi/pulumi-equinix-metal/sdk/v3/go/equinix-metal"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := equinix - metal.NewUserApiKey(ctx, "test", &equinix-metal.UserApiKeyArgs{
Description: pulumi.String("Read-only user key"),
ReadOnly: pulumi.Bool(true),
})
if err != nil {
return err
}
return nil
})
}
Coming soon!
import pulumi
import pulumi_equinix_metal as equinix_metal
test = equinix_metal.UserApiKey("test",
description="Read-only user key",
read_only=True)
import * as pulumi from "@pulumi/pulumi";
import * as metal from "@pulumi/metal";
const test = new metal.UserApiKey("test", {
description: "Read-only user key",
readOnly: true,
});
Coming soon!
Create UserApiKey Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new UserApiKey(name: string, args: UserApiKeyArgs, opts?: CustomResourceOptions);
@overload
def UserApiKey(resource_name: str,
args: UserApiKeyArgs,
opts: Optional[ResourceOptions] = None)
@overload
def UserApiKey(resource_name: str,
opts: Optional[ResourceOptions] = None,
description: Optional[str] = None,
read_only: Optional[bool] = None)
func NewUserApiKey(ctx *Context, name string, args UserApiKeyArgs, opts ...ResourceOption) (*UserApiKey, error)
public UserApiKey(string name, UserApiKeyArgs args, CustomResourceOptions? opts = null)
public UserApiKey(String name, UserApiKeyArgs args)
public UserApiKey(String name, UserApiKeyArgs args, CustomResourceOptions options)
type: equinix-metal:UserApiKey
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 UserApiKeyArgs
- 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 UserApiKeyArgs
- 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 UserApiKeyArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args UserApiKeyArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args UserApiKeyArgs
- 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 userApiKeyResource = new EquinixMetal.UserApiKey("userApiKeyResource", new()
{
Description = "string",
ReadOnly = false,
});
example, err := equinixmetal.NewUserApiKey(ctx, "userApiKeyResource", &equinixmetal.UserApiKeyArgs{
Description: pulumi.String("string"),
ReadOnly: pulumi.Bool(false),
})
var userApiKeyResource = new UserApiKey("userApiKeyResource", UserApiKeyArgs.builder()
.description("string")
.readOnly(false)
.build());
user_api_key_resource = equinix_metal.UserApiKey("userApiKeyResource",
description="string",
read_only=False)
const userApiKeyResource = new equinix_metal.UserApiKey("userApiKeyResource", {
description: "string",
readOnly: false,
});
type: equinix-metal:UserApiKey
properties:
description: string
readOnly: false
UserApiKey Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The UserApiKey resource accepts the following input properties:
- Description string
- Description string for the User API Key resource
read-only
- Flag indicating whether the API key shoud be read-only
- Read
Only bool - Flag indicating whether the API key shoud be read-only
- Description string
- Description string for the User API Key resource
read-only
- Flag indicating whether the API key shoud be read-only
- Read
Only bool - Flag indicating whether the API key shoud be read-only
- description String
- Description string for the User API Key resource
read-only
- Flag indicating whether the API key shoud be read-only
- read
Only Boolean - Flag indicating whether the API key shoud be read-only
- description string
- Description string for the User API Key resource
read-only
- Flag indicating whether the API key shoud be read-only
- read
Only boolean - Flag indicating whether the API key shoud be read-only
- description str
- Description string for the User API Key resource
read-only
- Flag indicating whether the API key shoud be read-only
- read_
only bool - Flag indicating whether the API key shoud be read-only
- description String
- Description string for the User API Key resource
read-only
- Flag indicating whether the API key shoud be read-only
- read
Only Boolean - Flag indicating whether the API key shoud be read-only
Outputs
All input properties are implicitly available as output properties. Additionally, the UserApiKey resource produces the following output properties:
Look up Existing UserApiKey Resource
Get an existing UserApiKey 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?: UserApiKeyState, opts?: CustomResourceOptions): UserApiKey
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
description: Optional[str] = None,
read_only: Optional[bool] = None,
token: Optional[str] = None,
user_id: Optional[str] = None) -> UserApiKey
func GetUserApiKey(ctx *Context, name string, id IDInput, state *UserApiKeyState, opts ...ResourceOption) (*UserApiKey, error)
public static UserApiKey Get(string name, Input<string> id, UserApiKeyState? state, CustomResourceOptions? opts = null)
public static UserApiKey get(String name, Output<String> id, UserApiKeyState 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.
- Description string
- Description string for the User API Key resource
read-only
- Flag indicating whether the API key shoud be read-only
- Read
Only bool - Flag indicating whether the API key shoud be read-only
- Token string
- API token which can be used in Equinix Metal API clients
- User
Id string - UUID of the owner of the API key
- Description string
- Description string for the User API Key resource
read-only
- Flag indicating whether the API key shoud be read-only
- Read
Only bool - Flag indicating whether the API key shoud be read-only
- Token string
- API token which can be used in Equinix Metal API clients
- User
Id string - UUID of the owner of the API key
- description String
- Description string for the User API Key resource
read-only
- Flag indicating whether the API key shoud be read-only
- read
Only Boolean - Flag indicating whether the API key shoud be read-only
- token String
- API token which can be used in Equinix Metal API clients
- user
Id String - UUID of the owner of the API key
- description string
- Description string for the User API Key resource
read-only
- Flag indicating whether the API key shoud be read-only
- read
Only boolean - Flag indicating whether the API key shoud be read-only
- token string
- API token which can be used in Equinix Metal API clients
- user
Id string - UUID of the owner of the API key
- description str
- Description string for the User API Key resource
read-only
- Flag indicating whether the API key shoud be read-only
- read_
only bool - Flag indicating whether the API key shoud be read-only
- token str
- API token which can be used in Equinix Metal API clients
- user_
id str - UUID of the owner of the API key
- description String
- Description string for the User API Key resource
read-only
- Flag indicating whether the API key shoud be read-only
- read
Only Boolean - Flag indicating whether the API key shoud be read-only
- token String
- API token which can be used in Equinix Metal API clients
- user
Id String - UUID of the owner of the API key
Package Details
- Repository
- Equinix Metal pulumi/pulumi-equinix-metal
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
metal
Terraform Provider.
This package is deprecated. We recommend using the new Equinix package.