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

pulumi_cloudamqp/get_account.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
@@ -37,7 +38,7 @@ class GetAccountResult:
 
     @property
     @pulumi.getter
-    def id(self) -> str:
+    def id(self) -> builtins.str:
         """
         The provider-assigned unique ID for this managed resource.
         """
@@ -46,6 +47,10 @@ class GetAccountResult:
     @property
     @pulumi.getter
     def instances(self) -> Sequence['outputs.GetAccountInstanceResult']:
+        """
+        An array of instances. Each `instances` block consists of the fields documented
+        below.
+        """
         return pulumi.get(self, "instances")
 
 
@@ -61,7 +66,8 @@ class AwaitableGetAccountResult(GetAccountResult):
 
 def get_account(opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetAccountResult:
     """
-    Use this data source to retrieve basic information about all instances available for an account. Uses the included apikey in provider configuration, to determine which account to read from.
+    Use this data source to retrieve basic information about all instances available for an account.
+    Uses the included apikey in provider configuration, to determine which account to read from.
     """
     __args__ = dict()
     opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
@@ -72,7 +78,8 @@ def get_account(opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetAcco
         instances=pulumi.get(__ret__, 'instances'))
 def get_account_output(opts: Optional[Union[pulumi.InvokeOptions, pulumi.InvokeOutputOptions]] = None) -> pulumi.Output[GetAccountResult]:
     """
-    Use this data source to retrieve basic information about all instances available for an account. Uses the included apikey in provider configuration, to determine which account to read from.
+    Use this data source to retrieve basic information about all instances available for an account.
+    Uses the included apikey in provider configuration, to determine which account to read from.
     """
     __args__ = dict()
     opts = pulumi.InvokeOutputOptions.merge(_utilities.get_invoke_opts_defaults(), opts)

pulumi_cloudamqp/get_account_vpcs.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
@@ -37,7 +38,7 @@ class GetAccountVpcsResult:
 
     @property
     @pulumi.getter
-    def id(self) -> str:
+    def id(self) -> builtins.str:
         """
         The provider-assigned unique ID for this managed resource.
         """
@@ -46,6 +47,9 @@ class GetAccountVpcsResult:
     @property
     @pulumi.getter
     def vpcs(self) -> Sequence['outputs.GetAccountVpcsVpcResult']:
+        """
+        An array of VPCs. Each `vpcs` block consists of the fields documented below.
+        """
         return pulumi.get(self, "vpcs")
 
 
@@ -61,11 +65,14 @@ class AwaitableGetAccountVpcsResult(GetAccountVpcsResult):
 
 def get_account_vpcs(opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetAccountVpcsResult:
     """
-    Use this data source to retrieve basic information about all standalone VPCs available for an account. Uses the included apikey in provider configuration to determine which account to read from.
+    Use this data source to retrieve basic information about all standalone VPCs available for an
+    account. Uses the included apikey in provider configuration to determine which account to read from.
 
     ## Example Usage
 
-    Can be used in other resources/data sources when the VPC identifier is unknown, while other attributes are known. E.g. find correct VPC using the `name` you gave your VPC. Then iterate over VPCs to find the matching one and extract the VPC identifier.
+    Can be used in other resources/data sources when the VPC identifier is unknown, while other
+    attributes are known. E.g. find correct VPC using the `name` you gave your VPC. Then iterate over
+    VPCs to find the matching one and extract the VPC identifier.
 
     ```python
     import pulumi
@@ -76,24 +83,6 @@ def get_account_vpcs(opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGe
     pulumi.export("vpcId", [vpc for vpc in vpc_list.vpcs if vpc.name == my_vpc_name][0].id)
     ```
 
-    ## Attributes reference
-
-    All attributes reference are computed
-
-    * `id`      - The identifier for this data source. Set to `na` since there is no unique identifier.
-    * `vpcs`    - An array of VPCs. Each `vpcs` block consists of the fields documented below.
-
-    ***
-
-    The `vpcs` block consist of
-
-    * `id`          - The VPC identifier.
-    * `name`        - The VPC instance name.
-    * `region`      - The region the VPC is hosted in.
-    * `subnet`      - The VPC subnet.
-    * `tags`        - Optional tags set for the VPC.
-    * `vpc_name`    - VPC name given when hosted at the cloud provider.
-
     ## Dependency
 
     This data source depends on apikey set in the provider configuration.
@@ -107,11 +96,14 @@ def get_account_vpcs(opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGe
         vpcs=pulumi.get(__ret__, 'vpcs'))
 def get_account_vpcs_output(opts: Optional[Union[pulumi.InvokeOptions, pulumi.InvokeOutputOptions]] = None) -> pulumi.Output[GetAccountVpcsResult]:
     """
-    Use this data source to retrieve basic information about all standalone VPCs available for an account. Uses the included apikey in provider configuration to determine which account to read from.
+    Use this data source to retrieve basic information about all standalone VPCs available for an
+    account. Uses the included apikey in provider configuration to determine which account to read from.
 
     ## Example Usage
 
-    Can be used in other resources/data sources when the VPC identifier is unknown, while other attributes are known. E.g. find correct VPC using the `name` you gave your VPC. Then iterate over VPCs to find the matching one and extract the VPC identifier.
+    Can be used in other resources/data sources when the VPC identifier is unknown, while other
+    attributes are known. E.g. find correct VPC using the `name` you gave your VPC. Then iterate over
+    VPCs to find the matching one and extract the VPC identifier.
 
     ```python
     import pulumi
@@ -122,24 +114,6 @@ def get_account_vpcs_output(opts: Optional[Union[pulumi.InvokeOptions, pulumi.In
     pulumi.export("vpcId", [vpc for vpc in vpc_list.vpcs if vpc.name == my_vpc_name][0].id)
     ```
 
-    ## Attributes reference
-
-    All attributes reference are computed
-
-    * `id`      - The identifier for this data source. Set to `na` since there is no unique identifier.
-    * `vpcs`    - An array of VPCs. Each `vpcs` block consists of the fields documented below.
-
-    ***
-
-    The `vpcs` block consist of
-
-    * `id`          - The VPC identifier.
-    * `name`        - The VPC instance name.
-    * `region`      - The region the VPC is hosted in.
-    * `subnet`      - The VPC subnet.
-    * `tags`        - Optional tags set for the VPC.
-    * `vpc_name`    - VPC name given when hosted at the cloud provider.
-
     ## Dependency
 
     This data source depends on apikey set in the provider configuration.

pulumi_cloudamqp/get_alarm.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
@@ -69,17 +70,20 @@ class GetAlarmResult:
 
     @property
     @pulumi.getter(name="alarmId")
-    def alarm_id(self) -> Optional[int]:
+    def alarm_id(self) -> Optional[builtins.int]:
         return pulumi.get(self, "alarm_id")
 
     @property
     @pulumi.getter
-    def enabled(self) -> bool:
+    def enabled(self) -> builtins.bool:
+        """
+        Enable/disable status of the alarm.
+        """
         return pulumi.get(self, "enabled")
 
     @property
     @pulumi.getter
-    def id(self) -> str:
+    def id(self) -> builtins.str:
         """
         The provider-assigned unique ID for this managed resource.
         """
@@ -87,52 +91,79 @@ class GetAlarmResult:
 
     @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(name="messageType")
-    def message_type(self) -> str:
+    def message_type(self) -> builtins.str:
+        """
+        Message type `(total, unacked, ready)` used by queue alarm type.
+        """
         return pulumi.get(self, "message_type")
 
     @property
     @pulumi.getter(name="queueRegex")
-    def queue_regex(self) -> str:
+    def queue_regex(self) -> builtins.str:
+        """
+        Regular expression for which queue to check.
+        """
         return pulumi.get(self, "queue_regex")
 
     @property
     @pulumi.getter
-    def recipients(self) -> Sequence[int]:
+    def recipients(self) -> Sequence[builtins.int]:
+        """
+        Identifier for recipient to be notified.
+        """
         return pulumi.get(self, "recipients")
 
     @property
     @pulumi.getter(name="reminderInterval")
-    def reminder_interval(self) -> int:
+    def reminder_interval(self) -> builtins.int:
+        """
+        The reminder interval (in seconds) to resend the alarm if not resolved.
+        Set to 0 for no reminders.
+        """
         return pulumi.get(self, "reminder_interval")
 
     @property
     @pulumi.getter(name="timeThreshold")
-    def time_threshold(self) -> int:
+    def time_threshold(self) -> builtins.int:
+        """
+        The time interval (in seconds) the `value_threshold` should be active
+        before trigger an alarm.
+        """
         return pulumi.get(self, "time_threshold")
 
     @property
     @pulumi.getter
-    def type(self) -> Optional[str]:
+    def type(self) -> Optional[builtins.str]:
         return pulumi.get(self, "type")
 
     @property
     @pulumi.getter(name="valueCalculation")
-    def value_calculation(self) -> Optional[str]:
+    def value_calculation(self) -> Optional[builtins.str]:
+        """
+        Disk value threshold calculation, `(fixed, percentage)` of disk space
+        remaining.
+        """
         return pulumi.get(self, "value_calculation")
 
     @property
     @pulumi.getter(name="valueThreshold")
-    def value_threshold(self) -> int:
+    def value_threshold(self) -> builtins.int:
+        """
+        The value threshold that triggers the alarm.
+        """
         return pulumi.get(self, "value_threshold")
 
     @property
     @pulumi.getter(name="vhostRegex")
-    def vhost_regex(self) -> str:
+    def vhost_regex(self) -> builtins.str:
+        """
+        Regular expression for which vhost to check
+        """
         return pulumi.get(self, "vhost_regex")
 
 
@@ -157,13 +188,14 @@ class AwaitableGetAlarmResult(GetAlarmResult):
             vhost_regex=self.vhost_regex)
 
 
-def get_alarm(alarm_id: Optional[int] = None,
-              instance_id: Optional[int] = None,
-              type: Optional[str] = None,
-              value_calculation: Optional[str] = None,
+def get_alarm(alarm_id: Optional[builtins.int] = None,
+              instance_id: Optional[builtins.int] = None,
+              type: Optional[builtins.str] = None,
+              value_calculation: Optional[builtins.str] = None,
               opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetAlarmResult:
     """
-    Use this data source to retrieve information about default or created alarms. Either use `alarm_id` or `type` to retrieve the alarm.
+    Use this data source to retrieve information about default or created alarms. Either use `alarm_id`
+    or `type` to retrieve the alarm.
 
     ## Example Usage
 
@@ -175,36 +207,23 @@ def get_alarm(alarm_id: Optional[int] = None,
         type="cpu")
     ```
 
-    ## Attributes reference
-
-    All attributes reference are computed
-
-    * `id`                  - The identifier for this resource.
-    * `enabled`             - Enable/disable status of the alarm.
-    * `value_threshold`     - The value threshold that triggers the alarm.
-    * `reminder_interval`   - The reminder interval (in seconds) to resend the alarm if not resolved. Set to 0 for no reminders.
-    * `time_threshold`      - The time interval (in seconds) the `value_threshold` should be active before trigger an alarm.
-    * `queue_regex`         - Regular expression for which queue to check.
-    * `vhost_regex`         - Regular expression for which vhost to check
-    * `recipients`          - Identifier for recipient to be notified.
-    * `message_type`        - Message type `(total, unacked, ready)` used by queue alarm type.
-
-    Specific attribute for `disk` alarm
-
-    * `value_calculation`   - Disk value threshold calculation, `(fixed, percentage)` of disk space remaining.
-
     ## Dependency
 
     This data source depends on CloudAMQP instance identifier, `cloudamqp_instance.instance.id`.
 
-    ## Alarm types
+    ## Alarm Types
 
     `cpu, memory, disk, queue, connection, flow, consumer, netsplit, server_unreachable, notice`
 
 
-    :param int alarm_id: The alarm identifier. Either use this or `type` to give `Alarm` necessary information to retrieve the alarm.
-    :param int instance_id: The CloudAMQP instance identifier.
-    :param str type: The alarm type. Either use this or `alarm_id` to give `Alarm` necessary information when retrieve the alarm. Supported alarm types
+    :param builtins.int alarm_id: The alarm identifier. Either use this or `type` to give
+           `Alarm` necessary information to retrieve the alarm.
+    :param builtins.int instance_id: The CloudAMQP instance identifier.
+    :param builtins.str type: The alarm type. Either use this or `alarm_id` to give `Alarm`
+           necessary information when retrieve the alarm. Supported
+           alarm types.
+    :param builtins.str value_calculation: Disk value threshold calculation, `(fixed, percentage)` of disk space
+           remaining.
     """
     __args__ = dict()
     __args__['alarmId'] = alarm_id
@@ -228,13 +247,14 @@ def get_alarm(alarm_id: Optional[int] = None,
         value_calculation=pulumi.get(__ret__, 'value_calculation'),
         value_threshold=pulumi.get(__ret__, 'value_threshold'),
         vhost_regex=pulumi.get(__ret__, 'vhost_regex'))
-def get_alarm_output(alarm_id: Optional[pulumi.Input[Optional[int]]] = None,
-                     instance_id: Optional[pulumi.Input[int]] = None,
-                     type: Optional[pulumi.Input[Optional[str]]] = None,
-                     value_calculation: Optional[pulumi.Input[Optional[str]]] = None,
+def get_alarm_output(alarm_id: Optional[pulumi.Input[Optional[builtins.int]]] = None,
+                     instance_id: Optional[pulumi.Input[builtins.int]] = None,
+                     type: Optional[pulumi.Input[Optional[builtins.str]]] = None,
+                     value_calculation: Optional[pulumi.Input[Optional[builtins.str]]] = None,
                      opts: Optional[Union[pulumi.InvokeOptions, pulumi.InvokeOutputOptions]] = None) -> pulumi.Output[GetAlarmResult]:
     """
-    Use this data source to retrieve information about default or created alarms. Either use `alarm_id` or `type` to retrieve the alarm.
+    Use this data source to retrieve information about default or created alarms. Either use `alarm_id`
+    or `type` to retrieve the alarm.
 
     ## Example Usage
 
@@ -246,36 +266,23 @@ def get_alarm_output(alarm_id: Optional[pulumi.Input[Optional[int]]] = None,
         type="cpu")
     ```
 
-    ## Attributes reference
-
-    All attributes reference are computed
-
-    * `id`                  - The identifier for this resource.
-    * `enabled`             - Enable/disable status of the alarm.
-    * `value_threshold`     - The value threshold that triggers the alarm.
-    * `reminder_interval`   - The reminder interval (in seconds) to resend the alarm if not resolved. Set to 0 for no reminders.
-    * `time_threshold`      - The time interval (in seconds) the `value_threshold` should be active before trigger an alarm.
-    * `queue_regex`         - Regular expression for which queue to check.
-    * `vhost_regex`         - Regular expression for which vhost to check
-    * `recipients`          - Identifier for recipient to be notified.
-    * `message_type`        - Message type `(total, unacked, ready)` used by queue alarm type.
-
-    Specific attribute for `disk` alarm
-
-    * `value_calculation`   - Disk value threshold calculation, `(fixed, percentage)` of disk space remaining.
-
     ## Dependency
 
     This data source depends on CloudAMQP instance identifier, `cloudamqp_instance.instance.id`.
 
-    ## Alarm types
+    ## Alarm Types
 
     `cpu, memory, disk, queue, connection, flow, consumer, netsplit, server_unreachable, notice`
 
 
-    :param int alarm_id: The alarm identifier. Either use this or `type` to give `Alarm` necessary information to retrieve the alarm.
-    :param int instance_id: The CloudAMQP instance identifier.
-    :param str type: The alarm type. Either use this or `alarm_id` to give `Alarm` necessary information when retrieve the alarm. Supported alarm types
+    :param builtins.int alarm_id: The alarm identifier. Either use this or `type` to give
+           `Alarm` necessary information to retrieve the alarm.
+    :param builtins.int instance_id: The CloudAMQP instance identifier.
+    :param builtins.str type: The alarm type. Either use this or `alarm_id` to give `Alarm`
+           necessary information when retrieve the alarm. Supported
+           alarm types.
+    :param builtins.str value_calculation: Disk value threshold calculation, `(fixed, percentage)` of disk space
+           remaining.
     """
     __args__ = dict()
     __args__['alarmId'] = alarm_id

pulumi_cloudamqp/get_alarms.py

@@ -0,0 +1,165 @@
+# 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 builtins
+import copy
+import warnings
+import sys
+import pulumi
+import pulumi.runtime
+from typing import Any, Mapping, Optional, Sequence, Union, overload
+if sys.version_info >= (3, 11):
+    from typing import NotRequired, TypedDict, TypeAlias
+else:
+    from typing_extensions import NotRequired, TypedDict, TypeAlias
+from . import _utilities
+from . import outputs
+
+__all__ = [
+    'GetAlarmsResult',
+    'AwaitableGetAlarmsResult',
+    'get_alarms',
+    'get_alarms_output',
+]
+
+@pulumi.output_type
+class GetAlarmsResult:
+    """
+    A collection of values returned by getAlarms.
+    """
+    def __init__(__self__, alarms=None, id=None, instance_id=None, type=None):
+        if alarms and not isinstance(alarms, list):
+            raise TypeError("Expected argument 'alarms' to be a list")
+        pulumi.set(__self__, "alarms", alarms)
+        if id and not isinstance(id, str):
+            raise TypeError("Expected argument 'id' to be a str")
+        pulumi.set(__self__, "id", id)
+        if instance_id and not isinstance(instance_id, int):
+            raise TypeError("Expected argument 'instance_id' to be a int")
+        pulumi.set(__self__, "instance_id", instance_id)
+        if type and not isinstance(type, str):
+            raise TypeError("Expected argument 'type' to be a str")
+        pulumi.set(__self__, "type", type)
+
+    @property
+    @pulumi.getter
+    def alarms(self) -> Sequence['outputs.GetAlarmsAlarmResult']:
+        """
+        List of alarms (see below for nested schema)
+        """
+        return pulumi.get(self, "alarms")
+
+    @property
+    @pulumi.getter
+    def id(self) -> builtins.str:
+        """
+        The provider-assigned unique ID for this managed resource.
+        """
+        return pulumi.get(self, "id")
+
+    @property
+    @pulumi.getter(name="instanceId")
+    def instance_id(self) -> builtins.int:
+        return pulumi.get(self, "instance_id")
+
+    @property
+    @pulumi.getter
+    def type(self) -> Optional[builtins.str]:
+        """
+        The type of the alarm.
+        """
+        return pulumi.get(self, "type")
+
+
+class AwaitableGetAlarmsResult(GetAlarmsResult):
+    # pylint: disable=using-constant-test
+    def __await__(self):
+        if False:
+            yield self
+        return GetAlarmsResult(
+            alarms=self.alarms,
+            id=self.id,
+            instance_id=self.instance_id,
+            type=self.type)
+
+
+def get_alarms(instance_id: Optional[builtins.int] = None,
+               type: Optional[builtins.str] = None,
+               opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetAlarmsResult:
+    """
+    Use this data source to retrieve a list of default or created alarms.
+
+    ## Example Usage
+
+    ```python
+    import pulumi
+    import pulumi_cloudamqp as cloudamqp
+
+    queue_alarms = cloudamqp.get_alarms(instance_id=instance["id"],
+        type="queue")
+    ```
+
+    ## Dependency
+
+    This data source depends on CloudAMQP instance identifier, `cloudamqp_instance.instance.id`.
+
+    ## Alarm Types
+
+    `cpu, memory, disk, queue, connection, flow, consumer, netsplit, server_unreachable, notice`
+
+
+    :param builtins.int instance_id: The CloudAMQP instance identifier.
+    :param builtins.str type: The alarm type to filter for. Supported
+           alarm types.
+    """
+    __args__ = dict()
+    __args__['instanceId'] = instance_id
+    __args__['type'] = type
+    opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
+    __ret__ = pulumi.runtime.invoke('cloudamqp:index/getAlarms:getAlarms', __args__, opts=opts, typ=GetAlarmsResult).value
+
+    return AwaitableGetAlarmsResult(
+        alarms=pulumi.get(__ret__, 'alarms'),
+        id=pulumi.get(__ret__, 'id'),
+        instance_id=pulumi.get(__ret__, 'instance_id'),
+        type=pulumi.get(__ret__, 'type'))
+def get_alarms_output(instance_id: Optional[pulumi.Input[builtins.int]] = None,
+                      type: Optional[pulumi.Input[Optional[builtins.str]]] = None,
+                      opts: Optional[Union[pulumi.InvokeOptions, pulumi.InvokeOutputOptions]] = None) -> pulumi.Output[GetAlarmsResult]:
+    """
+    Use this data source to retrieve a list of default or created alarms.
+
+    ## Example Usage
+
+    ```python
+    import pulumi
+    import pulumi_cloudamqp as cloudamqp
+
+    queue_alarms = cloudamqp.get_alarms(instance_id=instance["id"],
+        type="queue")
+    ```
+
+    ## Dependency
+
+    This data source depends on CloudAMQP instance identifier, `cloudamqp_instance.instance.id`.
+
+    ## Alarm Types
+
+    `cpu, memory, disk, queue, connection, flow, consumer, netsplit, server_unreachable, notice`
+
+
+    :param builtins.int instance_id: The CloudAMQP instance identifier.
+    :param builtins.str type: The alarm type to filter for. Supported
+           alarm types.
+    """
+    __args__ = dict()
+    __args__['instanceId'] = instance_id
+    __args__['type'] = type
+    opts = pulumi.InvokeOutputOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
+    __ret__ = pulumi.runtime.invoke_output('cloudamqp:index/getAlarms:getAlarms', __args__, opts=opts, typ=GetAlarmsResult)
+    return __ret__.apply(lambda __response__: GetAlarmsResult(
+        alarms=pulumi.get(__response__, 'alarms'),
+        id=pulumi.get(__response__, 'id'),
+        instance_id=pulumi.get(__response__, 'instance_id'),
+        type=pulumi.get(__response__, 'type')))