import * as pulumi from "@pulumi/pulumi"; /** * This resource provides the Oci Cache Backup resource in Oracle Cloud Infrastructure Redis service. * Api doc link for the resource: https://docs.oracle.com/iaas/api/#/en/ocicache/latest/OciCacheBackup * * Example terraform configs related to the resource : https://github.com/oracle/terraform-provider-oci/tree/master/examples/redis * * Creates a new Oracle Cloud Infrastructure Cache Backup. * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as oci from "@pulumi/oci"; * * const testOciCacheBackup = new oci.redis.OciCacheBackup("test_oci_cache_backup", { * compartmentId: compartmentId, * displayName: ociCacheBackupDisplayName, * sourceClusterId: testRedisCluster.id, * backupSource: ociCacheBackupBackupSource, * definedTags: { * "foo-namespace.bar-key": "value", * }, * description: ociCacheBackupDescription, * freeformTags: { * "bar-key": "value", * }, * retentionPeriodInDays: Number(ociCacheBackupRetentionPeriodInDays), * }); * ``` * * ## Import * * OciCacheBackups can be imported using the `id`, e.g. * * ```sh * $ pulumi import oci:Redis/ociCacheBackup:OciCacheBackup test_oci_cache_backup "id" * ``` */ export declare class OciCacheBackup extends pulumi.CustomResource { /** * Get an existing OciCacheBackup 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?: OciCacheBackupState, opts?: pulumi.CustomResourceOptions): OciCacheBackup; /** * Returns true if the given object is an instance of OciCacheBackup. 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 OciCacheBackup; /** * Backup size in GB. */ readonly backupSizeInGbs: pulumi.Output; /** * Specifies whether the backup was created from a replica or primary node */ readonly backupSource: pulumi.Output; /** * Backup Type. */ readonly backupType: pulumi.Output; /** * The amount of memory allocated to the cluster, in gigabytes. */ readonly clusterMemoryInGbs: pulumi.Output; /** * Specifies whether the cluster is sharded or non-sharded. */ readonly clusterMode: pulumi.Output; /** * (Updatable) Compartment identifier */ readonly compartmentId: pulumi.Output; /** * (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ readonly definedTags: pulumi.Output<{ [key: string]: string; }>; /** * (Updatable) Backup description */ readonly description: pulumi.Output; /** * (Updatable) Backup display name. */ readonly displayName: pulumi.Output; /** * (Updatable) An optional property when incremented triggers Export To Object Storage. Could be set to any integer value. * * ** 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 exportToObjectStorageTrigger: pulumi.Output; /** * (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ readonly freeformTags: pulumi.Output<{ [key: string]: string; }>; /** * (Updatable) Backup retention period in days. */ readonly retentionPeriodInDays: pulumi.Output; /** * The number of shards in a sharded cluster. Only applicable when clusterMode is SHARDED. */ readonly shardCount: pulumi.Output; /** * The Oracle Cloud Infrastructure Cache engine version that the cluster is running. */ readonly softwareVersion: pulumi.Output; /** * Oracle Cloud Infrastructure Cache cluster identifier */ readonly sourceClusterId: pulumi.Output; /** * The current state of the backup. */ readonly state: pulumi.Output; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ readonly systemTags: pulumi.Output<{ [key: string]: string; }>; /** * The date and time the backup was created. An [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339) formatted datetime string. */ readonly timeCreated: pulumi.Output; /** * The date and time the backup was updated. An [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339) formatted datetime string. */ readonly timeUpdated: pulumi.Output; /** * Create a OciCacheBackup 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: OciCacheBackupArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering OciCacheBackup resources. */ export interface OciCacheBackupState { /** * Backup size in GB. */ backupSizeInGbs?: pulumi.Input; /** * Specifies whether the backup was created from a replica or primary node */ backupSource?: pulumi.Input; /** * Backup Type. */ backupType?: pulumi.Input; /** * The amount of memory allocated to the cluster, in gigabytes. */ clusterMemoryInGbs?: pulumi.Input; /** * Specifies whether the cluster is sharded or non-sharded. */ clusterMode?: pulumi.Input; /** * (Updatable) Compartment identifier */ compartmentId?: pulumi.Input; /** * (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * (Updatable) Backup description */ description?: pulumi.Input; /** * (Updatable) Backup display name. */ displayName?: pulumi.Input; /** * (Updatable) An optional property when incremented triggers Export To Object Storage. Could be set to any integer value. * * ** 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 */ exportToObjectStorageTrigger?: pulumi.Input; /** * (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * (Updatable) Backup retention period in days. */ retentionPeriodInDays?: pulumi.Input; /** * The number of shards in a sharded cluster. Only applicable when clusterMode is SHARDED. */ shardCount?: pulumi.Input; /** * The Oracle Cloud Infrastructure Cache engine version that the cluster is running. */ softwareVersion?: pulumi.Input; /** * Oracle Cloud Infrastructure Cache cluster identifier */ sourceClusterId?: pulumi.Input; /** * The current state of the backup. */ state?: pulumi.Input; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * The date and time the backup was created. An [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339) formatted datetime string. */ timeCreated?: pulumi.Input; /** * The date and time the backup was updated. An [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339) formatted datetime string. */ timeUpdated?: pulumi.Input; } /** * The set of arguments for constructing a OciCacheBackup resource. */ export interface OciCacheBackupArgs { /** * Specifies whether the backup was created from a replica or primary node */ backupSource?: pulumi.Input; /** * (Updatable) Compartment identifier */ compartmentId: pulumi.Input; /** * (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * (Updatable) Backup description */ description?: pulumi.Input; /** * (Updatable) Backup display name. */ displayName: pulumi.Input; /** * (Updatable) An optional property when incremented triggers Export To Object Storage. Could be set to any integer value. * * ** 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 */ exportToObjectStorageTrigger?: pulumi.Input; /** * (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * (Updatable) Backup retention period in days. */ retentionPeriodInDays?: pulumi.Input; /** * Oracle Cloud Infrastructure Cache cluster identifier */ sourceClusterId: pulumi.Input; } //# sourceMappingURL=ociCacheBackup.d.ts.map