Confluent v1.17.0, Jun 1 23

confluentcloud.ByokKey

Explore with Pulumi AI

Import

You can import a BYOK Key by using BYOK Key ID. The following example shows how to import a BYOK Key$ export CONFLUENT_CLOUD_API_KEY="<cloud_api_key>" $ export CONFLUENT_CLOUD_API_SECRET="<cloud_api_secret>"

 $ pulumi import confluentcloud:index/byokKey:ByokKey aws_key cck-abcde

!> Warning: Do not forget to delete terminal command history afterwards for security purposes.

Create ByokKey Resource

new ByokKey(name: string, args?: ByokKeyArgs, opts?: CustomResourceOptions);

@overload
def ByokKey(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            aws: Optional[ByokKeyAwsArgs] = None,
            azure: Optional[ByokKeyAzureArgs] = None)
@overload
def ByokKey(resource_name: str,
            args: Optional[ByokKeyArgs] = None,
            opts: Optional[ResourceOptions] = None)

func NewByokKey(ctx *Context, name string, args *ByokKeyArgs, opts ...ResourceOption) (*ByokKey, error)

public ByokKey(string name, ByokKeyArgs? args = null, CustomResourceOptions? opts = null)

public ByokKey(String name, ByokKeyArgs args)
public ByokKey(String name, ByokKeyArgs args, CustomResourceOptions options)

type: confluentcloud:ByokKey
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

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

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

name String: The unique name of the resource.
args ByokKeyArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

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

Aws Pulumi.ConfluentCloud.Inputs.ByokKeyAwsArgs: (Optional Configuration Block) supports the following:
Azure Pulumi.ConfluentCloud.Inputs.ByokKeyAzureArgs: (Optional Configuration Block) supports the following:

Aws ByokKeyAwsArgs: (Optional Configuration Block) supports the following:
Azure ByokKeyAzureArgs: (Optional Configuration Block) supports the following:

aws ByokKeyAwsArgs: (Optional Configuration Block) supports the following:
azure ByokKeyAzureArgs: (Optional Configuration Block) supports the following:

aws ByokKeyAwsArgs: (Optional Configuration Block) supports the following:
azure ByokKeyAzureArgs: (Optional Configuration Block) supports the following:

aws ByokKeyAwsArgs: (Optional Configuration Block) supports the following:
azure ByokKeyAzureArgs: (Optional Configuration Block) supports the following:

aws Property Map: (Optional Configuration Block) supports the following:
azure Property Map: (Optional Configuration Block) supports the following:

Outputs

All input properties are implicitly available as output properties. Additionally, the ByokKey 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 ByokKey Resource

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

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        aws: Optional[ByokKeyAwsArgs] = None,
        azure: Optional[ByokKeyAzureArgs] = None) -> ByokKey

func GetByokKey(ctx *Context, name string, id IDInput, state *ByokKeyState, opts ...ResourceOption) (*ByokKey, error)

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

public static ByokKey get(String name, Output<String> id, ByokKeyState 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.

The following state arguments are supported:

Aws Pulumi.ConfluentCloud.Inputs.ByokKeyAwsArgs: (Optional Configuration Block) supports the following:
Azure Pulumi.ConfluentCloud.Inputs.ByokKeyAzureArgs: (Optional Configuration Block) supports the following:

Aws ByokKeyAwsArgs: (Optional Configuration Block) supports the following:
Azure ByokKeyAzureArgs: (Optional Configuration Block) supports the following:

aws ByokKeyAwsArgs: (Optional Configuration Block) supports the following:
azure ByokKeyAzureArgs: (Optional Configuration Block) supports the following:

aws ByokKeyAwsArgs: (Optional Configuration Block) supports the following:
azure ByokKeyAzureArgs: (Optional Configuration Block) supports the following:

aws ByokKeyAwsArgs: (Optional Configuration Block) supports the following:
azure ByokKeyAzureArgs: (Optional Configuration Block) supports the following:

aws Property Map: (Optional Configuration Block) supports the following:
azure Property Map: (Optional Configuration Block) supports the following:

Supporting Types

ByokKeyAws

KeyArn string: The Amazon Resource Name (ARN) of an AWS KMS key.
Roles List<string>: (Optional List of Strings) The Amazon Resource Names (ARNs) of IAM Roles created for this key-environment

KeyArn string: The Amazon Resource Name (ARN) of an AWS KMS key.
Roles []string: (Optional List of Strings) The Amazon Resource Names (ARNs) of IAM Roles created for this key-environment

keyArn String: The Amazon Resource Name (ARN) of an AWS KMS key.
roles List<String>: (Optional List of Strings) The Amazon Resource Names (ARNs) of IAM Roles created for this key-environment

keyArn string: The Amazon Resource Name (ARN) of an AWS KMS key.
roles string[]: (Optional List of Strings) The Amazon Resource Names (ARNs) of IAM Roles created for this key-environment

key_arn str: The Amazon Resource Name (ARN) of an AWS KMS key.
roles Sequence[str]: (Optional List of Strings) The Amazon Resource Names (ARNs) of IAM Roles created for this key-environment

keyArn String: The Amazon Resource Name (ARN) of an AWS KMS key.
roles List<String>: (Optional List of Strings) The Amazon Resource Names (ARNs) of IAM Roles created for this key-environment

ByokKeyAzure

KeyIdentifier string: The unique Key Object Identifier URL of an Azure Key Vault key.
KeyVaultId string: Key Vault ID containing the key.
TenantId string: Tenant ID (uuid) hosting the Key Vault containing the key.
ApplicationId string: (Optional String) The Application ID created for this key-environment combination.

KeyIdentifier string: The unique Key Object Identifier URL of an Azure Key Vault key.
KeyVaultId string: Key Vault ID containing the key.
TenantId string: Tenant ID (uuid) hosting the Key Vault containing the key.
ApplicationId string: (Optional String) The Application ID created for this key-environment combination.

keyIdentifier String: The unique Key Object Identifier URL of an Azure Key Vault key.
keyVaultId String: Key Vault ID containing the key.
tenantId String: Tenant ID (uuid) hosting the Key Vault containing the key.
applicationId String: (Optional String) The Application ID created for this key-environment combination.

keyIdentifier string: The unique Key Object Identifier URL of an Azure Key Vault key.
keyVaultId string: Key Vault ID containing the key.
tenantId string: Tenant ID (uuid) hosting the Key Vault containing the key.
applicationId string: (Optional String) The Application ID created for this key-environment combination.

key_identifier str: The unique Key Object Identifier URL of an Azure Key Vault key.
key_vault_id str: Key Vault ID containing the key.
tenant_id str: Tenant ID (uuid) hosting the Key Vault containing the key.
application_id str: (Optional String) The Application ID created for this key-environment combination.

keyIdentifier String: The unique Key Object Identifier URL of an Azure Key Vault key.
keyVaultId String: Key Vault ID containing the key.
tenantId String: Tenant ID (uuid) hosting the Key Vault containing the key.
applicationId String: (Optional String) The Application ID created for this key-environment combination.

Package Details

Repository: Confluent Cloud pulumi/pulumi-confluentcloud
License: Apache-2.0
Notes: This Pulumi package is based on the confluent Terraform Provider.