pulumi-signalfx 7.2.0a1709367777__py3-none-any.whl → 7.6.0a1736835428__py3-none-any.whl

pulumi_signalfx/org_token.py

@@ -4,9 +4,14 @@
 
 import copy
 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
 from . import outputs
 from ._inputs import *
@@ -26,12 +31,12 @@ class OrgTokenArgs:
         """
         The set of arguments for constructing a OrgToken resource.
         :param pulumi.Input[Sequence[pulumi.Input[str]]] auth_scopes: Authentication scope, ex: INGEST, API, RUM ... (Optional)
-        :param pulumi.Input[str] description: Description of the token (Optional)
-        :param pulumi.Input[bool] disabled: Flag that controls enabling the token. If set to `true`, the token is disabled, and you can't use it for authentication.
-               Defaults to `false`
-        :param pulumi.Input[str] name: Name of the token
-        :param pulumi.Input[Sequence[pulumi.Input[str]]] notifications: List of strings specifying where notifications will be sent when an incident occurs. See
-               https://developers.signalfx.com/v2/docs/detector-model#notifications-models for more info
+        :param pulumi.Input[str] description: Description of the token.
+        :param pulumi.Input[bool] disabled: Flag that controls enabling the token. If set to `true`, the token is disabled, and you can't use it for authentication. Defaults to `false`.
+        :param pulumi.Input['OrgTokenDpmLimitsArgs'] dpm_limits: Specify DPM-based limits for this token.
+        :param pulumi.Input['OrgTokenHostOrUsageLimitsArgs'] host_or_usage_limits: Specify Usage-based limits for this token.
+        :param pulumi.Input[str] name: Name of the token.
+        :param pulumi.Input[Sequence[pulumi.Input[str]]] notifications: Where to send notifications about this token's limits. See the Notification Format laid out in detectors.
         """
         if auth_scopes is not None:
             pulumi.set(__self__, "auth_scopes", auth_scopes)
@@ -64,7 +69,7 @@ class OrgTokenArgs:
     @pulumi.getter
     def description(self) -> Optional[pulumi.Input[str]]:
         """
-        Description of the token (Optional)
+        Description of the token.
         """
         return pulumi.get(self, "description")
 
@@ -76,8 +81,7 @@ class OrgTokenArgs:
     @pulumi.getter
     def disabled(self) -> Optional[pulumi.Input[bool]]:
         """
-        Flag that controls enabling the token. If set to `true`, the token is disabled, and you can't use it for authentication.
-        Defaults to `false`
+        Flag that controls enabling the token. If set to `true`, the token is disabled, and you can't use it for authentication. Defaults to `false`.
         """
         return pulumi.get(self, "disabled")
 
@@ -88,6 +92,9 @@ class OrgTokenArgs:
     @property
     @pulumi.getter(name="dpmLimits")
     def dpm_limits(self) -> Optional[pulumi.Input['OrgTokenDpmLimitsArgs']]:
+        """
+        Specify DPM-based limits for this token.
+        """
         return pulumi.get(self, "dpm_limits")
 
     @dpm_limits.setter
@@ -97,6 +104,9 @@ class OrgTokenArgs:
     @property
     @pulumi.getter(name="hostOrUsageLimits")
     def host_or_usage_limits(self) -> Optional[pulumi.Input['OrgTokenHostOrUsageLimitsArgs']]:
+        """
+        Specify Usage-based limits for this token.
+        """
         return pulumi.get(self, "host_or_usage_limits")
 
     @host_or_usage_limits.setter
@@ -107,7 +117,7 @@ class OrgTokenArgs:
     @pulumi.getter
     def name(self) -> Optional[pulumi.Input[str]]:
         """
-        Name of the token
+        Name of the token.
         """
         return pulumi.get(self, "name")
 
@@ -119,8 +129,7 @@ class OrgTokenArgs:
     @pulumi.getter
     def notifications(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
         """
-        List of strings specifying where notifications will be sent when an incident occurs. See
-        https://developers.signalfx.com/v2/docs/detector-model#notifications-models for more info
+        Where to send notifications about this token's limits. See the Notification Format laid out in detectors.
         """
         return pulumi.get(self, "notifications")
 
@@ -143,12 +152,13 @@ class _OrgTokenState:
         """
         Input properties used for looking up and filtering OrgToken resources.
         :param pulumi.Input[Sequence[pulumi.Input[str]]] auth_scopes: Authentication scope, ex: INGEST, API, RUM ... (Optional)
-        :param pulumi.Input[str] description: Description of the token (Optional)
-        :param pulumi.Input[bool] disabled: Flag that controls enabling the token. If set to `true`, the token is disabled, and you can't use it for authentication.
-               Defaults to `false`
-        :param pulumi.Input[str] name: Name of the token
-        :param pulumi.Input[Sequence[pulumi.Input[str]]] notifications: List of strings specifying where notifications will be sent when an incident occurs. See
-               https://developers.signalfx.com/v2/docs/detector-model#notifications-models for more info
+        :param pulumi.Input[str] description: Description of the token.
+        :param pulumi.Input[bool] disabled: Flag that controls enabling the token. If set to `true`, the token is disabled, and you can't use it for authentication. Defaults to `false`.
+        :param pulumi.Input['OrgTokenDpmLimitsArgs'] dpm_limits: Specify DPM-based limits for this token.
+        :param pulumi.Input['OrgTokenHostOrUsageLimitsArgs'] host_or_usage_limits: Specify Usage-based limits for this token.
+        :param pulumi.Input[str] name: Name of the token.
+        :param pulumi.Input[Sequence[pulumi.Input[str]]] notifications: Where to send notifications about this token's limits. See the Notification Format laid out in detectors.
+        :param pulumi.Input[str] secret: The secret token created by the API. You cannot set this value.
         """
         if auth_scopes is not None:
             pulumi.set(__self__, "auth_scopes", auth_scopes)
@@ -183,7 +193,7 @@ class _OrgTokenState:
     @pulumi.getter
     def description(self) -> Optional[pulumi.Input[str]]:
         """
-        Description of the token (Optional)
+        Description of the token.
         """
         return pulumi.get(self, "description")
 
@@ -195,8 +205,7 @@ class _OrgTokenState:
     @pulumi.getter
     def disabled(self) -> Optional[pulumi.Input[bool]]:
         """
-        Flag that controls enabling the token. If set to `true`, the token is disabled, and you can't use it for authentication.
-        Defaults to `false`
+        Flag that controls enabling the token. If set to `true`, the token is disabled, and you can't use it for authentication. Defaults to `false`.
         """
         return pulumi.get(self, "disabled")
 
@@ -207,6 +216,9 @@ class _OrgTokenState:
     @property
     @pulumi.getter(name="dpmLimits")
     def dpm_limits(self) -> Optional[pulumi.Input['OrgTokenDpmLimitsArgs']]:
+        """
+        Specify DPM-based limits for this token.
+        """
         return pulumi.get(self, "dpm_limits")
 
     @dpm_limits.setter
@@ -216,6 +228,9 @@ class _OrgTokenState:
     @property
     @pulumi.getter(name="hostOrUsageLimits")
     def host_or_usage_limits(self) -> Optional[pulumi.Input['OrgTokenHostOrUsageLimitsArgs']]:
+        """
+        Specify Usage-based limits for this token.
+        """
         return pulumi.get(self, "host_or_usage_limits")
 
     @host_or_usage_limits.setter
@@ -226,7 +241,7 @@ class _OrgTokenState:
     @pulumi.getter
     def name(self) -> Optional[pulumi.Input[str]]:
         """
-        Name of the token
+        Name of the token.
         """
         return pulumi.get(self, "name")
 
@@ -238,8 +253,7 @@ class _OrgTokenState:
     @pulumi.getter
     def notifications(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
         """
-        List of strings specifying where notifications will be sent when an incident occurs. See
-        https://developers.signalfx.com/v2/docs/detector-model#notifications-models for more info
+        Where to send notifications about this token's limits. See the Notification Format laid out in detectors.
         """
         return pulumi.get(self, "notifications")
 
@@ -250,6 +264,9 @@ class _OrgTokenState:
     @property
     @pulumi.getter
     def secret(self) -> Optional[pulumi.Input[str]]:
+        """
+        The secret token created by the API. You cannot set this value.
+        """
         return pulumi.get(self, "secret")
 
     @secret.setter
@@ -265,8 +282,8 @@ class OrgToken(pulumi.CustomResource):
                  auth_scopes: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                  description: Optional[pulumi.Input[str]] = None,
                  disabled: Optional[pulumi.Input[bool]] = None,
-                 dpm_limits: Optional[pulumi.Input[pulumi.InputType['OrgTokenDpmLimitsArgs']]] = None,
-                 host_or_usage_limits: Optional[pulumi.Input[pulumi.InputType['OrgTokenHostOrUsageLimitsArgs']]] = None,
+                 dpm_limits: Optional[pulumi.Input[Union['OrgTokenDpmLimitsArgs', 'OrgTokenDpmLimitsArgsDict']]] = None,
+                 host_or_usage_limits: Optional[pulumi.Input[Union['OrgTokenHostOrUsageLimitsArgs', 'OrgTokenHostOrUsageLimitsArgsDict']]] = None,
                  name: Optional[pulumi.Input[str]] = None,
                  notifications: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                  __props__=None):
@@ -282,58 +299,30 @@ class OrgToken(pulumi.CustomResource):
         import pulumi_signalfx as signalfx
 
         myteamkey0 = signalfx.OrgToken("myteamkey0",
+            name="TeamIDKey",
             description="My team's rad key",
-            host_or_usage_limits=signalfx.OrgTokenHostOrUsageLimitsArgs(
-                container_limit=200,
-                container_notification_threshold=180,
-                custom_metrics_limit=1000,
-                custom_metrics_notification_threshold=900,
-                high_res_metrics_limit=1000,
-                high_res_metrics_notification_threshold=900,
-                host_limit=100,
-                host_notification_threshold=90,
-            ),
-            notifications=["Email,foo-alerts@bar.com"])
+            notifications=["Email,foo-alerts@bar.com"],
+            host_or_usage_limits={
+                "host_limit": 100,
+                "host_notification_threshold": 90,
+                "container_limit": 200,
+                "container_notification_threshold": 180,
+                "custom_metrics_limit": 1000,
+                "custom_metrics_notification_threshold": 900,
+                "high_res_metrics_limit": 1000,
+                "high_res_metrics_notification_threshold": 900,
+            })
         ```
 
-        ## Arguments
-
-        The following arguments are supported in the resource block:
-
-        * `name` - (Required) Name of the token.
-        * `description` - (Optional) Description of the token.
-        * `disabled` - (Optional) Flag that controls enabling the token. If set to `true`, the token is disabled, and you can't use it for authentication. Defaults to `false`.
-        * `secret` - The secret token created by the API. You cannot set this value.
-        * `notifications` - (Optional) Where to send notifications about this token's limits. See the Notification Format laid out in detectors.
-        * `host_or_usage_limits` - (Optional) Specify Usage-based limits for this token.
-          * `host_limit` - (Optional) Max number of hosts that can use this token
-          * `host_notification_threshold` - (Optional) Notification threshold for hosts
-          * `container_limit` - (Optional) Max number of Docker containers that can use this token
-          * `container_notification_threshold` - (Optional) Notification threshold for Docker containers
-          * `custom_metrics_limit` - (Optional) Max number of custom metrics that can be sent with this token
-          * `custom_metrics_notification_threshold` - (Optional) Notification threshold for custom metrics
-          * `high_res_metrics_limit` - (Optional) Max number of hi-res metrics that can be sent with this toke
-          * `high_res_metrics_notification_threshold` - (Optional) Notification threshold for hi-res metrics
-        * `dpm_limits` (Optional) Specify DPM-based limits for this token.
-          * `dpm_notification_threshold` - (Optional) DPM level at which Splunk Observability Cloud sends the notification for this token. If you don't specify a notification, Splunk Observability Cloud sends the generic notification.
-          * `dpm_limit` - (Required) The datapoints per minute (dpm) limit for this token. If you exceed this limit, Splunk Observability Cloud sends out an alert.
-
-        ## Attributes
-
-        In a addition to all arguments above, the following attributes are exported:
-
-        * `id` - The ID of the token.
-        * `secret` - The assigned token.
-
         :param str resource_name: The name of the resource.
         :param pulumi.ResourceOptions opts: Options for the resource.
         :param pulumi.Input[Sequence[pulumi.Input[str]]] auth_scopes: Authentication scope, ex: INGEST, API, RUM ... (Optional)
-        :param pulumi.Input[str] description: Description of the token (Optional)
-        :param pulumi.Input[bool] disabled: Flag that controls enabling the token. If set to `true`, the token is disabled, and you can't use it for authentication.
-               Defaults to `false`
-        :param pulumi.Input[str] name: Name of the token
-        :param pulumi.Input[Sequence[pulumi.Input[str]]] notifications: List of strings specifying where notifications will be sent when an incident occurs. See
-               https://developers.signalfx.com/v2/docs/detector-model#notifications-models for more info
+        :param pulumi.Input[str] description: Description of the token.
+        :param pulumi.Input[bool] disabled: Flag that controls enabling the token. If set to `true`, the token is disabled, and you can't use it for authentication. Defaults to `false`.
+        :param pulumi.Input[Union['OrgTokenDpmLimitsArgs', 'OrgTokenDpmLimitsArgsDict']] dpm_limits: Specify DPM-based limits for this token.
+        :param pulumi.Input[Union['OrgTokenHostOrUsageLimitsArgs', 'OrgTokenHostOrUsageLimitsArgsDict']] host_or_usage_limits: Specify Usage-based limits for this token.
+        :param pulumi.Input[str] name: Name of the token.
+        :param pulumi.Input[Sequence[pulumi.Input[str]]] notifications: Where to send notifications about this token's limits. See the Notification Format laid out in detectors.
         """
         ...
     @overload
@@ -353,49 +342,21 @@ class OrgToken(pulumi.CustomResource):
         import pulumi_signalfx as signalfx
 
         myteamkey0 = signalfx.OrgToken("myteamkey0",
+            name="TeamIDKey",
             description="My team's rad key",
-            host_or_usage_limits=signalfx.OrgTokenHostOrUsageLimitsArgs(
-                container_limit=200,
-                container_notification_threshold=180,
-                custom_metrics_limit=1000,
-                custom_metrics_notification_threshold=900,
-                high_res_metrics_limit=1000,
-                high_res_metrics_notification_threshold=900,
-                host_limit=100,
-                host_notification_threshold=90,
-            ),
-            notifications=["Email,foo-alerts@bar.com"])
+            notifications=["Email,foo-alerts@bar.com"],
+            host_or_usage_limits={
+                "host_limit": 100,
+                "host_notification_threshold": 90,
+                "container_limit": 200,
+                "container_notification_threshold": 180,
+                "custom_metrics_limit": 1000,
+                "custom_metrics_notification_threshold": 900,
+                "high_res_metrics_limit": 1000,
+                "high_res_metrics_notification_threshold": 900,
+            })
         ```
 
-        ## Arguments
-
-        The following arguments are supported in the resource block:
-
-        * `name` - (Required) Name of the token.
-        * `description` - (Optional) Description of the token.
-        * `disabled` - (Optional) Flag that controls enabling the token. If set to `true`, the token is disabled, and you can't use it for authentication. Defaults to `false`.
-        * `secret` - The secret token created by the API. You cannot set this value.
-        * `notifications` - (Optional) Where to send notifications about this token's limits. See the Notification Format laid out in detectors.
-        * `host_or_usage_limits` - (Optional) Specify Usage-based limits for this token.
-          * `host_limit` - (Optional) Max number of hosts that can use this token
-          * `host_notification_threshold` - (Optional) Notification threshold for hosts
-          * `container_limit` - (Optional) Max number of Docker containers that can use this token
-          * `container_notification_threshold` - (Optional) Notification threshold for Docker containers
-          * `custom_metrics_limit` - (Optional) Max number of custom metrics that can be sent with this token
-          * `custom_metrics_notification_threshold` - (Optional) Notification threshold for custom metrics
-          * `high_res_metrics_limit` - (Optional) Max number of hi-res metrics that can be sent with this toke
-          * `high_res_metrics_notification_threshold` - (Optional) Notification threshold for hi-res metrics
-        * `dpm_limits` (Optional) Specify DPM-based limits for this token.
-          * `dpm_notification_threshold` - (Optional) DPM level at which Splunk Observability Cloud sends the notification for this token. If you don't specify a notification, Splunk Observability Cloud sends the generic notification.
-          * `dpm_limit` - (Required) The datapoints per minute (dpm) limit for this token. If you exceed this limit, Splunk Observability Cloud sends out an alert.
-
-        ## Attributes
-
-        In a addition to all arguments above, the following attributes are exported:
-
-        * `id` - The ID of the token.
-        * `secret` - The assigned token.
-
         :param str resource_name: The name of the resource.
         :param OrgTokenArgs args: The arguments to use to populate this resource's properties.
         :param pulumi.ResourceOptions opts: Options for the resource.
@@ -414,8 +375,8 @@ class OrgToken(pulumi.CustomResource):
                  auth_scopes: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                  description: Optional[pulumi.Input[str]] = None,
                  disabled: Optional[pulumi.Input[bool]] = None,
-                 dpm_limits: Optional[pulumi.Input[pulumi.InputType['OrgTokenDpmLimitsArgs']]] = None,
-                 host_or_usage_limits: Optional[pulumi.Input[pulumi.InputType['OrgTokenHostOrUsageLimitsArgs']]] = None,
+                 dpm_limits: Optional[pulumi.Input[Union['OrgTokenDpmLimitsArgs', 'OrgTokenDpmLimitsArgsDict']]] = None,
+                 host_or_usage_limits: Optional[pulumi.Input[Union['OrgTokenHostOrUsageLimitsArgs', 'OrgTokenHostOrUsageLimitsArgsDict']]] = None,
                  name: Optional[pulumi.Input[str]] = None,
                  notifications: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                  __props__=None):
@@ -450,8 +411,8 @@ class OrgToken(pulumi.CustomResource):
             auth_scopes: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
             description: Optional[pulumi.Input[str]] = None,
             disabled: Optional[pulumi.Input[bool]] = None,
-            dpm_limits: Optional[pulumi.Input[pulumi.InputType['OrgTokenDpmLimitsArgs']]] = None,
-            host_or_usage_limits: Optional[pulumi.Input[pulumi.InputType['OrgTokenHostOrUsageLimitsArgs']]] = None,
+            dpm_limits: Optional[pulumi.Input[Union['OrgTokenDpmLimitsArgs', 'OrgTokenDpmLimitsArgsDict']]] = None,
+            host_or_usage_limits: Optional[pulumi.Input[Union['OrgTokenHostOrUsageLimitsArgs', 'OrgTokenHostOrUsageLimitsArgsDict']]] = None,
             name: Optional[pulumi.Input[str]] = None,
             notifications: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
             secret: Optional[pulumi.Input[str]] = None) -> 'OrgToken':
@@ -463,12 +424,13 @@ class OrgToken(pulumi.CustomResource):
         :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[Sequence[pulumi.Input[str]]] auth_scopes: Authentication scope, ex: INGEST, API, RUM ... (Optional)
-        :param pulumi.Input[str] description: Description of the token (Optional)
-        :param pulumi.Input[bool] disabled: Flag that controls enabling the token. If set to `true`, the token is disabled, and you can't use it for authentication.
-               Defaults to `false`
-        :param pulumi.Input[str] name: Name of the token
-        :param pulumi.Input[Sequence[pulumi.Input[str]]] notifications: List of strings specifying where notifications will be sent when an incident occurs. See
-               https://developers.signalfx.com/v2/docs/detector-model#notifications-models for more info
+        :param pulumi.Input[str] description: Description of the token.
+        :param pulumi.Input[bool] disabled: Flag that controls enabling the token. If set to `true`, the token is disabled, and you can't use it for authentication. Defaults to `false`.
+        :param pulumi.Input[Union['OrgTokenDpmLimitsArgs', 'OrgTokenDpmLimitsArgsDict']] dpm_limits: Specify DPM-based limits for this token.
+        :param pulumi.Input[Union['OrgTokenHostOrUsageLimitsArgs', 'OrgTokenHostOrUsageLimitsArgsDict']] host_or_usage_limits: Specify Usage-based limits for this token.
+        :param pulumi.Input[str] name: Name of the token.
+        :param pulumi.Input[Sequence[pulumi.Input[str]]] notifications: Where to send notifications about this token's limits. See the Notification Format laid out in detectors.
+        :param pulumi.Input[str] secret: The secret token created by the API. You cannot set this value.
         """
         opts = pulumi.ResourceOptions.merge(opts, pulumi.ResourceOptions(id=id))
 
@@ -496,7 +458,7 @@ class OrgToken(pulumi.CustomResource):
     @pulumi.getter
     def description(self) -> pulumi.Output[Optional[str]]:
         """
-        Description of the token (Optional)
+        Description of the token.
         """
         return pulumi.get(self, "description")
 
@@ -504,26 +466,31 @@ class OrgToken(pulumi.CustomResource):
     @pulumi.getter
     def disabled(self) -> pulumi.Output[Optional[bool]]:
         """
-        Flag that controls enabling the token. If set to `true`, the token is disabled, and you can't use it for authentication.
-        Defaults to `false`
+        Flag that controls enabling the token. If set to `true`, the token is disabled, and you can't use it for authentication. Defaults to `false`.
         """
         return pulumi.get(self, "disabled")
 
     @property
     @pulumi.getter(name="dpmLimits")
     def dpm_limits(self) -> pulumi.Output[Optional['outputs.OrgTokenDpmLimits']]:
+        """
+        Specify DPM-based limits for this token.
+        """
         return pulumi.get(self, "dpm_limits")
 
     @property
     @pulumi.getter(name="hostOrUsageLimits")
     def host_or_usage_limits(self) -> pulumi.Output[Optional['outputs.OrgTokenHostOrUsageLimits']]:
+        """
+        Specify Usage-based limits for this token.
+        """
         return pulumi.get(self, "host_or_usage_limits")
 
     @property
     @pulumi.getter
     def name(self) -> pulumi.Output[str]:
         """
-        Name of the token
+        Name of the token.
         """
         return pulumi.get(self, "name")
 
@@ -531,13 +498,15 @@ class OrgToken(pulumi.CustomResource):
     @pulumi.getter
     def notifications(self) -> pulumi.Output[Optional[Sequence[str]]]:
         """
-        List of strings specifying where notifications will be sent when an incident occurs. See
-        https://developers.signalfx.com/v2/docs/detector-model#notifications-models for more info
+        Where to send notifications about this token's limits. See the Notification Format laid out in detectors.
         """
         return pulumi.get(self, "notifications")
 
     @property
     @pulumi.getter
     def secret(self) -> pulumi.Output[str]:
+        """
+        The secret token created by the API. You cannot set this value.
+        """
         return pulumi.get(self, "secret")