1. Packages
  2. Akamai
  3. API Docs
  4. IamGroup
Akamai v8.0.0 published on Saturday, Mar 1, 2025 by Pulumi

akamai.IamGroup

Explore with Pulumi AI

Create IamGroup Resource

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

Constructor syntax

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

@overload
def IamGroup(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             parent_group_id: Optional[int] = None,
             name: Optional[str] = None)
func NewIamGroup(ctx *Context, name string, args IamGroupArgs, opts ...ResourceOption) (*IamGroup, error)
public IamGroup(string name, IamGroupArgs args, CustomResourceOptions? opts = null)
public IamGroup(String name, IamGroupArgs args)
public IamGroup(String name, IamGroupArgs args, CustomResourceOptions options)
type: akamai:IamGroup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. IamGroupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. IamGroupArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. IamGroupArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. IamGroupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. IamGroupArgs
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 iamGroupResource = new Akamai.IamGroup("iamGroupResource", new()
{
    ParentGroupId = 0,
    Name = "string",
});
Copy
example, err := akamai.NewIamGroup(ctx, "iamGroupResource", &akamai.IamGroupArgs{
	ParentGroupId: pulumi.Int(0),
	Name:          pulumi.String("string"),
})
Copy
var iamGroupResource = new IamGroup("iamGroupResource", IamGroupArgs.builder()
    .parentGroupId(0)
    .name("string")
    .build());
Copy
iam_group_resource = akamai.IamGroup("iamGroupResource",
    parent_group_id=0,
    name="string")
Copy
const iamGroupResource = new akamai.IamGroup("iamGroupResource", {
    parentGroupId: 0,
    name: "string",
});
Copy
type: akamai:IamGroup
properties:
    name: string
    parentGroupId: 0
Copy

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

ParentGroupId This property is required. int
Unique identifier for the parent group.
Name string
Human readable name for a group.
ParentGroupId This property is required. int
Unique identifier for the parent group.
Name string
Human readable name for a group.
parentGroupId This property is required. Integer
Unique identifier for the parent group.
name String
Human readable name for a group.
parentGroupId This property is required. number
Unique identifier for the parent group.
name string
Human readable name for a group.
parent_group_id This property is required. int
Unique identifier for the parent group.
name str
Human readable name for a group.
parentGroupId This property is required. Number
Unique identifier for the parent group.
name String
Human readable name for a group.

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
SubGroups List<int>
Subgroups IDs.
Id string
The provider-assigned unique ID for this managed resource.
SubGroups []int
Subgroups IDs.
id String
The provider-assigned unique ID for this managed resource.
subGroups List<Integer>
Subgroups IDs.
id string
The provider-assigned unique ID for this managed resource.
subGroups number[]
Subgroups IDs.
id str
The provider-assigned unique ID for this managed resource.
sub_groups Sequence[int]
Subgroups IDs.
id String
The provider-assigned unique ID for this managed resource.
subGroups List<Number>
Subgroups IDs.

Look up Existing IamGroup Resource

Get an existing IamGroup 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?: IamGroupState, opts?: CustomResourceOptions): IamGroup
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        name: Optional[str] = None,
        parent_group_id: Optional[int] = None,
        sub_groups: Optional[Sequence[int]] = None) -> IamGroup
func GetIamGroup(ctx *Context, name string, id IDInput, state *IamGroupState, opts ...ResourceOption) (*IamGroup, error)
public static IamGroup Get(string name, Input<string> id, IamGroupState? state, CustomResourceOptions? opts = null)
public static IamGroup get(String name, Output<String> id, IamGroupState state, CustomResourceOptions options)
resources:  _:    type: akamai:IamGroup    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
Name string
Human readable name for a group.
ParentGroupId int
Unique identifier for the parent group.
SubGroups List<int>
Subgroups IDs.
Name string
Human readable name for a group.
ParentGroupId int
Unique identifier for the parent group.
SubGroups []int
Subgroups IDs.
name String
Human readable name for a group.
parentGroupId Integer
Unique identifier for the parent group.
subGroups List<Integer>
Subgroups IDs.
name string
Human readable name for a group.
parentGroupId number
Unique identifier for the parent group.
subGroups number[]
Subgroups IDs.
name str
Human readable name for a group.
parent_group_id int
Unique identifier for the parent group.
sub_groups Sequence[int]
Subgroups IDs.
name String
Human readable name for a group.
parentGroupId Number
Unique identifier for the parent group.
subGroups List<Number>
Subgroups IDs.

Package Details

Repository
Akamai pulumi/pulumi-akamai
License
Apache-2.0
Notes
This Pulumi package is based on the akamai Terraform Provider.