Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Ibm Provider
  3. API Docs
  4. IamAccessGroup
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

ibm.IamAccessGroup

Explore with Pulumi AI

ibm logo
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

    Create, modify, or delete an IAM access group. Access groups can be used to define a set of permissions that you want to grant to a group of users. For more information, about IAM access group, see How IAM access works?.

    Example Usage

    The following example creates an access group that is named mygroup.

    import * as pulumi from "@pulumi/pulumi";
import * as ibm from "@pulumi/ibm";

const accgrp = new ibm.IamAccessGroup("accgrp", {description: "New access group"});

    import pulumi
import pulumi_ibm as ibm

accgrp = ibm.IamAccessGroup("accgrp", description="New access group")

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/ibm"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ibm.NewIamAccessGroup(ctx, "accgrp", &ibm.IamAccessGroupArgs{
			Description: pulumi.String("New access group"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;

return await Deployment.RunAsync(() => 
{
    var accgrp = new Ibm.IamAccessGroup("accgrp", new()
    {
        Description = "New access group",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.IamAccessGroup;
import com.pulumi.ibm.IamAccessGroupArgs;
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 accgrp = new IamAccessGroup("accgrp", IamAccessGroupArgs.builder()
            .description("New access group")
            .build());

    }
}

    resources:
  accgrp:
    type: ibm:IamAccessGroup
    properties:
      description: New access group

    Create IamAccessGroup Resource

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

    Constructor syntax

    new IamAccessGroup(name: string, args?: IamAccessGroupArgs, opts?: CustomResourceOptions);
    @overload
def IamAccessGroup(resource_name: str,
                   args: Optional[IamAccessGroupArgs] = None,
                   opts: Optional[ResourceOptions] = None)

@overload
def IamAccessGroup(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   description: Optional[str] = None,
                   iam_access_group_id: Optional[str] = None,
                   name: Optional[str] = None,
                   tags: Optional[Sequence[str]] = None)
    func NewIamAccessGroup(ctx *Context, name string, args *IamAccessGroupArgs, opts ...ResourceOption) (*IamAccessGroup, error)
    public IamAccessGroup(string name, IamAccessGroupArgs? args = null, CustomResourceOptions? opts = null)
    public IamAccessGroup(String name, IamAccessGroupArgs args)
public IamAccessGroup(String name, IamAccessGroupArgs args, CustomResourceOptions options)

    type: ibm:IamAccessGroup
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 IamAccessGroupArgs
    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 IamAccessGroupArgs
    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 IamAccessGroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args IamAccessGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args IamAccessGroupArgs
    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 iamAccessGroupResource = new Ibm.IamAccessGroup("iamAccessGroupResource", new()
{
    Description = "string",
    IamAccessGroupId = "string",
    Name = "string",
    Tags = new[]
    {
        "string",
    },
});

    example, err := ibm.NewIamAccessGroup(ctx, "iamAccessGroupResource", &ibm.IamAccessGroupArgs{
	Description:      pulumi.String("string"),
	IamAccessGroupId: pulumi.String("string"),
	Name:             pulumi.String("string"),
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
})

    var iamAccessGroupResource = new IamAccessGroup("iamAccessGroupResource", IamAccessGroupArgs.builder()
    .description("string")
    .iamAccessGroupId("string")
    .name("string")
    .tags("string")
    .build());

    iam_access_group_resource = ibm.IamAccessGroup("iamAccessGroupResource",
    description="string",
    iam_access_group_id="string",
    name="string",
    tags=["string"])

    const iamAccessGroupResource = new ibm.IamAccessGroup("iamAccessGroupResource", {
    description: "string",
    iamAccessGroupId: "string",
    name: "string",
    tags: ["string"],
});

    type: ibm:IamAccessGroup
properties:
    description: string
    iamAccessGroupId: string
    name: string
    tags:
        - string

    IamAccessGroup 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 IamAccessGroup resource accepts the following input properties:

    Description string
    The description of the access group.
    IamAccessGroupId string
    (String) The unique identifier of the access group.
    Name string
    The name of the access group.
    Tags List<string>
    The list of tags that you want to associated with your access group. Note Tags are managed locally and not stored on the IBM Cloud Service Endpoint at this moment.
    Description string
    The description of the access group.
    IamAccessGroupId string
    (String) The unique identifier of the access group.
    Name string
    The name of the access group.
    Tags []string
    The list of tags that you want to associated with your access group. Note Tags are managed locally and not stored on the IBM Cloud Service Endpoint at this moment.
    description String
    The description of the access group.
    iamAccessGroupId String
    (String) The unique identifier of the access group.
    name String
    The name of the access group.
    tags List<String>
    The list of tags that you want to associated with your access group. Note Tags are managed locally and not stored on the IBM Cloud Service Endpoint at this moment.
    description string
    The description of the access group.
    iamAccessGroupId string
    (String) The unique identifier of the access group.
    name string
    The name of the access group.
    tags string[]
    The list of tags that you want to associated with your access group. Note Tags are managed locally and not stored on the IBM Cloud Service Endpoint at this moment.
    description str
    The description of the access group.
    iam_access_group_id str
    (String) The unique identifier of the access group.
    name str
    The name of the access group.
    tags Sequence[str]
    The list of tags that you want to associated with your access group. Note Tags are managed locally and not stored on the IBM Cloud Service Endpoint at this moment.
    description String
    The description of the access group.
    iamAccessGroupId String
    (String) The unique identifier of the access group.
    name String
    The name of the access group.
    tags List<String>
    The list of tags that you want to associated with your access group. Note Tags are managed locally and not stored on the IBM Cloud Service Endpoint at this moment.

    Outputs

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

    Crn string
    (String) CRN of the access group
    Id string
    The provider-assigned unique ID for this managed resource.
    Version string
    (String) The version of the access group.
    Crn string
    (String) CRN of the access group
    Id string
    The provider-assigned unique ID for this managed resource.
    Version string
    (String) The version of the access group.
    crn String
    (String) CRN of the access group
    id String
    The provider-assigned unique ID for this managed resource.
    version String
    (String) The version of the access group.
    crn string
    (String) CRN of the access group
    id string
    The provider-assigned unique ID for this managed resource.
    version string
    (String) The version of the access group.
    crn str
    (String) CRN of the access group
    id str
    The provider-assigned unique ID for this managed resource.
    version str
    (String) The version of the access group.
    crn String
    (String) CRN of the access group
    id String
    The provider-assigned unique ID for this managed resource.
    version String
    (String) The version of the access group.

    Look up Existing IamAccessGroup Resource

    Get an existing IamAccessGroup 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?: IamAccessGroupState, opts?: CustomResourceOptions): IamAccessGroup
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        crn: Optional[str] = None,
        description: Optional[str] = None,
        iam_access_group_id: Optional[str] = None,
        name: Optional[str] = None,
        tags: Optional[Sequence[str]] = None,
        version: Optional[str] = None) -> IamAccessGroup
    func GetIamAccessGroup(ctx *Context, name string, id IDInput, state *IamAccessGroupState, opts ...ResourceOption) (*IamAccessGroup, error)
    public static IamAccessGroup Get(string name, Input<string> id, IamAccessGroupState? state, CustomResourceOptions? opts = null)
    public static IamAccessGroup get(String name, Output<String> id, IamAccessGroupState state, CustomResourceOptions options)
    resources:  _:    type: ibm:IamAccessGroup    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:
    Crn string
    (String) CRN of the access group
    Description string
    The description of the access group.
    IamAccessGroupId string
    (String) The unique identifier of the access group.
    Name string
    The name of the access group.
    Tags List<string>
    The list of tags that you want to associated with your access group. Note Tags are managed locally and not stored on the IBM Cloud Service Endpoint at this moment.
    Version string
    (String) The version of the access group.
    Crn string
    (String) CRN of the access group
    Description string
    The description of the access group.
    IamAccessGroupId string
    (String) The unique identifier of the access group.
    Name string
    The name of the access group.
    Tags []string
    The list of tags that you want to associated with your access group. Note Tags are managed locally and not stored on the IBM Cloud Service Endpoint at this moment.
    Version string
    (String) The version of the access group.
    crn String
    (String) CRN of the access group
    description String
    The description of the access group.
    iamAccessGroupId String
    (String) The unique identifier of the access group.
    name String
    The name of the access group.
    tags List<String>
    The list of tags that you want to associated with your access group. Note Tags are managed locally and not stored on the IBM Cloud Service Endpoint at this moment.
    version String
    (String) The version of the access group.
    crn string
    (String) CRN of the access group
    description string
    The description of the access group.
    iamAccessGroupId string
    (String) The unique identifier of the access group.
    name string
    The name of the access group.
    tags string[]
    The list of tags that you want to associated with your access group. Note Tags are managed locally and not stored on the IBM Cloud Service Endpoint at this moment.
    version string
    (String) The version of the access group.
    crn str
    (String) CRN of the access group
    description str
    The description of the access group.
    iam_access_group_id str
    (String) The unique identifier of the access group.
    name str
    The name of the access group.
    tags Sequence[str]
    The list of tags that you want to associated with your access group. Note Tags are managed locally and not stored on the IBM Cloud Service Endpoint at this moment.
    version str
    (String) The version of the access group.
    crn String
    (String) CRN of the access group
    description String
    The description of the access group.
    iamAccessGroupId String
    (String) The unique identifier of the access group.
    name String
    The name of the access group.
    tags List<String>
    The list of tags that you want to associated with your access group. Note Tags are managed locally and not stored on the IBM Cloud Service Endpoint at this moment.
    version String
    (String) The version of the access group.

    Package Details

    Repository
    ibm ibm-cloud/terraform-provider-ibm
    License
    Notes
    This Pulumi package is based on the ibm Terraform Provider.
    ibm logo
    ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
    ibm-cloud/terraform-provider-ibm