Linode

v3.7.1 published on Wednesday, Jan 5, 2022 by Pulumi

ObjectStorageKey

Provides a Linode Object Storage Key resource. This can be used to create, modify, and delete Linodes Object Storage Keys.

Attributes

This resource exports the following attributes:

access_key - This keypair’s access key. This is not secret.
secret_key - This keypair’s secret key.
limited - Whether or not this key is a limited access key.

Example Usage

using Pulumi;
using Linode = Pulumi.Linode;

class MyStack : Stack
{
    public MyStack()
    {
        var foo = new Linode.ObjectStorageKey("foo", new Linode.ObjectStorageKeyArgs
        {
            Label = "image-access",
        });
    }

}

package main

import (
	"github.com/pulumi/pulumi-linode/sdk/v3/go/linode"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := linode.NewObjectStorageKey(ctx, "foo", &linode.ObjectStorageKeyArgs{
			Label: pulumi.String("image-access"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

import pulumi
import pulumi_linode as linode

foo = linode.ObjectStorageKey("foo", label="image-access")

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

const foo = new linode.ObjectStorageKey("foo", {
    label: "image-access",
});

Create a ObjectStorageKey Resource

new ObjectStorageKey(name: string, args: ObjectStorageKeyArgs, opts?: CustomResourceOptions);

@overload
def ObjectStorageKey(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     bucket_accesses: Optional[Sequence[ObjectStorageKeyBucketAccessArgs]] = None,
                     label: Optional[str] = None)
@overload
def ObjectStorageKey(resource_name: str,
                     args: ObjectStorageKeyArgs,
                     opts: Optional[ResourceOptions] = None)

func NewObjectStorageKey(ctx *Context, name string, args ObjectStorageKeyArgs, opts ...ResourceOption) (*ObjectStorageKey, error)

public ObjectStorageKey(string name, ObjectStorageKeyArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args ObjectStorageKeyArgs: 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 ObjectStorageKeyArgs: 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 ObjectStorageKeyArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

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

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

Label string: The label given to this key. For display purposes only.
BucketAccesses List<ObjectStorageKeyBucketAccessArgs>: Defines this key as a Limited Access Key. Limited Access Keys restrict this Object Storage key’s access to only the bucket(s) declared in this array and define their bucket-level permissions. Not providing this block will not limit this Object Storage Key.

Label string: The label given to this key. For display purposes only.
BucketAccesses []ObjectStorageKeyBucketAccessArgs: Defines this key as a Limited Access Key. Limited Access Keys restrict this Object Storage key’s access to only the bucket(s) declared in this array and define their bucket-level permissions. Not providing this block will not limit this Object Storage Key.

label string: The label given to this key. For display purposes only.
bucketAccesses ObjectStorageKeyBucketAccessArgs[]: Defines this key as a Limited Access Key. Limited Access Keys restrict this Object Storage key’s access to only the bucket(s) declared in this array and define their bucket-level permissions. Not providing this block will not limit this Object Storage Key.

label str: The label given to this key. For display purposes only.
bucket_accesses Sequence[ObjectStorageKeyBucketAccessArgs]: Defines this key as a Limited Access Key. Limited Access Keys restrict this Object Storage key’s access to only the bucket(s) declared in this array and define their bucket-level permissions. Not providing this block will not limit this Object Storage Key.

Outputs

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

AccessKey string: This keypair’s access key. This is not secret.
Id string: The provider-assigned unique ID for this managed resource.
Limited bool: Whether or not this key is a limited access key.
SecretKey string: This keypair’s secret key.

AccessKey string: This keypair’s access key. This is not secret.
Id string: The provider-assigned unique ID for this managed resource.
Limited bool: Whether or not this key is a limited access key.
SecretKey string: This keypair’s secret key.

accessKey string: This keypair’s access key. This is not secret.
id string: The provider-assigned unique ID for this managed resource.
limited boolean: Whether or not this key is a limited access key.
secretKey string: This keypair’s secret key.

access_key str: This keypair’s access key. This is not secret.
id str: The provider-assigned unique ID for this managed resource.
limited bool: Whether or not this key is a limited access key.
secret_key str: This keypair’s secret key.

Look up an Existing ObjectStorageKey Resource

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

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        access_key: Optional[str] = None,
        bucket_accesses: Optional[Sequence[ObjectStorageKeyBucketAccessArgs]] = None,
        label: Optional[str] = None,
        limited: Optional[bool] = None,
        secret_key: Optional[str] = None) -> ObjectStorageKey

func GetObjectStorageKey(ctx *Context, name string, id IDInput, state *ObjectStorageKeyState, opts ...ResourceOption) (*ObjectStorageKey, error)

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

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.

The following state arguments are supported:

AccessKey string: This keypair’s access key. This is not secret.
BucketAccesses List<ObjectStorageKeyBucketAccessArgs>: Defines this key as a Limited Access Key. Limited Access Keys restrict this Object Storage key’s access to only the bucket(s) declared in this array and define their bucket-level permissions. Not providing this block will not limit this Object Storage Key.
Label string: The label given to this key. For display purposes only.
Limited bool: Whether or not this key is a limited access key.
SecretKey string: This keypair’s secret key.

AccessKey string: This keypair’s access key. This is not secret.
BucketAccesses []ObjectStorageKeyBucketAccessArgs: Defines this key as a Limited Access Key. Limited Access Keys restrict this Object Storage key’s access to only the bucket(s) declared in this array and define their bucket-level permissions. Not providing this block will not limit this Object Storage Key.
Label string: The label given to this key. For display purposes only.
Limited bool: Whether or not this key is a limited access key.
SecretKey string: This keypair’s secret key.

accessKey string: This keypair’s access key. This is not secret.
bucketAccesses ObjectStorageKeyBucketAccessArgs[]: Defines this key as a Limited Access Key. Limited Access Keys restrict this Object Storage key’s access to only the bucket(s) declared in this array and define their bucket-level permissions. Not providing this block will not limit this Object Storage Key.
label string: The label given to this key. For display purposes only.
limited boolean: Whether or not this key is a limited access key.
secretKey string: This keypair’s secret key.

access_key str: This keypair’s access key. This is not secret.
bucket_accesses Sequence[ObjectStorageKeyBucketAccessArgs]: Defines this key as a Limited Access Key. Limited Access Keys restrict this Object Storage key’s access to only the bucket(s) declared in this array and define their bucket-level permissions. Not providing this block will not limit this Object Storage Key.
label str: The label given to this key. For display purposes only.
limited bool: Whether or not this key is a limited access key.
secret_key str: This keypair’s secret key.

Supporting Types

ObjectStorageKeyBucketAccess

BucketName string: The unique label of the bucket to which the key will grant limited access.
Cluster string: The Object Storage cluster where a bucket to which the key is granting access is hosted.
Permissions string: This Limited Access Key’s permissions for the selected bucket. Changing permissions forces the creation of a new Object Storage Key. (read_write, read_only)

BucketName string: The unique label of the bucket to which the key will grant limited access.
Cluster string: The Object Storage cluster where a bucket to which the key is granting access is hosted.
Permissions string: This Limited Access Key’s permissions for the selected bucket. Changing permissions forces the creation of a new Object Storage Key. (read_write, read_only)

bucketName string: The unique label of the bucket to which the key will grant limited access.
cluster string: The Object Storage cluster where a bucket to which the key is granting access is hosted.
permissions string: This Limited Access Key’s permissions for the selected bucket. Changing permissions forces the creation of a new Object Storage Key. (read_write, read_only)

bucket_name str: The unique label of the bucket to which the key will grant limited access.
cluster str: The Object Storage cluster where a bucket to which the key is granting access is hosted.
permissions str: This Limited Access Key’s permissions for the selected bucket. Changing permissions forces the creation of a new Object Storage Key. (read_write, read_only)

Package Details

Repository: https://github.com/pulumi/pulumi-linode
License: Apache-2.0
Notes: This Pulumi package is based on the linode Terraform Provider.