@cdktf/provider-upcloud
Version:
Prebuilt upcloud Provider for Terraform CDK (cdktf)
223 lines (222 loc) • 10.8 kB
TypeScript
/**
* Copyright (c) HashiCorp, Inc.
* SPDX-License-Identifier: MPL-2.0
*/
import { Construct } from 'constructs';
import * as cdktf from 'cdktf';
export interface ManagedObjectStorageConfig extends cdktf.TerraformMetaArguments {
/**
* Service status managed by the end user.
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.23.3/docs/resources/managed_object_storage#configured_status ManagedObjectStorage#configured_status}
*/
readonly configuredStatus: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.23.3/docs/resources/managed_object_storage#id ManagedObjectStorage#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;
/**
* User defined key-value pairs to classify the managed object storage.
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.23.3/docs/resources/managed_object_storage#labels ManagedObjectStorage#labels}
*/
readonly labels?: {
[key: string]: string;
};
/**
* Name of the Managed Object Storage service. Must be unique within account.
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.23.3/docs/resources/managed_object_storage#name ManagedObjectStorage#name}
*/
readonly name: string;
/**
* Region in which the service will be hosted, see `upcloud_managed_object_storage_regions` data source.
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.23.3/docs/resources/managed_object_storage#region ManagedObjectStorage#region}
*/
readonly region: string;
/**
* network block
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.23.3/docs/resources/managed_object_storage#network ManagedObjectStorage#network}
*/
readonly network?: ManagedObjectStorageNetwork[] | cdktf.IResolvable;
}
export interface ManagedObjectStorageEndpoint {
}
export declare function managedObjectStorageEndpointToTerraform(struct?: ManagedObjectStorageEndpoint): any;
export declare function managedObjectStorageEndpointToHclTerraform(struct?: ManagedObjectStorageEndpoint): any;
export declare class ManagedObjectStorageEndpointOutputReference extends cdktf.ComplexObject {
private isEmptyObject;
/**
* @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(): ManagedObjectStorageEndpoint | undefined;
set internalValue(value: ManagedObjectStorageEndpoint | undefined);
get domainName(): string;
get iamUrl(): string;
get stsUrl(): string;
get type(): string;
}
export declare class ManagedObjectStorageEndpointList extends cdktf.ComplexList {
protected terraformResource: cdktf.IInterpolatingParent;
protected terraformAttribute: string;
protected wrapsSet: boolean;
/**
* @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): ManagedObjectStorageEndpointOutputReference;
}
export interface ManagedObjectStorageNetwork {
/**
* Network family. IPv6 currently not supported.
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.23.3/docs/resources/managed_object_storage#family ManagedObjectStorage#family}
*/
readonly family: string;
/**
* Network name. Must be unique within the service.
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.23.3/docs/resources/managed_object_storage#name ManagedObjectStorage#name}
*/
readonly name: string;
/**
* Network type.
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.23.3/docs/resources/managed_object_storage#type ManagedObjectStorage#type}
*/
readonly type: string;
/**
* Private network uuid. For public networks the field should be omitted.
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.23.3/docs/resources/managed_object_storage#uuid ManagedObjectStorage#uuid}
*/
readonly uuid?: string;
}
export declare function managedObjectStorageNetworkToTerraform(struct?: ManagedObjectStorageNetwork | cdktf.IResolvable): any;
export declare function managedObjectStorageNetworkToHclTerraform(struct?: ManagedObjectStorageNetwork | cdktf.IResolvable): any;
export declare class ManagedObjectStorageNetworkOutputReference 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(): ManagedObjectStorageNetwork | cdktf.IResolvable | undefined;
set internalValue(value: ManagedObjectStorageNetwork | cdktf.IResolvable | undefined);
private _family?;
get family(): string;
set family(value: string);
get familyInput(): string | undefined;
private _name?;
get name(): string;
set name(value: string);
get nameInput(): string | undefined;
private _type?;
get type(): string;
set type(value: string);
get typeInput(): string | undefined;
private _uuid?;
get uuid(): string;
set uuid(value: string);
resetUuid(): void;
get uuidInput(): string | undefined;
}
export declare class ManagedObjectStorageNetworkList extends cdktf.ComplexList {
protected terraformResource: cdktf.IInterpolatingParent;
protected terraformAttribute: string;
protected wrapsSet: boolean;
internalValue?: ManagedObjectStorageNetwork[] | 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): ManagedObjectStorageNetworkOutputReference;
}
/**
* Represents a {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.23.3/docs/resources/managed_object_storage upcloud_managed_object_storage}
*/
export declare class ManagedObjectStorage extends cdktf.TerraformResource {
static readonly tfResourceType = "upcloud_managed_object_storage";
/**
* Generates CDKTF code for importing a ManagedObjectStorage 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 ManagedObjectStorage to import
* @param importFromId The id of the existing ManagedObjectStorage that should be imported. Refer to the {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.23.3/docs/resources/managed_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 ManagedObjectStorage 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/managed_object_storage upcloud_managed_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 ManagedObjectStorageConfig
*/
constructor(scope: Construct, id: string, config: ManagedObjectStorageConfig);
private _configuredStatus?;
get configuredStatus(): string;
set configuredStatus(value: string);
get configuredStatusInput(): string | undefined;
get createdAt(): string;
private _endpoint;
get endpoint(): ManagedObjectStorageEndpointList;
private _id?;
get id(): string;
set id(value: string);
resetId(): void;
get idInput(): string | undefined;
private _labels?;
get labels(): {
[key: string]: string;
};
set labels(value: {
[key: string]: string;
});
resetLabels(): void;
get labelsInput(): {
[key: string]: string;
} | undefined;
private _name?;
get name(): string;
set name(value: string);
get nameInput(): string | undefined;
get operationalState(): string;
private _region?;
get region(): string;
set region(value: string);
get regionInput(): string | undefined;
get updatedAt(): string;
private _network;
get network(): ManagedObjectStorageNetworkList;
putNetwork(value: ManagedObjectStorageNetwork[] | cdktf.IResolvable): void;
resetNetwork(): void;
get networkInput(): cdktf.IResolvable | ManagedObjectStorageNetwork[] | undefined;
protected synthesizeAttributes(): {
[name: string]: any;
};
protected synthesizeHclAttributes(): {
[name: string]: any;
};
}