pulumi-newrelic 5.19.0a1708065288__py3-none-any.whl → 5.20.0__py3-none-any.whl

pulumi_newrelic/group.py

@@ -0,0 +1,412 @@
+# coding=utf-8
+# *** WARNING: this file was generated by the Pulumi Terraform Bridge (tfgen) Tool. ***
+# *** Do not edit by hand unless you're certain you know what you are doing! ***
+
+import copy
+import warnings
+import pulumi
+import pulumi.runtime
+from typing import Any, Mapping, Optional, Sequence, Union, overload
+from . import _utilities
+
+__all__ = ['GroupArgs', 'Group']
+
+@pulumi.input_type
+class GroupArgs:
+    def __init__(__self__, *,
+                 authentication_domain_id: pulumi.Input[str],
+                 name: Optional[pulumi.Input[str]] = None,
+                 user_ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None):
+        """
+        The set of arguments for constructing a Group resource.
+        :param pulumi.Input[str] authentication_domain_id: The ID of the authentication domain to which the group to be created would belong.
+        :param pulumi.Input[str] name: The name of the group to be created.
+        :param pulumi.Input[Sequence[pulumi.Input[str]]] user_ids: 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 `get_authentication_domain`, 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 `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.
+        """
+        pulumi.set(__self__, "authentication_domain_id", authentication_domain_id)
+        if name is not None:
+            pulumi.set(__self__, "name", name)
+        if user_ids is not None:
+            pulumi.set(__self__, "user_ids", user_ids)
+
+    @property
+    @pulumi.getter(name="authenticationDomainId")
+    def authentication_domain_id(self) -> pulumi.Input[str]:
+        """
+        The ID of the authentication domain to which the group to be created would belong.
+        """
+        return pulumi.get(self, "authentication_domain_id")
+
+    @authentication_domain_id.setter
+    def authentication_domain_id(self, value: pulumi.Input[str]):
+        pulumi.set(self, "authentication_domain_id", value)
+
+    @property
+    @pulumi.getter
+    def name(self) -> Optional[pulumi.Input[str]]:
+        """
+        The name of the group to be created.
+        """
+        return pulumi.get(self, "name")
+
+    @name.setter
+    def name(self, value: Optional[pulumi.Input[str]]):
+        pulumi.set(self, "name", value)
+
+    @property
+    @pulumi.getter(name="userIds")
+    def user_ids(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[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 `get_authentication_domain`, 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 `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.
+        """
+        return pulumi.get(self, "user_ids")
+
+    @user_ids.setter
+    def user_ids(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
+        pulumi.set(self, "user_ids", value)
+
+
+@pulumi.input_type
+class _GroupState:
+    def __init__(__self__, *,
+                 authentication_domain_id: Optional[pulumi.Input[str]] = None,
+                 name: Optional[pulumi.Input[str]] = None,
+                 user_ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None):
+        """
+        Input properties used for looking up and filtering Group resources.
+        :param pulumi.Input[str] authentication_domain_id: The ID of the authentication domain to which the group to be created would belong.
+        :param pulumi.Input[str] name: The name of the group to be created.
+        :param pulumi.Input[Sequence[pulumi.Input[str]]] user_ids: 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 `get_authentication_domain`, 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 `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.
+        """
+        if authentication_domain_id is not None:
+            pulumi.set(__self__, "authentication_domain_id", authentication_domain_id)
+        if name is not None:
+            pulumi.set(__self__, "name", name)
+        if user_ids is not None:
+            pulumi.set(__self__, "user_ids", user_ids)
+
+    @property
+    @pulumi.getter(name="authenticationDomainId")
+    def authentication_domain_id(self) -> Optional[pulumi.Input[str]]:
+        """
+        The ID of the authentication domain to which the group to be created would belong.
+        """
+        return pulumi.get(self, "authentication_domain_id")
+
+    @authentication_domain_id.setter
+    def authentication_domain_id(self, value: Optional[pulumi.Input[str]]):
+        pulumi.set(self, "authentication_domain_id", value)
+
+    @property
+    @pulumi.getter
+    def name(self) -> Optional[pulumi.Input[str]]:
+        """
+        The name of the group to be created.
+        """
+        return pulumi.get(self, "name")
+
+    @name.setter
+    def name(self, value: Optional[pulumi.Input[str]]):
+        pulumi.set(self, "name", value)
+
+    @property
+    @pulumi.getter(name="userIds")
+    def user_ids(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[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 `get_authentication_domain`, 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 `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.
+        """
+        return pulumi.get(self, "user_ids")
+
+    @user_ids.setter
+    def user_ids(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
+        pulumi.set(self, "user_ids", value)
+
+
+class Group(pulumi.CustomResource):
+    @overload
+    def __init__(__self__,
+                 resource_name: str,
+                 opts: Optional[pulumi.ResourceOptions] = None,
+                 authentication_domain_id: Optional[pulumi.Input[str]] = None,
+                 name: Optional[pulumi.Input[str]] = None,
+                 user_ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
+                 __props__=None):
+        """
+        The `Group` resource facilitates creating, updating, and deleting groups in New Relic, while also enabling the addition and removal of users from these groups.
+
+        ## Example Usage
+
+        ```python
+        import pulumi
+        import pulumi_newrelic as newrelic
+
+        foo_authentication_domain = newrelic.get_authentication_domain(name="Test Authentication Domain")
+        foo_group = newrelic.Group("fooGroup",
+            authentication_domain_id=foo_authentication_domain.id,
+            user_ids=[
+                "0001112222",
+                "2221110000",
+            ])
+        ```
+        ## Additional Examples
+
+        ### Addition of New Users to a New Group
+
+        The following example illustrates the creation of a group using the `Group` resource, to which users created using the `User` resource are added.
+
+        ```python
+        import pulumi
+        import pulumi_newrelic as newrelic
+
+        foo_authentication_domain = newrelic.get_authentication_domain(name="Test Authentication Domain")
+        foo_user = newrelic.User("fooUser",
+            email_id="test_user_one@test.com",
+            authentication_domain_id=foo_authentication_domain.id,
+            user_type="CORE_USER_TIER")
+        bar = newrelic.User("bar",
+            email_id="test_user_two@test.com",
+            authentication_domain_id=foo_authentication_domain.id,
+            user_type="BASIC_USER_TIER")
+        foo_group = newrelic.Group("fooGroup",
+            authentication_domain_id=foo_authentication_domain.id,
+            user_ids=[
+                foo_user.id,
+                bar.id,
+            ])
+        ```
+
+        ### Addition of Existing Users to a New Group
+
+        The following example demonstrates the usage of the `Group` resource to create a group, wherein the `User` data source is employed to associate existing users with the newly formed group.
+
+        ```python
+        import pulumi
+        import pulumi_newrelic as newrelic
+
+        foo_authentication_domain = newrelic.get_authentication_domain(name="Test Authentication Domain")
+        foo_user = newrelic.get_user(authentication_domain_id=foo_authentication_domain.id,
+            email_id="test_user_one@test.com")
+        bar = newrelic.get_user(authentication_domain_id=foo_authentication_domain.id,
+            name="Test User Two")
+        foo_group = newrelic.Group("fooGroup",
+            authentication_domain_id=foo_authentication_domain.id,
+            user_ids=[
+                foo_user.id,
+                bar.id,
+            ])
+        ```
+
+        > **NOTE** Please note that the addition of users to groups is only possible when both the group and the users to be added to it belong to the _same authentication domain_. If the group being created and the users being added to it belong to different authentication domains, an error indicating `user not found` or an equivalent error will be thrown.
+
+        ## Import
+
+        A group can be imported using its ID. Example:
+
+        ```sh
+        $ pulumi import newrelic:index/group:Group foo <group_id>
+        ```
+
+        :param str resource_name: The name of the resource.
+        :param pulumi.ResourceOptions opts: Options for the resource.
+        :param pulumi.Input[str] authentication_domain_id: The ID of the authentication domain to which the group to be created would belong.
+        :param pulumi.Input[str] name: The name of the group to be created.
+        :param pulumi.Input[Sequence[pulumi.Input[str]]] user_ids: 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 `get_authentication_domain`, 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 `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.
+        """
+        ...
+    @overload
+    def __init__(__self__,
+                 resource_name: str,
+                 args: GroupArgs,
+                 opts: Optional[pulumi.ResourceOptions] = None):
+        """
+        The `Group` resource facilitates creating, updating, and deleting groups in New Relic, while also enabling the addition and removal of users from these groups.
+
+        ## Example Usage
+
+        ```python
+        import pulumi
+        import pulumi_newrelic as newrelic
+
+        foo_authentication_domain = newrelic.get_authentication_domain(name="Test Authentication Domain")
+        foo_group = newrelic.Group("fooGroup",
+            authentication_domain_id=foo_authentication_domain.id,
+            user_ids=[
+                "0001112222",
+                "2221110000",
+            ])
+        ```
+        ## Additional Examples
+
+        ### Addition of New Users to a New Group
+
+        The following example illustrates the creation of a group using the `Group` resource, to which users created using the `User` resource are added.
+
+        ```python
+        import pulumi
+        import pulumi_newrelic as newrelic
+
+        foo_authentication_domain = newrelic.get_authentication_domain(name="Test Authentication Domain")
+        foo_user = newrelic.User("fooUser",
+            email_id="test_user_one@test.com",
+            authentication_domain_id=foo_authentication_domain.id,
+            user_type="CORE_USER_TIER")
+        bar = newrelic.User("bar",
+            email_id="test_user_two@test.com",
+            authentication_domain_id=foo_authentication_domain.id,
+            user_type="BASIC_USER_TIER")
+        foo_group = newrelic.Group("fooGroup",
+            authentication_domain_id=foo_authentication_domain.id,
+            user_ids=[
+                foo_user.id,
+                bar.id,
+            ])
+        ```
+
+        ### Addition of Existing Users to a New Group
+
+        The following example demonstrates the usage of the `Group` resource to create a group, wherein the `User` data source is employed to associate existing users with the newly formed group.
+
+        ```python
+        import pulumi
+        import pulumi_newrelic as newrelic
+
+        foo_authentication_domain = newrelic.get_authentication_domain(name="Test Authentication Domain")
+        foo_user = newrelic.get_user(authentication_domain_id=foo_authentication_domain.id,
+            email_id="test_user_one@test.com")
+        bar = newrelic.get_user(authentication_domain_id=foo_authentication_domain.id,
+            name="Test User Two")
+        foo_group = newrelic.Group("fooGroup",
+            authentication_domain_id=foo_authentication_domain.id,
+            user_ids=[
+                foo_user.id,
+                bar.id,
+            ])
+        ```
+
+        > **NOTE** Please note that the addition of users to groups is only possible when both the group and the users to be added to it belong to the _same authentication domain_. If the group being created and the users being added to it belong to different authentication domains, an error indicating `user not found` or an equivalent error will be thrown.
+
+        ## Import
+
+        A group can be imported using its ID. Example:
+
+        ```sh
+        $ pulumi import newrelic:index/group:Group foo <group_id>
+        ```
+
+        :param str resource_name: The name of the resource.
+        :param GroupArgs args: The arguments to use to populate this resource's properties.
+        :param pulumi.ResourceOptions opts: Options for the resource.
+        """
+        ...
+    def __init__(__self__, resource_name: str, *args, **kwargs):
+        resource_args, opts = _utilities.get_resource_args_opts(GroupArgs, pulumi.ResourceOptions, *args, **kwargs)
+        if resource_args is not None:
+            __self__._internal_init(resource_name, opts, **resource_args.__dict__)
+        else:
+            __self__._internal_init(resource_name, *args, **kwargs)
+
+    def _internal_init(__self__,
+                 resource_name: str,
+                 opts: Optional[pulumi.ResourceOptions] = None,
+                 authentication_domain_id: Optional[pulumi.Input[str]] = None,
+                 name: Optional[pulumi.Input[str]] = None,
+                 user_ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
+                 __props__=None):
+        opts = pulumi.ResourceOptions.merge(_utilities.get_resource_opts_defaults(), opts)
+        if not isinstance(opts, pulumi.ResourceOptions):
+            raise TypeError('Expected resource options to be a ResourceOptions instance')
+        if opts.id is None:
+            if __props__ is not None:
+                raise TypeError('__props__ is only valid when passed in combination with a valid opts.id to get an existing resource')
+            __props__ = GroupArgs.__new__(GroupArgs)
+
+            if authentication_domain_id is None and not opts.urn:
+                raise TypeError("Missing required property 'authentication_domain_id'")
+            __props__.__dict__["authentication_domain_id"] = authentication_domain_id
+            __props__.__dict__["name"] = name
+            __props__.__dict__["user_ids"] = user_ids
+        super(Group, __self__).__init__(
+            'newrelic:index/group:Group',
+            resource_name,
+            __props__,
+            opts)
+
+    @staticmethod
+    def get(resource_name: str,
+            id: pulumi.Input[str],
+            opts: Optional[pulumi.ResourceOptions] = None,
+            authentication_domain_id: Optional[pulumi.Input[str]] = None,
+            name: Optional[pulumi.Input[str]] = None,
+            user_ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None) -> 'Group':
+        """
+        Get an existing Group resource's state with the given name, id, and optional extra
+        properties used to qualify the lookup.
+
+        :param str resource_name: The unique name of the resulting resource.
+        :param pulumi.Input[str] id: The unique provider ID of the resource to lookup.
+        :param pulumi.ResourceOptions opts: Options for the resource.
+        :param pulumi.Input[str] authentication_domain_id: The ID of the authentication domain to which the group to be created would belong.
+        :param pulumi.Input[str] name: The name of the group to be created.
+        :param pulumi.Input[Sequence[pulumi.Input[str]]] user_ids: 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 `get_authentication_domain`, 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 `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.
+        """
+        opts = pulumi.ResourceOptions.merge(opts, pulumi.ResourceOptions(id=id))
+
+        __props__ = _GroupState.__new__(_GroupState)
+
+        __props__.__dict__["authentication_domain_id"] = authentication_domain_id
+        __props__.__dict__["name"] = name
+        __props__.__dict__["user_ids"] = user_ids
+        return Group(resource_name, opts=opts, __props__=__props__)
+
+    @property
+    @pulumi.getter(name="authenticationDomainId")
+    def authentication_domain_id(self) -> pulumi.Output[str]:
+        """
+        The ID of the authentication domain to which the group to be created would belong.
+        """
+        return pulumi.get(self, "authentication_domain_id")
+
+    @property
+    @pulumi.getter
+    def name(self) -> pulumi.Output[str]:
+        """
+        The name of the group to be created.
+        """
+        return pulumi.get(self, "name")
+
+    @property
+    @pulumi.getter(name="userIds")
+    def user_ids(self) -> pulumi.Output[Optional[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 `get_authentication_domain`, 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 `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.
+        """
+        return pulumi.get(self, "user_ids")
+

pulumi_newrelic/notification_channel.py

@@ -398,6 +398,7 @@ class NotificationChannel(pulumi.CustomResource):
                 ),
                 newrelic.NotificationChannelPropertyArgs(
                     key="service",
+                    label="Service Name",
                     value="PTQK3FM",
                 ),
                 newrelic.NotificationChannelPropertyArgs(
@@ -565,6 +566,18 @@ class NotificationChannel(pulumi.CustomResource):
 
         > **NOTE:** `AlertChannel` are legacy resources.
 
+        ## Import
+
+        Channels can only be used by a single workflow, therefore importing them is not particularly useful, because in the UI channels are created upon workflow creation.
+
+         Additionally, the channel id isn't available via the UI, and you'd need to look it up with the `channels` query in the NerdGraph API.
+
+         That being said, importing is possible using -
+
+        ```sh
+        $ pulumi import newrelic:index/notificationChannel:NotificationChannel foo <destination_id>
+        ```
+
         :param str resource_name: The name of the resource.
         :param pulumi.ResourceOptions opts: Options for the resource.
         :param pulumi.Input[int] account_id: Determines the New Relic account where the notification channel will be created. Defaults to the account associated with the API key used.
@@ -701,6 +714,7 @@ class NotificationChannel(pulumi.CustomResource):
                 ),
                 newrelic.NotificationChannelPropertyArgs(
                     key="service",
+                    label="Service Name",
                     value="PTQK3FM",
                 ),
                 newrelic.NotificationChannelPropertyArgs(
@@ -868,6 +882,18 @@ class NotificationChannel(pulumi.CustomResource):
 
         > **NOTE:** `AlertChannel` are legacy resources.
 
+        ## Import
+
+        Channels can only be used by a single workflow, therefore importing them is not particularly useful, because in the UI channels are created upon workflow creation.
+
+         Additionally, the channel id isn't available via the UI, and you'd need to look it up with the `channels` query in the NerdGraph API.
+
+         That being said, importing is possible using -
+
+        ```sh
+        $ pulumi import newrelic:index/notificationChannel:NotificationChannel foo <destination_id>
+        ```
+
         :param str resource_name: The name of the resource.
         :param NotificationChannelArgs args: The arguments to use to populate this resource's properties.
         :param pulumi.ResourceOptions opts: Options for the resource.

pulumi_newrelic/notification_destination.py

@@ -301,7 +301,76 @@ class NotificationDestination(pulumi.CustomResource):
                  type: Optional[pulumi.Input[str]] = None,
                  __props__=None):
         """
-        Create a NotificationDestination resource with the given unique name, props, and options.
+        ## Import
+
+        Destination id can be found in the Destinations page -> three dots at the right of the chosen destination -> copy destination id to clipboard.
+
+         This example is especially useful for slack destinations which *must* be imported.
+
+         1. Add an empty resource to your terraform file:
+
+         terraform
+
+         resource "newrelic_notification_destination" "foo" {
+
+         }
+
+        ```sh
+        $ pulumi import newrelic:index/notificationDestination:NotificationDestination
+
+        Run import command: `newrelic_notification_destination.foo <destination_id>`
+        ```
+
+         3. Run the following command after the import successfully done and copy the information to your resource:
+
+         `terraform state show newrelic_notification_destination.foo`
+
+         4. Add `ignore_changes` attribute on `auth_token` in your imported resource:
+
+         terraform
+
+         lifecycle {
+
+         ignore_changes = [auth_token]
+
+         }
+
+         Your imported destination should look like that:
+
+         terraform
+
+         resource "newrelic_notification_destination" "foo" {
+
+         lifecycle {
+
+         ignore_changes = [auth_token]
+
+         }
+
+         name = "*********"
+
+         type = "SLACK"
+
+         auth_token {
+
+         prefix = "Bearer"
+
+         }
+
+         property {
+
+         key
+
+         = "teamName"
+
+         label = "Team Name"
+
+         value = "******"
+
+         }
+
+         }
+
         :param str resource_name: The name of the resource.
         :param pulumi.ResourceOptions opts: Options for the resource.
         :param pulumi.Input[int] account_id: Determines the New Relic account where the notification destination will be created. Defaults to the account associated with the API key used.
@@ -320,7 +389,76 @@ class NotificationDestination(pulumi.CustomResource):
                  args: NotificationDestinationArgs,
                  opts: Optional[pulumi.ResourceOptions] = None):
         """
-        Create a NotificationDestination resource with the given unique name, props, and options.
+        ## Import
+
+        Destination id can be found in the Destinations page -> three dots at the right of the chosen destination -> copy destination id to clipboard.
+
+         This example is especially useful for slack destinations which *must* be imported.
+
+         1. Add an empty resource to your terraform file:
+
+         terraform
+
+         resource "newrelic_notification_destination" "foo" {
+
+         }
+
+        ```sh
+        $ pulumi import newrelic:index/notificationDestination:NotificationDestination
+
+        Run import command: `newrelic_notification_destination.foo <destination_id>`
+        ```
+
+         3. Run the following command after the import successfully done and copy the information to your resource:
+
+         `terraform state show newrelic_notification_destination.foo`
+
+         4. Add `ignore_changes` attribute on `auth_token` in your imported resource:
+
+         terraform
+
+         lifecycle {
+
+         ignore_changes = [auth_token]
+
+         }
+
+         Your imported destination should look like that:
+
+         terraform
+
+         resource "newrelic_notification_destination" "foo" {
+
+         lifecycle {
+
+         ignore_changes = [auth_token]
+
+         }
+
+         name = "*********"
+
+         type = "SLACK"
+
+         auth_token {
+
+         prefix = "Bearer"
+
+         }
+
+         property {
+
+         key
+
+         = "teamName"
+
+         label = "Team Name"
+
+         value = "******"
+
+         }
+
+         }
+
         :param str resource_name: The name of the resource.
         :param NotificationDestinationArgs args: The arguments to use to populate this resource's properties.
         :param pulumi.ResourceOptions opts: Options for the resource.