rhizo-co-terraform-provider-oci
Version:
Prebuilt oci Provider for Terraform CDK (cdktf)
459 lines (458 loc) • 22.3 kB
TypeScript
import { Construct } from 'constructs';
import * as cdktf from 'cdktf';
export interface CoreVolumeConfig extends cdktf.TerraformMetaArguments {
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/oracle/oci/6.18.0/docs/resources/core_volume#availability_domain CoreVolume#availability_domain}
*/
readonly availabilityDomain: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/oracle/oci/6.18.0/docs/resources/core_volume#backup_policy_id CoreVolume#backup_policy_id}
*/
readonly backupPolicyId?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/oracle/oci/6.18.0/docs/resources/core_volume#block_volume_replicas_deletion CoreVolume#block_volume_replicas_deletion}
*/
readonly blockVolumeReplicasDeletion?: boolean | cdktf.IResolvable;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/oracle/oci/6.18.0/docs/resources/core_volume#cluster_placement_group_id CoreVolume#cluster_placement_group_id}
*/
readonly clusterPlacementGroupId?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/oracle/oci/6.18.0/docs/resources/core_volume#compartment_id CoreVolume#compartment_id}
*/
readonly compartmentId: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/oracle/oci/6.18.0/docs/resources/core_volume#defined_tags CoreVolume#defined_tags}
*/
readonly definedTags?: {
[key: string]: string;
};
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/oracle/oci/6.18.0/docs/resources/core_volume#display_name CoreVolume#display_name}
*/
readonly displayName?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/oracle/oci/6.18.0/docs/resources/core_volume#freeform_tags CoreVolume#freeform_tags}
*/
readonly freeformTags?: {
[key: string]: string;
};
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/oracle/oci/6.18.0/docs/resources/core_volume#id CoreVolume#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;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/oracle/oci/6.18.0/docs/resources/core_volume#is_auto_tune_enabled CoreVolume#is_auto_tune_enabled}
*/
readonly isAutoTuneEnabled?: boolean | cdktf.IResolvable;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/oracle/oci/6.18.0/docs/resources/core_volume#kms_key_id CoreVolume#kms_key_id}
*/
readonly kmsKeyId?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/oracle/oci/6.18.0/docs/resources/core_volume#size_in_gbs CoreVolume#size_in_gbs}
*/
readonly sizeInGbs?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/oracle/oci/6.18.0/docs/resources/core_volume#size_in_mbs CoreVolume#size_in_mbs}
*/
readonly sizeInMbs?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/oracle/oci/6.18.0/docs/resources/core_volume#volume_backup_id CoreVolume#volume_backup_id}
*/
readonly volumeBackupId?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/oracle/oci/6.18.0/docs/resources/core_volume#vpus_per_gb CoreVolume#vpus_per_gb}
*/
readonly vpusPerGb?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/oracle/oci/6.18.0/docs/resources/core_volume#xrc_kms_key_id CoreVolume#xrc_kms_key_id}
*/
readonly xrcKmsKeyId?: string;
/**
* autotune_policies block
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/oracle/oci/6.18.0/docs/resources/core_volume#autotune_policies CoreVolume#autotune_policies}
*/
readonly autotunePolicies?: CoreVolumeAutotunePolicies[] | cdktf.IResolvable;
/**
* block_volume_replicas block
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/oracle/oci/6.18.0/docs/resources/core_volume#block_volume_replicas CoreVolume#block_volume_replicas}
*/
readonly blockVolumeReplicas?: CoreVolumeBlockVolumeReplicas[] | cdktf.IResolvable;
/**
* source_details block
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/oracle/oci/6.18.0/docs/resources/core_volume#source_details CoreVolume#source_details}
*/
readonly sourceDetails?: CoreVolumeSourceDetails;
/**
* timeouts block
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/oracle/oci/6.18.0/docs/resources/core_volume#timeouts CoreVolume#timeouts}
*/
readonly timeouts?: CoreVolumeTimeouts;
}
export interface CoreVolumeAutotunePolicies {
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/oracle/oci/6.18.0/docs/resources/core_volume#autotune_type CoreVolume#autotune_type}
*/
readonly autotuneType: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/oracle/oci/6.18.0/docs/resources/core_volume#max_vpus_per_gb CoreVolume#max_vpus_per_gb}
*/
readonly maxVpusPerGb?: string;
}
export declare function coreVolumeAutotunePoliciesToTerraform(struct?: CoreVolumeAutotunePolicies | cdktf.IResolvable): any;
export declare function coreVolumeAutotunePoliciesToHclTerraform(struct?: CoreVolumeAutotunePolicies | cdktf.IResolvable): any;
export declare class CoreVolumeAutotunePoliciesOutputReference 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(): CoreVolumeAutotunePolicies | cdktf.IResolvable | undefined;
set internalValue(value: CoreVolumeAutotunePolicies | cdktf.IResolvable | undefined);
private _autotuneType?;
get autotuneType(): string;
set autotuneType(value: string);
get autotuneTypeInput(): string | undefined;
private _maxVpusPerGb?;
get maxVpusPerGb(): string;
set maxVpusPerGb(value: string);
resetMaxVpusPerGb(): void;
get maxVpusPerGbInput(): string | undefined;
}
export declare class CoreVolumeAutotunePoliciesList extends cdktf.ComplexList {
protected terraformResource: cdktf.IInterpolatingParent;
protected terraformAttribute: string;
protected wrapsSet: boolean;
internalValue?: CoreVolumeAutotunePolicies[] | 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): CoreVolumeAutotunePoliciesOutputReference;
}
export interface CoreVolumeBlockVolumeReplicas {
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/oracle/oci/6.18.0/docs/resources/core_volume#availability_domain CoreVolume#availability_domain}
*/
readonly availabilityDomain: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/oracle/oci/6.18.0/docs/resources/core_volume#display_name CoreVolume#display_name}
*/
readonly displayName?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/oracle/oci/6.18.0/docs/resources/core_volume#xrr_kms_key_id CoreVolume#xrr_kms_key_id}
*/
readonly xrrKmsKeyId?: string;
}
export declare function coreVolumeBlockVolumeReplicasToTerraform(struct?: CoreVolumeBlockVolumeReplicas | cdktf.IResolvable): any;
export declare function coreVolumeBlockVolumeReplicasToHclTerraform(struct?: CoreVolumeBlockVolumeReplicas | cdktf.IResolvable): any;
export declare class CoreVolumeBlockVolumeReplicasOutputReference 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(): CoreVolumeBlockVolumeReplicas | cdktf.IResolvable | undefined;
set internalValue(value: CoreVolumeBlockVolumeReplicas | cdktf.IResolvable | undefined);
private _availabilityDomain?;
get availabilityDomain(): string;
set availabilityDomain(value: string);
get availabilityDomainInput(): string | undefined;
get blockVolumeReplicaId(): string;
private _displayName?;
get displayName(): string;
set displayName(value: string);
resetDisplayName(): void;
get displayNameInput(): string | undefined;
get kmsKeyId(): string;
private _xrrKmsKeyId?;
get xrrKmsKeyId(): string;
set xrrKmsKeyId(value: string);
resetXrrKmsKeyId(): void;
get xrrKmsKeyIdInput(): string | undefined;
}
export declare class CoreVolumeBlockVolumeReplicasList extends cdktf.ComplexList {
protected terraformResource: cdktf.IInterpolatingParent;
protected terraformAttribute: string;
protected wrapsSet: boolean;
internalValue?: CoreVolumeBlockVolumeReplicas[] | 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): CoreVolumeBlockVolumeReplicasOutputReference;
}
export interface CoreVolumeSourceDetails {
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/oracle/oci/6.18.0/docs/resources/core_volume#change_block_size_in_bytes CoreVolume#change_block_size_in_bytes}
*/
readonly changeBlockSizeInBytes?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/oracle/oci/6.18.0/docs/resources/core_volume#first_backup_id CoreVolume#first_backup_id}
*/
readonly firstBackupId?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/oracle/oci/6.18.0/docs/resources/core_volume#id CoreVolume#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;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/oracle/oci/6.18.0/docs/resources/core_volume#second_backup_id CoreVolume#second_backup_id}
*/
readonly secondBackupId?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/oracle/oci/6.18.0/docs/resources/core_volume#type CoreVolume#type}
*/
readonly type: string;
}
export declare function coreVolumeSourceDetailsToTerraform(struct?: CoreVolumeSourceDetailsOutputReference | CoreVolumeSourceDetails): any;
export declare function coreVolumeSourceDetailsToHclTerraform(struct?: CoreVolumeSourceDetailsOutputReference | CoreVolumeSourceDetails): any;
export declare class CoreVolumeSourceDetailsOutputReference extends cdktf.ComplexObject {
private isEmptyObject;
/**
* @param terraformResource The parent resource
* @param terraformAttribute The attribute on the parent resource this class is referencing
*/
constructor(terraformResource: cdktf.IInterpolatingParent, terraformAttribute: string);
get internalValue(): CoreVolumeSourceDetails | undefined;
set internalValue(value: CoreVolumeSourceDetails | undefined);
private _changeBlockSizeInBytes?;
get changeBlockSizeInBytes(): string;
set changeBlockSizeInBytes(value: string);
resetChangeBlockSizeInBytes(): void;
get changeBlockSizeInBytesInput(): string | undefined;
private _firstBackupId?;
get firstBackupId(): string;
set firstBackupId(value: string);
resetFirstBackupId(): void;
get firstBackupIdInput(): string | undefined;
private _id?;
get id(): string;
set id(value: string);
resetId(): void;
get idInput(): string | undefined;
private _secondBackupId?;
get secondBackupId(): string;
set secondBackupId(value: string);
resetSecondBackupId(): void;
get secondBackupIdInput(): string | undefined;
private _type?;
get type(): string;
set type(value: string);
get typeInput(): string | undefined;
}
export interface CoreVolumeTimeouts {
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/oracle/oci/6.18.0/docs/resources/core_volume#create CoreVolume#create}
*/
readonly create?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/oracle/oci/6.18.0/docs/resources/core_volume#delete CoreVolume#delete}
*/
readonly delete?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/oracle/oci/6.18.0/docs/resources/core_volume#update CoreVolume#update}
*/
readonly update?: string;
}
export declare function coreVolumeTimeoutsToTerraform(struct?: CoreVolumeTimeouts | cdktf.IResolvable): any;
export declare function coreVolumeTimeoutsToHclTerraform(struct?: CoreVolumeTimeouts | cdktf.IResolvable): any;
export declare class CoreVolumeTimeoutsOutputReference extends cdktf.ComplexObject {
private isEmptyObject;
private resolvableValue?;
/**
* @param terraformResource The parent resource
* @param terraformAttribute The attribute on the parent resource this class is referencing
*/
constructor(terraformResource: cdktf.IInterpolatingParent, terraformAttribute: string);
get internalValue(): CoreVolumeTimeouts | cdktf.IResolvable | undefined;
set internalValue(value: CoreVolumeTimeouts | cdktf.IResolvable | undefined);
private _create?;
get create(): string;
set create(value: string);
resetCreate(): void;
get createInput(): string | undefined;
private _delete?;
get delete(): string;
set delete(value: string);
resetDelete(): void;
get deleteInput(): string | undefined;
private _update?;
get update(): string;
set update(value: string);
resetUpdate(): void;
get updateInput(): string | undefined;
}
/**
* Represents a {@link https://registry.terraform.io/providers/oracle/oci/6.18.0/docs/resources/core_volume oci_core_volume}
*/
export declare class CoreVolume extends cdktf.TerraformResource {
static readonly tfResourceType = "oci_core_volume";
/**
* Generates CDKTF code for importing a CoreVolume 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 CoreVolume to import
* @param importFromId The id of the existing CoreVolume that should be imported. Refer to the {@link https://registry.terraform.io/providers/oracle/oci/6.18.0/docs/resources/core_volume#import import section} in the documentation of this resource for the id to use
* @param provider? Optional instance of the provider where the CoreVolume 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/oracle/oci/6.18.0/docs/resources/core_volume oci_core_volume} 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 CoreVolumeConfig
*/
constructor(scope: Construct, id: string, config: CoreVolumeConfig);
get autoTunedVpusPerGb(): string;
private _availabilityDomain?;
get availabilityDomain(): string;
set availabilityDomain(value: string);
get availabilityDomainInput(): string | undefined;
private _backupPolicyId?;
get backupPolicyId(): string;
set backupPolicyId(value: string);
resetBackupPolicyId(): void;
get backupPolicyIdInput(): string | undefined;
private _blockVolumeReplicasDeletion?;
get blockVolumeReplicasDeletion(): boolean | cdktf.IResolvable;
set blockVolumeReplicasDeletion(value: boolean | cdktf.IResolvable);
resetBlockVolumeReplicasDeletion(): void;
get blockVolumeReplicasDeletionInput(): boolean | cdktf.IResolvable | undefined;
private _clusterPlacementGroupId?;
get clusterPlacementGroupId(): string;
set clusterPlacementGroupId(value: string);
resetClusterPlacementGroupId(): void;
get clusterPlacementGroupIdInput(): string | undefined;
private _compartmentId?;
get compartmentId(): string;
set compartmentId(value: string);
get compartmentIdInput(): string | undefined;
private _definedTags?;
get definedTags(): {
[key: string]: string;
};
set definedTags(value: {
[key: string]: string;
});
resetDefinedTags(): void;
get definedTagsInput(): {
[key: string]: string;
} | undefined;
private _displayName?;
get displayName(): string;
set displayName(value: string);
resetDisplayName(): void;
get displayNameInput(): string | undefined;
private _freeformTags?;
get freeformTags(): {
[key: string]: string;
};
set freeformTags(value: {
[key: string]: string;
});
resetFreeformTags(): void;
get freeformTagsInput(): {
[key: string]: string;
} | undefined;
private _id?;
get id(): string;
set id(value: string);
resetId(): void;
get idInput(): string | undefined;
private _isAutoTuneEnabled?;
get isAutoTuneEnabled(): boolean | cdktf.IResolvable;
set isAutoTuneEnabled(value: boolean | cdktf.IResolvable);
resetIsAutoTuneEnabled(): void;
get isAutoTuneEnabledInput(): boolean | cdktf.IResolvable | undefined;
get isHydrated(): cdktf.IResolvable;
private _kmsKeyId?;
get kmsKeyId(): string;
set kmsKeyId(value: string);
resetKmsKeyId(): void;
get kmsKeyIdInput(): string | undefined;
private _sizeInGbs?;
get sizeInGbs(): string;
set sizeInGbs(value: string);
resetSizeInGbs(): void;
get sizeInGbsInput(): string | undefined;
private _sizeInMbs?;
get sizeInMbs(): string;
set sizeInMbs(value: string);
resetSizeInMbs(): void;
get sizeInMbsInput(): string | undefined;
get state(): string;
private _systemTags;
get systemTags(): cdktf.StringMap;
get timeCreated(): string;
private _volumeBackupId?;
get volumeBackupId(): string;
set volumeBackupId(value: string);
resetVolumeBackupId(): void;
get volumeBackupIdInput(): string | undefined;
get volumeGroupId(): string;
private _vpusPerGb?;
get vpusPerGb(): string;
set vpusPerGb(value: string);
resetVpusPerGb(): void;
get vpusPerGbInput(): string | undefined;
private _xrcKmsKeyId?;
get xrcKmsKeyId(): string;
set xrcKmsKeyId(value: string);
resetXrcKmsKeyId(): void;
get xrcKmsKeyIdInput(): string | undefined;
private _autotunePolicies;
get autotunePolicies(): CoreVolumeAutotunePoliciesList;
putAutotunePolicies(value: CoreVolumeAutotunePolicies[] | cdktf.IResolvable): void;
resetAutotunePolicies(): void;
get autotunePoliciesInput(): cdktf.IResolvable | CoreVolumeAutotunePolicies[] | undefined;
private _blockVolumeReplicas;
get blockVolumeReplicas(): CoreVolumeBlockVolumeReplicasList;
putBlockVolumeReplicas(value: CoreVolumeBlockVolumeReplicas[] | cdktf.IResolvable): void;
resetBlockVolumeReplicas(): void;
get blockVolumeReplicasInput(): cdktf.IResolvable | CoreVolumeBlockVolumeReplicas[] | undefined;
private _sourceDetails;
get sourceDetails(): CoreVolumeSourceDetailsOutputReference;
putSourceDetails(value: CoreVolumeSourceDetails): void;
resetSourceDetails(): void;
get sourceDetailsInput(): CoreVolumeSourceDetails | undefined;
private _timeouts;
get timeouts(): CoreVolumeTimeoutsOutputReference;
putTimeouts(value: CoreVolumeTimeouts): void;
resetTimeouts(): void;
get timeoutsInput(): cdktf.IResolvable | CoreVolumeTimeouts | undefined;
protected synthesizeAttributes(): {
[name: string]: any;
};
protected synthesizeHclAttributes(): {
[name: string]: any;
};
}