pulumiverse-scaleway 1.24.0a1741680905__py3-none-any.whl → 1.25.0__py3-none-any.whl

pulumiverse_scaleway/object/get_bucket.py

@@ -0,0 +1,290 @@
+# 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 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__ = [
+    'GetBucketResult',
+    'AwaitableGetBucketResult',
+    'get_bucket',
+    'get_bucket_output',
+]
+
+@pulumi.output_type
+class GetBucketResult:
+    """
+    A collection of values returned by getBucket.
+    """
+    def __init__(__self__, acl=None, api_endpoint=None, cors_rules=None, endpoint=None, force_destroy=None, id=None, lifecycle_rules=None, name=None, object_lock_enabled=None, project_id=None, region=None, tags=None, versionings=None):
+        if acl and not isinstance(acl, str):
+            raise TypeError("Expected argument 'acl' to be a str")
+        pulumi.set(__self__, "acl", acl)
+        if api_endpoint and not isinstance(api_endpoint, str):
+            raise TypeError("Expected argument 'api_endpoint' to be a str")
+        pulumi.set(__self__, "api_endpoint", api_endpoint)
+        if cors_rules and not isinstance(cors_rules, list):
+            raise TypeError("Expected argument 'cors_rules' to be a list")
+        pulumi.set(__self__, "cors_rules", cors_rules)
+        if endpoint and not isinstance(endpoint, str):
+            raise TypeError("Expected argument 'endpoint' to be a str")
+        pulumi.set(__self__, "endpoint", endpoint)
+        if force_destroy and not isinstance(force_destroy, bool):
+            raise TypeError("Expected argument 'force_destroy' to be a bool")
+        pulumi.set(__self__, "force_destroy", force_destroy)
+        if id and not isinstance(id, str):
+            raise TypeError("Expected argument 'id' to be a str")
+        pulumi.set(__self__, "id", id)
+        if lifecycle_rules and not isinstance(lifecycle_rules, list):
+            raise TypeError("Expected argument 'lifecycle_rules' to be a list")
+        pulumi.set(__self__, "lifecycle_rules", lifecycle_rules)
+        if name and not isinstance(name, str):
+            raise TypeError("Expected argument 'name' to be a str")
+        pulumi.set(__self__, "name", name)
+        if object_lock_enabled and not isinstance(object_lock_enabled, bool):
+            raise TypeError("Expected argument 'object_lock_enabled' to be a bool")
+        pulumi.set(__self__, "object_lock_enabled", object_lock_enabled)
+        if project_id and not isinstance(project_id, str):
+            raise TypeError("Expected argument 'project_id' to be a str")
+        pulumi.set(__self__, "project_id", project_id)
+        if region and not isinstance(region, str):
+            raise TypeError("Expected argument 'region' to be a str")
+        pulumi.set(__self__, "region", region)
+        if tags and not isinstance(tags, dict):
+            raise TypeError("Expected argument 'tags' to be a dict")
+        pulumi.set(__self__, "tags", tags)
+        if versionings and not isinstance(versionings, list):
+            raise TypeError("Expected argument 'versionings' to be a list")
+        pulumi.set(__self__, "versionings", versionings)
+
+    @property
+    @pulumi.getter
+    def acl(self) -> str:
+        return pulumi.get(self, "acl")
+
+    @property
+    @pulumi.getter(name="apiEndpoint")
+    def api_endpoint(self) -> str:
+        return pulumi.get(self, "api_endpoint")
+
+    @property
+    @pulumi.getter(name="corsRules")
+    def cors_rules(self) -> Sequence['outputs.GetBucketCorsRuleResult']:
+        return pulumi.get(self, "cors_rules")
+
+    @property
+    @pulumi.getter
+    def endpoint(self) -> str:
+        """
+        The endpoint URL of the bucket
+        """
+        return pulumi.get(self, "endpoint")
+
+    @property
+    @pulumi.getter(name="forceDestroy")
+    def force_destroy(self) -> bool:
+        return pulumi.get(self, "force_destroy")
+
+    @property
+    @pulumi.getter
+    def id(self) -> str:
+        """
+        The provider-assigned unique ID for this managed resource.
+        """
+        return pulumi.get(self, "id")
+
+    @property
+    @pulumi.getter(name="lifecycleRules")
+    def lifecycle_rules(self) -> Sequence['outputs.GetBucketLifecycleRuleResult']:
+        return pulumi.get(self, "lifecycle_rules")
+
+    @property
+    @pulumi.getter
+    def name(self) -> Optional[str]:
+        return pulumi.get(self, "name")
+
+    @property
+    @pulumi.getter(name="objectLockEnabled")
+    def object_lock_enabled(self) -> bool:
+        return pulumi.get(self, "object_lock_enabled")
+
+    @property
+    @pulumi.getter(name="projectId")
+    def project_id(self) -> Optional[str]:
+        return pulumi.get(self, "project_id")
+
+    @property
+    @pulumi.getter
+    def region(self) -> Optional[str]:
+        return pulumi.get(self, "region")
+
+    @property
+    @pulumi.getter
+    def tags(self) -> Mapping[str, str]:
+        return pulumi.get(self, "tags")
+
+    @property
+    @pulumi.getter
+    def versionings(self) -> Sequence['outputs.GetBucketVersioningResult']:
+        return pulumi.get(self, "versionings")
+
+
+class AwaitableGetBucketResult(GetBucketResult):
+    # pylint: disable=using-constant-test
+    def __await__(self):
+        if False:
+            yield self
+        return GetBucketResult(
+            acl=self.acl,
+            api_endpoint=self.api_endpoint,
+            cors_rules=self.cors_rules,
+            endpoint=self.endpoint,
+            force_destroy=self.force_destroy,
+            id=self.id,
+            lifecycle_rules=self.lifecycle_rules,
+            name=self.name,
+            object_lock_enabled=self.object_lock_enabled,
+            project_id=self.project_id,
+            region=self.region,
+            tags=self.tags,
+            versionings=self.versionings)
+
+
+def get_bucket(name: Optional[str] = None,
+               project_id: Optional[str] = None,
+               region: Optional[str] = None,
+               opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetBucketResult:
+    """
+    The `object.Bucket` data source is used to retrieve information about an Object Storage bucket.
+
+    Refer to the Object Storage [documentation](https://www.scaleway.com/en/docs/object-storage/how-to/create-a-bucket/) for more information.
+
+    ## Retrieve an Object Storage bucket
+
+    The following commands allow you to:
+
+    - retrieve a bucket by its name
+    - retrieve a bucket by its ID
+
+    ```python
+    import pulumi
+    import pulumi_scaleway as scaleway
+    import pulumiverse_scaleway as scaleway
+
+    main = scaleway.object.Bucket("main",
+        name="bucket.test.com",
+        tags={
+            "foo": "bar",
+        })
+    selected = scaleway.object.get_bucket_output(name=main.id)
+    ```
+
+    ## Retrieve a bucket from a specific project
+
+    ```python
+    import pulumi
+    import pulumi_scaleway as scaleway
+
+    selected = scaleway.object.get_bucket(name="bucket.test.com",
+        project_id="11111111-1111-1111-1111-111111111111")
+    ```
+
+
+    :param str project_id: `project_id`) The ID of the project with which the bucket is associated.
+    :param str region: `region`) The region in which the bucket exists.
+    """
+    __args__ = dict()
+    __args__['name'] = name
+    __args__['projectId'] = project_id
+    __args__['region'] = region
+    opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
+    __ret__ = pulumi.runtime.invoke('scaleway:object/getBucket:getBucket', __args__, opts=opts, typ=GetBucketResult).value
+
+    return AwaitableGetBucketResult(
+        acl=pulumi.get(__ret__, 'acl'),
+        api_endpoint=pulumi.get(__ret__, 'api_endpoint'),
+        cors_rules=pulumi.get(__ret__, 'cors_rules'),
+        endpoint=pulumi.get(__ret__, 'endpoint'),
+        force_destroy=pulumi.get(__ret__, 'force_destroy'),
+        id=pulumi.get(__ret__, 'id'),
+        lifecycle_rules=pulumi.get(__ret__, 'lifecycle_rules'),
+        name=pulumi.get(__ret__, 'name'),
+        object_lock_enabled=pulumi.get(__ret__, 'object_lock_enabled'),
+        project_id=pulumi.get(__ret__, 'project_id'),
+        region=pulumi.get(__ret__, 'region'),
+        tags=pulumi.get(__ret__, 'tags'),
+        versionings=pulumi.get(__ret__, 'versionings'))
+def get_bucket_output(name: Optional[pulumi.Input[Optional[str]]] = None,
+                      project_id: Optional[pulumi.Input[Optional[str]]] = None,
+                      region: Optional[pulumi.Input[Optional[str]]] = None,
+                      opts: Optional[Union[pulumi.InvokeOptions, pulumi.InvokeOutputOptions]] = None) -> pulumi.Output[GetBucketResult]:
+    """
+    The `object.Bucket` data source is used to retrieve information about an Object Storage bucket.
+
+    Refer to the Object Storage [documentation](https://www.scaleway.com/en/docs/object-storage/how-to/create-a-bucket/) for more information.
+
+    ## Retrieve an Object Storage bucket
+
+    The following commands allow you to:
+
+    - retrieve a bucket by its name
+    - retrieve a bucket by its ID
+
+    ```python
+    import pulumi
+    import pulumi_scaleway as scaleway
+    import pulumiverse_scaleway as scaleway
+
+    main = scaleway.object.Bucket("main",
+        name="bucket.test.com",
+        tags={
+            "foo": "bar",
+        })
+    selected = scaleway.object.get_bucket_output(name=main.id)
+    ```
+
+    ## Retrieve a bucket from a specific project
+
+    ```python
+    import pulumi
+    import pulumi_scaleway as scaleway
+
+    selected = scaleway.object.get_bucket(name="bucket.test.com",
+        project_id="11111111-1111-1111-1111-111111111111")
+    ```
+
+
+    :param str project_id: `project_id`) The ID of the project with which the bucket is associated.
+    :param str region: `region`) The region in which the bucket exists.
+    """
+    __args__ = dict()
+    __args__['name'] = name
+    __args__['projectId'] = project_id
+    __args__['region'] = region
+    opts = pulumi.InvokeOutputOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
+    __ret__ = pulumi.runtime.invoke_output('scaleway:object/getBucket:getBucket', __args__, opts=opts, typ=GetBucketResult)
+    return __ret__.apply(lambda __response__: GetBucketResult(
+        acl=pulumi.get(__response__, 'acl'),
+        api_endpoint=pulumi.get(__response__, 'api_endpoint'),
+        cors_rules=pulumi.get(__response__, 'cors_rules'),
+        endpoint=pulumi.get(__response__, 'endpoint'),
+        force_destroy=pulumi.get(__response__, 'force_destroy'),
+        id=pulumi.get(__response__, 'id'),
+        lifecycle_rules=pulumi.get(__response__, 'lifecycle_rules'),
+        name=pulumi.get(__response__, 'name'),
+        object_lock_enabled=pulumi.get(__response__, 'object_lock_enabled'),
+        project_id=pulumi.get(__response__, 'project_id'),
+        region=pulumi.get(__response__, 'region'),
+        tags=pulumi.get(__response__, 'tags'),
+        versionings=pulumi.get(__response__, 'versionings')))

pulumiverse_scaleway/object/get_bucket_policy.py

@@ -0,0 +1,163 @@
+# 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 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__ = [
+    'GetBucketPolicyResult',
+    'AwaitableGetBucketPolicyResult',
+    'get_bucket_policy',
+    'get_bucket_policy_output',
+]
+
+@pulumi.output_type
+class GetBucketPolicyResult:
+    """
+    A collection of values returned by getBucketPolicy.
+    """
+    def __init__(__self__, bucket=None, id=None, policy=None, project_id=None, region=None):
+        if bucket and not isinstance(bucket, str):
+            raise TypeError("Expected argument 'bucket' to be a str")
+        pulumi.set(__self__, "bucket", bucket)
+        if id and not isinstance(id, str):
+            raise TypeError("Expected argument 'id' to be a str")
+        pulumi.set(__self__, "id", id)
+        if policy and not isinstance(policy, str):
+            raise TypeError("Expected argument 'policy' to be a str")
+        pulumi.set(__self__, "policy", policy)
+        if project_id and not isinstance(project_id, str):
+            raise TypeError("Expected argument 'project_id' to be a str")
+        pulumi.set(__self__, "project_id", project_id)
+        if region and not isinstance(region, str):
+            raise TypeError("Expected argument 'region' to be a str")
+        pulumi.set(__self__, "region", region)
+
+    @property
+    @pulumi.getter
+    def bucket(self) -> str:
+        return pulumi.get(self, "bucket")
+
+    @property
+    @pulumi.getter
+    def id(self) -> str:
+        """
+        The provider-assigned unique ID for this managed resource.
+        """
+        return pulumi.get(self, "id")
+
+    @property
+    @pulumi.getter
+    def policy(self) -> str:
+        """
+        The content of the bucket policy in JSON format.
+        """
+        return pulumi.get(self, "policy")
+
+    @property
+    @pulumi.getter(name="projectId")
+    def project_id(self) -> Optional[str]:
+        return pulumi.get(self, "project_id")
+
+    @property
+    @pulumi.getter
+    def region(self) -> Optional[str]:
+        return pulumi.get(self, "region")
+
+
+class AwaitableGetBucketPolicyResult(GetBucketPolicyResult):
+    # pylint: disable=using-constant-test
+    def __await__(self):
+        if False:
+            yield self
+        return GetBucketPolicyResult(
+            bucket=self.bucket,
+            id=self.id,
+            policy=self.policy,
+            project_id=self.project_id,
+            region=self.region)
+
+
+def get_bucket_policy(bucket: Optional[str] = None,
+                      project_id: Optional[str] = None,
+                      region: Optional[str] = None,
+                      opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetBucketPolicyResult:
+    """
+    The `object.BucketPolicy` data source is used to retrieve information about the bucket policy of an Object Storage bucket.
+
+    Refer to the Object Storage [documentation](https://www.scaleway.com/en/docs/object-storage/api-cli/bucket-policy/) for more information.
+
+    ## Retrieve the bucket policy of a bucket
+
+    The following command allows you to retrieve a bucket policy by its bucket.
+
+    ```python
+    import pulumi
+    import pulumi_scaleway as scaleway
+
+    main = scaleway.object.get_bucket_policy(bucket="bucket.test.com")
+    ```
+
+
+    :param str bucket: The name of the bucket.
+    :param str region: `region`) The region in which the Object Storage exists.
+    """
+    __args__ = dict()
+    __args__['bucket'] = bucket
+    __args__['projectId'] = project_id
+    __args__['region'] = region
+    opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
+    __ret__ = pulumi.runtime.invoke('scaleway:object/getBucketPolicy:getBucketPolicy', __args__, opts=opts, typ=GetBucketPolicyResult).value
+
+    return AwaitableGetBucketPolicyResult(
+        bucket=pulumi.get(__ret__, 'bucket'),
+        id=pulumi.get(__ret__, 'id'),
+        policy=pulumi.get(__ret__, 'policy'),
+        project_id=pulumi.get(__ret__, 'project_id'),
+        region=pulumi.get(__ret__, 'region'))
+def get_bucket_policy_output(bucket: Optional[pulumi.Input[str]] = None,
+                             project_id: Optional[pulumi.Input[Optional[str]]] = None,
+                             region: Optional[pulumi.Input[Optional[str]]] = None,
+                             opts: Optional[Union[pulumi.InvokeOptions, pulumi.InvokeOutputOptions]] = None) -> pulumi.Output[GetBucketPolicyResult]:
+    """
+    The `object.BucketPolicy` data source is used to retrieve information about the bucket policy of an Object Storage bucket.
+
+    Refer to the Object Storage [documentation](https://www.scaleway.com/en/docs/object-storage/api-cli/bucket-policy/) for more information.
+
+    ## Retrieve the bucket policy of a bucket
+
+    The following command allows you to retrieve a bucket policy by its bucket.
+
+    ```python
+    import pulumi
+    import pulumi_scaleway as scaleway
+
+    main = scaleway.object.get_bucket_policy(bucket="bucket.test.com")
+    ```
+
+
+    :param str bucket: The name of the bucket.
+    :param str region: `region`) The region in which the Object Storage exists.
+    """
+    __args__ = dict()
+    __args__['bucket'] = bucket
+    __args__['projectId'] = project_id
+    __args__['region'] = region
+    opts = pulumi.InvokeOutputOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
+    __ret__ = pulumi.runtime.invoke_output('scaleway:object/getBucketPolicy:getBucketPolicy', __args__, opts=opts, typ=GetBucketPolicyResult)
+    return __ret__.apply(lambda __response__: GetBucketPolicyResult(
+        bucket=pulumi.get(__response__, 'bucket'),
+        id=pulumi.get(__response__, 'id'),
+        policy=pulumi.get(__response__, 'policy'),
+        project_id=pulumi.get(__response__, 'project_id'),
+        region=pulumi.get(__response__, 'region')))