@pulumi/confluent
Version:
A Pulumi package for creating and managing confluent cloud resources.
92 lines (91 loc) • 2.91 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
export declare class ApiKey extends pulumi.CustomResource {
/**
* Get an existing ApiKey resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ApiKeyState, opts?: pulumi.CustomResourceOptions): ApiKey;
/**
* Returns true if the given object is an instance of ApiKey. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is ApiKey;
readonly clusterId: pulumi.Output<string | undefined>;
/**
* Description
*/
readonly description: pulumi.Output<string | undefined>;
/**
* Environment ID
*/
readonly environmentId: pulumi.Output<string>;
readonly key: pulumi.Output<string>;
/**
* Logical Cluster ID List to create API Key
*/
readonly logicalClusters: pulumi.Output<string[] | undefined>;
readonly secret: pulumi.Output<string>;
/**
* User ID
*/
readonly userId: pulumi.Output<number | undefined>;
/**
* Create a ApiKey resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: ApiKeyArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering ApiKey resources.
*/
export interface ApiKeyState {
clusterId?: pulumi.Input<string>;
/**
* Description
*/
description?: pulumi.Input<string>;
/**
* Environment ID
*/
environmentId?: pulumi.Input<string>;
key?: pulumi.Input<string>;
/**
* Logical Cluster ID List to create API Key
*/
logicalClusters?: pulumi.Input<pulumi.Input<string>[]>;
secret?: pulumi.Input<string>;
/**
* User ID
*/
userId?: pulumi.Input<number>;
}
/**
* The set of arguments for constructing a ApiKey resource.
*/
export interface ApiKeyArgs {
clusterId?: pulumi.Input<string>;
/**
* Description
*/
description?: pulumi.Input<string>;
/**
* Environment ID
*/
environmentId: pulumi.Input<string>;
/**
* Logical Cluster ID List to create API Key
*/
logicalClusters?: pulumi.Input<pulumi.Input<string>[]>;
/**
* User ID
*/
userId?: pulumi.Input<number>;
}