pulumi-newrelic 5.16.0a1698964311__py3-none-any.whl → 5.58.0a1763707205__py3-none-any.whl

pulumi_newrelic/alert_policy_channel.py

@@ -1,12 +1,17 @@
 # coding=utf-8
-# *** WARNING: this file was generated by the Pulumi Terraform Bridge (tfgen) Tool. ***
+# *** WARNING: this file was generated by pulumi-language-python. ***
 # *** Do not edit by hand unless you're certain you know what you are doing! ***
 
-import copy
+import builtins as _builtins
 import warnings
+import sys
 import pulumi
 import pulumi.runtime
 from typing import Any, Mapping, Optional, Sequence, Union, overload
+if sys.version_info >= (3, 11):
+    from typing import NotRequired, TypedDict, TypeAlias
+else:
+    from typing_extensions import NotRequired, TypedDict, TypeAlias
 from . import _utilities
 
 __all__ = ['AlertPolicyChannelArgs', 'AlertPolicyChannel']
@@ -14,68 +19,68 @@ __all__ = ['AlertPolicyChannelArgs', 'AlertPolicyChannel']
 @pulumi.input_type
 class AlertPolicyChannelArgs:
     def __init__(__self__, *,
-                 channel_ids: pulumi.Input[Sequence[pulumi.Input[int]]],
-                 policy_id: pulumi.Input[int],
-                 account_id: Optional[pulumi.Input[int]] = None):
+                 channel_ids: pulumi.Input[Sequence[pulumi.Input[_builtins.str]]],
+                 policy_id: pulumi.Input[_builtins.str],
+                 account_id: Optional[pulumi.Input[_builtins.str]] = None):
         """
         The set of arguments for constructing a AlertPolicyChannel resource.
-        :param pulumi.Input[Sequence[pulumi.Input[int]]] channel_ids: Array of channel IDs to apply to the specified policy. We recommended sorting channel IDs in ascending order to avoid drift in your state.
-        :param pulumi.Input[int] policy_id: The ID of the policy.
-        :param pulumi.Input[int] account_id: Determines the New Relic account where the alert policy channel will be created. Defaults to the account associated with the API key used.
+        :param pulumi.Input[Sequence[pulumi.Input[_builtins.str]]] channel_ids: Array of channel IDs to apply to the specified policy. We recommended sorting channel IDs in ascending order to avoid drift in your state.
+        :param pulumi.Input[_builtins.str] policy_id: The ID of the policy.
+        :param pulumi.Input[_builtins.str] account_id: Determines the New Relic account where the alert policy channel will be created. Defaults to the account associated with the API key used.
         """
         pulumi.set(__self__, "channel_ids", channel_ids)
         pulumi.set(__self__, "policy_id", policy_id)
         if account_id is not None:
             pulumi.set(__self__, "account_id", account_id)
 
-    @property
+    @_builtins.property
     @pulumi.getter(name="channelIds")
-    def channel_ids(self) -> pulumi.Input[Sequence[pulumi.Input[int]]]:
+    def channel_ids(self) -> pulumi.Input[Sequence[pulumi.Input[_builtins.str]]]:
         """
         Array of channel IDs to apply to the specified policy. We recommended sorting channel IDs in ascending order to avoid drift in your state.
         """
         return pulumi.get(self, "channel_ids")
 
     @channel_ids.setter
-    def channel_ids(self, value: pulumi.Input[Sequence[pulumi.Input[int]]]):
+    def channel_ids(self, value: pulumi.Input[Sequence[pulumi.Input[_builtins.str]]]):
         pulumi.set(self, "channel_ids", value)
 
-    @property
+    @_builtins.property
     @pulumi.getter(name="policyId")
-    def policy_id(self) -> pulumi.Input[int]:
+    def policy_id(self) -> pulumi.Input[_builtins.str]:
         """
         The ID of the policy.
         """
         return pulumi.get(self, "policy_id")
 
     @policy_id.setter
-    def policy_id(self, value: pulumi.Input[int]):
+    def policy_id(self, value: pulumi.Input[_builtins.str]):
         pulumi.set(self, "policy_id", value)
 
-    @property
+    @_builtins.property
     @pulumi.getter(name="accountId")
-    def account_id(self) -> Optional[pulumi.Input[int]]:
+    def account_id(self) -> Optional[pulumi.Input[_builtins.str]]:
         """
         Determines the New Relic account where the alert policy channel will be created. Defaults to the account associated with the API key used.
         """
         return pulumi.get(self, "account_id")
 
     @account_id.setter
-    def account_id(self, value: Optional[pulumi.Input[int]]):
+    def account_id(self, value: Optional[pulumi.Input[_builtins.str]]):
         pulumi.set(self, "account_id", value)
 
 
 @pulumi.input_type
 class _AlertPolicyChannelState:
     def __init__(__self__, *,
-                 account_id: Optional[pulumi.Input[int]] = None,
-                 channel_ids: Optional[pulumi.Input[Sequence[pulumi.Input[int]]]] = None,
-                 policy_id: Optional[pulumi.Input[int]] = None):
+                 account_id: Optional[pulumi.Input[_builtins.str]] = None,
+                 channel_ids: Optional[pulumi.Input[Sequence[pulumi.Input[_builtins.str]]]] = None,
+                 policy_id: Optional[pulumi.Input[_builtins.str]] = None):
         """
         Input properties used for looking up and filtering AlertPolicyChannel resources.
-        :param pulumi.Input[int] account_id: Determines the New Relic account where the alert policy channel will be created. Defaults to the account associated with the API key used.
-        :param pulumi.Input[Sequence[pulumi.Input[int]]] channel_ids: Array of channel IDs to apply to the specified policy. We recommended sorting channel IDs in ascending order to avoid drift in your state.
-        :param pulumi.Input[int] policy_id: The ID of the policy.
+        :param pulumi.Input[_builtins.str] account_id: Determines the New Relic account where the alert policy channel will be created. Defaults to the account associated with the API key used.
+        :param pulumi.Input[Sequence[pulumi.Input[_builtins.str]]] channel_ids: Array of channel IDs to apply to the specified policy. We recommended sorting channel IDs in ascending order to avoid drift in your state.
+        :param pulumi.Input[_builtins.str] policy_id: The ID of the policy.
         """
         if account_id is not None:
             pulumi.set(__self__, "account_id", account_id)
@@ -84,56 +89,57 @@ class _AlertPolicyChannelState:
         if policy_id is not None:
             pulumi.set(__self__, "policy_id", policy_id)
 
-    @property
+    @_builtins.property
     @pulumi.getter(name="accountId")
-    def account_id(self) -> Optional[pulumi.Input[int]]:
+    def account_id(self) -> Optional[pulumi.Input[_builtins.str]]:
         """
         Determines the New Relic account where the alert policy channel will be created. Defaults to the account associated with the API key used.
         """
         return pulumi.get(self, "account_id")
 
     @account_id.setter
-    def account_id(self, value: Optional[pulumi.Input[int]]):
+    def account_id(self, value: Optional[pulumi.Input[_builtins.str]]):
         pulumi.set(self, "account_id", value)
 
-    @property
+    @_builtins.property
     @pulumi.getter(name="channelIds")
-    def channel_ids(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[int]]]]:
+    def channel_ids(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[_builtins.str]]]]:
         """
         Array of channel IDs to apply to the specified policy. We recommended sorting channel IDs in ascending order to avoid drift in your state.
         """
         return pulumi.get(self, "channel_ids")
 
     @channel_ids.setter
-    def channel_ids(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[int]]]]):
+    def channel_ids(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[_builtins.str]]]]):
         pulumi.set(self, "channel_ids", value)
 
-    @property
+    @_builtins.property
     @pulumi.getter(name="policyId")
-    def policy_id(self) -> Optional[pulumi.Input[int]]:
+    def policy_id(self) -> Optional[pulumi.Input[_builtins.str]]:
         """
         The ID of the policy.
         """
         return pulumi.get(self, "policy_id")
 
     @policy_id.setter
-    def policy_id(self, value: Optional[pulumi.Input[int]]):
+    def policy_id(self, value: Optional[pulumi.Input[_builtins.str]]):
         pulumi.set(self, "policy_id", value)
 
 
+@pulumi.type_token("newrelic:index/alertPolicyChannel:AlertPolicyChannel")
 class AlertPolicyChannel(pulumi.CustomResource):
     @overload
     def __init__(__self__,
                  resource_name: str,
                  opts: Optional[pulumi.ResourceOptions] = None,
-                 account_id: Optional[pulumi.Input[int]] = None,
-                 channel_ids: Optional[pulumi.Input[Sequence[pulumi.Input[int]]]] = None,
-                 policy_id: Optional[pulumi.Input[int]] = None,
+                 account_id: Optional[pulumi.Input[_builtins.str]] = None,
+                 channel_ids: Optional[pulumi.Input[Sequence[pulumi.Input[_builtins.str]]]] = None,
+                 policy_id: Optional[pulumi.Input[_builtins.str]] = None,
                  __props__=None):
         """
         Use this resource to map alert policies to alert channels in New Relic.
 
-        > **WARNING:** The `AlertPolicyChannel` resource is deprecated and will be removed in the next major release. For managing channel resources in Workflows, use `NotificationChannel`.
+        > **WARNING:** The `AlertPolicyChannel` resource is **deprecated** and will be **removed in a future major release**. As an alternative, you can map channels to policies using the resource `Workflow`, with the channels to be mapped created using a combination of the newer resources `NotificationDestination` and `NotificationChannel`. We **strongly recommend** migrating to these new resources at the earliest. Please refer to this example for a detailed illustration on setting up channels and workflows with these resources.
 
         ## Example Usage
 
@@ -143,21 +149,25 @@ class AlertPolicyChannel(pulumi.CustomResource):
         import pulumi
         import pulumi_newrelic as newrelic
 
+        # Fetches the data for this policy from your New Relic account
+        # and is referenced in the newrelic_alert_policy_channel block below.
         example_policy = newrelic.get_alert_policy(name="my-alert-policy")
         # Creates an email alert channel.
-        email_channel = newrelic.AlertChannel("emailChannel",
+        email_channel = newrelic.AlertChannel("email_channel",
+            name="bar",
             type="email",
-            config=newrelic.AlertChannelConfigArgs(
-                recipients="foo@example.com",
-                include_json_attachment="1",
-            ))
+            config={
+                "recipients": "foo@example.com",
+                "include_json_attachment": "1",
+            })
         # Creates a Slack alert channel.
-        slack_channel = newrelic.AlertChannel("slackChannel",
+        slack_channel = newrelic.AlertChannel("slack_channel",
+            name="slack-channel-example",
             type="slack",
-            config=newrelic.AlertChannelConfigArgs(
-                channel="#example-channel",
-                url="http://example-org.slack.com",
-            ))
+            config={
+                "channel": "#example-channel",
+                "url": "http://example-org.slack.com",
+            })
         # Applies the created channels above to the alert policy
         # referenced at the top of the config.
         foo = newrelic.AlertPolicyChannel("foo",
@@ -170,18 +180,18 @@ class AlertPolicyChannel(pulumi.CustomResource):
 
         ## Import
 
-        Alert policy channels can be imported using the following notation`<policyID>:<channelID>:<channelID>`, e.g.
+        Alert policy channels can be imported using the following notation: `<policyID>:<channelID>:<channelID>`, e.g.
 
         ```sh
-         $ pulumi import newrelic:index/alertPolicyChannel:AlertPolicyChannel foo 123456:3462754:2938324
+        $ pulumi import newrelic:index/alertPolicyChannel:AlertPolicyChannel foo 123456:3462754:2938324
         ```
-         When importing `newrelic_alert_policy_channel` resource, the attribute `channel_ids`* will be set in your Terraform state. You can import multiple channels as long as those channel IDs are included as part of the import ID hash.
+        When importing `newrelic_alert_policy_channel` resource, the attribute `channel_ids`* will be set in your Terraform state. You can import multiple channels as long as those channel IDs are included as part of the import ID hash.
 
         :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 alert policy channel will be created. Defaults to the account associated with the API key used.
-        :param pulumi.Input[Sequence[pulumi.Input[int]]] channel_ids: Array of channel IDs to apply to the specified policy. We recommended sorting channel IDs in ascending order to avoid drift in your state.
-        :param pulumi.Input[int] policy_id: The ID of the policy.
+        :param pulumi.Input[_builtins.str] account_id: Determines the New Relic account where the alert policy channel will be created. Defaults to the account associated with the API key used.
+        :param pulumi.Input[Sequence[pulumi.Input[_builtins.str]]] channel_ids: Array of channel IDs to apply to the specified policy. We recommended sorting channel IDs in ascending order to avoid drift in your state.
+        :param pulumi.Input[_builtins.str] policy_id: The ID of the policy.
         """
         ...
     @overload
@@ -192,7 +202,7 @@ class AlertPolicyChannel(pulumi.CustomResource):
         """
         Use this resource to map alert policies to alert channels in New Relic.
 
-        > **WARNING:** The `AlertPolicyChannel` resource is deprecated and will be removed in the next major release. For managing channel resources in Workflows, use `NotificationChannel`.
+        > **WARNING:** The `AlertPolicyChannel` resource is **deprecated** and will be **removed in a future major release**. As an alternative, you can map channels to policies using the resource `Workflow`, with the channels to be mapped created using a combination of the newer resources `NotificationDestination` and `NotificationChannel`. We **strongly recommend** migrating to these new resources at the earliest. Please refer to this example for a detailed illustration on setting up channels and workflows with these resources.
 
         ## Example Usage
 
@@ -202,21 +212,25 @@ class AlertPolicyChannel(pulumi.CustomResource):
         import pulumi
         import pulumi_newrelic as newrelic
 
+        # Fetches the data for this policy from your New Relic account
+        # and is referenced in the newrelic_alert_policy_channel block below.
         example_policy = newrelic.get_alert_policy(name="my-alert-policy")
         # Creates an email alert channel.
-        email_channel = newrelic.AlertChannel("emailChannel",
+        email_channel = newrelic.AlertChannel("email_channel",
+            name="bar",
             type="email",
-            config=newrelic.AlertChannelConfigArgs(
-                recipients="foo@example.com",
-                include_json_attachment="1",
-            ))
+            config={
+                "recipients": "foo@example.com",
+                "include_json_attachment": "1",
+            })
         # Creates a Slack alert channel.
-        slack_channel = newrelic.AlertChannel("slackChannel",
+        slack_channel = newrelic.AlertChannel("slack_channel",
+            name="slack-channel-example",
             type="slack",
-            config=newrelic.AlertChannelConfigArgs(
-                channel="#example-channel",
-                url="http://example-org.slack.com",
-            ))
+            config={
+                "channel": "#example-channel",
+                "url": "http://example-org.slack.com",
+            })
         # Applies the created channels above to the alert policy
         # referenced at the top of the config.
         foo = newrelic.AlertPolicyChannel("foo",
@@ -229,12 +243,12 @@ class AlertPolicyChannel(pulumi.CustomResource):
 
         ## Import
 
-        Alert policy channels can be imported using the following notation`<policyID>:<channelID>:<channelID>`, e.g.
+        Alert policy channels can be imported using the following notation: `<policyID>:<channelID>:<channelID>`, e.g.
 
         ```sh
-         $ pulumi import newrelic:index/alertPolicyChannel:AlertPolicyChannel foo 123456:3462754:2938324
+        $ pulumi import newrelic:index/alertPolicyChannel:AlertPolicyChannel foo 123456:3462754:2938324
         ```
-         When importing `newrelic_alert_policy_channel` resource, the attribute `channel_ids`* will be set in your Terraform state. You can import multiple channels as long as those channel IDs are included as part of the import ID hash.
+        When importing `newrelic_alert_policy_channel` resource, the attribute `channel_ids`* will be set in your Terraform state. You can import multiple channels as long as those channel IDs are included as part of the import ID hash.
 
         :param str resource_name: The name of the resource.
         :param AlertPolicyChannelArgs args: The arguments to use to populate this resource's properties.
@@ -251,9 +265,9 @@ class AlertPolicyChannel(pulumi.CustomResource):
     def _internal_init(__self__,
                  resource_name: str,
                  opts: Optional[pulumi.ResourceOptions] = None,
-                 account_id: Optional[pulumi.Input[int]] = None,
-                 channel_ids: Optional[pulumi.Input[Sequence[pulumi.Input[int]]]] = None,
-                 policy_id: Optional[pulumi.Input[int]] = None,
+                 account_id: Optional[pulumi.Input[_builtins.str]] = None,
+                 channel_ids: Optional[pulumi.Input[Sequence[pulumi.Input[_builtins.str]]]] = None,
+                 policy_id: Optional[pulumi.Input[_builtins.str]] = None,
                  __props__=None):
         opts = pulumi.ResourceOptions.merge(_utilities.get_resource_opts_defaults(), opts)
         if not isinstance(opts, pulumi.ResourceOptions):
@@ -280,9 +294,9 @@ class AlertPolicyChannel(pulumi.CustomResource):
     def get(resource_name: str,
             id: pulumi.Input[str],
             opts: Optional[pulumi.ResourceOptions] = None,
-            account_id: Optional[pulumi.Input[int]] = None,
-            channel_ids: Optional[pulumi.Input[Sequence[pulumi.Input[int]]]] = None,
-            policy_id: Optional[pulumi.Input[int]] = None) -> 'AlertPolicyChannel':
+            account_id: Optional[pulumi.Input[_builtins.str]] = None,
+            channel_ids: Optional[pulumi.Input[Sequence[pulumi.Input[_builtins.str]]]] = None,
+            policy_id: Optional[pulumi.Input[_builtins.str]] = None) -> 'AlertPolicyChannel':
         """
         Get an existing AlertPolicyChannel resource's state with the given name, id, and optional extra
         properties used to qualify the lookup.
@@ -290,9 +304,9 @@ class AlertPolicyChannel(pulumi.CustomResource):
         :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[int] account_id: Determines the New Relic account where the alert policy channel will be created. Defaults to the account associated with the API key used.
-        :param pulumi.Input[Sequence[pulumi.Input[int]]] channel_ids: Array of channel IDs to apply to the specified policy. We recommended sorting channel IDs in ascending order to avoid drift in your state.
-        :param pulumi.Input[int] policy_id: The ID of the policy.
+        :param pulumi.Input[_builtins.str] account_id: Determines the New Relic account where the alert policy channel will be created. Defaults to the account associated with the API key used.
+        :param pulumi.Input[Sequence[pulumi.Input[_builtins.str]]] channel_ids: Array of channel IDs to apply to the specified policy. We recommended sorting channel IDs in ascending order to avoid drift in your state.
+        :param pulumi.Input[_builtins.str] policy_id: The ID of the policy.
         """
         opts = pulumi.ResourceOptions.merge(opts, pulumi.ResourceOptions(id=id))
 
@@ -303,25 +317,25 @@ class AlertPolicyChannel(pulumi.CustomResource):
         __props__.__dict__["policy_id"] = policy_id
         return AlertPolicyChannel(resource_name, opts=opts, __props__=__props__)
 
-    @property
+    @_builtins.property
     @pulumi.getter(name="accountId")
-    def account_id(self) -> pulumi.Output[int]:
+    def account_id(self) -> pulumi.Output[_builtins.str]:
         """
         Determines the New Relic account where the alert policy channel will be created. Defaults to the account associated with the API key used.
         """
         return pulumi.get(self, "account_id")
 
-    @property
+    @_builtins.property
     @pulumi.getter(name="channelIds")
-    def channel_ids(self) -> pulumi.Output[Sequence[int]]:
+    def channel_ids(self) -> pulumi.Output[Sequence[_builtins.str]]:
         """
         Array of channel IDs to apply to the specified policy. We recommended sorting channel IDs in ascending order to avoid drift in your state.
         """
         return pulumi.get(self, "channel_ids")
 
-    @property
+    @_builtins.property
     @pulumi.getter(name="policyId")
-    def policy_id(self) -> pulumi.Output[int]:
+    def policy_id(self) -> pulumi.Output[_builtins.str]:
         """
         The ID of the policy.
         """