pulumi-newrelic 5.20.0a1709365820__py3-none-any.whl → 5.21.0__py3-none-any.whl

pulumi_newrelic/get_group.py

@@ -0,0 +1,145 @@
+# 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__ = [
+    'GetGroupResult',
+    'AwaitableGetGroupResult',
+    'get_group',
+    'get_group_output',
+]
+
+@pulumi.output_type
+class GetGroupResult:
+    """
+    A collection of values returned by getGroup.
+    """
+    def __init__(__self__, authentication_domain_id=None, id=None, name=None, user_ids=None):
+        if authentication_domain_id and not isinstance(authentication_domain_id, str):
+            raise TypeError("Expected argument 'authentication_domain_id' to be a str")
+        pulumi.set(__self__, "authentication_domain_id", authentication_domain_id)
+        if id and not isinstance(id, str):
+            raise TypeError("Expected argument 'id' to be a str")
+        pulumi.set(__self__, "id", id)
+        if name and not isinstance(name, str):
+            raise TypeError("Expected argument 'name' to be a str")
+        pulumi.set(__self__, "name", name)
+        if user_ids and not isinstance(user_ids, list):
+            raise TypeError("Expected argument 'user_ids' to be a list")
+        pulumi.set(__self__, "user_ids", user_ids)
+
+    @property
+    @pulumi.getter(name="authenticationDomainId")
+    def authentication_domain_id(self) -> str:
+        return pulumi.get(self, "authentication_domain_id")
+
+    @property
+    @pulumi.getter
+    def id(self) -> str:
+        """
+        The ID of the fetched matching group.
+        """
+        return pulumi.get(self, "id")
+
+    @property
+    @pulumi.getter
+    def name(self) -> str:
+        return pulumi.get(self, "name")
+
+    @property
+    @pulumi.getter(name="userIds")
+    def user_ids(self) -> Sequence[str]:
+        """
+        IDs of users who belong to the group. In the absence of any users in the group, the value of this attribute would be an empty list.
+        """
+        return pulumi.get(self, "user_ids")
+
+
+class AwaitableGetGroupResult(GetGroupResult):
+    # pylint: disable=using-constant-test
+    def __await__(self):
+        if False:
+            yield self
+        return GetGroupResult(
+            authentication_domain_id=self.authentication_domain_id,
+            id=self.id,
+            name=self.name,
+            user_ids=self.user_ids)
+
+
+def get_group(authentication_domain_id: Optional[str] = None,
+              name: Optional[str] = None,
+              opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetGroupResult:
+    """
+    The `Group` data source helps search for a group by its name and retrieve the ID of the matching group and other associated attributes.
+
+    ## Example Usage
+
+    The below example illustrates fetching the ID of a group (and IDs of users who belong to the group, if any) using the required arguments.
+
+    <!--Start PulumiCodeChooser -->
+    ```python
+    import pulumi
+    import pulumi_newrelic as newrelic
+
+    foo_authentication_domain = newrelic.get_authentication_domain(name="Test Authentication Domain")
+    foo_group = newrelic.get_group(authentication_domain_id=foo_authentication_domain.id,
+        name="Test Group")
+    ```
+    <!--End PulumiCodeChooser -->
+
+
+    :param str authentication_domain_id: The ID of the authentication domain the group to be searched for belongs to.
+    :param str name: The name of the group to search for.
+           
+           > **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.
+    """
+    __args__ = dict()
+    __args__['authenticationDomainId'] = authentication_domain_id
+    __args__['name'] = name
+    opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
+    __ret__ = pulumi.runtime.invoke('newrelic:index/getGroup:getGroup', __args__, opts=opts, typ=GetGroupResult).value
+
+    return AwaitableGetGroupResult(
+        authentication_domain_id=pulumi.get(__ret__, 'authentication_domain_id'),
+        id=pulumi.get(__ret__, 'id'),
+        name=pulumi.get(__ret__, 'name'),
+        user_ids=pulumi.get(__ret__, 'user_ids'))
+
+
+@_utilities.lift_output_func(get_group)
+def get_group_output(authentication_domain_id: Optional[pulumi.Input[str]] = None,
+                     name: Optional[pulumi.Input[str]] = None,
+                     opts: Optional[pulumi.InvokeOptions] = None) -> pulumi.Output[GetGroupResult]:
+    """
+    The `Group` data source helps search for a group by its name and retrieve the ID of the matching group and other associated attributes.
+
+    ## Example Usage
+
+    The below example illustrates fetching the ID of a group (and IDs of users who belong to the group, if any) using the required arguments.
+
+    <!--Start PulumiCodeChooser -->
+    ```python
+    import pulumi
+    import pulumi_newrelic as newrelic
+
+    foo_authentication_domain = newrelic.get_authentication_domain(name="Test Authentication Domain")
+    foo_group = newrelic.get_group(authentication_domain_id=foo_authentication_domain.id,
+        name="Test Group")
+    ```
+    <!--End PulumiCodeChooser -->
+
+
+    :param str authentication_domain_id: The ID of the authentication domain the group to be searched for belongs to.
+    :param str name: The name of the group to search for.
+           
+           > **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.
+    """
+    ...

pulumi_newrelic/get_key_transaction.py

@@ -60,6 +60,7 @@ def get_key_transaction(name: Optional[str] = None,
 
     ## Example Usage
 
+    <!--Start PulumiCodeChooser -->
     ```python
     import pulumi
     import pulumi_newrelic as newrelic
@@ -80,6 +81,7 @@ def get_key_transaction(name: Optional[str] = None,
             time_function="all",
         )])
     ```
+    <!--End PulumiCodeChooser -->
 
 
     :param str name: The name of the key transaction in New Relic.
@@ -102,6 +104,7 @@ def get_key_transaction_output(name: Optional[pulumi.Input[str]] = None,
 
     ## Example Usage
 
+    <!--Start PulumiCodeChooser -->
     ```python
     import pulumi
     import pulumi_newrelic as newrelic
@@ -122,6 +125,7 @@ def get_key_transaction_output(name: Optional[pulumi.Input[str]] = None,
             time_function="all",
         )])
     ```
+    <!--End PulumiCodeChooser -->
 
 
     :param str name: The name of the key transaction in New Relic.

pulumi_newrelic/get_notification_destination.py

@@ -22,13 +22,16 @@ class GetNotificationDestinationResult:
     """
     A collection of values returned by getNotificationDestination.
     """
-    def __init__(__self__, account_id=None, active=None, id=None, name=None, properties=None, status=None, type=None):
+    def __init__(__self__, account_id=None, active=None, guid=None, id=None, name=None, properties=None, status=None, type=None):
         if account_id and not isinstance(account_id, int):
             raise TypeError("Expected argument 'account_id' to be a int")
         pulumi.set(__self__, "account_id", account_id)
         if active and not isinstance(active, bool):
             raise TypeError("Expected argument 'active' to be a bool")
         pulumi.set(__self__, "active", active)
+        if guid and not isinstance(guid, str):
+            raise TypeError("Expected argument 'guid' to be a str")
+        pulumi.set(__self__, "guid", guid)
         if id and not isinstance(id, str):
             raise TypeError("Expected argument 'id' to be a str")
         pulumi.set(__self__, "id", id)
@@ -58,6 +61,14 @@ class GetNotificationDestinationResult:
         """
         return pulumi.get(self, "active")
 
+    @property
+    @pulumi.getter
+    def guid(self) -> str:
+        """
+        The unique entity identifier of the destination in New Relic.
+        """
+        return pulumi.get(self, "guid")
+
     @property
     @pulumi.getter
     def id(self) -> Optional[str]:
@@ -104,6 +115,7 @@ class AwaitableGetNotificationDestinationResult(GetNotificationDestinationResult
         return GetNotificationDestinationResult(
             account_id=self.account_id,
             active=self.active,
+            guid=self.guid,
             id=self.id,
             name=self.name,
             properties=self.properties,
@@ -134,6 +146,7 @@ def get_notification_destination(account_id: Optional[int] = None,
     return AwaitableGetNotificationDestinationResult(
         account_id=pulumi.get(__ret__, 'account_id'),
         active=pulumi.get(__ret__, 'active'),
+        guid=pulumi.get(__ret__, 'guid'),
         id=pulumi.get(__ret__, 'id'),
         name=pulumi.get(__ret__, 'name'),
         properties=pulumi.get(__ret__, 'properties'),

pulumi_newrelic/get_obfuscation_expression.py

@@ -70,6 +70,7 @@ def get_obfuscation_expression(account_id: Optional[int] = None,
 
     ## Example Usage
 
+    <!--Start PulumiCodeChooser -->
     ```python
     import pulumi
     import pulumi_newrelic as newrelic
@@ -86,6 +87,7 @@ def get_obfuscation_expression(account_id: Optional[int] = None,
             method="MASK",
         )])
     ```
+    <!--End PulumiCodeChooser -->
 
 
     :param int account_id: The account id associated with the obfuscation expression. If left empty will default to account ID specified in provider level configuration.
@@ -112,6 +114,7 @@ def get_obfuscation_expression_output(account_id: Optional[pulumi.Input[Optional
 
     ## Example Usage
 
+    <!--Start PulumiCodeChooser -->
     ```python
     import pulumi
     import pulumi_newrelic as newrelic
@@ -128,6 +131,7 @@ def get_obfuscation_expression_output(account_id: Optional[pulumi.Input[Optional
             method="MASK",
         )])
     ```
+    <!--End PulumiCodeChooser -->
 
 
     :param int account_id: The account id associated with the obfuscation expression. If left empty will default to account ID specified in provider level configuration.

pulumi_newrelic/get_service_level_alert_helper.py

@@ -170,6 +170,7 @@ def get_service_level_alert_helper(alert_type: Optional[str] = None,
 
     Firstly set up your service level objective, we recommend using local variables for the `target` and `time_window.rolling.count`, as they are also necessary for the helper.
 
+    <!--Start PulumiCodeChooser -->
     ```python
     import pulumi
     import pulumi_newrelic as newrelic
@@ -200,12 +201,14 @@ def get_service_level_alert_helper(alert_type: Optional[str] = None,
             ),
         ))
     ```
+    <!--End PulumiCodeChooser -->
     Then use the helper to obtain the necessary fields to set up an alert on that Service Level.
     Note that the Service Level was set up using bad events, that's why `is_bad_events` is set to `true`.
     If the Service Level was configured with good events that would be unnecessary as the field defaults to `false`.
 
     Here is an example of a `slow_burn` alert.
 
+    <!--Start PulumiCodeChooser -->
     ```python
     import pulumi
     import pulumi_newrelic as newrelic
@@ -236,9 +239,11 @@ def get_service_level_alert_helper(alert_type: Optional[str] = None,
         aggregation_delay="120",
         slide_by=900)
     ```
+    <!--End PulumiCodeChooser -->
 
     Here is an example of a custom alert:
 
+    <!--Start PulumiCodeChooser -->
     ```python
     import pulumi
     import pulumi_newrelic as newrelic
@@ -271,6 +276,7 @@ def get_service_level_alert_helper(alert_type: Optional[str] = None,
         aggregation_delay="120",
         slide_by=60)
     ```
+    <!--End PulumiCodeChooser -->
 
 
     :param str alert_type: The type of alert we want to set. Valid values are:
@@ -323,6 +329,7 @@ def get_service_level_alert_helper_output(alert_type: Optional[pulumi.Input[str]
 
     Firstly set up your service level objective, we recommend using local variables for the `target` and `time_window.rolling.count`, as they are also necessary for the helper.
 
+    <!--Start PulumiCodeChooser -->
     ```python
     import pulumi
     import pulumi_newrelic as newrelic
@@ -353,12 +360,14 @@ def get_service_level_alert_helper_output(alert_type: Optional[pulumi.Input[str]
             ),
         ))
     ```
+    <!--End PulumiCodeChooser -->
     Then use the helper to obtain the necessary fields to set up an alert on that Service Level.
     Note that the Service Level was set up using bad events, that's why `is_bad_events` is set to `true`.
     If the Service Level was configured with good events that would be unnecessary as the field defaults to `false`.
 
     Here is an example of a `slow_burn` alert.
 
+    <!--Start PulumiCodeChooser -->
     ```python
     import pulumi
     import pulumi_newrelic as newrelic
@@ -389,9 +398,11 @@ def get_service_level_alert_helper_output(alert_type: Optional[pulumi.Input[str]
         aggregation_delay="120",
         slide_by=900)
     ```
+    <!--End PulumiCodeChooser -->
 
     Here is an example of a custom alert:
 
+    <!--Start PulumiCodeChooser -->
     ```python
     import pulumi
     import pulumi_newrelic as newrelic
@@ -424,6 +435,7 @@ def get_service_level_alert_helper_output(alert_type: Optional[pulumi.Input[str]
         aggregation_delay="120",
         slide_by=60)
     ```
+    <!--End PulumiCodeChooser -->
 
 
     :param str alert_type: The type of alert we want to set. Valid values are:

pulumi_newrelic/get_test_grok_pattern.py

@@ -91,6 +91,7 @@ def get_test_grok_pattern(account_id: Optional[int] = None,
     """
     ## Example Usage
 
+    <!--Start PulumiCodeChooser -->
     ```python
     import pulumi
     import pulumi_newrelic as newrelic
@@ -101,6 +102,7 @@ def get_test_grok_pattern(account_id: Optional[int] = None,
             "bytes_received: 2048",
         ])
     ```
+    <!--End PulumiCodeChooser -->
 
 
     :param int account_id: The New Relic account ID to operate on.  This allows you to override the `account_id` attribute set on the provider. Defaults to the environment variable `NEW_RELIC_ACCOUNT_ID`.
@@ -130,6 +132,7 @@ def get_test_grok_pattern_output(account_id: Optional[pulumi.Input[Optional[int]
     """
     ## Example Usage
 
+    <!--Start PulumiCodeChooser -->
     ```python
     import pulumi
     import pulumi_newrelic as newrelic
@@ -140,6 +143,7 @@ def get_test_grok_pattern_output(account_id: Optional[pulumi.Input[Optional[int]
             "bytes_received: 2048",
         ])
     ```
+    <!--End PulumiCodeChooser -->
 
 
     :param int account_id: The New Relic account ID to operate on.  This allows you to override the `account_id` attribute set on the provider. Defaults to the environment variable `NEW_RELIC_ACCOUNT_ID`.

pulumi_newrelic/get_user.py

@@ -76,11 +76,12 @@ def get_user(authentication_domain_id: Optional[str] = None,
              name: Optional[str] = None,
              opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetUserResult:
     """
-    The `User` data source may be used to search for a user by their name and/or email ID, and accordingly, fetch the ID of the matching user.
+    The `User` data source helps search for a user by their name and/or email ID, and accordingly, fetch the ID of the matching user.
 
     ## Example Usage
 
-    The below example illustrates fetching a user's ID (and other arguments) using the ID of the authentication domain the user belongs to, as well as a name and/or email ID, which can be used as criteria to search for a user who matches these specified parameters.
+    The below example illustrates fetching a the ID of a user (and other arguments) using the ID of the authentication domain the user belongs to, as well as a name and/or email ID, which can be used as criteria to search for a user who matches these specified parameters.
+    <!--Start PulumiCodeChooser -->
     ```python
     import pulumi
     import pulumi_newrelic as newrelic
@@ -91,6 +92,7 @@ def get_user(authentication_domain_id: Optional[str] = None,
     user_two = newrelic.get_user(authentication_domain_id=foo.id,
         email_id="test_user@random.com")
     ```
+    <!--End PulumiCodeChooser -->
 
 
     :param str authentication_domain_id: The ID of the authentication domain the user to be searched for belongs to.
@@ -98,7 +100,7 @@ def get_user(authentication_domain_id: Optional[str] = None,
            
            It should be noted that either `name` or `email_id` must be specified in order to retrieve a matching user.
            
-           > **NOTE** If the specified `name` matches, or is contained in the names of multiple users in the account, the data source will return the first match from the list of all matching users retrieved from the API. However, when using the `email_id` argument as the search criterion, only the user with the specified email ID will be returned, as each user has a unique email ID and multiple users cannot have the same email ID.
+           > **NOTE** If the `name` specified in the configuration matches the names of multiple users in the account, the data source will return the first match from the list of all matching users retrieved from the API. However, when using the `email_id` argument as the search criterion, only the user with the specified email ID will be returned, as each user has a unique email ID and multiple users cannot have the same email ID.
            
            > **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.
     :param str name: The name of the user to search for.
@@ -123,11 +125,12 @@ def get_user_output(authentication_domain_id: Optional[pulumi.Input[str]] = None
                     name: Optional[pulumi.Input[Optional[str]]] = None,
                     opts: Optional[pulumi.InvokeOptions] = None) -> pulumi.Output[GetUserResult]:
     """
-    The `User` data source may be used to search for a user by their name and/or email ID, and accordingly, fetch the ID of the matching user.
+    The `User` data source helps search for a user by their name and/or email ID, and accordingly, fetch the ID of the matching user.
 
     ## Example Usage
 
-    The below example illustrates fetching a user's ID (and other arguments) using the ID of the authentication domain the user belongs to, as well as a name and/or email ID, which can be used as criteria to search for a user who matches these specified parameters.
+    The below example illustrates fetching a the ID of a user (and other arguments) using the ID of the authentication domain the user belongs to, as well as a name and/or email ID, which can be used as criteria to search for a user who matches these specified parameters.
+    <!--Start PulumiCodeChooser -->
     ```python
     import pulumi
     import pulumi_newrelic as newrelic
@@ -138,6 +141,7 @@ def get_user_output(authentication_domain_id: Optional[pulumi.Input[str]] = None
     user_two = newrelic.get_user(authentication_domain_id=foo.id,
         email_id="test_user@random.com")
     ```
+    <!--End PulumiCodeChooser -->
 
 
     :param str authentication_domain_id: The ID of the authentication domain the user to be searched for belongs to.
@@ -145,7 +149,7 @@ def get_user_output(authentication_domain_id: Optional[pulumi.Input[str]] = None
            
            It should be noted that either `name` or `email_id` must be specified in order to retrieve a matching user.
            
-           > **NOTE** If the specified `name` matches, or is contained in the names of multiple users in the account, the data source will return the first match from the list of all matching users retrieved from the API. However, when using the `email_id` argument as the search criterion, only the user with the specified email ID will be returned, as each user has a unique email ID and multiple users cannot have the same email ID.
+           > **NOTE** If the `name` specified in the configuration matches the names of multiple users in the account, the data source will return the first match from the list of all matching users retrieved from the API. However, when using the `email_id` argument as the search criterion, only the user with the specified email ID will be returned, as each user has a unique email ID and multiple users cannot have the same email ID.
            
            > **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.
     :param str name: The name of the user to search for.