com.pulumi.azure.eventhub.kotlin.ConsumerGroupArgs.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-azure-kotlin Show documentation
Show all versions of pulumi-azure-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.azure.eventhub.kotlin
import com.pulumi.azure.eventhub.ConsumerGroupArgs.builder
import com.pulumi.core.Output
import com.pulumi.core.Output.of
import com.pulumi.kotlin.ConvertibleToJava
import com.pulumi.kotlin.PulumiTagMarker
import kotlin.String
import kotlin.Suppress
import kotlin.jvm.JvmName
/**
* Manages a Event Hubs Consumer Group as a nested resource within an Event Hub.
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as azure from "@pulumi/azure";
* const example = new azure.core.ResourceGroup("example", {
* name: "example-resources",
* location: "West Europe",
* });
* const exampleEventHubNamespace = new azure.eventhub.EventHubNamespace("example", {
* name: "acceptanceTestEventHubNamespace",
* location: example.location,
* resourceGroupName: example.name,
* sku: "Basic",
* capacity: 2,
* tags: {
* environment: "Production",
* },
* });
* const exampleEventHub = new azure.eventhub.EventHub("example", {
* name: "acceptanceTestEventHub",
* namespaceName: exampleEventHubNamespace.name,
* resourceGroupName: example.name,
* partitionCount: 2,
* messageRetention: 2,
* });
* const exampleConsumerGroup = new azure.eventhub.ConsumerGroup("example", {
* name: "acceptanceTestEventHubConsumerGroup",
* namespaceName: exampleEventHubNamespace.name,
* eventhubName: exampleEventHub.name,
* resourceGroupName: example.name,
* userMetadata: "some-meta-data",
* });
* ```
* ```python
* import pulumi
* import pulumi_azure as azure
* example = azure.core.ResourceGroup("example",
* name="example-resources",
* location="West Europe")
* example_event_hub_namespace = azure.eventhub.EventHubNamespace("example",
* name="acceptanceTestEventHubNamespace",
* location=example.location,
* resource_group_name=example.name,
* sku="Basic",
* capacity=2,
* tags={
* "environment": "Production",
* })
* example_event_hub = azure.eventhub.EventHub("example",
* name="acceptanceTestEventHub",
* namespace_name=example_event_hub_namespace.name,
* resource_group_name=example.name,
* partition_count=2,
* message_retention=2)
* example_consumer_group = azure.eventhub.ConsumerGroup("example",
* name="acceptanceTestEventHubConsumerGroup",
* namespace_name=example_event_hub_namespace.name,
* eventhub_name=example_event_hub.name,
* resource_group_name=example.name,
* user_metadata="some-meta-data")
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using Azure = Pulumi.Azure;
* return await Deployment.RunAsync(() =>
* {
* var example = new Azure.Core.ResourceGroup("example", new()
* {
* Name = "example-resources",
* Location = "West Europe",
* });
* var exampleEventHubNamespace = new Azure.EventHub.EventHubNamespace("example", new()
* {
* Name = "acceptanceTestEventHubNamespace",
* Location = example.Location,
* ResourceGroupName = example.Name,
* Sku = "Basic",
* Capacity = 2,
* Tags =
* {
* { "environment", "Production" },
* },
* });
* var exampleEventHub = new Azure.EventHub.EventHub("example", new()
* {
* Name = "acceptanceTestEventHub",
* NamespaceName = exampleEventHubNamespace.Name,
* ResourceGroupName = example.Name,
* PartitionCount = 2,
* MessageRetention = 2,
* });
* var exampleConsumerGroup = new Azure.EventHub.ConsumerGroup("example", new()
* {
* Name = "acceptanceTestEventHubConsumerGroup",
* NamespaceName = exampleEventHubNamespace.Name,
* EventhubName = exampleEventHub.Name,
* ResourceGroupName = example.Name,
* UserMetadata = "some-meta-data",
* });
* });
* ```
* ```go
* package main
* import (
* "github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
* "github.com/pulumi/pulumi-azure/sdk/v5/go/azure/eventhub"
* "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
* )
* func main() {
* pulumi.Run(func(ctx *pulumi.Context) error {
* example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
* Name: pulumi.String("example-resources"),
* Location: pulumi.String("West Europe"),
* })
* if err != nil {
* return err
* }
* exampleEventHubNamespace, err := eventhub.NewEventHubNamespace(ctx, "example", &eventhub.EventHubNamespaceArgs{
* Name: pulumi.String("acceptanceTestEventHubNamespace"),
* Location: example.Location,
* ResourceGroupName: example.Name,
* Sku: pulumi.String("Basic"),
* Capacity: pulumi.Int(2),
* Tags: pulumi.StringMap{
* "environment": pulumi.String("Production"),
* },
* })
* if err != nil {
* return err
* }
* exampleEventHub, err := eventhub.NewEventHub(ctx, "example", &eventhub.EventHubArgs{
* Name: pulumi.String("acceptanceTestEventHub"),
* NamespaceName: exampleEventHubNamespace.Name,
* ResourceGroupName: example.Name,
* PartitionCount: pulumi.Int(2),
* MessageRetention: pulumi.Int(2),
* })
* if err != nil {
* return err
* }
* _, err = eventhub.NewConsumerGroup(ctx, "example", &eventhub.ConsumerGroupArgs{
* Name: pulumi.String("acceptanceTestEventHubConsumerGroup"),
* NamespaceName: exampleEventHubNamespace.Name,
* EventhubName: exampleEventHub.Name,
* ResourceGroupName: example.Name,
* UserMetadata: pulumi.String("some-meta-data"),
* })
* 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.azure.core.ResourceGroup;
* import com.pulumi.azure.core.ResourceGroupArgs;
* import com.pulumi.azure.eventhub.EventHubNamespace;
* import com.pulumi.azure.eventhub.EventHubNamespaceArgs;
* import com.pulumi.azure.eventhub.EventHub;
* import com.pulumi.azure.eventhub.EventHubArgs;
* import com.pulumi.azure.eventhub.ConsumerGroup;
* import com.pulumi.azure.eventhub.ConsumerGroupArgs;
* 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) {
* var example = new ResourceGroup("example", ResourceGroupArgs.builder()
* .name("example-resources")
* .location("West Europe")
* .build());
* var exampleEventHubNamespace = new EventHubNamespace("exampleEventHubNamespace", EventHubNamespaceArgs.builder()
* .name("acceptanceTestEventHubNamespace")
* .location(example.location())
* .resourceGroupName(example.name())
* .sku("Basic")
* .capacity(2)
* .tags(Map.of("environment", "Production"))
* .build());
* var exampleEventHub = new EventHub("exampleEventHub", EventHubArgs.builder()
* .name("acceptanceTestEventHub")
* .namespaceName(exampleEventHubNamespace.name())
* .resourceGroupName(example.name())
* .partitionCount(2)
* .messageRetention(2)
* .build());
* var exampleConsumerGroup = new ConsumerGroup("exampleConsumerGroup", ConsumerGroupArgs.builder()
* .name("acceptanceTestEventHubConsumerGroup")
* .namespaceName(exampleEventHubNamespace.name())
* .eventhubName(exampleEventHub.name())
* .resourceGroupName(example.name())
* .userMetadata("some-meta-data")
* .build());
* }
* }
* ```
* ```yaml
* resources:
* example:
* type: azure:core:ResourceGroup
* properties:
* name: example-resources
* location: West Europe
* exampleEventHubNamespace:
* type: azure:eventhub:EventHubNamespace
* name: example
* properties:
* name: acceptanceTestEventHubNamespace
* location: ${example.location}
* resourceGroupName: ${example.name}
* sku: Basic
* capacity: 2
* tags:
* environment: Production
* exampleEventHub:
* type: azure:eventhub:EventHub
* name: example
* properties:
* name: acceptanceTestEventHub
* namespaceName: ${exampleEventHubNamespace.name}
* resourceGroupName: ${example.name}
* partitionCount: 2
* messageRetention: 2
* exampleConsumerGroup:
* type: azure:eventhub:ConsumerGroup
* name: example
* properties:
* name: acceptanceTestEventHubConsumerGroup
* namespaceName: ${exampleEventHubNamespace.name}
* eventhubName: ${exampleEventHub.name}
* resourceGroupName: ${example.name}
* userMetadata: some-meta-data
* ```
*
* ## Import
* EventHub Consumer Groups can be imported using the `resource id`, e.g.
* ```sh
* $ pulumi import azure:eventhub/consumerGroup:ConsumerGroup consumerGroup1 /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.EventHub/namespaces/namespace1/eventhubs/eventhub1/consumerGroups/consumerGroup1
* ```
* @property eventhubName Specifies the name of the EventHub. Changing this forces a new resource to be created.
* @property name Specifies the name of the EventHub Consumer Group resource. Changing this forces a new resource to be created.
* @property namespaceName Specifies the name of the grandparent EventHub Namespace. Changing this forces a new resource to be created.
* @property resourceGroupName The name of the resource group in which the EventHub Consumer Group's grandparent Namespace exists. Changing this forces a new resource to be created.
* @property userMetadata Specifies the user metadata.
*/
public data class ConsumerGroupArgs(
public val eventhubName: Output? = null,
public val name: Output? = null,
public val namespaceName: Output? = null,
public val resourceGroupName: Output? = null,
public val userMetadata: Output? = null,
) : ConvertibleToJava {
override fun toJava(): com.pulumi.azure.eventhub.ConsumerGroupArgs =
com.pulumi.azure.eventhub.ConsumerGroupArgs.builder()
.eventhubName(eventhubName?.applyValue({ args0 -> args0 }))
.name(name?.applyValue({ args0 -> args0 }))
.namespaceName(namespaceName?.applyValue({ args0 -> args0 }))
.resourceGroupName(resourceGroupName?.applyValue({ args0 -> args0 }))
.userMetadata(userMetadata?.applyValue({ args0 -> args0 })).build()
}
/**
* Builder for [ConsumerGroupArgs].
*/
@PulumiTagMarker
public class ConsumerGroupArgsBuilder internal constructor() {
private var eventhubName: Output? = null
private var name: Output? = null
private var namespaceName: Output? = null
private var resourceGroupName: Output? = null
private var userMetadata: Output? = null
/**
* @param value Specifies the name of the EventHub. Changing this forces a new resource to be created.
*/
@JvmName("nleddsqugnbuqkop")
public suspend fun eventhubName(`value`: Output) {
this.eventhubName = value
}
/**
* @param value Specifies the name of the EventHub Consumer Group resource. Changing this forces a new resource to be created.
*/
@JvmName("klwkwgtsraxjudpq")
public suspend fun name(`value`: Output) {
this.name = value
}
/**
* @param value Specifies the name of the grandparent EventHub Namespace. Changing this forces a new resource to be created.
*/
@JvmName("oicaatxnhkghstic")
public suspend fun namespaceName(`value`: Output) {
this.namespaceName = value
}
/**
* @param value The name of the resource group in which the EventHub Consumer Group's grandparent Namespace exists. Changing this forces a new resource to be created.
*/
@JvmName("unymwhgjhogqawpa")
public suspend fun resourceGroupName(`value`: Output) {
this.resourceGroupName = value
}
/**
* @param value Specifies the user metadata.
*/
@JvmName("ioxthxcimwfsxsno")
public suspend fun userMetadata(`value`: Output) {
this.userMetadata = value
}
/**
* @param value Specifies the name of the EventHub. Changing this forces a new resource to be created.
*/
@JvmName("wggalmdwmlojcluk")
public suspend fun eventhubName(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.eventhubName = mapped
}
/**
* @param value Specifies the name of the EventHub Consumer Group resource. Changing this forces a new resource to be created.
*/
@JvmName("spqbhcehhrwottea")
public suspend fun name(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.name = mapped
}
/**
* @param value Specifies the name of the grandparent EventHub Namespace. Changing this forces a new resource to be created.
*/
@JvmName("skqmccnslagbcmvt")
public suspend fun namespaceName(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.namespaceName = mapped
}
/**
* @param value The name of the resource group in which the EventHub Consumer Group's grandparent Namespace exists. Changing this forces a new resource to be created.
*/
@JvmName("nrnmifspvjwulrex")
public suspend fun resourceGroupName(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.resourceGroupName = mapped
}
/**
* @param value Specifies the user metadata.
*/
@JvmName("rivjsahxouhhknwi")
public suspend fun userMetadata(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.userMetadata = mapped
}
internal fun build(): ConsumerGroupArgs = ConsumerGroupArgs(
eventhubName = eventhubName,
name = name,
namespaceName = namespaceName,
resourceGroupName = resourceGroupName,
userMetadata = userMetadata,
)
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy