@pulumiverse/scaleway
Version:
A Pulumi package for creating and managing Scaleway cloud resources.
295 lines • 10.2 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Creates and manages Scaleway Kafka clusters.
* For more information refer to the [product documentation](https://www.scaleway.com/en/docs/managed-services/kafka/).
*
* > **Important:** The Kafka product is currently in Public Beta.
*
* ## Example Usage
*
* ### Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@pulumiverse/scaleway";
*
* const main = new scaleway.network.Vpc("main", {
* region: "fr-par",
* name: "my-vpc",
* });
* const pn = new scaleway.network.PrivateNetwork("pn", {
* name: "my-private-network",
* region: "fr-par",
* vpcId: main.id,
* });
* const mainCluster = new scaleway.kafka.Cluster("main", {
* name: "my-kafka-cluster",
* version: "4.1.1",
* nodeAmount: 1,
* nodeType: "KAFK-PLAY-NANO",
* volumeType: "sbs_5k",
* volumeSizeInGb: 10,
* userName: "admin",
* password: "thiZ_is_v&ry_s3cret",
* privateNetwork: {
* pnId: pn.id,
* },
* });
* ```
*
* ### With Tags
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@pulumiverse/scaleway";
*
* const main = new scaleway.network.Vpc("main", {
* region: "fr-par",
* name: "my-vpc",
* });
* const pn = new scaleway.network.PrivateNetwork("pn", {
* name: "my-private-network",
* region: "fr-par",
* vpcId: main.id,
* });
* const mainCluster = new scaleway.kafka.Cluster("main", {
* name: "my-kafka-cluster",
* version: "4.1.1",
* nodeAmount: 1,
* nodeType: "KAFK-PLAY-NANO",
* volumeType: "sbs_5k",
* volumeSizeInGb: 10,
* userName: "admin",
* password: "thiZ_is_v&ry_s3cret",
* tags: [
* "production",
* "messaging",
* ],
* privateNetwork: {
* pnId: pn.id,
* },
* });
* ```
*
* ## Import
*
* Kafka clusters can be imported using the `{region}/{id}`, e.g.
*
* ```sh
* $ pulumi import scaleway:kafka/cluster:Cluster main fr-par/11111111-1111-1111-1111-111111111111
* ```
*/
export declare class Cluster extends pulumi.CustomResource {
/**
* Get an existing Cluster 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?: ClusterState, opts?: pulumi.CustomResourceOptions): Cluster;
/**
* Returns true if the given object is an instance of Cluster. 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 Cluster;
/**
* Date and time of cluster creation (RFC 3339 format).
*/
readonly createdAt: pulumi.Output<string>;
/**
* Name of the Kafka cluster.
*/
readonly name: pulumi.Output<string>;
/**
* Number of nodes in the cluster. Changing this forces recreation of the cluster.
*/
readonly nodeAmount: pulumi.Output<number>;
/**
* Node type to use for the cluster. Changing this forces recreation of the cluster.
*/
readonly nodeType: pulumi.Output<string>;
/**
* Password for the Kafka user. Required if `userName` is specified. Changing this forces recreation of the cluster.
*/
readonly password: pulumi.Output<string | undefined>;
/**
* Private network endpoint information.
*/
readonly privateNetwork: pulumi.Output<outputs.kafka.ClusterPrivateNetwork | undefined>;
/**
* `projectId`) The ID of the project the cluster is associated with.
*/
readonly projectId: pulumi.Output<string>;
/**
* Public endpoint information.
*/
readonly publicNetworks: pulumi.Output<outputs.kafka.ClusterPublicNetwork[]>;
/**
* `region`) The region in which the cluster should be created.
*/
readonly region: pulumi.Output<string | undefined>;
/**
* The status of the cluster (e.g., "ready", "creating", "configuring").
*/
readonly status: pulumi.Output<string>;
/**
* List of tags to apply to the cluster.
*/
readonly tags: pulumi.Output<string[] | undefined>;
/**
* Date and time of cluster last update (RFC 3339 format).
*/
readonly updatedAt: pulumi.Output<string>;
/**
* Username for the Kafka user. If not specified, no user will be created. Changing this forces recreation of the cluster.
*/
readonly userName: pulumi.Output<string | undefined>;
/**
* Kafka version to use (e.g., "4.1.1"). Changing this forces recreation of the cluster.
*/
readonly version: pulumi.Output<string>;
/**
* Volume size in GB. Changing this forces recreation of the cluster.
*/
readonly volumeSizeInGb: pulumi.Output<number>;
/**
* Type of volume where data is stored (e.g., "sbs5k", "sbs15k"). Changing this forces recreation of the cluster.
*/
readonly volumeType: pulumi.Output<string>;
/**
* Create a Cluster 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: ClusterArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Cluster resources.
*/
export interface ClusterState {
/**
* Date and time of cluster creation (RFC 3339 format).
*/
createdAt?: pulumi.Input<string | undefined>;
/**
* Name of the Kafka cluster.
*/
name?: pulumi.Input<string | undefined>;
/**
* Number of nodes in the cluster. Changing this forces recreation of the cluster.
*/
nodeAmount?: pulumi.Input<number | undefined>;
/**
* Node type to use for the cluster. Changing this forces recreation of the cluster.
*/
nodeType?: pulumi.Input<string | undefined>;
/**
* Password for the Kafka user. Required if `userName` is specified. Changing this forces recreation of the cluster.
*/
password?: pulumi.Input<string | undefined>;
/**
* Private network endpoint information.
*/
privateNetwork?: pulumi.Input<inputs.kafka.ClusterPrivateNetwork | undefined>;
/**
* `projectId`) The ID of the project the cluster is associated with.
*/
projectId?: pulumi.Input<string | undefined>;
/**
* Public endpoint information.
*/
publicNetworks?: pulumi.Input<pulumi.Input<inputs.kafka.ClusterPublicNetwork>[] | undefined>;
/**
* `region`) The region in which the cluster should be created.
*/
region?: pulumi.Input<string | undefined>;
/**
* The status of the cluster (e.g., "ready", "creating", "configuring").
*/
status?: pulumi.Input<string | undefined>;
/**
* List of tags to apply to the cluster.
*/
tags?: pulumi.Input<pulumi.Input<string>[] | undefined>;
/**
* Date and time of cluster last update (RFC 3339 format).
*/
updatedAt?: pulumi.Input<string | undefined>;
/**
* Username for the Kafka user. If not specified, no user will be created. Changing this forces recreation of the cluster.
*/
userName?: pulumi.Input<string | undefined>;
/**
* Kafka version to use (e.g., "4.1.1"). Changing this forces recreation of the cluster.
*/
version?: pulumi.Input<string | undefined>;
/**
* Volume size in GB. Changing this forces recreation of the cluster.
*/
volumeSizeInGb?: pulumi.Input<number | undefined>;
/**
* Type of volume where data is stored (e.g., "sbs5k", "sbs15k"). Changing this forces recreation of the cluster.
*/
volumeType?: pulumi.Input<string | undefined>;
}
/**
* The set of arguments for constructing a Cluster resource.
*/
export interface ClusterArgs {
/**
* Name of the Kafka cluster.
*/
name?: pulumi.Input<string | undefined>;
/**
* Number of nodes in the cluster. Changing this forces recreation of the cluster.
*/
nodeAmount: pulumi.Input<number>;
/**
* Node type to use for the cluster. Changing this forces recreation of the cluster.
*/
nodeType: pulumi.Input<string>;
/**
* Password for the Kafka user. Required if `userName` is specified. Changing this forces recreation of the cluster.
*/
password?: pulumi.Input<string | undefined>;
/**
* Private network endpoint information.
*/
privateNetwork?: pulumi.Input<inputs.kafka.ClusterPrivateNetwork | undefined>;
/**
* `projectId`) The ID of the project the cluster is associated with.
*/
projectId?: pulumi.Input<string | undefined>;
/**
* `region`) The region in which the cluster should be created.
*/
region?: pulumi.Input<string | undefined>;
/**
* List of tags to apply to the cluster.
*/
tags?: pulumi.Input<pulumi.Input<string>[] | undefined>;
/**
* Username for the Kafka user. If not specified, no user will be created. Changing this forces recreation of the cluster.
*/
userName?: pulumi.Input<string | undefined>;
/**
* Kafka version to use (e.g., "4.1.1"). Changing this forces recreation of the cluster.
*/
version: pulumi.Input<string>;
/**
* Volume size in GB. Changing this forces recreation of the cluster.
*/
volumeSizeInGb: pulumi.Input<number>;
/**
* Type of volume where data is stored (e.g., "sbs5k", "sbs15k"). Changing this forces recreation of the cluster.
*/
volumeType: pulumi.Input<string>;
}
//# sourceMappingURL=cluster.d.ts.map