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

pulumi_signalfx/text_chart.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
 
 __all__ = ['TextChartArgs', 'TextChart']
@@ -19,9 +24,9 @@ class TextChartArgs:
                  name: Optional[pulumi.Input[str]] = None):
         """
         The set of arguments for constructing a TextChart resource.
-        :param pulumi.Input[str] markdown: Markdown text to display. More info at: https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet
-        :param pulumi.Input[str] description: Description of the chart (Optional)
-        :param pulumi.Input[str] name: Name of the chart
+        :param pulumi.Input[str] markdown: Markdown text to display.
+        :param pulumi.Input[str] description: Description of the text note.
+        :param pulumi.Input[str] name: Name of the text note.
         """
         pulumi.set(__self__, "markdown", markdown)
         if description is not None:
@@ -33,7 +38,7 @@ class TextChartArgs:
     @pulumi.getter
     def markdown(self) -> pulumi.Input[str]:
         """
-        Markdown text to display. More info at: https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet
+        Markdown text to display.
         """
         return pulumi.get(self, "markdown")
 
@@ -45,7 +50,7 @@ class TextChartArgs:
     @pulumi.getter
     def description(self) -> Optional[pulumi.Input[str]]:
         """
-        Description of the chart (Optional)
+        Description of the text note.
         """
         return pulumi.get(self, "description")
 
@@ -57,7 +62,7 @@ class TextChartArgs:
     @pulumi.getter
     def name(self) -> Optional[pulumi.Input[str]]:
         """
-        Name of the chart
+        Name of the text note.
         """
         return pulumi.get(self, "name")
 
@@ -75,10 +80,10 @@ class _TextChartState:
                  url: Optional[pulumi.Input[str]] = None):
         """
         Input properties used for looking up and filtering TextChart resources.
-        :param pulumi.Input[str] description: Description of the chart (Optional)
-        :param pulumi.Input[str] markdown: Markdown text to display. More info at: https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet
-        :param pulumi.Input[str] name: Name of the chart
-        :param pulumi.Input[str] url: URL of the chart
+        :param pulumi.Input[str] description: Description of the text note.
+        :param pulumi.Input[str] markdown: Markdown text to display.
+        :param pulumi.Input[str] name: Name of the text note.
+        :param pulumi.Input[str] url: The URL of the chart.
         """
         if description is not None:
             pulumi.set(__self__, "description", description)
@@ -93,7 +98,7 @@ class _TextChartState:
     @pulumi.getter
     def description(self) -> Optional[pulumi.Input[str]]:
         """
-        Description of the chart (Optional)
+        Description of the text note.
         """
         return pulumi.get(self, "description")
 
@@ -105,7 +110,7 @@ class _TextChartState:
     @pulumi.getter
     def markdown(self) -> Optional[pulumi.Input[str]]:
         """
-        Markdown text to display. More info at: https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet
+        Markdown text to display.
         """
         return pulumi.get(self, "markdown")
 
@@ -117,7 +122,7 @@ class _TextChartState:
     @pulumi.getter
     def name(self) -> Optional[pulumi.Input[str]]:
         """
-        Name of the chart
+        Name of the text note.
         """
         return pulumi.get(self, "name")
 
@@ -129,7 +134,7 @@ class _TextChartState:
     @pulumi.getter
     def url(self) -> Optional[pulumi.Input[str]]:
         """
-        URL of the chart
+        The URL of the chart.
         """
         return pulumi.get(self, "url")
 
@@ -157,47 +162,32 @@ class TextChart(pulumi.CustomResource):
         import pulumi_signalfx as signalfx
 
         mynote0 = signalfx.TextChart("mynote0",
+            name="Important Dashboard Note",
             description="Lorem ipsum dolor sit amet, laudem tibique iracundia at mea. Nam posse dolores ex, nec cu adhuc putent honestatis",
-            markdown=\"\"\"    1. First ordered list item
-            2. Another item
-              * Unordered sub-list.
-            1. Actual numbers don't matter, just that it's a number
-              1. Ordered sub-list
-            4. And another item.
-
-               You can have properly indented paragraphs within list items. Notice the blank line above, and the leading spaces (at least one, but we'll use three here to also align the raw Markdown).
-
-               To have a line break without a paragraph, you will need to use two trailing spaces.⋅⋅
-               Note that this line is separate, but within the same paragraph.⋅⋅
-               (This is contrary to the typical GFM line break behaviour, where trailing spaces are not required.)
-
-            * Unordered list can use asterisks
-            - Or minuses
-            + Or pluses
-
+            markdown=\"\"\"1. First ordered list item
+        2. Another item
+          * Unordered sub-list.
+        1. Actual numbers don't matter, just that it's a number
+          1. Ordered sub-list
+        4. And another item.
+
+           You can have properly indented paragraphs within list items. Notice the blank line above, and the leading spaces (at least one, but we'll use three here to also align the raw Markdown).
+
+           To have a line break without a paragraph, you will need to use two trailing spaces.⋅⋅
+           Note that this line is separate, but within the same paragraph.⋅⋅
+           (This is contrary to the typical GFM line break behaviour, where trailing spaces are not required.)
+
+        * Unordered list can use asterisks
+        - Or minuses
+        + Or pluses
         \"\"\")
         ```
 
-        ## Arguments
-
-        The following arguments are supported in the resource block:
-
-        * `name` - (Required) Name of the text note.
-        * `markdown` - (Required) Markdown text to display.
-        * `description` - (Optional) Description of the text note.
-
-        ## Attributes
-
-        In a addition to all arguments above, the following attributes are exported:
-
-        * `id` - The ID of the chart.
-        * `url` - The URL of the chart.
-
         :param str resource_name: The name of the resource.
         :param pulumi.ResourceOptions opts: Options for the resource.
-        :param pulumi.Input[str] description: Description of the chart (Optional)
-        :param pulumi.Input[str] markdown: Markdown text to display. More info at: https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet
-        :param pulumi.Input[str] name: Name of the chart
+        :param pulumi.Input[str] description: Description of the text note.
+        :param pulumi.Input[str] markdown: Markdown text to display.
+        :param pulumi.Input[str] name: Name of the text note.
         """
         ...
     @overload
@@ -215,42 +205,27 @@ class TextChart(pulumi.CustomResource):
         import pulumi_signalfx as signalfx
 
         mynote0 = signalfx.TextChart("mynote0",
+            name="Important Dashboard Note",
             description="Lorem ipsum dolor sit amet, laudem tibique iracundia at mea. Nam posse dolores ex, nec cu adhuc putent honestatis",
-            markdown=\"\"\"    1. First ordered list item
-            2. Another item
-              * Unordered sub-list.
-            1. Actual numbers don't matter, just that it's a number
-              1. Ordered sub-list
-            4. And another item.
-
-               You can have properly indented paragraphs within list items. Notice the blank line above, and the leading spaces (at least one, but we'll use three here to also align the raw Markdown).
-
-               To have a line break without a paragraph, you will need to use two trailing spaces.⋅⋅
-               Note that this line is separate, but within the same paragraph.⋅⋅
-               (This is contrary to the typical GFM line break behaviour, where trailing spaces are not required.)
-
-            * Unordered list can use asterisks
-            - Or minuses
-            + Or pluses
-
+            markdown=\"\"\"1. First ordered list item
+        2. Another item
+          * Unordered sub-list.
+        1. Actual numbers don't matter, just that it's a number
+          1. Ordered sub-list
+        4. And another item.
+
+           You can have properly indented paragraphs within list items. Notice the blank line above, and the leading spaces (at least one, but we'll use three here to also align the raw Markdown).
+
+           To have a line break without a paragraph, you will need to use two trailing spaces.⋅⋅
+           Note that this line is separate, but within the same paragraph.⋅⋅
+           (This is contrary to the typical GFM line break behaviour, where trailing spaces are not required.)
+
+        * Unordered list can use asterisks
+        - Or minuses
+        + Or pluses
         \"\"\")
         ```
 
-        ## Arguments
-
-        The following arguments are supported in the resource block:
-
-        * `name` - (Required) Name of the text note.
-        * `markdown` - (Required) Markdown text to display.
-        * `description` - (Optional) Description of the text note.
-
-        ## Attributes
-
-        In a addition to all arguments above, the following attributes are exported:
-
-        * `id` - The ID of the chart.
-        * `url` - The URL of the chart.
-
         :param str resource_name: The name of the resource.
         :param TextChartArgs args: The arguments to use to populate this resource's properties.
         :param pulumi.ResourceOptions opts: Options for the resource.
@@ -305,10 +280,10 @@ class TextChart(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] description: Description of the chart (Optional)
-        :param pulumi.Input[str] markdown: Markdown text to display. More info at: https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet
-        :param pulumi.Input[str] name: Name of the chart
-        :param pulumi.Input[str] url: URL of the chart
+        :param pulumi.Input[str] description: Description of the text note.
+        :param pulumi.Input[str] markdown: Markdown text to display.
+        :param pulumi.Input[str] name: Name of the text note.
+        :param pulumi.Input[str] url: The URL of the chart.
         """
         opts = pulumi.ResourceOptions.merge(opts, pulumi.ResourceOptions(id=id))
 
@@ -324,7 +299,7 @@ class TextChart(pulumi.CustomResource):
     @pulumi.getter
     def description(self) -> pulumi.Output[Optional[str]]:
         """
-        Description of the chart (Optional)
+        Description of the text note.
         """
         return pulumi.get(self, "description")
 
@@ -332,7 +307,7 @@ class TextChart(pulumi.CustomResource):
     @pulumi.getter
     def markdown(self) -> pulumi.Output[str]:
         """
-        Markdown text to display. More info at: https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet
+        Markdown text to display.
         """
         return pulumi.get(self, "markdown")
 
@@ -340,7 +315,7 @@ class TextChart(pulumi.CustomResource):
     @pulumi.getter
     def name(self) -> pulumi.Output[str]:
         """
-        Name of the chart
+        Name of the text note.
         """
         return pulumi.get(self, "name")
 
@@ -348,7 +323,7 @@ class TextChart(pulumi.CustomResource):
     @pulumi.getter
     def url(self) -> pulumi.Output[str]:
         """
-        URL of the chart
+        The URL of the chart.
         """
         return pulumi.get(self, "url")