Docs Home
alicloud.ram.Group
Explore with Pulumi AI
Provides a RAM Group resource.
The group that users can join.
For information about RAM Group and how to use it, see What is Group.
NOTE: Available since v1.0.0.
Example Usage
Basic Usage
import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";
const config = new pulumi.Config();
const name = config.get("name") || "terraform-example";
const group = new alicloud.ram.Group("group", {
groupName: name,
comments: name,
force: true,
});
import pulumi
import pulumi_alicloud as alicloud
config = pulumi.Config()
name = config.get("name")
if name is None:
name = "terraform-example"
group = alicloud.ram.Group("group",
group_name=name,
comments=name,
force=True)
package main
import (
"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/ram"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
cfg := config.New(ctx, "")
name := "terraform-example"
if param := cfg.Get("name"); param != "" {
name = param
}
_, err := ram.NewGroup(ctx, "group", &ram.GroupArgs{
GroupName: pulumi.String(name),
Comments: pulumi.String(name),
Force: pulumi.Bool(true),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AliCloud = Pulumi.AliCloud;
return await Deployment.RunAsync(() =>
{
var config = new Config();
var name = config.Get("name") ?? "terraform-example";
var @group = new AliCloud.Ram.Group("group", new()
{
GroupName = name,
Comments = name,
Force = true,
});
});
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) {
final var config = ctx.config();
final var name = config.get("name").orElse("terraform-example");
var group = new Group("group", GroupArgs.builder()
.groupName(name)
.comments(name)
.force(true)
.build());
}
}
configuration:
name:
type: string
default: terraform-example
resources:
group:
type: alicloud:ram:Group
properties:
groupName: ${name}
comments: ${name}
force: true
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,
group_name: Optional[str] = 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)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,
GroupName = "string",
});
example, err := ram.NewGroup(ctx, "examplegroupResourceResourceFromRamgroup", &ram.GroupArgs{
Comments: pulumi.String("string"),
Force: pulumi.Bool(false),
GroupName: pulumi.String("string"),
})
var examplegroupResourceResourceFromRamgroup = new com.pulumi.alicloud.ram.Group("examplegroupResourceResourceFromRamgroup", com.pulumi.alicloud.ram.GroupArgs.builder()
.comments("string")
.force(false)
.groupName("string")
.build());
examplegroup_resource_resource_from_ramgroup = alicloud.ram.Group("examplegroupResourceResourceFromRamgroup",
comments="string",
force=False,
group_name="string")
const examplegroupResourceResourceFromRamgroup = new alicloud.ram.Group("examplegroupResourceResourceFromRamgroup", {
comments: "string",
force: false,
groupName: "string",
});
type: alicloud:ram:Group
properties:
comments: string
force: false
groupName: 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
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Group resource accepts the following input properties:
- Comments string
- The Group comment information. The maximum length is 128 characters.
- Force bool
- Specifies whether to force delete the Group. Default value:
false. Valid values: - Group
Name string The group name. You must specify at least one of the
group_nameandname. It can be 1 to 64 characters in length and can contain letters, digits, periods (.), underscores (_), and dashes (-).The following arguments will be discarded. Please use new fields as soon as possible:
- Name string
- . Field 'name' has been deprecated from provider version 1.120.0. New field 'group_name' instead.
- Comments string
- The Group comment information. The maximum length is 128 characters.
- Force bool
- Specifies whether to force delete the Group. Default value:
false. Valid values: - Group
Name string The group name. You must specify at least one of the
group_nameandname. It can be 1 to 64 characters in length and can contain letters, digits, periods (.), underscores (_), and dashes (-).The following arguments will be discarded. Please use new fields as soon as possible:
- Name string
- . Field 'name' has been deprecated from provider version 1.120.0. New field 'group_name' instead.
- comments String
- The Group comment information. The maximum length is 128 characters.
- force Boolean
- Specifies whether to force delete the Group. Default value:
false. Valid values: - group
Name String The group name. You must specify at least one of the
group_nameandname. It can be 1 to 64 characters in length and can contain letters, digits, periods (.), underscores (_), and dashes (-).The following arguments will be discarded. Please use new fields as soon as possible:
- name String
- . Field 'name' has been deprecated from provider version 1.120.0. New field 'group_name' instead.
- comments string
- The Group comment information. The maximum length is 128 characters.
- force boolean
- Specifies whether to force delete the Group. Default value:
false. Valid values: - group
Name string The group name. You must specify at least one of the
group_nameandname. It can be 1 to 64 characters in length and can contain letters, digits, periods (.), underscores (_), and dashes (-).The following arguments will be discarded. Please use new fields as soon as possible:
- name string
- . Field 'name' has been deprecated from provider version 1.120.0. New field 'group_name' instead.
- comments str
- The Group comment information. The maximum length is 128 characters.
- force bool
- Specifies whether to force delete the Group. Default value:
false. Valid values: - group_
name str The group name. You must specify at least one of the
group_nameandname. It can be 1 to 64 characters in length and can contain letters, digits, periods (.), underscores (_), and dashes (-).The following arguments will be discarded. Please use new fields as soon as possible:
- name str
- . Field 'name' has been deprecated from provider version 1.120.0. New field 'group_name' instead.
- comments String
- The Group comment information. The maximum length is 128 characters.
- force Boolean
- Specifies whether to force delete the Group. Default value:
false. Valid values: - group
Name String The group name. You must specify at least one of the
group_nameandname. It can be 1 to 64 characters in length and can contain letters, digits, periods (.), underscores (_), and dashes (-).The following arguments will be discarded. Please use new fields as soon as possible:
- name String
- . Field 'name' has been deprecated from provider version 1.120.0. New field 'group_name' instead.
Outputs
All input properties are implicitly available as output properties. Additionally, the Group resource produces the following output properties:
- Create
Time string - (Available since v1.245.0) The create time of the group.
- Id string
- The provider-assigned unique ID for this managed resource.
- Create
Time string - (Available since v1.245.0) The create time of the group.
- Id string
- The provider-assigned unique ID for this managed resource.
- create
Time String - (Available since v1.245.0) The create time of the group.
- id String
- The provider-assigned unique ID for this managed resource.
- create
Time string - (Available since v1.245.0) The create time of the group.
- id string
- The provider-assigned unique ID for this managed resource.
- create_
time str - (Available since v1.245.0) The create time of the group.
- id str
- The provider-assigned unique ID for this managed resource.
- create
Time String - (Available since v1.245.0) The create time of the group.
- 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,
create_time: Optional[str] = None,
force: Optional[bool] = None,
group_name: Optional[str] = None,
name: Optional[str] = None) -> Groupfunc 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)resources: _: type: alicloud:ram:Group 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.
- Comments string
- The Group comment information. The maximum length is 128 characters.
- Create
Time string - (Available since v1.245.0) The create time of the group.
- Force bool
- Specifies whether to force delete the Group. Default value:
false. Valid values: - Group
Name string The group name. You must specify at least one of the
group_nameandname. It can be 1 to 64 characters in length and can contain letters, digits, periods (.), underscores (_), and dashes (-).The following arguments will be discarded. Please use new fields as soon as possible:
- Name string
- . Field 'name' has been deprecated from provider version 1.120.0. New field 'group_name' instead.
- Comments string
- The Group comment information. The maximum length is 128 characters.
- Create
Time string - (Available since v1.245.0) The create time of the group.
- Force bool
- Specifies whether to force delete the Group. Default value:
false. Valid values: - Group
Name string The group name. You must specify at least one of the
group_nameandname. It can be 1 to 64 characters in length and can contain letters, digits, periods (.), underscores (_), and dashes (-).The following arguments will be discarded. Please use new fields as soon as possible:
- Name string
- . Field 'name' has been deprecated from provider version 1.120.0. New field 'group_name' instead.
- comments String
- The Group comment information. The maximum length is 128 characters.
- create
Time String - (Available since v1.245.0) The create time of the group.
- force Boolean
- Specifies whether to force delete the Group. Default value:
false. Valid values: - group
Name String The group name. You must specify at least one of the
group_nameandname. It can be 1 to 64 characters in length and can contain letters, digits, periods (.), underscores (_), and dashes (-).The following arguments will be discarded. Please use new fields as soon as possible:
- name String
- . Field 'name' has been deprecated from provider version 1.120.0. New field 'group_name' instead.
- comments string
- The Group comment information. The maximum length is 128 characters.
- create
Time string - (Available since v1.245.0) The create time of the group.
- force boolean
- Specifies whether to force delete the Group. Default value:
false. Valid values: - group
Name string The group name. You must specify at least one of the
group_nameandname. It can be 1 to 64 characters in length and can contain letters, digits, periods (.), underscores (_), and dashes (-).The following arguments will be discarded. Please use new fields as soon as possible:
- name string
- . Field 'name' has been deprecated from provider version 1.120.0. New field 'group_name' instead.
- comments str
- The Group comment information. The maximum length is 128 characters.
- create_
time str - (Available since v1.245.0) The create time of the group.
- force bool
- Specifies whether to force delete the Group. Default value:
false. Valid values: - group_
name str The group name. You must specify at least one of the
group_nameandname. It can be 1 to 64 characters in length and can contain letters, digits, periods (.), underscores (_), and dashes (-).The following arguments will be discarded. Please use new fields as soon as possible:
- name str
- . Field 'name' has been deprecated from provider version 1.120.0. New field 'group_name' instead.
- comments String
- The Group comment information. The maximum length is 128 characters.
- create
Time String - (Available since v1.245.0) The create time of the group.
- force Boolean
- Specifies whether to force delete the Group. Default value:
false. Valid values: - group
Name String The group name. You must specify at least one of the
group_nameandname. It can be 1 to 64 characters in length and can contain letters, digits, periods (.), underscores (_), and dashes (-).The following arguments will be discarded. Please use new fields as soon as possible:
- name String
- . Field 'name' has been deprecated from provider version 1.120.0. New field 'group_name' instead.
Import
RAM Group can be imported using the id, e.g.
$ pulumi import alicloud:ram/group:Group example <id>
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
alicloudTerraform Provider.