Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi
oci.FileStorage.getFilesystemSnapshotPolicy
Explore with Pulumi AI
This data source provides details about a specific Filesystem Snapshot Policy resource in Oracle Cloud Infrastructure File Storage service.
Gets the specified file system snapshot policy’s information.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testFilesystemSnapshotPolicy = oci.FileStorage.getFilesystemSnapshotPolicy({
filesystemSnapshotPolicyId: testFilesystemSnapshotPolicyOciFileStorageFilesystemSnapshotPolicy.id,
});
import pulumi
import pulumi_oci as oci
test_filesystem_snapshot_policy = oci.FileStorage.get_filesystem_snapshot_policy(filesystem_snapshot_policy_id=test_filesystem_snapshot_policy_oci_file_storage_filesystem_snapshot_policy["id"])
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.GetFilesystemSnapshotPolicy(ctx, &filestorage.GetFilesystemSnapshotPolicyArgs{
FilesystemSnapshotPolicyId: testFilesystemSnapshotPolicyOciFileStorageFilesystemSnapshotPolicy.Id,
}, nil)
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;
return await Deployment.RunAsync(() =>
{
var testFilesystemSnapshotPolicy = Oci.FileStorage.GetFilesystemSnapshotPolicy.Invoke(new()
{
FilesystemSnapshotPolicyId = testFilesystemSnapshotPolicyOciFileStorageFilesystemSnapshotPolicy.Id,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.FileStorage.FileStorageFunctions;
import com.pulumi.oci.FileStorage.inputs.GetFilesystemSnapshotPolicyArgs;
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) {
final var testFilesystemSnapshotPolicy = FileStorageFunctions.getFilesystemSnapshotPolicy(GetFilesystemSnapshotPolicyArgs.builder()
.filesystemSnapshotPolicyId(testFilesystemSnapshotPolicyOciFileStorageFilesystemSnapshotPolicy.id())
.build());
}
}
variables:
testFilesystemSnapshotPolicy:
fn::invoke:
Function: oci:FileStorage:getFilesystemSnapshotPolicy
Arguments:
filesystemSnapshotPolicyId: ${testFilesystemSnapshotPolicyOciFileStorageFilesystemSnapshotPolicy.id}
Using getFilesystemSnapshotPolicy
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getFilesystemSnapshotPolicy(args: GetFilesystemSnapshotPolicyArgs, opts?: InvokeOptions): Promise<GetFilesystemSnapshotPolicyResult>
function getFilesystemSnapshotPolicyOutput(args: GetFilesystemSnapshotPolicyOutputArgs, opts?: InvokeOptions): Output<GetFilesystemSnapshotPolicyResult>
def get_filesystem_snapshot_policy(filesystem_snapshot_policy_id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetFilesystemSnapshotPolicyResult
def get_filesystem_snapshot_policy_output(filesystem_snapshot_policy_id: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetFilesystemSnapshotPolicyResult]
func GetFilesystemSnapshotPolicy(ctx *Context, args *GetFilesystemSnapshotPolicyArgs, opts ...InvokeOption) (*GetFilesystemSnapshotPolicyResult, error)
func GetFilesystemSnapshotPolicyOutput(ctx *Context, args *GetFilesystemSnapshotPolicyOutputArgs, opts ...InvokeOption) GetFilesystemSnapshotPolicyResultOutput
> Note: This function is named GetFilesystemSnapshotPolicy
in the Go SDK.
public static class GetFilesystemSnapshotPolicy
{
public static Task<GetFilesystemSnapshotPolicyResult> InvokeAsync(GetFilesystemSnapshotPolicyArgs args, InvokeOptions? opts = null)
public static Output<GetFilesystemSnapshotPolicyResult> Invoke(GetFilesystemSnapshotPolicyInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetFilesystemSnapshotPolicyResult> getFilesystemSnapshotPolicy(GetFilesystemSnapshotPolicyArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: oci:FileStorage/getFilesystemSnapshotPolicy:getFilesystemSnapshotPolicy
arguments:
# arguments dictionary
The following arguments are supported:
- Filesystem
Snapshot stringPolicy Id - The OCID of the file system snapshot policy.
- Filesystem
Snapshot stringPolicy Id - The OCID of the file system snapshot policy.
- filesystem
Snapshot StringPolicy Id - The OCID of the file system snapshot policy.
- filesystem
Snapshot stringPolicy Id - The OCID of the file system snapshot policy.
- filesystem_
snapshot_ strpolicy_ id - The OCID of the file system snapshot policy.
- filesystem
Snapshot StringPolicy Id - The OCID of the file system snapshot policy.
getFilesystemSnapshotPolicy Result
The following output properties are available:
- Availability
Domain string - The availability domain that the file system snapshot policy is in. May be unset using a blank or NULL value. Example:
Uocm:PHX-AD-2
- Compartment
Id string - The OCID of the compartment that contains the file system snapshot policy.
- Dictionary<string, string>
- 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 string - A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information. Example:
My Filesystem Snapshot Policy
- Filesystem
Snapshot stringPolicy Id - Dictionary<string, string>
- 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"}
- Id string
- The OCID of the file system snapshot policy.
- Is
Lock boolOverride - Locks
List<Get
Filesystem Snapshot Policy Lock> - Locks associated with this resource.
- Policy
Prefix string - The prefix to apply to all snapshots created by this policy. Example:
acme
- Schedules
List<Get
Filesystem Snapshot Policy Schedule> - The list of associated snapshot schedules. A maximum of 10 schedules can be associated with a policy.
- State string
- The current state of this file system snapshot policy.
- Time
Created 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 string - The availability domain that the file system snapshot policy is in. May be unset using a blank or NULL value. Example:
Uocm:PHX-AD-2
- Compartment
Id string - The OCID of the compartment that contains the file system snapshot policy.
- map[string]string
- 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 string - A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information. Example:
My Filesystem Snapshot Policy
- Filesystem
Snapshot stringPolicy Id - map[string]string
- 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"}
- Id string
- The OCID of the file system snapshot policy.
- Is
Lock boolOverride - Locks
[]Get
Filesystem Snapshot Policy Lock - Locks associated with this resource.
- Policy
Prefix string - The prefix to apply to all snapshots created by this policy. Example:
acme
- Schedules
[]Get
Filesystem Snapshot Policy Schedule - The list of associated snapshot schedules. A maximum of 10 schedules can be associated with a policy.
- State string
- The current state of this file system snapshot policy.
- Time
Created 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 String - The availability domain that the file system snapshot policy is in. May be unset using a blank or NULL value. Example:
Uocm:PHX-AD-2
- compartment
Id String - The OCID of the compartment that contains the file system snapshot policy.
- Map<String,String>
- 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 String - A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information. Example:
My Filesystem Snapshot Policy
- filesystem
Snapshot StringPolicy Id - Map<String,String>
- 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"}
- id String
- The OCID of the file system snapshot policy.
- is
Lock BooleanOverride - locks
List<Get
Filesystem Snapshot Policy Lock> - Locks associated with this resource.
- policy
Prefix String - The prefix to apply to all snapshots created by this policy. Example:
acme
- schedules
List<Get
Filesystem Snapshot Policy Schedule> - The list of associated snapshot schedules. A maximum of 10 schedules can be associated with a policy.
- state String
- The current state of this file system snapshot policy.
- time
Created 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 string - The availability domain that the file system snapshot policy is in. May be unset using a blank or NULL value. Example:
Uocm:PHX-AD-2
- compartment
Id string - The OCID of the compartment that contains the file system snapshot policy.
- {[key: string]: string}
- 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 string - A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information. Example:
My Filesystem Snapshot Policy
- filesystem
Snapshot stringPolicy Id - {[key: string]: string}
- 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"}
- id string
- The OCID of the file system snapshot policy.
- is
Lock booleanOverride - locks
Get
Filesystem Snapshot Policy Lock[] - Locks associated with this resource.
- policy
Prefix string - The prefix to apply to all snapshots created by this policy. Example:
acme
- schedules
Get
Filesystem Snapshot Policy Schedule[] - The list of associated snapshot schedules. A maximum of 10 schedules can be associated with a policy.
- state string
- The current state of this file system snapshot policy.
- time
Created 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 str - The availability domain that the file system snapshot policy is in. May be unset using a blank or NULL value. Example:
Uocm:PHX-AD-2
- compartment_
id str - The OCID of the compartment that contains the file system snapshot policy.
- Mapping[str, str]
- 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 - A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information. Example:
My Filesystem Snapshot Policy
- filesystem_
snapshot_ strpolicy_ id - Mapping[str, str]
- 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"}
- id str
- The OCID of the file system snapshot policy.
- is_
lock_ booloverride - locks
Sequence[filestorage.
Get Filesystem Snapshot Policy Lock] - Locks associated with this resource.
- policy_
prefix str - The prefix to apply to all snapshots created by this policy. Example:
acme
- schedules
Sequence[filestorage.
Get Filesystem Snapshot Policy Schedule] - The list of associated snapshot schedules. A maximum of 10 schedules can be associated with a policy.
- state str
- The current state of this file system snapshot policy.
- 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
- availability
Domain String - The availability domain that the file system snapshot policy is in. May be unset using a blank or NULL value. Example:
Uocm:PHX-AD-2
- compartment
Id String - The OCID of the compartment that contains the file system snapshot policy.
- Map<String>
- 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 String - A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information. Example:
My Filesystem Snapshot Policy
- filesystem
Snapshot StringPolicy Id - Map<String>
- 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"}
- id String
- The OCID of the file system snapshot policy.
- is
Lock BooleanOverride - locks List<Property Map>
- Locks associated with this resource.
- policy
Prefix String - The prefix to apply to all snapshots created by this policy. Example:
acme
- schedules List<Property Map>
- The list of associated snapshot schedules. A maximum of 10 schedules can be associated with a policy.
- state String
- The current state of this file system snapshot policy.
- time
Created 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
GetFilesystemSnapshotPolicyLock
- Message string
- A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
- string
- The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
- Time
Created 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
- Type string
- Type of the lock.
- Message string
- A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
- string
- The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
- Time
Created 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
- Type string
- Type of the lock.
- message String
- A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
- String
- The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
- time
Created 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
- type String
- Type of the lock.
- message string
- A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
- string
- The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
- time
Created 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
- type string
- Type of the lock.
- message str
- A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
- str
- The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
- 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
- type str
- Type of the lock.
- message String
- A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
- String
- The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
- time
Created 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
- type String
- Type of the lock.
GetFilesystemSnapshotPolicySchedule
- Day
Of intMonth - 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 stringWeek - 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 intDay - 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
- The month to create a scheduled snapshot. Used only for YEARLY snapshot schedules. If not set, the system chooses a value at creation time.
- Period string
- The frequency of scheduled snapshots.
- Retention
Duration stringIn Seconds - 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 string - A name prefix to be applied to snapshots created by this schedule. Example:
compliance1
- Time
Schedule stringStart - 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. - Time
Zone string - Time zone used for scheduling the snapshot.
- Day
Of intMonth - 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 stringWeek - 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 intDay - 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
- The month to create a scheduled snapshot. Used only for YEARLY snapshot schedules. If not set, the system chooses a value at creation time.
- Period string
- The frequency of scheduled snapshots.
- Retention
Duration stringIn Seconds - 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 string - A name prefix to be applied to snapshots created by this schedule. Example:
compliance1
- Time
Schedule stringStart - 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. - Time
Zone string - Time zone used for scheduling the snapshot.
- day
Of IntegerMonth - 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 StringWeek - 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 IntegerDay - 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
- The month to create a scheduled snapshot. Used only for YEARLY snapshot schedules. If not set, the system chooses a value at creation time.
- period String
- The frequency of scheduled snapshots.
- retention
Duration StringIn Seconds - 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 String - A name prefix to be applied to snapshots created by this schedule. Example:
compliance1
- time
Schedule StringStart - 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. - time
Zone String - Time zone used for scheduling the snapshot.
- day
Of numberMonth - 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 stringWeek - 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 numberDay - 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
- The month to create a scheduled snapshot. Used only for YEARLY snapshot schedules. If not set, the system chooses a value at creation time.
- period string
- The frequency of scheduled snapshots.
- retention
Duration stringIn Seconds - 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 string - A name prefix to be applied to snapshots created by this schedule. Example:
compliance1
- time
Schedule stringStart - 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. - time
Zone string - Time zone used for scheduling the snapshot.
- day_
of_ intmonth - 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_ strweek - 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_ intday - 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
- The month to create a scheduled snapshot. Used only for YEARLY snapshot schedules. If not set, the system chooses a value at creation time.
- period str
- The frequency of scheduled snapshots.
- retention_
duration_ strin_ seconds - 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 - A name prefix to be applied to snapshots created by this schedule. Example:
compliance1
- time_
schedule_ strstart - 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. - time_
zone str - Time zone used for scheduling the snapshot.
- day
Of NumberMonth - 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 StringWeek - 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 NumberDay - 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
- The month to create a scheduled snapshot. Used only for YEARLY snapshot schedules. If not set, the system chooses a value at creation time.
- period String
- The frequency of scheduled snapshots.
- retention
Duration StringIn Seconds - 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 String - A name prefix to be applied to snapshots created by this schedule. Example:
compliance1
- time
Schedule StringStart - 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. - time
Zone String - Time zone used for scheduling the snapshot.
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
oci
Terraform Provider.