← All packages

Akamai

Pulumi Official

Package maintained by Pulumi

v2.9.0 published on Wednesday, Apr 6, 2022 by Pulumi

Source code

getGroups

Use the akamai.getGroups data source to list groups associated with the EdgeGrid API client token you’re using.

Basic usage

Return groups associated with the EdgeGrid API client token you’re using:

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

const my-example = akamai.getGroups({});
export const propertyMatch = my_example;

import pulumi
import pulumi_akamai as akamai

my_example = akamai.get_groups()
pulumi.export("propertyMatch", my_example)

using Pulumi;
using Akamai = Pulumi.Akamai;

class MyStack : Stack
{
    public MyStack()
    {
        var my_example = Output.Create(Akamai.GetGroups.InvokeAsync());
        this.PropertyMatch = my_example;
    }

    [Output("propertyMatch")]
    public Output<string> PropertyMatch { get; set; }
}

package main

import (
	"github.com/pulumi/pulumi-akamai/sdk/v2/go/akamai"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		my_example, err := akamai.GetGroups(ctx, nil, nil)
		if err != nil {
			return err
		}
		ctx.Export("propertyMatch", my_example)
		return nil
	})
}

Attributes reference

This data source returns these attributes:

groups - A list of supported groups, with the following attributes:
- group_id - A group’s unique ID, including the grp_ prefix.
- group_name - The name of the group.
- parent_group_id - The ID of the parent group, if applicable.
- contract_ids - An array of strings listing the contract IDs for each group.

Using getGroups

function getGroups(opts?: InvokeOptions): Promise<GetGroupsResult>

def get_groups(opts: Optional[InvokeOptions] = None) -> GetGroupsResult

func GetGroups(ctx *Context, opts ...InvokeOption) (*GetGroupsResult, error)

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

public static class GetGroups 
{
    public static Task<GetGroupsResult> InvokeAsync(InvokeOptions? opts = null)
}

public static CompletableFuture<GetGroupsResult> getGroups(InvokeOptions options)
// Output-based functions aren't available in Java yet

Fn::Invoke:
  Function: akamai:index/getGroups:getGroups
  Arguments:
    # Arguments dictionary

getGroups Result

The following output properties are available:

Groups List<GetGroupsGroup>
Id string: The provider-assigned unique ID for this managed resource.

Groups []GetGroupsGroup
Id string: The provider-assigned unique ID for this managed resource.

groups ListGroupsGroup>
id String: The provider-assigned unique ID for this managed resource.

groups GetGroupsGroup[]
id string: The provider-assigned unique ID for this managed resource.

groups Sequence[GetGroupsGroup]
id str: The provider-assigned unique ID for this managed resource.

groups List
id String: The provider-assigned unique ID for this managed resource.

Supporting Types

GetGroupsGroup

ContractIds List<string>
GroupId string
GroupName string
ParentGroupId string

ContractIds []string
GroupId string
GroupName string
ParentGroupId string

contractIds List
groupId String
groupName String
parentGroupId String

contractIds string[]
groupId string
groupName string
parentGroupId string

contract_ids Sequence[str]
group_id str
group_name str
parent_group_id str

contractIds List
groupId String
groupName String
parentGroupId String

Package Details

Repository: https://github.com/pulumi/pulumi-akamai
License: Apache-2.0
Notes: This Pulumi package is based on the akamai Terraform Provider.