Alibaba Cloud

v3.28.0 published on Tuesday, Aug 16, 2022 by Pulumi

Group

Provides a Cloud SSO Group resource.

For information about Cloud SSO Group and how to use it, see What is Group.

NOTE: Available in v1.138.0+.

NOTE: Cloud SSO Only Support cn-shanghai And us-west-1 Region

Create Group Resource

new Group(name: string, args: GroupArgs, opts?: CustomResourceOptions);
@overload
def Group(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          description: Optional[str] = None,
          directory_id: Optional[str] = None,
          group_name: Optional[str] = None)
@overload
def Group(resource_name: str,
          args: GroupArgs,
          opts: Optional[ResourceOptions] = None)
func NewGroup(ctx *Context, name string, args GroupArgs, opts ...ResourceOption) (*Group, error)
public Group(string name, GroupArgs args, CustomResourceOptions? opts = null)
public Group(String name, GroupArgs args)
public Group(String name, GroupArgs args, CustomResourceOptions options)
type: alicloud:cloudsso:Group
properties: # The arguments to resource properties.
options: # 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.
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.

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:

DirectoryId string

The ID of the Directory.

GroupName string

The Name of the group. The name must be 1 to 128 characters in length and can contain letters, digits, periods (.), underscores (_), and hyphens (-).

Description string

The Description of the group. The description can be up to 1024 characters long.

DirectoryId string

The ID of the Directory.

GroupName string

The Name of the group. The name must be 1 to 128 characters in length and can contain letters, digits, periods (.), underscores (_), and hyphens (-).

Description string

The Description of the group. The description can be up to 1024 characters long.

directoryId String

The ID of the Directory.

groupName String

The Name of the group. The name must be 1 to 128 characters in length and can contain letters, digits, periods (.), underscores (_), and hyphens (-).

description String

The Description of the group. The description can be up to 1024 characters long.

directoryId string

The ID of the Directory.

groupName string

The Name of the group. The name must be 1 to 128 characters in length and can contain letters, digits, periods (.), underscores (_), and hyphens (-).

description string

The Description of the group. The description can be up to 1024 characters long.

directory_id str

The ID of the Directory.

group_name str

The Name of the group. The name must be 1 to 128 characters in length and can contain letters, digits, periods (.), underscores (_), and hyphens (-).

description str

The Description of the group. The description can be up to 1024 characters long.

directoryId String

The ID of the Directory.

groupName String

The Name of the group. The name must be 1 to 128 characters in length and can contain letters, digits, periods (.), underscores (_), and hyphens (-).

description String

The Description of the group. The description can be up to 1024 characters long.

Outputs

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

GroupId string

The GroupId of the group.

Id string

The provider-assigned unique ID for this managed resource.

GroupId string

The GroupId of the group.

Id string

The provider-assigned unique ID for this managed resource.

groupId String

The GroupId of the group.

id String

The provider-assigned unique ID for this managed resource.

groupId string

The GroupId of the group.

id string

The provider-assigned unique ID for this managed resource.

group_id str

The GroupId of the group.

id str

The provider-assigned unique ID for this managed resource.

groupId String

The GroupId 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,
        description: Optional[str] = None,
        directory_id: Optional[str] = None,
        group_id: Optional[str] = None,
        group_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:
Description string

The Description of the group. The description can be up to 1024 characters long.

DirectoryId string

The ID of the Directory.

GroupId string

The GroupId of the group.

GroupName string

The Name of the group. The name must be 1 to 128 characters in length and can contain letters, digits, periods (.), underscores (_), and hyphens (-).

Description string

The Description of the group. The description can be up to 1024 characters long.

DirectoryId string

The ID of the Directory.

GroupId string

The GroupId of the group.

GroupName string

The Name of the group. The name must be 1 to 128 characters in length and can contain letters, digits, periods (.), underscores (_), and hyphens (-).

description String

The Description of the group. The description can be up to 1024 characters long.

directoryId String

The ID of the Directory.

groupId String

The GroupId of the group.

groupName String

The Name of the group. The name must be 1 to 128 characters in length and can contain letters, digits, periods (.), underscores (_), and hyphens (-).

description string

The Description of the group. The description can be up to 1024 characters long.

directoryId string

The ID of the Directory.

groupId string

The GroupId of the group.

groupName string

The Name of the group. The name must be 1 to 128 characters in length and can contain letters, digits, periods (.), underscores (_), and hyphens (-).

description str

The Description of the group. The description can be up to 1024 characters long.

directory_id str

The ID of the Directory.

group_id str

The GroupId of the group.

group_name str

The Name of the group. The name must be 1 to 128 characters in length and can contain letters, digits, periods (.), underscores (_), and hyphens (-).

description String

The Description of the group. The description can be up to 1024 characters long.

directoryId String

The ID of the Directory.

groupId String

The GroupId of the group.

groupName String

The Name of the group. The name must be 1 to 128 characters in length and can contain letters, digits, periods (.), underscores (_), and hyphens (-).

Import

Cloud SSO Group can be imported using the id, e.g.

 $ pulumi import alicloud:cloudsso/group:Group example <directory_id>:<group_id>

Package Details

Repository
https://github.com/pulumi/pulumi-alicloud
License
Apache-2.0
Notes

This Pulumi package is based on the alicloud Terraform Provider.