1. Packages
  2. Minio Provider
  3. API Docs
  4. KmsKey
MinIO v0.16.3 published on Wednesday, Feb 12, 2025 by Pulumi

minio.KmsKey

Explore with Pulumi AI

Create KmsKey Resource

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

Constructor syntax

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

@overload
def KmsKey(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           key_id: Optional[str] = None)
func NewKmsKey(ctx *Context, name string, args KmsKeyArgs, opts ...ResourceOption) (*KmsKey, error)
public KmsKey(string name, KmsKeyArgs args, CustomResourceOptions? opts = null)
public KmsKey(String name, KmsKeyArgs args)
public KmsKey(String name, KmsKeyArgs args, CustomResourceOptions options)
type: minio:KmsKey
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. KmsKeyArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. KmsKeyArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. KmsKeyArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. KmsKeyArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. KmsKeyArgs
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 kmsKeyResource = new Minio.KmsKey("kmsKeyResource", new()
{
    KeyId = "string",
});
Copy
example, err := minio.NewKmsKey(ctx, "kmsKeyResource", &minio.KmsKeyArgs{
	KeyId: pulumi.String("string"),
})
Copy
var kmsKeyResource = new KmsKey("kmsKeyResource", KmsKeyArgs.builder()
    .keyId("string")
    .build());
Copy
kms_key_resource = minio.KmsKey("kmsKeyResource", key_id="string")
Copy
const kmsKeyResource = new minio.KmsKey("kmsKeyResource", {keyId: "string"});
Copy
type: minio:KmsKey
properties:
    keyId: string
Copy

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

KeyId
This property is required.
Changes to this property will trigger replacement.
string
KeyId
This property is required.
Changes to this property will trigger replacement.
string
keyId
This property is required.
Changes to this property will trigger replacement.
String
keyId
This property is required.
Changes to this property will trigger replacement.
string
key_id
This property is required.
Changes to this property will trigger replacement.
str
keyId
This property is required.
Changes to this property will trigger replacement.
String

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing KmsKey Resource

Get an existing KmsKey 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?: KmsKeyState, opts?: CustomResourceOptions): KmsKey
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        key_id: Optional[str] = None) -> KmsKey
func GetKmsKey(ctx *Context, name string, id IDInput, state *KmsKeyState, opts ...ResourceOption) (*KmsKey, error)
public static KmsKey Get(string name, Input<string> id, KmsKeyState? state, CustomResourceOptions? opts = null)
public static KmsKey get(String name, Output<String> id, KmsKeyState state, CustomResourceOptions options)
resources:  _:    type: minio:KmsKey    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
KeyId Changes to this property will trigger replacement. string
KeyId Changes to this property will trigger replacement. string
keyId Changes to this property will trigger replacement. String
keyId Changes to this property will trigger replacement. string
key_id Changes to this property will trigger replacement. str
keyId Changes to this property will trigger replacement. String

Package Details

Repository
MinIO pulumi/pulumi-minio
License
Apache-2.0
Notes
This Pulumi package is based on the minio Terraform Provider.