Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. Bytepluscc Provider
  4. API Docs
  5. storageebs
  6. getSnapshotPolicy
Viewing docs for bytepluscc v0.0.35
published on Monday, Jun 15, 2026 by Byteplus
Schema (JSON)
byteplus-sdk/pulumi-bytepluscc

bytepluscc.storageebs.getSnapshotPolicy

bytepluscc logo
Viewing docs for bytepluscc v0.0.35
published on Monday, Jun 15, 2026 by Byteplus
Schema (JSON)
byteplus-sdk/pulumi-bytepluscc

    Data Source schema for Byteplus::StorageEBS::SnapshotPolicy

    Using getSnapshotPolicy

    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 getSnapshotPolicy(args: GetSnapshotPolicyArgs, opts?: InvokeOptions): Promise<GetSnapshotPolicyResult>
function getSnapshotPolicyOutput(args: GetSnapshotPolicyOutputArgs, opts?: InvokeOptions): Output<GetSnapshotPolicyResult>
    def get_snapshot_policy(id: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetSnapshotPolicyResult
def get_snapshot_policy_output(id: pulumi.Input[Optional[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetSnapshotPolicyResult]
    func LookupSnapshotPolicy(ctx *Context, args *LookupSnapshotPolicyArgs, opts ...InvokeOption) (*LookupSnapshotPolicyResult, error)
func LookupSnapshotPolicyOutput(ctx *Context, args *LookupSnapshotPolicyOutputArgs, opts ...InvokeOption) LookupSnapshotPolicyResultOutput

    > Note: This function is named LookupSnapshotPolicy in the Go SDK.

    public static class GetSnapshotPolicy 
{
    public static Task<GetSnapshotPolicyResult> InvokeAsync(GetSnapshotPolicyArgs args, InvokeOptions? opts = null)
    public static Output<GetSnapshotPolicyResult> Invoke(GetSnapshotPolicyInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetSnapshotPolicyResult> getSnapshotPolicy(GetSnapshotPolicyArgs args, InvokeOptions options)
public static Output<GetSnapshotPolicyResult> getSnapshotPolicy(GetSnapshotPolicyArgs args, InvokeOptions options)

    fn::invoke:
  function: bytepluscc:storageebs/getSnapshotPolicy:getSnapshotPolicy
  arguments:
    # arguments dictionary
    data "bytepluscc_storageebs_getsnapshotpolicy" "name" {
    # arguments
}

    The following arguments are supported:

    Id string
    Uniquely identifies the resource.
    Id string
    Uniquely identifies the resource.
    id string
    Uniquely identifies the resource.
    id String
    Uniquely identifies the resource.
    id string
    Uniquely identifies the resource.
    id str
    Uniquely identifies the resource.
    id String
    Uniquely identifies the resource.

    getSnapshotPolicy Result

    The following output properties are available:

    AddVolumeIds List<string>
    List of cloud disk IDs to associate with the automatic snapshot policy.
    AutoSnapshotPolicyId string
    Automatic snapshot policy ID.
    AutoSnapshotPolicyName string
    Automatic snapshot policy name. Naming rules: The first character must be Chinese, a letter, or an underscore (). It can include Chinese, letters, numbers, underscores (), hyphens (-), or periods (.). Length must be between 1 and 128 characters.
    CreatedAt string
    Creation time of the automatic snapshot policy.
    Id string
    Uniquely identifies the resource.
    ProjectName string
    Project associated with the automatic snapshot policy.
    RemoveVolumeIds List<string>
    List of cloud disk IDs to disassociate from the automatic snapshot policy.
    RepeatDays int
    Create snapshots on a daily basis, with a specified interval in days. The value range is [1, 30]. When repeating snapshot creation daily, the day you create the automatic snapshot policy is considered Day 1. Snapshots will not be created for past time points. If all scheduled snapshot times for the day have passed, the day is still counted as Day 1.
    RepeatWeekdays List<string>
    Create snapshots on a weekly basis by selecting one or more days from Monday to Sunday. The value range is 1–7. When creating an automatic snapshot policy, you must set either the RepeatWeekdays.N or RepeatDays parameter. Setting both parameters at the same time is not supported.
    RetentionDays int
    Retention period for automatic snapshots, in days. -1: Save permanently; 1–65536: Specify number of days to retain.
    Status string
    Reserved parameter.
    Tags List<Byteplus.GetSnapshotPolicyTag>
    Tag.
    TimePoints List<string>
    Snapshot creation time points, using UTC +8 time. Unit: hour. Value range: 0–23.
    UpdatedAt string
    Update time of the automatic snapshot policy.
    VolumeNums int
    Total number of cloud disks.
    AddVolumeIds []string
    List of cloud disk IDs to associate with the automatic snapshot policy.
    AutoSnapshotPolicyId string
    Automatic snapshot policy ID.
    AutoSnapshotPolicyName string
    Automatic snapshot policy name. Naming rules: The first character must be Chinese, a letter, or an underscore (). It can include Chinese, letters, numbers, underscores (), hyphens (-), or periods (.). Length must be between 1 and 128 characters.
    CreatedAt string
    Creation time of the automatic snapshot policy.
    Id string
    Uniquely identifies the resource.
    ProjectName string
    Project associated with the automatic snapshot policy.
    RemoveVolumeIds []string
    List of cloud disk IDs to disassociate from the automatic snapshot policy.
    RepeatDays int
    Create snapshots on a daily basis, with a specified interval in days. The value range is [1, 30]. When repeating snapshot creation daily, the day you create the automatic snapshot policy is considered Day 1. Snapshots will not be created for past time points. If all scheduled snapshot times for the day have passed, the day is still counted as Day 1.
    RepeatWeekdays []string
    Create snapshots on a weekly basis by selecting one or more days from Monday to Sunday. The value range is 1–7. When creating an automatic snapshot policy, you must set either the RepeatWeekdays.N or RepeatDays parameter. Setting both parameters at the same time is not supported.
    RetentionDays int
    Retention period for automatic snapshots, in days. -1: Save permanently; 1–65536: Specify number of days to retain.
    Status string
    Reserved parameter.
    Tags []GetSnapshotPolicyTag
    Tag.
    TimePoints []string
    Snapshot creation time points, using UTC +8 time. Unit: hour. Value range: 0–23.
    UpdatedAt string
    Update time of the automatic snapshot policy.
    VolumeNums int
    Total number of cloud disks.
    add_volume_ids list(string)
    List of cloud disk IDs to associate with the automatic snapshot policy.
    auto_snapshot_policy_id string
    Automatic snapshot policy ID.
    auto_snapshot_policy_name string
    Automatic snapshot policy name. Naming rules: The first character must be Chinese, a letter, or an underscore (). It can include Chinese, letters, numbers, underscores (), hyphens (-), or periods (.). Length must be between 1 and 128 characters.
    created_at string
    Creation time of the automatic snapshot policy.
    id string
    Uniquely identifies the resource.
    project_name string
    Project associated with the automatic snapshot policy.
    remove_volume_ids list(string)
    List of cloud disk IDs to disassociate from the automatic snapshot policy.
    repeat_days number
    Create snapshots on a daily basis, with a specified interval in days. The value range is [1, 30]. When repeating snapshot creation daily, the day you create the automatic snapshot policy is considered Day 1. Snapshots will not be created for past time points. If all scheduled snapshot times for the day have passed, the day is still counted as Day 1.
    repeat_weekdays list(string)
    Create snapshots on a weekly basis by selecting one or more days from Monday to Sunday. The value range is 1–7. When creating an automatic snapshot policy, you must set either the RepeatWeekdays.N or RepeatDays parameter. Setting both parameters at the same time is not supported.
    retention_days number
    Retention period for automatic snapshots, in days. -1: Save permanently; 1–65536: Specify number of days to retain.
    status string
    Reserved parameter.
    tags list(object)
    Tag.
    time_points list(string)
    Snapshot creation time points, using UTC +8 time. Unit: hour. Value range: 0–23.
    updated_at string
    Update time of the automatic snapshot policy.
    volume_nums number
    Total number of cloud disks.
    addVolumeIds List<String>
    List of cloud disk IDs to associate with the automatic snapshot policy.
    autoSnapshotPolicyId String
    Automatic snapshot policy ID.
    autoSnapshotPolicyName String
    Automatic snapshot policy name. Naming rules: The first character must be Chinese, a letter, or an underscore (). It can include Chinese, letters, numbers, underscores (), hyphens (-), or periods (.). Length must be between 1 and 128 characters.
    createdAt String
    Creation time of the automatic snapshot policy.
    id String
    Uniquely identifies the resource.
    projectName String
    Project associated with the automatic snapshot policy.
    removeVolumeIds List<String>
    List of cloud disk IDs to disassociate from the automatic snapshot policy.
    repeatDays Integer
    Create snapshots on a daily basis, with a specified interval in days. The value range is [1, 30]. When repeating snapshot creation daily, the day you create the automatic snapshot policy is considered Day 1. Snapshots will not be created for past time points. If all scheduled snapshot times for the day have passed, the day is still counted as Day 1.
    repeatWeekdays List<String>
    Create snapshots on a weekly basis by selecting one or more days from Monday to Sunday. The value range is 1–7. When creating an automatic snapshot policy, you must set either the RepeatWeekdays.N or RepeatDays parameter. Setting both parameters at the same time is not supported.
    retentionDays Integer
    Retention period for automatic snapshots, in days. -1: Save permanently; 1–65536: Specify number of days to retain.
    status String
    Reserved parameter.
    tags List<GetSnapshotPolicyTag>
    Tag.
    timePoints List<String>
    Snapshot creation time points, using UTC +8 time. Unit: hour. Value range: 0–23.
    updatedAt String
    Update time of the automatic snapshot policy.
    volumeNums Integer
    Total number of cloud disks.
    addVolumeIds string[]
    List of cloud disk IDs to associate with the automatic snapshot policy.
    autoSnapshotPolicyId string
    Automatic snapshot policy ID.
    autoSnapshotPolicyName string
    Automatic snapshot policy name. Naming rules: The first character must be Chinese, a letter, or an underscore (). It can include Chinese, letters, numbers, underscores (), hyphens (-), or periods (.). Length must be between 1 and 128 characters.
    createdAt string
    Creation time of the automatic snapshot policy.
    id string
    Uniquely identifies the resource.
    projectName string
    Project associated with the automatic snapshot policy.
    removeVolumeIds string[]
    List of cloud disk IDs to disassociate from the automatic snapshot policy.
    repeatDays number
    Create snapshots on a daily basis, with a specified interval in days. The value range is [1, 30]. When repeating snapshot creation daily, the day you create the automatic snapshot policy is considered Day 1. Snapshots will not be created for past time points. If all scheduled snapshot times for the day have passed, the day is still counted as Day 1.
    repeatWeekdays string[]
    Create snapshots on a weekly basis by selecting one or more days from Monday to Sunday. The value range is 1–7. When creating an automatic snapshot policy, you must set either the RepeatWeekdays.N or RepeatDays parameter. Setting both parameters at the same time is not supported.
    retentionDays number
    Retention period for automatic snapshots, in days. -1: Save permanently; 1–65536: Specify number of days to retain.
    status string
    Reserved parameter.
    tags GetSnapshotPolicyTag[]
    Tag.
    timePoints string[]
    Snapshot creation time points, using UTC +8 time. Unit: hour. Value range: 0–23.
    updatedAt string
    Update time of the automatic snapshot policy.
    volumeNums number
    Total number of cloud disks.
    add_volume_ids Sequence[str]
    List of cloud disk IDs to associate with the automatic snapshot policy.
    auto_snapshot_policy_id str
    Automatic snapshot policy ID.
    auto_snapshot_policy_name str
    Automatic snapshot policy name. Naming rules: The first character must be Chinese, a letter, or an underscore (). It can include Chinese, letters, numbers, underscores (), hyphens (-), or periods (.). Length must be between 1 and 128 characters.
    created_at str
    Creation time of the automatic snapshot policy.
    id str
    Uniquely identifies the resource.
    project_name str
    Project associated with the automatic snapshot policy.
    remove_volume_ids Sequence[str]
    List of cloud disk IDs to disassociate from the automatic snapshot policy.
    repeat_days int
    Create snapshots on a daily basis, with a specified interval in days. The value range is [1, 30]. When repeating snapshot creation daily, the day you create the automatic snapshot policy is considered Day 1. Snapshots will not be created for past time points. If all scheduled snapshot times for the day have passed, the day is still counted as Day 1.
    repeat_weekdays Sequence[str]
    Create snapshots on a weekly basis by selecting one or more days from Monday to Sunday. The value range is 1–7. When creating an automatic snapshot policy, you must set either the RepeatWeekdays.N or RepeatDays parameter. Setting both parameters at the same time is not supported.
    retention_days int
    Retention period for automatic snapshots, in days. -1: Save permanently; 1–65536: Specify number of days to retain.
    status str
    Reserved parameter.
    tags Sequence[GetSnapshotPolicyTag]
    Tag.
    time_points Sequence[str]
    Snapshot creation time points, using UTC +8 time. Unit: hour. Value range: 0–23.
    updated_at str
    Update time of the automatic snapshot policy.
    volume_nums int
    Total number of cloud disks.
    addVolumeIds List<String>
    List of cloud disk IDs to associate with the automatic snapshot policy.
    autoSnapshotPolicyId String
    Automatic snapshot policy ID.
    autoSnapshotPolicyName String
    Automatic snapshot policy name. Naming rules: The first character must be Chinese, a letter, or an underscore (). It can include Chinese, letters, numbers, underscores (), hyphens (-), or periods (.). Length must be between 1 and 128 characters.
    createdAt String
    Creation time of the automatic snapshot policy.
    id String
    Uniquely identifies the resource.
    projectName String
    Project associated with the automatic snapshot policy.
    removeVolumeIds List<String>
    List of cloud disk IDs to disassociate from the automatic snapshot policy.
    repeatDays Number
    Create snapshots on a daily basis, with a specified interval in days. The value range is [1, 30]. When repeating snapshot creation daily, the day you create the automatic snapshot policy is considered Day 1. Snapshots will not be created for past time points. If all scheduled snapshot times for the day have passed, the day is still counted as Day 1.
    repeatWeekdays List<String>
    Create snapshots on a weekly basis by selecting one or more days from Monday to Sunday. The value range is 1–7. When creating an automatic snapshot policy, you must set either the RepeatWeekdays.N or RepeatDays parameter. Setting both parameters at the same time is not supported.
    retentionDays Number
    Retention period for automatic snapshots, in days. -1: Save permanently; 1–65536: Specify number of days to retain.
    status String
    Reserved parameter.
    tags List<Property Map>
    Tag.
    timePoints List<String>
    Snapshot creation time points, using UTC +8 time. Unit: hour. Value range: 0–23.
    updatedAt String
    Update time of the automatic snapshot policy.
    volumeNums Number
    Total number of cloud disks.

    Supporting Types

    GetSnapshotPolicyTag

    Key string
    Tag key
    Value string
    Tag value
    Key string
    Tag key
    Value string
    Tag value
    key string
    Tag key
    value string
    Tag value
    key String
    Tag key
    value String
    Tag value
    key string
    Tag key
    value string
    Tag value
    key str
    Tag key
    value str
    Tag value
    key String
    Tag key
    value String
    Tag value

    Package Details

    Repository
    bytepluscc byteplus-sdk/pulumi-bytepluscc
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the bytepluscc Terraform Provider.
    bytepluscc logo
    Viewing docs for bytepluscc v0.0.35
    published on Monday, Jun 15, 2026 by Byteplus
    Schema (JSON)
    byteplus-sdk/pulumi-bytepluscc

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial