pulumi-newrelic 5.23.0__py3-none-any.whl → 5.23.0a1711605988__py3-none-any.whl

pulumi_newrelic/account_management.py

@@ -18,8 +18,8 @@ class AccountManagementArgs:
                  name: Optional[pulumi.Input[str]] = None):
         """
         The set of arguments for constructing a AccountManagement resource.
-        :param pulumi.Input[str] region: A description of what this parsing rule represents.
-        :param pulumi.Input[str] name: Name of the account to be created
+        :param pulumi.Input[str] region: The region code of the account.  One of: `us01`, `eu01`.
+        :param pulumi.Input[str] name: The name of the Account.
         """
         pulumi.set(__self__, "region", region)
         if name is not None:
@@ -29,7 +29,7 @@ class AccountManagementArgs:
     @pulumi.getter
     def region(self) -> pulumi.Input[str]:
         """
-        A description of what this parsing rule represents.
+        The region code of the account.  One of: `us01`, `eu01`.
         """
         return pulumi.get(self, "region")
 
@@ -41,7 +41,7 @@ class AccountManagementArgs:
     @pulumi.getter
     def name(self) -> Optional[pulumi.Input[str]]:
         """
-        Name of the account to be created
+        The name of the Account.
         """
         return pulumi.get(self, "name")
 
@@ -57,8 +57,8 @@ class _AccountManagementState:
                  region: Optional[pulumi.Input[str]] = None):
         """
         Input properties used for looking up and filtering AccountManagement resources.
-        :param pulumi.Input[str] name: Name of the account to be created
-        :param pulumi.Input[str] region: A description of what this parsing rule represents.
+        :param pulumi.Input[str] name: The name of the Account.
+        :param pulumi.Input[str] region: The region code of the account.  One of: `us01`, `eu01`.
         """
         if name is not None:
             pulumi.set(__self__, "name", name)
@@ -69,7 +69,7 @@ class _AccountManagementState:
     @pulumi.getter
     def name(self) -> Optional[pulumi.Input[str]]:
         """
-        Name of the account to be created
+        The name of the Account.
         """
         return pulumi.get(self, "name")
 
@@ -81,7 +81,7 @@ class _AccountManagementState:
     @pulumi.getter
     def region(self) -> Optional[pulumi.Input[str]]:
         """
-        A description of what this parsing rule represents.
+        The region code of the account.  One of: `us01`, `eu01`.
         """
         return pulumi.get(self, "region")
 
@@ -106,14 +106,14 @@ class AccountManagement(pulumi.CustomResource):
         ## Example Usage
 
         ##### Create Account
+        <!--Start PulumiCodeChooser -->
         ```python
         import pulumi
         import pulumi_newrelic as newrelic
 
-        foo = newrelic.AccountManagement("foo",
-            name="Test Account Name",
-            region="us01")
+        foo = newrelic.AccountManagement("foo", region="us01")
         ```
+        <!--End PulumiCodeChooser -->
 
         ## Import
 
@@ -127,8 +127,8 @@ class AccountManagement(pulumi.CustomResource):
 
         :param str resource_name: The name of the resource.
         :param pulumi.ResourceOptions opts: Options for the resource.
-        :param pulumi.Input[str] name: Name of the account to be created
-        :param pulumi.Input[str] region: A description of what this parsing rule represents.
+        :param pulumi.Input[str] name: The name of the Account.
+        :param pulumi.Input[str] region: The region code of the account.  One of: `us01`, `eu01`.
         """
         ...
     @overload
@@ -144,14 +144,14 @@ class AccountManagement(pulumi.CustomResource):
         ## Example Usage
 
         ##### Create Account
+        <!--Start PulumiCodeChooser -->
         ```python
         import pulumi
         import pulumi_newrelic as newrelic
 
-        foo = newrelic.AccountManagement("foo",
-            name="Test Account Name",
-            region="us01")
+        foo = newrelic.AccountManagement("foo", region="us01")
         ```
+        <!--End PulumiCodeChooser -->
 
         ## Import
 
@@ -212,8 +212,8 @@ class AccountManagement(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[str] name: Name of the account to be created
-        :param pulumi.Input[str] region: A description of what this parsing rule represents.
+        :param pulumi.Input[str] name: The name of the Account.
+        :param pulumi.Input[str] region: The region code of the account.  One of: `us01`, `eu01`.
         """
         opts = pulumi.ResourceOptions.merge(opts, pulumi.ResourceOptions(id=id))
 
@@ -227,7 +227,7 @@ class AccountManagement(pulumi.CustomResource):
     @pulumi.getter
     def name(self) -> pulumi.Output[str]:
         """
-        Name of the account to be created
+        The name of the Account.
         """
         return pulumi.get(self, "name")
 
@@ -235,7 +235,7 @@ class AccountManagement(pulumi.CustomResource):
     @pulumi.getter
     def region(self) -> pulumi.Output[str]:
         """
-        A description of what this parsing rule represents.
+        The region code of the account.  One of: `us01`, `eu01`.
         """
         return pulumi.get(self, "region")
 

pulumi_newrelic/alert_channel.py

@@ -22,10 +22,10 @@ class AlertChannelArgs:
                  name: Optional[pulumi.Input[str]] = None):
         """
         The set of arguments for constructing a AlertChannel resource.
-        :param pulumi.Input[str] type: (Required) The type of channel. One of: (email, opsgenie, pagerduty, slack, user, victorops, webhook).
-        :param pulumi.Input[int] account_id: The New Relic account ID where you want to create alert channels.
-        :param pulumi.Input['AlertChannelConfigArgs'] config: The configuration block for the alert channel.
-        :param pulumi.Input[str] name: (Required) The name of the channel.
+        :param pulumi.Input[str] type: The type of channel.  One of: `email`, `slack`, `opsgenie`, `pagerduty`, `victorops`, or `webhook`.
+        :param pulumi.Input[int] account_id: Determines the New Relic account where the alert channel will be created. Defaults to the account associated with the API key used.
+        :param pulumi.Input['AlertChannelConfigArgs'] config: A nested block that describes an alert channel configuration.  Only one config block is permitted per alert channel definition.  See Nested config blocks below for details.
+        :param pulumi.Input[str] name: The name of the channel.
         """
         pulumi.set(__self__, "type", type)
         if account_id is not None:
@@ -39,7 +39,7 @@ class AlertChannelArgs:
     @pulumi.getter
     def type(self) -> pulumi.Input[str]:
         """
-        (Required) The type of channel. One of: (email, opsgenie, pagerduty, slack, user, victorops, webhook).
+        The type of channel.  One of: `email`, `slack`, `opsgenie`, `pagerduty`, `victorops`, or `webhook`.
         """
         return pulumi.get(self, "type")
 
@@ -51,7 +51,7 @@ class AlertChannelArgs:
     @pulumi.getter(name="accountId")
     def account_id(self) -> Optional[pulumi.Input[int]]:
         """
-        The New Relic account ID where you want to create alert channels.
+        Determines the New Relic account where the alert channel will be created. Defaults to the account associated with the API key used.
         """
         return pulumi.get(self, "account_id")
 
@@ -63,7 +63,7 @@ class AlertChannelArgs:
     @pulumi.getter
     def config(self) -> Optional[pulumi.Input['AlertChannelConfigArgs']]:
         """
-        The configuration block for the alert channel.
+        A nested block that describes an alert channel configuration.  Only one config block is permitted per alert channel definition.  See Nested config blocks below for details.
         """
         return pulumi.get(self, "config")
 
@@ -75,7 +75,7 @@ class AlertChannelArgs:
     @pulumi.getter
     def name(self) -> Optional[pulumi.Input[str]]:
         """
-        (Required) The name of the channel.
+        The name of the channel.
         """
         return pulumi.get(self, "name")
 
@@ -93,10 +93,10 @@ class _AlertChannelState:
                  type: Optional[pulumi.Input[str]] = None):
         """
         Input properties used for looking up and filtering AlertChannel resources.
-        :param pulumi.Input[int] account_id: The New Relic account ID where you want to create alert channels.
-        :param pulumi.Input['AlertChannelConfigArgs'] config: The configuration block for the alert channel.
-        :param pulumi.Input[str] name: (Required) The name of the channel.
-        :param pulumi.Input[str] type: (Required) The type of channel. One of: (email, opsgenie, pagerduty, slack, user, victorops, webhook).
+        :param pulumi.Input[int] account_id: Determines the New Relic account where the alert channel will be created. Defaults to the account associated with the API key used.
+        :param pulumi.Input['AlertChannelConfigArgs'] config: A nested block that describes an alert channel configuration.  Only one config block is permitted per alert channel definition.  See Nested config blocks below for details.
+        :param pulumi.Input[str] name: The name of the channel.
+        :param pulumi.Input[str] type: The type of channel.  One of: `email`, `slack`, `opsgenie`, `pagerduty`, `victorops`, or `webhook`.
         """
         if account_id is not None:
             pulumi.set(__self__, "account_id", account_id)
@@ -111,7 +111,7 @@ class _AlertChannelState:
     @pulumi.getter(name="accountId")
     def account_id(self) -> Optional[pulumi.Input[int]]:
         """
-        The New Relic account ID where you want to create alert channels.
+        Determines the New Relic account where the alert channel will be created. Defaults to the account associated with the API key used.
         """
         return pulumi.get(self, "account_id")
 
@@ -123,7 +123,7 @@ class _AlertChannelState:
     @pulumi.getter
     def config(self) -> Optional[pulumi.Input['AlertChannelConfigArgs']]:
         """
-        The configuration block for the alert channel.
+        A nested block that describes an alert channel configuration.  Only one config block is permitted per alert channel definition.  See Nested config blocks below for details.
         """
         return pulumi.get(self, "config")
 
@@ -135,7 +135,7 @@ class _AlertChannelState:
     @pulumi.getter
     def name(self) -> Optional[pulumi.Input[str]]:
         """
-        (Required) The name of the channel.
+        The name of the channel.
         """
         return pulumi.get(self, "name")
 
@@ -147,7 +147,7 @@ class _AlertChannelState:
     @pulumi.getter
     def type(self) -> Optional[pulumi.Input[str]]:
         """
-        (Required) The type of channel. One of: (email, opsgenie, pagerduty, slack, user, victorops, webhook).
+        The type of channel.  One of: `email`, `slack`, `opsgenie`, `pagerduty`, `victorops`, or `webhook`.
         """
         return pulumi.get(self, "type")
 
@@ -174,87 +174,92 @@ class AlertChannel(pulumi.CustomResource):
         ## Example Usage
 
         ### Email
+        <!--Start PulumiCodeChooser -->
         ```python
         import pulumi
         import pulumi_newrelic as newrelic
 
         foo = newrelic.AlertChannel("foo",
-            name="foo",
-            type="email",
             config=newrelic.AlertChannelConfigArgs(
-                recipients="foo@example.com",
                 include_json_attachment="true",
-            ))
+                recipients="foo@example.com",
+            ),
+            type="email")
         ```
+        <!--End PulumiCodeChooser -->
 
         ## Additional Examples
 
         ##### Slack
+        <!--Start PulumiCodeChooser -->
         ```python
         import pulumi
         import pulumi_newrelic as newrelic
 
         foo = newrelic.AlertChannel("foo",
-            name="slack-example",
-            type="slack",
             config=newrelic.AlertChannelConfigArgs(
-                url="https://hooks.slack.com/services/XXXXXXX/XXXXXXX/XXXXXXXXXX",
                 channel="example-alerts-channel",
-            ))
+                url="https://hooks.slack.com/services/XXXXXXX/XXXXXXX/XXXXXXXXXX",
+            ),
+            type="slack")
         ```
+        <!--End PulumiCodeChooser -->
 
         > **NOTE:** For instructions on setting up Webhooks with Slack, please visit the article linked under the argument `slack` in the aforementioned configuration, or [this article](https://docs.newrelic.com/docs/alerts-applied-intelligence/new-relic-alerts/alert-notifications/notification-channels-control-where-send-alerts/#slack) in New Relic's docs for additional details on setting up the `New Relic Alerts` Slack application, and subsequently using the generated Webhook URL.
 
         ### OpsGenie
+        <!--Start PulumiCodeChooser -->
         ```python
         import pulumi
         import pulumi_newrelic as newrelic
 
         foo = newrelic.AlertChannel("foo",
-            name="opsgenie-example",
-            type="opsgenie",
             config=newrelic.AlertChannelConfigArgs(
                 api_key="abc123",
-                teams="team1, team2",
-                tags="tag1, tag2",
                 recipients="user1@domain.com, user2@domain.com",
-            ))
+                tags="tag1, tag2",
+                teams="team1, team2",
+            ),
+            type="opsgenie")
         ```
+        <!--End PulumiCodeChooser -->
 
         ### PagerDuty
+        <!--Start PulumiCodeChooser -->
         ```python
         import pulumi
         import pulumi_newrelic as newrelic
 
         foo = newrelic.AlertChannel("foo",
-            name="pagerduty-example",
-            type="pagerduty",
             config=newrelic.AlertChannelConfigArgs(
                 service_key="abc123",
-            ))
+            ),
+            type="pagerduty")
         ```
+        <!--End PulumiCodeChooser -->
 
         ### VictorOps
+        <!--Start PulumiCodeChooser -->
         ```python
         import pulumi
         import pulumi_newrelic as newrelic
 
         foo = newrelic.AlertChannel("foo",
-            name="victorops-example",
-            type="victorops",
             config=newrelic.AlertChannelConfigArgs(
                 key="abc123",
                 route_key="/example",
-            ))
+            ),
+            type="victorops")
         ```
+        <!--End PulumiCodeChooser -->
 
         ### Webhook
+        <!--Start PulumiCodeChooser -->
         ```python
         import pulumi
         import pulumi_newrelic as newrelic
 
         foo = newrelic.AlertChannel("foo",
-            name="webhook-example",
             type="webhook",
             config=newrelic.AlertChannelConfigArgs(
                 base_url="http://www.test.com",
@@ -269,27 +274,30 @@ class AlertChannel(pulumi.CustomResource):
                 },
             ))
         ```
+        <!--End PulumiCodeChooser -->
 
         ### Webhook with complex payload
+        <!--Start PulumiCodeChooser -->
         ```python
         import pulumi
         import pulumi_newrelic as newrelic
 
         foo = newrelic.AlertChannel("foo",
-            name="webhook-example",
-            type="webhook",
             config=newrelic.AlertChannelConfigArgs(
                 base_url="http://www.test.com",
-                payload_type="application/json",
                 payload_string=\"\"\"{
           "my_custom_values": {
             "condition_name": "$CONDITION_NAME",
             "policy_name": "$POLICY_NAME"
           }
         }
+
         \"\"\",
-            ))
+                payload_type="application/json",
+            ),
+            type="webhook")
         ```
+        <!--End PulumiCodeChooser -->
 
         ## Import
 
@@ -303,10 +311,10 @@ class AlertChannel(pulumi.CustomResource):
 
         :param str resource_name: The name of the resource.
         :param pulumi.ResourceOptions opts: Options for the resource.
-        :param pulumi.Input[int] account_id: The New Relic account ID where you want to create alert channels.
-        :param pulumi.Input[pulumi.InputType['AlertChannelConfigArgs']] config: The configuration block for the alert channel.
-        :param pulumi.Input[str] name: (Required) The name of the channel.
-        :param pulumi.Input[str] type: (Required) The type of channel. One of: (email, opsgenie, pagerduty, slack, user, victorops, webhook).
+        :param pulumi.Input[int] account_id: Determines the New Relic account where the alert channel will be created. Defaults to the account associated with the API key used.
+        :param pulumi.Input[pulumi.InputType['AlertChannelConfigArgs']] config: A nested block that describes an alert channel configuration.  Only one config block is permitted per alert channel definition.  See Nested config blocks below for details.
+        :param pulumi.Input[str] name: The name of the channel.
+        :param pulumi.Input[str] type: The type of channel.  One of: `email`, `slack`, `opsgenie`, `pagerduty`, `victorops`, or `webhook`.
         """
         ...
     @overload
@@ -322,87 +330,92 @@ class AlertChannel(pulumi.CustomResource):
         ## Example Usage
 
         ### Email
+        <!--Start PulumiCodeChooser -->
         ```python
         import pulumi
         import pulumi_newrelic as newrelic
 
         foo = newrelic.AlertChannel("foo",
-            name="foo",
-            type="email",
             config=newrelic.AlertChannelConfigArgs(
-                recipients="foo@example.com",
                 include_json_attachment="true",
-            ))
+                recipients="foo@example.com",
+            ),
+            type="email")
         ```
+        <!--End PulumiCodeChooser -->
 
         ## Additional Examples
 
         ##### Slack
+        <!--Start PulumiCodeChooser -->
         ```python
         import pulumi
         import pulumi_newrelic as newrelic
 
         foo = newrelic.AlertChannel("foo",
-            name="slack-example",
-            type="slack",
             config=newrelic.AlertChannelConfigArgs(
-                url="https://hooks.slack.com/services/XXXXXXX/XXXXXXX/XXXXXXXXXX",
                 channel="example-alerts-channel",
-            ))
+                url="https://hooks.slack.com/services/XXXXXXX/XXXXXXX/XXXXXXXXXX",
+            ),
+            type="slack")
         ```
+        <!--End PulumiCodeChooser -->
 
         > **NOTE:** For instructions on setting up Webhooks with Slack, please visit the article linked under the argument `slack` in the aforementioned configuration, or [this article](https://docs.newrelic.com/docs/alerts-applied-intelligence/new-relic-alerts/alert-notifications/notification-channels-control-where-send-alerts/#slack) in New Relic's docs for additional details on setting up the `New Relic Alerts` Slack application, and subsequently using the generated Webhook URL.
 
         ### OpsGenie
+        <!--Start PulumiCodeChooser -->
         ```python
         import pulumi
         import pulumi_newrelic as newrelic
 
         foo = newrelic.AlertChannel("foo",
-            name="opsgenie-example",
-            type="opsgenie",
             config=newrelic.AlertChannelConfigArgs(
                 api_key="abc123",
-                teams="team1, team2",
-                tags="tag1, tag2",
                 recipients="user1@domain.com, user2@domain.com",
-            ))
+                tags="tag1, tag2",
+                teams="team1, team2",
+            ),
+            type="opsgenie")
         ```
+        <!--End PulumiCodeChooser -->
 
         ### PagerDuty
+        <!--Start PulumiCodeChooser -->
         ```python
         import pulumi
         import pulumi_newrelic as newrelic
 
         foo = newrelic.AlertChannel("foo",
-            name="pagerduty-example",
-            type="pagerduty",
             config=newrelic.AlertChannelConfigArgs(
                 service_key="abc123",
-            ))
+            ),
+            type="pagerduty")
         ```
+        <!--End PulumiCodeChooser -->
 
         ### VictorOps
+        <!--Start PulumiCodeChooser -->
         ```python
         import pulumi
         import pulumi_newrelic as newrelic
 
         foo = newrelic.AlertChannel("foo",
-            name="victorops-example",
-            type="victorops",
             config=newrelic.AlertChannelConfigArgs(
                 key="abc123",
                 route_key="/example",
-            ))
+            ),
+            type="victorops")
         ```
+        <!--End PulumiCodeChooser -->
 
         ### Webhook
+        <!--Start PulumiCodeChooser -->
         ```python
         import pulumi
         import pulumi_newrelic as newrelic
 
         foo = newrelic.AlertChannel("foo",
-            name="webhook-example",
             type="webhook",
             config=newrelic.AlertChannelConfigArgs(
                 base_url="http://www.test.com",
@@ -417,27 +430,30 @@ class AlertChannel(pulumi.CustomResource):
                 },
             ))
         ```
+        <!--End PulumiCodeChooser -->
 
         ### Webhook with complex payload
+        <!--Start PulumiCodeChooser -->
         ```python
         import pulumi
         import pulumi_newrelic as newrelic
 
         foo = newrelic.AlertChannel("foo",
-            name="webhook-example",
-            type="webhook",
             config=newrelic.AlertChannelConfigArgs(
                 base_url="http://www.test.com",
-                payload_type="application/json",
                 payload_string=\"\"\"{
           "my_custom_values": {
             "condition_name": "$CONDITION_NAME",
             "policy_name": "$POLICY_NAME"
           }
         }
+
         \"\"\",
-            ))
+                payload_type="application/json",
+            ),
+            type="webhook")
         ```
+        <!--End PulumiCodeChooser -->
 
         ## Import
 
@@ -504,10 +520,10 @@ class AlertChannel(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: The New Relic account ID where you want to create alert channels.
-        :param pulumi.Input[pulumi.InputType['AlertChannelConfigArgs']] config: The configuration block for the alert channel.
-        :param pulumi.Input[str] name: (Required) The name of the channel.
-        :param pulumi.Input[str] type: (Required) The type of channel. One of: (email, opsgenie, pagerduty, slack, user, victorops, webhook).
+        :param pulumi.Input[int] account_id: Determines the New Relic account where the alert channel will be created. Defaults to the account associated with the API key used.
+        :param pulumi.Input[pulumi.InputType['AlertChannelConfigArgs']] config: A nested block that describes an alert channel configuration.  Only one config block is permitted per alert channel definition.  See Nested config blocks below for details.
+        :param pulumi.Input[str] name: The name of the channel.
+        :param pulumi.Input[str] type: The type of channel.  One of: `email`, `slack`, `opsgenie`, `pagerduty`, `victorops`, or `webhook`.
         """
         opts = pulumi.ResourceOptions.merge(opts, pulumi.ResourceOptions(id=id))
 
@@ -523,7 +539,7 @@ class AlertChannel(pulumi.CustomResource):
     @pulumi.getter(name="accountId")
     def account_id(self) -> pulumi.Output[int]:
         """
-        The New Relic account ID where you want to create alert channels.
+        Determines the New Relic account where the alert channel will be created. Defaults to the account associated with the API key used.
         """
         return pulumi.get(self, "account_id")
 
@@ -531,7 +547,7 @@ class AlertChannel(pulumi.CustomResource):
     @pulumi.getter
     def config(self) -> pulumi.Output[Optional['outputs.AlertChannelConfig']]:
         """
-        The configuration block for the alert channel.
+        A nested block that describes an alert channel configuration.  Only one config block is permitted per alert channel definition.  See Nested config blocks below for details.
         """
         return pulumi.get(self, "config")
 
@@ -539,7 +555,7 @@ class AlertChannel(pulumi.CustomResource):
     @pulumi.getter
     def name(self) -> pulumi.Output[str]:
         """
-        (Required) The name of the channel.
+        The name of the channel.
         """
         return pulumi.get(self, "name")
 
@@ -547,7 +563,7 @@ class AlertChannel(pulumi.CustomResource):
     @pulumi.getter
     def type(self) -> pulumi.Output[str]:
         """
-        (Required) The type of channel. One of: (email, opsgenie, pagerduty, slack, user, victorops, webhook).
+        The type of channel.  One of: `email`, `slack`, `opsgenie`, `pagerduty`, `victorops`, or `webhook`.
         """
         return pulumi.get(self, "type")