1. Packages
  2. Redpanda Provider
  3. API Docs
  4. ResourceGroup
redpanda 1.3.0 published on Friday, Sep 26, 2025 by redpanda-data

redpanda.ResourceGroup

Explore with Pulumi AI

redpanda logo
redpanda 1.3.0 published on Friday, Sep 26, 2025 by redpanda-data

    A Redpanda Cloud resource group

    Creates a Resource Group in the Redpanda Cloud.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as redpanda from "@pulumi/redpanda";
    
    const example = new redpanda.ResourceGroup("example", {});
    
    import pulumi
    import pulumi_redpanda as redpanda
    
    example = redpanda.ResourceGroup("example")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/redpanda/redpanda"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := redpanda.NewResourceGroup(ctx, "example", nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Redpanda = Pulumi.Redpanda;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Redpanda.ResourceGroup("example");
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.redpanda.ResourceGroup;
    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");
    
        }
    }
    
    resources:
      example:
        type: redpanda:ResourceGroup
    

    API Reference

    For more information, see the Redpanda Cloud Control Plane API documentation.

    Create ResourceGroup Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ResourceGroup(name: string, args?: ResourceGroupArgs, opts?: CustomResourceOptions);
    @overload
    def ResourceGroup(resource_name: str,
                      args: Optional[ResourceGroupArgs] = None,
                      opts: Optional[ResourceOptions] = None)
    
    @overload
    def ResourceGroup(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      name: Optional[str] = None)
    func NewResourceGroup(ctx *Context, name string, args *ResourceGroupArgs, opts ...ResourceOption) (*ResourceGroup, error)
    public ResourceGroup(string name, ResourceGroupArgs? args = null, CustomResourceOptions? opts = null)
    public ResourceGroup(String name, ResourceGroupArgs args)
    public ResourceGroup(String name, ResourceGroupArgs args, CustomResourceOptions options)
    
    type: redpanda:ResourceGroup
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args ResourceGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ResourceGroupArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ResourceGroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ResourceGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ResourceGroupArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var resourceGroupResource = new Redpanda.ResourceGroup("resourceGroupResource", new()
    {
        Name = "string",
    });
    
    example, err := redpanda.NewResourceGroup(ctx, "resourceGroupResource", &redpanda.ResourceGroupArgs{
    	Name: pulumi.String("string"),
    })
    
    var resourceGroupResource = new ResourceGroup("resourceGroupResource", ResourceGroupArgs.builder()
        .name("string")
        .build());
    
    resource_group_resource = redpanda.ResourceGroup("resourceGroupResource", name="string")
    
    const resourceGroupResource = new redpanda.ResourceGroup("resourceGroupResource", {name: "string"});
    
    type: redpanda:ResourceGroup
    properties:
        name: string
    

    ResourceGroup Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The ResourceGroup resource accepts the following input properties:

    Name string
    Name of the resource group. Changing the name of a resource group will result in a new resource group being created and the old one being destroyed
    Name string
    Name of the resource group. Changing the name of a resource group will result in a new resource group being created and the old one being destroyed
    name String
    Name of the resource group. Changing the name of a resource group will result in a new resource group being created and the old one being destroyed
    name string
    Name of the resource group. Changing the name of a resource group will result in a new resource group being created and the old one being destroyed
    name str
    Name of the resource group. Changing the name of a resource group will result in a new resource group being created and the old one being destroyed
    name String
    Name of the resource group. Changing the name of a resource group will result in a new resource group being created and the old one being destroyed

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ResourceGroup resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing ResourceGroup Resource

    Get an existing ResourceGroup resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ResourceGroupState, opts?: CustomResourceOptions): ResourceGroup
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            name: Optional[str] = None) -> ResourceGroup
    func GetResourceGroup(ctx *Context, name string, id IDInput, state *ResourceGroupState, opts ...ResourceOption) (*ResourceGroup, error)
    public static ResourceGroup Get(string name, Input<string> id, ResourceGroupState? state, CustomResourceOptions? opts = null)
    public static ResourceGroup get(String name, Output<String> id, ResourceGroupState state, CustomResourceOptions options)
    resources:  _:    type: redpanda:ResourceGroup    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Name string
    Name of the resource group. Changing the name of a resource group will result in a new resource group being created and the old one being destroyed
    Name string
    Name of the resource group. Changing the name of a resource group will result in a new resource group being created and the old one being destroyed
    name String
    Name of the resource group. Changing the name of a resource group will result in a new resource group being created and the old one being destroyed
    name string
    Name of the resource group. Changing the name of a resource group will result in a new resource group being created and the old one being destroyed
    name str
    Name of the resource group. Changing the name of a resource group will result in a new resource group being created and the old one being destroyed
    name String
    Name of the resource group. Changing the name of a resource group will result in a new resource group being created and the old one being destroyed

    Import

    $ pulumi import redpanda:index/resourceGroup:ResourceGroup example resourcegroupId
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    redpanda redpanda-data/terraform-provider-redpanda
    License
    Notes
    This Pulumi package is based on the redpanda Terraform Provider.
    redpanda logo
    redpanda 1.3.0 published on Friday, Sep 26, 2025 by redpanda-data