Confluent Cloud v0.2.2, Dec 10 21

confluent.ApiKey

Create ApiKey Resource

new ApiKey(name: string, args: ApiKeyArgs, opts?: CustomResourceOptions);

@overload
def ApiKey(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           cluster_id: Optional[str] = None,
           description: Optional[str] = None,
           environment_id: Optional[str] = None,
           logical_clusters: Optional[Sequence[str]] = None,
           user_id: Optional[int] = None)
@overload
def ApiKey(resource_name: str,
           args: ApiKeyArgs,
           opts: Optional[ResourceOptions] = None)

func NewApiKey(ctx *Context, name string, args ApiKeyArgs, opts ...ResourceOption) (*ApiKey, error)

public ApiKey(string name, ApiKeyArgs args, CustomResourceOptions? opts = null)

public ApiKey(String name, ApiKeyArgs args)
public ApiKey(String name, ApiKeyArgs args, CustomResourceOptions options)

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

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

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

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

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

EnvironmentId string: Environment ID
ClusterId string
Description string: Description
LogicalClusters List<string>: Logical Cluster ID List to create API Key
UserId int: User ID

EnvironmentId string: Environment ID
ClusterId string
Description string: Description
LogicalClusters []string: Logical Cluster ID List to create API Key
UserId int: User ID

environmentId String: Environment ID
clusterId String
description String: Description
logicalClusters List<String>: Logical Cluster ID List to create API Key
userId Integer: User ID

environmentId string: Environment ID
clusterId string
description string: Description
logicalClusters string[]: Logical Cluster ID List to create API Key
userId number: User ID

environment_id str: Environment ID
cluster_id str
description str: Description
logical_clusters Sequence[str]: Logical Cluster ID List to create API Key
user_id int: User ID

environmentId String: Environment ID
clusterId String
description String: Description
logicalClusters List<String>: Logical Cluster ID List to create API Key
userId Number: User ID

Outputs

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

Id string: The provider-assigned unique ID for this managed resource.
Key string
Secret string

Id string: The provider-assigned unique ID for this managed resource.
Key string
Secret string

id String: The provider-assigned unique ID for this managed resource.
key String
secret String

id string: The provider-assigned unique ID for this managed resource.
key string
secret string

id str: The provider-assigned unique ID for this managed resource.
key str
secret str

id String: The provider-assigned unique ID for this managed resource.
key String
secret String

Look up Existing ApiKey Resource

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

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cluster_id: Optional[str] = None,
        description: Optional[str] = None,
        environment_id: Optional[str] = None,
        key: Optional[str] = None,
        logical_clusters: Optional[Sequence[str]] = None,
        secret: Optional[str] = None,
        user_id: Optional[int] = None) -> ApiKey

func GetApiKey(ctx *Context, name string, id IDInput, state *ApiKeyState, opts ...ResourceOption) (*ApiKey, error)

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

public static ApiKey get(String name, Output<String> id, ApiKeyState 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:

ClusterId string
Description string: Description
EnvironmentId string: Environment ID
Key string
LogicalClusters List<string>: Logical Cluster ID List to create API Key
Secret string
UserId int: User ID

ClusterId string
Description string: Description
EnvironmentId string: Environment ID
Key string
LogicalClusters []string: Logical Cluster ID List to create API Key
Secret string
UserId int: User ID

clusterId String
description String: Description
environmentId String: Environment ID
key String
logicalClusters List<String>: Logical Cluster ID List to create API Key
secret String
userId Integer: User ID

clusterId string
description string: Description
environmentId string: Environment ID
key string
logicalClusters string[]: Logical Cluster ID List to create API Key
secret string
userId number: User ID

cluster_id str
description str: Description
environment_id str: Environment ID
key str
logical_clusters Sequence[str]: Logical Cluster ID List to create API Key
secret str
user_id int: User ID

clusterId String
description String: Description
environmentId String: Environment ID
key String
logicalClusters List<String>: Logical Cluster ID List to create API Key
secret String
userId Number: User ID

Package Details

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