Docs Home
Formal v1.0.2 published on Thursday, Aug 14, 2025 by Formal
formal.Group
Explore with Pulumi AI
Creating a Group in Formal.
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,
description: Optional[str] = None,
name: Optional[str] = None,
termination_protection: Optional[bool] = None)func NewGroup(ctx *Context, name string, args GroupArgs, opts ...ResourceOption) (*Group, error)public Group(string name, GroupArgs args, CustomResourceOptions? opts = null)type: formal:Group
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
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 Pulumi.Group("groupResource", new()
{
Description = "string",
Name = "string",
TerminationProtection = false,
});
example, err := formal.NewGroup(ctx, "groupResource", &formal.GroupArgs{
Description: pulumi.String("string"),
Name: pulumi.String("string"),
TerminationProtection: pulumi.Bool(false),
})
var groupResource = new Group("groupResource", GroupArgs.builder()
.description("string")
.name("string")
.terminationProtection(false)
.build());
group_resource = formal.Group("groupResource",
description="string",
name="string",
termination_protection=False)
const groupResource = new formal.Group("groupResource", {
description: "string",
name: "string",
terminationProtection: false,
});
type: formal:Group
properties:
description: string
name: string
terminationProtection: false
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:
- Description string
- Description for this Group.
- Name string
- Friendly Name for this Group.
- Termination
Protection bool - If set to true, this Group cannot be deleted.
- Description string
- Description for this Group.
- Name string
- Friendly Name for this Group.
- Termination
Protection bool - If set to true, this Group cannot be deleted.
- description String
- Description for this Group.
- name String
- Friendly Name for this Group.
- termination
Protection Boolean - If set to true, this Group cannot be deleted.
- description string
- Description for this Group.
- name string
- Friendly Name for this Group.
- termination
Protection boolean - If set to true, this Group cannot be deleted.
- description str
- Description for this Group.
- name str
- Friendly Name for this Group.
- termination_
protection bool - If set to true, this Group cannot be deleted.
- description String
- Description for this Group.
- name String
- Friendly Name for this Group.
- termination
Protection Boolean - If set to true, this Group cannot be deleted.
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 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,
name: Optional[str] = None,
termination_protection: Optional[bool] = 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: _: type: formal:Group get: id: ${id}- name
- The unique name of the resulting resource.
- id
- 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
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- 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
- The unique name of the resulting resource.
- id
- 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
- The unique name of the resulting resource.
- id
- 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.
- Description string
- Description for this Group.
- Name string
- Friendly Name for this Group.
- Termination
Protection bool - If set to true, this Group cannot be deleted.
- Description string
- Description for this Group.
- Name string
- Friendly Name for this Group.
- Termination
Protection bool - If set to true, this Group cannot be deleted.
- description String
- Description for this Group.
- name String
- Friendly Name for this Group.
- termination
Protection Boolean - If set to true, this Group cannot be deleted.
- description string
- Description for this Group.
- name string
- Friendly Name for this Group.
- termination
Protection boolean - If set to true, this Group cannot be deleted.
- description str
- Description for this Group.
- name str
- Friendly Name for this Group.
- termination_
protection bool - If set to true, this Group cannot be deleted.
- description String
- Description for this Group.
- name String
- Friendly Name for this Group.
- termination
Protection Boolean - If set to true, this Group cannot be deleted.
Package Details
- Repository
- formal formalco/pulumi-formal
- License
- MPL-2.0
- Notes
- This Pulumi package is based on the
formalTerraform Provider.