← All packages

Akamai

Pulumi Official

Package maintained by Pulumi

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

Source code

getGroup

Use the akamai.getGroup data source to get a group by name.

Each account features a hierarchy of groups, which control access to your Akamai configurations and help consolidate reporting functions, typically mapping to an organizational hierarchy. Using either Control Center or the Identity Management: User Administration API, account administrators can assign properties to specific groups, each with its own set of users and accompanying roles.

Attributes reference

This data source returns this attribute:

id - The group’s unique ID, including the grp_ prefix.

Example Usage

Coming soon!

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

const exampleGroup = pulumi.output(akamai.getGroup({
    contractId: "",
    "data.akamai_contract.example.id": [{}],
    groupName: "example group name",
}));
const exampleContract = pulumi.output(akamai.getContract({
    groupName: "example group name",
}));
const exampleProperty = new akamai.Property("example", {
    "data.akamai_group.example.id": [{}],
    groupId: "",
});

Coming soon!

Using getGroup

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 getGroup(args: GetGroupArgs, opts?: InvokeOptions): Promise<GetGroupResult>
function getGroupOutput(args: GetGroupOutputArgs, opts?: InvokeOptions): Output<GetGroupResult>

def get_group(contract: Optional[str] = None,
              contract_id: Optional[str] = None,
              group_name: Optional[str] = None,
              name: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetGroupResult
def get_group_output(contract: Optional[pulumi.Input[str]] = None,
              contract_id: Optional[pulumi.Input[str]] = None,
              group_name: Optional[pulumi.Input[str]] = None,
              name: Optional[pulumi.Input[str]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetGroupResult]

func GetGroup(ctx *Context, args *GetGroupArgs, opts ...InvokeOption) (*GetGroupResult, error)
func GetGroupOutput(ctx *Context, args *GetGroupOutputArgs, opts ...InvokeOption) GetGroupResultOutput

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

public static class GetGroup 
{
    public static Task<GetGroupResult> InvokeAsync(GetGroupArgs args, InvokeOptions? opts = null)
    public static Output<GetGroupResult> Invoke(GetGroupInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetGroupResult> getGroup(GetGroupArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

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

The following arguments are supported:

Contract string

Replaced by contract_id. Maintained for legacy purposes.

Deprecated:

The setting "contract" has been deprecated.

ContractId string

- (Required) A contract's unique ID, including the ctr_ prefix.

GroupName string

The group name.

Name string

Replaced by group_name. Maintained for legacy purposes.

Deprecated:

The setting "name" has been deprecated.

Contract string

Replaced by contract_id. Maintained for legacy purposes.

Deprecated:

The setting "contract" has been deprecated.

ContractId string

- (Required) A contract's unique ID, including the ctr_ prefix.

GroupName string

The group name.

Name string

Replaced by group_name. Maintained for legacy purposes.

Deprecated:

The setting "name" has been deprecated.

contract String

Replaced by contract_id. Maintained for legacy purposes.

Deprecated:

The setting "contract" has been deprecated.

contractId String

- (Required) A contract's unique ID, including the ctr_ prefix.

groupName String

The group name.

name String

Replaced by group_name. Maintained for legacy purposes.

Deprecated:

The setting "name" has been deprecated.

contract string

Replaced by contract_id. Maintained for legacy purposes.

Deprecated:

The setting "contract" has been deprecated.

contractId string

- (Required) A contract's unique ID, including the ctr_ prefix.

groupName string

The group name.

name string

Replaced by group_name. Maintained for legacy purposes.

Deprecated:

The setting "name" has been deprecated.

contract str

Replaced by contract_id. Maintained for legacy purposes.

Deprecated:

The setting "contract" has been deprecated.

contract_id str

- (Required) A contract's unique ID, including the ctr_ prefix.

group_name str

The group name.

name str

Replaced by group_name. Maintained for legacy purposes.

Deprecated:

The setting "name" has been deprecated.

contract String

Replaced by contract_id. Maintained for legacy purposes.

Deprecated:

The setting "contract" has been deprecated.

contractId String

- (Required) A contract's unique ID, including the ctr_ prefix.

groupName String

The group name.

name String

Replaced by group_name. Maintained for legacy purposes.

Deprecated:

The setting "name" has been deprecated.

getGroup Result

The following output properties are available:

Contract string

Deprecated:

The setting "contract" has been deprecated.

ContractId string

GroupName string

Id string

The provider-assigned unique ID for this managed resource.

Name string

Deprecated:

The setting "name" has been deprecated.

Contract string

Deprecated:

The setting "contract" has been deprecated.

ContractId string

GroupName string

Id string

The provider-assigned unique ID for this managed resource.

Name string

Deprecated:

The setting "name" has been deprecated.

contract String

Deprecated:

The setting "contract" has been deprecated.

contractId String

groupName String

id String

The provider-assigned unique ID for this managed resource.

name String

Deprecated:

The setting "name" has been deprecated.

contract string

Deprecated:

The setting "contract" has been deprecated.

contractId string

groupName string

id string

The provider-assigned unique ID for this managed resource.

name string

Deprecated:

The setting "name" has been deprecated.

contract str

Deprecated:

The setting "contract" has been deprecated.

contract_id str

group_name str

id str

The provider-assigned unique ID for this managed resource.

name str

Deprecated:

The setting "name" has been deprecated.

contract String

Deprecated:

The setting "contract" has been deprecated.

contractId String

groupName String

id String

The provider-assigned unique ID for this managed resource.

name String

Deprecated:

The setting "name" has been deprecated.

Package Details

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

Akamai

getGroup

Attributes reference

Example Usage

Using getGroup

getGroup Result

Package Details

Contents