pulumi-consul 3.11.0a1700198651__tar.gz → 3.11.1__tar.gz

{pulumi_consul-3.11.0a1700198651 → pulumi_consul-3.11.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pulumi_consul
-Version: 3.11.0a1700198651
+Version: 3.11.1
 Summary: A Pulumi package for creating and managing consul resources.
 License: Apache-2.0
 Project-URL: Homepage, https://pulumi.io

{pulumi_consul-3.11.0a1700198651 → pulumi_consul-3.11.1}/pulumi_consul/_inputs.py

@@ -4671,13 +4671,9 @@ class GetKeysKeyArgs:
                  path: str,
                  default: Optional[str] = None):
         """
-        :param str name: This is the name of the key. This value of the
-               key is exposed as `var.<name>`. This is not the path of the key
-               in Consul.
-        :param str path: This is the path in Consul that should be read
-               or written to.
-        :param str default: This is the default value to set for `var.<name>`
-               if the key does not exist in Consul. Defaults to an empty string.
+        :param str name: This is the name of the key. This value of the key is exposed as `var.<name>`. This is not the path of the key in Consul.
+        :param str path: This is the path in Consul that should be read or written to.
+        :param str default: This is the default value to set for `var.<name>` if the key does not exist in Consul. Defaults to an empty string.
         """
         pulumi.set(__self__, "name", name)
         pulumi.set(__self__, "path", path)
@@ -4688,9 +4684,7 @@ class GetKeysKeyArgs:
     @pulumi.getter
     def name(self) -> str:
         """
-        This is the name of the key. This value of the
-        key is exposed as `var.<name>`. This is not the path of the key
-        in Consul.
+        This is the name of the key. This value of the key is exposed as `var.<name>`. This is not the path of the key in Consul.
         """
         return pulumi.get(self, "name")
 
@@ -4702,8 +4696,7 @@ class GetKeysKeyArgs:
     @pulumi.getter
     def path(self) -> str:
         """
-        This is the path in Consul that should be read
-        or written to.
+        This is the path in Consul that should be read or written to.
         """
         return pulumi.get(self, "path")
 
@@ -4715,8 +4708,7 @@ class GetKeysKeyArgs:
     @pulumi.getter
     def default(self) -> Optional[str]:
         """
-        This is the default value to set for `var.<name>`
-        if the key does not exist in Consul. Defaults to an empty string.
+        This is the default value to set for `var.<name>` if the key does not exist in Consul. Defaults to an empty string.
         """
         return pulumi.get(self, "default")
 

{pulumi_consul-3.11.0a1700198651 → pulumi_consul-3.11.1}/pulumi_consul/_utilities.py

@@ -3,6 +3,7 @@
 # *** Do not edit by hand unless you're certain you know what you are doing! ***
 
 
+import asyncio
 import importlib.util
 import inspect
 import json
@@ -13,6 +14,7 @@ import typing
 
 import pulumi
 import pulumi.runtime
+from pulumi.runtime.sync_await import _sync_await
 
 from semver import VersionInfo as SemverVersion
 from parver import Version as PEP440Version
@@ -246,5 +248,44 @@ def lift_output_func(func: typing.Any) -> typing.Callable[[_F], _F]:
 
     return (lambda _: lifted_func)
 
+
+def call_plain(
+    tok: str,
+    props: pulumi.Inputs,
+    res: typing.Optional[pulumi.Resource] = None,
+    typ: typing.Optional[type] = None,
+) -> typing.Any:
+    """
+    Wraps pulumi.runtime.plain to force the output and return it plainly.
+    """
+
+    output = pulumi.runtime.call(tok, props, res, typ)
+
+    # Ingoring deps silently. They are typically non-empty, r.f() calls include r as a dependency.
+    result, known, secret, _ = _sync_await(asyncio.ensure_future(_await_output(output)))
+
+    problem = None
+    if not known:
+        problem = ' an unknown value'
+    elif secret:
+        problem = ' a secret value'
+
+    if problem:
+        raise AssertionError(
+            f"Plain resource method '{tok}' incorrectly returned {problem}. "
+            + "This is an error in the provider, please report this to the provider developer."
+        )
+
+    return result
+
+
+async def _await_output(o: pulumi.Output[typing.Any]) -> typing.Tuple[object, bool, bool, set]:
+    return (
+        await o._future,
+        await o._is_known,
+        await o._is_secret,
+        await o._resources,
+    )
+
 def get_plugin_download_url():
 	return None

pulumi_consul-3.11.1/pulumi_consul/config/__init__.pyi

@@ -0,0 +1,94 @@
+# coding=utf-8
+# *** WARNING: this file was generated by the Pulumi Terraform Bridge (tfgen) Tool. ***
+# *** Do not edit by hand unless you're certain you know what you are doing! ***
+
+import copy
+import warnings
+import pulumi
+import pulumi.runtime
+from typing import Any, Mapping, Optional, Sequence, Union, overload
+from .. import _utilities
+from . import outputs
+
+address: Optional[str]
+"""
+The HTTP(S) API address of the agent to use. Defaults to "127.0.0.1:8500".
+"""
+
+authJwt: Optional[str]
+"""
+Authenticates to Consul using a JWT authentication method.
+"""
+
+caFile: Optional[str]
+"""
+A path to a PEM-encoded certificate authority used to verify the remote agent's certificate.
+"""
+
+caPath: Optional[str]
+"""
+A path to a directory of PEM-encoded certificate authority files to use to check the authenticity of client and server
+connections. Can also be specified with the `CONSUL_CAPATH` environment variable.
+"""
+
+caPem: Optional[str]
+"""
+PEM-encoded certificate authority used to verify the remote agent's certificate.
+"""
+
+certFile: Optional[str]
+"""
+A path to a PEM-encoded certificate provided to the remote agent; requires use of `key_file` or `key_pem`.
+"""
+
+certPem: Optional[str]
+"""
+PEM-encoded certificate provided to the remote agent; requires use of `key_file` or `key_pem`.
+"""
+
+datacenter: Optional[str]
+"""
+The datacenter to use. Defaults to that of the agent.
+"""
+
+headers: Optional[str]
+"""
+A configuration block, described below, that provides additional headers to be sent along with all requests to the
+Consul server. This block can be specified multiple times.
+"""
+
+httpAuth: Optional[str]
+"""
+HTTP Basic Authentication credentials to be used when communicating with Consul, in the format of either `user` or
+`user:pass`. This may also be specified using the `CONSUL_HTTP_AUTH` environment variable.
+"""
+
+insecureHttps: Optional[bool]
+"""
+Boolean value to disable SSL certificate verification; setting this value to true is not recommended for production use.
+Only use this with scheme set to "https".
+"""
+
+keyFile: Optional[str]
+"""
+A path to a PEM-encoded private key, required if `cert_file` or `cert_pem` is specified.
+"""
+
+keyPem: Optional[str]
+"""
+PEM-encoded private key, required if `cert_file` or `cert_pem` is specified.
+"""
+
+namespace: Optional[str]
+
+scheme: Optional[str]
+"""
+The URL scheme of the agent to use ("http" or "https"). Defaults to "http".
+"""
+
+token: Optional[str]
+"""
+The ACL token to use by default when making requests to the agent. Can also be specified with `CONSUL_HTTP_TOKEN` or
+`CONSUL_TOKEN` as an environment variable.
+"""
+

{pulumi_consul-3.11.0a1700198651 → pulumi_consul-3.11.1}/pulumi_consul/get_keys.py

@@ -23,10 +23,13 @@ class GetKeysResult:
     """
     A collection of values returned by getKeys.
     """
-    def __init__(__self__, datacenter=None, id=None, keys=None, namespace=None, partition=None, token=None, var=None):
+    def __init__(__self__, datacenter=None, error_on_missing_keys=None, id=None, keys=None, namespace=None, partition=None, token=None, var=None):
         if datacenter and not isinstance(datacenter, str):
             raise TypeError("Expected argument 'datacenter' to be a str")
         pulumi.set(__self__, "datacenter", datacenter)
+        if error_on_missing_keys and not isinstance(error_on_missing_keys, bool):
+            raise TypeError("Expected argument 'error_on_missing_keys' to be a bool")
+        pulumi.set(__self__, "error_on_missing_keys", error_on_missing_keys)
         if id and not isinstance(id, str):
             raise TypeError("Expected argument 'id' to be a str")
         pulumi.set(__self__, "id", id)
@@ -50,12 +53,18 @@ class GetKeysResult:
     @pulumi.getter
     def datacenter(self) -> str:
         """
-        The datacenter the keys are being read from.
-        * `var.<name>` - For each name given, the corresponding attribute
-        has the value of the key.
+        The datacenter to use. This overrides the agent's default datacenter and the datacenter in the provider setup.
         """
         return pulumi.get(self, "datacenter")
 
+    @property
+    @pulumi.getter(name="errorOnMissingKeys")
+    def error_on_missing_keys(self) -> Optional[bool]:
+        """
+        Whether to return an error when a key is absent from the KV store and no default is configured. This defaults to `false`.
+        """
+        return pulumi.get(self, "error_on_missing_keys")
+
     @property
     @pulumi.getter
     def id(self) -> str:
@@ -67,21 +76,33 @@ class GetKeysResult:
     @property
     @pulumi.getter
     def keys(self) -> Optional[Sequence['outputs.GetKeysKeyResult']]:
+        """
+        Specifies a key in Consul to be read. Supported values documented below. Multiple blocks supported.
+        """
         return pulumi.get(self, "keys")
 
     @property
     @pulumi.getter
     def namespace(self) -> Optional[str]:
+        """
+        The namespace to lookup the keys.
+        """
         return pulumi.get(self, "namespace")
 
     @property
     @pulumi.getter
     def partition(self) -> Optional[str]:
+        """
+        The partition to lookup the keys.
+        """
         return pulumi.get(self, "partition")
 
     @property
     @pulumi.getter
     def token(self) -> Optional[str]:
+        """
+        The ACL token to use. This overrides the token that the agent provides by default.
+        """
         warnings.warn("""The token argument has been deprecated and will be removed in a future release.
 Please use the token argument in the provider configuration""", DeprecationWarning)
         pulumi.log.warn("""token is deprecated: The token argument has been deprecated and will be removed in a future release.
@@ -92,6 +113,9 @@ Please use the token argument in the provider configuration""")
     @property
     @pulumi.getter
     def var(self) -> Mapping[str, str]:
+        """
+        For each name given, the corresponding attribute has the value of the key.
+        """
         return pulumi.get(self, "var")
 
 
@@ -102,6 +126,7 @@ class AwaitableGetKeysResult(GetKeysResult):
             yield self
         return GetKeysResult(
             datacenter=self.datacenter,
+            error_on_missing_keys=self.error_on_missing_keys,
             id=self.id,
             keys=self.keys,
             namespace=self.namespace,
@@ -111,14 +136,14 @@ class AwaitableGetKeysResult(GetKeysResult):
 
 
 def get_keys(datacenter: Optional[str] = None,
+             error_on_missing_keys: Optional[bool] = None,
              keys: Optional[Sequence[pulumi.InputType['GetKeysKeyArgs']]] = None,
              namespace: Optional[str] = None,
              partition: Optional[str] = None,
              token: Optional[str] = None,
              opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetKeysResult:
     """
-    The `Keys` resource reads values from the Consul key/value store.
-    This is a powerful way dynamically set values in templates.
+    The `Keys` datasource reads values from the Consul key/value store. This is a powerful way to dynamically set values in templates.
 
     ## Example Usage
 
@@ -129,27 +154,26 @@ def get_keys(datacenter: Optional[str] = None,
 
     app_keys = consul.get_keys(datacenter="nyc1",
         keys=[consul.GetKeysKeyArgs(
-            default="ami-1234",
             name="ami",
             path="service/app/launch_ami",
-        )],
-        token="abcd")
+            default="ami-1234",
+        )])
     # Start our instance with the dynamic ami value
     app_instance = aws.ec2.Instance("appInstance", ami=app_keys.var["ami"])
+    # ...
     ```
 
 
-    :param str datacenter: The datacenter to use. This overrides the
-           agent's default datacenter and the datacenter in the provider setup.
-    :param Sequence[pulumi.InputType['GetKeysKeyArgs']] keys: Specifies a key in Consul to be read. Supported
-           values documented below. Multiple blocks supported.
+    :param str datacenter: The datacenter to use. This overrides the agent's default datacenter and the datacenter in the provider setup.
+    :param bool error_on_missing_keys: Whether to return an error when a key is absent from the KV store and no default is configured. This defaults to `false`.
+    :param Sequence[pulumi.InputType['GetKeysKeyArgs']] keys: Specifies a key in Consul to be read. Supported values documented below. Multiple blocks supported.
     :param str namespace: The namespace to lookup the keys.
     :param str partition: The partition to lookup the keys.
-    :param str token: The ACL token to use. This overrides the
-           token that the agent provides by default.
+    :param str token: The ACL token to use. This overrides the token that the agent provides by default.
     """
     __args__ = dict()
     __args__['datacenter'] = datacenter
+    __args__['errorOnMissingKeys'] = error_on_missing_keys
     __args__['keys'] = keys
     __args__['namespace'] = namespace
     __args__['partition'] = partition
@@ -159,6 +183,7 @@ def get_keys(datacenter: Optional[str] = None,
 
     return AwaitableGetKeysResult(
         datacenter=pulumi.get(__ret__, 'datacenter'),
+        error_on_missing_keys=pulumi.get(__ret__, 'error_on_missing_keys'),
         id=pulumi.get(__ret__, 'id'),
         keys=pulumi.get(__ret__, 'keys'),
         namespace=pulumi.get(__ret__, 'namespace'),
@@ -169,14 +194,14 @@ def get_keys(datacenter: Optional[str] = None,
 
 @_utilities.lift_output_func(get_keys)
 def get_keys_output(datacenter: Optional[pulumi.Input[Optional[str]]] = None,
+                    error_on_missing_keys: Optional[pulumi.Input[Optional[bool]]] = None,
                     keys: Optional[pulumi.Input[Optional[Sequence[pulumi.InputType['GetKeysKeyArgs']]]]] = None,
                     namespace: Optional[pulumi.Input[Optional[str]]] = None,
                     partition: Optional[pulumi.Input[Optional[str]]] = None,
                     token: Optional[pulumi.Input[Optional[str]]] = None,
                     opts: Optional[pulumi.InvokeOptions] = None) -> pulumi.Output[GetKeysResult]:
     """
-    The `Keys` resource reads values from the Consul key/value store.
-    This is a powerful way dynamically set values in templates.
+    The `Keys` datasource reads values from the Consul key/value store. This is a powerful way to dynamically set values in templates.
 
     ## Example Usage
 
@@ -187,23 +212,21 @@ def get_keys_output(datacenter: Optional[pulumi.Input[Optional[str]]] = None,
 
     app_keys = consul.get_keys(datacenter="nyc1",
         keys=[consul.GetKeysKeyArgs(
-            default="ami-1234",
             name="ami",
             path="service/app/launch_ami",
-        )],
-        token="abcd")
+            default="ami-1234",
+        )])
     # Start our instance with the dynamic ami value
     app_instance = aws.ec2.Instance("appInstance", ami=app_keys.var["ami"])
+    # ...
     ```
 
 
-    :param str datacenter: The datacenter to use. This overrides the
-           agent's default datacenter and the datacenter in the provider setup.
-    :param Sequence[pulumi.InputType['GetKeysKeyArgs']] keys: Specifies a key in Consul to be read. Supported
-           values documented below. Multiple blocks supported.
+    :param str datacenter: The datacenter to use. This overrides the agent's default datacenter and the datacenter in the provider setup.
+    :param bool error_on_missing_keys: Whether to return an error when a key is absent from the KV store and no default is configured. This defaults to `false`.
+    :param Sequence[pulumi.InputType['GetKeysKeyArgs']] keys: Specifies a key in Consul to be read. Supported values documented below. Multiple blocks supported.
     :param str namespace: The namespace to lookup the keys.
     :param str partition: The partition to lookup the keys.
-    :param str token: The ACL token to use. This overrides the
-           token that the agent provides by default.
+    :param str token: The ACL token to use. This overrides the token that the agent provides by default.
     """
     ...

{pulumi_consul-3.11.0a1700198651 → pulumi_consul-3.11.1}/pulumi_consul/outputs.py

@@ -4822,13 +4822,9 @@ class GetKeysKeyResult(dict):
                  path: str,
                  default: Optional[str] = None):
         """
-        :param str name: This is the name of the key. This value of the
-               key is exposed as `var.<name>`. This is not the path of the key
-               in Consul.
-        :param str path: This is the path in Consul that should be read
-               or written to.
-        :param str default: This is the default value to set for `var.<name>`
-               if the key does not exist in Consul. Defaults to an empty string.
+        :param str name: This is the name of the key. This value of the key is exposed as `var.<name>`. This is not the path of the key in Consul.
+        :param str path: This is the path in Consul that should be read or written to.
+        :param str default: This is the default value to set for `var.<name>` if the key does not exist in Consul. Defaults to an empty string.
         """
         pulumi.set(__self__, "name", name)
         pulumi.set(__self__, "path", path)
@@ -4839,9 +4835,7 @@ class GetKeysKeyResult(dict):
     @pulumi.getter
     def name(self) -> str:
         """
-        This is the name of the key. This value of the
-        key is exposed as `var.<name>`. This is not the path of the key
-        in Consul.
+        This is the name of the key. This value of the key is exposed as `var.<name>`. This is not the path of the key in Consul.
         """
         return pulumi.get(self, "name")
 
@@ -4849,8 +4843,7 @@ class GetKeysKeyResult(dict):
     @pulumi.getter
     def path(self) -> str:
         """
-        This is the path in Consul that should be read
-        or written to.
+        This is the path in Consul that should be read or written to.
         """
         return pulumi.get(self, "path")
 
@@ -4858,8 +4851,7 @@ class GetKeysKeyResult(dict):
     @pulumi.getter
     def default(self) -> Optional[str]:
         """
-        This is the default value to set for `var.<name>`
-        if the key does not exist in Consul. Defaults to an empty string.
+        This is the default value to set for `var.<name>` if the key does not exist in Consul. Defaults to an empty string.
         """
         return pulumi.get(self, "default")
 

{pulumi_consul-3.11.0a1700198651 → pulumi_consul-3.11.1}/pulumi_consul.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
-Name: pulumi-consul
-Version: 3.11.0a1700198651
+Name: pulumi_consul
+Version: 3.11.1
 Summary: A Pulumi package for creating and managing consul resources.
 License: Apache-2.0
 Project-URL: Homepage, https://pulumi.io

{pulumi_consul-3.11.0a1700198651 → pulumi_consul-3.11.1}/pulumi_consul.egg-info/SOURCES.txt

@@ -68,5 +68,6 @@ pulumi_consul.egg-info/dependency_links.txt
 pulumi_consul.egg-info/requires.txt
 pulumi_consul.egg-info/top_level.txt
 pulumi_consul/config/__init__.py
+pulumi_consul/config/__init__.pyi
 pulumi_consul/config/outputs.py
 pulumi_consul/config/vars.py

{pulumi_consul-3.11.0a1700198651 → pulumi_consul-3.11.1}/pyproject.toml

@@ -5,7 +5,7 @@
   keywords = ["pulumi", "consul"]
   readme = "README.md"
   requires-python = ">=3.7"
-  version = "3.11.0a1700198651"
+  version = "3.11.1"
   [project.license]
     text = "Apache-2.0"
   [project.urls]