lxd 2.5.0, Mar 13 25

lxd 2.5.0 published on Thursday, Mar 13, 2025 by terraform-lxd

lxd.StorageBucketKey

Explore with Pulumi AI

lxd 2.5.0 published on Thursday, Mar 13, 2025 by terraform-lxd

Create StorageBucketKey Resource

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

Constructor syntax

new StorageBucketKey(name: string, args: StorageBucketKeyArgs, opts?: CustomResourceOptions);

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

@overload
def StorageBucketKey(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     bucket: Optional[str] = None,
                     pool: Optional[str] = None,
                     description: Optional[str] = None,
                     name: Optional[str] = None,
                     project: Optional[str] = None,
                     remote: Optional[str] = None,
                     role: Optional[str] = None)

func NewStorageBucketKey(ctx *Context, name string, args StorageBucketKeyArgs, opts ...ResourceOption) (*StorageBucketKey, error)

public StorageBucketKey(string name, StorageBucketKeyArgs args, CustomResourceOptions? opts = null)

public StorageBucketKey(String name, StorageBucketKeyArgs args)
public StorageBucketKey(String name, StorageBucketKeyArgs args, CustomResourceOptions options)

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

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

name String: The unique name of the resource.
args StorageBucketKeyArgs: 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 storageBucketKeyResource = new Lxd.StorageBucketKey("storageBucketKeyResource", new()
{
    Bucket = "string",
    Pool = "string",
    Description = "string",
    Name = "string",
    Project = "string",
    Remote = "string",
    Role = "string",
});

example, err := lxd.NewStorageBucketKey(ctx, "storageBucketKeyResource", &lxd.StorageBucketKeyArgs{
Bucket: pulumi.String("string"),
Pool: pulumi.String("string"),
Description: pulumi.String("string"),
Name: pulumi.String("string"),
Project: pulumi.String("string"),
Remote: pulumi.String("string"),
Role: pulumi.String("string"),
})

var storageBucketKeyResource = new StorageBucketKey("storageBucketKeyResource", StorageBucketKeyArgs.builder()
    .bucket("string")
    .pool("string")
    .description("string")
    .name("string")
    .project("string")
    .remote("string")
    .role("string")
    .build());

storage_bucket_key_resource = lxd.StorageBucketKey("storageBucketKeyResource",
    bucket="string",
    pool="string",
    description="string",
    name="string",
    project="string",
    remote="string",
    role="string")

const storageBucketKeyResource = new lxd.StorageBucketKey("storageBucketKeyResource", {
    bucket: "string",
    pool: "string",
    description: "string",
    name: "string",
    project: "string",
    remote: "string",
    role: "string",
});

type: lxd:StorageBucketKey
properties:
    bucket: string
    description: string
    name: string
    pool: string
    project: string
    remote: string
    role: string

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

Bucket string: Required - Name of the storage bucket.
Pool string: Required - Name of storage pool to host the storage bucket key.
Description string: Optional - Description of the storage bucket key.
Name string: Required - Name of the storage bucket key.
Project string: Optional - Name of the project where the storage bucket key will be stored.
Remote string: Optional - The remote in which the resource will be created. If not provided, the provider's default remote will be used.
Role string: Optional - Name of the role that controls the access rights for the key. If not specified, the default role is used, as described in the official documentation.

Bucket string: Required - Name of the storage bucket.
Pool string: Required - Name of storage pool to host the storage bucket key.
Description string: Optional - Description of the storage bucket key.
Name string: Required - Name of the storage bucket key.
Project string: Optional - Name of the project where the storage bucket key will be stored.
Remote string: Optional - The remote in which the resource will be created. If not provided, the provider's default remote will be used.
Role string: Optional - Name of the role that controls the access rights for the key. If not specified, the default role is used, as described in the official documentation.

bucket String: Required - Name of the storage bucket.
pool String: Required - Name of storage pool to host the storage bucket key.
description String: Optional - Description of the storage bucket key.
name String: Required - Name of the storage bucket key.
project String: Optional - Name of the project where the storage bucket key will be stored.
remote String: Optional - The remote in which the resource will be created. If not provided, the provider's default remote will be used.
role String: Optional - Name of the role that controls the access rights for the key. If not specified, the default role is used, as described in the official documentation.

bucket string: Required - Name of the storage bucket.
pool string: Required - Name of storage pool to host the storage bucket key.
description string: Optional - Description of the storage bucket key.
name string: Required - Name of the storage bucket key.
project string: Optional - Name of the project where the storage bucket key will be stored.
remote string: Optional - The remote in which the resource will be created. If not provided, the provider's default remote will be used.
role string: Optional - Name of the role that controls the access rights for the key. If not specified, the default role is used, as described in the official documentation.

bucket str: Required - Name of the storage bucket.
pool str: Required - Name of storage pool to host the storage bucket key.
description str: Optional - Description of the storage bucket key.
name str: Required - Name of the storage bucket key.
project str: Optional - Name of the project where the storage bucket key will be stored.
remote str: Optional - The remote in which the resource will be created. If not provided, the provider's default remote will be used.
role str: Optional - Name of the role that controls the access rights for the key. If not specified, the default role is used, as described in the official documentation.

bucket String: Required - Name of the storage bucket.
pool String: Required - Name of storage pool to host the storage bucket key.
description String: Optional - Description of the storage bucket key.
name String: Required - Name of the storage bucket key.
project String: Optional - Name of the project where the storage bucket key will be stored.
remote String: Optional - The remote in which the resource will be created. If not provided, the provider's default remote will be used.
role String: Optional - Name of the role that controls the access rights for the key. If not specified, the default role is used, as described in the official documentation.

Outputs

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

AccessKey string: Access key of the storage bucket key.
Id string: The provider-assigned unique ID for this managed resource.
SecretKey string: Secret key of the storage bucket key.

AccessKey string: Access key of the storage bucket key.
Id string: The provider-assigned unique ID for this managed resource.
SecretKey string: Secret key of the storage bucket key.

accessKey String: Access key of the storage bucket key.
id String: The provider-assigned unique ID for this managed resource.
secretKey String: Secret key of the storage bucket key.

accessKey string: Access key of the storage bucket key.
id string: The provider-assigned unique ID for this managed resource.
secretKey string: Secret key of the storage bucket key.

access_key str: Access key of the storage bucket key.
id str: The provider-assigned unique ID for this managed resource.
secret_key str: Secret key of the storage bucket key.

accessKey String: Access key of the storage bucket key.
id String: The provider-assigned unique ID for this managed resource.
secretKey String: Secret key of the storage bucket key.

Look up Existing StorageBucketKey Resource

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

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        access_key: Optional[str] = None,
        bucket: Optional[str] = None,
        description: Optional[str] = None,
        name: Optional[str] = None,
        pool: Optional[str] = None,
        project: Optional[str] = None,
        remote: Optional[str] = None,
        role: Optional[str] = None,
        secret_key: Optional[str] = None) -> StorageBucketKey

func GetStorageBucketKey(ctx *Context, name string, id IDInput, state *StorageBucketKeyState, opts ...ResourceOption) (*StorageBucketKey, error)

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

public static StorageBucketKey get(String name, Output<String> id, StorageBucketKeyState state, CustomResourceOptions options)

resources:  _:    type: lxd:StorageBucketKey    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: Access key of the storage bucket key.
Bucket string: Required - Name of the storage bucket.
Description string: Optional - Description of the storage bucket key.
Name string: Required - Name of the storage bucket key.
Pool string: Required - Name of storage pool to host the storage bucket key.
Project string: Optional - Name of the project where the storage bucket key will be stored.
Remote string: Optional - The remote in which the resource will be created. If not provided, the provider's default remote will be used.
Role string: Optional - Name of the role that controls the access rights for the key. If not specified, the default role is used, as described in the official documentation.
SecretKey string: Secret key of the storage bucket key.

AccessKey string: Access key of the storage bucket key.
Bucket string: Required - Name of the storage bucket.
Description string: Optional - Description of the storage bucket key.
Name string: Required - Name of the storage bucket key.
Pool string: Required - Name of storage pool to host the storage bucket key.
Project string: Optional - Name of the project where the storage bucket key will be stored.
Remote string: Optional - The remote in which the resource will be created. If not provided, the provider's default remote will be used.
Role string: Optional - Name of the role that controls the access rights for the key. If not specified, the default role is used, as described in the official documentation.
SecretKey string: Secret key of the storage bucket key.

accessKey String: Access key of the storage bucket key.
bucket String: Required - Name of the storage bucket.
description String: Optional - Description of the storage bucket key.
name String: Required - Name of the storage bucket key.
pool String: Required - Name of storage pool to host the storage bucket key.
project String: Optional - Name of the project where the storage bucket key will be stored.
remote String: Optional - The remote in which the resource will be created. If not provided, the provider's default remote will be used.
role String: Optional - Name of the role that controls the access rights for the key. If not specified, the default role is used, as described in the official documentation.
secretKey String: Secret key of the storage bucket key.

accessKey string: Access key of the storage bucket key.
bucket string: Required - Name of the storage bucket.
description string: Optional - Description of the storage bucket key.
name string: Required - Name of the storage bucket key.
pool string: Required - Name of storage pool to host the storage bucket key.
project string: Optional - Name of the project where the storage bucket key will be stored.
remote string: Optional - The remote in which the resource will be created. If not provided, the provider's default remote will be used.
role string: Optional - Name of the role that controls the access rights for the key. If not specified, the default role is used, as described in the official documentation.
secretKey string: Secret key of the storage bucket key.

access_key str: Access key of the storage bucket key.
bucket str: Required - Name of the storage bucket.
description str: Optional - Description of the storage bucket key.
name str: Required - Name of the storage bucket key.
pool str: Required - Name of storage pool to host the storage bucket key.
project str: Optional - Name of the project where the storage bucket key will be stored.
remote str: Optional - The remote in which the resource will be created. If not provided, the provider's default remote will be used.
role str: Optional - Name of the role that controls the access rights for the key. If not specified, the default role is used, as described in the official documentation.
secret_key str: Secret key of the storage bucket key.

accessKey String: Access key of the storage bucket key.
bucket String: Required - Name of the storage bucket.
description String: Optional - Description of the storage bucket key.
name String: Required - Name of the storage bucket key.
pool String: Required - Name of storage pool to host the storage bucket key.
project String: Optional - Name of the project where the storage bucket key will be stored.
remote String: Optional - The remote in which the resource will be created. If not provided, the provider's default remote will be used.
role String: Optional - Name of the role that controls the access rights for the key. If not specified, the default role is used, as described in the official documentation.
secretKey String: Secret key of the storage bucket key.

Package Details

Repository: lxd terraform-lxd/terraform-provider-lxd
License
Notes: This Pulumi package is based on the lxd Terraform Provider.

lxd 2.5.0 published on Thursday, Mar 13, 2025 by terraform-lxd

terraform-lxd/terraform-provider-lxd

lxd.StorageBucketKey

On this page

On this page

Create StorageBucketKey Resource

Constructor syntax

Parameters

Constructor example

StorageBucketKey Resource Properties

Inputs

Outputs

Look up Existing StorageBucketKey Resource

Package Details

On this page

On this page