Confluent v1.17.0, Jun 1 23
Confluent v1.17.0, Jun 1 23
confluentcloud.ApiKey
Explore with Pulumi AI
Import
You can import a Cluster API Key by using the Environment ID and Cluster API Key ID in the format <Environment ID>/<Cluster API Key ID>
, for example$ export CONFLUENT_CLOUD_API_KEY="<cloud_api_key>" $ export CONFLUENT_CLOUD_API_SECRET="<cloud_api_secret>" $ export API_KEY_SECRET="<api_key_secret>" Option #1Cluster API Key
$ pulumi import confluentcloud:index/apiKey:ApiKey example_kafka_api_key "env-abc123/UTT6WDRXX7FHD2GV"
You can import a Cloud API Key by using Cloud API Key ID, for example$ export CONFLUENT_CLOUD_API_KEY="<cloud_api_key>" $ export CONFLUENT_CLOUD_API_SECRET="<cloud_api_secret>" $ export API_KEY_SECRET="<api_key_secret>" Option #2Cloud API Key
$ pulumi import confluentcloud:index/apiKey:ApiKey example_cloud_api_key "4UEXOMMWIBE5KZQG"
!> Warning: Do not forget to delete terminal command history afterwards for security purposes.
Create ApiKey Resource
new ApiKey(name: string, args: ApiKeyArgs, opts?: CustomResourceOptions);
@overload
def ApiKey(resource_name: str,
opts: Optional[ResourceOptions] = None,
description: Optional[str] = None,
disable_wait_for_ready: Optional[bool] = None,
display_name: Optional[str] = None,
managed_resource: Optional[ApiKeyManagedResourceArgs] = None,
owner: Optional[ApiKeyOwnerArgs] = 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: confluentcloud: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:
- Owner
Pulumi.
Confluent Cloud. Inputs. Api Key Owner Args The owner to which the API Key belongs. The owner can be one of 'iam.v2.User', 'iam.v2.ServiceAccount'.
- Description string
A free-form description of the API Account.
- Disable
Wait boolFor Ready An optional flag to disable wait-for-readiness on create. Its primary use case is for Cluster API Keys for private networking options when readiness check fails. Must be unset when importing. Defaults to
false
.- Display
Name string A human-readable name for the API Key.
- Managed
Resource Pulumi.Confluent Cloud. Inputs. Api Key Managed Resource Args The resource associated with this object. The only resource that is supported is 'cmk.v2.Cluster', 'srcm.v2.Cluster'.
- Owner
Api
Key Owner Args The owner to which the API Key belongs. The owner can be one of 'iam.v2.User', 'iam.v2.ServiceAccount'.
- Description string
A free-form description of the API Account.
- Disable
Wait boolFor Ready An optional flag to disable wait-for-readiness on create. Its primary use case is for Cluster API Keys for private networking options when readiness check fails. Must be unset when importing. Defaults to
false
.- Display
Name string A human-readable name for the API Key.
- Managed
Resource ApiKey Managed Resource Args The resource associated with this object. The only resource that is supported is 'cmk.v2.Cluster', 'srcm.v2.Cluster'.
- owner
Api
Key Owner Args The owner to which the API Key belongs. The owner can be one of 'iam.v2.User', 'iam.v2.ServiceAccount'.
- description String
A free-form description of the API Account.
- disable
Wait BooleanFor Ready An optional flag to disable wait-for-readiness on create. Its primary use case is for Cluster API Keys for private networking options when readiness check fails. Must be unset when importing. Defaults to
false
.- display
Name String A human-readable name for the API Key.
- managed
Resource ApiKey Managed Resource Args The resource associated with this object. The only resource that is supported is 'cmk.v2.Cluster', 'srcm.v2.Cluster'.
- owner
Api
Key Owner Args The owner to which the API Key belongs. The owner can be one of 'iam.v2.User', 'iam.v2.ServiceAccount'.
- description string
A free-form description of the API Account.
- disable
Wait booleanFor Ready An optional flag to disable wait-for-readiness on create. Its primary use case is for Cluster API Keys for private networking options when readiness check fails. Must be unset when importing. Defaults to
false
.- display
Name string A human-readable name for the API Key.
- managed
Resource ApiKey Managed Resource Args The resource associated with this object. The only resource that is supported is 'cmk.v2.Cluster', 'srcm.v2.Cluster'.
- owner
Api
Key Owner Args The owner to which the API Key belongs. The owner can be one of 'iam.v2.User', 'iam.v2.ServiceAccount'.
- description str
A free-form description of the API Account.
- disable_
wait_ boolfor_ ready An optional flag to disable wait-for-readiness on create. Its primary use case is for Cluster API Keys for private networking options when readiness check fails. Must be unset when importing. Defaults to
false
.- display_
name str A human-readable name for the API Key.
- managed_
resource ApiKey Managed Resource Args The resource associated with this object. The only resource that is supported is 'cmk.v2.Cluster', 'srcm.v2.Cluster'.
- owner Property Map
The owner to which the API Key belongs. The owner can be one of 'iam.v2.User', 'iam.v2.ServiceAccount'.
- description String
A free-form description of the API Account.
- disable
Wait BooleanFor Ready An optional flag to disable wait-for-readiness on create. Its primary use case is for Cluster API Keys for private networking options when readiness check fails. Must be unset when importing. Defaults to
false
.- display
Name String A human-readable name for the API Key.
- managed
Resource Property Map The resource associated with this object. The only resource that is supported is 'cmk.v2.Cluster', 'srcm.v2.Cluster'.
Outputs
All input properties are implicitly available as output properties. Additionally, the ApiKey resource produces the following output properties:
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,
description: Optional[str] = None,
disable_wait_for_ready: Optional[bool] = None,
display_name: Optional[str] = None,
managed_resource: Optional[ApiKeyManagedResourceArgs] = None,
owner: Optional[ApiKeyOwnerArgs] = None,
secret: Optional[str] = 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.
- Description string
A free-form description of the API Account.
- Disable
Wait boolFor Ready An optional flag to disable wait-for-readiness on create. Its primary use case is for Cluster API Keys for private networking options when readiness check fails. Must be unset when importing. Defaults to
false
.- Display
Name string A human-readable name for the API Key.
- Managed
Resource Pulumi.Confluent Cloud. Inputs. Api Key Managed Resource Args The resource associated with this object. The only resource that is supported is 'cmk.v2.Cluster', 'srcm.v2.Cluster'.
- Owner
Pulumi.
Confluent Cloud. Inputs. Api Key Owner Args The owner to which the API Key belongs. The owner can be one of 'iam.v2.User', 'iam.v2.ServiceAccount'.
- Secret string
(Required String, Sensitive) The secret of the API Key.
- Description string
A free-form description of the API Account.
- Disable
Wait boolFor Ready An optional flag to disable wait-for-readiness on create. Its primary use case is for Cluster API Keys for private networking options when readiness check fails. Must be unset when importing. Defaults to
false
.- Display
Name string A human-readable name for the API Key.
- Managed
Resource ApiKey Managed Resource Args The resource associated with this object. The only resource that is supported is 'cmk.v2.Cluster', 'srcm.v2.Cluster'.
- Owner
Api
Key Owner Args The owner to which the API Key belongs. The owner can be one of 'iam.v2.User', 'iam.v2.ServiceAccount'.
- Secret string
(Required String, Sensitive) The secret of the API Key.
- description String
A free-form description of the API Account.
- disable
Wait BooleanFor Ready An optional flag to disable wait-for-readiness on create. Its primary use case is for Cluster API Keys for private networking options when readiness check fails. Must be unset when importing. Defaults to
false
.- display
Name String A human-readable name for the API Key.
- managed
Resource ApiKey Managed Resource Args The resource associated with this object. The only resource that is supported is 'cmk.v2.Cluster', 'srcm.v2.Cluster'.
- owner
Api
Key Owner Args The owner to which the API Key belongs. The owner can be one of 'iam.v2.User', 'iam.v2.ServiceAccount'.
- secret String
(Required String, Sensitive) The secret of the API Key.
- description string
A free-form description of the API Account.
- disable
Wait booleanFor Ready An optional flag to disable wait-for-readiness on create. Its primary use case is for Cluster API Keys for private networking options when readiness check fails. Must be unset when importing. Defaults to
false
.- display
Name string A human-readable name for the API Key.
- managed
Resource ApiKey Managed Resource Args The resource associated with this object. The only resource that is supported is 'cmk.v2.Cluster', 'srcm.v2.Cluster'.
- owner
Api
Key Owner Args The owner to which the API Key belongs. The owner can be one of 'iam.v2.User', 'iam.v2.ServiceAccount'.
- secret string
(Required String, Sensitive) The secret of the API Key.
- description str
A free-form description of the API Account.
- disable_
wait_ boolfor_ ready An optional flag to disable wait-for-readiness on create. Its primary use case is for Cluster API Keys for private networking options when readiness check fails. Must be unset when importing. Defaults to
false
.- display_
name str A human-readable name for the API Key.
- managed_
resource ApiKey Managed Resource Args The resource associated with this object. The only resource that is supported is 'cmk.v2.Cluster', 'srcm.v2.Cluster'.
- owner
Api
Key Owner Args The owner to which the API Key belongs. The owner can be one of 'iam.v2.User', 'iam.v2.ServiceAccount'.
- secret str
(Required String, Sensitive) The secret of the API Key.
- description String
A free-form description of the API Account.
- disable
Wait BooleanFor Ready An optional flag to disable wait-for-readiness on create. Its primary use case is for Cluster API Keys for private networking options when readiness check fails. Must be unset when importing. Defaults to
false
.- display
Name String A human-readable name for the API Key.
- managed
Resource Property Map The resource associated with this object. The only resource that is supported is 'cmk.v2.Cluster', 'srcm.v2.Cluster'.
- owner Property Map
The owner to which the API Key belongs. The owner can be one of 'iam.v2.User', 'iam.v2.ServiceAccount'.
- secret String
(Required String, Sensitive) The secret of the API Key.
Supporting Types
ApiKeyManagedResource
- Api
Version string The API group and version of the managed resource that the API Key associated with, for example,
cmk/v2
.- Environment
Pulumi.
Confluent Cloud. Inputs. Api Key Managed Resource Environment - Id string
The ID of the Environment that the managed resource belongs to, for example,
env-abc123
.- Kind string
The kind of the managed resource that the API Key associated with, for example,
Cluster
.
- Api
Version string The API group and version of the managed resource that the API Key associated with, for example,
cmk/v2
.- Environment
Api
Key Managed Resource Environment - Id string
The ID of the Environment that the managed resource belongs to, for example,
env-abc123
.- Kind string
The kind of the managed resource that the API Key associated with, for example,
Cluster
.
- api
Version String The API group and version of the managed resource that the API Key associated with, for example,
cmk/v2
.- environment
Api
Key Managed Resource Environment - id String
The ID of the Environment that the managed resource belongs to, for example,
env-abc123
.- kind String
The kind of the managed resource that the API Key associated with, for example,
Cluster
.
- api
Version string The API group and version of the managed resource that the API Key associated with, for example,
cmk/v2
.- environment
Api
Key Managed Resource Environment - id string
The ID of the Environment that the managed resource belongs to, for example,
env-abc123
.- kind string
The kind of the managed resource that the API Key associated with, for example,
Cluster
.
- api_
version str The API group and version of the managed resource that the API Key associated with, for example,
cmk/v2
.- environment
Api
Key Managed Resource Environment - id str
The ID of the Environment that the managed resource belongs to, for example,
env-abc123
.- kind str
The kind of the managed resource that the API Key associated with, for example,
Cluster
.
- api
Version String The API group and version of the managed resource that the API Key associated with, for example,
cmk/v2
.- environment Property Map
- id String
The ID of the Environment that the managed resource belongs to, for example,
env-abc123
.- kind String
The kind of the managed resource that the API Key associated with, for example,
Cluster
.
ApiKeyManagedResourceEnvironment
- Id string
The ID of the Environment that the managed resource belongs to, for example,
env-abc123
.
- Id string
The ID of the Environment that the managed resource belongs to, for example,
env-abc123
.
- id String
The ID of the Environment that the managed resource belongs to, for example,
env-abc123
.
- id string
The ID of the Environment that the managed resource belongs to, for example,
env-abc123
.
- id str
The ID of the Environment that the managed resource belongs to, for example,
env-abc123
.
- id String
The ID of the Environment that the managed resource belongs to, for example,
env-abc123
.
ApiKeyOwner
- Api
Version string The API group and version of the managed resource that the API Key associated with, for example,
cmk/v2
.- Id string
The ID of the Environment that the managed resource belongs to, for example,
env-abc123
.- Kind string
The kind of the managed resource that the API Key associated with, for example,
Cluster
.
- Api
Version string The API group and version of the managed resource that the API Key associated with, for example,
cmk/v2
.- Id string
The ID of the Environment that the managed resource belongs to, for example,
env-abc123
.- Kind string
The kind of the managed resource that the API Key associated with, for example,
Cluster
.
- api
Version String The API group and version of the managed resource that the API Key associated with, for example,
cmk/v2
.- id String
The ID of the Environment that the managed resource belongs to, for example,
env-abc123
.- kind String
The kind of the managed resource that the API Key associated with, for example,
Cluster
.
- api
Version string The API group and version of the managed resource that the API Key associated with, for example,
cmk/v2
.- id string
The ID of the Environment that the managed resource belongs to, for example,
env-abc123
.- kind string
The kind of the managed resource that the API Key associated with, for example,
Cluster
.
- api_
version str The API group and version of the managed resource that the API Key associated with, for example,
cmk/v2
.- id str
The ID of the Environment that the managed resource belongs to, for example,
env-abc123
.- kind str
The kind of the managed resource that the API Key associated with, for example,
Cluster
.
- api
Version String The API group and version of the managed resource that the API Key associated with, for example,
cmk/v2
.- id String
The ID of the Environment that the managed resource belongs to, for example,
env-abc123
.- kind String
The kind of the managed resource that the API Key associated with, for example,
Cluster
.
Package Details
- Repository
- Confluent Cloud pulumi/pulumi-confluentcloud
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
confluent
Terraform Provider.