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

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.KafkaCluster

Explore with Pulumi AI

confluent logo

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 KafkaCluster Resource

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

    Constructor syntax

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

@overload
def KafkaCluster(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 availability: Optional[str] = None,
                 environment_id: Optional[str] = None,
                 region: Optional[str] = None,
                 service_provider: Optional[str] = None,
                 cku: Optional[int] = None,
                 deployment: Optional[Mapping[str, str]] = None,
                 name: Optional[str] = None,
                 network_egress: Optional[int] = None,
                 network_ingress: Optional[int] = None,
                 storage: Optional[int] = None)
    func NewKafkaCluster(ctx *Context, name string, args KafkaClusterArgs, opts ...ResourceOption) (*KafkaCluster, error)
    public KafkaCluster(string name, KafkaClusterArgs args, CustomResourceOptions? opts = null)
    public KafkaCluster(String name, KafkaClusterArgs args)
public KafkaCluster(String name, KafkaClusterArgs args, CustomResourceOptions options)

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

    Parameters

    name string
    The unique name of the resource.
    args KafkaClusterArgs
    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 KafkaClusterArgs
    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 KafkaClusterArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args KafkaClusterArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args KafkaClusterArgs
    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 kafkaClusterResource = new Confluent.KafkaCluster("kafkaClusterResource", new()
{
    Availability = "string",
    EnvironmentId = "string",
    Region = "string",
    ServiceProvider = "string",
    Cku = 0,
    Deployment = 
    {
        { "string", "string" },
    },
    Name = "string",
    NetworkEgress = 0,
    NetworkIngress = 0,
    Storage = 0,
});

    example, err := confluent.NewKafkaCluster(ctx, "kafkaClusterResource", &confluent.KafkaClusterArgs{
	Availability:    pulumi.String("string"),
	EnvironmentId:   pulumi.String("string"),
	Region:          pulumi.String("string"),
	ServiceProvider: pulumi.String("string"),
	Cku:             pulumi.Int(0),
	Deployment: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Name:           pulumi.String("string"),
	NetworkEgress:  pulumi.Int(0),
	NetworkIngress: pulumi.Int(0),
	Storage:        pulumi.Int(0),
})

    var kafkaClusterResource = new KafkaCluster("kafkaClusterResource", KafkaClusterArgs.builder()
    .availability("string")
    .environmentId("string")
    .region("string")
    .serviceProvider("string")
    .cku(0)
    .deployment(Map.of("string", "string"))
    .name("string")
    .networkEgress(0)
    .networkIngress(0)
    .storage(0)
    .build());

    kafka_cluster_resource = confluent.KafkaCluster("kafkaClusterResource",
    availability="string",
    environment_id="string",
    region="string",
    service_provider="string",
    cku=0,
    deployment={
        "string": "string",
    },
    name="string",
    network_egress=0,
    network_ingress=0,
    storage=0)

    const kafkaClusterResource = new confluent.KafkaCluster("kafkaClusterResource", {
    availability: "string",
    environmentId: "string",
    region: "string",
    serviceProvider: "string",
    cku: 0,
    deployment: {
        string: "string",
    },
    name: "string",
    networkEgress: 0,
    networkIngress: 0,
    storage: 0,
});

    type: confluent:KafkaCluster
properties:
    availability: string
    cku: 0
    deployment:
        string: string
    environmentId: string
    name: string
    networkEgress: 0
    networkIngress: 0
    region: string
    serviceProvider: string
    storage: 0

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

    Availability string
    LOW(single-zone) or HIGH(multi-zone)
    EnvironmentId string
    Environment ID
    Region string
    where
    ServiceProvider string
    AWS / GCP
    Cku int
    cku
    Deployment Dictionary<string, string>
    Deployment settings. Currently only sku is supported.
    Name string
    The name of the cluster
    NetworkEgress int
    Network egress limit(MBps)
    NetworkIngress int
    Network ingress limit(MBps)
    Storage int
    Storage limit(GB)
    Availability string
    LOW(single-zone) or HIGH(multi-zone)
    EnvironmentId string
    Environment ID
    Region string
    where
    ServiceProvider string
    AWS / GCP
    Cku int
    cku
    Deployment map[string]string
    Deployment settings. Currently only sku is supported.
    Name string
    The name of the cluster
    NetworkEgress int
    Network egress limit(MBps)
    NetworkIngress int
    Network ingress limit(MBps)
    Storage int
    Storage limit(GB)
    availability String
    LOW(single-zone) or HIGH(multi-zone)
    environmentId String
    Environment ID
    region String
    where
    serviceProvider String
    AWS / GCP
    cku Integer
    cku
    deployment Map<String,String>
    Deployment settings. Currently only sku is supported.
    name String
    The name of the cluster
    networkEgress Integer
    Network egress limit(MBps)
    networkIngress Integer
    Network ingress limit(MBps)
    storage Integer
    Storage limit(GB)
    availability string
    LOW(single-zone) or HIGH(multi-zone)
    environmentId string
    Environment ID
    region string
    where
    serviceProvider string
    AWS / GCP
    cku number
    cku
    deployment {[key: string]: string}
    Deployment settings. Currently only sku is supported.
    name string
    The name of the cluster
    networkEgress number
    Network egress limit(MBps)
    networkIngress number
    Network ingress limit(MBps)
    storage number
    Storage limit(GB)
    availability str
    LOW(single-zone) or HIGH(multi-zone)
    environment_id str
    Environment ID
    region str
    where
    service_provider str
    AWS / GCP
    cku int
    cku
    deployment Mapping[str, str]
    Deployment settings. Currently only sku is supported.
    name str
    The name of the cluster
    network_egress int
    Network egress limit(MBps)
    network_ingress int
    Network ingress limit(MBps)
    storage int
    Storage limit(GB)
    availability String
    LOW(single-zone) or HIGH(multi-zone)
    environmentId String
    Environment ID
    region String
    where
    serviceProvider String
    AWS / GCP
    cku Number
    cku
    deployment Map<String>
    Deployment settings. Currently only sku is supported.
    name String
    The name of the cluster
    networkEgress Number
    Network egress limit(MBps)
    networkIngress Number
    Network ingress limit(MBps)
    storage Number
    Storage limit(GB)

    Outputs

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

    BootstrapServers string
    Id string
    The provider-assigned unique ID for this managed resource.
    BootstrapServers string
    Id string
    The provider-assigned unique ID for this managed resource.
    bootstrapServers String
    id String
    The provider-assigned unique ID for this managed resource.
    bootstrapServers string
    id string
    The provider-assigned unique ID for this managed resource.
    bootstrap_servers str
    id str
    The provider-assigned unique ID for this managed resource.
    bootstrapServers String
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing KafkaCluster Resource

    Get an existing KafkaCluster 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?: KafkaClusterState, opts?: CustomResourceOptions): KafkaCluster
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        availability: Optional[str] = None,
        bootstrap_servers: Optional[str] = None,
        cku: Optional[int] = None,
        deployment: Optional[Mapping[str, str]] = None,
        environment_id: Optional[str] = None,
        name: Optional[str] = None,
        network_egress: Optional[int] = None,
        network_ingress: Optional[int] = None,
        region: Optional[str] = None,
        service_provider: Optional[str] = None,
        storage: Optional[int] = None) -> KafkaCluster
    func GetKafkaCluster(ctx *Context, name string, id IDInput, state *KafkaClusterState, opts ...ResourceOption) (*KafkaCluster, error)
    public static KafkaCluster Get(string name, Input<string> id, KafkaClusterState? state, CustomResourceOptions? opts = null)
    public static KafkaCluster get(String name, Output<String> id, KafkaClusterState 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:
    Availability string
    LOW(single-zone) or HIGH(multi-zone)
    BootstrapServers string
    Cku int
    cku
    Deployment Dictionary<string, string>
    Deployment settings. Currently only sku is supported.
    EnvironmentId string
    Environment ID
    Name string
    The name of the cluster
    NetworkEgress int
    Network egress limit(MBps)
    NetworkIngress int
    Network ingress limit(MBps)
    Region string
    where
    ServiceProvider string
    AWS / GCP
    Storage int
    Storage limit(GB)
    Availability string
    LOW(single-zone) or HIGH(multi-zone)
    BootstrapServers string
    Cku int
    cku
    Deployment map[string]string
    Deployment settings. Currently only sku is supported.
    EnvironmentId string
    Environment ID
    Name string
    The name of the cluster
    NetworkEgress int
    Network egress limit(MBps)
    NetworkIngress int
    Network ingress limit(MBps)
    Region string
    where
    ServiceProvider string
    AWS / GCP
    Storage int
    Storage limit(GB)
    availability String
    LOW(single-zone) or HIGH(multi-zone)
    bootstrapServers String
    cku Integer
    cku
    deployment Map<String,String>
    Deployment settings. Currently only sku is supported.
    environmentId String
    Environment ID
    name String
    The name of the cluster
    networkEgress Integer
    Network egress limit(MBps)
    networkIngress Integer
    Network ingress limit(MBps)
    region String
    where
    serviceProvider String
    AWS / GCP
    storage Integer
    Storage limit(GB)
    availability string
    LOW(single-zone) or HIGH(multi-zone)
    bootstrapServers string
    cku number
    cku
    deployment {[key: string]: string}
    Deployment settings. Currently only sku is supported.
    environmentId string
    Environment ID
    name string
    The name of the cluster
    networkEgress number
    Network egress limit(MBps)
    networkIngress number
    Network ingress limit(MBps)
    region string
    where
    serviceProvider string
    AWS / GCP
    storage number
    Storage limit(GB)
    availability str
    LOW(single-zone) or HIGH(multi-zone)
    bootstrap_servers str
    cku int
    cku
    deployment Mapping[str, str]
    Deployment settings. Currently only sku is supported.
    environment_id str
    Environment ID
    name str
    The name of the cluster
    network_egress int
    Network egress limit(MBps)
    network_ingress int
    Network ingress limit(MBps)
    region str
    where
    service_provider str
    AWS / GCP
    storage int
    Storage limit(GB)
    availability String
    LOW(single-zone) or HIGH(multi-zone)
    bootstrapServers String
    cku Number
    cku
    deployment Map<String>
    Deployment settings. Currently only sku is supported.
    environmentId String
    Environment ID
    name String
    The name of the cluster
    networkEgress Number
    Network egress limit(MBps)
    networkIngress Number
    Network ingress limit(MBps)
    region String
    where
    serviceProvider String
    AWS / GCP
    storage Number
    Storage limit(GB)

    Package Details

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

    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