@cdktf/provider-upcloud/lib/object-storage/index.d.ts

Prebuilt upcloud Provider for Terraform CDK (cdktf)

/**
 * Copyright (c) HashiCorp, Inc.
 * SPDX-License-Identifier: MPL-2.0
 */
import { Construct } from 'constructs';
import * as cdktf from 'cdktf';
export interface ObjectStorageConfig extends cdktf.TerraformMetaArguments {
    /**
    * The access key used to identify user.
    * 				Can be set to an empty string, which will tell the provider to get the access key from environment variable.
    * 				The environment variable should be "UPCLOUD_OBJECT_STORAGE_ACCESS_KEY_{name}".
    * 				{name} is the name given to object storage instance (so not the resource label), it should be all uppercased
    * 				and all dashes (-) should be replaced with underscores (_). For example, object storage named "my-files" would
    * 				use environment variable named "UPCLOUD_OBJECT_STORAGE_ACCESS_KEY_MY_FILES".
    *
    * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.23.3/docs/resources/object_storage#access_key ObjectStorage#access_key}
    */
    readonly accessKey: string;
    /**
    * The description of the object storage instance to be created
    *
    * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.23.3/docs/resources/object_storage#description ObjectStorage#description}
    */
    readonly description?: string;
    /**
    * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.23.3/docs/resources/object_storage#id ObjectStorage#id}
    *
    * Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2.
    * If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.
    */
    readonly id?: string;
    /**
    * The name of the object storage instance to be created
    *
    * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.23.3/docs/resources/object_storage#name ObjectStorage#name}
    */
    readonly name: string;
    /**
    * The secret key used to authenticate user.
    * 				Can be set to an empty string, which will tell the provider to get the secret key from environment variable.
    * 				The environment variable should be "UPCLOUD_OBJECT_STORAGE_SECRET_KEY_{name}".
    * 				{name} is the name given to object storage instance (so not the resource label), it should be all uppercased
    * 				and all dashes (-) should be replaced with underscores (_). For example, object storage named "my-files" would
    * 				use environment variable named "UPCLOUD_OBJECT_STORAGE_SECRET_KEY_MY_FILES".
    *
    * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.23.3/docs/resources/object_storage#secret_key ObjectStorage#secret_key}
    */
    readonly secretKey: string;
    /**
    * The size of the object storage instance in gigabytes
    *
    * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.23.3/docs/resources/object_storage#size ObjectStorage#size}
    */
    readonly size: number;
    /**
    * The zone in which the object storage instance will be created, e.g. `de-fra1`. You can list available zones with `upctl zone list`.
    *
    * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.23.3/docs/resources/object_storage#zone ObjectStorage#zone}
    */
    readonly zone: string;
    /**
    * bucket block
    *
    * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.23.3/docs/resources/object_storage#bucket ObjectStorage#bucket}
    */
    readonly bucket?: ObjectStorageBucket[] | cdktf.IResolvable;
}
export interface ObjectStorageBucket {
    /**
    * The name of the bucket
    *
    * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.23.3/docs/resources/object_storage#name ObjectStorage#name}
    */
    readonly name: string;
}
export declare function objectStorageBucketToTerraform(struct?: ObjectStorageBucket | cdktf.IResolvable): any;
export declare function objectStorageBucketToHclTerraform(struct?: ObjectStorageBucket | cdktf.IResolvable): any;
export declare class ObjectStorageBucketOutputReference extends cdktf.ComplexObject {
    private isEmptyObject;
    private resolvableValue?;
    /**
    * @param terraformResource The parent resource
    * @param terraformAttribute The attribute on the parent resource this class is referencing
    * @param complexObjectIndex the index of this item in the list
    * @param complexObjectIsFromSet whether the list is wrapping a set (will add tolist() to be able to access an item via an index)
    */
    constructor(terraformResource: cdktf.IInterpolatingParent, terraformAttribute: string, complexObjectIndex: number, complexObjectIsFromSet: boolean);
    get internalValue(): ObjectStorageBucket | cdktf.IResolvable | undefined;
    set internalValue(value: ObjectStorageBucket | cdktf.IResolvable | undefined);
    private _name?;
    get name(): string;
    set name(value: string);
    get nameInput(): string | undefined;
}
export declare class ObjectStorageBucketList extends cdktf.ComplexList {
    protected terraformResource: cdktf.IInterpolatingParent;
    protected terraformAttribute: string;
    protected wrapsSet: boolean;
    internalValue?: ObjectStorageBucket[] | cdktf.IResolvable;
    /**
    * @param terraformResource The parent resource
    * @param terraformAttribute The attribute on the parent resource this class is referencing
    * @param wrapsSet whether the list is wrapping a set (will add tolist() to be able to access an item via an index)
    */
    constructor(terraformResource: cdktf.IInterpolatingParent, terraformAttribute: string, wrapsSet: boolean);
    /**
    * @param index the index of the item to return
    */
    get(index: number): ObjectStorageBucketOutputReference;
}
/**
* Represents a {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.23.3/docs/resources/object_storage upcloud_object_storage}
*/
export declare class ObjectStorage extends cdktf.TerraformResource {
    static readonly tfResourceType = "upcloud_object_storage";
    /**
    * Generates CDKTF code for importing a ObjectStorage resource upon running "cdktf plan <stack-name>"
    * @param scope The scope in which to define this construct
    * @param importToId The construct id used in the generated config for the ObjectStorage to import
    * @param importFromId The id of the existing ObjectStorage that should be imported. Refer to the {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.23.3/docs/resources/object_storage#import import section} in the documentation of this resource for the id to use
    * @param provider? Optional instance of the provider where the ObjectStorage to import is found
    */
    static generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: cdktf.TerraformProvider): cdktf.ImportableResource;
    /**
    * Create a new {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.23.3/docs/resources/object_storage upcloud_object_storage} Resource
    *
    * @param scope The scope in which to define this construct
    * @param id The scoped construct ID. Must be unique amongst siblings in the same scope
    * @param options ObjectStorageConfig
    */
    constructor(scope: Construct, id: string, config: ObjectStorageConfig);
    private _accessKey?;
    get accessKey(): string;
    set accessKey(value: string);
    get accessKeyInput(): string | undefined;
    get created(): string;
    private _description?;
    get description(): string;
    set description(value: string);
    resetDescription(): void;
    get descriptionInput(): string | undefined;
    private _id?;
    get id(): string;
    set id(value: string);
    resetId(): void;
    get idInput(): string | undefined;
    private _name?;
    get name(): string;
    set name(value: string);
    get nameInput(): string | undefined;
    private _secretKey?;
    get secretKey(): string;
    set secretKey(value: string);
    get secretKeyInput(): string | undefined;
    private _size?;
    get size(): number;
    set size(value: number);
    get sizeInput(): number | undefined;
    get state(): string;
    get url(): string;
    get usedSpace(): number;
    private _zone?;
    get zone(): string;
    set zone(value: string);
    get zoneInput(): string | undefined;
    private _bucket;
    get bucket(): ObjectStorageBucketList;
    putBucket(value: ObjectStorageBucket[] | cdktf.IResolvable): void;
    resetBucket(): void;
    get bucketInput(): cdktf.IResolvable | ObjectStorageBucket[] | undefined;
    protected synthesizeAttributes(): {
        [name: string]: any;
    };
    protected synthesizeHclAttributes(): {
        [name: string]: any;
    };
}