@pulumiverse/scaleway/object/get.d.ts

A Pulumi package for creating and managing Scaleway cloud resources.

import * as pulumi from "@pulumi/pulumi";
/**
 * The `scaleway.object.Item` data source is used to retrieve information about an Object Storage object.
 *
 * 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 object
 *
 * The following example demonstrates how to retrieve metadata about an object stored in a bucket:
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as scaleway from "@pulumiverse/scaleway";
 *
 * const main = new scaleway.object.Bucket("main", {name: "bucket.test.com"});
 * const example = new scaleway.object.Item("example", {
 *     bucket: main.name,
 *     key: "example.txt",
 *     content: "Hello world!",
 * });
 * const selected = scaleway.object.getOutput({
 *     bucket: example.bucket,
 *     key: example.key,
 * });
 * ```
 */
export declare function get(args: GetArgs, opts?: pulumi.InvokeOptions): Promise<GetResult>;
/**
 * A collection of arguments for invoking get.
 */
export interface GetArgs {
    /**
     * The name of the bucket, or its terraform ID (`{region}/{name}`)
     */
    bucket: string;
    /**
     * The key (path or filename) of the object within the bucket.
     */
    key: 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 get.
 */
export interface GetResult {
    readonly bucket: string;
    readonly content: string;
    readonly contentBase64: string;
    readonly contentType: string;
    readonly file: string;
    readonly hash: string;
    /**
     * The provider-assigned unique ID for this managed resource.
     */
    readonly id: string;
    readonly key: string;
    readonly metadata: {
        [key: string]: string;
    };
    readonly projectId?: string;
    readonly region?: string;
    readonly sseCustomerKey: string;
    readonly storageClass: string;
    readonly tags: {
        [key: string]: string;
    };
    readonly visibility: string;
}
/**
 * The `scaleway.object.Item` data source is used to retrieve information about an Object Storage object.
 *
 * 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 object
 *
 * The following example demonstrates how to retrieve metadata about an object stored in a bucket:
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as scaleway from "@pulumiverse/scaleway";
 *
 * const main = new scaleway.object.Bucket("main", {name: "bucket.test.com"});
 * const example = new scaleway.object.Item("example", {
 *     bucket: main.name,
 *     key: "example.txt",
 *     content: "Hello world!",
 * });
 * const selected = scaleway.object.getOutput({
 *     bucket: example.bucket,
 *     key: example.key,
 * });
 * ```
 */
export declare function getOutput(args: GetOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetResult>;
/**
 * A collection of arguments for invoking get.
 */
export interface GetOutputArgs {
    /**
     * The name of the bucket, or its terraform ID (`{region}/{name}`)
     */
    bucket: pulumi.Input<string>;
    /**
     * The key (path or filename) of the object within the bucket.
     */
    key: pulumi.Input<string>;
    /**
     * `projectId`) The ID of the project with which the bucket is associated.
     */
    projectId?: pulumi.Input<string | undefined>;
    /**
     * `region`) The region in which the bucket exists.
     */
    region?: pulumi.Input<string | undefined>;
}
//# sourceMappingURL=get.d.ts.map