com.pulumi.gcp.managedkafka.kotlin.Topic.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-gcp-kotlin Show documentation
Show all versions of pulumi-gcp-kotlin Show documentation
Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.gcp.managedkafka.kotlin
import com.pulumi.core.Output
import com.pulumi.kotlin.KotlinCustomResource
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.ResourceMapper
import com.pulumi.kotlin.options.CustomResourceOptions
import com.pulumi.kotlin.options.CustomResourceOptionsBuilder
import com.pulumi.resources.Resource
import kotlin.Boolean
import kotlin.Int
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.collections.Map
/**
* Builder for [Topic].
*/
@PulumiTagMarker
public class TopicResourceBuilder internal constructor() {
public var name: String? = null
public var args: TopicArgs = TopicArgs()
public var opts: CustomResourceOptions = CustomResourceOptions()
/**
* @param name The _unique_ name of the resulting resource.
*/
public fun name(`value`: String) {
this.name = value
}
/**
* @param block The arguments to use to populate this resource's properties.
*/
public suspend fun args(block: suspend TopicArgsBuilder.() -> Unit) {
val builder = TopicArgsBuilder()
block(builder)
this.args = builder.build()
}
/**
* @param block A bag of options that control this resource's behavior.
*/
public suspend fun opts(block: suspend CustomResourceOptionsBuilder.() -> Unit) {
this.opts = com.pulumi.kotlin.options.CustomResourceOptions.opts(block)
}
internal fun build(): Topic {
val builtJavaResource = com.pulumi.gcp.managedkafka.Topic(
this.name,
this.args.toJava(),
this.opts.toJava(),
)
return Topic(builtJavaResource)
}
}
/**
* A Managed Service for Apache Kafka topic. Apache Kafka is a trademark owned by the Apache Software Foundation.
* ## Example Usage
* ### Managedkafka Topic Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
* const project = gcp.organizations.getProject({});
* const cluster = new gcp.managedkafka.Cluster("cluster", {
* clusterId: "my-cluster",
* location: "us-central1",
* capacityConfig: {
* vcpuCount: "3",
* memoryBytes: "3221225472",
* },
* gcpConfig: {
* accessConfig: {
* networkConfigs: [{
* subnet: project.then(project => `projects/${project.number}/regions/us-central1/subnetworks/default`),
* }],
* },
* },
* });
* const example = new gcp.managedkafka.Topic("example", {
* topicId: "my-topic",
* cluster: cluster.clusterId,
* location: "us-central1",
* partitionCount: 2,
* replicationFactor: 3,
* configs: {
* "cleanup.policy": "compact",
* },
* });
* ```
* ```python
* import pulumi
* import pulumi_gcp as gcp
* project = gcp.organizations.get_project()
* cluster = gcp.managedkafka.Cluster("cluster",
* cluster_id="my-cluster",
* location="us-central1",
* capacity_config={
* "vcpu_count": "3",
* "memory_bytes": "3221225472",
* },
* gcp_config={
* "access_config": {
* "network_configs": [{
* "subnet": f"projects/{project.number}/regions/us-central1/subnetworks/default",
* }],
* },
* })
* example = gcp.managedkafka.Topic("example",
* topic_id="my-topic",
* cluster=cluster.cluster_id,
* location="us-central1",
* partition_count=2,
* replication_factor=3,
* configs={
* "cleanup.policy": "compact",
* })
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using Gcp = Pulumi.Gcp;
* return await Deployment.RunAsync(() =>
* {
* var project = Gcp.Organizations.GetProject.Invoke();
* var cluster = new Gcp.ManagedKafka.Cluster("cluster", new()
* {
* ClusterId = "my-cluster",
* Location = "us-central1",
* CapacityConfig = new Gcp.ManagedKafka.Inputs.ClusterCapacityConfigArgs
* {
* VcpuCount = "3",
* MemoryBytes = "3221225472",
* },
* GcpConfig = new Gcp.ManagedKafka.Inputs.ClusterGcpConfigArgs
* {
* AccessConfig = new Gcp.ManagedKafka.Inputs.ClusterGcpConfigAccessConfigArgs
* {
* NetworkConfigs = new[]
* {
* new Gcp.ManagedKafka.Inputs.ClusterGcpConfigAccessConfigNetworkConfigArgs
* {
* Subnet = $"projects/{project.Apply(getProjectResult => getProjectResult.Number)}/regions/us-central1/subnetworks/default",
* },
* },
* },
* },
* });
* var example = new Gcp.ManagedKafka.Topic("example", new()
* {
* TopicId = "my-topic",
* Cluster = cluster.ClusterId,
* Location = "us-central1",
* PartitionCount = 2,
* ReplicationFactor = 3,
* Configs =
* {
* { "cleanup.policy", "compact" },
* },
* });
* });
* ```
* ```go
* package main
* import (
* "fmt"
* "github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/managedkafka"
* "github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/organizations"
* "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
* )
* func main() {
* pulumi.Run(func(ctx *pulumi.Context) error {
* project, err := organizations.LookupProject(ctx, &organizations.LookupProjectArgs{}, nil)
* if err != nil {
* return err
* }
* cluster, err := managedkafka.NewCluster(ctx, "cluster", &managedkafka.ClusterArgs{
* ClusterId: pulumi.String("my-cluster"),
* Location: pulumi.String("us-central1"),
* CapacityConfig: &managedkafka.ClusterCapacityConfigArgs{
* VcpuCount: pulumi.String("3"),
* MemoryBytes: pulumi.String("3221225472"),
* },
* GcpConfig: &managedkafka.ClusterGcpConfigArgs{
* AccessConfig: &managedkafka.ClusterGcpConfigAccessConfigArgs{
* NetworkConfigs: managedkafka.ClusterGcpConfigAccessConfigNetworkConfigArray{
* &managedkafka.ClusterGcpConfigAccessConfigNetworkConfigArgs{
* Subnet: pulumi.Sprintf("projects/%v/regions/us-central1/subnetworks/default", project.Number),
* },
* },
* },
* },
* })
* if err != nil {
* return err
* }
* _, err = managedkafka.NewTopic(ctx, "example", &managedkafka.TopicArgs{
* TopicId: pulumi.String("my-topic"),
* Cluster: cluster.ClusterId,
* Location: pulumi.String("us-central1"),
* PartitionCount: pulumi.Int(2),
* ReplicationFactor: pulumi.Int(3),
* Configs: pulumi.StringMap{
* "cleanup.policy": pulumi.String("compact"),
* },
* })
* if err != nil {
* return err
* }
* return nil
* })
* }
* ```
* ```java
* package generated_program;
* import com.pulumi.Context;
* import com.pulumi.Pulumi;
* import com.pulumi.core.Output;
* import com.pulumi.gcp.organizations.OrganizationsFunctions;
* import com.pulumi.gcp.organizations.inputs.GetProjectArgs;
* import com.pulumi.gcp.managedkafka.Cluster;
* import com.pulumi.gcp.managedkafka.ClusterArgs;
* import com.pulumi.gcp.managedkafka.inputs.ClusterCapacityConfigArgs;
* import com.pulumi.gcp.managedkafka.inputs.ClusterGcpConfigArgs;
* import com.pulumi.gcp.managedkafka.inputs.ClusterGcpConfigAccessConfigArgs;
* import com.pulumi.gcp.managedkafka.Topic;
* import com.pulumi.gcp.managedkafka.TopicArgs;
* import java.util.List;
* import java.util.ArrayList;
* import java.util.Map;
* import java.io.File;
* import java.nio.file.Files;
* import java.nio.file.Paths;
* public class App {
* public static void main(String[] args) {
* Pulumi.run(App::stack);
* }
* public static void stack(Context ctx) {
* final var project = OrganizationsFunctions.getProject();
* var cluster = new Cluster("cluster", ClusterArgs.builder()
* .clusterId("my-cluster")
* .location("us-central1")
* .capacityConfig(ClusterCapacityConfigArgs.builder()
* .vcpuCount(3)
* .memoryBytes(3221225472)
* .build())
* .gcpConfig(ClusterGcpConfigArgs.builder()
* .accessConfig(ClusterGcpConfigAccessConfigArgs.builder()
* .networkConfigs(ClusterGcpConfigAccessConfigNetworkConfigArgs.builder()
* .subnet(String.format("projects/%s/regions/us-central1/subnetworks/default", project.applyValue(getProjectResult -> getProjectResult.number())))
* .build())
* .build())
* .build())
* .build());
* var example = new Topic("example", TopicArgs.builder()
* .topicId("my-topic")
* .cluster(cluster.clusterId())
* .location("us-central1")
* .partitionCount(2)
* .replicationFactor(3)
* .configs(Map.of("cleanup.policy", "compact"))
* .build());
* }
* }
* ```
* ```yaml
* resources:
* cluster:
* type: gcp:managedkafka:Cluster
* properties:
* clusterId: my-cluster
* location: us-central1
* capacityConfig:
* vcpuCount: 3
* memoryBytes: 3.221225472e+09
* gcpConfig:
* accessConfig:
* networkConfigs:
* - subnet: projects/${project.number}/regions/us-central1/subnetworks/default
* example:
* type: gcp:managedkafka:Topic
* properties:
* topicId: my-topic
* cluster: ${cluster.clusterId}
* location: us-central1
* partitionCount: 2
* replicationFactor: 3
* configs:
* cleanup.policy: compact
* variables:
* project:
* fn::invoke:
* function: gcp:organizations:getProject
* arguments: {}
* ```
*
* ## Import
* Topic can be imported using any of these accepted formats:
* * `projects/{{project}}/locations/{{location}}/clusters/{{cluster}}/topics/{{topic_id}}`
* * `{{project}}/{{location}}/{{cluster}}/{{topic_id}}`
* * `{{location}}/{{cluster}}/{{topic_id}}`
* When using the `pulumi import` command, Topic can be imported using one of the formats above. For example:
* ```sh
* $ pulumi import gcp:managedkafka/topic:Topic default projects/{{project}}/locations/{{location}}/clusters/{{cluster}}/topics/{{topic_id}}
* ```
* ```sh
* $ pulumi import gcp:managedkafka/topic:Topic default {{project}}/{{location}}/{{cluster}}/{{topic_id}}
* ```
* ```sh
* $ pulumi import gcp:managedkafka/topic:Topic default {{location}}/{{cluster}}/{{topic_id}}
* ```
*/
public class Topic internal constructor(
override val javaResource: com.pulumi.gcp.managedkafka.Topic,
) : KotlinCustomResource(javaResource, TopicMapper) {
/**
* The cluster name.
*/
public val cluster: Output
get() = javaResource.cluster().applyValue({ args0 -> args0 })
/**
* Configuration for the topic that are overridden from the cluster defaults. The key of the map is a Kafka topic property name, for example: `cleanup.policy=compact`, `compression.type=producer`.
*/
public val configs: Output>?
get() = javaResource.configs().applyValue({ args0 ->
args0.map({ args0 ->
args0.map({ args0 ->
args0.key.to(args0.value)
}).toMap()
}).orElse(null)
})
/**
* ID of the location of the Kafka resource. See https://cloud.google.com/managed-kafka/docs/locations for a list of supported locations.
*/
public val location: Output
get() = javaResource.location().applyValue({ args0 -> args0 })
/**
* The name of the topic. The `topic` segment is used when connecting directly to the cluster. Must be in the format `projects/PROJECT_ID/locations/LOCATION/clusters/CLUSTER_ID/topics/TOPIC_ID`.
*/
public val name: Output
get() = javaResource.name().applyValue({ args0 -> args0 })
/**
* The number of partitions in a topic. You can increase the partition count for a topic, but you cannot decrease it. Increasing partitions for a topic that uses a key might change how messages are distributed.
*/
public val partitionCount: Output?
get() = javaResource.partitionCount().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
public val project: Output
get() = javaResource.project().applyValue({ args0 -> args0 })
/**
* The number of replicas of each partition. A replication factor of 3 is recommended for high availability.
*/
public val replicationFactor: Output
get() = javaResource.replicationFactor().applyValue({ args0 -> args0 })
/**
* The ID to use for the topic, which will become the final component of the topic's name. This value is structured like: `my-topic-name`.
* - - -
*/
public val topicId: Output
get() = javaResource.topicId().applyValue({ args0 -> args0 })
}
public object TopicMapper : ResourceMapper {
override fun supportsMappingOfType(javaResource: Resource): Boolean =
com.pulumi.gcp.managedkafka.Topic::class == javaResource::class
override fun map(javaResource: Resource): Topic = Topic(
javaResource as
com.pulumi.gcp.managedkafka.Topic,
)
}
/**
* @see [Topic].
* @param name The _unique_ name of the resulting resource.
* @param block Builder for [Topic].
*/
public suspend fun topic(name: String, block: suspend TopicResourceBuilder.() -> Unit): Topic {
val builder = TopicResourceBuilder()
builder.name(name)
block(builder)
return builder.build()
}
/**
* @see [Topic].
* @param name The _unique_ name of the resulting resource.
*/
public fun topic(name: String): Topic {
val builder = TopicResourceBuilder()
builder.name(name)
return builder.build()
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy