import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * This resource provides the Filesystem Snapshot Policy resource in Oracle Cloud Infrastructure File Storage service. * Api doc link for the resource: https://docs.oracle.com/iaas/api/#/en/filestorage/latest/FilesystemSnapshotPolicy * * Example terraform configs related to the resource : https://github.com/oracle/terraform-provider-oci/tree/master/examples/ * * Creates a new file system snapshot policy in the specified compartment and * availability domain. * * After you create a file system snapshot policy, you can associate it with * file systems. * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as oci from "@pulumi/oci"; * * const testFilesystemSnapshotPolicy = new oci.filestorage.FilesystemSnapshotPolicy("test_filesystem_snapshot_policy", { * availabilityDomain: filesystemSnapshotPolicyAvailabilityDomain, * compartmentId: compartmentId, * definedTags: { * "Operations.CostCenter": "42", * }, * displayName: filesystemSnapshotPolicyDisplayName, * freeformTags: { * Department: "Finance", * }, * locks: [{ * type: filesystemSnapshotPolicyLocksType, * message: filesystemSnapshotPolicyLocksMessage, * relatedResourceId: testResource.id, * timeCreated: filesystemSnapshotPolicyLocksTimeCreated, * }], * policyPrefix: filesystemSnapshotPolicyPolicyPrefix, * schedules: [{ * period: filesystemSnapshotPolicySchedulesPeriod, * timeZone: filesystemSnapshotPolicySchedulesTimeZone, * dayOfMonth: Number(filesystemSnapshotPolicySchedulesDayOfMonth), * dayOfWeek: filesystemSnapshotPolicySchedulesDayOfWeek, * hourOfDay: Number(filesystemSnapshotPolicySchedulesHourOfDay), * lockDurationDetails: { * lockDuration: Number(filesystemSnapshotPolicySchedulesLockDurationDetailsLockDuration), * lockMode: filesystemSnapshotPolicySchedulesLockDurationDetailsLockMode, * coolOffDuration: Number(filesystemSnapshotPolicySchedulesLockDurationDetailsCoolOffDuration), * }, * month: filesystemSnapshotPolicySchedulesMonth, * retentionDurationInSeconds: filesystemSnapshotPolicySchedulesRetentionDurationInSeconds, * schedulePrefix: filesystemSnapshotPolicySchedulesSchedulePrefix, * timeScheduleStart: filesystemSnapshotPolicySchedulesTimeScheduleStart, * }], * }); * ``` * * ## Import * * FilesystemSnapshotPolicies can be imported using the `id`, e.g. * * ```sh * $ pulumi import oci:FileStorage/filesystemSnapshotPolicy:FilesystemSnapshotPolicy test_filesystem_snapshot_policy "id" * ``` */ export declare class FilesystemSnapshotPolicy extends pulumi.CustomResource { /** * Get an existing FilesystemSnapshotPolicy resource's state with the given name, ID, and optional extra * properties used to qualify the lookup. * * @param name The _unique_ name of the resulting resource. * @param id The _unique_ provider ID of the resource to lookup. * @param state Any extra arguments used during the lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input, state?: FilesystemSnapshotPolicyState, opts?: pulumi.CustomResourceOptions): FilesystemSnapshotPolicy; /** * Returns true if the given object is an instance of FilesystemSnapshotPolicy. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is FilesystemSnapshotPolicy; /** * The availability domain that the file system snapshot policy is in. Example: `Uocm:PHX-AD-1` */ readonly availabilityDomain: pulumi.Output; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the file system snapshot policy. */ readonly compartmentId: pulumi.Output; /** * (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations.CostCenter": "42"}` */ readonly definedTags: pulumi.Output<{ [key: string]: string; }>; /** * (Updatable) A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information. Example: `policy1` */ readonly displayName: pulumi.Output; /** * (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` */ readonly freeformTags: pulumi.Output<{ [key: string]: string; }>; readonly isLockOverride: pulumi.Output; /** * Locks associated with this resource. */ readonly locks: pulumi.Output; /** * (Updatable) The prefix to apply to all snapshots created by this policy. Example: `acme` */ readonly policyPrefix: pulumi.Output; /** * (Updatable) The list of associated snapshot schedules. A maximum of 10 schedules can be associated with a policy. * * If using the CLI, provide the schedule as a list of JSON strings, with the list wrapped in quotation marks, i.e. ```--schedules '[{"timeZone":"UTC","period":"DAILY","hourOfDay":18},{"timeZone":"UTC","period":"HOURLY"}]'``` */ readonly schedules: pulumi.Output; /** * (Updatable) The target state for the Filesystem Snapshot Policy. Could be set to `ACTIVE` or `INACTIVE`. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ readonly state: pulumi.Output; /** * System tags for this resource. System tags are applied to resources by internal Oracle Cloud Infrastructure services. */ readonly systemTags: pulumi.Output<{ [key: string]: string; }>; /** * The date and time the file system snapshot policy was created, expressed in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format. Example: `2016-08-25T21:10:29.600Z` */ readonly timeCreated: pulumi.Output; /** * Create a FilesystemSnapshotPolicy resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args: FilesystemSnapshotPolicyArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering FilesystemSnapshotPolicy resources. */ export interface FilesystemSnapshotPolicyState { /** * The availability domain that the file system snapshot policy is in. Example: `Uocm:PHX-AD-1` */ availabilityDomain?: pulumi.Input; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the file system snapshot policy. */ compartmentId?: pulumi.Input; /** * (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations.CostCenter": "42"}` */ definedTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * (Updatable) A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information. Example: `policy1` */ displayName?: pulumi.Input; /** * (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` */ freeformTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; isLockOverride?: pulumi.Input; /** * Locks associated with this resource. */ locks?: pulumi.Input[] | undefined>; /** * (Updatable) The prefix to apply to all snapshots created by this policy. Example: `acme` */ policyPrefix?: pulumi.Input; /** * (Updatable) The list of associated snapshot schedules. A maximum of 10 schedules can be associated with a policy. * * If using the CLI, provide the schedule as a list of JSON strings, with the list wrapped in quotation marks, i.e. ```--schedules '[{"timeZone":"UTC","period":"DAILY","hourOfDay":18},{"timeZone":"UTC","period":"HOURLY"}]'``` */ schedules?: pulumi.Input[] | undefined>; /** * (Updatable) The target state for the Filesystem Snapshot Policy. Could be set to `ACTIVE` or `INACTIVE`. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ state?: pulumi.Input; /** * System tags for this resource. System tags are applied to resources by internal Oracle Cloud Infrastructure services. */ systemTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * The date and time the file system snapshot policy was created, expressed in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format. Example: `2016-08-25T21:10:29.600Z` */ timeCreated?: pulumi.Input; } /** * The set of arguments for constructing a FilesystemSnapshotPolicy resource. */ export interface FilesystemSnapshotPolicyArgs { /** * The availability domain that the file system snapshot policy is in. Example: `Uocm:PHX-AD-1` */ availabilityDomain: pulumi.Input; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the file system snapshot policy. */ compartmentId: pulumi.Input; /** * (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations.CostCenter": "42"}` */ definedTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * (Updatable) A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information. Example: `policy1` */ displayName?: pulumi.Input; /** * (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` */ freeformTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; isLockOverride?: pulumi.Input; /** * Locks associated with this resource. */ locks?: pulumi.Input[] | undefined>; /** * (Updatable) The prefix to apply to all snapshots created by this policy. Example: `acme` */ policyPrefix?: pulumi.Input; /** * (Updatable) The list of associated snapshot schedules. A maximum of 10 schedules can be associated with a policy. * * If using the CLI, provide the schedule as a list of JSON strings, with the list wrapped in quotation marks, i.e. ```--schedules '[{"timeZone":"UTC","period":"DAILY","hourOfDay":18},{"timeZone":"UTC","period":"HOURLY"}]'``` */ schedules?: pulumi.Input[] | undefined>; /** * (Updatable) The target state for the Filesystem Snapshot Policy. Could be set to `ACTIVE` or `INACTIVE`. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ state?: pulumi.Input; } //# sourceMappingURL=filesystemSnapshotPolicy.d.ts.map