@lbrlabs/pulumi-scaleway
Version:
A Pulumi package for creating and managing scaleway cloud resources.
205 lines (204 loc) • 7.11 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Creates and manages Scaleway object storage objects.
* For more information, see [the documentation](https://www.scaleway.com/en/docs/object-storage-feature/).
*
* ## Import
*
* Objects can be imported using the `{region}/{bucketName}/{objectKey}` identifier, e.g. bash
*
* ```sh
* $ pulumi import scaleway:index/objectItem:ObjectItem some_object fr-par/some-bucket/some-file
* ```
*/
export declare class ObjectItem extends pulumi.CustomResource {
/**
* Get an existing ObjectItem resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ObjectItemState, opts?: pulumi.CustomResourceOptions): ObjectItem;
/**
* Returns true if the given object is an instance of ObjectItem. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is ObjectItem;
/**
* The name of the bucket.
*/
readonly bucket: pulumi.Output<string>;
/**
* The content of the file to upload. Only one of `file`, `content` or `contentBase64` can be defined.
*/
readonly content: pulumi.Output<string | undefined>;
/**
* The base64-encoded content of the file to upload. Only one of `file`, `content` or `contentBase64` can be defined.
*/
readonly contentBase64: pulumi.Output<string | undefined>;
/**
* The name of the file to upload, defaults to an empty file. Only one of `file`, `content` or `contentBase64` can be defined.
*/
readonly file: pulumi.Output<string | undefined>;
/**
* Hash of the file, used to trigger upload on file change
*/
readonly hash: pulumi.Output<string | undefined>;
/**
* The path of the object.
*/
readonly key: pulumi.Output<string>;
/**
* Map of metadata used for the object, keys must be lowercase
*/
readonly metadata: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* `projectId`) The ID of the project the bucket is associated with.
*/
readonly projectId: pulumi.Output<string>;
/**
* The Scaleway region this bucket resides in.
*/
readonly region: pulumi.Output<string>;
/**
* Specifies the Scaleway [storage class](https://www.scaleway.com/en/docs/storage/object/concepts/#storage-class) `STANDARD`, `GLACIER`, `ONEZONE_IA` used to store the object.
*/
readonly storageClass: pulumi.Output<string | undefined>;
/**
* Map of tags
*/
readonly tags: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* Visibility of the object, `public-read` or `private`
*/
readonly visibility: pulumi.Output<string>;
/**
* Create a ObjectItem resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: ObjectItemArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering ObjectItem resources.
*/
export interface ObjectItemState {
/**
* The name of the bucket.
*/
bucket?: pulumi.Input<string>;
/**
* The content of the file to upload. Only one of `file`, `content` or `contentBase64` can be defined.
*/
content?: pulumi.Input<string>;
/**
* The base64-encoded content of the file to upload. Only one of `file`, `content` or `contentBase64` can be defined.
*/
contentBase64?: pulumi.Input<string>;
/**
* The name of the file to upload, defaults to an empty file. Only one of `file`, `content` or `contentBase64` can be defined.
*/
file?: pulumi.Input<string>;
/**
* Hash of the file, used to trigger upload on file change
*/
hash?: pulumi.Input<string>;
/**
* The path of the object.
*/
key?: pulumi.Input<string>;
/**
* Map of metadata used for the object, keys must be lowercase
*/
metadata?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* `projectId`) The ID of the project the bucket is associated with.
*/
projectId?: pulumi.Input<string>;
/**
* The Scaleway region this bucket resides in.
*/
region?: pulumi.Input<string>;
/**
* Specifies the Scaleway [storage class](https://www.scaleway.com/en/docs/storage/object/concepts/#storage-class) `STANDARD`, `GLACIER`, `ONEZONE_IA` used to store the object.
*/
storageClass?: pulumi.Input<string>;
/**
* Map of tags
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* Visibility of the object, `public-read` or `private`
*/
visibility?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a ObjectItem resource.
*/
export interface ObjectItemArgs {
/**
* The name of the bucket.
*/
bucket: pulumi.Input<string>;
/**
* The content of the file to upload. Only one of `file`, `content` or `contentBase64` can be defined.
*/
content?: pulumi.Input<string>;
/**
* The base64-encoded content of the file to upload. Only one of `file`, `content` or `contentBase64` can be defined.
*/
contentBase64?: pulumi.Input<string>;
/**
* The name of the file to upload, defaults to an empty file. Only one of `file`, `content` or `contentBase64` can be defined.
*/
file?: pulumi.Input<string>;
/**
* Hash of the file, used to trigger upload on file change
*/
hash?: pulumi.Input<string>;
/**
* The path of the object.
*/
key: pulumi.Input<string>;
/**
* Map of metadata used for the object, keys must be lowercase
*/
metadata?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* `projectId`) The ID of the project the bucket is associated with.
*/
projectId?: pulumi.Input<string>;
/**
* The Scaleway region this bucket resides in.
*/
region?: pulumi.Input<string>;
/**
* Specifies the Scaleway [storage class](https://www.scaleway.com/en/docs/storage/object/concepts/#storage-class) `STANDARD`, `GLACIER`, `ONEZONE_IA` used to store the object.
*/
storageClass?: pulumi.Input<string>;
/**
* Map of tags
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* Visibility of the object, `public-read` or `private`
*/
visibility?: pulumi.Input<string>;
}