pulumi-cloudamqp 3.21.0a1743571485__py3-none-any.whl → 3.22.0__py3-none-any.whl

pulumi_cloudamqp/get_credentials.py

@@ -2,6 +2,7 @@
 # *** 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 builtins
 import copy
 import warnings
 import sys
@@ -42,7 +43,7 @@ class GetCredentialsResult:
 
     @property
     @pulumi.getter
-    def id(self) -> str:
+    def id(self) -> builtins.str:
         """
         The provider-assigned unique ID for this managed resource.
         """
@@ -50,17 +51,23 @@ class GetCredentialsResult:
 
     @property
     @pulumi.getter(name="instanceId")
-    def instance_id(self) -> int:
+    def instance_id(self) -> builtins.int:
         return pulumi.get(self, "instance_id")
 
     @property
     @pulumi.getter
-    def password(self) -> str:
+    def password(self) -> builtins.str:
+        """
+        (Sensitive) The password used by the `username`.
+        """
         return pulumi.get(self, "password")
 
     @property
     @pulumi.getter
-    def username(self) -> str:
+    def username(self) -> builtins.str:
+        """
+        (Sensitive) The username for the configured user in Rabbit MQ.
+        """
         return pulumi.get(self, "username")
 
 
@@ -76,10 +83,11 @@ class AwaitableGetCredentialsResult(GetCredentialsResult):
             username=self.username)
 
 
-def get_credentials(instance_id: Optional[int] = None,
+def get_credentials(instance_id: Optional[builtins.int] = None,
                     opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetCredentialsResult:
     """
-    Use this data source to retrieve information about the credentials of the configured user in Rabbit MQ. Information is extracted from `cloudamqp_instance.instance.url`.
+    Use this data source to retrieve information about the credentials of the configured user in
+    RabbitMQ. Information is extracted from `cloudamqp_instance.instance.url`.
 
     ## Example Usage
 
@@ -90,20 +98,12 @@ def get_credentials(instance_id: Optional[int] = None,
     credentials = cloudamqp.get_credentials(instance_id=instance["id"])
     ```
 
-    ## Attributes reference
-
-    All attributes reference are computed.
-
-    * `id`          - The identifier for this data source.
-    * `username`    - (Sensitive) The username for the configured user in Rabbit MQ.
-    * `password`    - (Sensitive) The password used by the `username`.
-
     ## Dependency
 
     This data source depends on CloudAMQP instance identifier, `cloudamqp_instance.instance.id`.
 
 
-    :param int instance_id: The CloudAMQP instance identifier.
+    :param builtins.int instance_id: The CloudAMQP instance identifier.
     """
     __args__ = dict()
     __args__['instanceId'] = instance_id
@@ -115,10 +115,11 @@ def get_credentials(instance_id: Optional[int] = None,
         instance_id=pulumi.get(__ret__, 'instance_id'),
         password=pulumi.get(__ret__, 'password'),
         username=pulumi.get(__ret__, 'username'))
-def get_credentials_output(instance_id: Optional[pulumi.Input[int]] = None,
+def get_credentials_output(instance_id: Optional[pulumi.Input[builtins.int]] = None,
                            opts: Optional[Union[pulumi.InvokeOptions, pulumi.InvokeOutputOptions]] = None) -> pulumi.Output[GetCredentialsResult]:
     """
-    Use this data source to retrieve information about the credentials of the configured user in Rabbit MQ. Information is extracted from `cloudamqp_instance.instance.url`.
+    Use this data source to retrieve information about the credentials of the configured user in
+    RabbitMQ. Information is extracted from `cloudamqp_instance.instance.url`.
 
     ## Example Usage
 
@@ -129,20 +130,12 @@ def get_credentials_output(instance_id: Optional[pulumi.Input[int]] = None,
     credentials = cloudamqp.get_credentials(instance_id=instance["id"])
     ```
 
-    ## Attributes reference
-
-    All attributes reference are computed.
-
-    * `id`          - The identifier for this data source.
-    * `username`    - (Sensitive) The username for the configured user in Rabbit MQ.
-    * `password`    - (Sensitive) The password used by the `username`.
-
     ## Dependency
 
     This data source depends on CloudAMQP instance identifier, `cloudamqp_instance.instance.id`.
 
 
-    :param int instance_id: The CloudAMQP instance identifier.
+    :param builtins.int instance_id: The CloudAMQP instance identifier.
     """
     __args__ = dict()
     __args__['instanceId'] = instance_id

pulumi_cloudamqp/get_instance.py

@@ -2,6 +2,7 @@
 # *** 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 builtins
 import copy
 import warnings
 import sys
@@ -87,32 +88,47 @@ class GetInstanceResult:
 
     @property
     @pulumi.getter
-    def apikey(self) -> str:
+    def apikey(self) -> builtins.str:
+        """
+        (Sensitive) The API key to secondary API handing alarms, integration etc.
+        """
         return pulumi.get(self, "apikey")
 
     @property
     @pulumi.getter
-    def backend(self) -> str:
+    def backend(self) -> builtins.str:
+        """
+        Information if the CloudAMQP instance runs either RabbitMQ or LavinMQ.
+        """
         return pulumi.get(self, "backend")
 
     @property
     @pulumi.getter
-    def dedicated(self) -> bool:
+    def dedicated(self) -> builtins.bool:
+        """
+        Information if the CloudAMQP instance is shared or dedicated.
+        """
         return pulumi.get(self, "dedicated")
 
     @property
     @pulumi.getter
-    def host(self) -> str:
+    def host(self) -> builtins.str:
+        """
+        The external hostname for the CloudAMQP instance.
+        """
         return pulumi.get(self, "host")
 
     @property
     @pulumi.getter(name="hostInternal")
-    def host_internal(self) -> str:
+    def host_internal(self) -> builtins.str:
+        """
+        The internal hostname for the CloudAMQP instance.
+        """
         return pulumi.get(self, "host_internal")
 
     @property
     @pulumi.getter
-    def id(self) -> str:
+    def id(self) -> builtins.str:
         """
         The provider-assigned unique ID for this managed resource.
         """
@@ -120,67 +136,99 @@ class GetInstanceResult:
 
     @property
     @pulumi.getter(name="instanceId")
-    def instance_id(self) -> int:
+    def instance_id(self) -> builtins.int:
         return pulumi.get(self, "instance_id")
 
     @property
     @pulumi.getter
-    def name(self) -> str:
+    def name(self) -> builtins.str:
+        """
+        The name of the CloudAMQP instance.
+        """
         return pulumi.get(self, "name")
 
     @property
     @pulumi.getter(name="noDefaultAlarms")
-    def no_default_alarms(self) -> bool:
+    def no_default_alarms(self) -> builtins.bool:
         return pulumi.get(self, "no_default_alarms")
 
     @property
     @pulumi.getter
-    def nodes(self) -> int:
+    def nodes(self) -> builtins.int:
+        """
+        Number of nodes in the cluster of the CloudAMQP instance.
+        """
         return pulumi.get(self, "nodes")
 
     @property
     @pulumi.getter
-    def plan(self) -> str:
+    def plan(self) -> builtins.str:
+        """
+        The subscription plan for the CloudAMQP instance.
+        """
         return pulumi.get(self, "plan")
 
     @property
     @pulumi.getter
-    def ready(self) -> bool:
+    def ready(self) -> builtins.bool:
         return pulumi.get(self, "ready")
 
     @property
     @pulumi.getter
-    def region(self) -> str:
+    def region(self) -> builtins.str:
+        """
+        The cloud platform and region that host the CloudAMQP instance,
+        `{platform}::{region}`.
+        """
         return pulumi.get(self, "region")
 
     @property
     @pulumi.getter(name="rmqVersion")
-    def rmq_version(self) -> str:
+    def rmq_version(self) -> builtins.str:
+        """
+        The version of installed Rabbit MQ.
+        """
         return pulumi.get(self, "rmq_version")
 
     @property
     @pulumi.getter
-    def tags(self) -> Sequence[str]:
+    def tags(self) -> Sequence[builtins.str]:
+        """
+        Tags the CloudAMQP instance with categories.
+        """
         return pulumi.get(self, "tags")
 
     @property
     @pulumi.getter
-    def url(self) -> str:
+    def url(self) -> builtins.str:
+        """
+        (Sensitive) The AMQP URL (uses the internal hostname if the instance was created
+        with VPC), used by clients to connect for pub/sub.
+        """
         return pulumi.get(self, "url")
 
     @property
     @pulumi.getter
-    def vhost(self) -> str:
+    def vhost(self) -> builtins.str:
+        """
+        The virtual host configured in Rabbit MQ.
+        """
         return pulumi.get(self, "vhost")
 
     @property
     @pulumi.getter(name="vpcId")
-    def vpc_id(self) -> int:
+    def vpc_id(self) -> builtins.int:
+        """
+        ID of the VPC configured for the CloudAMQP instance.
+        """
         return pulumi.get(self, "vpc_id")
 
     @property
     @pulumi.getter(name="vpcSubnet")
-    def vpc_subnet(self) -> str:
+    def vpc_subnet(self) -> builtins.str:
+        """
+        Dedicated VPC subnet configured for the CloudAMQP instance.
+        """
         return pulumi.get(self, "vpc_subnet")
 
 
@@ -211,13 +259,14 @@ class AwaitableGetInstanceResult(GetInstanceResult):
             vpc_subnet=self.vpc_subnet)
 
 
-def get_instance(instance_id: Optional[int] = None,
+def get_instance(instance_id: Optional[builtins.int] = None,
                  opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetInstanceResult:
     """
-    Use this data source to retrieve information about an already created CloudAMQP instance. In order to retrieve the correct information, the CoudAMQP instance identifier is needed.
+    Use this data source to retrieve information about an already created CloudAMQP instance. In order
+    to retrieve the correct information, the CoudAMQP instance identifier is needed.
 
 
-    :param int instance_id: The CloudAMQP instance identifier.
+    :param builtins.int instance_id: The CloudAMQP instance identifier.
     """
     __args__ = dict()
     __args__['instanceId'] = instance_id
@@ -244,13 +293,14 @@ def get_instance(instance_id: Optional[int] = None,
         vhost=pulumi.get(__ret__, 'vhost'),
         vpc_id=pulumi.get(__ret__, 'vpc_id'),
         vpc_subnet=pulumi.get(__ret__, 'vpc_subnet'))
-def get_instance_output(instance_id: Optional[pulumi.Input[int]] = None,
+def get_instance_output(instance_id: Optional[pulumi.Input[builtins.int]] = None,
                         opts: Optional[Union[pulumi.InvokeOptions, pulumi.InvokeOutputOptions]] = None) -> pulumi.Output[GetInstanceResult]:
     """
-    Use this data source to retrieve information about an already created CloudAMQP instance. In order to retrieve the correct information, the CoudAMQP instance identifier is needed.
+    Use this data source to retrieve information about an already created CloudAMQP instance. In order
+    to retrieve the correct information, the CoudAMQP instance identifier is needed.
 
 
-    :param int instance_id: The CloudAMQP instance identifier.
+    :param builtins.int instance_id: The CloudAMQP instance identifier.
     """
     __args__ = dict()
     __args__['instanceId'] = instance_id

pulumi_cloudamqp/get_nodes.py

@@ -2,6 +2,7 @@
 # *** 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 builtins
 import copy
 import warnings
 import sys
@@ -40,7 +41,7 @@ class GetNodesResult:
 
     @property
     @pulumi.getter
-    def id(self) -> str:
+    def id(self) -> builtins.str:
         """
         The provider-assigned unique ID for this managed resource.
         """
@@ -48,12 +49,15 @@ class GetNodesResult:
 
     @property
     @pulumi.getter(name="instanceId")
-    def instance_id(self) -> int:
+    def instance_id(self) -> builtins.int:
         return pulumi.get(self, "instance_id")
 
     @property
     @pulumi.getter
     def nodes(self) -> Sequence['outputs.GetNodesNodeResult']:
+        """
+        An array of node information. Each `nodes` block consists of the fields documented below.
+        """
         return pulumi.get(self, "nodes")
 
 
@@ -68,7 +72,7 @@ class AwaitableGetNodesResult(GetNodesResult):
             nodes=self.nodes)
 
 
-def get_nodes(instance_id: Optional[int] = None,
+def get_nodes(instance_id: Optional[builtins.int] = None,
               opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetNodesResult:
     """
     Use this data source to retrieve information about the node(s) created by CloudAMQP instance.
@@ -82,37 +86,12 @@ def get_nodes(instance_id: Optional[int] = None,
     nodes = cloudamqp.get_nodes(instance_id=instance["id"])
     ```
 
-    ## Attributes reference
-
-    All attributes reference are computed
-
-    * `id`    - The identifier for this resource.
-    * `nodes` - An array of node information. Each `nodes` block consists of the fields documented below.
-
-    ***
-
-    The `nodes` block consist of
-
-    * `hostname`              - External hostname assigned to the node.
-    * `hostname_internal`     - Internal hostname assigned to the node.
-    * `name`                  - Name of the node.
-    * `running`               - Is the node running?
-    * `rabbitmq_version`      - Currently configured Rabbit MQ version on the node.
-    * `erlang_version`        - Currently used Erlang version on the node.
-    * `hipe`                  - Enable or disable High-performance Erlang.
-    * `configured`            - Is the node configured?
-    * `disk_size`             - Subscription plan disk size
-    * `additional_disk_size`  - Additional added disk size
-    * `availability_zone`     - Availability zone the node is hosted in.
-
-    ***Note:*** *Total disk size = disk_size + additional_disk_size*
-
     ## Dependency
 
     This data source depends on CloudAMQP instance identifier, `cloudamqp_instance.instance.id`.
 
 
-    :param int instance_id: The CloudAMQP instance identifier.
+    :param builtins.int instance_id: The CloudAMQP instance identifier.
     """
     __args__ = dict()
     __args__['instanceId'] = instance_id
@@ -123,7 +102,7 @@ def get_nodes(instance_id: Optional[int] = None,
         id=pulumi.get(__ret__, 'id'),
         instance_id=pulumi.get(__ret__, 'instance_id'),
         nodes=pulumi.get(__ret__, 'nodes'))
-def get_nodes_output(instance_id: Optional[pulumi.Input[int]] = None,
+def get_nodes_output(instance_id: Optional[pulumi.Input[builtins.int]] = None,
                      opts: Optional[Union[pulumi.InvokeOptions, pulumi.InvokeOutputOptions]] = None) -> pulumi.Output[GetNodesResult]:
     """
     Use this data source to retrieve information about the node(s) created by CloudAMQP instance.
@@ -137,37 +116,12 @@ def get_nodes_output(instance_id: Optional[pulumi.Input[int]] = None,
     nodes = cloudamqp.get_nodes(instance_id=instance["id"])
     ```
 
-    ## Attributes reference
-
-    All attributes reference are computed
-
-    * `id`    - The identifier for this resource.
-    * `nodes` - An array of node information. Each `nodes` block consists of the fields documented below.
-
-    ***
-
-    The `nodes` block consist of
-
-    * `hostname`              - External hostname assigned to the node.
-    * `hostname_internal`     - Internal hostname assigned to the node.
-    * `name`                  - Name of the node.
-    * `running`               - Is the node running?
-    * `rabbitmq_version`      - Currently configured Rabbit MQ version on the node.
-    * `erlang_version`        - Currently used Erlang version on the node.
-    * `hipe`                  - Enable or disable High-performance Erlang.
-    * `configured`            - Is the node configured?
-    * `disk_size`             - Subscription plan disk size
-    * `additional_disk_size`  - Additional added disk size
-    * `availability_zone`     - Availability zone the node is hosted in.
-
-    ***Note:*** *Total disk size = disk_size + additional_disk_size*
-
     ## Dependency
 
     This data source depends on CloudAMQP instance identifier, `cloudamqp_instance.instance.id`.
 
 
-    :param int instance_id: The CloudAMQP instance identifier.
+    :param builtins.int instance_id: The CloudAMQP instance identifier.
     """
     __args__ = dict()
     __args__['instanceId'] = instance_id

pulumi_cloudamqp/get_notification.py

@@ -2,6 +2,7 @@
 # *** 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 builtins
 import copy
 import warnings
 import sys
@@ -51,7 +52,7 @@ class GetNotificationResult:
 
     @property
     @pulumi.getter
-    def id(self) -> str:
+    def id(self) -> builtins.str:
         """
         The provider-assigned unique ID for this managed resource.
         """
@@ -59,32 +60,41 @@ class GetNotificationResult:
 
     @property
     @pulumi.getter(name="instanceId")
-    def instance_id(self) -> int:
+    def instance_id(self) -> builtins.int:
         return pulumi.get(self, "instance_id")
 
     @property
     @pulumi.getter
-    def name(self) -> Optional[str]:
+    def name(self) -> Optional[builtins.str]:
         return pulumi.get(self, "name")
 
     @property
     @pulumi.getter
-    def options(self) -> Optional[Mapping[str, str]]:
+    def options(self) -> Optional[Mapping[str, builtins.str]]:
+        """
+        Options argument (e.g. `rk` used for VictorOps routing key).
+        """
         return pulumi.get(self, "options")
 
     @property
     @pulumi.getter(name="recipientId")
-    def recipient_id(self) -> Optional[int]:
+    def recipient_id(self) -> Optional[builtins.int]:
         return pulumi.get(self, "recipient_id")
 
     @property
     @pulumi.getter
-    def type(self) -> str:
+    def type(self) -> builtins.str:
+        """
+        The type of the recipient.
+        """
         return pulumi.get(self, "type")
 
     @property
     @pulumi.getter
-    def value(self) -> str:
+    def value(self) -> builtins.str:
+        """
+        The notification endpoint, where to send the notification.
+        """
         return pulumi.get(self, "value")
 
 
@@ -103,13 +113,15 @@ class AwaitableGetNotificationResult(GetNotificationResult):
             value=self.value)
 
 
-def get_notification(instance_id: Optional[int] = None,
-                     name: Optional[str] = None,
-                     options: Optional[Mapping[str, str]] = None,
-                     recipient_id: Optional[int] = None,
+def get_notification(instance_id: Optional[builtins.int] = None,
+                     name: Optional[builtins.str] = None,
+                     options: Optional[Mapping[str, builtins.str]] = None,
+                     recipient_id: Optional[builtins.int] = None,
                      opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetNotificationResult:
     """
-    Use this data source to retrieve information about default or created recipients. The recipient will receive notifications assigned to an alarm that has triggered. To retrieve the recipient either use `recipient_id` or `name`.
+    Use this data source to retrieve information about default or created recipients. The recipient will
+    receive notifications assigned to an alarm that has triggered. To retrieve the recipient either use
+    `recipient_id` or `name`.
 
     ## Example Usage
 
@@ -121,23 +133,15 @@ def get_notification(instance_id: Optional[int] = None,
         name="default")
     ```
 
-    ## Attributes reference
-
-    All attributes reference are computed
-
-    * `id`    - The identifier for this resource.
-    * `type`  - The type of the recipient.
-    * `value` - The notification endpoint, where to send the notification.
-    * `options`- Options argument (e.g. `rk` used for VictorOps routing key).
-
     ## Dependency
 
     This data source depends on CloudAMQP instance identifier, `cloudamqp_instance.instance.id`.
 
 
-    :param int instance_id: The CloudAMQP instance identifier.
-    :param str name: The name set for the recipient.
-    :param int recipient_id: The recipient identifier.
+    :param builtins.int instance_id: The CloudAMQP instance identifier.
+    :param builtins.str name: The name set for the recipient.
+    :param Mapping[str, builtins.str] options: Options argument (e.g. `rk` used for VictorOps routing key).
+    :param builtins.int recipient_id: The recipient identifier.
     """
     __args__ = dict()
     __args__['instanceId'] = instance_id
@@ -155,13 +159,15 @@ def get_notification(instance_id: Optional[int] = None,
         recipient_id=pulumi.get(__ret__, 'recipient_id'),
         type=pulumi.get(__ret__, 'type'),
         value=pulumi.get(__ret__, 'value'))
-def get_notification_output(instance_id: Optional[pulumi.Input[int]] = None,
-                            name: Optional[pulumi.Input[Optional[str]]] = None,
-                            options: Optional[pulumi.Input[Optional[Mapping[str, str]]]] = None,
-                            recipient_id: Optional[pulumi.Input[Optional[int]]] = None,
+def get_notification_output(instance_id: Optional[pulumi.Input[builtins.int]] = None,
+                            name: Optional[pulumi.Input[Optional[builtins.str]]] = None,
+                            options: Optional[pulumi.Input[Optional[Mapping[str, builtins.str]]]] = None,
+                            recipient_id: Optional[pulumi.Input[Optional[builtins.int]]] = None,
                             opts: Optional[Union[pulumi.InvokeOptions, pulumi.InvokeOutputOptions]] = None) -> pulumi.Output[GetNotificationResult]:
     """
-    Use this data source to retrieve information about default or created recipients. The recipient will receive notifications assigned to an alarm that has triggered. To retrieve the recipient either use `recipient_id` or `name`.
+    Use this data source to retrieve information about default or created recipients. The recipient will
+    receive notifications assigned to an alarm that has triggered. To retrieve the recipient either use
+    `recipient_id` or `name`.
 
     ## Example Usage
 
@@ -173,23 +179,15 @@ def get_notification_output(instance_id: Optional[pulumi.Input[int]] = None,
         name="default")
     ```
 
-    ## Attributes reference
-
-    All attributes reference are computed
-
-    * `id`    - The identifier for this resource.
-    * `type`  - The type of the recipient.
-    * `value` - The notification endpoint, where to send the notification.
-    * `options`- Options argument (e.g. `rk` used for VictorOps routing key).
-
     ## Dependency
 
     This data source depends on CloudAMQP instance identifier, `cloudamqp_instance.instance.id`.
 
 
-    :param int instance_id: The CloudAMQP instance identifier.
-    :param str name: The name set for the recipient.
-    :param int recipient_id: The recipient identifier.
+    :param builtins.int instance_id: The CloudAMQP instance identifier.
+    :param builtins.str name: The name set for the recipient.
+    :param Mapping[str, builtins.str] options: Options argument (e.g. `rk` used for VictorOps routing key).
+    :param builtins.int recipient_id: The recipient identifier.
     """
     __args__ = dict()
     __args__['instanceId'] = instance_id