rhizo-co-terraform-provider-oci
Version:
Prebuilt oci Provider for Terraform CDK (cdktf)
290 lines (289 loc) • 14.1 kB
TypeScript
import { Construct } from 'constructs';
import * as cdktf from 'cdktf';
export interface CoreVolumeBackupPolicyConfig extends cdktf.TerraformMetaArguments {
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/oracle/oci/6.18.0/docs/resources/core_volume_backup_policy#compartment_id CoreVolumeBackupPolicy#compartment_id}
*/
readonly compartmentId: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/oracle/oci/6.18.0/docs/resources/core_volume_backup_policy#defined_tags CoreVolumeBackupPolicy#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_backup_policy#destination_region CoreVolumeBackupPolicy#destination_region}
*/
readonly destinationRegion?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/oracle/oci/6.18.0/docs/resources/core_volume_backup_policy#display_name CoreVolumeBackupPolicy#display_name}
*/
readonly displayName?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/oracle/oci/6.18.0/docs/resources/core_volume_backup_policy#freeform_tags CoreVolumeBackupPolicy#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_backup_policy#id CoreVolumeBackupPolicy#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;
/**
* schedules block
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/oracle/oci/6.18.0/docs/resources/core_volume_backup_policy#schedules CoreVolumeBackupPolicy#schedules}
*/
readonly schedules?: CoreVolumeBackupPolicySchedules[] | cdktf.IResolvable;
/**
* timeouts block
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/oracle/oci/6.18.0/docs/resources/core_volume_backup_policy#timeouts CoreVolumeBackupPolicy#timeouts}
*/
readonly timeouts?: CoreVolumeBackupPolicyTimeouts;
}
export interface CoreVolumeBackupPolicySchedules {
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/oracle/oci/6.18.0/docs/resources/core_volume_backup_policy#backup_type CoreVolumeBackupPolicy#backup_type}
*/
readonly backupType: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/oracle/oci/6.18.0/docs/resources/core_volume_backup_policy#day_of_month CoreVolumeBackupPolicy#day_of_month}
*/
readonly dayOfMonth?: number;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/oracle/oci/6.18.0/docs/resources/core_volume_backup_policy#day_of_week CoreVolumeBackupPolicy#day_of_week}
*/
readonly dayOfWeek?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/oracle/oci/6.18.0/docs/resources/core_volume_backup_policy#hour_of_day CoreVolumeBackupPolicy#hour_of_day}
*/
readonly hourOfDay?: number;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/oracle/oci/6.18.0/docs/resources/core_volume_backup_policy#month CoreVolumeBackupPolicy#month}
*/
readonly month?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/oracle/oci/6.18.0/docs/resources/core_volume_backup_policy#offset_seconds CoreVolumeBackupPolicy#offset_seconds}
*/
readonly offsetSeconds?: number;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/oracle/oci/6.18.0/docs/resources/core_volume_backup_policy#offset_type CoreVolumeBackupPolicy#offset_type}
*/
readonly offsetType?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/oracle/oci/6.18.0/docs/resources/core_volume_backup_policy#period CoreVolumeBackupPolicy#period}
*/
readonly period: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/oracle/oci/6.18.0/docs/resources/core_volume_backup_policy#retention_seconds CoreVolumeBackupPolicy#retention_seconds}
*/
readonly retentionSeconds: number;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/oracle/oci/6.18.0/docs/resources/core_volume_backup_policy#time_zone CoreVolumeBackupPolicy#time_zone}
*/
readonly timeZone?: string;
}
export declare function coreVolumeBackupPolicySchedulesToTerraform(struct?: CoreVolumeBackupPolicySchedules | cdktf.IResolvable): any;
export declare function coreVolumeBackupPolicySchedulesToHclTerraform(struct?: CoreVolumeBackupPolicySchedules | cdktf.IResolvable): any;
export declare class CoreVolumeBackupPolicySchedulesOutputReference 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(): CoreVolumeBackupPolicySchedules | cdktf.IResolvable | undefined;
set internalValue(value: CoreVolumeBackupPolicySchedules | cdktf.IResolvable | undefined);
private _backupType?;
get backupType(): string;
set backupType(value: string);
get backupTypeInput(): string | undefined;
private _dayOfMonth?;
get dayOfMonth(): number;
set dayOfMonth(value: number);
resetDayOfMonth(): void;
get dayOfMonthInput(): number | undefined;
private _dayOfWeek?;
get dayOfWeek(): string;
set dayOfWeek(value: string);
resetDayOfWeek(): void;
get dayOfWeekInput(): string | undefined;
private _hourOfDay?;
get hourOfDay(): number;
set hourOfDay(value: number);
resetHourOfDay(): void;
get hourOfDayInput(): number | undefined;
private _month?;
get month(): string;
set month(value: string);
resetMonth(): void;
get monthInput(): string | undefined;
private _offsetSeconds?;
get offsetSeconds(): number;
set offsetSeconds(value: number);
resetOffsetSeconds(): void;
get offsetSecondsInput(): number | undefined;
private _offsetType?;
get offsetType(): string;
set offsetType(value: string);
resetOffsetType(): void;
get offsetTypeInput(): string | undefined;
private _period?;
get period(): string;
set period(value: string);
get periodInput(): string | undefined;
private _retentionSeconds?;
get retentionSeconds(): number;
set retentionSeconds(value: number);
get retentionSecondsInput(): number | undefined;
private _timeZone?;
get timeZone(): string;
set timeZone(value: string);
resetTimeZone(): void;
get timeZoneInput(): string | undefined;
}
export declare class CoreVolumeBackupPolicySchedulesList extends cdktf.ComplexList {
protected terraformResource: cdktf.IInterpolatingParent;
protected terraformAttribute: string;
protected wrapsSet: boolean;
internalValue?: CoreVolumeBackupPolicySchedules[] | 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): CoreVolumeBackupPolicySchedulesOutputReference;
}
export interface CoreVolumeBackupPolicyTimeouts {
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/oracle/oci/6.18.0/docs/resources/core_volume_backup_policy#create CoreVolumeBackupPolicy#create}
*/
readonly create?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/oracle/oci/6.18.0/docs/resources/core_volume_backup_policy#delete CoreVolumeBackupPolicy#delete}
*/
readonly delete?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/oracle/oci/6.18.0/docs/resources/core_volume_backup_policy#update CoreVolumeBackupPolicy#update}
*/
readonly update?: string;
}
export declare function coreVolumeBackupPolicyTimeoutsToTerraform(struct?: CoreVolumeBackupPolicyTimeouts | cdktf.IResolvable): any;
export declare function coreVolumeBackupPolicyTimeoutsToHclTerraform(struct?: CoreVolumeBackupPolicyTimeouts | cdktf.IResolvable): any;
export declare class CoreVolumeBackupPolicyTimeoutsOutputReference 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(): CoreVolumeBackupPolicyTimeouts | cdktf.IResolvable | undefined;
set internalValue(value: CoreVolumeBackupPolicyTimeouts | 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_backup_policy oci_core_volume_backup_policy}
*/
export declare class CoreVolumeBackupPolicy extends cdktf.TerraformResource {
static readonly tfResourceType = "oci_core_volume_backup_policy";
/**
* Generates CDKTF code for importing a CoreVolumeBackupPolicy 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 CoreVolumeBackupPolicy to import
* @param importFromId The id of the existing CoreVolumeBackupPolicy that should be imported. Refer to the {@link https://registry.terraform.io/providers/oracle/oci/6.18.0/docs/resources/core_volume_backup_policy#import import section} in the documentation of this resource for the id to use
* @param provider? Optional instance of the provider where the CoreVolumeBackupPolicy 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_backup_policy oci_core_volume_backup_policy} 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 CoreVolumeBackupPolicyConfig
*/
constructor(scope: Construct, id: string, config: CoreVolumeBackupPolicyConfig);
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 _destinationRegion?;
get destinationRegion(): string;
set destinationRegion(value: string);
resetDestinationRegion(): void;
get destinationRegionInput(): 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;
get timeCreated(): string;
private _schedules;
get schedules(): CoreVolumeBackupPolicySchedulesList;
putSchedules(value: CoreVolumeBackupPolicySchedules[] | cdktf.IResolvable): void;
resetSchedules(): void;
get schedulesInput(): cdktf.IResolvable | CoreVolumeBackupPolicySchedules[] | undefined;
private _timeouts;
get timeouts(): CoreVolumeBackupPolicyTimeoutsOutputReference;
putTimeouts(value: CoreVolumeBackupPolicyTimeouts): void;
resetTimeouts(): void;
get timeoutsInput(): cdktf.IResolvable | CoreVolumeBackupPolicyTimeouts | undefined;
protected synthesizeAttributes(): {
[name: string]: any;
};
protected synthesizeHclAttributes(): {
[name: string]: any;
};
}