1. Packages
  2. Alicloud Provider
  3. API Docs
  4. ram
  5. Group
Alibaba Cloud v3.63.0 published on Monday, Sep 30, 2024 by Pulumi

alicloud.ram.Group

Explore with Pulumi AI

alicloud logo
Alibaba Cloud v3.63.0 published on Monday, Sep 30, 2024 by Pulumi

    Provides a RAM Group resource.

    NOTE: When you want to destroy this resource forcefully(means remove all the relationships associated with it automatically and then destroy it) without set force with true at beginning, you need add force = true to configuration file and run pulumi preview, then you can delete resource forcefully.

    NOTE: Available since v1.0.0+.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as alicloud from "@pulumi/alicloud";
    
    // Create a new RAM Group.
    const group = new alicloud.ram.Group("group", {
        name: "groupName",
        comments: "this is a group comments.",
    });
    
    import pulumi
    import pulumi_alicloud as alicloud
    
    # Create a new RAM Group.
    group = alicloud.ram.Group("group",
        name="groupName",
        comments="this is a group comments.")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/ram"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		// Create a new RAM Group.
    		_, err := ram.NewGroup(ctx, "group", &ram.GroupArgs{
    			Name:     pulumi.String("groupName"),
    			Comments: pulumi.String("this is a group comments."),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AliCloud = Pulumi.AliCloud;
    
    return await Deployment.RunAsync(() => 
    {
        // Create a new RAM Group.
        var @group = new AliCloud.Ram.Group("group", new()
        {
            Name = "groupName",
            Comments = "this is a group comments.",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.alicloud.ram.Group;
    import com.pulumi.alicloud.ram.GroupArgs;
    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) {
            // Create a new RAM Group.
            var group = new Group("group", GroupArgs.builder()
                .name("groupName")
                .comments("this is a group comments.")
                .build());
    
        }
    }
    
    resources:
      # Create a new RAM Group.
      group:
        type: alicloud:ram:Group
        properties:
          name: groupName
          comments: this is a group comments.
    

    Create Group Resource

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

    Constructor syntax

    new Group(name: string, args?: GroupArgs, opts?: CustomResourceOptions);
    @overload
    def Group(resource_name: str,
              args: Optional[GroupArgs] = None,
              opts: Optional[ResourceOptions] = None)
    
    @overload
    def Group(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              comments: Optional[str] = None,
              force: Optional[bool] = None,
              name: Optional[str] = None)
    func NewGroup(ctx *Context, name string, args *GroupArgs, opts ...ResourceOption) (*Group, error)
    public Group(string name, GroupArgs? args = null, CustomResourceOptions? opts = null)
    public Group(String name, GroupArgs args)
    public Group(String name, GroupArgs args, CustomResourceOptions options)
    
    type: alicloud:ram:Group
    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 GroupArgs
    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 GroupArgs
    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 GroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GroupArgs
    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 examplegroupResourceResourceFromRamgroup = new AliCloud.Ram.Group("examplegroupResourceResourceFromRamgroup", new()
    {
        Comments = "string",
        Force = false,
        Name = "string",
    });
    
    example, err := ram.NewGroup(ctx, "examplegroupResourceResourceFromRamgroup", &ram.GroupArgs{
    	Comments: pulumi.String("string"),
    	Force:    pulumi.Bool(false),
    	Name:     pulumi.String("string"),
    })
    
    var examplegroupResourceResourceFromRamgroup = new Group("examplegroupResourceResourceFromRamgroup", GroupArgs.builder()
        .comments("string")
        .force(false)
        .name("string")
        .build());
    
    examplegroup_resource_resource_from_ramgroup = alicloud.ram.Group("examplegroupResourceResourceFromRamgroup",
        comments="string",
        force=False,
        name="string")
    
    const examplegroupResourceResourceFromRamgroup = new alicloud.ram.Group("examplegroupResourceResourceFromRamgroup", {
        comments: "string",
        force: false,
        name: "string",
    });
    
    type: alicloud:ram:Group
    properties:
        comments: string
        force: false
        name: string
    

    Group Resource Properties

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

    Inputs

    The Group resource accepts the following input properties:

    Comments string
    Comment of the RAM group. This parameter can have a string of 1 to 128 characters.
    Force bool
    This parameter is used for resource destroy. Default value is false.
    Name string
    Name of the RAM group. This name can have a string of 1 to 128 characters, must contain only alphanumeric characters or hyphen "-", and must not begin with a hyphen.
    Comments string
    Comment of the RAM group. This parameter can have a string of 1 to 128 characters.
    Force bool
    This parameter is used for resource destroy. Default value is false.
    Name string
    Name of the RAM group. This name can have a string of 1 to 128 characters, must contain only alphanumeric characters or hyphen "-", and must not begin with a hyphen.
    comments String
    Comment of the RAM group. This parameter can have a string of 1 to 128 characters.
    force Boolean
    This parameter is used for resource destroy. Default value is false.
    name String
    Name of the RAM group. This name can have a string of 1 to 128 characters, must contain only alphanumeric characters or hyphen "-", and must not begin with a hyphen.
    comments string
    Comment of the RAM group. This parameter can have a string of 1 to 128 characters.
    force boolean
    This parameter is used for resource destroy. Default value is false.
    name string
    Name of the RAM group. This name can have a string of 1 to 128 characters, must contain only alphanumeric characters or hyphen "-", and must not begin with a hyphen.
    comments str
    Comment of the RAM group. This parameter can have a string of 1 to 128 characters.
    force bool
    This parameter is used for resource destroy. Default value is false.
    name str
    Name of the RAM group. This name can have a string of 1 to 128 characters, must contain only alphanumeric characters or hyphen "-", and must not begin with a hyphen.
    comments String
    Comment of the RAM group. This parameter can have a string of 1 to 128 characters.
    force Boolean
    This parameter is used for resource destroy. Default value is false.
    name String
    Name of the RAM group. This name can have a string of 1 to 128 characters, must contain only alphanumeric characters or hyphen "-", and must not begin with a hyphen.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Group 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 Group Resource

    Get an existing Group 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?: GroupState, opts?: CustomResourceOptions): Group
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            comments: Optional[str] = None,
            force: Optional[bool] = None,
            name: Optional[str] = None) -> Group
    func GetGroup(ctx *Context, name string, id IDInput, state *GroupState, opts ...ResourceOption) (*Group, error)
    public static Group Get(string name, Input<string> id, GroupState? state, CustomResourceOptions? opts = null)
    public static Group get(String name, Output<String> id, GroupState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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:
    Comments string
    Comment of the RAM group. This parameter can have a string of 1 to 128 characters.
    Force bool
    This parameter is used for resource destroy. Default value is false.
    Name string
    Name of the RAM group. This name can have a string of 1 to 128 characters, must contain only alphanumeric characters or hyphen "-", and must not begin with a hyphen.
    Comments string
    Comment of the RAM group. This parameter can have a string of 1 to 128 characters.
    Force bool
    This parameter is used for resource destroy. Default value is false.
    Name string
    Name of the RAM group. This name can have a string of 1 to 128 characters, must contain only alphanumeric characters or hyphen "-", and must not begin with a hyphen.
    comments String
    Comment of the RAM group. This parameter can have a string of 1 to 128 characters.
    force Boolean
    This parameter is used for resource destroy. Default value is false.
    name String
    Name of the RAM group. This name can have a string of 1 to 128 characters, must contain only alphanumeric characters or hyphen "-", and must not begin with a hyphen.
    comments string
    Comment of the RAM group. This parameter can have a string of 1 to 128 characters.
    force boolean
    This parameter is used for resource destroy. Default value is false.
    name string
    Name of the RAM group. This name can have a string of 1 to 128 characters, must contain only alphanumeric characters or hyphen "-", and must not begin with a hyphen.
    comments str
    Comment of the RAM group. This parameter can have a string of 1 to 128 characters.
    force bool
    This parameter is used for resource destroy. Default value is false.
    name str
    Name of the RAM group. This name can have a string of 1 to 128 characters, must contain only alphanumeric characters or hyphen "-", and must not begin with a hyphen.
    comments String
    Comment of the RAM group. This parameter can have a string of 1 to 128 characters.
    force Boolean
    This parameter is used for resource destroy. Default value is false.
    name String
    Name of the RAM group. This name can have a string of 1 to 128 characters, must contain only alphanumeric characters or hyphen "-", and must not begin with a hyphen.

    Import

    RAM group can be imported using the id or name, e.g.

    $ pulumi import alicloud:ram/group:Group example my-group
    

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

    Package Details

    Repository
    Alibaba Cloud pulumi/pulumi-alicloud
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the alicloud Terraform Provider.
    alicloud logo
    Alibaba Cloud v3.63.0 published on Monday, Sep 30, 2024 by Pulumi