1. Packages
  2. Volcengine
  3. API Docs
  4. kafka
  5. Groups
Volcengine v0.0.24 published on Tuesday, Jun 25, 2024 by Volcengine

volcengine.kafka.Groups

Explore with Pulumi AI

volcengine logo
Volcengine v0.0.24 published on Tuesday, Jun 25, 2024 by Volcengine

    Use this data source to query detailed information of kafka groups

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Volcengine = Pulumi.Volcengine;
    
    return await Deployment.RunAsync(() => 
    {
        var fooZones = Volcengine.Ecs.Zones.Invoke();
    
        var fooVpc = new Volcengine.Vpc.Vpc("fooVpc", new()
        {
            VpcName = "acc-test-vpc",
            CidrBlock = "172.16.0.0/16",
        });
    
        var fooSubnet = new Volcengine.Vpc.Subnet("fooSubnet", new()
        {
            SubnetName = "acc-test-subnet",
            CidrBlock = "172.16.0.0/24",
            ZoneId = fooZones.Apply(zonesResult => zonesResult.Zones[0]?.Id),
            VpcId = fooVpc.Id,
        });
    
        var fooInstance = new Volcengine.Kafka.Instance("fooInstance", new()
        {
            InstanceName = "acc-test-kafka",
            InstanceDescription = "tf-test",
            Version = "2.2.2",
            ComputeSpec = "kafka.20xrate.hw",
            SubnetId = fooSubnet.Id,
            UserName = "tf-user",
            UserPassword = "tf-pass!@q1",
            ChargeType = "PostPaid",
            StorageSpace = 300,
            PartitionNumber = 350,
            ProjectName = "default",
            Tags = new[]
            {
                new Volcengine.Kafka.Inputs.InstanceTagArgs
                {
                    Key = "k1",
                    Value = "v1",
                },
            },
            Parameters = new[]
            {
                new Volcengine.Kafka.Inputs.InstanceParameterArgs
                {
                    ParameterName = "MessageMaxByte",
                    ParameterValue = "12",
                },
                new Volcengine.Kafka.Inputs.InstanceParameterArgs
                {
                    ParameterName = "LogRetentionHours",
                    ParameterValue = "70",
                },
            },
        });
    
        var fooGroup = new Volcengine.Kafka.Group("fooGroup", new()
        {
            InstanceId = fooInstance.Id,
            GroupId = "acc-test-group",
            Description = "tf-test",
        });
    
        var @default = Volcengine.Kafka.Groups.Invoke(new()
        {
            InstanceId = fooGroup.InstanceId,
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/ecs"
    	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/kafka"
    	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/vpc"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		fooZones, err := ecs.Zones(ctx, nil, nil)
    		if err != nil {
    			return err
    		}
    		fooVpc, err := vpc.NewVpc(ctx, "fooVpc", &vpc.VpcArgs{
    			VpcName:   pulumi.String("acc-test-vpc"),
    			CidrBlock: pulumi.String("172.16.0.0/16"),
    		})
    		if err != nil {
    			return err
    		}
    		fooSubnet, err := vpc.NewSubnet(ctx, "fooSubnet", &vpc.SubnetArgs{
    			SubnetName: pulumi.String("acc-test-subnet"),
    			CidrBlock:  pulumi.String("172.16.0.0/24"),
    			ZoneId:     *pulumi.String(fooZones.Zones[0].Id),
    			VpcId:      fooVpc.ID(),
    		})
    		if err != nil {
    			return err
    		}
    		fooInstance, err := kafka.NewInstance(ctx, "fooInstance", &kafka.InstanceArgs{
    			InstanceName:        pulumi.String("acc-test-kafka"),
    			InstanceDescription: pulumi.String("tf-test"),
    			Version:             pulumi.String("2.2.2"),
    			ComputeSpec:         pulumi.String("kafka.20xrate.hw"),
    			SubnetId:            fooSubnet.ID(),
    			UserName:            pulumi.String("tf-user"),
    			UserPassword:        pulumi.String("tf-pass!@q1"),
    			ChargeType:          pulumi.String("PostPaid"),
    			StorageSpace:        pulumi.Int(300),
    			PartitionNumber:     pulumi.Int(350),
    			ProjectName:         pulumi.String("default"),
    			Tags: kafka.InstanceTagArray{
    				&kafka.InstanceTagArgs{
    					Key:   pulumi.String("k1"),
    					Value: pulumi.String("v1"),
    				},
    			},
    			Parameters: kafka.InstanceParameterArray{
    				&kafka.InstanceParameterArgs{
    					ParameterName:  pulumi.String("MessageMaxByte"),
    					ParameterValue: pulumi.String("12"),
    				},
    				&kafka.InstanceParameterArgs{
    					ParameterName:  pulumi.String("LogRetentionHours"),
    					ParameterValue: pulumi.String("70"),
    				},
    			},
    		})
    		if err != nil {
    			return err
    		}
    		fooGroup, err := kafka.NewGroup(ctx, "fooGroup", &kafka.GroupArgs{
    			InstanceId:  fooInstance.ID(),
    			GroupId:     pulumi.String("acc-test-group"),
    			Description: pulumi.String("tf-test"),
    		})
    		if err != nil {
    			return err
    		}
    		_ = kafka.GroupsOutput(ctx, kafka.GroupsOutputArgs{
    			InstanceId: fooGroup.InstanceId,
    		}, nil)
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.volcengine.ecs.EcsFunctions;
    import com.pulumi.volcengine.ecs.inputs.ZonesArgs;
    import com.pulumi.volcengine.vpc.Vpc;
    import com.pulumi.volcengine.vpc.VpcArgs;
    import com.pulumi.volcengine.vpc.Subnet;
    import com.pulumi.volcengine.vpc.SubnetArgs;
    import com.pulumi.volcengine.kafka.Instance;
    import com.pulumi.volcengine.kafka.InstanceArgs;
    import com.pulumi.volcengine.kafka.inputs.InstanceTagArgs;
    import com.pulumi.volcengine.kafka.inputs.InstanceParameterArgs;
    import com.pulumi.volcengine.kafka.Group;
    import com.pulumi.volcengine.kafka.GroupArgs;
    import com.pulumi.volcengine.kafka.KafkaFunctions;
    import com.pulumi.volcengine.kafka.inputs.GroupsArgs;
    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 fooZones = EcsFunctions.Zones();
    
            var fooVpc = new Vpc("fooVpc", VpcArgs.builder()        
                .vpcName("acc-test-vpc")
                .cidrBlock("172.16.0.0/16")
                .build());
    
            var fooSubnet = new Subnet("fooSubnet", SubnetArgs.builder()        
                .subnetName("acc-test-subnet")
                .cidrBlock("172.16.0.0/24")
                .zoneId(fooZones.applyValue(zonesResult -> zonesResult.zones()[0].id()))
                .vpcId(fooVpc.id())
                .build());
    
            var fooInstance = new Instance("fooInstance", InstanceArgs.builder()        
                .instanceName("acc-test-kafka")
                .instanceDescription("tf-test")
                .version("2.2.2")
                .computeSpec("kafka.20xrate.hw")
                .subnetId(fooSubnet.id())
                .userName("tf-user")
                .userPassword("tf-pass!@q1")
                .chargeType("PostPaid")
                .storageSpace(300)
                .partitionNumber(350)
                .projectName("default")
                .tags(InstanceTagArgs.builder()
                    .key("k1")
                    .value("v1")
                    .build())
                .parameters(            
                    InstanceParameterArgs.builder()
                        .parameterName("MessageMaxByte")
                        .parameterValue("12")
                        .build(),
                    InstanceParameterArgs.builder()
                        .parameterName("LogRetentionHours")
                        .parameterValue("70")
                        .build())
                .build());
    
            var fooGroup = new Group("fooGroup", GroupArgs.builder()        
                .instanceId(fooInstance.id())
                .groupId("acc-test-group")
                .description("tf-test")
                .build());
    
            final var default = KafkaFunctions.Groups(GroupsArgs.builder()
                .instanceId(fooGroup.instanceId())
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_volcengine as volcengine
    
    foo_zones = volcengine.ecs.zones()
    foo_vpc = volcengine.vpc.Vpc("fooVpc",
        vpc_name="acc-test-vpc",
        cidr_block="172.16.0.0/16")
    foo_subnet = volcengine.vpc.Subnet("fooSubnet",
        subnet_name="acc-test-subnet",
        cidr_block="172.16.0.0/24",
        zone_id=foo_zones.zones[0].id,
        vpc_id=foo_vpc.id)
    foo_instance = volcengine.kafka.Instance("fooInstance",
        instance_name="acc-test-kafka",
        instance_description="tf-test",
        version="2.2.2",
        compute_spec="kafka.20xrate.hw",
        subnet_id=foo_subnet.id,
        user_name="tf-user",
        user_password="tf-pass!@q1",
        charge_type="PostPaid",
        storage_space=300,
        partition_number=350,
        project_name="default",
        tags=[volcengine.kafka.InstanceTagArgs(
            key="k1",
            value="v1",
        )],
        parameters=[
            volcengine.kafka.InstanceParameterArgs(
                parameter_name="MessageMaxByte",
                parameter_value="12",
            ),
            volcengine.kafka.InstanceParameterArgs(
                parameter_name="LogRetentionHours",
                parameter_value="70",
            ),
        ])
    foo_group = volcengine.kafka.Group("fooGroup",
        instance_id=foo_instance.id,
        group_id="acc-test-group",
        description="tf-test")
    default = volcengine.kafka.groups_output(instance_id=foo_group.instance_id)
    
    import * as pulumi from "@pulumi/pulumi";
    import * as volcengine from "@pulumi/volcengine";
    import * as volcengine from "@volcengine/pulumi";
    
    const fooZones = volcengine.ecs.Zones({});
    const fooVpc = new volcengine.vpc.Vpc("fooVpc", {
        vpcName: "acc-test-vpc",
        cidrBlock: "172.16.0.0/16",
    });
    const fooSubnet = new volcengine.vpc.Subnet("fooSubnet", {
        subnetName: "acc-test-subnet",
        cidrBlock: "172.16.0.0/24",
        zoneId: fooZones.then(fooZones => fooZones.zones?.[0]?.id),
        vpcId: fooVpc.id,
    });
    const fooInstance = new volcengine.kafka.Instance("fooInstance", {
        instanceName: "acc-test-kafka",
        instanceDescription: "tf-test",
        version: "2.2.2",
        computeSpec: "kafka.20xrate.hw",
        subnetId: fooSubnet.id,
        userName: "tf-user",
        userPassword: "tf-pass!@q1",
        chargeType: "PostPaid",
        storageSpace: 300,
        partitionNumber: 350,
        projectName: "default",
        tags: [{
            key: "k1",
            value: "v1",
        }],
        parameters: [
            {
                parameterName: "MessageMaxByte",
                parameterValue: "12",
            },
            {
                parameterName: "LogRetentionHours",
                parameterValue: "70",
            },
        ],
    });
    const fooGroup = new volcengine.kafka.Group("fooGroup", {
        instanceId: fooInstance.id,
        groupId: "acc-test-group",
        description: "tf-test",
    });
    const default = volcengine.kafka.GroupsOutput({
        instanceId: fooGroup.instanceId,
    });
    
    resources:
      fooVpc:
        type: volcengine:vpc:Vpc
        properties:
          vpcName: acc-test-vpc
          cidrBlock: 172.16.0.0/16
      fooSubnet:
        type: volcengine:vpc:Subnet
        properties:
          subnetName: acc-test-subnet
          cidrBlock: 172.16.0.0/24
          zoneId: ${fooZones.zones[0].id}
          vpcId: ${fooVpc.id}
      fooInstance:
        type: volcengine:kafka:Instance
        properties:
          instanceName: acc-test-kafka
          instanceDescription: tf-test
          version: 2.2.2
          computeSpec: kafka.20xrate.hw
          subnetId: ${fooSubnet.id}
          userName: tf-user
          userPassword: tf-pass!@q1
          chargeType: PostPaid
          storageSpace: 300
          partitionNumber: 350
          projectName: default
          tags:
            - key: k1
              value: v1
          parameters:
            - parameterName: MessageMaxByte
              parameterValue: '12'
            - parameterName: LogRetentionHours
              parameterValue: '70'
      fooGroup:
        type: volcengine:kafka:Group
        properties:
          instanceId: ${fooInstance.id}
          groupId: acc-test-group
          description: tf-test
    variables:
      fooZones:
        fn::invoke:
          Function: volcengine:ecs:Zones
          Arguments: {}
      default:
        fn::invoke:
          Function: volcengine:kafka:Groups
          Arguments:
            instanceId: ${fooGroup.instanceId}
    

    Using Groups

    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 groups(args: GroupsArgs, opts?: InvokeOptions): Promise<GroupsResult>
    function groupsOutput(args: GroupsOutputArgs, opts?: InvokeOptions): Output<GroupsResult>
    def groups(group_id: Optional[str] = None,
               instance_id: Optional[str] = None,
               name_regex: Optional[str] = None,
               output_file: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GroupsResult
    def groups_output(group_id: Optional[pulumi.Input[str]] = None,
               instance_id: Optional[pulumi.Input[str]] = None,
               name_regex: Optional[pulumi.Input[str]] = None,
               output_file: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GroupsResult]
    func Groups(ctx *Context, args *GroupsArgs, opts ...InvokeOption) (*GroupsResult, error)
    func GroupsOutput(ctx *Context, args *GroupsOutputArgs, opts ...InvokeOption) GroupsResultOutput
    public static class Groups 
    {
        public static Task<GroupsResult> InvokeAsync(GroupsArgs args, InvokeOptions? opts = null)
        public static Output<GroupsResult> Invoke(GroupsInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GroupsResult> groups(GroupsArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: volcengine:kafka:Groups
      arguments:
        # arguments dictionary

    The following arguments are supported:

    InstanceId string
    The instance id of kafka group.
    GroupId string
    The id of kafka group, support fuzzy matching.
    NameRegex string
    A Name Regex of kafka group.
    OutputFile string
    File name where to save data source results.
    InstanceId string
    The instance id of kafka group.
    GroupId string
    The id of kafka group, support fuzzy matching.
    NameRegex string
    A Name Regex of kafka group.
    OutputFile string
    File name where to save data source results.
    instanceId String
    The instance id of kafka group.
    groupId String
    The id of kafka group, support fuzzy matching.
    nameRegex String
    A Name Regex of kafka group.
    outputFile String
    File name where to save data source results.
    instanceId string
    The instance id of kafka group.
    groupId string
    The id of kafka group, support fuzzy matching.
    nameRegex string
    A Name Regex of kafka group.
    outputFile string
    File name where to save data source results.
    instance_id str
    The instance id of kafka group.
    group_id str
    The id of kafka group, support fuzzy matching.
    name_regex str
    A Name Regex of kafka group.
    output_file str
    File name where to save data source results.
    instanceId String
    The instance id of kafka group.
    groupId String
    The id of kafka group, support fuzzy matching.
    nameRegex String
    A Name Regex of kafka group.
    outputFile String
    File name where to save data source results.

    Groups Result

    The following output properties are available:

    Groups List<GroupsGroup>
    The collection of query.
    Id string
    The provider-assigned unique ID for this managed resource.
    InstanceId string
    TotalCount int
    The total count of query.
    GroupId string
    The id of kafka group.
    NameRegex string
    OutputFile string
    Groups []GroupsGroup
    The collection of query.
    Id string
    The provider-assigned unique ID for this managed resource.
    InstanceId string
    TotalCount int
    The total count of query.
    GroupId string
    The id of kafka group.
    NameRegex string
    OutputFile string
    groups List<GroupsGroup>
    The collection of query.
    id String
    The provider-assigned unique ID for this managed resource.
    instanceId String
    totalCount Integer
    The total count of query.
    groupId String
    The id of kafka group.
    nameRegex String
    outputFile String
    groups GroupsGroup[]
    The collection of query.
    id string
    The provider-assigned unique ID for this managed resource.
    instanceId string
    totalCount number
    The total count of query.
    groupId string
    The id of kafka group.
    nameRegex string
    outputFile string
    groups Sequence[GroupsGroup]
    The collection of query.
    id str
    The provider-assigned unique ID for this managed resource.
    instance_id str
    total_count int
    The total count of query.
    group_id str
    The id of kafka group.
    name_regex str
    output_file str
    groups List<Property Map>
    The collection of query.
    id String
    The provider-assigned unique ID for this managed resource.
    instanceId String
    totalCount Number
    The total count of query.
    groupId String
    The id of kafka group.
    nameRegex String
    outputFile String

    Supporting Types

    GroupsGroup

    GroupId string
    The id of kafka group, support fuzzy matching.
    State string
    The state of kafka group.
    GroupId string
    The id of kafka group, support fuzzy matching.
    State string
    The state of kafka group.
    groupId String
    The id of kafka group, support fuzzy matching.
    state String
    The state of kafka group.
    groupId string
    The id of kafka group, support fuzzy matching.
    state string
    The state of kafka group.
    group_id str
    The id of kafka group, support fuzzy matching.
    state str
    The state of kafka group.
    groupId String
    The id of kafka group, support fuzzy matching.
    state String
    The state of kafka group.

    Package Details

    Repository
    volcengine volcengine/pulumi-volcengine
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the volcengine Terraform Provider.
    volcengine logo
    Volcengine v0.0.24 published on Tuesday, Jun 25, 2024 by Volcengine