Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. FileStorage
  5. FilesystemSnapshotPolicy
Oracle Cloud Infrastructure v2.28.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-oci

oci.FileStorage.FilesystemSnapshotPolicy

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.28.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-oci

This resource provides the Filesystem Snapshot Policy resource in Oracle Cloud Infrastructure File Storage service.

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

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: filesystemSnapshotPolicySchedulesDayOfMonth,
        dayOfWeek: filesystemSnapshotPolicySchedulesDayOfWeek,
        hourOfDay: filesystemSnapshotPolicySchedulesHourOfDay,
        month: filesystemSnapshotPolicySchedulesMonth,
        retentionDurationInSeconds: filesystemSnapshotPolicySchedulesRetentionDurationInSeconds,
        schedulePrefix: filesystemSnapshotPolicySchedulesSchedulePrefix,
        timeScheduleStart: filesystemSnapshotPolicySchedulesTimeScheduleStart,
    }],
});
Copy
import pulumi
import pulumi_oci as oci

test_filesystem_snapshot_policy = oci.file_storage.FilesystemSnapshotPolicy("test_filesystem_snapshot_policy",
    availability_domain=filesystem_snapshot_policy_availability_domain,
    compartment_id=compartment_id,
    defined_tags={
        "Operations.CostCenter": "42",
    },
    display_name=filesystem_snapshot_policy_display_name,
    freeform_tags={
        "Department": "Finance",
    },
    locks=[{
        "type": filesystem_snapshot_policy_locks_type,
        "message": filesystem_snapshot_policy_locks_message,
        "related_resource_id": test_resource["id"],
        "time_created": filesystem_snapshot_policy_locks_time_created,
    }],
    policy_prefix=filesystem_snapshot_policy_policy_prefix,
    schedules=[{
        "period": filesystem_snapshot_policy_schedules_period,
        "time_zone": filesystem_snapshot_policy_schedules_time_zone,
        "day_of_month": filesystem_snapshot_policy_schedules_day_of_month,
        "day_of_week": filesystem_snapshot_policy_schedules_day_of_week,
        "hour_of_day": filesystem_snapshot_policy_schedules_hour_of_day,
        "month": filesystem_snapshot_policy_schedules_month,
        "retention_duration_in_seconds": filesystem_snapshot_policy_schedules_retention_duration_in_seconds,
        "schedule_prefix": filesystem_snapshot_policy_schedules_schedule_prefix,
        "time_schedule_start": filesystem_snapshot_policy_schedules_time_schedule_start,
    }])
Copy
package main

import (
	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/filestorage"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := filestorage.NewFilesystemSnapshotPolicy(ctx, "test_filesystem_snapshot_policy", &filestorage.FilesystemSnapshotPolicyArgs{
			AvailabilityDomain: pulumi.Any(filesystemSnapshotPolicyAvailabilityDomain),
			CompartmentId:      pulumi.Any(compartmentId),
			DefinedTags: pulumi.StringMap{
				"Operations.CostCenter": pulumi.String("42"),
			},
			DisplayName: pulumi.Any(filesystemSnapshotPolicyDisplayName),
			FreeformTags: pulumi.StringMap{
				"Department": pulumi.String("Finance"),
			},
			Locks: filestorage.FilesystemSnapshotPolicyLockArray{
				&filestorage.FilesystemSnapshotPolicyLockArgs{
					Type:              pulumi.Any(filesystemSnapshotPolicyLocksType),
					Message:           pulumi.Any(filesystemSnapshotPolicyLocksMessage),
					RelatedResourceId: pulumi.Any(testResource.Id),
					TimeCreated:       pulumi.Any(filesystemSnapshotPolicyLocksTimeCreated),
				},
			},
			PolicyPrefix: pulumi.Any(filesystemSnapshotPolicyPolicyPrefix),
			Schedules: filestorage.FilesystemSnapshotPolicyScheduleArray{
				&filestorage.FilesystemSnapshotPolicyScheduleArgs{
					Period:                     pulumi.Any(filesystemSnapshotPolicySchedulesPeriod),
					TimeZone:                   pulumi.Any(filesystemSnapshotPolicySchedulesTimeZone),
					DayOfMonth:                 pulumi.Any(filesystemSnapshotPolicySchedulesDayOfMonth),
					DayOfWeek:                  pulumi.Any(filesystemSnapshotPolicySchedulesDayOfWeek),
					HourOfDay:                  pulumi.Any(filesystemSnapshotPolicySchedulesHourOfDay),
					Month:                      pulumi.Any(filesystemSnapshotPolicySchedulesMonth),
					RetentionDurationInSeconds: pulumi.Any(filesystemSnapshotPolicySchedulesRetentionDurationInSeconds),
					SchedulePrefix:             pulumi.Any(filesystemSnapshotPolicySchedulesSchedulePrefix),
					TimeScheduleStart:          pulumi.Any(filesystemSnapshotPolicySchedulesTimeScheduleStart),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testFilesystemSnapshotPolicy = new Oci.FileStorage.FilesystemSnapshotPolicy("test_filesystem_snapshot_policy", new()
    {
        AvailabilityDomain = filesystemSnapshotPolicyAvailabilityDomain,
        CompartmentId = compartmentId,
        DefinedTags = 
        {
            { "Operations.CostCenter", "42" },
        },
        DisplayName = filesystemSnapshotPolicyDisplayName,
        FreeformTags = 
        {
            { "Department", "Finance" },
        },
        Locks = new[]
        {
            new Oci.FileStorage.Inputs.FilesystemSnapshotPolicyLockArgs
            {
                Type = filesystemSnapshotPolicyLocksType,
                Message = filesystemSnapshotPolicyLocksMessage,
                RelatedResourceId = testResource.Id,
                TimeCreated = filesystemSnapshotPolicyLocksTimeCreated,
            },
        },
        PolicyPrefix = filesystemSnapshotPolicyPolicyPrefix,
        Schedules = new[]
        {
            new Oci.FileStorage.Inputs.FilesystemSnapshotPolicyScheduleArgs
            {
                Period = filesystemSnapshotPolicySchedulesPeriod,
                TimeZone = filesystemSnapshotPolicySchedulesTimeZone,
                DayOfMonth = filesystemSnapshotPolicySchedulesDayOfMonth,
                DayOfWeek = filesystemSnapshotPolicySchedulesDayOfWeek,
                HourOfDay = filesystemSnapshotPolicySchedulesHourOfDay,
                Month = filesystemSnapshotPolicySchedulesMonth,
                RetentionDurationInSeconds = filesystemSnapshotPolicySchedulesRetentionDurationInSeconds,
                SchedulePrefix = filesystemSnapshotPolicySchedulesSchedulePrefix,
                TimeScheduleStart = filesystemSnapshotPolicySchedulesTimeScheduleStart,
            },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.FileStorage.FilesystemSnapshotPolicy;
import com.pulumi.oci.FileStorage.FilesystemSnapshotPolicyArgs;
import com.pulumi.oci.FileStorage.inputs.FilesystemSnapshotPolicyLockArgs;
import com.pulumi.oci.FileStorage.inputs.FilesystemSnapshotPolicyScheduleArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var testFilesystemSnapshotPolicy = new FilesystemSnapshotPolicy("testFilesystemSnapshotPolicy", FilesystemSnapshotPolicyArgs.builder()
            .availabilityDomain(filesystemSnapshotPolicyAvailabilityDomain)
            .compartmentId(compartmentId)
            .definedTags(Map.of("Operations.CostCenter", "42"))
            .displayName(filesystemSnapshotPolicyDisplayName)
            .freeformTags(Map.of("Department", "Finance"))
            .locks(FilesystemSnapshotPolicyLockArgs.builder()
                .type(filesystemSnapshotPolicyLocksType)
                .message(filesystemSnapshotPolicyLocksMessage)
                .relatedResourceId(testResource.id())
                .timeCreated(filesystemSnapshotPolicyLocksTimeCreated)
                .build())
            .policyPrefix(filesystemSnapshotPolicyPolicyPrefix)
            .schedules(FilesystemSnapshotPolicyScheduleArgs.builder()
                .period(filesystemSnapshotPolicySchedulesPeriod)
                .timeZone(filesystemSnapshotPolicySchedulesTimeZone)
                .dayOfMonth(filesystemSnapshotPolicySchedulesDayOfMonth)
                .dayOfWeek(filesystemSnapshotPolicySchedulesDayOfWeek)
                .hourOfDay(filesystemSnapshotPolicySchedulesHourOfDay)
                .month(filesystemSnapshotPolicySchedulesMonth)
                .retentionDurationInSeconds(filesystemSnapshotPolicySchedulesRetentionDurationInSeconds)
                .schedulePrefix(filesystemSnapshotPolicySchedulesSchedulePrefix)
                .timeScheduleStart(filesystemSnapshotPolicySchedulesTimeScheduleStart)
                .build())
            .build());

    }
}
Copy
resources:
  testFilesystemSnapshotPolicy:
    type: oci:FileStorage:FilesystemSnapshotPolicy
    name: test_filesystem_snapshot_policy
    properties:
      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: ${filesystemSnapshotPolicySchedulesDayOfMonth}
          dayOfWeek: ${filesystemSnapshotPolicySchedulesDayOfWeek}
          hourOfDay: ${filesystemSnapshotPolicySchedulesHourOfDay}
          month: ${filesystemSnapshotPolicySchedulesMonth}
          retentionDurationInSeconds: ${filesystemSnapshotPolicySchedulesRetentionDurationInSeconds}
          schedulePrefix: ${filesystemSnapshotPolicySchedulesSchedulePrefix}
          timeScheduleStart: ${filesystemSnapshotPolicySchedulesTimeScheduleStart}
Copy

Create FilesystemSnapshotPolicy Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new FilesystemSnapshotPolicy(name: string, args: FilesystemSnapshotPolicyArgs, opts?: CustomResourceOptions);
@overload
def FilesystemSnapshotPolicy(resource_name: str,
                             args: FilesystemSnapshotPolicyArgs,
                             opts: Optional[ResourceOptions] = None)

@overload
def FilesystemSnapshotPolicy(resource_name: str,
                             opts: Optional[ResourceOptions] = None,
                             availability_domain: Optional[str] = None,
                             compartment_id: Optional[str] = None,
                             defined_tags: Optional[Mapping[str, str]] = None,
                             display_name: Optional[str] = None,
                             freeform_tags: Optional[Mapping[str, str]] = None,
                             is_lock_override: Optional[bool] = None,
                             locks: Optional[Sequence[_filestorage.FilesystemSnapshotPolicyLockArgs]] = None,
                             policy_prefix: Optional[str] = None,
                             schedules: Optional[Sequence[_filestorage.FilesystemSnapshotPolicyScheduleArgs]] = None,
                             state: Optional[str] = None)
func NewFilesystemSnapshotPolicy(ctx *Context, name string, args FilesystemSnapshotPolicyArgs, opts ...ResourceOption) (*FilesystemSnapshotPolicy, error)
public FilesystemSnapshotPolicy(string name, FilesystemSnapshotPolicyArgs args, CustomResourceOptions? opts = null)
public FilesystemSnapshotPolicy(String name, FilesystemSnapshotPolicyArgs args)
public FilesystemSnapshotPolicy(String name, FilesystemSnapshotPolicyArgs args, CustomResourceOptions options)

type: oci:FileStorage:FilesystemSnapshotPolicy
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. FilesystemSnapshotPolicyArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. FilesystemSnapshotPolicyArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. FilesystemSnapshotPolicyArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. FilesystemSnapshotPolicyArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. FilesystemSnapshotPolicyArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var filesystemSnapshotPolicyResource = new Oci.FileStorage.FilesystemSnapshotPolicy("filesystemSnapshotPolicyResource", new()
{
    AvailabilityDomain = "string",
    CompartmentId = "string",
    DefinedTags = 
    {
        { "string", "string" },
    },
    DisplayName = "string",
    FreeformTags = 
    {
        { "string", "string" },
    },
    IsLockOverride = false,
    Locks = new[]
    {
        new Oci.FileStorage.Inputs.FilesystemSnapshotPolicyLockArgs
        {
            Type = "string",
            Message = "string",
            RelatedResourceId = "string",
            TimeCreated = "string",
        },
    },
    PolicyPrefix = "string",
    Schedules = new[]
    {
        new Oci.FileStorage.Inputs.FilesystemSnapshotPolicyScheduleArgs
        {
            Period = "string",
            TimeZone = "string",
            DayOfMonth = 0,
            DayOfWeek = "string",
            HourOfDay = 0,
            Month = "string",
            RetentionDurationInSeconds = "string",
            SchedulePrefix = "string",
            TimeScheduleStart = "string",
        },
    },
    State = "string",
});
Copy
example, err := FileStorage.NewFilesystemSnapshotPolicy(ctx, "filesystemSnapshotPolicyResource", &FileStorage.FilesystemSnapshotPolicyArgs{
	AvailabilityDomain: pulumi.String("string"),
	CompartmentId:      pulumi.String("string"),
	DefinedTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	DisplayName: pulumi.String("string"),
	FreeformTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	IsLockOverride: pulumi.Bool(false),
	Locks: filestorage.FilesystemSnapshotPolicyLockArray{
		&filestorage.FilesystemSnapshotPolicyLockArgs{
			Type:              pulumi.String("string"),
			Message:           pulumi.String("string"),
			RelatedResourceId: pulumi.String("string"),
			TimeCreated:       pulumi.String("string"),
		},
	},
	PolicyPrefix: pulumi.String("string"),
	Schedules: filestorage.FilesystemSnapshotPolicyScheduleArray{
		&filestorage.FilesystemSnapshotPolicyScheduleArgs{
			Period:                     pulumi.String("string"),
			TimeZone:                   pulumi.String("string"),
			DayOfMonth:                 pulumi.Int(0),
			DayOfWeek:                  pulumi.String("string"),
			HourOfDay:                  pulumi.Int(0),
			Month:                      pulumi.String("string"),
			RetentionDurationInSeconds: pulumi.String("string"),
			SchedulePrefix:             pulumi.String("string"),
			TimeScheduleStart:          pulumi.String("string"),
		},
	},
	State: pulumi.String("string"),
})
Copy
var filesystemSnapshotPolicyResource = new FilesystemSnapshotPolicy("filesystemSnapshotPolicyResource", FilesystemSnapshotPolicyArgs.builder()
    .availabilityDomain("string")
    .compartmentId("string")
    .definedTags(Map.of("string", "string"))
    .displayName("string")
    .freeformTags(Map.of("string", "string"))
    .isLockOverride(false)
    .locks(FilesystemSnapshotPolicyLockArgs.builder()
        .type("string")
        .message("string")
        .relatedResourceId("string")
        .timeCreated("string")
        .build())
    .policyPrefix("string")
    .schedules(FilesystemSnapshotPolicyScheduleArgs.builder()
        .period("string")
        .timeZone("string")
        .dayOfMonth(0)
        .dayOfWeek("string")
        .hourOfDay(0)
        .month("string")
        .retentionDurationInSeconds("string")
        .schedulePrefix("string")
        .timeScheduleStart("string")
        .build())
    .state("string")
    .build());
Copy
filesystem_snapshot_policy_resource = oci.file_storage.FilesystemSnapshotPolicy("filesystemSnapshotPolicyResource",
    availability_domain="string",
    compartment_id="string",
    defined_tags={
        "string": "string",
    },
    display_name="string",
    freeform_tags={
        "string": "string",
    },
    is_lock_override=False,
    locks=[{
        "type": "string",
        "message": "string",
        "related_resource_id": "string",
        "time_created": "string",
    }],
    policy_prefix="string",
    schedules=[{
        "period": "string",
        "time_zone": "string",
        "day_of_month": 0,
        "day_of_week": "string",
        "hour_of_day": 0,
        "month": "string",
        "retention_duration_in_seconds": "string",
        "schedule_prefix": "string",
        "time_schedule_start": "string",
    }],
    state="string")
Copy
const filesystemSnapshotPolicyResource = new oci.filestorage.FilesystemSnapshotPolicy("filesystemSnapshotPolicyResource", {
    availabilityDomain: "string",
    compartmentId: "string",
    definedTags: {
        string: "string",
    },
    displayName: "string",
    freeformTags: {
        string: "string",
    },
    isLockOverride: false,
    locks: [{
        type: "string",
        message: "string",
        relatedResourceId: "string",
        timeCreated: "string",
    }],
    policyPrefix: "string",
    schedules: [{
        period: "string",
        timeZone: "string",
        dayOfMonth: 0,
        dayOfWeek: "string",
        hourOfDay: 0,
        month: "string",
        retentionDurationInSeconds: "string",
        schedulePrefix: "string",
        timeScheduleStart: "string",
    }],
    state: "string",
});
Copy
type: oci:FileStorage:FilesystemSnapshotPolicy
properties:
    availabilityDomain: string
    compartmentId: string
    definedTags:
        string: string
    displayName: string
    freeformTags:
        string: string
    isLockOverride: false
    locks:
        - message: string
          relatedResourceId: string
          timeCreated: string
          type: string
    policyPrefix: string
    schedules:
        - dayOfMonth: 0
          dayOfWeek: string
          hourOfDay: 0
          month: string
          period: string
          retentionDurationInSeconds: string
          schedulePrefix: string
          timeScheduleStart: string
          timeZone: string
    state: string
Copy

FilesystemSnapshotPolicy Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The FilesystemSnapshotPolicy resource accepts the following input properties:

AvailabilityDomain
This property is required.
Changes to this property will trigger replacement.
string
The availability domain that the file system snapshot policy is in. Example: Uocm:PHX-AD-1
CompartmentId This property is required. string
(Updatable) The OCID of the compartment that contains the file system snapshot policy.
DefinedTags Dictionary<string, string>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
DisplayName string
(Updatable) A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information. Example: policy1
FreeformTags Dictionary<string, string>
(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. Example: {"Department": "Finance"}
IsLockOverride bool
Locks Changes to this property will trigger replacement. List<FilesystemSnapshotPolicyLock>
Locks associated with this resource.
PolicyPrefix string
(Updatable) The prefix to apply to all snapshots created by this policy. Example: acme
Schedules List<FilesystemSnapshotPolicySchedule>

(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"}]'

State string

(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

AvailabilityDomain
This property is required.
Changes to this property will trigger replacement.
string
The availability domain that the file system snapshot policy is in. Example: Uocm:PHX-AD-1
CompartmentId This property is required. string
(Updatable) The OCID of the compartment that contains the file system snapshot policy.
DefinedTags map[string]string
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
DisplayName string
(Updatable) A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information. Example: policy1
FreeformTags map[string]string
(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. Example: {"Department": "Finance"}
IsLockOverride bool
Locks Changes to this property will trigger replacement. []FilesystemSnapshotPolicyLockArgs
Locks associated with this resource.
PolicyPrefix string
(Updatable) The prefix to apply to all snapshots created by this policy. Example: acme
Schedules []FilesystemSnapshotPolicyScheduleArgs

(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"}]'

State string

(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

availabilityDomain
This property is required.
Changes to this property will trigger replacement.
String
The availability domain that the file system snapshot policy is in. Example: Uocm:PHX-AD-1
compartmentId This property is required. String
(Updatable) The OCID of the compartment that contains the file system snapshot policy.
definedTags Map<String,String>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
displayName String
(Updatable) A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information. Example: policy1
freeformTags Map<String,String>
(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. Example: {"Department": "Finance"}
isLockOverride Boolean
locks Changes to this property will trigger replacement. List<FilesystemSnapshotPolicyLock>
Locks associated with this resource.
policyPrefix String
(Updatable) The prefix to apply to all snapshots created by this policy. Example: acme
schedules List<FilesystemSnapshotPolicySchedule>

(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"}]'

state String

(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

availabilityDomain
This property is required.
Changes to this property will trigger replacement.
string
The availability domain that the file system snapshot policy is in. Example: Uocm:PHX-AD-1
compartmentId This property is required. string
(Updatable) The OCID of the compartment that contains the file system snapshot policy.
definedTags {[key: string]: string}
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
displayName string
(Updatable) A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information. Example: policy1
freeformTags {[key: string]: string}
(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. Example: {"Department": "Finance"}
isLockOverride boolean
locks Changes to this property will trigger replacement. FilesystemSnapshotPolicyLock[]
Locks associated with this resource.
policyPrefix string
(Updatable) The prefix to apply to all snapshots created by this policy. Example: acme
schedules FilesystemSnapshotPolicySchedule[]

(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"}]'

state string

(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

availability_domain
This property is required.
Changes to this property will trigger replacement.
str
The availability domain that the file system snapshot policy is in. Example: Uocm:PHX-AD-1
compartment_id This property is required. str
(Updatable) The OCID of the compartment that contains the file system snapshot policy.
defined_tags Mapping[str, str]
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
display_name str
(Updatable) A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information. Example: policy1
freeform_tags Mapping[str, str]
(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. Example: {"Department": "Finance"}
is_lock_override bool
locks Changes to this property will trigger replacement. Sequence[filestorage.FilesystemSnapshotPolicyLockArgs]
Locks associated with this resource.
policy_prefix str
(Updatable) The prefix to apply to all snapshots created by this policy. Example: acme
schedules Sequence[filestorage.FilesystemSnapshotPolicyScheduleArgs]

(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"}]'

state str

(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

availabilityDomain
This property is required.
Changes to this property will trigger replacement.
String
The availability domain that the file system snapshot policy is in. Example: Uocm:PHX-AD-1
compartmentId This property is required. String
(Updatable) The OCID of the compartment that contains the file system snapshot policy.
definedTags Map<String>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
displayName String
(Updatable) A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information. Example: policy1
freeformTags Map<String>
(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. Example: {"Department": "Finance"}
isLockOverride Boolean
locks Changes to this property will trigger replacement. List<Property Map>
Locks associated with this resource.
policyPrefix String
(Updatable) The prefix to apply to all snapshots created by this policy. Example: acme
schedules List<Property Map>

(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"}]'

state String

(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

Outputs

All input properties are implicitly available as output properties. Additionally, the FilesystemSnapshotPolicy resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
SystemTags Dictionary<string, string>
System tags for this resource. System tags are applied to resources by internal Oracle Cloud Infrastructure services.
TimeCreated string
The date and time the file system snapshot policy was created, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
Id string
The provider-assigned unique ID for this managed resource.
SystemTags map[string]string
System tags for this resource. System tags are applied to resources by internal Oracle Cloud Infrastructure services.
TimeCreated string
The date and time the file system snapshot policy was created, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
id String
The provider-assigned unique ID for this managed resource.
systemTags Map<String,String>
System tags for this resource. System tags are applied to resources by internal Oracle Cloud Infrastructure services.
timeCreated String
The date and time the file system snapshot policy was created, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
id string
The provider-assigned unique ID for this managed resource.
systemTags {[key: string]: string}
System tags for this resource. System tags are applied to resources by internal Oracle Cloud Infrastructure services.
timeCreated string
The date and time the file system snapshot policy was created, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
id str
The provider-assigned unique ID for this managed resource.
system_tags Mapping[str, str]
System tags for this resource. System tags are applied to resources by internal Oracle Cloud Infrastructure services.
time_created str
The date and time the file system snapshot policy was created, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
id String
The provider-assigned unique ID for this managed resource.
systemTags Map<String>
System tags for this resource. System tags are applied to resources by internal Oracle Cloud Infrastructure services.
timeCreated String
The date and time the file system snapshot policy was created, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z

Look up Existing FilesystemSnapshotPolicy Resource

Get an existing FilesystemSnapshotPolicy resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: FilesystemSnapshotPolicyState, opts?: CustomResourceOptions): FilesystemSnapshotPolicy
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        availability_domain: Optional[str] = None,
        compartment_id: Optional[str] = None,
        defined_tags: Optional[Mapping[str, str]] = None,
        display_name: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, str]] = None,
        is_lock_override: Optional[bool] = None,
        locks: Optional[Sequence[_filestorage.FilesystemSnapshotPolicyLockArgs]] = None,
        policy_prefix: Optional[str] = None,
        schedules: Optional[Sequence[_filestorage.FilesystemSnapshotPolicyScheduleArgs]] = None,
        state: Optional[str] = None,
        system_tags: Optional[Mapping[str, str]] = None,
        time_created: Optional[str] = None) -> FilesystemSnapshotPolicy
func GetFilesystemSnapshotPolicy(ctx *Context, name string, id IDInput, state *FilesystemSnapshotPolicyState, opts ...ResourceOption) (*FilesystemSnapshotPolicy, error)
public static FilesystemSnapshotPolicy Get(string name, Input<string> id, FilesystemSnapshotPolicyState? state, CustomResourceOptions? opts = null)
public static FilesystemSnapshotPolicy get(String name, Output<String> id, FilesystemSnapshotPolicyState state, CustomResourceOptions options)
resources:  _:    type: oci:FileStorage:FilesystemSnapshotPolicy    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
AvailabilityDomain Changes to this property will trigger replacement. string
The availability domain that the file system snapshot policy is in. Example: Uocm:PHX-AD-1
CompartmentId string
(Updatable) The OCID of the compartment that contains the file system snapshot policy.
DefinedTags Dictionary<string, string>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
DisplayName string
(Updatable) A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information. Example: policy1
FreeformTags Dictionary<string, string>
(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. Example: {"Department": "Finance"}
IsLockOverride bool
Locks Changes to this property will trigger replacement. List<FilesystemSnapshotPolicyLock>
Locks associated with this resource.
PolicyPrefix string
(Updatable) The prefix to apply to all snapshots created by this policy. Example: acme
Schedules List<FilesystemSnapshotPolicySchedule>

(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"}]'

State string

(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

SystemTags Dictionary<string, string>
System tags for this resource. System tags are applied to resources by internal Oracle Cloud Infrastructure services.
TimeCreated string
The date and time the file system snapshot policy was created, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
AvailabilityDomain Changes to this property will trigger replacement. string
The availability domain that the file system snapshot policy is in. Example: Uocm:PHX-AD-1
CompartmentId string
(Updatable) The OCID of the compartment that contains the file system snapshot policy.
DefinedTags map[string]string
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
DisplayName string
(Updatable) A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information. Example: policy1
FreeformTags map[string]string
(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. Example: {"Department": "Finance"}
IsLockOverride bool
Locks Changes to this property will trigger replacement. []FilesystemSnapshotPolicyLockArgs
Locks associated with this resource.
PolicyPrefix string
(Updatable) The prefix to apply to all snapshots created by this policy. Example: acme
Schedules []FilesystemSnapshotPolicyScheduleArgs

(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"}]'

State string

(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

SystemTags map[string]string
System tags for this resource. System tags are applied to resources by internal Oracle Cloud Infrastructure services.
TimeCreated string
The date and time the file system snapshot policy was created, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
availabilityDomain Changes to this property will trigger replacement. String
The availability domain that the file system snapshot policy is in. Example: Uocm:PHX-AD-1
compartmentId String
(Updatable) The OCID of the compartment that contains the file system snapshot policy.
definedTags Map<String,String>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
displayName String
(Updatable) A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information. Example: policy1
freeformTags Map<String,String>
(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. Example: {"Department": "Finance"}
isLockOverride Boolean
locks Changes to this property will trigger replacement. List<FilesystemSnapshotPolicyLock>
Locks associated with this resource.
policyPrefix String
(Updatable) The prefix to apply to all snapshots created by this policy. Example: acme
schedules List<FilesystemSnapshotPolicySchedule>

(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"}]'

state String

(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

systemTags Map<String,String>
System tags for this resource. System tags are applied to resources by internal Oracle Cloud Infrastructure services.
timeCreated String
The date and time the file system snapshot policy was created, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
availabilityDomain Changes to this property will trigger replacement. string
The availability domain that the file system snapshot policy is in. Example: Uocm:PHX-AD-1
compartmentId string
(Updatable) The OCID of the compartment that contains the file system snapshot policy.
definedTags {[key: string]: string}
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
displayName string
(Updatable) A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information. Example: policy1
freeformTags {[key: string]: string}
(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. Example: {"Department": "Finance"}
isLockOverride boolean
locks Changes to this property will trigger replacement. FilesystemSnapshotPolicyLock[]
Locks associated with this resource.
policyPrefix string
(Updatable) The prefix to apply to all snapshots created by this policy. Example: acme
schedules FilesystemSnapshotPolicySchedule[]

(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"}]'

state string

(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

systemTags {[key: string]: string}
System tags for this resource. System tags are applied to resources by internal Oracle Cloud Infrastructure services.
timeCreated string
The date and time the file system snapshot policy was created, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
availability_domain Changes to this property will trigger replacement. str
The availability domain that the file system snapshot policy is in. Example: Uocm:PHX-AD-1
compartment_id str
(Updatable) The OCID of the compartment that contains the file system snapshot policy.
defined_tags Mapping[str, str]
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
display_name str
(Updatable) A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information. Example: policy1
freeform_tags Mapping[str, str]
(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. Example: {"Department": "Finance"}
is_lock_override bool
locks Changes to this property will trigger replacement. Sequence[filestorage.FilesystemSnapshotPolicyLockArgs]
Locks associated with this resource.
policy_prefix str
(Updatable) The prefix to apply to all snapshots created by this policy. Example: acme
schedules Sequence[filestorage.FilesystemSnapshotPolicyScheduleArgs]

(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"}]'

state str

(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

system_tags Mapping[str, str]
System tags for this resource. System tags are applied to resources by internal Oracle Cloud Infrastructure services.
time_created str
The date and time the file system snapshot policy was created, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
availabilityDomain Changes to this property will trigger replacement. String
The availability domain that the file system snapshot policy is in. Example: Uocm:PHX-AD-1
compartmentId String
(Updatable) The OCID of the compartment that contains the file system snapshot policy.
definedTags Map<String>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
displayName String
(Updatable) A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information. Example: policy1
freeformTags Map<String>
(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. Example: {"Department": "Finance"}
isLockOverride Boolean
locks Changes to this property will trigger replacement. List<Property Map>
Locks associated with this resource.
policyPrefix String
(Updatable) The prefix to apply to all snapshots created by this policy. Example: acme
schedules List<Property Map>

(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"}]'

state String

(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

systemTags Map<String>
System tags for this resource. System tags are applied to resources by internal Oracle Cloud Infrastructure services.
timeCreated String
The date and time the file system snapshot policy was created, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z

Supporting Types

FilesystemSnapshotPolicyLock
, FilesystemSnapshotPolicyLockArgs

Type
This property is required.
Changes to this property will trigger replacement.
string
Type of the lock.
Message Changes to this property will trigger replacement. string
A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
RelatedResourceId Changes to this property will trigger replacement. string
The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
TimeCreated Changes to this property will trigger replacement. string
When the lock was created.
Type
This property is required.
Changes to this property will trigger replacement.
string
Type of the lock.
Message Changes to this property will trigger replacement. string
A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
RelatedResourceId Changes to this property will trigger replacement. string
The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
TimeCreated Changes to this property will trigger replacement. string
When the lock was created.
type
This property is required.
Changes to this property will trigger replacement.
String
Type of the lock.
message Changes to this property will trigger replacement. String
A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
relatedResourceId Changes to this property will trigger replacement. String
The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
timeCreated Changes to this property will trigger replacement. String
When the lock was created.
type
This property is required.
Changes to this property will trigger replacement.
string
Type of the lock.
message Changes to this property will trigger replacement. string
A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
relatedResourceId Changes to this property will trigger replacement. string
The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
timeCreated Changes to this property will trigger replacement. string
When the lock was created.
type
This property is required.
Changes to this property will trigger replacement.
str
Type of the lock.
message Changes to this property will trigger replacement. str
A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
related_resource_id Changes to this property will trigger replacement. str
The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
time_created Changes to this property will trigger replacement. str
When the lock was created.
type
This property is required.
Changes to this property will trigger replacement.
String
Type of the lock.
message Changes to this property will trigger replacement. String
A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
relatedResourceId Changes to this property will trigger replacement. String
The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
timeCreated Changes to this property will trigger replacement. String
When the lock was created.

FilesystemSnapshotPolicySchedule
, FilesystemSnapshotPolicyScheduleArgs

Period This property is required. string
(Updatable) The frequency of scheduled snapshots.
TimeZone This property is required. string
(Updatable) Time zone used for scheduling the snapshot.
DayOfMonth int
(Updatable) The day of the month to create a scheduled snapshot. If the day does not exist for the month, snapshot creation will be skipped. Used for MONTHLY and YEARLY snapshot schedules. If not set, the system chooses a value at creation time.
DayOfWeek string
(Updatable) The day of the week to create a scheduled snapshot. Used for WEEKLY snapshot schedules. If not set, the system chooses a value at creation time.
HourOfDay int
(Updatable) The hour of the day to create a DAILY, WEEKLY, MONTHLY, or YEARLY snapshot. If not set, the system chooses a value at creation time.
Month string
(Updatable) The month to create a scheduled snapshot. Used only for YEARLY snapshot schedules. If not set, the system chooses a value at creation time.
RetentionDurationInSeconds string
(Updatable) The number of seconds to retain snapshots created with this schedule. Snapshot expiration time will not be set if this value is empty.
SchedulePrefix string
(Updatable) A name prefix to be applied to snapshots created by this schedule. Example: compliance1
TimeScheduleStart string
(Updatable) The starting point used to begin the scheduling of the snapshots based upon recurrence string in RFC 3339 timestamp format. If no timeScheduleStart is provided, the value will be set to the time when the schedule was created.
Period This property is required. string
(Updatable) The frequency of scheduled snapshots.
TimeZone This property is required. string
(Updatable) Time zone used for scheduling the snapshot.
DayOfMonth int
(Updatable) The day of the month to create a scheduled snapshot. If the day does not exist for the month, snapshot creation will be skipped. Used for MONTHLY and YEARLY snapshot schedules. If not set, the system chooses a value at creation time.
DayOfWeek string
(Updatable) The day of the week to create a scheduled snapshot. Used for WEEKLY snapshot schedules. If not set, the system chooses a value at creation time.
HourOfDay int
(Updatable) The hour of the day to create a DAILY, WEEKLY, MONTHLY, or YEARLY snapshot. If not set, the system chooses a value at creation time.
Month string
(Updatable) The month to create a scheduled snapshot. Used only for YEARLY snapshot schedules. If not set, the system chooses a value at creation time.
RetentionDurationInSeconds string
(Updatable) The number of seconds to retain snapshots created with this schedule. Snapshot expiration time will not be set if this value is empty.
SchedulePrefix string
(Updatable) A name prefix to be applied to snapshots created by this schedule. Example: compliance1
TimeScheduleStart string
(Updatable) The starting point used to begin the scheduling of the snapshots based upon recurrence string in RFC 3339 timestamp format. If no timeScheduleStart is provided, the value will be set to the time when the schedule was created.
period This property is required. String
(Updatable) The frequency of scheduled snapshots.
timeZone This property is required. String
(Updatable) Time zone used for scheduling the snapshot.
dayOfMonth Integer
(Updatable) The day of the month to create a scheduled snapshot. If the day does not exist for the month, snapshot creation will be skipped. Used for MONTHLY and YEARLY snapshot schedules. If not set, the system chooses a value at creation time.
dayOfWeek String
(Updatable) The day of the week to create a scheduled snapshot. Used for WEEKLY snapshot schedules. If not set, the system chooses a value at creation time.
hourOfDay Integer
(Updatable) The hour of the day to create a DAILY, WEEKLY, MONTHLY, or YEARLY snapshot. If not set, the system chooses a value at creation time.
month String
(Updatable) The month to create a scheduled snapshot. Used only for YEARLY snapshot schedules. If not set, the system chooses a value at creation time.
retentionDurationInSeconds String
(Updatable) The number of seconds to retain snapshots created with this schedule. Snapshot expiration time will not be set if this value is empty.
schedulePrefix String
(Updatable) A name prefix to be applied to snapshots created by this schedule. Example: compliance1
timeScheduleStart String
(Updatable) The starting point used to begin the scheduling of the snapshots based upon recurrence string in RFC 3339 timestamp format. If no timeScheduleStart is provided, the value will be set to the time when the schedule was created.
period This property is required. string
(Updatable) The frequency of scheduled snapshots.
timeZone This property is required. string
(Updatable) Time zone used for scheduling the snapshot.
dayOfMonth number
(Updatable) The day of the month to create a scheduled snapshot. If the day does not exist for the month, snapshot creation will be skipped. Used for MONTHLY and YEARLY snapshot schedules. If not set, the system chooses a value at creation time.
dayOfWeek string
(Updatable) The day of the week to create a scheduled snapshot. Used for WEEKLY snapshot schedules. If not set, the system chooses a value at creation time.
hourOfDay number
(Updatable) The hour of the day to create a DAILY, WEEKLY, MONTHLY, or YEARLY snapshot. If not set, the system chooses a value at creation time.
month string
(Updatable) The month to create a scheduled snapshot. Used only for YEARLY snapshot schedules. If not set, the system chooses a value at creation time.
retentionDurationInSeconds string
(Updatable) The number of seconds to retain snapshots created with this schedule. Snapshot expiration time will not be set if this value is empty.
schedulePrefix string
(Updatable) A name prefix to be applied to snapshots created by this schedule. Example: compliance1
timeScheduleStart string
(Updatable) The starting point used to begin the scheduling of the snapshots based upon recurrence string in RFC 3339 timestamp format. If no timeScheduleStart is provided, the value will be set to the time when the schedule was created.
period This property is required. str
(Updatable) The frequency of scheduled snapshots.
time_zone This property is required. str
(Updatable) Time zone used for scheduling the snapshot.
day_of_month int
(Updatable) The day of the month to create a scheduled snapshot. If the day does not exist for the month, snapshot creation will be skipped. Used for MONTHLY and YEARLY snapshot schedules. If not set, the system chooses a value at creation time.
day_of_week str
(Updatable) The day of the week to create a scheduled snapshot. Used for WEEKLY snapshot schedules. If not set, the system chooses a value at creation time.
hour_of_day int
(Updatable) The hour of the day to create a DAILY, WEEKLY, MONTHLY, or YEARLY snapshot. If not set, the system chooses a value at creation time.
month str
(Updatable) The month to create a scheduled snapshot. Used only for YEARLY snapshot schedules. If not set, the system chooses a value at creation time.
retention_duration_in_seconds str
(Updatable) The number of seconds to retain snapshots created with this schedule. Snapshot expiration time will not be set if this value is empty.
schedule_prefix str
(Updatable) A name prefix to be applied to snapshots created by this schedule. Example: compliance1
time_schedule_start str
(Updatable) The starting point used to begin the scheduling of the snapshots based upon recurrence string in RFC 3339 timestamp format. If no timeScheduleStart is provided, the value will be set to the time when the schedule was created.
period This property is required. String
(Updatable) The frequency of scheduled snapshots.
timeZone This property is required. String
(Updatable) Time zone used for scheduling the snapshot.
dayOfMonth Number
(Updatable) The day of the month to create a scheduled snapshot. If the day does not exist for the month, snapshot creation will be skipped. Used for MONTHLY and YEARLY snapshot schedules. If not set, the system chooses a value at creation time.
dayOfWeek String
(Updatable) The day of the week to create a scheduled snapshot. Used for WEEKLY snapshot schedules. If not set, the system chooses a value at creation time.
hourOfDay Number
(Updatable) The hour of the day to create a DAILY, WEEKLY, MONTHLY, or YEARLY snapshot. If not set, the system chooses a value at creation time.
month String
(Updatable) The month to create a scheduled snapshot. Used only for YEARLY snapshot schedules. If not set, the system chooses a value at creation time.
retentionDurationInSeconds String
(Updatable) The number of seconds to retain snapshots created with this schedule. Snapshot expiration time will not be set if this value is empty.
schedulePrefix String
(Updatable) A name prefix to be applied to snapshots created by this schedule. Example: compliance1
timeScheduleStart String
(Updatable) The starting point used to begin the scheduling of the snapshots based upon recurrence string in RFC 3339 timestamp format. If no timeScheduleStart is provided, the value will be set to the time when the schedule was created.

Import

FilesystemSnapshotPolicies can be imported using the id, e.g.

$ pulumi import oci:FileStorage/filesystemSnapshotPolicy:FilesystemSnapshotPolicy test_filesystem_snapshot_policy "id"
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
oci pulumi/pulumi-oci
License
Apache-2.0
Notes
This Pulumi package is based on the oci Terraform Provider.
Oracle Cloud Infrastructure v2.28.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-oci