1. Packages
  2. Scaleway
  3. API Docs
  4. getIamGroup
Scaleway v1.14.0 published on Thursday, Jun 6, 2024 by pulumiverse

scaleway.getIamGroup

Explore with Pulumi AI

scaleway logo
Scaleway v1.14.0 published on Thursday, Jun 6, 2024 by pulumiverse

    Gets information about an existing IAM group. For more information, please check the documentation

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as scaleway from "@pulumi/scaleway";
    
    const findByName = scaleway.getIamGroup({
        name: "foobar",
    });
    const findById = scaleway.getIamGroup({
        groupId: "11111111-1111-1111-1111-111111111111",
    });
    
    import pulumi
    import pulumi_scaleway as scaleway
    
    find_by_name = scaleway.get_iam_group(name="foobar")
    find_by_id = scaleway.get_iam_group(group_id="11111111-1111-1111-1111-111111111111")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/pulumiverse/pulumi-scaleway/sdk/go/scaleway"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := scaleway.LookupIamGroup(ctx, &scaleway.LookupIamGroupArgs{
    			Name: pulumi.StringRef("foobar"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		_, err = scaleway.LookupIamGroup(ctx, &scaleway.LookupIamGroupArgs{
    			GroupId: pulumi.StringRef("11111111-1111-1111-1111-111111111111"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Scaleway = Pulumi.Scaleway;
    
    return await Deployment.RunAsync(() => 
    {
        var findByName = Scaleway.GetIamGroup.Invoke(new()
        {
            Name = "foobar",
        });
    
        var findById = Scaleway.GetIamGroup.Invoke(new()
        {
            GroupId = "11111111-1111-1111-1111-111111111111",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.scaleway.ScalewayFunctions;
    import com.pulumi.scaleway.inputs.GetIamGroupArgs;
    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 findByName = ScalewayFunctions.getIamGroup(GetIamGroupArgs.builder()
                .name("foobar")
                .build());
    
            final var findById = ScalewayFunctions.getIamGroup(GetIamGroupArgs.builder()
                .groupId("11111111-1111-1111-1111-111111111111")
                .build());
    
        }
    }
    
    variables:
      findByName:
        fn::invoke:
          Function: scaleway:getIamGroup
          Arguments:
            name: foobar
      findById:
        fn::invoke:
          Function: scaleway:getIamGroup
          Arguments:
            groupId: 11111111-1111-1111-1111-111111111111
    

    Using getIamGroup

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getIamGroup(args: GetIamGroupArgs, opts?: InvokeOptions): Promise<GetIamGroupResult>
    function getIamGroupOutput(args: GetIamGroupOutputArgs, opts?: InvokeOptions): Output<GetIamGroupResult>
    def get_iam_group(group_id: Optional[str] = None,
                      name: Optional[str] = None,
                      organization_id: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetIamGroupResult
    def get_iam_group_output(group_id: Optional[pulumi.Input[str]] = None,
                      name: Optional[pulumi.Input[str]] = None,
                      organization_id: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetIamGroupResult]
    func LookupIamGroup(ctx *Context, args *LookupIamGroupArgs, opts ...InvokeOption) (*LookupIamGroupResult, error)
    func LookupIamGroupOutput(ctx *Context, args *LookupIamGroupOutputArgs, opts ...InvokeOption) LookupIamGroupResultOutput

    > Note: This function is named LookupIamGroup in the Go SDK.

    public static class GetIamGroup 
    {
        public static Task<GetIamGroupResult> InvokeAsync(GetIamGroupArgs args, InvokeOptions? opts = null)
        public static Output<GetIamGroupResult> Invoke(GetIamGroupInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetIamGroupResult> getIamGroup(GetIamGroupArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: scaleway:index/getIamGroup:getIamGroup
      arguments:
        # arguments dictionary

    The following arguments are supported:

    GroupId string
    The ID of the IAM group. Only one of the name and group_id should be specified.
    Name string
    The name of the IAM group. Only one of the name and group_id should be specified.
    OrganizationId string
    organization_id) The ID of the organization the group is associated with.
    GroupId string
    The ID of the IAM group. Only one of the name and group_id should be specified.
    Name string
    The name of the IAM group. Only one of the name and group_id should be specified.
    OrganizationId string
    organization_id) The ID of the organization the group is associated with.
    groupId String
    The ID of the IAM group. Only one of the name and group_id should be specified.
    name String
    The name of the IAM group. Only one of the name and group_id should be specified.
    organizationId String
    organization_id) The ID of the organization the group is associated with.
    groupId string
    The ID of the IAM group. Only one of the name and group_id should be specified.
    name string
    The name of the IAM group. Only one of the name and group_id should be specified.
    organizationId string
    organization_id) The ID of the organization the group is associated with.
    group_id str
    The ID of the IAM group. Only one of the name and group_id should be specified.
    name str
    The name of the IAM group. Only one of the name and group_id should be specified.
    organization_id str
    organization_id) The ID of the organization the group is associated with.
    groupId String
    The ID of the IAM group. Only one of the name and group_id should be specified.
    name String
    The name of the IAM group. Only one of the name and group_id should be specified.
    organizationId String
    organization_id) The ID of the organization the group is associated with.

    getIamGroup Result

    The following output properties are available:

    ApplicationIds List<string>
    CreatedAt string
    Description string
    ExternalMembership bool
    Id string
    The provider-assigned unique ID for this managed resource.
    Tags List<string>
    UpdatedAt string
    UserIds List<string>
    GroupId string
    Name string
    OrganizationId string
    ApplicationIds []string
    CreatedAt string
    Description string
    ExternalMembership bool
    Id string
    The provider-assigned unique ID for this managed resource.
    Tags []string
    UpdatedAt string
    UserIds []string
    GroupId string
    Name string
    OrganizationId string
    applicationIds List<String>
    createdAt String
    description String
    externalMembership Boolean
    id String
    The provider-assigned unique ID for this managed resource.
    tags List<String>
    updatedAt String
    userIds List<String>
    groupId String
    name String
    organizationId String
    applicationIds string[]
    createdAt string
    description string
    externalMembership boolean
    id string
    The provider-assigned unique ID for this managed resource.
    tags string[]
    updatedAt string
    userIds string[]
    groupId string
    name string
    organizationId string
    application_ids Sequence[str]
    created_at str
    description str
    external_membership bool
    id str
    The provider-assigned unique ID for this managed resource.
    tags Sequence[str]
    updated_at str
    user_ids Sequence[str]
    group_id str
    name str
    organization_id str
    applicationIds List<String>
    createdAt String
    description String
    externalMembership Boolean
    id String
    The provider-assigned unique ID for this managed resource.
    tags List<String>
    updatedAt String
    userIds List<String>
    groupId String
    name String
    organizationId String

    Package Details

    Repository
    scaleway pulumiverse/pulumi-scaleway
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the scaleway Terraform Provider.
    scaleway logo
    Scaleway v1.14.0 published on Thursday, Jun 6, 2024 by pulumiverse