import * as pulumi from "@pulumi/pulumi"; import * as inputs from "./types/input"; import * as outputs from "./types/output"; /** * Provides a Linode Object Storage Bucket resource. This can be used to create, modify, and delete Linodes Object Storage Buckets. * For more information, see the [Linode APIv4 docs](https://techdocs.akamai.com/linode-api/reference/post-object-storage-bucket). * * ## Example Usage * * The following example shows how one might use this resource to create an Object Storage Bucket: * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as linode from "@pulumi/linode"; * * const foobar = new linode.ObjectStorageBucket("foobar", { * region: "us-mia", * label: "mybucket", * }); * ``` * * Creating an Object Storage Bucket with Lifecycle rules: * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as linode from "@pulumi/linode"; * * const mykey = new linode.ObjectStorageKey("mykey", {label: "image-access"}); * const mybucket = new linode.ObjectStorageBucket("mybucket", { * accessKey: mykey.accessKey, * secretKey: mykey.secretKey, * region: "us-mia", * label: "mybucket", * lifecycleRules: [{ * id: "my-rule", * enabled: true, * abortIncompleteMultipartUploadDays: 5, * expiration: { * date: "2021-06-21", * }, * }], * }); * ``` * * Creating an Object Storage Bucket with Lifecycle rules using provider-level object credentials * * ## Import * * Linodes Object Storage Buckets can be imported using the resource `id` which is made of `cluster:label`, e.g. * * ```sh * $ pulumi import linode:index/objectStorageBucket:ObjectStorageBucket mybucket us-east-1:foobar * ``` */ export declare class ObjectStorageBucket extends pulumi.CustomResource { /** * Get an existing ObjectStorageBucket 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, state?: ObjectStorageBucketState, opts?: pulumi.CustomResourceOptions): ObjectStorageBucket; /** * Returns true if the given object is an instance of ObjectStorageBucket. 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 ObjectStorageBucket; /** * The access key to authenticate with. If not specified with the resource, its value can be * * configured by `objAccessKey` in the provider configuration; * * or, generated implicitly at apply-time if `objUseTempKeys` at provider-level is set. */ readonly accessKey: pulumi.Output; /** * The Access Control Level of the bucket using a canned ACL string. See all ACL strings [in the Linode API v4 documentation](https://techdocs.akamai.com/linode-api/reference/post-object-storage-bucket). */ readonly acl: pulumi.Output; /** * The cert used by this Object Storage Bucket. */ readonly cert: pulumi.Output; /** * The cluster of the Linode Object Storage Bucket. This is deprecated in favor of `region` attribute. * For example, `us-mia-1` cluster can be translated into `us-mia` region. Exactly one of `region` and `cluster` is required for creating a bucket. * * @deprecated The cluster attribute has been deprecated, please consider switching to the region attribute. For example, a cluster value of `us-mia-1` can be translated to a region value of `us-mia`. */ readonly cluster: pulumi.Output; /** * If true, the bucket will have CORS enabled for all origins. */ readonly corsEnabled: pulumi.Output; /** * The endpoint for the bucket used for s3 connections. * * @deprecated Use `s3Endpoint` instead */ readonly endpoint: pulumi.Output; /** * The type of `s3Endpoint` available to the user in this region. See [Endpoint types](https://techdocs.akamai.com/cloud-computing/docs/object-storage#endpoint-type) for more information. */ readonly endpointType: pulumi.Output; /** * The hostname where this bucket can be accessed. This hostname can be accessed through a browser if the bucket is made * public. */ readonly hostname: pulumi.Output; /** * The label of the Linode Object Storage Bucket. */ readonly label: pulumi.Output; /** * Lifecycle rules to be applied to the bucket. */ readonly lifecycleRules: pulumi.Output; /** * The region of the Linode Object Storage Bucket. Exactly one of `region` and `cluster` is required for creating a bucket. */ readonly region: pulumi.Output; /** * The user's s3 endpoint URL, based on the `endpointType` and `region`. */ readonly s3Endpoint: pulumi.Output; /** * The secret key to authenticate with. If not specified with the resource, its value can be * * configured by `objSecretKey` in the provider configuration; * * or, generated implicitly at apply-time if `objUseTempKeys` at provider-level is set. */ readonly secretKey: pulumi.Output; /** * Whether to enable versioning. Once you version-enable a bucket, it can never return to an unversioned state. You can, however, suspend versioning on that bucket. (Requires `accessKey` and `secretKey`) * * * `lifecycleRule` - (Optional) Lifecycle rules to be applied to the bucket. (Requires `accessKey` and `secretKey`) * * * `cert` - (Optional) The bucket's TLS/SSL certificate. */ readonly versioning: pulumi.Output; /** * Create a ObjectStorageBucket 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: ObjectStorageBucketArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering ObjectStorageBucket resources. */ export interface ObjectStorageBucketState { /** * The access key to authenticate with. If not specified with the resource, its value can be * * configured by `objAccessKey` in the provider configuration; * * or, generated implicitly at apply-time if `objUseTempKeys` at provider-level is set. */ accessKey?: pulumi.Input; /** * The Access Control Level of the bucket using a canned ACL string. See all ACL strings [in the Linode API v4 documentation](https://techdocs.akamai.com/linode-api/reference/post-object-storage-bucket). */ acl?: pulumi.Input; /** * The cert used by this Object Storage Bucket. */ cert?: pulumi.Input; /** * The cluster of the Linode Object Storage Bucket. This is deprecated in favor of `region` attribute. * For example, `us-mia-1` cluster can be translated into `us-mia` region. Exactly one of `region` and `cluster` is required for creating a bucket. * * @deprecated The cluster attribute has been deprecated, please consider switching to the region attribute. For example, a cluster value of `us-mia-1` can be translated to a region value of `us-mia`. */ cluster?: pulumi.Input; /** * If true, the bucket will have CORS enabled for all origins. */ corsEnabled?: pulumi.Input; /** * The endpoint for the bucket used for s3 connections. * * @deprecated Use `s3Endpoint` instead */ endpoint?: pulumi.Input; /** * The type of `s3Endpoint` available to the user in this region. See [Endpoint types](https://techdocs.akamai.com/cloud-computing/docs/object-storage#endpoint-type) for more information. */ endpointType?: pulumi.Input; /** * The hostname where this bucket can be accessed. This hostname can be accessed through a browser if the bucket is made * public. */ hostname?: pulumi.Input; /** * The label of the Linode Object Storage Bucket. */ label?: pulumi.Input; /** * Lifecycle rules to be applied to the bucket. */ lifecycleRules?: pulumi.Input[]>; /** * The region of the Linode Object Storage Bucket. Exactly one of `region` and `cluster` is required for creating a bucket. */ region?: pulumi.Input; /** * The user's s3 endpoint URL, based on the `endpointType` and `region`. */ s3Endpoint?: pulumi.Input; /** * The secret key to authenticate with. If not specified with the resource, its value can be * * configured by `objSecretKey` in the provider configuration; * * or, generated implicitly at apply-time if `objUseTempKeys` at provider-level is set. */ secretKey?: pulumi.Input; /** * Whether to enable versioning. Once you version-enable a bucket, it can never return to an unversioned state. You can, however, suspend versioning on that bucket. (Requires `accessKey` and `secretKey`) * * * `lifecycleRule` - (Optional) Lifecycle rules to be applied to the bucket. (Requires `accessKey` and `secretKey`) * * * `cert` - (Optional) The bucket's TLS/SSL certificate. */ versioning?: pulumi.Input; } /** * The set of arguments for constructing a ObjectStorageBucket resource. */ export interface ObjectStorageBucketArgs { /** * The access key to authenticate with. If not specified with the resource, its value can be * * configured by `objAccessKey` in the provider configuration; * * or, generated implicitly at apply-time if `objUseTempKeys` at provider-level is set. */ accessKey?: pulumi.Input; /** * The Access Control Level of the bucket using a canned ACL string. See all ACL strings [in the Linode API v4 documentation](https://techdocs.akamai.com/linode-api/reference/post-object-storage-bucket). */ acl?: pulumi.Input; /** * The cert used by this Object Storage Bucket. */ cert?: pulumi.Input; /** * The cluster of the Linode Object Storage Bucket. This is deprecated in favor of `region` attribute. * For example, `us-mia-1` cluster can be translated into `us-mia` region. Exactly one of `region` and `cluster` is required for creating a bucket. * * @deprecated The cluster attribute has been deprecated, please consider switching to the region attribute. For example, a cluster value of `us-mia-1` can be translated to a region value of `us-mia`. */ cluster?: pulumi.Input; /** * If true, the bucket will have CORS enabled for all origins. */ corsEnabled?: pulumi.Input; /** * The type of `s3Endpoint` available to the user in this region. See [Endpoint types](https://techdocs.akamai.com/cloud-computing/docs/object-storage#endpoint-type) for more information. */ endpointType?: pulumi.Input; /** * The label of the Linode Object Storage Bucket. */ label: pulumi.Input; /** * Lifecycle rules to be applied to the bucket. */ lifecycleRules?: pulumi.Input[]>; /** * The region of the Linode Object Storage Bucket. Exactly one of `region` and `cluster` is required for creating a bucket. */ region?: pulumi.Input; /** * The user's s3 endpoint URL, based on the `endpointType` and `region`. */ s3Endpoint?: pulumi.Input; /** * The secret key to authenticate with. If not specified with the resource, its value can be * * configured by `objSecretKey` in the provider configuration; * * or, generated implicitly at apply-time if `objUseTempKeys` at provider-level is set. */ secretKey?: pulumi.Input; /** * Whether to enable versioning. Once you version-enable a bucket, it can never return to an unversioned state. You can, however, suspend versioning on that bucket. (Requires `accessKey` and `secretKey`) * * * `lifecycleRule` - (Optional) Lifecycle rules to be applied to the bucket. (Requires `accessKey` and `secretKey`) * * * `cert` - (Optional) The bucket's TLS/SSL certificate. */ versioning?: pulumi.Input; }