Yandex

v0.10.0 published on Thursday, Nov 18, 2021 by Pulumi

getMdbKafkaCluster

Get information about a Yandex Managed Kafka cluster. For more information, see the official documentation.

Example Usage

using Pulumi;
using Yandex = Pulumi.Yandex;

class MyStack : Stack
{
    public MyStack()
    {
        var foo = Output.Create(Yandex.GetMdbKafkaCluster.InvokeAsync(new Yandex.GetMdbKafkaClusterArgs
        {
            Name = "test",
        }));
        this.NetworkId = foo.Apply(foo => foo.NetworkId);
    }

    [Output("networkId")]
    public Output<string> NetworkId { get; set; }
}
package main

import (
	"github.com/pulumi/pulumi-yandex/sdk/go/yandex"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		opt0 := "test"
		foo, err := yandex.LookupMdbKafkaCluster(ctx, &GetMdbKafkaClusterArgs{
			Name: &opt0,
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("networkId", foo.NetworkId)
		return nil
	})
}
import pulumi
import pulumi_yandex as yandex

foo = yandex.get_mdb_kafka_cluster(name="test")
pulumi.export("networkId", foo.network_id)
import * as pulumi from "@pulumi/pulumi";
import * as yandex from "@pulumi/yandex";

const foo = pulumi.output(yandex.getMdbKafkaCluster({
    name: "test",
}));

export const networkId = foo.networkId;

Using getMdbKafkaCluster

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getMdbKafkaCluster(args: GetMdbKafkaClusterArgs, opts?: InvokeOptions): Promise<GetMdbKafkaClusterResult>
function getMdbKafkaClusterOutput(args: GetMdbKafkaClusterOutputArgs, opts?: InvokeOptions): Output<GetMdbKafkaClusterResult>
def get_mdb_kafka_cluster(cluster_id: Optional[str] = None,
                          config: Optional[GetMdbKafkaClusterConfig] = None,
                          deletion_protection: Optional[bool] = None,
                          folder_id: Optional[str] = None,
                          name: Optional[str] = None,
                          subnet_ids: Optional[Sequence[str]] = None,
                          topics: Optional[Sequence[GetMdbKafkaClusterTopic]] = None,
                          users: Optional[Sequence[GetMdbKafkaClusterUser]] = None,
                          opts: Optional[InvokeOptions] = None) -> GetMdbKafkaClusterResult
def get_mdb_kafka_cluster_output(cluster_id: Optional[pulumi.Input[str]] = None,
                          config: Optional[pulumi.Input[GetMdbKafkaClusterConfigArgs]] = None,
                          deletion_protection: Optional[pulumi.Input[bool]] = None,
                          folder_id: Optional[pulumi.Input[str]] = None,
                          name: Optional[pulumi.Input[str]] = None,
                          subnet_ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                          topics: Optional[pulumi.Input[Sequence[pulumi.Input[GetMdbKafkaClusterTopicArgs]]]] = None,
                          users: Optional[pulumi.Input[Sequence[pulumi.Input[GetMdbKafkaClusterUserArgs]]]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetMdbKafkaClusterResult]
func LookupMdbKafkaCluster(ctx *Context, args *LookupMdbKafkaClusterArgs, opts ...InvokeOption) (*LookupMdbKafkaClusterResult, error)
func LookupMdbKafkaClusterOutput(ctx *Context, args *LookupMdbKafkaClusterOutputArgs, opts ...InvokeOption) LookupMdbKafkaClusterResultOutput

> Note: This function is named LookupMdbKafkaCluster in the Go SDK.

public static class GetMdbKafkaCluster 
{
    public static Task<GetMdbKafkaClusterResult> InvokeAsync(GetMdbKafkaClusterArgs args, InvokeOptions? opts = null)
    public static Output<GetMdbKafkaClusterResult> Invoke(GetMdbKafkaClusterInvokeArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

ClusterId string
The ID of the Kafka cluster.
Config GetMdbKafkaClusterConfig
Configuration of the Kafka cluster. The structure is documented below.
DeletionProtection bool
FolderId string
The ID of the folder that the resource belongs to. If it is not provided, the default provider folder is used.
Name string
The name of the Kafka cluster.
SubnetIds List<string>
Topics List<GetMdbKafkaClusterTopic>
A topic of the Kafka cluster. The structure is documented below.
Users List<GetMdbKafkaClusterUser>
A user of the Kafka cluster. The structure is documented below.
ClusterId string
The ID of the Kafka cluster.
Config GetMdbKafkaClusterConfig
Configuration of the Kafka cluster. The structure is documented below.
DeletionProtection bool
FolderId string
The ID of the folder that the resource belongs to. If it is not provided, the default provider folder is used.
Name string
The name of the Kafka cluster.
SubnetIds []string
Topics []GetMdbKafkaClusterTopic
A topic of the Kafka cluster. The structure is documented below.
Users []GetMdbKafkaClusterUser
A user of the Kafka cluster. The structure is documented below.
clusterId string
The ID of the Kafka cluster.
config GetMdbKafkaClusterConfig
Configuration of the Kafka cluster. The structure is documented below.
deletionProtection boolean
folderId string
The ID of the folder that the resource belongs to. If it is not provided, the default provider folder is used.
name string
The name of the Kafka cluster.
subnetIds string[]
topics GetMdbKafkaClusterTopic[]
A topic of the Kafka cluster. The structure is documented below.
users GetMdbKafkaClusterUser[]
A user of the Kafka cluster. The structure is documented below.
cluster_id str
The ID of the Kafka cluster.
config GetMdbKafkaClusterConfig
Configuration of the Kafka cluster. The structure is documented below.
deletion_protection bool
folder_id str
The ID of the folder that the resource belongs to. If it is not provided, the default provider folder is used.
name str
The name of the Kafka cluster.
subnet_ids Sequence[str]
topics Sequence[GetMdbKafkaClusterTopic]
A topic of the Kafka cluster. The structure is documented below.
users Sequence[GetMdbKafkaClusterUser]
A user of the Kafka cluster. The structure is documented below.

getMdbKafkaCluster Result

The following output properties are available:

ClusterId string
CreatedAt string
Creation timestamp of the key.
DeletionProtection bool
Description string
Description of the Kafka cluster.
Environment string
Deployment environment of the Kafka cluster.
FolderId string
Health string
Health of the host.
HostGroupIds List<string>
A list of IDs of the host groups hosting VMs of the cluster.
Hosts List<GetMdbKafkaClusterHost>
A host of the Kafka cluster. The structure is documented below.
Id string
The provider-assigned unique ID for this managed resource.
Labels Dictionary<string, string>
A set of key/value label pairs to assign to the Kafka cluster.
Name string
The fully qualified domain name of the host.
NetworkId string
ID of the network, to which the Kafka cluster belongs.
SecurityGroupIds List<string>
A list of security groups IDs of the Kafka cluster.
Status string
Status of the cluster.
Config GetMdbKafkaClusterConfig
Configuration of the Kafka cluster. The structure is documented below.
SubnetIds List<string>
Topics List<GetMdbKafkaClusterTopic>
A topic of the Kafka cluster. The structure is documented below.
Users List<GetMdbKafkaClusterUser>
A user of the Kafka cluster. The structure is documented below.
ClusterId string
CreatedAt string
Creation timestamp of the key.
DeletionProtection bool
Description string
Description of the Kafka cluster.
Environment string
Deployment environment of the Kafka cluster.
FolderId string
Health string
Health of the host.
HostGroupIds []string
A list of IDs of the host groups hosting VMs of the cluster.
Hosts []GetMdbKafkaClusterHost
A host of the Kafka cluster. The structure is documented below.
Id string
The provider-assigned unique ID for this managed resource.
Labels map[string]string
A set of key/value label pairs to assign to the Kafka cluster.
Name string
The fully qualified domain name of the host.
NetworkId string
ID of the network, to which the Kafka cluster belongs.
SecurityGroupIds []string
A list of security groups IDs of the Kafka cluster.
Status string
Status of the cluster.
Config GetMdbKafkaClusterConfig
Configuration of the Kafka cluster. The structure is documented below.
SubnetIds []string
Topics []GetMdbKafkaClusterTopic
A topic of the Kafka cluster. The structure is documented below.
Users []GetMdbKafkaClusterUser
A user of the Kafka cluster. The structure is documented below.
clusterId string
createdAt string
Creation timestamp of the key.
deletionProtection boolean
description string
Description of the Kafka cluster.
environment string
Deployment environment of the Kafka cluster.
folderId string
health string
Health of the host.
hostGroupIds string[]
A list of IDs of the host groups hosting VMs of the cluster.
hosts GetMdbKafkaClusterHost[]
A host of the Kafka cluster. The structure is documented below.
id string
The provider-assigned unique ID for this managed resource.
labels {[key: string]: string}
A set of key/value label pairs to assign to the Kafka cluster.
name string
The fully qualified domain name of the host.
networkId string
ID of the network, to which the Kafka cluster belongs.
securityGroupIds string[]
A list of security groups IDs of the Kafka cluster.
status string
Status of the cluster.
config GetMdbKafkaClusterConfig
Configuration of the Kafka cluster. The structure is documented below.
subnetIds string[]
topics GetMdbKafkaClusterTopic[]
A topic of the Kafka cluster. The structure is documented below.
users GetMdbKafkaClusterUser[]
A user of the Kafka cluster. The structure is documented below.
cluster_id str
created_at str
Creation timestamp of the key.
deletion_protection bool
description str
Description of the Kafka cluster.
environment str
Deployment environment of the Kafka cluster.
folder_id str
health str
Health of the host.
host_group_ids Sequence[str]
A list of IDs of the host groups hosting VMs of the cluster.
hosts Sequence[GetMdbKafkaClusterHost]
A host of the Kafka cluster. The structure is documented below.
id str
The provider-assigned unique ID for this managed resource.
labels Mapping[str, str]
A set of key/value label pairs to assign to the Kafka cluster.
name str
The fully qualified domain name of the host.
network_id str
ID of the network, to which the Kafka cluster belongs.
security_group_ids Sequence[str]
A list of security groups IDs of the Kafka cluster.
status str
Status of the cluster.
config GetMdbKafkaClusterConfig
Configuration of the Kafka cluster. The structure is documented below.
subnet_ids Sequence[str]
topics Sequence[GetMdbKafkaClusterTopic]
A topic of the Kafka cluster. The structure is documented below.
users Sequence[GetMdbKafkaClusterUser]
A user of the Kafka cluster. The structure is documented below.

Supporting Types

GetMdbKafkaClusterConfig

Kafka GetMdbKafkaClusterConfigKafka
(Optional) Configuration of the Kafka subcluster. The structure is documented below.
Version string
(Required) Version of the Kafka server software.
Zones List<string>
(Optional) List of availability zones.
Zookeeper GetMdbKafkaClusterConfigZookeeper
(Optional) Configuration of the ZooKeeper subcluster. The structure is documented below.
AssignPublicIp bool
The flag that defines whether a public IP address is assigned to the node.
BrokersCount int
(Optional) Count of brokers per availability zone.
SchemaRegistry bool
(Optional) Enables managed schema registry on cluster. Can be either true or false.
UnmanagedTopics bool
(Optional) Allows to use Kafka AdminAPI to manage topics. Can be either true or false.
Kafka GetMdbKafkaClusterConfigKafka
(Optional) Configuration of the Kafka subcluster. The structure is documented below.
Version string
(Required) Version of the Kafka server software.
Zones []string
(Optional) List of availability zones.
Zookeeper GetMdbKafkaClusterConfigZookeeper
(Optional) Configuration of the ZooKeeper subcluster. The structure is documented below.
AssignPublicIp bool
The flag that defines whether a public IP address is assigned to the node.
BrokersCount int
(Optional) Count of brokers per availability zone.
SchemaRegistry bool
(Optional) Enables managed schema registry on cluster. Can be either true or false.
UnmanagedTopics bool
(Optional) Allows to use Kafka AdminAPI to manage topics. Can be either true or false.
kafka GetMdbKafkaClusterConfigKafka
(Optional) Configuration of the Kafka subcluster. The structure is documented below.
version string
(Required) Version of the Kafka server software.
zones string[]
(Optional) List of availability zones.
zookeeper GetMdbKafkaClusterConfigZookeeper
(Optional) Configuration of the ZooKeeper subcluster. The structure is documented below.
assignPublicIp boolean
The flag that defines whether a public IP address is assigned to the node.
brokersCount number
(Optional) Count of brokers per availability zone.
schemaRegistry boolean
(Optional) Enables managed schema registry on cluster. Can be either true or false.
unmanagedTopics boolean
(Optional) Allows to use Kafka AdminAPI to manage topics. Can be either true or false.
kafka GetMdbKafkaClusterConfigKafka
(Optional) Configuration of the Kafka subcluster. The structure is documented below.
version str
(Required) Version of the Kafka server software.
zones Sequence[str]
(Optional) List of availability zones.
zookeeper GetMdbKafkaClusterConfigZookeeper
(Optional) Configuration of the ZooKeeper subcluster. The structure is documented below.
assign_public_ip bool
The flag that defines whether a public IP address is assigned to the node.
brokers_count int
(Optional) Count of brokers per availability zone.
schema_registry bool
(Optional) Enables managed schema registry on cluster. Can be either true or false.
unmanaged_topics bool
(Optional) Allows to use Kafka AdminAPI to manage topics. Can be either true or false.

GetMdbKafkaClusterConfigKafka

Resources GetMdbKafkaClusterConfigKafkaResources
(Optional) Resources allocated to hosts of the ZooKeeper subcluster. The structure is documented below.
KafkaConfig GetMdbKafkaClusterConfigKafkaKafkaConfig
(Optional) User-defined settings for the Kafka cluster. The structure is documented below.
Resources GetMdbKafkaClusterConfigKafkaResources
(Optional) Resources allocated to hosts of the ZooKeeper subcluster. The structure is documented below.
KafkaConfig GetMdbKafkaClusterConfigKafkaKafkaConfig
(Optional) User-defined settings for the Kafka cluster. The structure is documented below.
resources GetMdbKafkaClusterConfigKafkaResources
(Optional) Resources allocated to hosts of the ZooKeeper subcluster. The structure is documented below.
kafkaConfig GetMdbKafkaClusterConfigKafkaKafkaConfig
(Optional) User-defined settings for the Kafka cluster. The structure is documented below.
resources GetMdbKafkaClusterConfigKafkaResources
(Optional) Resources allocated to hosts of the ZooKeeper subcluster. The structure is documented below.
kafka_config GetMdbKafkaClusterConfigKafkaKafkaConfig
(Optional) User-defined settings for the Kafka cluster. The structure is documented below.

GetMdbKafkaClusterConfigKafkaKafkaConfig

GetMdbKafkaClusterConfigKafkaResources

DiskSize int
(Optional) Volume of the storage available to a ZooKeeper host, in gigabytes.
DiskTypeId string
(Optional) Type of the storage of ZooKeeper hosts. For more information see the official documentation.
ResourcePresetId string
DiskSize int
(Optional) Volume of the storage available to a ZooKeeper host, in gigabytes.
DiskTypeId string
(Optional) Type of the storage of ZooKeeper hosts. For more information see the official documentation.
ResourcePresetId string
diskSize number
(Optional) Volume of the storage available to a ZooKeeper host, in gigabytes.
diskTypeId string
(Optional) Type of the storage of ZooKeeper hosts. For more information see the official documentation.
resourcePresetId string
disk_size int
(Optional) Volume of the storage available to a ZooKeeper host, in gigabytes.
disk_type_id str
(Optional) Type of the storage of ZooKeeper hosts. For more information see the official documentation.
resource_preset_id str

GetMdbKafkaClusterConfigZookeeper

Resources GetMdbKafkaClusterConfigZookeeperResources
(Optional) Resources allocated to hosts of the ZooKeeper subcluster. The structure is documented below.
Resources GetMdbKafkaClusterConfigZookeeperResources
(Optional) Resources allocated to hosts of the ZooKeeper subcluster. The structure is documented below.
resources GetMdbKafkaClusterConfigZookeeperResources
(Optional) Resources allocated to hosts of the ZooKeeper subcluster. The structure is documented below.
resources GetMdbKafkaClusterConfigZookeeperResources
(Optional) Resources allocated to hosts of the ZooKeeper subcluster. The structure is documented below.

GetMdbKafkaClusterConfigZookeeperResources

DiskSize int
(Optional) Volume of the storage available to a ZooKeeper host, in gigabytes.
DiskTypeId string
(Optional) Type of the storage of ZooKeeper hosts. For more information see the official documentation.
ResourcePresetId string
DiskSize int
(Optional) Volume of the storage available to a ZooKeeper host, in gigabytes.
DiskTypeId string
(Optional) Type of the storage of ZooKeeper hosts. For more information see the official documentation.
ResourcePresetId string
diskSize number
(Optional) Volume of the storage available to a ZooKeeper host, in gigabytes.
diskTypeId string
(Optional) Type of the storage of ZooKeeper hosts. For more information see the official documentation.
resourcePresetId string
disk_size int
(Optional) Volume of the storage available to a ZooKeeper host, in gigabytes.
disk_type_id str
(Optional) Type of the storage of ZooKeeper hosts. For more information see the official documentation.
resource_preset_id str

GetMdbKafkaClusterHost

AssignPublicIp bool
The flag that defines whether a public IP address is assigned to the node.
Health string
Health of the host.
Name string
The name of the Kafka cluster.
Role string
Role of the host in the cluster.
SubnetId string
The ID of the subnet, to which the host belongs.
ZoneId string
The availability zone where the Kafka host was created.
AssignPublicIp bool
The flag that defines whether a public IP address is assigned to the node.
Health string
Health of the host.
Name string
The name of the Kafka cluster.
Role string
Role of the host in the cluster.
SubnetId string
The ID of the subnet, to which the host belongs.
ZoneId string
The availability zone where the Kafka host was created.
assignPublicIp boolean
The flag that defines whether a public IP address is assigned to the node.
health string
Health of the host.
name string
The name of the Kafka cluster.
role string
Role of the host in the cluster.
subnetId string
The ID of the subnet, to which the host belongs.
zoneId string
The availability zone where the Kafka host was created.
assign_public_ip bool
The flag that defines whether a public IP address is assigned to the node.
health str
Health of the host.
name str
The name of the Kafka cluster.
role str
Role of the host in the cluster.
subnet_id str
The ID of the subnet, to which the host belongs.
zone_id str
The availability zone where the Kafka host was created.

GetMdbKafkaClusterTopic

ClusterId string
The ID of the Kafka cluster.
Name string
The name of the Kafka cluster.
Partitions int
(Required) The number of the topic’s partitions.
ReplicationFactor int
(Required) Amount of data copies (replicas) for the topic in the cluster.
TopicConfig GetMdbKafkaClusterTopicTopicConfig
(Required) User-defined settings for the topic. The structure is documented below.
ClusterId string
The ID of the Kafka cluster.
Name string
The name of the Kafka cluster.
Partitions int
(Required) The number of the topic’s partitions.
ReplicationFactor int
(Required) Amount of data copies (replicas) for the topic in the cluster.
TopicConfig GetMdbKafkaClusterTopicTopicConfig
(Required) User-defined settings for the topic. The structure is documented below.
clusterId string
The ID of the Kafka cluster.
name string
The name of the Kafka cluster.
partitions number
(Required) The number of the topic’s partitions.
replicationFactor number
(Required) Amount of data copies (replicas) for the topic in the cluster.
topicConfig GetMdbKafkaClusterTopicTopicConfig
(Required) User-defined settings for the topic. The structure is documented below.
cluster_id str
The ID of the Kafka cluster.
name str
The name of the Kafka cluster.
partitions int
(Required) The number of the topic’s partitions.
replication_factor int
(Required) Amount of data copies (replicas) for the topic in the cluster.
topic_config GetMdbKafkaClusterTopicTopicConfig
(Required) User-defined settings for the topic. The structure is documented below.

GetMdbKafkaClusterTopicTopicConfig

GetMdbKafkaClusterUser

Name string
The name of the Kafka cluster.
Password string
(Required) The password of the user.
Permissions List<GetMdbKafkaClusterUserPermission>
(Optional) Set of permissions granted to the user. The structure is documented below.
Name string
The name of the Kafka cluster.
Password string
(Required) The password of the user.
Permissions []GetMdbKafkaClusterUserPermission
(Optional) Set of permissions granted to the user. The structure is documented below.
name string
The name of the Kafka cluster.
password string
(Required) The password of the user.
permissions GetMdbKafkaClusterUserPermission[]
(Optional) Set of permissions granted to the user. The structure is documented below.
name str
The name of the Kafka cluster.
password str
(Required) The password of the user.
permissions Sequence[GetMdbKafkaClusterUserPermission]
(Optional) Set of permissions granted to the user. The structure is documented below.

GetMdbKafkaClusterUserPermission

Role string
Role of the host in the cluster.
TopicName string
(Required) The name of the topic that the permission grants access to.
Role string
Role of the host in the cluster.
TopicName string
(Required) The name of the topic that the permission grants access to.
role string
Role of the host in the cluster.
topicName string
(Required) The name of the topic that the permission grants access to.
role str
Role of the host in the cluster.
topic_name str
(Required) The name of the topic that the permission grants access to.

Package Details

Repository
https://github.com/pulumi/pulumi-yandex
License
Apache-2.0
Notes
This Pulumi package is based on the yandex Terraform Provider.