pulumi-consul 3.11.1__py3-none-any.whl → 3.11.3__py3-none-any.whl

pulumi_consul/outputs.py

@@ -865,6 +865,7 @@ class ConfigEntryServiceDefaultsUpstreamConfigDefault(dict):
         :param Sequence['ConfigEntryServiceDefaultsUpstreamConfigDefaultLimitArgs'] limits: Map that specifies a set of limits to apply to when connecting upstream services.
         :param Sequence['ConfigEntryServiceDefaultsUpstreamConfigDefaultMeshGatewayArgs'] mesh_gateways: Specifies the default mesh gateway mode field for all upstreams.
         :param Sequence['ConfigEntryServiceDefaultsUpstreamConfigDefaultPassiveHealthCheckArgs'] passive_health_checks: Map that specifies a set of rules that enable Consul to remove hosts from the upstream cluster that are unreachable or that return errors.
+        :param str protocol: Specifies the default protocol for the service.
         """
         if balance_outbound_connections is not None:
             pulumi.set(__self__, "balance_outbound_connections", balance_outbound_connections)
@@ -919,6 +920,9 @@ class ConfigEntryServiceDefaultsUpstreamConfigDefault(dict):
     @property
     @pulumi.getter
     def protocol(self) -> Optional[str]:
+        """
+        Specifies the default protocol for the service.
+        """
         return pulumi.get(self, "protocol")
 
 
@@ -1132,10 +1136,12 @@ class ConfigEntryServiceDefaultsUpstreamConfigOverride(dict):
         :param str balance_outbound_connections: Sets the strategy for allocating outbound connections from upstreams across Envoy proxy threads.
         :param Sequence['ConfigEntryServiceDefaultsUpstreamConfigOverrideLimitArgs'] limits: Map that specifies a set of limits to apply to when connecting upstream services.
         :param Sequence['ConfigEntryServiceDefaultsUpstreamConfigOverrideMeshGatewayArgs'] mesh_gateways: Specifies the default mesh gateway mode field for all upstreams.
+        :param str name: Specifies the name of the service you are setting the defaults for.
         :param str namespace: Specifies the namespace containing the upstream service that the configuration applies to.
         :param str partition: Specifies the name of the name of the Consul admin partition that the configuration entry applies to.
         :param Sequence['ConfigEntryServiceDefaultsUpstreamConfigOverridePassiveHealthCheckArgs'] passive_health_checks: Map that specifies a set of rules that enable Consul to remove hosts from the upstream cluster that are unreachable or that return errors.
         :param str peer: Specifies the peer name of the upstream service that the configuration applies to.
+        :param str protocol: Specifies the default protocol for the service.
         """
         if balance_outbound_connections is not None:
             pulumi.set(__self__, "balance_outbound_connections", balance_outbound_connections)
@@ -1197,6 +1203,9 @@ class ConfigEntryServiceDefaultsUpstreamConfigOverride(dict):
     @property
     @pulumi.getter
     def name(self) -> Optional[str]:
+        """
+        Specifies the name of the service you are setting the defaults for.
+        """
         return pulumi.get(self, "name")
 
     @property
@@ -1234,6 +1243,9 @@ class ConfigEntryServiceDefaultsUpstreamConfigOverride(dict):
     @property
     @pulumi.getter
     def protocol(self) -> Optional[str]:
+        """
+        Specifies the default protocol for the service.
+        """
         return pulumi.get(self, "protocol")
 
 
@@ -1652,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)
@@ -1662,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")
 
@@ -1774,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.
@@ -1800,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")
 
@@ -1992,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)
@@ -2023,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")
 
@@ -2047,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")
 
@@ -2055,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")
 
@@ -2793,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)
@@ -2808,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")
 
@@ -2824,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")
 
@@ -3049,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)
@@ -3067,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")
 
@@ -3075,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")
 
@@ -3083,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")
 
@@ -3091,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")
 
@@ -3404,8 +3416,8 @@ class KeysKey(dict):
     @property
     @pulumi.getter
     def name(self) -> Optional[str]:
-        warnings.warn("""Using consul_keys resource to *read* is deprecated; please use consul_keys data source instead""", DeprecationWarning)
-        pulumi.log.warn("""name is deprecated: Using consul_keys resource to *read* is deprecated; please use consul_keys data source instead""")
+        warnings.warn("""Using Keys resource to *read* is deprecated; please use Keys data source instead""", DeprecationWarning)
+        pulumi.log.warn("""name is deprecated: Using Keys resource to *read* is deprecated; please use Keys data source instead""")
 
         return pulumi.get(self, "name")
 
@@ -3807,17 +3819,27 @@ class GetAclRoleNodeIdentityResult(dict):
     def __init__(__self__, *,
                  datacenter: str,
                  node_name: str):
+        """
+        :param str datacenter: Specifies the nodes datacenter. This will result in effective policy only being valid in that datacenter.
+        :param str node_name: The name of the node.
+        """
         pulumi.set(__self__, "datacenter", datacenter)
         pulumi.set(__self__, "node_name", node_name)
 
     @property
     @pulumi.getter
     def datacenter(self) -> str:
+        """
+        Specifies the nodes datacenter. This will result in effective policy only being valid in that datacenter.
+        """
         return pulumi.get(self, "datacenter")
 
     @property
     @pulumi.getter(name="nodeName")
     def node_name(self) -> str:
+        """
+        The name of the node.
+        """
         return pulumi.get(self, "node_name")
 
 
@@ -3826,17 +3848,27 @@ class GetAclRolePolicyResult(dict):
     def __init__(__self__, *,
                  id: str,
                  name: str):
+        """
+        :param str id: The ID of the policy.
+        :param str name: The name of the policy.
+        """
         pulumi.set(__self__, "id", id)
         pulumi.set(__self__, "name", name)
 
     @property
     @pulumi.getter
     def id(self) -> str:
+        """
+        The ID of the policy.
+        """
         return pulumi.get(self, "id")
 
     @property
     @pulumi.getter
     def name(self) -> str:
+        """
+        The name of the policy.
+        """
         return pulumi.get(self, "name")
 
 
@@ -3845,6 +3877,10 @@ class GetAclRoleServiceIdentityResult(dict):
     def __init__(__self__, *,
                  datacenters: Optional[Sequence[str]] = None,
                  service_name: Optional[str] = None):
+        """
+        :param Sequence[str] datacenters: Specifies the datacenters the effective policy is valid within.
+        :param str service_name: The name of the service.
+        """
         if datacenters is not None:
             pulumi.set(__self__, "datacenters", datacenters)
         if service_name is not None:
@@ -3853,11 +3889,17 @@ class GetAclRoleServiceIdentityResult(dict):
     @property
     @pulumi.getter
     def datacenters(self) -> Optional[Sequence[str]]:
+        """
+        Specifies the datacenters the effective policy is valid within.
+        """
         return pulumi.get(self, "datacenters")
 
     @property
     @pulumi.getter(name="serviceName")
     def service_name(self) -> Optional[str]:
+        """
+        The name of the service.
+        """
         return pulumi.get(self, "service_name")
 
 
@@ -3867,6 +3909,11 @@ class GetAclRoleTemplatedPolicyResult(dict):
                  datacenters: Sequence[str],
                  template_name: str,
                  template_variables: Sequence['outputs.GetAclRoleTemplatedPolicyTemplateVariableResult']):
+        """
+        :param Sequence[str] datacenters: Specifies the datacenters the effective policy is valid within.
+        :param str template_name: The name of the templated policies.
+        :param Sequence['GetAclRoleTemplatedPolicyTemplateVariableArgs'] template_variables: The templated policy variables.
+        """
         pulumi.set(__self__, "datacenters", datacenters)
         pulumi.set(__self__, "template_name", template_name)
         pulumi.set(__self__, "template_variables", template_variables)
@@ -3874,16 +3921,25 @@ class GetAclRoleTemplatedPolicyResult(dict):
     @property
     @pulumi.getter
     def datacenters(self) -> Sequence[str]:
+        """
+        Specifies the datacenters the effective policy is valid within.
+        """
         return pulumi.get(self, "datacenters")
 
     @property
     @pulumi.getter(name="templateName")
     def template_name(self) -> str:
+        """
+        The name of the templated policies.
+        """
         return pulumi.get(self, "template_name")
 
     @property
     @pulumi.getter(name="templateVariables")
     def template_variables(self) -> Sequence['outputs.GetAclRoleTemplatedPolicyTemplateVariableResult']:
+        """
+        The templated policy variables.
+        """
         return pulumi.get(self, "template_variables")
 
 
@@ -3891,11 +3947,17 @@ class GetAclRoleTemplatedPolicyResult(dict):
 class GetAclRoleTemplatedPolicyTemplateVariableResult(dict):
     def __init__(__self__, *,
                  name: str):
+        """
+        :param str name: The name of node, workload identity or service.
+        """
         pulumi.set(__self__, "name", name)
 
     @property
     @pulumi.getter
     def name(self) -> str:
+        """
+        The name of node, workload identity or service.
+        """
         return pulumi.get(self, "name")
 
 
@@ -3904,17 +3966,27 @@ class GetAclTokenNodeIdentityResult(dict):
     def __init__(__self__, *,
                  datacenter: str,
                  node_name: str):
+        """
+        :param str datacenter: Specifies the node's datacenter.
+        :param str node_name: The list of node identities that should be applied to the token.
+        """
         pulumi.set(__self__, "datacenter", datacenter)
         pulumi.set(__self__, "node_name", node_name)
 
     @property
     @pulumi.getter
     def datacenter(self) -> str:
+        """
+        Specifies the node's datacenter.
+        """
         return pulumi.get(self, "datacenter")
 
     @property
     @pulumi.getter(name="nodeName")
     def node_name(self) -> str:
+        """
+        The list of node identities that should be applied to the token.
+        """
         return pulumi.get(self, "node_name")
 
 
@@ -3961,17 +4033,27 @@ class GetAclTokenServiceIdentityResult(dict):
     def __init__(__self__, *,
                  datacenters: Sequence[str],
                  service_name: str):
+        """
+        :param Sequence[str] datacenters: Specifies the datacenters the effective policy is valid within.
+        :param str service_name: The name of the service.
+        """
         pulumi.set(__self__, "datacenters", datacenters)
         pulumi.set(__self__, "service_name", service_name)
 
     @property
     @pulumi.getter
     def datacenters(self) -> Sequence[str]:
+        """
+        Specifies the datacenters the effective policy is valid within.
+        """
         return pulumi.get(self, "datacenters")
 
     @property
     @pulumi.getter(name="serviceName")
     def service_name(self) -> str:
+        """
+        The name of the service.
+        """
         return pulumi.get(self, "service_name")
 
 
@@ -3981,6 +4063,11 @@ class GetAclTokenTemplatedPolicyResult(dict):
                  datacenters: Sequence[str],
                  template_name: str,
                  template_variables: Sequence['outputs.GetAclTokenTemplatedPolicyTemplateVariableResult']):
+        """
+        :param Sequence[str] datacenters: Specifies the datacenters the effective policy is valid within.
+        :param str template_name: The name of the templated policies.
+        :param Sequence['GetAclTokenTemplatedPolicyTemplateVariableArgs'] template_variables: The templated policy variables.
+        """
         pulumi.set(__self__, "datacenters", datacenters)
         pulumi.set(__self__, "template_name", template_name)
         pulumi.set(__self__, "template_variables", template_variables)
@@ -3988,16 +4075,25 @@ class GetAclTokenTemplatedPolicyResult(dict):
     @property
     @pulumi.getter
     def datacenters(self) -> Sequence[str]:
+        """
+        Specifies the datacenters the effective policy is valid within.
+        """
         return pulumi.get(self, "datacenters")
 
     @property
     @pulumi.getter(name="templateName")
     def template_name(self) -> str:
+        """
+        The name of the templated policies.
+        """
         return pulumi.get(self, "template_name")
 
     @property
     @pulumi.getter(name="templateVariables")
     def template_variables(self) -> Sequence['outputs.GetAclTokenTemplatedPolicyTemplateVariableResult']:
+        """
+        The templated policy variables.
+        """
         return pulumi.get(self, "template_variables")
 
 
@@ -4005,11 +4101,17 @@ class GetAclTokenTemplatedPolicyResult(dict):
 class GetAclTokenTemplatedPolicyTemplateVariableResult(dict):
     def __init__(__self__, *,
                  name: str):
+        """
+        :param str name: The name of node, workload identity or service.
+        """
         pulumi.set(__self__, "name", name)
 
     @property
     @pulumi.getter
     def name(self) -> str:
+        """
+        The name of node, workload identity or service.
+        """
         return pulumi.get(self, "name")
 
 

pulumi_consul/peering.py

@@ -242,18 +242,13 @@ class Peering(pulumi.CustomResource):
         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"]))
+            })
         ```
 
         :param str resource_name: The name of the resource.
@@ -283,18 +278,13 @@ class Peering(pulumi.CustomResource):
         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"]))
+            })
         ```
 
         :param str resource_name: The name of the resource.