rhizo-co-terraform-provider-oci
Version:
Prebuilt oci Provider for Terraform CDK (cdktf)
387 lines (386 loc) • 20.7 kB
TypeScript
import { Construct } from 'constructs';
import * as cdktf from 'cdktf';
export interface FileStorageFilesystemSnapshotPolicyConfig extends cdktf.TerraformMetaArguments {
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/oracle/oci/6.18.0/docs/resources/file_storage_filesystem_snapshot_policy#availability_domain FileStorageFilesystemSnapshotPolicy#availability_domain}
*/
readonly availabilityDomain: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/oracle/oci/6.18.0/docs/resources/file_storage_filesystem_snapshot_policy#compartment_id FileStorageFilesystemSnapshotPolicy#compartment_id}
*/
readonly compartmentId: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/oracle/oci/6.18.0/docs/resources/file_storage_filesystem_snapshot_policy#defined_tags FileStorageFilesystemSnapshotPolicy#defined_tags}
*/
readonly definedTags?: {
[key: string]: string;
};
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/oracle/oci/6.18.0/docs/resources/file_storage_filesystem_snapshot_policy#display_name FileStorageFilesystemSnapshotPolicy#display_name}
*/
readonly displayName?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/oracle/oci/6.18.0/docs/resources/file_storage_filesystem_snapshot_policy#freeform_tags FileStorageFilesystemSnapshotPolicy#freeform_tags}
*/
readonly freeformTags?: {
[key: string]: string;
};
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/oracle/oci/6.18.0/docs/resources/file_storage_filesystem_snapshot_policy#id FileStorageFilesystemSnapshotPolicy#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/file_storage_filesystem_snapshot_policy#is_lock_override FileStorageFilesystemSnapshotPolicy#is_lock_override}
*/
readonly isLockOverride?: boolean | cdktf.IResolvable;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/oracle/oci/6.18.0/docs/resources/file_storage_filesystem_snapshot_policy#policy_prefix FileStorageFilesystemSnapshotPolicy#policy_prefix}
*/
readonly policyPrefix?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/oracle/oci/6.18.0/docs/resources/file_storage_filesystem_snapshot_policy#state FileStorageFilesystemSnapshotPolicy#state}
*/
readonly state?: string;
/**
* locks block
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/oracle/oci/6.18.0/docs/resources/file_storage_filesystem_snapshot_policy#locks FileStorageFilesystemSnapshotPolicy#locks}
*/
readonly locks?: FileStorageFilesystemSnapshotPolicyLocks[] | cdktf.IResolvable;
/**
* schedules block
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/oracle/oci/6.18.0/docs/resources/file_storage_filesystem_snapshot_policy#schedules FileStorageFilesystemSnapshotPolicy#schedules}
*/
readonly schedules?: FileStorageFilesystemSnapshotPolicySchedules[] | cdktf.IResolvable;
/**
* timeouts block
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/oracle/oci/6.18.0/docs/resources/file_storage_filesystem_snapshot_policy#timeouts FileStorageFilesystemSnapshotPolicy#timeouts}
*/
readonly timeouts?: FileStorageFilesystemSnapshotPolicyTimeouts;
}
export interface FileStorageFilesystemSnapshotPolicyLocks {
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/oracle/oci/6.18.0/docs/resources/file_storage_filesystem_snapshot_policy#message FileStorageFilesystemSnapshotPolicy#message}
*/
readonly message?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/oracle/oci/6.18.0/docs/resources/file_storage_filesystem_snapshot_policy#related_resource_id FileStorageFilesystemSnapshotPolicy#related_resource_id}
*/
readonly relatedResourceId?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/oracle/oci/6.18.0/docs/resources/file_storage_filesystem_snapshot_policy#time_created FileStorageFilesystemSnapshotPolicy#time_created}
*/
readonly timeCreated?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/oracle/oci/6.18.0/docs/resources/file_storage_filesystem_snapshot_policy#type FileStorageFilesystemSnapshotPolicy#type}
*/
readonly type: string;
}
export declare function fileStorageFilesystemSnapshotPolicyLocksToTerraform(struct?: FileStorageFilesystemSnapshotPolicyLocks | cdktf.IResolvable): any;
export declare function fileStorageFilesystemSnapshotPolicyLocksToHclTerraform(struct?: FileStorageFilesystemSnapshotPolicyLocks | cdktf.IResolvable): any;
export declare class FileStorageFilesystemSnapshotPolicyLocksOutputReference 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(): FileStorageFilesystemSnapshotPolicyLocks | cdktf.IResolvable | undefined;
set internalValue(value: FileStorageFilesystemSnapshotPolicyLocks | cdktf.IResolvable | undefined);
private _message?;
get message(): string;
set message(value: string);
resetMessage(): void;
get messageInput(): string | undefined;
private _relatedResourceId?;
get relatedResourceId(): string;
set relatedResourceId(value: string);
resetRelatedResourceId(): void;
get relatedResourceIdInput(): string | undefined;
private _timeCreated?;
get timeCreated(): string;
set timeCreated(value: string);
resetTimeCreated(): void;
get timeCreatedInput(): string | undefined;
private _type?;
get type(): string;
set type(value: string);
get typeInput(): string | undefined;
}
export declare class FileStorageFilesystemSnapshotPolicyLocksList extends cdktf.ComplexList {
protected terraformResource: cdktf.IInterpolatingParent;
protected terraformAttribute: string;
protected wrapsSet: boolean;
internalValue?: FileStorageFilesystemSnapshotPolicyLocks[] | 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): FileStorageFilesystemSnapshotPolicyLocksOutputReference;
}
export interface FileStorageFilesystemSnapshotPolicySchedules {
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/oracle/oci/6.18.0/docs/resources/file_storage_filesystem_snapshot_policy#day_of_month FileStorageFilesystemSnapshotPolicy#day_of_month}
*/
readonly dayOfMonth?: number;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/oracle/oci/6.18.0/docs/resources/file_storage_filesystem_snapshot_policy#day_of_week FileStorageFilesystemSnapshotPolicy#day_of_week}
*/
readonly dayOfWeek?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/oracle/oci/6.18.0/docs/resources/file_storage_filesystem_snapshot_policy#hour_of_day FileStorageFilesystemSnapshotPolicy#hour_of_day}
*/
readonly hourOfDay?: number;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/oracle/oci/6.18.0/docs/resources/file_storage_filesystem_snapshot_policy#month FileStorageFilesystemSnapshotPolicy#month}
*/
readonly month?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/oracle/oci/6.18.0/docs/resources/file_storage_filesystem_snapshot_policy#period FileStorageFilesystemSnapshotPolicy#period}
*/
readonly period: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/oracle/oci/6.18.0/docs/resources/file_storage_filesystem_snapshot_policy#retention_duration_in_seconds FileStorageFilesystemSnapshotPolicy#retention_duration_in_seconds}
*/
readonly retentionDurationInSeconds?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/oracle/oci/6.18.0/docs/resources/file_storage_filesystem_snapshot_policy#schedule_prefix FileStorageFilesystemSnapshotPolicy#schedule_prefix}
*/
readonly schedulePrefix?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/oracle/oci/6.18.0/docs/resources/file_storage_filesystem_snapshot_policy#time_schedule_start FileStorageFilesystemSnapshotPolicy#time_schedule_start}
*/
readonly timeScheduleStart?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/oracle/oci/6.18.0/docs/resources/file_storage_filesystem_snapshot_policy#time_zone FileStorageFilesystemSnapshotPolicy#time_zone}
*/
readonly timeZone: string;
}
export declare function fileStorageFilesystemSnapshotPolicySchedulesToTerraform(struct?: FileStorageFilesystemSnapshotPolicySchedules | cdktf.IResolvable): any;
export declare function fileStorageFilesystemSnapshotPolicySchedulesToHclTerraform(struct?: FileStorageFilesystemSnapshotPolicySchedules | cdktf.IResolvable): any;
export declare class FileStorageFilesystemSnapshotPolicySchedulesOutputReference 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(): FileStorageFilesystemSnapshotPolicySchedules | cdktf.IResolvable | undefined;
set internalValue(value: FileStorageFilesystemSnapshotPolicySchedules | cdktf.IResolvable | 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 _period?;
get period(): string;
set period(value: string);
get periodInput(): string | undefined;
private _retentionDurationInSeconds?;
get retentionDurationInSeconds(): string;
set retentionDurationInSeconds(value: string);
resetRetentionDurationInSeconds(): void;
get retentionDurationInSecondsInput(): string | undefined;
private _schedulePrefix?;
get schedulePrefix(): string;
set schedulePrefix(value: string);
resetSchedulePrefix(): void;
get schedulePrefixInput(): string | undefined;
private _timeScheduleStart?;
get timeScheduleStart(): string;
set timeScheduleStart(value: string);
resetTimeScheduleStart(): void;
get timeScheduleStartInput(): string | undefined;
private _timeZone?;
get timeZone(): string;
set timeZone(value: string);
get timeZoneInput(): string | undefined;
}
export declare class FileStorageFilesystemSnapshotPolicySchedulesList extends cdktf.ComplexList {
protected terraformResource: cdktf.IInterpolatingParent;
protected terraformAttribute: string;
protected wrapsSet: boolean;
internalValue?: FileStorageFilesystemSnapshotPolicySchedules[] | 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): FileStorageFilesystemSnapshotPolicySchedulesOutputReference;
}
export interface FileStorageFilesystemSnapshotPolicyTimeouts {
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/oracle/oci/6.18.0/docs/resources/file_storage_filesystem_snapshot_policy#create FileStorageFilesystemSnapshotPolicy#create}
*/
readonly create?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/oracle/oci/6.18.0/docs/resources/file_storage_filesystem_snapshot_policy#delete FileStorageFilesystemSnapshotPolicy#delete}
*/
readonly delete?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/oracle/oci/6.18.0/docs/resources/file_storage_filesystem_snapshot_policy#update FileStorageFilesystemSnapshotPolicy#update}
*/
readonly update?: string;
}
export declare function fileStorageFilesystemSnapshotPolicyTimeoutsToTerraform(struct?: FileStorageFilesystemSnapshotPolicyTimeouts | cdktf.IResolvable): any;
export declare function fileStorageFilesystemSnapshotPolicyTimeoutsToHclTerraform(struct?: FileStorageFilesystemSnapshotPolicyTimeouts | cdktf.IResolvable): any;
export declare class FileStorageFilesystemSnapshotPolicyTimeoutsOutputReference 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(): FileStorageFilesystemSnapshotPolicyTimeouts | cdktf.IResolvable | undefined;
set internalValue(value: FileStorageFilesystemSnapshotPolicyTimeouts | 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/file_storage_filesystem_snapshot_policy oci_file_storage_filesystem_snapshot_policy}
*/
export declare class FileStorageFilesystemSnapshotPolicy extends cdktf.TerraformResource {
static readonly tfResourceType = "oci_file_storage_filesystem_snapshot_policy";
/**
* Generates CDKTF code for importing a FileStorageFilesystemSnapshotPolicy 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 FileStorageFilesystemSnapshotPolicy to import
* @param importFromId The id of the existing FileStorageFilesystemSnapshotPolicy that should be imported. Refer to the {@link https://registry.terraform.io/providers/oracle/oci/6.18.0/docs/resources/file_storage_filesystem_snapshot_policy#import import section} in the documentation of this resource for the id to use
* @param provider? Optional instance of the provider where the FileStorageFilesystemSnapshotPolicy 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/file_storage_filesystem_snapshot_policy oci_file_storage_filesystem_snapshot_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 FileStorageFilesystemSnapshotPolicyConfig
*/
constructor(scope: Construct, id: string, config: FileStorageFilesystemSnapshotPolicyConfig);
private _availabilityDomain?;
get availabilityDomain(): string;
set availabilityDomain(value: string);
get availabilityDomainInput(): 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 _isLockOverride?;
get isLockOverride(): boolean | cdktf.IResolvable;
set isLockOverride(value: boolean | cdktf.IResolvable);
resetIsLockOverride(): void;
get isLockOverrideInput(): boolean | cdktf.IResolvable | undefined;
private _policyPrefix?;
get policyPrefix(): string;
set policyPrefix(value: string);
resetPolicyPrefix(): void;
get policyPrefixInput(): string | undefined;
private _state?;
get state(): string;
set state(value: string);
resetState(): void;
get stateInput(): string | undefined;
get timeCreated(): string;
private _locks;
get locks(): FileStorageFilesystemSnapshotPolicyLocksList;
putLocks(value: FileStorageFilesystemSnapshotPolicyLocks[] | cdktf.IResolvable): void;
resetLocks(): void;
get locksInput(): cdktf.IResolvable | FileStorageFilesystemSnapshotPolicyLocks[] | undefined;
private _schedules;
get schedules(): FileStorageFilesystemSnapshotPolicySchedulesList;
putSchedules(value: FileStorageFilesystemSnapshotPolicySchedules[] | cdktf.IResolvable): void;
resetSchedules(): void;
get schedulesInput(): cdktf.IResolvable | FileStorageFilesystemSnapshotPolicySchedules[] | undefined;
private _timeouts;
get timeouts(): FileStorageFilesystemSnapshotPolicyTimeoutsOutputReference;
putTimeouts(value: FileStorageFilesystemSnapshotPolicyTimeouts): void;
resetTimeouts(): void;
get timeoutsInput(): cdktf.IResolvable | FileStorageFilesystemSnapshotPolicyTimeouts | undefined;
protected synthesizeAttributes(): {
[name: string]: any;
};
protected synthesizeHclAttributes(): {
[name: string]: any;
};
}