Confluent v2.12.0 published on Wednesday, Dec 4, 2024 by Pulumi
confluentcloud.getByokKey
Explore with Pulumi AI
confluentcloud.ByokKey
describes a BYOK Key data source.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as confluentcloud from "@pulumi/confluentcloud";
const azureKey = confluentcloud.getByokKey({
id: "cck-abcde",
});
export const byok = azureKey;
import pulumi
import pulumi_confluentcloud as confluentcloud
azure_key = confluentcloud.get_byok_key(id="cck-abcde")
pulumi.export("byok", azure_key)
package main
import (
"github.com/pulumi/pulumi-confluentcloud/sdk/v2/go/confluentcloud"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
azureKey, err := confluentcloud.LookupByokKey(ctx, &confluentcloud.LookupByokKeyArgs{
Id: "cck-abcde",
}, nil)
if err != nil {
return err
}
ctx.Export("byok", azureKey)
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using ConfluentCloud = Pulumi.ConfluentCloud;
return await Deployment.RunAsync(() =>
{
var azureKey = ConfluentCloud.GetByokKey.Invoke(new()
{
Id = "cck-abcde",
});
return new Dictionary<string, object?>
{
["byok"] = azureKey,
};
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.confluentcloud.ConfluentcloudFunctions;
import com.pulumi.confluentcloud.inputs.GetByokKeyArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var azureKey = ConfluentcloudFunctions.getByokKey(GetByokKeyArgs.builder()
.id("cck-abcde")
.build());
ctx.export("byok", azureKey.applyValue(getByokKeyResult -> getByokKeyResult));
}
}
variables:
azureKey:
fn::invoke:
Function: confluentcloud:getByokKey
Arguments:
id: cck-abcde
outputs:
byok: ${azureKey}
Using getByokKey
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getByokKey(args: GetByokKeyArgs, opts?: InvokeOptions): Promise<GetByokKeyResult>
function getByokKeyOutput(args: GetByokKeyOutputArgs, opts?: InvokeOptions): Output<GetByokKeyResult>
def get_byok_key(id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetByokKeyResult
def get_byok_key_output(id: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetByokKeyResult]
func LookupByokKey(ctx *Context, args *LookupByokKeyArgs, opts ...InvokeOption) (*LookupByokKeyResult, error)
func LookupByokKeyOutput(ctx *Context, args *LookupByokKeyOutputArgs, opts ...InvokeOption) LookupByokKeyResultOutput
> Note: This function is named LookupByokKey
in the Go SDK.
public static class GetByokKey
{
public static Task<GetByokKeyResult> InvokeAsync(GetByokKeyArgs args, InvokeOptions? opts = null)
public static Output<GetByokKeyResult> Invoke(GetByokKeyInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetByokKeyResult> getByokKey(GetByokKeyArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: confluentcloud:index/getByokKey:getByokKey
arguments:
# arguments dictionary
The following arguments are supported:
- Id string
- The ID of the BYOK key, for example,
cck-abcde
.
- Id string
- The ID of the BYOK key, for example,
cck-abcde
.
- id String
- The ID of the BYOK key, for example,
cck-abcde
.
- id string
- The ID of the BYOK key, for example,
cck-abcde
.
- id str
- The ID of the BYOK key, for example,
cck-abcde
.
- id String
- The ID of the BYOK key, for example,
cck-abcde
.
getByokKey Result
The following output properties are available:
- Aws
List<Pulumi.
Confluent Cloud. Outputs. Get Byok Key Aw> - (Optional Configuration Block) supports the following:
- Azures
List<Pulumi.
Confluent Cloud. Outputs. Get Byok Key Azure> - (Optional Configuration Block) supports the following:
- Gcps
List<Pulumi.
Confluent Cloud. Outputs. Get Byok Key Gcp> - (Optional Configuration Block) supports the following:
- Id string
- (Required String) The ID of the BYOK key, for example,
cck-abcde
.
- Aws
[]Get
Byok Key Aw - (Optional Configuration Block) supports the following:
- Azures
[]Get
Byok Key Azure - (Optional Configuration Block) supports the following:
- Gcps
[]Get
Byok Key Gcp - (Optional Configuration Block) supports the following:
- Id string
- (Required String) The ID of the BYOK key, for example,
cck-abcde
.
- aws
List<Get
Byok Key Aw> - (Optional Configuration Block) supports the following:
- azures
List<Get
Byok Key Azure> - (Optional Configuration Block) supports the following:
- gcps
List<Get
Byok Key Gcp> - (Optional Configuration Block) supports the following:
- id String
- (Required String) The ID of the BYOK key, for example,
cck-abcde
.
- aws
Get
Byok Key Aw[] - (Optional Configuration Block) supports the following:
- azures
Get
Byok Key Azure[] - (Optional Configuration Block) supports the following:
- gcps
Get
Byok Key Gcp[] - (Optional Configuration Block) supports the following:
- id string
- (Required String) The ID of the BYOK key, for example,
cck-abcde
.
- aws
Sequence[Get
Byok Key Aw] - (Optional Configuration Block) supports the following:
- azures
Sequence[Get
Byok Key Azure] - (Optional Configuration Block) supports the following:
- gcps
Sequence[Get
Byok Key Gcp] - (Optional Configuration Block) supports the following:
- id str
- (Required String) The ID of the BYOK key, for example,
cck-abcde
.
- aws List<Property Map>
- (Optional Configuration Block) supports the following:
- azures List<Property Map>
- (Optional Configuration Block) supports the following:
- gcps List<Property Map>
- (Optional Configuration Block) supports the following:
- id String
- (Required String) The ID of the BYOK key, for example,
cck-abcde
.
Supporting Types
GetByokKeyAw
GetByokKeyAzure
- Application
Id string - (Optional String) The Application ID created for this key-environment combination.
- Key
Identifier string - (Required String) The unique Key Object Identifier URL of an Azure Key Vault key.
- Key
Vault stringId - (Required String) Key Vault ID containing the key.
- Tenant
Id string - (Required 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 - (Required String) The unique Key Object Identifier URL of an Azure Key Vault key.
- Key
Vault stringId - (Required String) Key Vault ID containing the key.
- Tenant
Id string - (Required 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 - (Required String) The unique Key Object Identifier URL of an Azure Key Vault key.
- key
Vault StringId - (Required String) Key Vault ID containing the key.
- tenant
Id String - (Required 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 - (Required String) The unique Key Object Identifier URL of an Azure Key Vault key.
- key
Vault stringId - (Required String) Key Vault ID containing the key.
- tenant
Id string - (Required String) 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 str - (Required String) The unique Key Object Identifier URL of an Azure Key Vault key.
- key_
vault_ strid - (Required String) Key Vault ID containing the key.
- tenant_
id str - (Required 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 - (Required String) The unique Key Object Identifier URL of an Azure Key Vault key.
- key
Vault StringId - (Required String) Key Vault ID containing the key.
- tenant
Id String - (Required String) Tenant ID (uuid) hosting the Key Vault containing the key.
GetByokKeyGcp
- Key
Id string - (Required String) The Google Cloud Platform key ID.
- Security
Group string - (Optional String) The Google security group created for this key.
- Key
Id string - (Required String) The Google Cloud Platform key ID.
- Security
Group string - (Optional String) The Google security group created for this key.
- key
Id String - (Required String) The Google Cloud Platform key ID.
- security
Group String - (Optional String) The Google security group created for this key.
- key
Id string - (Required String) The Google Cloud Platform key ID.
- security
Group string - (Optional String) The Google security group created for this key.
- key_
id str - (Required String) The Google Cloud Platform key ID.
- security_
group str - (Optional String) The Google security group created for this key.
- key
Id String - (Required String) The Google Cloud Platform key ID.
- security
Group String - (Optional String) The Google security group created for this key.
Package Details
- Repository
- Confluent Cloud pulumi/pulumi-confluentcloud
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
confluent
Terraform Provider.