pulumi-consul 3.12.0a1713331566__py3-none-any.whl → 3.12.0a1713897703__py3-none-any.whl

pulumi_consul/outputs.py

@@ -1664,7 +1664,7 @@ class ConfigEntryServiceIntentionsSourcePermission(dict):
                  action: str,
                  https: Sequence['outputs.ConfigEntryServiceIntentionsSourcePermissionHttp']):
         """
-        :param str action: Specifies the action to take when the source sends traffic to the destination service.
+        :param str action: Specifies the action to take when the source sends traffic to the destination service. The value is either allow or deny.
         :param Sequence['ConfigEntryServiceIntentionsSourcePermissionHttpArgs'] https: Specifies a set of HTTP-specific match criteria.
         """
         pulumi.set(__self__, "action", action)
@@ -1674,7 +1674,7 @@ class ConfigEntryServiceIntentionsSourcePermission(dict):
     @pulumi.getter
     def action(self) -> str:
         """
-        Specifies the action to take when the source sends traffic to the destination service.
+        Specifies the action to take when the source sends traffic to the destination service. The value is either allow or deny.
         """
         return pulumi.get(self, "action")
 
@@ -1786,7 +1786,7 @@ class ConfigEntryServiceIntentionsSourcePermissionHttpHeader(dict):
                  regex: Optional[str] = None,
                  suffix: Optional[str] = None):
         """
-        :param str name: Specifies the name of a JWT provider defined in the Name field of the jwt-provider configuration entry.
+        :param str name: Specifies the name of the header to match.
         :param str exact: Specifies a value for the header key set in the Name field. If the request header value matches the Exact value, Consul applies the permission.
         :param bool invert: Inverts the matching logic configured in the Header.
         :param str prefix: Specifies a prefix value for the header key set in the Name field.
@@ -1812,7 +1812,7 @@ class ConfigEntryServiceIntentionsSourcePermissionHttpHeader(dict):
     @pulumi.getter
     def name(self) -> str:
         """
-        Specifies the name of a JWT provider defined in the Name field of the jwt-provider configuration entry.
+        Specifies the name of the header to match.
         """
         return pulumi.get(self, "name")
 
@@ -2004,11 +2004,11 @@ class ConfigEntryServiceResolverFailoverTarget(dict):
                  service_subset: Optional[str] = None):
         """
         :param str datacenter: Specifies the WAN federated datacenter to use for the failover target. If empty, the current datacenter is used.
-        :param str namespace: Specifies the namespace at the failover location where the failover services are deployed.
+        :param str namespace: Specifies the namespace to use for the failover target. If empty, the default namespace is used.
         :param str partition: Specifies the admin partition within the same datacenter to use for the failover target. If empty, the default partition is used.
         :param str peer: Specifies the destination cluster peer to resolve the target service name from.
-        :param str service: Specifies the name of the service to resolve at the failover location during a failover scenario.
-        :param str service_subset: Specifies the name of a subset of service instances to resolve at the failover location during a failover scenario.
+        :param str service: Specifies the service name to use for the failover target. If empty, the current service name is used.
+        :param str service_subset: Specifies the named subset to use for the failover target. If empty, the default subset for the requested service name is used.
         """
         if datacenter is not None:
             pulumi.set(__self__, "datacenter", datacenter)
@@ -2035,7 +2035,7 @@ class ConfigEntryServiceResolverFailoverTarget(dict):
     @pulumi.getter
     def namespace(self) -> Optional[str]:
         """
-        Specifies the namespace at the failover location where the failover services are deployed.
+        Specifies the namespace to use for the failover target. If empty, the default namespace is used.
         """
         return pulumi.get(self, "namespace")
 
@@ -2059,7 +2059,7 @@ class ConfigEntryServiceResolverFailoverTarget(dict):
     @pulumi.getter
     def service(self) -> Optional[str]:
         """
-        Specifies the name of the service to resolve at the failover location during a failover scenario.
+        Specifies the service name to use for the failover target. If empty, the current service name is used.
         """
         return pulumi.get(self, "service")
 
@@ -2067,7 +2067,7 @@ class ConfigEntryServiceResolverFailoverTarget(dict):
     @pulumi.getter(name="serviceSubset")
     def service_subset(self) -> Optional[str]:
         """
-        Specifies the name of a subset of service instances to resolve at the failover location during a failover scenario.
+        Specifies the named subset to use for the failover target. If empty, the default subset for the requested service name is used.
         """
         return pulumi.get(self, "service_subset")
 
@@ -2805,9 +2805,9 @@ class ConfigEntryServiceRouterRouteDestinationResponseHeaders(dict):
                  removes: Optional[Sequence[str]] = None,
                  set: Optional[Mapping[str, str]] = None):
         """
-        :param Mapping[str, str] add: Defines a set of key-value pairs to add to the header. Use header names as the keys.
+        :param Mapping[str, str] add: Defines a set of key-value pairs to add to the header. Use header names as the keys
         :param Sequence[str] removes: Defines a list of headers to remove.
-        :param Mapping[str, str] set: Defines a set of key-value pairs to add to the request header or to replace existing header values with.
+        :param Mapping[str, str] set: Defines a set of key-value pairs to add to the response header or to replace existing header values with
         """
         if add is not None:
             pulumi.set(__self__, "add", add)
@@ -2820,7 +2820,7 @@ class ConfigEntryServiceRouterRouteDestinationResponseHeaders(dict):
     @pulumi.getter
     def add(self) -> Optional[Mapping[str, str]]:
         """
-        Defines a set of key-value pairs to add to the header. Use header names as the keys.
+        Defines a set of key-value pairs to add to the header. Use header names as the keys
         """
         return pulumi.get(self, "add")
 
@@ -2836,7 +2836,7 @@ class ConfigEntryServiceRouterRouteDestinationResponseHeaders(dict):
     @pulumi.getter
     def set(self) -> Optional[Mapping[str, str]]:
         """
-        Defines a set of key-value pairs to add to the request header or to replace existing header values with.
+        Defines a set of key-value pairs to add to the response header or to replace existing header values with
         """
         return pulumi.get(self, "set")
 
@@ -3061,10 +3061,10 @@ class ConfigEntryServiceRouterRouteMatchHttpQueryParam(dict):
                  present: Optional[bool] = None,
                  regex: Optional[str] = None):
         """
-        :param str exact: Specifies that a request matches when the header with the given name is this exact value.
-        :param str name: Specifies the name of the HTTP header to match.
-        :param bool present: Specifies that a request matches when the value in the `name` argument is present anywhere in the HTTP header.
-        :param str regex: Specifies that a request matches when the header with the given name matches this regular expression.
+        :param str exact: Specifies that a request matches when the query parameter with the given name is this exact value.
+        :param str name: Specifies the name of the HTTP query parameter to match.
+        :param bool present: Specifies that a request matches when the value in the `name` argument is present anywhere in the HTTP query parameter.
+        :param str regex: Specifies that a request matches when the query parameter with the given name matches this regular expression.
         """
         if exact is not None:
             pulumi.set(__self__, "exact", exact)
@@ -3079,7 +3079,7 @@ class ConfigEntryServiceRouterRouteMatchHttpQueryParam(dict):
     @pulumi.getter
     def exact(self) -> Optional[str]:
         """
-        Specifies that a request matches when the header with the given name is this exact value.
+        Specifies that a request matches when the query parameter with the given name is this exact value.
         """
         return pulumi.get(self, "exact")
 
@@ -3087,7 +3087,7 @@ class ConfigEntryServiceRouterRouteMatchHttpQueryParam(dict):
     @pulumi.getter
     def name(self) -> Optional[str]:
         """
-        Specifies the name of the HTTP header to match.
+        Specifies the name of the HTTP query parameter to match.
         """
         return pulumi.get(self, "name")
 
@@ -3095,7 +3095,7 @@ class ConfigEntryServiceRouterRouteMatchHttpQueryParam(dict):
     @pulumi.getter
     def present(self) -> Optional[bool]:
         """
-        Specifies that a request matches when the value in the `name` argument is present anywhere in the HTTP header.
+        Specifies that a request matches when the value in the `name` argument is present anywhere in the HTTP query parameter.
         """
         return pulumi.get(self, "present")
 
@@ -3103,7 +3103,7 @@ class ConfigEntryServiceRouterRouteMatchHttpQueryParam(dict):
     @pulumi.getter
     def regex(self) -> Optional[str]:
         """
-        Specifies that a request matches when the header with the given name matches this regular expression.
+        Specifies that a request matches when the query parameter with the given name matches this regular expression.
         """
         return pulumi.get(self, "regex")
 

pulumi_consul/peering.py

@@ -238,25 +238,18 @@ class Peering(pulumi.CustomResource):
 
         ## Example Usage
 
-        <!--Start PulumiCodeChooser -->
         ```python
         import pulumi
         import pulumi_consul as consul
 
-        # Create a peering between the EU and US Consul clusters
-        eu = consul.Provider("eu", address="eu-cluster:8500")
-        us = consul.Provider("us", address="us-cluster:8500")
-        eu_us_peering_token = consul.PeeringToken("eu-usPeeringToken", peer_name="eu-cluster",
-        opts=pulumi.ResourceOptions(provider=consul["us"]))
-        eu_us_peering = consul.Peering("eu-usPeering",
+        eu_us = consul.PeeringToken("eu-us", peer_name="eu-cluster")
+        eu_us_peering = consul.Peering("eu-us",
             peer_name="eu-cluster",
-            peering_token=consul_peering_token["token"]["peering_token"],
+            peering_token=token["peeringToken"],
             meta={
                 "hello": "world",
-            },
-            opts=pulumi.ResourceOptions(provider=consul["eu"]))
+            })
         ```
-        <!--End PulumiCodeChooser -->
 
         :param str resource_name: The name of the resource.
         :param pulumi.ResourceOptions opts: Options for the resource.
@@ -281,25 +274,18 @@ class Peering(pulumi.CustomResource):
 
         ## Example Usage
 
-        <!--Start PulumiCodeChooser -->
         ```python
         import pulumi
         import pulumi_consul as consul
 
-        # Create a peering between the EU and US Consul clusters
-        eu = consul.Provider("eu", address="eu-cluster:8500")
-        us = consul.Provider("us", address="us-cluster:8500")
-        eu_us_peering_token = consul.PeeringToken("eu-usPeeringToken", peer_name="eu-cluster",
-        opts=pulumi.ResourceOptions(provider=consul["us"]))
-        eu_us_peering = consul.Peering("eu-usPeering",
+        eu_us = consul.PeeringToken("eu-us", peer_name="eu-cluster")
+        eu_us_peering = consul.Peering("eu-us",
             peer_name="eu-cluster",
-            peering_token=consul_peering_token["token"]["peering_token"],
+            peering_token=token["peeringToken"],
             meta={
                 "hello": "world",
-            },
-            opts=pulumi.ResourceOptions(provider=consul["eu"]))
+            })
         ```
-        <!--End PulumiCodeChooser -->
 
         :param str resource_name: The name of the resource.
         :param PeeringArgs args: The arguments to use to populate this resource's properties.

pulumi_consul/peering_token.py

@@ -150,14 +150,12 @@ class PeeringToken(pulumi.CustomResource):
 
         ## Example Usage
 
-        <!--Start PulumiCodeChooser -->
         ```python
         import pulumi
         import pulumi_consul as consul
 
         token = consul.PeeringToken("token", peer_name="eu-cluster")
         ```
-        <!--End PulumiCodeChooser -->
 
         :param str resource_name: The name of the resource.
         :param pulumi.ResourceOptions opts: Options for the resource.
@@ -181,14 +179,12 @@ class PeeringToken(pulumi.CustomResource):
 
         ## Example Usage
 
-        <!--Start PulumiCodeChooser -->
         ```python
         import pulumi
         import pulumi_consul as consul
 
         token = consul.PeeringToken("token", peer_name="eu-cluster")
         ```
-        <!--End PulumiCodeChooser -->
 
         :param str resource_name: The name of the resource.
         :param PeeringTokenArgs args: The arguments to use to populate this resource's properties.

pulumi_consul/prepared_query.py

@@ -36,7 +36,7 @@ class PreparedQueryArgs:
         The set of arguments for constructing a PreparedQuery resource.
         :param pulumi.Input[str] service: The name of the service to query
         :param pulumi.Input[bool] connect: When `true` the prepared query will return connect proxy services for a queried service.  Conditions such as `tags` in the prepared query will be matched against the proxy service. Defaults to false.
-        :param pulumi.Input[str] datacenter: Specifies a WAN federated datacenter to forward the query to.
+        :param pulumi.Input[str] datacenter: The datacenter to use. This overrides the agent's default datacenter and the datacenter in the provider setup.
         :param pulumi.Input['PreparedQueryDnsArgs'] dns: Settings for controlling the DNS response details.
         :param pulumi.Input['PreparedQueryFailoverArgs'] failover: Options for controlling behavior when no healthy nodes are available in the local DC.
         :param pulumi.Input[Sequence[pulumi.Input[str]]] ignore_check_ids: Specifies a list of check IDs that should be ignored when filtering unhealthy instances. This is mostly useful in an emergency or as a temporary measure when a health check is found to be unreliable. Being able to ignore it in centrally-defined queries can be simpler than de-registering the check as an interim solution until the check can be fixed.
@@ -116,7 +116,7 @@ Please use the token argument in the provider configuration""")
     @pulumi.getter
     def datacenter(self) -> Optional[pulumi.Input[str]]:
         """
-        Specifies a WAN federated datacenter to forward the query to.
+        The datacenter to use. This overrides the agent's default datacenter and the datacenter in the provider setup.
         """
         return pulumi.get(self, "datacenter")
 
@@ -308,7 +308,7 @@ class _PreparedQueryState:
         """
         Input properties used for looking up and filtering PreparedQuery resources.
         :param pulumi.Input[bool] connect: When `true` the prepared query will return connect proxy services for a queried service.  Conditions such as `tags` in the prepared query will be matched against the proxy service. Defaults to false.
-        :param pulumi.Input[str] datacenter: Specifies a WAN federated datacenter to forward the query to.
+        :param pulumi.Input[str] datacenter: The datacenter to use. This overrides the agent's default datacenter and the datacenter in the provider setup.
         :param pulumi.Input['PreparedQueryDnsArgs'] dns: Settings for controlling the DNS response details.
         :param pulumi.Input['PreparedQueryFailoverArgs'] failover: Options for controlling behavior when no healthy nodes are available in the local DC.
         :param pulumi.Input[Sequence[pulumi.Input[str]]] ignore_check_ids: Specifies a list of check IDs that should be ignored when filtering unhealthy instances. This is mostly useful in an emergency or as a temporary measure when a health check is found to be unreliable. Being able to ignore it in centrally-defined queries can be simpler than de-registering the check as an interim solution until the check can be fixed.
@@ -378,7 +378,7 @@ Please use the token argument in the provider configuration""")
     @pulumi.getter
     def datacenter(self) -> Optional[pulumi.Input[str]]:
         """
-        Specifies a WAN federated datacenter to forward the query to.
+        The datacenter to use. This overrides the agent's default datacenter and the datacenter in the provider setup.
         """
         return pulumi.get(self, "datacenter")
 
@@ -585,7 +585,6 @@ class PreparedQuery(pulumi.CustomResource):
         """
         ## Example Usage
 
-        <!--Start PulumiCodeChooser -->
         ```python
         import pulumi
         import pulumi_consul as consul
@@ -594,55 +593,56 @@ class PreparedQuery(pulumi.CustomResource):
         # healthy myapp.service.consul instance that has the active tag and not
         # the standby tag.
         myapp_query = consul.PreparedQuery("myapp-query",
+            name="myquery",
             datacenter="us-central1",
-            dns=consul.PreparedQueryDnsArgs(
-                ttl="30s",
-            ),
+            token="abcd",
+            stored_token="wxyz",
+            only_passing=True,
+            near="_agent",
+            service="myapp",
+            tags=[
+                "active",
+                "!standby",
+            ],
             failover=consul.PreparedQueryFailoverArgs(
+                nearest_n=3,
                 datacenters=[
                     "us-west1",
                     "us-east-2",
                     "asia-east1",
                 ],
-                nearest_n=3,
             ),
-            near="_agent",
-            only_passing=True,
-            service="myapp",
-            stored_token="wxyz",
-            tags=[
-                "active",
-                "!standby",
-            ],
-            token="abcd")
+            dns=consul.PreparedQueryDnsArgs(
+                ttl="30s",
+            ))
         # Creates a Prepared Query Template that matches *-near-self.query.consul
         # and finds the nearest service that matches the glob character (e.g.
         # foo-near-self.query.consul will find the nearest healthy foo.service.consul).
         service_near_self = consul.PreparedQuery("service-near-self",
-            connect=True,
             datacenter="nyc1",
-            dns=consul.PreparedQueryDnsArgs(
-                ttl="5m",
+            token="abcd",
+            stored_token="wxyz",
+            name="",
+            only_passing=True,
+            connect=True,
+            near="_agent",
+            template=consul.PreparedQueryTemplateArgs(
+                type="name_prefix_match",
+                regexp="^(.*)-near-self$",
             ),
+            service="${match(1)}",
             failover=consul.PreparedQueryFailoverArgs(
+                nearest_n=3,
                 datacenters=[
                     "dc2",
                     "dc3",
                     "dc4",
                 ],
-                nearest_n=3,
             ),
-            near="_agent",
-            only_passing=True,
-            service="${match(1)}",
-            stored_token="wxyz",
-            template=consul.PreparedQueryTemplateArgs(
-                regexp="^(.*)-near-self$",
-                type="name_prefix_match",
-            ),
-            token="abcd")
+            dns=consul.PreparedQueryDnsArgs(
+                ttl="5m",
+            ))
         ```
-        <!--End PulumiCodeChooser -->
 
         ## Import
 
@@ -653,7 +653,7 @@ class PreparedQuery(pulumi.CustomResource):
         :param str resource_name: The name of the resource.
         :param pulumi.ResourceOptions opts: Options for the resource.
         :param pulumi.Input[bool] connect: When `true` the prepared query will return connect proxy services for a queried service.  Conditions such as `tags` in the prepared query will be matched against the proxy service. Defaults to false.
-        :param pulumi.Input[str] datacenter: Specifies a WAN federated datacenter to forward the query to.
+        :param pulumi.Input[str] datacenter: The datacenter to use. This overrides the agent's default datacenter and the datacenter in the provider setup.
         :param pulumi.Input[pulumi.InputType['PreparedQueryDnsArgs']] dns: Settings for controlling the DNS response details.
         :param pulumi.Input[pulumi.InputType['PreparedQueryFailoverArgs']] failover: Options for controlling behavior when no healthy nodes are available in the local DC.
         :param pulumi.Input[Sequence[pulumi.Input[str]]] ignore_check_ids: Specifies a list of check IDs that should be ignored when filtering unhealthy instances. This is mostly useful in an emergency or as a temporary measure when a health check is found to be unreliable. Being able to ignore it in centrally-defined queries can be simpler than de-registering the check as an interim solution until the check can be fixed.
@@ -678,7 +678,6 @@ class PreparedQuery(pulumi.CustomResource):
         """
         ## Example Usage
 
-        <!--Start PulumiCodeChooser -->
         ```python
         import pulumi
         import pulumi_consul as consul
@@ -687,55 +686,56 @@ class PreparedQuery(pulumi.CustomResource):
         # healthy myapp.service.consul instance that has the active tag and not
         # the standby tag.
         myapp_query = consul.PreparedQuery("myapp-query",
+            name="myquery",
             datacenter="us-central1",
-            dns=consul.PreparedQueryDnsArgs(
-                ttl="30s",
-            ),
+            token="abcd",
+            stored_token="wxyz",
+            only_passing=True,
+            near="_agent",
+            service="myapp",
+            tags=[
+                "active",
+                "!standby",
+            ],
             failover=consul.PreparedQueryFailoverArgs(
+                nearest_n=3,
                 datacenters=[
                     "us-west1",
                     "us-east-2",
                     "asia-east1",
                 ],
-                nearest_n=3,
             ),
-            near="_agent",
-            only_passing=True,
-            service="myapp",
-            stored_token="wxyz",
-            tags=[
-                "active",
-                "!standby",
-            ],
-            token="abcd")
+            dns=consul.PreparedQueryDnsArgs(
+                ttl="30s",
+            ))
         # Creates a Prepared Query Template that matches *-near-self.query.consul
         # and finds the nearest service that matches the glob character (e.g.
         # foo-near-self.query.consul will find the nearest healthy foo.service.consul).
         service_near_self = consul.PreparedQuery("service-near-self",
-            connect=True,
             datacenter="nyc1",
-            dns=consul.PreparedQueryDnsArgs(
-                ttl="5m",
+            token="abcd",
+            stored_token="wxyz",
+            name="",
+            only_passing=True,
+            connect=True,
+            near="_agent",
+            template=consul.PreparedQueryTemplateArgs(
+                type="name_prefix_match",
+                regexp="^(.*)-near-self$",
             ),
+            service="${match(1)}",
             failover=consul.PreparedQueryFailoverArgs(
+                nearest_n=3,
                 datacenters=[
                     "dc2",
                     "dc3",
                     "dc4",
                 ],
-                nearest_n=3,
             ),
-            near="_agent",
-            only_passing=True,
-            service="${match(1)}",
-            stored_token="wxyz",
-            template=consul.PreparedQueryTemplateArgs(
-                regexp="^(.*)-near-self$",
-                type="name_prefix_match",
-            ),
-            token="abcd")
+            dns=consul.PreparedQueryDnsArgs(
+                ttl="5m",
+            ))
         ```
-        <!--End PulumiCodeChooser -->
 
         ## Import
 
@@ -837,7 +837,7 @@ class PreparedQuery(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[bool] connect: When `true` the prepared query will return connect proxy services for a queried service.  Conditions such as `tags` in the prepared query will be matched against the proxy service. Defaults to false.
-        :param pulumi.Input[str] datacenter: Specifies a WAN federated datacenter to forward the query to.
+        :param pulumi.Input[str] datacenter: The datacenter to use. This overrides the agent's default datacenter and the datacenter in the provider setup.
         :param pulumi.Input[pulumi.InputType['PreparedQueryDnsArgs']] dns: Settings for controlling the DNS response details.
         :param pulumi.Input[pulumi.InputType['PreparedQueryFailoverArgs']] failover: Options for controlling behavior when no healthy nodes are available in the local DC.
         :param pulumi.Input[Sequence[pulumi.Input[str]]] ignore_check_ids: Specifies a list of check IDs that should be ignored when filtering unhealthy instances. This is mostly useful in an emergency or as a temporary measure when a health check is found to be unreliable. Being able to ignore it in centrally-defined queries can be simpler than de-registering the check as an interim solution until the check can be fixed.
@@ -887,7 +887,7 @@ class PreparedQuery(pulumi.CustomResource):
     @pulumi.getter
     def datacenter(self) -> pulumi.Output[Optional[str]]:
         """
-        Specifies a WAN federated datacenter to forward the query to.
+        The datacenter to use. This overrides the agent's default datacenter and the datacenter in the provider setup.
         """
         return pulumi.get(self, "datacenter")