@pulumiverse/scaleway
Version:
A Pulumi package for creating and managing Scaleway cloud resources.
141 lines (140 loc) • 4.42 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "./types/output";
/**
* The `scaleway.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
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@pulumi/scaleway";
* import * as scaleway from "@pulumiverse/scaleway";
*
* const main = new scaleway.object.Bucket("main", {
* name: "bucket.test.com",
* tags: {
* foo: "bar",
* },
* });
* const selected = scaleway.object.getBucketOutput({
* name: main.id,
* });
* ```
*
* ## Retrieve a bucket from a specific project
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@pulumi/scaleway";
*
* const selected = scaleway.object.getBucket({
* name: "bucket.test.com",
* projectId: "11111111-1111-1111-1111-111111111111",
* });
* ```
*/
/** @deprecated scaleway.index/getobjectbucket.getObjectBucket has been deprecated in favor of scaleway.object/getbucket.getBucket */
export declare function getObjectBucket(args?: GetObjectBucketArgs, opts?: pulumi.InvokeOptions): Promise<GetObjectBucketResult>;
/**
* A collection of arguments for invoking getObjectBucket.
*/
export interface GetObjectBucketArgs {
name?: string;
/**
* `projectId`) The ID of the project with which the bucket is associated.
*/
projectId?: string;
/**
* `region`) The region in which the bucket exists.
*/
region?: string;
}
/**
* A collection of values returned by getObjectBucket.
*/
export interface GetObjectBucketResult {
readonly acl: string;
readonly apiEndpoint: string;
readonly corsRules: outputs.GetObjectBucketCorsRule[];
/**
* The endpoint URL of the bucket
*/
readonly endpoint: string;
readonly forceDestroy: boolean;
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
readonly lifecycleRules: outputs.GetObjectBucketLifecycleRule[];
readonly name?: string;
readonly objectLockEnabled: boolean;
readonly projectId?: string;
readonly region?: string;
readonly tags: {
[key: string]: string;
};
readonly versionings: outputs.GetObjectBucketVersioning[];
}
/**
* The `scaleway.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
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@pulumi/scaleway";
* import * as scaleway from "@pulumiverse/scaleway";
*
* const main = new scaleway.object.Bucket("main", {
* name: "bucket.test.com",
* tags: {
* foo: "bar",
* },
* });
* const selected = scaleway.object.getBucketOutput({
* name: main.id,
* });
* ```
*
* ## Retrieve a bucket from a specific project
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@pulumi/scaleway";
*
* const selected = scaleway.object.getBucket({
* name: "bucket.test.com",
* projectId: "11111111-1111-1111-1111-111111111111",
* });
* ```
*/
/** @deprecated scaleway.index/getobjectbucket.getObjectBucket has been deprecated in favor of scaleway.object/getbucket.getBucket */
export declare function getObjectBucketOutput(args?: GetObjectBucketOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetObjectBucketResult>;
/**
* A collection of arguments for invoking getObjectBucket.
*/
export interface GetObjectBucketOutputArgs {
name?: pulumi.Input<string>;
/**
* `projectId`) The ID of the project with which the bucket is associated.
*/
projectId?: pulumi.Input<string>;
/**
* `region`) The region in which the bucket exists.
*/
region?: pulumi.Input<string>;
}