import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * This resource provides the Snapshot resource in Oracle Cloud Infrastructure File Storage service. * Api doc link for the resource: https://docs.oracle.com/iaas/api/#/en/filestorage/latest/Snapshot * * Example terraform configs related to the resource : https://github.com/oracle/terraform-provider-oci/tree/master/examples/ * * Creates a new snapshot of the specified file system. You * can access the snapshot at `.snapshot/`. * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as oci from "@pulumi/oci"; * * const testSnapshot = new oci.filestorage.Snapshot("test_snapshot", { * fileSystemId: testFileSystem.id, * name: snapshotName, * definedTags: { * "Operations.CostCenter": "42", * }, * expirationTime: snapshotExpirationTime, * freeformTags: { * Department: "Finance", * }, * lockDurationDetails: { * lockDuration: Number(snapshotLockDurationDetailsLockDuration), * lockMode: snapshotLockDurationDetailsLockMode, * coolOffDuration: Number(snapshotLockDurationDetailsCoolOffDuration), * }, * locks: [{ * type: snapshotLocksType, * message: snapshotLocksMessage, * relatedResourceId: testResource.id, * timeCreated: snapshotLocksTimeCreated, * }], * }); * ``` * * ## Import * * Snapshots can be imported using the `id`, e.g. * * ```sh * $ pulumi import oci:FileStorage/snapshot:Snapshot test_snapshot "id" * ``` */ export declare class Snapshot extends pulumi.CustomResource { /** * Get an existing Snapshot 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?: SnapshotState, opts?: pulumi.CustomResourceOptions): Snapshot; /** * Returns true if the given object is an instance of Snapshot. 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 Snapshot; /** * (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; }>; /** * Bytes referenced only by this snapshot; deducted from compartment usage immediately upon deletion. */ readonly exclusiveBytes: pulumi.Output; /** * (Updatable) The time when this snapshot will be deleted. */ readonly expirationTime: pulumi.Output; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the file system to take a snapshot of. */ readonly fileSystemId: pulumi.Output; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the file system snapshot policy that created this snapshot. */ readonly filesystemSnapshotPolicyId: 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; }>; /** * Specifies whether the snapshot has been cloned. See [Cloning a File System](https://docs.cloud.oracle.com/iaas/Content/File/Tasks/cloningFS.htm). */ readonly isCloneSource: pulumi.Output; readonly isLockOverride: pulumi.Output; /** * Additional information about the current `lifecycleState`. */ readonly lifecycleDetails: pulumi.Output; /** * (Updatable) Details for setting a retention date or legal hold. */ readonly lockDurationDetails: pulumi.Output; /** * Locks associated with this resource. */ readonly locks: pulumi.Output; /** * Name of the snapshot. This value is immutable. It must also be unique with respect to all other non-DELETED snapshots on the associated file system. * * Avoid entering confidential information. * * Example: `Sunday` * * ** 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 name: pulumi.Output; /** * An [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) identifying the parent from which this snapshot was cloned. If this snapshot was not cloned, then the `provenanceId` is the same as the snapshot `id` value. If this snapshot was cloned, then the `provenanceId` value is the parent's `provenanceId`. See [Cloning a File System](https://docs.cloud.oracle.com/iaas/Content/File/Tasks/cloningFS.htm). */ readonly provenanceId: pulumi.Output; /** * The date and time the snapshot was taken, expressed in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format. This value might be the same or different from `timeCreated` depending on the following factors: * * If the snapshot is created in the original file system directory. * * If the snapshot is cloned from a file system. * * If the snapshot is replicated from a file system. */ readonly snapshotTime: pulumi.Output; /** * Specifies the generation type of the snapshot. */ readonly snapshotType: pulumi.Output; /** * The current state of the snapshot. */ 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 snapshot 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; /** * The date and time as per [RFC 3339](https://tools.ietf.org/html/rfc3339) when this snapshot was locked. It is a read-only property because the user should not be able to set it, it is set by our service. */ readonly timeLocked: pulumi.Output; /** * Create a Snapshot 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: SnapshotArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering Snapshot resources. */ export interface SnapshotState { /** * (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>; /** * Bytes referenced only by this snapshot; deducted from compartment usage immediately upon deletion. */ exclusiveBytes?: pulumi.Input; /** * (Updatable) The time when this snapshot will be deleted. */ expirationTime?: pulumi.Input; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the file system to take a snapshot of. */ fileSystemId?: pulumi.Input; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the file system snapshot policy that created this snapshot. */ filesystemSnapshotPolicyId?: 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>; /** * Specifies whether the snapshot has been cloned. See [Cloning a File System](https://docs.cloud.oracle.com/iaas/Content/File/Tasks/cloningFS.htm). */ isCloneSource?: pulumi.Input; isLockOverride?: pulumi.Input; /** * Additional information about the current `lifecycleState`. */ lifecycleDetails?: pulumi.Input; /** * (Updatable) Details for setting a retention date or legal hold. */ lockDurationDetails?: pulumi.Input; /** * Locks associated with this resource. */ locks?: pulumi.Input[] | undefined>; /** * Name of the snapshot. This value is immutable. It must also be unique with respect to all other non-DELETED snapshots on the associated file system. * * Avoid entering confidential information. * * Example: `Sunday` * * ** 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 */ name?: pulumi.Input; /** * An [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) identifying the parent from which this snapshot was cloned. If this snapshot was not cloned, then the `provenanceId` is the same as the snapshot `id` value. If this snapshot was cloned, then the `provenanceId` value is the parent's `provenanceId`. See [Cloning a File System](https://docs.cloud.oracle.com/iaas/Content/File/Tasks/cloningFS.htm). */ provenanceId?: pulumi.Input; /** * The date and time the snapshot was taken, expressed in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format. This value might be the same or different from `timeCreated` depending on the following factors: * * If the snapshot is created in the original file system directory. * * If the snapshot is cloned from a file system. * * If the snapshot is replicated from a file system. */ snapshotTime?: pulumi.Input; /** * Specifies the generation type of the snapshot. */ snapshotType?: pulumi.Input; /** * The current state of the snapshot. */ 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 snapshot 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 date and time as per [RFC 3339](https://tools.ietf.org/html/rfc3339) when this snapshot was locked. It is a read-only property because the user should not be able to set it, it is set by our service. */ timeLocked?: pulumi.Input; } /** * The set of arguments for constructing a Snapshot resource. */ export interface SnapshotArgs { /** * (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) The time when this snapshot will be deleted. */ expirationTime?: pulumi.Input; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the file system to take a snapshot of. */ fileSystemId: 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; /** * (Updatable) Details for setting a retention date or legal hold. */ lockDurationDetails?: pulumi.Input; /** * Locks associated with this resource. */ locks?: pulumi.Input[] | undefined>; /** * Name of the snapshot. This value is immutable. It must also be unique with respect to all other non-DELETED snapshots on the associated file system. * * Avoid entering confidential information. * * Example: `Sunday` * * ** 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 */ name?: pulumi.Input; } //# sourceMappingURL=snapshot.d.ts.map