pulumi-digitalocean 4.40.0a1739511652__py3-none-any.whl → 4.56.0a1766428645__py3-none-any.whl

pulumi_digitalocean/get_sizes.py

@@ -1,8 +1,8 @@
 # coding=utf-8
-# *** WARNING: this file was generated by the Pulumi Terraform Bridge (tfgen) Tool. ***
+# *** WARNING: this file was generated by pulumi-language-python. ***
 # *** Do not edit by hand unless you're certain you know what you are doing! ***
 
-import copy
+import builtins as _builtins
 import warnings
 import sys
 import pulumi
@@ -42,25 +42,25 @@ class GetSizesResult:
             raise TypeError("Expected argument 'sorts' to be a list")
         pulumi.set(__self__, "sorts", sorts)
 
-    @property
+    @_builtins.property
     @pulumi.getter
     def filters(self) -> Optional[Sequence['outputs.GetSizesFilterResult']]:
         return pulumi.get(self, "filters")
 
-    @property
+    @_builtins.property
     @pulumi.getter
-    def id(self) -> str:
+    def id(self) -> _builtins.str:
         """
         The provider-assigned unique ID for this managed resource.
         """
         return pulumi.get(self, "id")
 
-    @property
+    @_builtins.property
     @pulumi.getter
     def sizes(self) -> Sequence['outputs.GetSizesSizeResult']:
         return pulumi.get(self, "sizes")
 
-    @property
+    @_builtins.property
     @pulumi.getter
     def sorts(self) -> Optional[Sequence['outputs.GetSizesSortResult']]:
         return pulumi.get(self, "sorts")
@@ -86,6 +86,73 @@ def get_sizes(filters: Optional[Sequence[Union['GetSizesFilterArgs', 'GetSizesFi
     the ability to filter and sort the results. If no filters are specified, all sizes
     will be returned.
 
+    ## Example Usage
+
+    Most common usage will probably be to supply a size to Droplet:
+
+    ```python
+    import pulumi
+    import pulumi_digitalocean as digitalocean
+
+    main = digitalocean.get_sizes(filters=[{
+        "key": "slug",
+        "values": ["s-1vcpu-1gb"],
+    }])
+    web = digitalocean.Droplet("web",
+        image="ubuntu-18-04-x64",
+        name="web-1",
+        region=digitalocean.Region.SGP1,
+        size=digitalocean.DropletSlug(main.sizes[0]["slug"]))
+    ```
+
+    The data source also supports multiple filters and sorts. For example, to fetch sizes with 1 or 2 virtual CPU that are available "sgp1" region, then pick the cheapest one:
+
+    ```python
+    import pulumi
+    import pulumi_digitalocean as digitalocean
+
+    main = digitalocean.get_sizes(filters=[
+            {
+                "key": "vcpus",
+                "values": [
+                    "1",
+                    "2",
+                ],
+            },
+            {
+                "key": "regions",
+                "values": ["sgp1"],
+            },
+        ],
+        sorts=[{
+            "key": "price_monthly",
+            "direction": "asc",
+        }])
+    web = digitalocean.Droplet("web",
+        image="ubuntu-18-04-x64",
+        name="web-1",
+        region=digitalocean.Region.SGP1,
+        size=digitalocean.DropletSlug(main.sizes[0]["slug"]))
+    ```
+
+    The data source can also handle multiple sorts. In which case, the sort will be applied in the order it is defined. For example, to sort by memory in ascending order, then sort by disk in descending order between sizes with same memory:
+
+    ```python
+    import pulumi
+    import pulumi_digitalocean as digitalocean
+
+    main = digitalocean.get_sizes(sorts=[
+        {
+            "key": "memory",
+            "direction": "asc",
+        },
+        {
+            "key": "disk",
+            "direction": "desc",
+        },
+    ])
+    ```
+
 
     :param Sequence[Union['GetSizesFilterArgs', 'GetSizesFilterArgsDict']] filters: Filter the results.
            The `filter` block is documented below.
@@ -111,6 +178,73 @@ def get_sizes_output(filters: Optional[pulumi.Input[Optional[Sequence[Union['Get
     the ability to filter and sort the results. If no filters are specified, all sizes
     will be returned.
 
+    ## Example Usage
+
+    Most common usage will probably be to supply a size to Droplet:
+
+    ```python
+    import pulumi
+    import pulumi_digitalocean as digitalocean
+
+    main = digitalocean.get_sizes(filters=[{
+        "key": "slug",
+        "values": ["s-1vcpu-1gb"],
+    }])
+    web = digitalocean.Droplet("web",
+        image="ubuntu-18-04-x64",
+        name="web-1",
+        region=digitalocean.Region.SGP1,
+        size=digitalocean.DropletSlug(main.sizes[0]["slug"]))
+    ```
+
+    The data source also supports multiple filters and sorts. For example, to fetch sizes with 1 or 2 virtual CPU that are available "sgp1" region, then pick the cheapest one:
+
+    ```python
+    import pulumi
+    import pulumi_digitalocean as digitalocean
+
+    main = digitalocean.get_sizes(filters=[
+            {
+                "key": "vcpus",
+                "values": [
+                    "1",
+                    "2",
+                ],
+            },
+            {
+                "key": "regions",
+                "values": ["sgp1"],
+            },
+        ],
+        sorts=[{
+            "key": "price_monthly",
+            "direction": "asc",
+        }])
+    web = digitalocean.Droplet("web",
+        image="ubuntu-18-04-x64",
+        name="web-1",
+        region=digitalocean.Region.SGP1,
+        size=digitalocean.DropletSlug(main.sizes[0]["slug"]))
+    ```
+
+    The data source can also handle multiple sorts. In which case, the sort will be applied in the order it is defined. For example, to sort by memory in ascending order, then sort by disk in descending order between sizes with same memory:
+
+    ```python
+    import pulumi
+    import pulumi_digitalocean as digitalocean
+
+    main = digitalocean.get_sizes(sorts=[
+        {
+            "key": "memory",
+            "direction": "asc",
+        },
+        {
+            "key": "disk",
+            "direction": "desc",
+        },
+    ])
+    ```
+
 
     :param Sequence[Union['GetSizesFilterArgs', 'GetSizesFilterArgsDict']] filters: Filter the results.
            The `filter` block is documented below.

pulumi_digitalocean/get_spaces_bucket.py

@@ -1,8 +1,8 @@
 # coding=utf-8
-# *** WARNING: this file was generated by the Pulumi Terraform Bridge (tfgen) Tool. ***
+# *** WARNING: this file was generated by pulumi-language-python. ***
 # *** Do not edit by hand unless you're certain you know what you are doing! ***
 
-import copy
+import builtins as _builtins
 import warnings
 import sys
 import pulumi
@@ -46,49 +46,49 @@ class GetSpacesBucketResult:
             raise TypeError("Expected argument 'urn' to be a str")
         pulumi.set(__self__, "urn", urn)
 
-    @property
+    @_builtins.property
     @pulumi.getter(name="bucketDomainName")
-    def bucket_domain_name(self) -> str:
+    def bucket_domain_name(self) -> _builtins.str:
         """
         The FQDN of the bucket (e.g. bucket-name.nyc3.digitaloceanspaces.com)
         """
         return pulumi.get(self, "bucket_domain_name")
 
-    @property
+    @_builtins.property
     @pulumi.getter
-    def endpoint(self) -> str:
+    def endpoint(self) -> _builtins.str:
         """
         The FQDN of the bucket without the bucket name (e.g. nyc3.digitaloceanspaces.com)
         """
         return pulumi.get(self, "endpoint")
 
-    @property
+    @_builtins.property
     @pulumi.getter
-    def id(self) -> str:
+    def id(self) -> _builtins.str:
         """
         The provider-assigned unique ID for this managed resource.
         """
         return pulumi.get(self, "id")
 
-    @property
+    @_builtins.property
     @pulumi.getter
-    def name(self) -> str:
+    def name(self) -> _builtins.str:
         """
         The name of the Spaces bucket
         """
         return pulumi.get(self, "name")
 
-    @property
+    @_builtins.property
     @pulumi.getter
-    def region(self) -> str:
+    def region(self) -> _builtins.str:
         """
         The slug of the region where the bucket is stored.
         """
         return pulumi.get(self, "region")
 
-    @property
+    @_builtins.property
     @pulumi.getter
-    def urn(self) -> str:
+    def urn(self) -> _builtins.str:
         """
         The uniform resource name of the bucket
         """
@@ -109,8 +109,8 @@ class AwaitableGetSpacesBucketResult(GetSpacesBucketResult):
             urn=self.urn)
 
 
-def get_spaces_bucket(name: Optional[str] = None,
-                      region: Optional[str] = None,
+def get_spaces_bucket(name: Optional[_builtins.str] = None,
+                      region: Optional[_builtins.str] = None,
                       opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetSpacesBucketResult:
     """
     Get information on a Spaces bucket for use in other resources. This is useful if the Spaces bucket in question
@@ -130,8 +130,8 @@ def get_spaces_bucket(name: Optional[str] = None,
     ```
 
 
-    :param str name: The name of the Spaces bucket.
-    :param str region: The slug of the region where the bucket is stored.
+    :param _builtins.str name: The name of the Spaces bucket.
+    :param _builtins.str region: The slug of the region where the bucket is stored.
     """
     __args__ = dict()
     __args__['name'] = name
@@ -146,8 +146,8 @@ def get_spaces_bucket(name: Optional[str] = None,
         name=pulumi.get(__ret__, 'name'),
         region=pulumi.get(__ret__, 'region'),
         urn=pulumi.get(__ret__, 'urn'))
-def get_spaces_bucket_output(name: Optional[pulumi.Input[str]] = None,
-                             region: Optional[pulumi.Input[str]] = None,
+def get_spaces_bucket_output(name: Optional[pulumi.Input[_builtins.str]] = None,
+                             region: Optional[pulumi.Input[_builtins.str]] = None,
                              opts: Optional[Union[pulumi.InvokeOptions, pulumi.InvokeOutputOptions]] = None) -> pulumi.Output[GetSpacesBucketResult]:
     """
     Get information on a Spaces bucket for use in other resources. This is useful if the Spaces bucket in question
@@ -167,8 +167,8 @@ def get_spaces_bucket_output(name: Optional[pulumi.Input[str]] = None,
     ```
 
 
-    :param str name: The name of the Spaces bucket.
-    :param str region: The slug of the region where the bucket is stored.
+    :param _builtins.str name: The name of the Spaces bucket.
+    :param _builtins.str region: The slug of the region where the bucket is stored.
     """
     __args__ = dict()
     __args__['name'] = name

pulumi_digitalocean/get_spaces_bucket_object.py

@@ -1,8 +1,8 @@
 # coding=utf-8
-# *** WARNING: this file was generated by the Pulumi Terraform Bridge (tfgen) Tool. ***
+# *** WARNING: this file was generated by pulumi-language-python. ***
 # *** Do not edit by hand unless you're certain you know what you are doing! ***
 
-import copy
+import builtins as _builtins
 import warnings
 import sys
 import pulumi
@@ -85,141 +85,141 @@ class GetSpacesBucketObjectResult:
             raise TypeError("Expected argument 'website_redirect_location' to be a str")
         pulumi.set(__self__, "website_redirect_location", website_redirect_location)
 
-    @property
+    @_builtins.property
     @pulumi.getter
-    def body(self) -> str:
+    def body(self) -> _builtins.str:
         """
         Object data (see **limitations above** to understand cases in which this field is actually available)
         """
         return pulumi.get(self, "body")
 
-    @property
+    @_builtins.property
     @pulumi.getter
-    def bucket(self) -> str:
+    def bucket(self) -> _builtins.str:
         return pulumi.get(self, "bucket")
 
-    @property
+    @_builtins.property
     @pulumi.getter(name="cacheControl")
-    def cache_control(self) -> str:
+    def cache_control(self) -> _builtins.str:
         """
         Specifies caching behavior along the request/reply chain.
         """
         return pulumi.get(self, "cache_control")
 
-    @property
+    @_builtins.property
     @pulumi.getter(name="contentDisposition")
-    def content_disposition(self) -> str:
+    def content_disposition(self) -> _builtins.str:
         """
         Specifies presentational information for the object.
         """
         return pulumi.get(self, "content_disposition")
 
-    @property
+    @_builtins.property
     @pulumi.getter(name="contentEncoding")
-    def content_encoding(self) -> str:
+    def content_encoding(self) -> _builtins.str:
         """
         Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.
         """
         return pulumi.get(self, "content_encoding")
 
-    @property
+    @_builtins.property
     @pulumi.getter(name="contentLanguage")
-    def content_language(self) -> str:
+    def content_language(self) -> _builtins.str:
         """
         The language the content is in.
         """
         return pulumi.get(self, "content_language")
 
-    @property
+    @_builtins.property
     @pulumi.getter(name="contentLength")
-    def content_length(self) -> int:
+    def content_length(self) -> _builtins.int:
         """
         Size of the body in bytes.
         """
         return pulumi.get(self, "content_length")
 
-    @property
+    @_builtins.property
     @pulumi.getter(name="contentType")
-    def content_type(self) -> str:
+    def content_type(self) -> _builtins.str:
         """
         A standard MIME type describing the format of the object data.
         """
         return pulumi.get(self, "content_type")
 
-    @property
+    @_builtins.property
     @pulumi.getter
-    def etag(self) -> str:
+    def etag(self) -> _builtins.str:
         """
         [ETag](https://en.wikipedia.org/wiki/HTTP_ETag) generated for the object (an MD5 sum of the object content in case it's not encrypted)
         """
         return pulumi.get(self, "etag")
 
-    @property
+    @_builtins.property
     @pulumi.getter
-    def expiration(self) -> str:
+    def expiration(self) -> _builtins.str:
         """
         If the object expiration is configured (see [object lifecycle management](http://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html)), the field includes this header. It includes the expiry-date and rule-id key value pairs providing object expiration information. The value of the rule-id is URL encoded.
         """
         return pulumi.get(self, "expiration")
 
-    @property
+    @_builtins.property
     @pulumi.getter
-    def expires(self) -> str:
+    def expires(self) -> _builtins.str:
         """
         The date and time at which the object is no longer cacheable.
         """
         return pulumi.get(self, "expires")
 
-    @property
+    @_builtins.property
     @pulumi.getter
-    def id(self) -> str:
+    def id(self) -> _builtins.str:
         """
         The provider-assigned unique ID for this managed resource.
         """
         return pulumi.get(self, "id")
 
-    @property
+    @_builtins.property
     @pulumi.getter
-    def key(self) -> str:
+    def key(self) -> _builtins.str:
         return pulumi.get(self, "key")
 
-    @property
+    @_builtins.property
     @pulumi.getter(name="lastModified")
-    def last_modified(self) -> str:
+    def last_modified(self) -> _builtins.str:
         """
         Last modified date of the object in RFC1123 format (e.g. `Mon, 02 Jan 2006 15:04:05 MST`)
         """
         return pulumi.get(self, "last_modified")
 
-    @property
+    @_builtins.property
     @pulumi.getter
-    def metadata(self) -> Mapping[str, str]:
+    def metadata(self) -> Mapping[str, _builtins.str]:
         """
         A map of metadata stored with the object in Spaces
         """
         return pulumi.get(self, "metadata")
 
-    @property
+    @_builtins.property
     @pulumi.getter
-    def range(self) -> Optional[str]:
+    def range(self) -> Optional[_builtins.str]:
         return pulumi.get(self, "range")
 
-    @property
+    @_builtins.property
     @pulumi.getter
-    def region(self) -> str:
+    def region(self) -> _builtins.str:
         return pulumi.get(self, "region")
 
-    @property
+    @_builtins.property
     @pulumi.getter(name="versionId")
-    def version_id(self) -> str:
+    def version_id(self) -> _builtins.str:
         """
         The latest version ID of the object returned.
         """
         return pulumi.get(self, "version_id")
 
-    @property
+    @_builtins.property
     @pulumi.getter(name="websiteRedirectLocation")
-    def website_redirect_location(self) -> str:
+    def website_redirect_location(self) -> _builtins.str:
         """
         If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Spaces stores the value of this header in the object metadata.
         """
@@ -253,11 +253,11 @@ class AwaitableGetSpacesBucketObjectResult(GetSpacesBucketObjectResult):
             website_redirect_location=self.website_redirect_location)
 
 
-def get_spaces_bucket_object(bucket: Optional[str] = None,
-                             key: Optional[str] = None,
-                             range: Optional[str] = None,
-                             region: Optional[str] = None,
-                             version_id: Optional[str] = None,
+def get_spaces_bucket_object(bucket: Optional[_builtins.str] = None,
+                             key: Optional[_builtins.str] = None,
+                             range: Optional[_builtins.str] = None,
+                             region: Optional[_builtins.str] = None,
+                             version_id: Optional[_builtins.str] = None,
                              opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetSpacesBucketObjectResult:
     """
     The Spaces object data source allows access to the metadata and
@@ -288,10 +288,10 @@ def get_spaces_bucket_object(bucket: Optional[str] = None,
     ```
 
 
-    :param str bucket: The name of the bucket to read the object from.
-    :param str key: The full path to the object inside the bucket
-    :param str region: The slug of the region where the bucket is stored.
-    :param str version_id: Specific version ID of the object returned (defaults to latest version)
+    :param _builtins.str bucket: The name of the bucket to read the object from.
+    :param _builtins.str key: The full path to the object inside the bucket
+    :param _builtins.str region: The slug of the region where the bucket is stored.
+    :param _builtins.str version_id: Specific version ID of the object returned (defaults to latest version)
     """
     __args__ = dict()
     __args__['bucket'] = bucket
@@ -322,11 +322,11 @@ def get_spaces_bucket_object(bucket: Optional[str] = None,
         region=pulumi.get(__ret__, 'region'),
         version_id=pulumi.get(__ret__, 'version_id'),
         website_redirect_location=pulumi.get(__ret__, 'website_redirect_location'))
-def get_spaces_bucket_object_output(bucket: Optional[pulumi.Input[str]] = None,
-                                    key: Optional[pulumi.Input[str]] = None,
-                                    range: Optional[pulumi.Input[Optional[str]]] = None,
-                                    region: Optional[pulumi.Input[str]] = None,
-                                    version_id: Optional[pulumi.Input[Optional[str]]] = None,
+def get_spaces_bucket_object_output(bucket: Optional[pulumi.Input[_builtins.str]] = None,
+                                    key: Optional[pulumi.Input[_builtins.str]] = None,
+                                    range: Optional[pulumi.Input[Optional[_builtins.str]]] = None,
+                                    region: Optional[pulumi.Input[_builtins.str]] = None,
+                                    version_id: Optional[pulumi.Input[Optional[_builtins.str]]] = None,
                                     opts: Optional[Union[pulumi.InvokeOptions, pulumi.InvokeOutputOptions]] = None) -> pulumi.Output[GetSpacesBucketObjectResult]:
     """
     The Spaces object data source allows access to the metadata and
@@ -357,10 +357,10 @@ def get_spaces_bucket_object_output(bucket: Optional[pulumi.Input[str]] = None,
     ```
 
 
-    :param str bucket: The name of the bucket to read the object from.
-    :param str key: The full path to the object inside the bucket
-    :param str region: The slug of the region where the bucket is stored.
-    :param str version_id: Specific version ID of the object returned (defaults to latest version)
+    :param _builtins.str bucket: The name of the bucket to read the object from.
+    :param _builtins.str key: The full path to the object inside the bucket
+    :param _builtins.str region: The slug of the region where the bucket is stored.
+    :param _builtins.str version_id: Specific version ID of the object returned (defaults to latest version)
     """
     __args__ = dict()
     __args__['bucket'] = bucket