pulumiverse-scaleway 1.29.0a1747948949__py3-none-any.whl → 1.30.0__py3-none-any.whl

pulumiverse_scaleway/elasticmetal/get_partition_schema.py

@@ -0,0 +1,216 @@
+# coding=utf-8
+# *** 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 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
+
+__all__ = [
+    'GetPartitionSchemaResult',
+    'AwaitableGetPartitionSchemaResult',
+    'get_partition_schema',
+    'get_partition_schema_output',
+]
+
+@pulumi.output_type
+class GetPartitionSchemaResult:
+    """
+    A collection of values returned by getPartitionSchema.
+    """
+    def __init__(__self__, ext4_mountpoint=None, extra_partition=None, id=None, json_partition=None, offer_id=None, os_id=None, swap=None):
+        if ext4_mountpoint and not isinstance(ext4_mountpoint, str):
+            raise TypeError("Expected argument 'ext4_mountpoint' to be a str")
+        pulumi.set(__self__, "ext4_mountpoint", ext4_mountpoint)
+        if extra_partition and not isinstance(extra_partition, bool):
+            raise TypeError("Expected argument 'extra_partition' to be a bool")
+        pulumi.set(__self__, "extra_partition", extra_partition)
+        if id and not isinstance(id, str):
+            raise TypeError("Expected argument 'id' to be a str")
+        pulumi.set(__self__, "id", id)
+        if json_partition and not isinstance(json_partition, str):
+            raise TypeError("Expected argument 'json_partition' to be a str")
+        pulumi.set(__self__, "json_partition", json_partition)
+        if offer_id and not isinstance(offer_id, str):
+            raise TypeError("Expected argument 'offer_id' to be a str")
+        pulumi.set(__self__, "offer_id", offer_id)
+        if os_id and not isinstance(os_id, str):
+            raise TypeError("Expected argument 'os_id' to be a str")
+        pulumi.set(__self__, "os_id", os_id)
+        if swap and not isinstance(swap, bool):
+            raise TypeError("Expected argument 'swap' to be a bool")
+        pulumi.set(__self__, "swap", swap)
+
+    @property
+    @pulumi.getter(name="ext4Mountpoint")
+    def ext4_mountpoint(self) -> Optional[builtins.str]:
+        return pulumi.get(self, "ext4_mountpoint")
+
+    @property
+    @pulumi.getter(name="extraPartition")
+    def extra_partition(self) -> Optional[builtins.bool]:
+        return pulumi.get(self, "extra_partition")
+
+    @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="jsonPartition")
+    def json_partition(self) -> builtins.str:
+        """
+        — A validated partitioning schema in JSON format that can be directly used for BareMetal server deployment.
+        """
+        return pulumi.get(self, "json_partition")
+
+    @property
+    @pulumi.getter(name="offerId")
+    def offer_id(self) -> builtins.str:
+        return pulumi.get(self, "offer_id")
+
+    @property
+    @pulumi.getter(name="osId")
+    def os_id(self) -> builtins.str:
+        return pulumi.get(self, "os_id")
+
+    @property
+    @pulumi.getter
+    def swap(self) -> Optional[builtins.bool]:
+        return pulumi.get(self, "swap")
+
+
+class AwaitableGetPartitionSchemaResult(GetPartitionSchemaResult):
+    # pylint: disable=using-constant-test
+    def __await__(self):
+        if False:
+            yield self
+        return GetPartitionSchemaResult(
+            ext4_mountpoint=self.ext4_mountpoint,
+            extra_partition=self.extra_partition,
+            id=self.id,
+            json_partition=self.json_partition,
+            offer_id=self.offer_id,
+            os_id=self.os_id,
+            swap=self.swap)
+
+
+def get_partition_schema(ext4_mountpoint: Optional[builtins.str] = None,
+                         extra_partition: Optional[builtins.bool] = None,
+                         offer_id: Optional[builtins.str] = None,
+                         os_id: Optional[builtins.str] = None,
+                         swap: Optional[builtins.bool] = None,
+                         opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetPartitionSchemaResult:
+    """
+    The elasticmetal_get_partition_schema data source allows you to retrieve a ready-to-use partitioning schema for a BareMetal server. This schema can be used for custom installations with optional swap and extra partitions.
+
+    This data source simplifies the process of generating valid partitioning configurations, especially useful when dealing with OS and offer compatibility requirements.
+
+    ## Partitioning Details
+
+    The partitioning schema generated by the `elasticmetal_get_partition_schema` data source includes a root (`/`) partition that is **20GB** in size by default.
+
+    If additional storage is required, you can enable the `extra_partition` option to mount extra space on a custom path (e.g., `/data`).
+
+    ## Example Usage
+
+    ```python
+    import pulumi
+    import pulumi_scaleway as scaleway
+
+    default = scaleway.elasticmetal.get_partition_schema(offer_id="11111111-1111-1111-1111-111111111111",
+        os_id="22222222-2222-2222-2222-222222222222",
+        swap=True,
+        extra_partition=True,
+        ext4_mountpoint="/data")
+    ```
+
+
+    :param builtins.str ext4_mountpoint: The mount point for the extra partition. Must be an absolute path using alphanumeric characters and underscores.
+    :param builtins.bool extra_partition: Whether to add an extra ext4 data partition.
+    :param builtins.str offer_id: The UUID of the BareMetal offer.
+    :param builtins.str os_id: The UUID of the OS image.
+    :param builtins.bool swap: Whether to include a swap partition.
+    """
+    __args__ = dict()
+    __args__['ext4Mountpoint'] = ext4_mountpoint
+    __args__['extraPartition'] = extra_partition
+    __args__['offerId'] = offer_id
+    __args__['osId'] = os_id
+    __args__['swap'] = swap
+    opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
+    __ret__ = pulumi.runtime.invoke('scaleway:elasticmetal/getPartitionSchema:getPartitionSchema', __args__, opts=opts, typ=GetPartitionSchemaResult).value
+
+    return AwaitableGetPartitionSchemaResult(
+        ext4_mountpoint=pulumi.get(__ret__, 'ext4_mountpoint'),
+        extra_partition=pulumi.get(__ret__, 'extra_partition'),
+        id=pulumi.get(__ret__, 'id'),
+        json_partition=pulumi.get(__ret__, 'json_partition'),
+        offer_id=pulumi.get(__ret__, 'offer_id'),
+        os_id=pulumi.get(__ret__, 'os_id'),
+        swap=pulumi.get(__ret__, 'swap'))
+def get_partition_schema_output(ext4_mountpoint: Optional[pulumi.Input[Optional[builtins.str]]] = None,
+                                extra_partition: Optional[pulumi.Input[Optional[builtins.bool]]] = None,
+                                offer_id: Optional[pulumi.Input[builtins.str]] = None,
+                                os_id: Optional[pulumi.Input[builtins.str]] = None,
+                                swap: Optional[pulumi.Input[Optional[builtins.bool]]] = None,
+                                opts: Optional[Union[pulumi.InvokeOptions, pulumi.InvokeOutputOptions]] = None) -> pulumi.Output[GetPartitionSchemaResult]:
+    """
+    The elasticmetal_get_partition_schema data source allows you to retrieve a ready-to-use partitioning schema for a BareMetal server. This schema can be used for custom installations with optional swap and extra partitions.
+
+    This data source simplifies the process of generating valid partitioning configurations, especially useful when dealing with OS and offer compatibility requirements.
+
+    ## Partitioning Details
+
+    The partitioning schema generated by the `elasticmetal_get_partition_schema` data source includes a root (`/`) partition that is **20GB** in size by default.
+
+    If additional storage is required, you can enable the `extra_partition` option to mount extra space on a custom path (e.g., `/data`).
+
+    ## Example Usage
+
+    ```python
+    import pulumi
+    import pulumi_scaleway as scaleway
+
+    default = scaleway.elasticmetal.get_partition_schema(offer_id="11111111-1111-1111-1111-111111111111",
+        os_id="22222222-2222-2222-2222-222222222222",
+        swap=True,
+        extra_partition=True,
+        ext4_mountpoint="/data")
+    ```
+
+
+    :param builtins.str ext4_mountpoint: The mount point for the extra partition. Must be an absolute path using alphanumeric characters and underscores.
+    :param builtins.bool extra_partition: Whether to add an extra ext4 data partition.
+    :param builtins.str offer_id: The UUID of the BareMetal offer.
+    :param builtins.str os_id: The UUID of the OS image.
+    :param builtins.bool swap: Whether to include a swap partition.
+    """
+    __args__ = dict()
+    __args__['ext4Mountpoint'] = ext4_mountpoint
+    __args__['extraPartition'] = extra_partition
+    __args__['offerId'] = offer_id
+    __args__['osId'] = os_id
+    __args__['swap'] = swap
+    opts = pulumi.InvokeOutputOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
+    __ret__ = pulumi.runtime.invoke_output('scaleway:elasticmetal/getPartitionSchema:getPartitionSchema', __args__, opts=opts, typ=GetPartitionSchemaResult)
+    return __ret__.apply(lambda __response__: GetPartitionSchemaResult(
+        ext4_mountpoint=pulumi.get(__response__, 'ext4_mountpoint'),
+        extra_partition=pulumi.get(__response__, 'extra_partition'),
+        id=pulumi.get(__response__, 'id'),
+        json_partition=pulumi.get(__response__, 'json_partition'),
+        offer_id=pulumi.get(__response__, 'offer_id'),
+        os_id=pulumi.get(__response__, 'os_id'),
+        swap=pulumi.get(__response__, 'swap')))

pulumiverse_scaleway/elasticmetal/get_server.py

@@ -1,7 +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 builtins
 import copy
 import warnings
 import sys
@@ -118,22 +119,22 @@ class GetServerResult:
 
     @property
     @pulumi.getter
-    def description(self) -> str:
+    def description(self) -> builtins.str:
         return pulumi.get(self, "description")
 
     @property
     @pulumi.getter
-    def domain(self) -> str:
+    def domain(self) -> builtins.str:
         return pulumi.get(self, "domain")
 
     @property
     @pulumi.getter
-    def hostname(self) -> str:
+    def hostname(self) -> builtins.str:
         return pulumi.get(self, "hostname")
 
     @property
     @pulumi.getter
-    def id(self) -> str:
+    def id(self) -> builtins.str:
         """
         The provider-assigned unique ID for this managed resource.
         """
@@ -141,7 +142,7 @@ class GetServerResult:
 
     @property
     @pulumi.getter(name="installConfigAfterward")
-    def install_config_afterward(self) -> bool:
+    def install_config_afterward(self) -> builtins.bool:
         return pulumi.get(self, "install_config_afterward")
 
     @property
@@ -161,22 +162,22 @@ class GetServerResult:
 
     @property
     @pulumi.getter
-    def name(self) -> Optional[str]:
+    def name(self) -> Optional[builtins.str]:
         return pulumi.get(self, "name")
 
     @property
     @pulumi.getter
-    def offer(self) -> str:
+    def offer(self) -> builtins.str:
         return pulumi.get(self, "offer")
 
     @property
     @pulumi.getter(name="offerId")
-    def offer_id(self) -> str:
+    def offer_id(self) -> builtins.str:
         return pulumi.get(self, "offer_id")
 
     @property
     @pulumi.getter(name="offerName")
-    def offer_name(self) -> str:
+    def offer_name(self) -> builtins.str:
         return pulumi.get(self, "offer_name")
 
     @property
@@ -186,27 +187,27 @@ class GetServerResult:
 
     @property
     @pulumi.getter(name="organizationId")
-    def organization_id(self) -> str:
+    def organization_id(self) -> builtins.str:
         return pulumi.get(self, "organization_id")
 
     @property
     @pulumi.getter
-    def os(self) -> str:
+    def os(self) -> builtins.str:
         return pulumi.get(self, "os")
 
     @property
     @pulumi.getter(name="osName")
-    def os_name(self) -> str:
+    def os_name(self) -> builtins.str:
         return pulumi.get(self, "os_name")
 
     @property
     @pulumi.getter
-    def partitioning(self) -> str:
+    def partitioning(self) -> builtins.str:
         return pulumi.get(self, "partitioning")
 
     @property
     @pulumi.getter
-    def password(self) -> str:
+    def password(self) -> builtins.str:
         return pulumi.get(self, "password")
 
     @property
@@ -221,47 +222,47 @@ class GetServerResult:
 
     @property
     @pulumi.getter(name="projectId")
-    def project_id(self) -> Optional[str]:
+    def project_id(self) -> Optional[builtins.str]:
         return pulumi.get(self, "project_id")
 
     @property
     @pulumi.getter(name="reinstallOnConfigChanges")
-    def reinstall_on_config_changes(self) -> bool:
+    def reinstall_on_config_changes(self) -> builtins.bool:
         return pulumi.get(self, "reinstall_on_config_changes")
 
     @property
     @pulumi.getter(name="serverId")
-    def server_id(self) -> Optional[str]:
+    def server_id(self) -> Optional[builtins.str]:
         return pulumi.get(self, "server_id")
 
     @property
     @pulumi.getter(name="servicePassword")
-    def service_password(self) -> str:
+    def service_password(self) -> builtins.str:
         return pulumi.get(self, "service_password")
 
     @property
     @pulumi.getter(name="serviceUser")
-    def service_user(self) -> str:
+    def service_user(self) -> builtins.str:
         return pulumi.get(self, "service_user")
 
     @property
     @pulumi.getter(name="sshKeyIds")
-    def ssh_key_ids(self) -> Sequence[str]:
+    def ssh_key_ids(self) -> Sequence[builtins.str]:
         return pulumi.get(self, "ssh_key_ids")
 
     @property
     @pulumi.getter
-    def tags(self) -> Sequence[str]:
+    def tags(self) -> Sequence[builtins.str]:
         return pulumi.get(self, "tags")
 
     @property
     @pulumi.getter
-    def user(self) -> str:
+    def user(self) -> builtins.str:
         return pulumi.get(self, "user")
 
     @property
     @pulumi.getter
-    def zone(self) -> Optional[str]:
+    def zone(self) -> Optional[builtins.str]:
         return pulumi.get(self, "zone")
 
 
@@ -302,10 +303,10 @@ class AwaitableGetServerResult(GetServerResult):
             zone=self.zone)
 
 
-def get_server(name: Optional[str] = None,
-               project_id: Optional[str] = None,
-               server_id: Optional[str] = None,
-               zone: Optional[str] = None,
+def get_server(name: Optional[builtins.str] = None,
+               project_id: Optional[builtins.str] = None,
+               server_id: Optional[builtins.str] = None,
+               zone: Optional[builtins.str] = None,
                opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetServerResult:
     """
     Gets information about a baremetal server.
@@ -325,9 +326,9 @@ def get_server(name: Optional[str] = None,
     ```
 
 
-    :param str name: The server name. Only one of `name` and `server_id` should be specified.
-    :param str project_id: The ID of the project the baremetal server is associated with.
-    :param str zone: `zone`) The zone in which the server exists.
+    :param builtins.str name: The server name. Only one of `name` and `server_id` should be specified.
+    :param builtins.str project_id: The ID of the project the baremetal server is associated with.
+    :param builtins.str zone: `zone`) The zone in which the server exists.
     """
     __args__ = dict()
     __args__['name'] = name
@@ -367,10 +368,10 @@ def get_server(name: Optional[str] = None,
         tags=pulumi.get(__ret__, 'tags'),
         user=pulumi.get(__ret__, 'user'),
         zone=pulumi.get(__ret__, 'zone'))
-def get_server_output(name: Optional[pulumi.Input[Optional[str]]] = None,
-                      project_id: Optional[pulumi.Input[Optional[str]]] = None,
-                      server_id: Optional[pulumi.Input[Optional[str]]] = None,
-                      zone: Optional[pulumi.Input[Optional[str]]] = None,
+def get_server_output(name: Optional[pulumi.Input[Optional[builtins.str]]] = None,
+                      project_id: Optional[pulumi.Input[Optional[builtins.str]]] = None,
+                      server_id: Optional[pulumi.Input[Optional[builtins.str]]] = None,
+                      zone: Optional[pulumi.Input[Optional[builtins.str]]] = None,
                       opts: Optional[Union[pulumi.InvokeOptions, pulumi.InvokeOutputOptions]] = None) -> pulumi.Output[GetServerResult]:
     """
     Gets information about a baremetal server.
@@ -390,9 +391,9 @@ def get_server_output(name: Optional[pulumi.Input[Optional[str]]] = None,
     ```
 
 
-    :param str name: The server name. Only one of `name` and `server_id` should be specified.
-    :param str project_id: The ID of the project the baremetal server is associated with.
-    :param str zone: `zone`) The zone in which the server exists.
+    :param builtins.str name: The server name. Only one of `name` and `server_id` should be specified.
+    :param builtins.str project_id: The ID of the project the baremetal server is associated with.
+    :param builtins.str zone: `zone`) The zone in which the server exists.
     """
     __args__ = dict()
     __args__['name'] = name