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.
Confluent Cloud. Inputs. Byok Key Aws (Optional Configuration Block) supports the following:
- Azure
Pulumi.
Confluent Cloud. Inputs. Byok Key Azure (Optional Configuration Block) supports the following:
- Aws
Byok
Key Aws Args (Optional Configuration Block) supports the following:
- Azure
Byok
Key Azure Args (Optional Configuration Block) supports the following:
- aws
Byok
Key Aws (Optional Configuration Block) supports the following:
- azure
Byok
Key Azure (Optional Configuration Block) supports the following:
- aws
Byok
Key Aws (Optional Configuration Block) supports the following:
- azure
Byok
Key Azure (Optional Configuration Block) supports the following:
- aws
Byok
Key Aws Args (Optional Configuration Block) supports the following:
- azure
Byok
Key Azure Args (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.
- Aws
Pulumi.
Confluent Cloud. Inputs. Byok Key Aws (Optional Configuration Block) supports the following:
- Azure
Pulumi.
Confluent Cloud. Inputs. Byok Key Azure (Optional Configuration Block) supports the following:
- Aws
Byok
Key Aws Args (Optional Configuration Block) supports the following:
- Azure
Byok
Key Azure Args (Optional Configuration Block) supports the following:
- aws
Byok
Key Aws (Optional Configuration Block) supports the following:
- azure
Byok
Key Azure (Optional Configuration Block) supports the following:
- aws
Byok
Key Aws (Optional Configuration Block) supports the following:
- azure
Byok
Key Azure (Optional Configuration Block) supports the following:
- aws
Byok
Key Aws Args (Optional Configuration Block) supports the following:
- azure
Byok
Key Azure Args (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, ByokKeyAwsArgs
ByokKeyAzure, ByokKeyAzureArgs
- Key
Identifier string The unique Key Object Identifier URL of an Azure Key Vault key.
- Key
Vault stringId Key Vault ID containing the key.
- Tenant
Id string Tenant ID (uuid) hosting the Key Vault containing the key.
- Application
Id string (Optional String) The Application ID created for this key-environment combination.
- Key
Identifier string The unique Key Object Identifier URL of an Azure Key Vault key.
- Key
Vault stringId Key Vault ID containing the key.
- Tenant
Id string Tenant ID (uuid) hosting the Key Vault containing the key.
- Application
Id string (Optional String) The Application ID created for this key-environment combination.
- key
Identifier String The unique Key Object Identifier URL of an Azure Key Vault key.
- key
Vault StringId Key Vault ID containing the key.
- tenant
Id String Tenant ID (uuid) hosting the Key Vault containing the key.
- application
Id String (Optional String) The Application ID created for this key-environment combination.
- key
Identifier string The unique Key Object Identifier URL of an Azure Key Vault key.
- key
Vault stringId Key Vault ID containing the key.
- tenant
Id string Tenant ID (uuid) hosting the Key Vault containing the key.
- application
Id 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_ strid 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.
- key
Identifier String The unique Key Object Identifier URL of an Azure Key Vault key.
- key
Vault StringId Key Vault ID containing the key.
- tenant
Id String Tenant ID (uuid) hosting the Key Vault containing the key.
- application
Id 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.