1. Packages
  2. Newrelic Provider
  3. API Docs
  4. Group
New Relic v5.44.0 published on Saturday, Mar 29, 2025 by Pulumi

newrelic.Group

Explore with Pulumi AI

Import

A group can be imported using its ID. Example:

$ pulumi import newrelic:index/group:Group foo <group_id>
Copy

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,
          authentication_domain_id: Optional[str] = None,
          name: Optional[str] = None,
          user_ids: Optional[Sequence[str]] = None)
func NewGroup(ctx *Context, name string, args GroupArgs, opts ...ResourceOption) (*Group, error)
public Group(string name, GroupArgs args, CustomResourceOptions? opts = null)
public Group(String name, GroupArgs args)
public Group(String name, GroupArgs args, CustomResourceOptions options)
type: newrelic:Group
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. GroupArgs
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. 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 This property is required. string
The unique name of the resource.
args This property is required. GroupArgs
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. GroupArgs
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. 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 NewRelic.Group("groupResource", new()
{
    AuthenticationDomainId = "string",
    Name = "string",
    UserIds = new[]
    {
        "string",
    },
});
Copy
example, err := newrelic.NewGroup(ctx, "groupResource", &newrelic.GroupArgs{
	AuthenticationDomainId: pulumi.String("string"),
	Name:                   pulumi.String("string"),
	UserIds: pulumi.StringArray{
		pulumi.String("string"),
	},
})
Copy
var groupResource = new Group("groupResource", GroupArgs.builder()
    .authenticationDomainId("string")
    .name("string")
    .userIds("string")
    .build());
Copy
group_resource = newrelic.Group("groupResource",
    authentication_domain_id="string",
    name="string",
    user_ids=["string"])
Copy
const groupResource = new newrelic.Group("groupResource", {
    authenticationDomainId: "string",
    name: "string",
    userIds: ["string"],
});
Copy
type: newrelic:Group
properties:
    authenticationDomainId: string
    name: string
    userIds:
        - string
Copy

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:

AuthenticationDomainId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the authentication domain to which the group to be created would belong.
Name string
The name of the group to be created.
UserIds List<string>

A list of IDs of users to be included in the group to be created.

NOTE The ID of an authentication domain can be retrieved using its name, via the data source newrelic.getAuthenticationDomain, as shown in the example above. Head over to the documentation of this data source for more details and examples.

WARNING: Changing the authentication_domain_id of a newrelic.Group resource that has already been applied would result in a replacement of the resource – destruction of the existing resource, followed by the addition of a new resource with the specified configuration. This is due to the fact that updating the authentication_domain_id of an existing group is not supported.

AuthenticationDomainId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the authentication domain to which the group to be created would belong.
Name string
The name of the group to be created.
UserIds []string

A list of IDs of users to be included in the group to be created.

NOTE The ID of an authentication domain can be retrieved using its name, via the data source newrelic.getAuthenticationDomain, as shown in the example above. Head over to the documentation of this data source for more details and examples.

WARNING: Changing the authentication_domain_id of a newrelic.Group resource that has already been applied would result in a replacement of the resource – destruction of the existing resource, followed by the addition of a new resource with the specified configuration. This is due to the fact that updating the authentication_domain_id of an existing group is not supported.

authenticationDomainId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the authentication domain to which the group to be created would belong.
name String
The name of the group to be created.
userIds List<String>

A list of IDs of users to be included in the group to be created.

NOTE The ID of an authentication domain can be retrieved using its name, via the data source newrelic.getAuthenticationDomain, as shown in the example above. Head over to the documentation of this data source for more details and examples.

WARNING: Changing the authentication_domain_id of a newrelic.Group resource that has already been applied would result in a replacement of the resource – destruction of the existing resource, followed by the addition of a new resource with the specified configuration. This is due to the fact that updating the authentication_domain_id of an existing group is not supported.

authenticationDomainId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the authentication domain to which the group to be created would belong.
name string
The name of the group to be created.
userIds string[]

A list of IDs of users to be included in the group to be created.

NOTE The ID of an authentication domain can be retrieved using its name, via the data source newrelic.getAuthenticationDomain, as shown in the example above. Head over to the documentation of this data source for more details and examples.

WARNING: Changing the authentication_domain_id of a newrelic.Group resource that has already been applied would result in a replacement of the resource – destruction of the existing resource, followed by the addition of a new resource with the specified configuration. This is due to the fact that updating the authentication_domain_id of an existing group is not supported.

authentication_domain_id
This property is required.
Changes to this property will trigger replacement.
str
The ID of the authentication domain to which the group to be created would belong.
name str
The name of the group to be created.
user_ids Sequence[str]

A list of IDs of users to be included in the group to be created.

NOTE The ID of an authentication domain can be retrieved using its name, via the data source newrelic.getAuthenticationDomain, as shown in the example above. Head over to the documentation of this data source for more details and examples.

WARNING: Changing the authentication_domain_id of a newrelic.Group resource that has already been applied would result in a replacement of the resource – destruction of the existing resource, followed by the addition of a new resource with the specified configuration. This is due to the fact that updating the authentication_domain_id of an existing group is not supported.

authenticationDomainId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the authentication domain to which the group to be created would belong.
name String
The name of the group to be created.
userIds List<String>

A list of IDs of users to be included in the group to be created.

NOTE The ID of an authentication domain can be retrieved using its name, via the data source newrelic.getAuthenticationDomain, as shown in the example above. Head over to the documentation of this data source for more details and examples.

WARNING: Changing the authentication_domain_id of a newrelic.Group resource that has already been applied would result in a replacement of the resource – destruction of the existing resource, followed by the addition of a new resource with the specified configuration. This is due to the fact that updating the authentication_domain_id of an existing group is not supported.

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,
        authentication_domain_id: Optional[str] = None,
        name: Optional[str] = None,
        user_ids: Optional[Sequence[str]] = None) -> Group
func 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: newrelic:Group    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:
AuthenticationDomainId Changes to this property will trigger replacement. string
The ID of the authentication domain to which the group to be created would belong.
Name string
The name of the group to be created.
UserIds List<string>

A list of IDs of users to be included in the group to be created.

NOTE The ID of an authentication domain can be retrieved using its name, via the data source newrelic.getAuthenticationDomain, as shown in the example above. Head over to the documentation of this data source for more details and examples.

WARNING: Changing the authentication_domain_id of a newrelic.Group resource that has already been applied would result in a replacement of the resource – destruction of the existing resource, followed by the addition of a new resource with the specified configuration. This is due to the fact that updating the authentication_domain_id of an existing group is not supported.

AuthenticationDomainId Changes to this property will trigger replacement. string
The ID of the authentication domain to which the group to be created would belong.
Name string
The name of the group to be created.
UserIds []string

A list of IDs of users to be included in the group to be created.

NOTE The ID of an authentication domain can be retrieved using its name, via the data source newrelic.getAuthenticationDomain, as shown in the example above. Head over to the documentation of this data source for more details and examples.

WARNING: Changing the authentication_domain_id of a newrelic.Group resource that has already been applied would result in a replacement of the resource – destruction of the existing resource, followed by the addition of a new resource with the specified configuration. This is due to the fact that updating the authentication_domain_id of an existing group is not supported.

authenticationDomainId Changes to this property will trigger replacement. String
The ID of the authentication domain to which the group to be created would belong.
name String
The name of the group to be created.
userIds List<String>

A list of IDs of users to be included in the group to be created.

NOTE The ID of an authentication domain can be retrieved using its name, via the data source newrelic.getAuthenticationDomain, as shown in the example above. Head over to the documentation of this data source for more details and examples.

WARNING: Changing the authentication_domain_id of a newrelic.Group resource that has already been applied would result in a replacement of the resource – destruction of the existing resource, followed by the addition of a new resource with the specified configuration. This is due to the fact that updating the authentication_domain_id of an existing group is not supported.

authenticationDomainId Changes to this property will trigger replacement. string
The ID of the authentication domain to which the group to be created would belong.
name string
The name of the group to be created.
userIds string[]

A list of IDs of users to be included in the group to be created.

NOTE The ID of an authentication domain can be retrieved using its name, via the data source newrelic.getAuthenticationDomain, as shown in the example above. Head over to the documentation of this data source for more details and examples.

WARNING: Changing the authentication_domain_id of a newrelic.Group resource that has already been applied would result in a replacement of the resource – destruction of the existing resource, followed by the addition of a new resource with the specified configuration. This is due to the fact that updating the authentication_domain_id of an existing group is not supported.

authentication_domain_id Changes to this property will trigger replacement. str
The ID of the authentication domain to which the group to be created would belong.
name str
The name of the group to be created.
user_ids Sequence[str]

A list of IDs of users to be included in the group to be created.

NOTE The ID of an authentication domain can be retrieved using its name, via the data source newrelic.getAuthenticationDomain, as shown in the example above. Head over to the documentation of this data source for more details and examples.

WARNING: Changing the authentication_domain_id of a newrelic.Group resource that has already been applied would result in a replacement of the resource – destruction of the existing resource, followed by the addition of a new resource with the specified configuration. This is due to the fact that updating the authentication_domain_id of an existing group is not supported.

authenticationDomainId Changes to this property will trigger replacement. String
The ID of the authentication domain to which the group to be created would belong.
name String
The name of the group to be created.
userIds List<String>

A list of IDs of users to be included in the group to be created.

NOTE The ID of an authentication domain can be retrieved using its name, via the data source newrelic.getAuthenticationDomain, as shown in the example above. Head over to the documentation of this data source for more details and examples.

WARNING: Changing the authentication_domain_id of a newrelic.Group resource that has already been applied would result in a replacement of the resource – destruction of the existing resource, followed by the addition of a new resource with the specified configuration. This is due to the fact that updating the authentication_domain_id of an existing group is not supported.

Package Details

Repository
New Relic pulumi/pulumi-newrelic
License
Apache-2.0
Notes
This Pulumi package is based on the newrelic Terraform Provider.