Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Confluent Cloud (Deprecated)
  3. API Docs
  4. ApiKey

This package is deprecated. We recommend using the new Confluent Cloud package.

Confluent Cloud v0.2.2 published on Friday, Dec 10, 2021 by Pulumi
pulumi/pulumi-confluent

confluent.ApiKey

Explore with Pulumi AI

This package is deprecated. We recommend using the new Confluent Cloud package.

Confluent Cloud v0.2.2 published on Friday, Dec 10, 2021 by Pulumi
pulumi/pulumi-confluent

Create ApiKey Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new ApiKey(name: string, args: ApiKeyArgs, opts?: CustomResourceOptions);
@overload
def ApiKey(resource_name: str,
           args: ApiKeyArgs,
           opts: Optional[ResourceOptions] = None)

@overload
def ApiKey(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           environment_id: Optional[str] = None,
           cluster_id: Optional[str] = None,
           description: Optional[str] = None,
           logical_clusters: Optional[Sequence[str]] = None,
           user_id: Optional[int] = 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.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. ApiKeyArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. 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 This property is required. string
The unique name of the resource.
args This property is required. ApiKeyArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ApiKeyArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ApiKeyArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var apiKeyResource = new Confluent.ApiKey("apiKeyResource", new()
{
    EnvironmentId = "string",
    ClusterId = "string",
    Description = "string",
    LogicalClusters = new[]
    {
        "string",
    },
    UserId = 0,
});
Copy
example, err := confluent.NewApiKey(ctx, "apiKeyResource", &confluent.ApiKeyArgs{
	EnvironmentId: pulumi.String("string"),
	ClusterId:     pulumi.String("string"),
	Description:   pulumi.String("string"),
	LogicalClusters: pulumi.StringArray{
		pulumi.String("string"),
	},
	UserId: pulumi.Int(0),
})
Copy
var apiKeyResource = new ApiKey("apiKeyResource", ApiKeyArgs.builder()
    .environmentId("string")
    .clusterId("string")
    .description("string")
    .logicalClusters("string")
    .userId(0)
    .build());
Copy
api_key_resource = confluent.ApiKey("apiKeyResource",
    environment_id="string",
    cluster_id="string",
    description="string",
    logical_clusters=["string"],
    user_id=0)
Copy
const apiKeyResource = new confluent.ApiKey("apiKeyResource", {
    environmentId: "string",
    clusterId: "string",
    description: "string",
    logicalClusters: ["string"],
    userId: 0,
});
Copy
type: confluent:ApiKey
properties:
    clusterId: string
    description: string
    environmentId: string
    logicalClusters:
        - string
    userId: 0
Copy

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

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The ApiKey resource accepts the following input properties:

EnvironmentId This property is required. string
Environment ID
ClusterId string
Description string
Description
LogicalClusters List<string>
Logical Cluster ID List to create API Key
UserId int
User ID
EnvironmentId This property is required. string
Environment ID
ClusterId string
Description string
Description
LogicalClusters []string
Logical Cluster ID List to create API Key
UserId int
User ID
environmentId This property is required. String
Environment ID
clusterId String
description String
Description
logicalClusters List<String>
Logical Cluster ID List to create API Key
userId Integer
User ID
environmentId This property is required. string
Environment ID
clusterId string
description string
Description
logicalClusters string[]
Logical Cluster ID List to create API Key
userId number
User ID
environment_id This property is required. 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 This property is required. 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)
resources:  _:    type: confluent:ApiKey    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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.

This package is deprecated. We recommend using the new Confluent Cloud package.

Confluent Cloud v0.2.2 published on Friday, Dec 10, 2021 by Pulumi
pulumi/pulumi-confluent