published on Thursday, Nov 19, 2026 by akeyless-community
published on Thursday, Nov 19, 2026 by akeyless-community
Group resource
Create Group Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Group(name: string, args: GroupArgs, opts?: CustomResourceOptions);@overload
def Group(resource_name: str,
args: GroupArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Group(resource_name: str,
opts: Optional[ResourceOptions] = None,
group_alias: Optional[str] = None,
user_assignment: Optional[str] = None,
description: Optional[str] = None,
group_id: Optional[str] = None,
name: Optional[str] = None,
retry: Optional[GroupRetryArgs] = None)func NewGroup(ctx *Context, name string, args GroupArgs, opts ...ResourceOption) (*Group, error)public Group(string name, GroupArgs args, CustomResourceOptions? opts = null)type: akeyless:Group
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "akeyless_group" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args GroupArgs
- 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 GroupArgs
- 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 GroupArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args GroupArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args GroupArgs
- 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 groupResource = new Akeyless.Group("groupResource", new()
{
GroupAlias = "string",
UserAssignment = "string",
Description = "string",
GroupId = "string",
Name = "string",
Retry = new Akeyless.Inputs.GroupRetryArgs
{
ErrorMessageRegexes = new[]
{
"string",
},
IntervalSeconds = 0.0,
MaxIntervalSeconds = 0.0,
MaxRetries = 0.0,
RetryOnStatusCodes = new[]
{
0.0,
},
},
});
example, err := akeyless.NewGroup(ctx, "groupResource", &akeyless.GroupArgs{
GroupAlias: pulumi.String("string"),
UserAssignment: pulumi.String("string"),
Description: pulumi.String("string"),
GroupId: pulumi.String("string"),
Name: pulumi.String("string"),
Retry: &akeyless.GroupRetryArgs{
ErrorMessageRegexes: pulumi.StringArray{
pulumi.String("string"),
},
IntervalSeconds: pulumi.Float64(0),
MaxIntervalSeconds: pulumi.Float64(0),
MaxRetries: pulumi.Float64(0),
RetryOnStatusCodes: pulumi.Float64Array{
pulumi.Float64(0),
},
},
})
resource "akeyless_group" "groupResource" {
lifecycle {
create_before_destroy = true
}
group_alias = "string"
user_assignment = "string"
description = "string"
group_id = "string"
name = "string"
retry = {
error_message_regexes = ["string"]
interval_seconds = 0
max_interval_seconds = 0
max_retries = 0
retry_on_status_codes = [0]
}
}
var groupResource = new Group("groupResource", GroupArgs.builder()
.groupAlias("string")
.userAssignment("string")
.description("string")
.groupId("string")
.name("string")
.retry(GroupRetryArgs.builder()
.errorMessageRegexes("string")
.intervalSeconds(0.0)
.maxIntervalSeconds(0.0)
.maxRetries(0.0)
.retryOnStatusCodes(0.0)
.build())
.build());
group_resource = akeyless.Group("groupResource",
group_alias="string",
user_assignment="string",
description="string",
group_id="string",
name="string",
retry={
"error_message_regexes": ["string"],
"interval_seconds": float(0),
"max_interval_seconds": float(0),
"max_retries": float(0),
"retry_on_status_codes": [float(0)],
})
const groupResource = new akeyless.Group("groupResource", {
groupAlias: "string",
userAssignment: "string",
description: "string",
groupId: "string",
name: "string",
retry: {
errorMessageRegexes: ["string"],
intervalSeconds: 0,
maxIntervalSeconds: 0,
maxRetries: 0,
retryOnStatusCodes: [0],
},
});
type: akeyless:Group
properties:
description: string
groupAlias: string
groupId: string
name: string
retry:
errorMessageRegexes:
- string
intervalSeconds: 0
maxIntervalSeconds: 0
maxRetries: 0
retryOnStatusCodes:
- 0
userAssignment: string
Group 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 Group resource accepts the following input properties:
- Group
Alias string - A short group alias
- User
Assignment string - A json array string defining the access permission assignment for this group. Format: [{"accessid":"p-abc123","subclaims":{"email":["user@example.com"]}}]. The accessid is the auth method access ID, and subclaims is a map of claim names to arrays of allowed values.
- Description string
- Description of the object
- Group
Id string - The ID of this resource.
- Name string
- Group name
- Retry
Group
Retry - Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
- Group
Alias string - A short group alias
- User
Assignment string - A json array string defining the access permission assignment for this group. Format: [{"accessid":"p-abc123","subclaims":{"email":["user@example.com"]}}]. The accessid is the auth method access ID, and subclaims is a map of claim names to arrays of allowed values.
- Description string
- Description of the object
- Group
Id string - The ID of this resource.
- Name string
- Group name
- Retry
Group
Retry Args - Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
- group_
alias string - A short group alias
- user_
assignment string - A json array string defining the access permission assignment for this group. Format: [{"accessid":"p-abc123","subclaims":{"email":["user@example.com"]}}]. The accessid is the auth method access ID, and subclaims is a map of claim names to arrays of allowed values.
- description string
- Description of the object
- group_
id string - The ID of this resource.
- name string
- Group name
- retry object
- Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
- group
Alias String - A short group alias
- user
Assignment String - A json array string defining the access permission assignment for this group. Format: [{"accessid":"p-abc123","subclaims":{"email":["user@example.com"]}}]. The accessid is the auth method access ID, and subclaims is a map of claim names to arrays of allowed values.
- description String
- Description of the object
- group
Id String - The ID of this resource.
- name String
- Group name
- retry
Group
Retry - Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
- group
Alias string - A short group alias
- user
Assignment string - A json array string defining the access permission assignment for this group. Format: [{"accessid":"p-abc123","subclaims":{"email":["user@example.com"]}}]. The accessid is the auth method access ID, and subclaims is a map of claim names to arrays of allowed values.
- description string
- Description of the object
- group
Id string - The ID of this resource.
- name string
- Group name
- retry
Group
Retry - Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
- group_
alias str - A short group alias
- user_
assignment str - A json array string defining the access permission assignment for this group. Format: [{"accessid":"p-abc123","subclaims":{"email":["user@example.com"]}}]. The accessid is the auth method access ID, and subclaims is a map of claim names to arrays of allowed values.
- description str
- Description of the object
- group_
id str - The ID of this resource.
- name str
- Group name
- retry
Group
Retry Args - Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
- group
Alias String - A short group alias
- user
Assignment String - A json array string defining the access permission assignment for this group. Format: [{"accessid":"p-abc123","subclaims":{"email":["user@example.com"]}}]. The accessid is the auth method access ID, and subclaims is a map of claim names to arrays of allowed values.
- description String
- Description of the object
- group
Id String - The ID of this resource.
- name String
- Group name
- retry Property Map
- Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
Outputs
All input properties are implicitly available as output properties. Additionally, the Group resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id str
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
Look up Existing Group Resource
Get an existing Group 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?: GroupState, opts?: CustomResourceOptions): Group@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
description: Optional[str] = None,
group_alias: Optional[str] = None,
group_id: Optional[str] = None,
name: Optional[str] = None,
retry: Optional[GroupRetryArgs] = None,
user_assignment: Optional[str] = None) -> Groupfunc GetGroup(ctx *Context, name string, id IDInput, state *GroupState, opts ...ResourceOption) (*Group, error)public static Group Get(string name, Input<string> id, GroupState? state, CustomResourceOptions? opts = null)public static Group get(String name, Output<String> id, GroupState state, CustomResourceOptions options)resources: existingGroup: type: akeyless:Group get: id: ${id}import {
to = akeyless_group.example
id = "${id}"
}
- name string
- The unique name of the resulting resource.
- id Input<ID>
- The unique provider ID of the resource to look up.
- state GroupState
- Known property values the provider needs, along with the ID, to find the resource. Usually not required.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resulting resource.
- id str
- The unique provider ID of the resource to look up.
- 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 resulting resource.
- id IDInput
- The unique provider ID of the resource to look up.
- state GroupState
- Known property values the provider needs, along with the ID, to find the resource. Usually not required.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resulting resource.
- id Input<string>
- The unique provider ID of the resource to look up.
- state GroupState
- Known property values the provider needs, along with the ID, to find the resource. Usually not required.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resulting resource.
- id Output<String>
- The unique provider ID of the resource to look up.
- state GroupState
- Known property values the provider needs, along with the ID, to find the resource. Usually not required.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
- Description string
- Description of the object
- Group
Alias string - A short group alias
- Group
Id string - The ID of this resource.
- Name string
- Group name
- Retry
Group
Retry - Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
- User
Assignment string - A json array string defining the access permission assignment for this group. Format: [{"accessid":"p-abc123","subclaims":{"email":["user@example.com"]}}]. The accessid is the auth method access ID, and subclaims is a map of claim names to arrays of allowed values.
- Description string
- Description of the object
- Group
Alias string - A short group alias
- Group
Id string - The ID of this resource.
- Name string
- Group name
- Retry
Group
Retry Args - Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
- User
Assignment string - A json array string defining the access permission assignment for this group. Format: [{"accessid":"p-abc123","subclaims":{"email":["user@example.com"]}}]. The accessid is the auth method access ID, and subclaims is a map of claim names to arrays of allowed values.
- description string
- Description of the object
- group_
alias string - A short group alias
- group_
id string - The ID of this resource.
- name string
- Group name
- retry object
- Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
- user_
assignment string - A json array string defining the access permission assignment for this group. Format: [{"accessid":"p-abc123","subclaims":{"email":["user@example.com"]}}]. The accessid is the auth method access ID, and subclaims is a map of claim names to arrays of allowed values.
- description String
- Description of the object
- group
Alias String - A short group alias
- group
Id String - The ID of this resource.
- name String
- Group name
- retry
Group
Retry - Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
- user
Assignment String - A json array string defining the access permission assignment for this group. Format: [{"accessid":"p-abc123","subclaims":{"email":["user@example.com"]}}]. The accessid is the auth method access ID, and subclaims is a map of claim names to arrays of allowed values.
- description string
- Description of the object
- group
Alias string - A short group alias
- group
Id string - The ID of this resource.
- name string
- Group name
- retry
Group
Retry - Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
- user
Assignment string - A json array string defining the access permission assignment for this group. Format: [{"accessid":"p-abc123","subclaims":{"email":["user@example.com"]}}]. The accessid is the auth method access ID, and subclaims is a map of claim names to arrays of allowed values.
- description str
- Description of the object
- group_
alias str - A short group alias
- group_
id str - The ID of this resource.
- name str
- Group name
- retry
Group
Retry Args - Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
- user_
assignment str - A json array string defining the access permission assignment for this group. Format: [{"accessid":"p-abc123","subclaims":{"email":["user@example.com"]}}]. The accessid is the auth method access ID, and subclaims is a map of claim names to arrays of allowed values.
- description String
- Description of the object
- group
Alias String - A short group alias
- group
Id String - The ID of this resource.
- name String
- Group name
- retry Property Map
- Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
- user
Assignment String - A json array string defining the access permission assignment for this group. Format: [{"accessid":"p-abc123","subclaims":{"email":["user@example.com"]}}]. The accessid is the auth method access ID, and subclaims is a map of claim names to arrays of allowed values.
Supporting Types
GroupRetry, GroupRetryArgs
- Error
Message List<string>Regexes - Regular expressions matched against the error message. If any matches, the operation is retried.
- Interval
Seconds double - Wait before the first retry, in seconds. The wait doubles on each retry.
- Max
Interval doubleSeconds - Maximum wait between retries, in seconds.
- Max
Retries double - Maximum number of retries after the first attempt.
- Retry
On List<double>Status Codes - HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
- Error
Message []stringRegexes - Regular expressions matched against the error message. If any matches, the operation is retried.
- Interval
Seconds float64 - Wait before the first retry, in seconds. The wait doubles on each retry.
- Max
Interval float64Seconds - Maximum wait between retries, in seconds.
- Max
Retries float64 - Maximum number of retries after the first attempt.
- Retry
On []float64Status Codes - HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
- error_
message_ list(string)regexes - Regular expressions matched against the error message. If any matches, the operation is retried.
- interval_
seconds number - Wait before the first retry, in seconds. The wait doubles on each retry.
- max_
interval_ numberseconds - Maximum wait between retries, in seconds.
- max_
retries number - Maximum number of retries after the first attempt.
- retry_
on_ list(number)status_ codes - HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
- error
Message List<String>Regexes - Regular expressions matched against the error message. If any matches, the operation is retried.
- interval
Seconds Double - Wait before the first retry, in seconds. The wait doubles on each retry.
- max
Interval DoubleSeconds - Maximum wait between retries, in seconds.
- max
Retries Double - Maximum number of retries after the first attempt.
- retry
On List<Double>Status Codes - HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
- error
Message string[]Regexes - Regular expressions matched against the error message. If any matches, the operation is retried.
- interval
Seconds number - Wait before the first retry, in seconds. The wait doubles on each retry.
- max
Interval numberSeconds - Maximum wait between retries, in seconds.
- max
Retries number - Maximum number of retries after the first attempt.
- retry
On number[]Status Codes - HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
- error_
message_ Sequence[str]regexes - Regular expressions matched against the error message. If any matches, the operation is retried.
- interval_
seconds float - Wait before the first retry, in seconds. The wait doubles on each retry.
- max_
interval_ floatseconds - Maximum wait between retries, in seconds.
- max_
retries float - Maximum number of retries after the first attempt.
- retry_
on_ Sequence[float]status_ codes - HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
- error
Message List<String>Regexes - Regular expressions matched against the error message. If any matches, the operation is retried.
- interval
Seconds Number - Wait before the first retry, in seconds. The wait doubles on each retry.
- max
Interval NumberSeconds - Maximum wait between retries, in seconds.
- max
Retries Number - Maximum number of retries after the first attempt.
- retry
On List<Number>Status Codes - HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
Package Details
- Repository
- akeyless akeyless-community/terraform-provider-akeyless
- License
- Notes
- This Pulumi package is based on the
akeylessTerraform Provider.
published on Thursday, Nov 19, 2026 by akeyless-community