pulumi-newrelic 5.42.1__py3-none-any.whl → 5.58.0a1766556761__py3-none-any.whl

pulumi_newrelic/nrql_drop_rule.py

@@ -1,8 +1,8 @@
 # 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
@@ -19,16 +19,16 @@ __all__ = ['NrqlDropRuleArgs', 'NrqlDropRule']
 @pulumi.input_type
 class NrqlDropRuleArgs:
     def __init__(__self__, *,
-                 action: pulumi.Input[str],
-                 nrql: pulumi.Input[str],
-                 account_id: Optional[pulumi.Input[str]] = None,
-                 description: Optional[pulumi.Input[str]] = None):
+                 action: pulumi.Input[_builtins.str],
+                 nrql: pulumi.Input[_builtins.str],
+                 account_id: Optional[pulumi.Input[_builtins.str]] = None,
+                 description: Optional[pulumi.Input[_builtins.str]] = None):
         """
         The set of arguments for constructing a NrqlDropRule resource.
-        :param pulumi.Input[str] action: An action type specifying how to apply the NRQL string (either `drop_data`, `drop_attributes`, or ` drop_attributes_from_metric_aggregates`).
-        :param pulumi.Input[str] nrql: A NRQL string that specifies what data types to drop.
-        :param pulumi.Input[str] account_id: Account where the drop rule will be put. Defaults to the account associated with the API key used.
-        :param pulumi.Input[str] description: The description of the drop rule.
+        :param pulumi.Input[_builtins.str] action: An action type specifying how to apply the NRQL string (either `drop_data`, `drop_attributes`, or ` drop_attributes_from_metric_aggregates`).
+        :param pulumi.Input[_builtins.str] nrql: A NRQL string that specifies what data types to drop.
+        :param pulumi.Input[_builtins.str] account_id: Account where the drop rule will be put. Defaults to the account associated with the API key used.
+        :param pulumi.Input[_builtins.str] description: The description of the drop rule.
         """
         pulumi.set(__self__, "action", action)
         pulumi.set(__self__, "nrql", nrql)
@@ -37,70 +37,72 @@ class NrqlDropRuleArgs:
         if description is not None:
             pulumi.set(__self__, "description", description)
 
-    @property
+    @_builtins.property
     @pulumi.getter
-    def action(self) -> pulumi.Input[str]:
+    def action(self) -> pulumi.Input[_builtins.str]:
         """
         An action type specifying how to apply the NRQL string (either `drop_data`, `drop_attributes`, or ` drop_attributes_from_metric_aggregates`).
         """
         return pulumi.get(self, "action")
 
     @action.setter
-    def action(self, value: pulumi.Input[str]):
+    def action(self, value: pulumi.Input[_builtins.str]):
         pulumi.set(self, "action", value)
 
-    @property
+    @_builtins.property
     @pulumi.getter
-    def nrql(self) -> pulumi.Input[str]:
+    def nrql(self) -> pulumi.Input[_builtins.str]:
         """
         A NRQL string that specifies what data types to drop.
         """
         return pulumi.get(self, "nrql")
 
     @nrql.setter
-    def nrql(self, value: pulumi.Input[str]):
+    def nrql(self, value: pulumi.Input[_builtins.str]):
         pulumi.set(self, "nrql", value)
 
-    @property
+    @_builtins.property
     @pulumi.getter(name="accountId")
-    def account_id(self) -> Optional[pulumi.Input[str]]:
+    def account_id(self) -> Optional[pulumi.Input[_builtins.str]]:
         """
         Account where the drop rule will be put. 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[str]]):
+    def account_id(self, value: Optional[pulumi.Input[_builtins.str]]):
         pulumi.set(self, "account_id", value)
 
-    @property
+    @_builtins.property
     @pulumi.getter
-    def description(self) -> Optional[pulumi.Input[str]]:
+    def description(self) -> Optional[pulumi.Input[_builtins.str]]:
         """
         The description of the drop rule.
         """
         return pulumi.get(self, "description")
 
     @description.setter
-    def description(self, value: Optional[pulumi.Input[str]]):
+    def description(self, value: Optional[pulumi.Input[_builtins.str]]):
         pulumi.set(self, "description", value)
 
 
 @pulumi.input_type
 class _NrqlDropRuleState:
     def __init__(__self__, *,
-                 account_id: Optional[pulumi.Input[str]] = None,
-                 action: Optional[pulumi.Input[str]] = None,
-                 description: Optional[pulumi.Input[str]] = None,
-                 nrql: Optional[pulumi.Input[str]] = None,
-                 rule_id: Optional[pulumi.Input[str]] = None):
+                 account_id: Optional[pulumi.Input[_builtins.str]] = None,
+                 action: Optional[pulumi.Input[_builtins.str]] = None,
+                 description: Optional[pulumi.Input[_builtins.str]] = None,
+                 nrql: Optional[pulumi.Input[_builtins.str]] = None,
+                 pipeline_cloud_rule_entity_id: Optional[pulumi.Input[_builtins.str]] = None,
+                 rule_id: Optional[pulumi.Input[_builtins.str]] = None):
         """
         Input properties used for looking up and filtering NrqlDropRule resources.
-        :param pulumi.Input[str] account_id: Account where the drop rule will be put. Defaults to the account associated with the API key used.
-        :param pulumi.Input[str] action: An action type specifying how to apply the NRQL string (either `drop_data`, `drop_attributes`, or ` drop_attributes_from_metric_aggregates`).
-        :param pulumi.Input[str] description: The description of the drop rule.
-        :param pulumi.Input[str] nrql: A NRQL string that specifies what data types to drop.
-        :param pulumi.Input[str] rule_id: The id, uniquely identifying the rule.
+        :param pulumi.Input[_builtins.str] account_id: Account where the drop rule will be put. Defaults to the account associated with the API key used.
+        :param pulumi.Input[_builtins.str] action: An action type specifying how to apply the NRQL string (either `drop_data`, `drop_attributes`, or ` drop_attributes_from_metric_aggregates`).
+        :param pulumi.Input[_builtins.str] description: The description of the drop rule.
+        :param pulumi.Input[_builtins.str] nrql: A NRQL string that specifies what data types to drop.
+        :param pulumi.Input[_builtins.str] pipeline_cloud_rule_entity_id: The ID (GUID) of the corresponding Pipeline Cloud Rule, (migrated upstream by New Relic, in light of the upcoming EOL, as stated in the Deprecation Warning above). This can be used to import the corresponding Pipeline Cloud Rule as a [`PipelineCloudRule`](https://www.terraform.io/providers/newrelic/newrelic/latest/docs/resources/pipeline_cloud_rule) resource, as explained in our Drop Rules EOL Migration Guide.
+        :param pulumi.Input[_builtins.str] rule_id: The id, uniquely identifying the rule.
         """
         if account_id is not None:
             pulumi.set(__self__, "account_id", account_id)
@@ -110,115 +112,96 @@ class _NrqlDropRuleState:
             pulumi.set(__self__, "description", description)
         if nrql is not None:
             pulumi.set(__self__, "nrql", nrql)
+        if pipeline_cloud_rule_entity_id is not None:
+            pulumi.set(__self__, "pipeline_cloud_rule_entity_id", pipeline_cloud_rule_entity_id)
         if rule_id is not None:
             pulumi.set(__self__, "rule_id", rule_id)
 
-    @property
+    @_builtins.property
     @pulumi.getter(name="accountId")
-    def account_id(self) -> Optional[pulumi.Input[str]]:
+    def account_id(self) -> Optional[pulumi.Input[_builtins.str]]:
         """
         Account where the drop rule will be put. 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[str]]):
+    def account_id(self, value: Optional[pulumi.Input[_builtins.str]]):
         pulumi.set(self, "account_id", value)
 
-    @property
+    @_builtins.property
     @pulumi.getter
-    def action(self) -> Optional[pulumi.Input[str]]:
+    def action(self) -> Optional[pulumi.Input[_builtins.str]]:
         """
         An action type specifying how to apply the NRQL string (either `drop_data`, `drop_attributes`, or ` drop_attributes_from_metric_aggregates`).
         """
         return pulumi.get(self, "action")
 
     @action.setter
-    def action(self, value: Optional[pulumi.Input[str]]):
+    def action(self, value: Optional[pulumi.Input[_builtins.str]]):
         pulumi.set(self, "action", value)
 
-    @property
+    @_builtins.property
     @pulumi.getter
-    def description(self) -> Optional[pulumi.Input[str]]:
+    def description(self) -> Optional[pulumi.Input[_builtins.str]]:
         """
         The description of the drop rule.
         """
         return pulumi.get(self, "description")
 
     @description.setter
-    def description(self, value: Optional[pulumi.Input[str]]):
+    def description(self, value: Optional[pulumi.Input[_builtins.str]]):
         pulumi.set(self, "description", value)
 
-    @property
+    @_builtins.property
     @pulumi.getter
-    def nrql(self) -> Optional[pulumi.Input[str]]:
+    def nrql(self) -> Optional[pulumi.Input[_builtins.str]]:
         """
         A NRQL string that specifies what data types to drop.
         """
         return pulumi.get(self, "nrql")
 
     @nrql.setter
-    def nrql(self, value: Optional[pulumi.Input[str]]):
+    def nrql(self, value: Optional[pulumi.Input[_builtins.str]]):
         pulumi.set(self, "nrql", value)
 
-    @property
+    @_builtins.property
+    @pulumi.getter(name="pipelineCloudRuleEntityId")
+    def pipeline_cloud_rule_entity_id(self) -> Optional[pulumi.Input[_builtins.str]]:
+        """
+        The ID (GUID) of the corresponding Pipeline Cloud Rule, (migrated upstream by New Relic, in light of the upcoming EOL, as stated in the Deprecation Warning above). This can be used to import the corresponding Pipeline Cloud Rule as a [`PipelineCloudRule`](https://www.terraform.io/providers/newrelic/newrelic/latest/docs/resources/pipeline_cloud_rule) resource, as explained in our Drop Rules EOL Migration Guide.
+        """
+        return pulumi.get(self, "pipeline_cloud_rule_entity_id")
+
+    @pipeline_cloud_rule_entity_id.setter
+    def pipeline_cloud_rule_entity_id(self, value: Optional[pulumi.Input[_builtins.str]]):
+        pulumi.set(self, "pipeline_cloud_rule_entity_id", value)
+
+    @_builtins.property
     @pulumi.getter(name="ruleId")
-    def rule_id(self) -> Optional[pulumi.Input[str]]:
+    def rule_id(self) -> Optional[pulumi.Input[_builtins.str]]:
         """
         The id, uniquely identifying the rule.
         """
         return pulumi.get(self, "rule_id")
 
     @rule_id.setter
-    def rule_id(self, value: Optional[pulumi.Input[str]]):
+    def rule_id(self, value: Optional[pulumi.Input[_builtins.str]]):
         pulumi.set(self, "rule_id", value)
 
 
+@pulumi.type_token("newrelic:index/nrqlDropRule:NrqlDropRule")
 class NrqlDropRule(pulumi.CustomResource):
     @overload
     def __init__(__self__,
                  resource_name: str,
                  opts: Optional[pulumi.ResourceOptions] = None,
-                 account_id: Optional[pulumi.Input[str]] = None,
-                 action: Optional[pulumi.Input[str]] = None,
-                 description: Optional[pulumi.Input[str]] = None,
-                 nrql: Optional[pulumi.Input[str]] = None,
+                 account_id: Optional[pulumi.Input[_builtins.str]] = None,
+                 action: Optional[pulumi.Input[_builtins.str]] = None,
+                 description: Optional[pulumi.Input[_builtins.str]] = None,
+                 nrql: Optional[pulumi.Input[_builtins.str]] = None,
                  __props__=None):
         """
-        ## Example Usage
-
-        ```python
-        import pulumi
-        import pulumi_newrelic as newrelic
-
-        foo = newrelic.NrqlDropRule("foo",
-            account_id="12345",
-            description="Drops all data for MyCustomEvent that comes from the LoadGeneratingApp in the dev environment, because there is too much and we don’t look at it.",
-            action="drop_data",
-            nrql="SELECT * FROM MyCustomEvent WHERE appName='LoadGeneratingApp' AND environment='development'")
-        bar = newrelic.NrqlDropRule("bar",
-            account_id="12345",
-            description="Removes the user name and email fields from MyCustomEvent",
-            action="drop_attributes",
-            nrql="SELECT userEmail, userName FROM MyCustomEvent")
-        baz = newrelic.NrqlDropRule("baz",
-            account_id="12345",
-            description="Removes containerId from metric aggregates to reduce metric cardinality.",
-            action="drop_attributes_from_metric_aggregates",
-            nrql="SELECT containerId FROM Metric")
-        ```
-
-        ## Using `newrelic-cli` to List Out Drop Rules
-
-        All NRQL Drop Rules associated with a New Relic account may be listed out using the following newrelic-cli command:
-
-        This would print all drop rules associated with your New Relic account to the terminal.
-        The number of rules to be printed can be customized using the `limit` argument of this command.
-        For instance, the following command limits the number of drop rules printed to two.
-
-        More details on the command and its arguments (for instance, the format in which the droprules are to be listed in the terminal, which is JSON by default) can be found in the output of the `newrelic nrql droprules --help` command.
-        If you do not have **newrelic-cli** installed on your device already, head over to [this page](https://github.com/newrelic/newrelic-cli#installation--upgrades) for instructions.
-
         ## Import
 
         New Relic NRQL drop rules can be imported using a concatenated string of the format
@@ -233,10 +216,10 @@ class NrqlDropRule(pulumi.CustomResource):
 
         :param str resource_name: The name of the resource.
         :param pulumi.ResourceOptions opts: Options for the resource.
-        :param pulumi.Input[str] account_id: Account where the drop rule will be put. Defaults to the account associated with the API key used.
-        :param pulumi.Input[str] action: An action type specifying how to apply the NRQL string (either `drop_data`, `drop_attributes`, or ` drop_attributes_from_metric_aggregates`).
-        :param pulumi.Input[str] description: The description of the drop rule.
-        :param pulumi.Input[str] nrql: A NRQL string that specifies what data types to drop.
+        :param pulumi.Input[_builtins.str] account_id: Account where the drop rule will be put. Defaults to the account associated with the API key used.
+        :param pulumi.Input[_builtins.str] action: An action type specifying how to apply the NRQL string (either `drop_data`, `drop_attributes`, or ` drop_attributes_from_metric_aggregates`).
+        :param pulumi.Input[_builtins.str] description: The description of the drop rule.
+        :param pulumi.Input[_builtins.str] nrql: A NRQL string that specifies what data types to drop.
         """
         ...
     @overload
@@ -245,40 +228,6 @@ class NrqlDropRule(pulumi.CustomResource):
                  args: NrqlDropRuleArgs,
                  opts: Optional[pulumi.ResourceOptions] = None):
         """
-        ## Example Usage
-
-        ```python
-        import pulumi
-        import pulumi_newrelic as newrelic
-
-        foo = newrelic.NrqlDropRule("foo",
-            account_id="12345",
-            description="Drops all data for MyCustomEvent that comes from the LoadGeneratingApp in the dev environment, because there is too much and we don’t look at it.",
-            action="drop_data",
-            nrql="SELECT * FROM MyCustomEvent WHERE appName='LoadGeneratingApp' AND environment='development'")
-        bar = newrelic.NrqlDropRule("bar",
-            account_id="12345",
-            description="Removes the user name and email fields from MyCustomEvent",
-            action="drop_attributes",
-            nrql="SELECT userEmail, userName FROM MyCustomEvent")
-        baz = newrelic.NrqlDropRule("baz",
-            account_id="12345",
-            description="Removes containerId from metric aggregates to reduce metric cardinality.",
-            action="drop_attributes_from_metric_aggregates",
-            nrql="SELECT containerId FROM Metric")
-        ```
-
-        ## Using `newrelic-cli` to List Out Drop Rules
-
-        All NRQL Drop Rules associated with a New Relic account may be listed out using the following newrelic-cli command:
-
-        This would print all drop rules associated with your New Relic account to the terminal.
-        The number of rules to be printed can be customized using the `limit` argument of this command.
-        For instance, the following command limits the number of drop rules printed to two.
-
-        More details on the command and its arguments (for instance, the format in which the droprules are to be listed in the terminal, which is JSON by default) can be found in the output of the `newrelic nrql droprules --help` command.
-        If you do not have **newrelic-cli** installed on your device already, head over to [this page](https://github.com/newrelic/newrelic-cli#installation--upgrades) for instructions.
-
         ## Import
 
         New Relic NRQL drop rules can be imported using a concatenated string of the format
@@ -306,10 +255,10 @@ class NrqlDropRule(pulumi.CustomResource):
     def _internal_init(__self__,
                  resource_name: str,
                  opts: Optional[pulumi.ResourceOptions] = None,
-                 account_id: Optional[pulumi.Input[str]] = None,
-                 action: Optional[pulumi.Input[str]] = None,
-                 description: Optional[pulumi.Input[str]] = None,
-                 nrql: Optional[pulumi.Input[str]] = None,
+                 account_id: Optional[pulumi.Input[_builtins.str]] = None,
+                 action: Optional[pulumi.Input[_builtins.str]] = None,
+                 description: Optional[pulumi.Input[_builtins.str]] = None,
+                 nrql: Optional[pulumi.Input[_builtins.str]] = None,
                  __props__=None):
         opts = pulumi.ResourceOptions.merge(_utilities.get_resource_opts_defaults(), opts)
         if not isinstance(opts, pulumi.ResourceOptions):
@@ -327,6 +276,7 @@ class NrqlDropRule(pulumi.CustomResource):
             if nrql is None and not opts.urn:
                 raise TypeError("Missing required property 'nrql'")
             __props__.__dict__["nrql"] = nrql
+            __props__.__dict__["pipeline_cloud_rule_entity_id"] = None
             __props__.__dict__["rule_id"] = None
         super(NrqlDropRule, __self__).__init__(
             'newrelic:index/nrqlDropRule:NrqlDropRule',
@@ -338,11 +288,12 @@ class NrqlDropRule(pulumi.CustomResource):
     def get(resource_name: str,
             id: pulumi.Input[str],
             opts: Optional[pulumi.ResourceOptions] = None,
-            account_id: Optional[pulumi.Input[str]] = None,
-            action: Optional[pulumi.Input[str]] = None,
-            description: Optional[pulumi.Input[str]] = None,
-            nrql: Optional[pulumi.Input[str]] = None,
-            rule_id: Optional[pulumi.Input[str]] = None) -> 'NrqlDropRule':
+            account_id: Optional[pulumi.Input[_builtins.str]] = None,
+            action: Optional[pulumi.Input[_builtins.str]] = None,
+            description: Optional[pulumi.Input[_builtins.str]] = None,
+            nrql: Optional[pulumi.Input[_builtins.str]] = None,
+            pipeline_cloud_rule_entity_id: Optional[pulumi.Input[_builtins.str]] = None,
+            rule_id: Optional[pulumi.Input[_builtins.str]] = None) -> 'NrqlDropRule':
         """
         Get an existing NrqlDropRule resource's state with the given name, id, and optional extra
         properties used to qualify the lookup.
@@ -350,11 +301,12 @@ class NrqlDropRule(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] account_id: Account where the drop rule will be put. Defaults to the account associated with the API key used.
-        :param pulumi.Input[str] action: An action type specifying how to apply the NRQL string (either `drop_data`, `drop_attributes`, or ` drop_attributes_from_metric_aggregates`).
-        :param pulumi.Input[str] description: The description of the drop rule.
-        :param pulumi.Input[str] nrql: A NRQL string that specifies what data types to drop.
-        :param pulumi.Input[str] rule_id: The id, uniquely identifying the rule.
+        :param pulumi.Input[_builtins.str] account_id: Account where the drop rule will be put. Defaults to the account associated with the API key used.
+        :param pulumi.Input[_builtins.str] action: An action type specifying how to apply the NRQL string (either `drop_data`, `drop_attributes`, or ` drop_attributes_from_metric_aggregates`).
+        :param pulumi.Input[_builtins.str] description: The description of the drop rule.
+        :param pulumi.Input[_builtins.str] nrql: A NRQL string that specifies what data types to drop.
+        :param pulumi.Input[_builtins.str] pipeline_cloud_rule_entity_id: The ID (GUID) of the corresponding Pipeline Cloud Rule, (migrated upstream by New Relic, in light of the upcoming EOL, as stated in the Deprecation Warning above). This can be used to import the corresponding Pipeline Cloud Rule as a [`PipelineCloudRule`](https://www.terraform.io/providers/newrelic/newrelic/latest/docs/resources/pipeline_cloud_rule) resource, as explained in our Drop Rules EOL Migration Guide.
+        :param pulumi.Input[_builtins.str] rule_id: The id, uniquely identifying the rule.
         """
         opts = pulumi.ResourceOptions.merge(opts, pulumi.ResourceOptions(id=id))
 
@@ -364,44 +316,53 @@ class NrqlDropRule(pulumi.CustomResource):
         __props__.__dict__["action"] = action
         __props__.__dict__["description"] = description
         __props__.__dict__["nrql"] = nrql
+        __props__.__dict__["pipeline_cloud_rule_entity_id"] = pipeline_cloud_rule_entity_id
         __props__.__dict__["rule_id"] = rule_id
         return NrqlDropRule(resource_name, opts=opts, __props__=__props__)
 
-    @property
+    @_builtins.property
     @pulumi.getter(name="accountId")
-    def account_id(self) -> pulumi.Output[str]:
+    def account_id(self) -> pulumi.Output[_builtins.str]:
         """
         Account where the drop rule will be put. Defaults to the account associated with the API key used.
         """
         return pulumi.get(self, "account_id")
 
-    @property
+    @_builtins.property
     @pulumi.getter
-    def action(self) -> pulumi.Output[str]:
+    def action(self) -> pulumi.Output[_builtins.str]:
         """
         An action type specifying how to apply the NRQL string (either `drop_data`, `drop_attributes`, or ` drop_attributes_from_metric_aggregates`).
         """
         return pulumi.get(self, "action")
 
-    @property
+    @_builtins.property
     @pulumi.getter
-    def description(self) -> pulumi.Output[Optional[str]]:
+    def description(self) -> pulumi.Output[Optional[_builtins.str]]:
         """
         The description of the drop rule.
         """
         return pulumi.get(self, "description")
 
-    @property
+    @_builtins.property
     @pulumi.getter
-    def nrql(self) -> pulumi.Output[str]:
+    def nrql(self) -> pulumi.Output[_builtins.str]:
         """
         A NRQL string that specifies what data types to drop.
         """
         return pulumi.get(self, "nrql")
 
-    @property
+    @_builtins.property
+    @pulumi.getter(name="pipelineCloudRuleEntityId")
+    def pipeline_cloud_rule_entity_id(self) -> pulumi.Output[_builtins.str]:
+        """
+        The ID (GUID) of the corresponding Pipeline Cloud Rule, (migrated upstream by New Relic, in light of the upcoming EOL, as stated in the Deprecation Warning above). This can be used to import the corresponding Pipeline Cloud Rule as a [`PipelineCloudRule`](https://www.terraform.io/providers/newrelic/newrelic/latest/docs/resources/pipeline_cloud_rule) resource, as explained in our Drop Rules EOL Migration Guide.
+        """
+        return pulumi.get(self, "pipeline_cloud_rule_entity_id")
+
+    @_builtins.property
     @pulumi.getter(name="ruleId")
-    def rule_id(self) -> pulumi.Output[str]:
+    def rule_id(self) -> pulumi.Output[_builtins.str]:
         """
         The id, uniquely identifying the rule.
         """