Docs
Packagesconfluentcloud.getKafkaTopic
Explore with Pulumi AI
Using getKafkaTopic
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 getKafkaTopic(args: GetKafkaTopicArgs, opts?: InvokeOptions): Promise<GetKafkaTopicResult>
function getKafkaTopicOutput(args: GetKafkaTopicOutputArgs, opts?: InvokeOptions): Output<GetKafkaTopicResult>def get_kafka_topic(credentials: Optional[GetKafkaTopicCredentials] = None,
kafka_cluster: Optional[GetKafkaTopicKafkaCluster] = None,
rest_endpoint: Optional[str] = None,
topic_name: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetKafkaTopicResult
def get_kafka_topic_output(credentials: Optional[pulumi.Input[GetKafkaTopicCredentialsArgs]] = None,
kafka_cluster: Optional[pulumi.Input[GetKafkaTopicKafkaClusterArgs]] = None,
rest_endpoint: Optional[pulumi.Input[str]] = None,
topic_name: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetKafkaTopicResult]func LookupKafkaTopic(ctx *Context, args *LookupKafkaTopicArgs, opts ...InvokeOption) (*LookupKafkaTopicResult, error)
func LookupKafkaTopicOutput(ctx *Context, args *LookupKafkaTopicOutputArgs, opts ...InvokeOption) LookupKafkaTopicResultOutput> Note: This function is named LookupKafkaTopic in the Go SDK.
public static class GetKafkaTopic
{
public static Task<GetKafkaTopicResult> InvokeAsync(GetKafkaTopicArgs args, InvokeOptions? opts = null)
public static Output<GetKafkaTopicResult> Invoke(GetKafkaTopicInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetKafkaTopicResult> getKafkaTopic(GetKafkaTopicArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: confluentcloud:index/getKafkaTopic:getKafkaTopic
arguments:
# arguments dictionaryThe following arguments are supported:
- Rest
Endpoint string The REST endpoint of the Kafka cluster, for example,
https://pkc-00000.us-central1.gcp.confluent.cloud:443).- Topic
Name string The name of the topic, for example,
orders-1. The topic name can be up to 255 characters in length and can contain only alphanumeric characters, hyphens, and underscores.- Credentials
Pulumi.
Confluent Cloud. Inputs. Get Kafka Topic Credentials - Kafka
Cluster Pulumi.Confluent Cloud. Inputs. Get Kafka Topic Kafka Cluster
- Rest
Endpoint string The REST endpoint of the Kafka cluster, for example,
https://pkc-00000.us-central1.gcp.confluent.cloud:443).- Topic
Name string The name of the topic, for example,
orders-1. The topic name can be up to 255 characters in length and can contain only alphanumeric characters, hyphens, and underscores.- Credentials
Get
Kafka Topic Credentials - Kafka
Cluster GetKafka Topic Kafka Cluster
- rest
Endpoint String The REST endpoint of the Kafka cluster, for example,
https://pkc-00000.us-central1.gcp.confluent.cloud:443).- topic
Name String The name of the topic, for example,
orders-1. The topic name can be up to 255 characters in length and can contain only alphanumeric characters, hyphens, and underscores.- credentials
Get
Kafka Topic Credentials - kafka
Cluster GetKafka Topic Kafka Cluster
- rest
Endpoint string The REST endpoint of the Kafka cluster, for example,
https://pkc-00000.us-central1.gcp.confluent.cloud:443).- topic
Name string The name of the topic, for example,
orders-1. The topic name can be up to 255 characters in length and can contain only alphanumeric characters, hyphens, and underscores.- credentials
Get
Kafka Topic Credentials - kafka
Cluster GetKafka Topic Kafka Cluster
- rest_
endpoint str The REST endpoint of the Kafka cluster, for example,
https://pkc-00000.us-central1.gcp.confluent.cloud:443).- topic_
name str The name of the topic, for example,
orders-1. The topic name can be up to 255 characters in length and can contain only alphanumeric characters, hyphens, and underscores.- credentials
Get
Kafka Topic Credentials - kafka_
cluster GetKafka Topic Kafka Cluster
- rest
Endpoint String The REST endpoint of the Kafka cluster, for example,
https://pkc-00000.us-central1.gcp.confluent.cloud:443).- topic
Name String The name of the topic, for example,
orders-1. The topic name can be up to 255 characters in length and can contain only alphanumeric characters, hyphens, and underscores.- credentials Property Map
- kafka
Cluster Property Map
getKafkaTopic Result
The following output properties are available:
- Config Dictionary<string, string>
(Optional Map) The custom topic settings:
- Id string
The provider-assigned unique ID for this managed resource.
- Partitions
Count int (Required Number) The number of partitions to create in the topic. Defaults to
6.- Rest
Endpoint string - Topic
Name string - Credentials
Pulumi.
Confluent Cloud. Outputs. Get Kafka Topic Credentials - Kafka
Cluster Pulumi.Confluent Cloud. Outputs. Get Kafka Topic Kafka Cluster
- Config map[string]string
(Optional Map) The custom topic settings:
- Id string
The provider-assigned unique ID for this managed resource.
- Partitions
Count int (Required Number) The number of partitions to create in the topic. Defaults to
6.- Rest
Endpoint string - Topic
Name string - Credentials
Get
Kafka Topic Credentials - Kafka
Cluster GetKafka Topic Kafka Cluster
- config Map<String,String>
(Optional Map) The custom topic settings:
- id String
The provider-assigned unique ID for this managed resource.
- partitions
Count Integer (Required Number) The number of partitions to create in the topic. Defaults to
6.- rest
Endpoint String - topic
Name String - credentials
Get
Kafka Topic Credentials - kafka
Cluster GetKafka Topic Kafka Cluster
- config {[key: string]: string}
(Optional Map) The custom topic settings:
- id string
The provider-assigned unique ID for this managed resource.
- partitions
Count number (Required Number) The number of partitions to create in the topic. Defaults to
6.- rest
Endpoint string - topic
Name string - credentials
Get
Kafka Topic Credentials - kafka
Cluster GetKafka Topic Kafka Cluster
- config Mapping[str, str]
(Optional Map) The custom topic settings:
- id str
The provider-assigned unique ID for this managed resource.
- partitions_
count int (Required Number) The number of partitions to create in the topic. Defaults to
6.- rest_
endpoint str - topic_
name str - credentials
Get
Kafka Topic Credentials - kafka_
cluster GetKafka Topic Kafka Cluster
- config Map<String>
(Optional Map) The custom topic settings:
- id String
The provider-assigned unique ID for this managed resource.
- partitions
Count Number (Required Number) The number of partitions to create in the topic. Defaults to
6.- rest
Endpoint String - topic
Name String - credentials Property Map
- kafka
Cluster Property Map
Supporting Types
GetKafkaTopicCredentials
GetKafkaTopicKafkaCluster
- Id string
The ID of the Kafka cluster, for example,
lkc-abc123.
- Id string
The ID of the Kafka cluster, for example,
lkc-abc123.
- id String
The ID of the Kafka cluster, for example,
lkc-abc123.
- id string
The ID of the Kafka cluster, for example,
lkc-abc123.
- id str
The ID of the Kafka cluster, for example,
lkc-abc123.
- id String
The ID of the Kafka cluster, for example,
lkc-abc123.
Package Details
- Repository
- Confluent Cloud pulumi/pulumi-confluentcloud
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
confluentTerraform Provider.