GetCloudProviderSnapshotBackupPolicy

mongodbatlas.CloudProviderSnapshotBackupPolicy provides a Cloud Backup Snapshot Backup Policy datasource. An Atlas Cloud Backup Snapshot Policy provides the current snapshot schedule and retention settings for the cluster.

NOTE: Groups and projects are synonymous terms. You may find groupId in the official documentation.

Using GetCloudProviderSnapshotBackupPolicy

function getCloudProviderSnapshotBackupPolicy(args: GetCloudProviderSnapshotBackupPolicyArgs, opts?: InvokeOptions): Promise<GetCloudProviderSnapshotBackupPolicyResult>

def get_cloud_provider_snapshot_backup_policy(cluster_name: Optional[str] = None, project_id: Optional[str] = None, opts: Optional[InvokeOptions] = None) -> GetCloudProviderSnapshotBackupPolicyResult

func LookupCloudProviderSnapshotBackupPolicy(ctx *Context, args *LookupCloudProviderSnapshotBackupPolicyArgs, opts ...InvokeOption) (*LookupCloudProviderSnapshotBackupPolicyResult, error)

Note: This function is named LookupCloudProviderSnapshotBackupPolicy in the Go SDK.

public static class GetCloudProviderSnapshotBackupPolicy {
    public static Task<GetCloudProviderSnapshotBackupPolicyResult> InvokeAsync(GetCloudProviderSnapshotBackupPolicyArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

ClusterName string: The name of the Atlas cluster that contains the snapshots backup policy you want to retrieve.
ProjectId string: The unique identifier of the project for the Atlas cluster.

ClusterName string: The name of the Atlas cluster that contains the snapshots backup policy you want to retrieve.
ProjectId string: The unique identifier of the project for the Atlas cluster.

clusterName string: The name of the Atlas cluster that contains the snapshots backup policy you want to retrieve.
projectId string: The unique identifier of the project for the Atlas cluster.

cluster_name str: The name of the Atlas cluster that contains the snapshots backup policy you want to retrieve.
project_id str: The unique identifier of the project for the Atlas cluster.

GetCloudProviderSnapshotBackupPolicy Result

The following output properties are available:

ClusterId string: Unique identifier of the Atlas cluster.
ClusterName string
Id string: The provider-assigned unique ID for this managed resource.
NextSnapshot string: UTC ISO 8601 formatted point in time when Atlas will take the next snapshot.
Policies List<GetCloudProviderSnapshotBackupPolicyPolicy>: A list of policy definitions for the cluster. * policies.#.id - Unique identifier of the backup policy.
ProjectId string
ReferenceHourOfDay int: UTC Hour of day between 0 and 23 representing which hour of the day that Atlas takes a snapshot.
ReferenceMinuteOfHour int: UTC Minute of day between 0 and 59 representing which minute of the referenceHourOfDay that Atlas takes the snapshot.
RestoreWindowDays int: Specifies a restore window in days for cloud backup to maintain.
UpdateSnapshots bool

ClusterId string: Unique identifier of the Atlas cluster.
ClusterName string
Id string: The provider-assigned unique ID for this managed resource.
NextSnapshot string: UTC ISO 8601 formatted point in time when Atlas will take the next snapshot.
Policies []GetCloudProviderSnapshotBackupPolicyPolicy: A list of policy definitions for the cluster. * policies.#.id - Unique identifier of the backup policy.
ProjectId string
ReferenceHourOfDay int: UTC Hour of day between 0 and 23 representing which hour of the day that Atlas takes a snapshot.
ReferenceMinuteOfHour int: UTC Minute of day between 0 and 59 representing which minute of the referenceHourOfDay that Atlas takes the snapshot.
RestoreWindowDays int: Specifies a restore window in days for cloud backup to maintain.
UpdateSnapshots bool

clusterId string: Unique identifier of the Atlas cluster.
clusterName string
id string: The provider-assigned unique ID for this managed resource.
nextSnapshot string: UTC ISO 8601 formatted point in time when Atlas will take the next snapshot.
policies GetCloudProviderSnapshotBackupPolicyPolicy[]: A list of policy definitions for the cluster. * policies.#.id - Unique identifier of the backup policy.
projectId string
referenceHourOfDay number: UTC Hour of day between 0 and 23 representing which hour of the day that Atlas takes a snapshot.
referenceMinuteOfHour number: UTC Minute of day between 0 and 59 representing which minute of the referenceHourOfDay that Atlas takes the snapshot.
restoreWindowDays number: Specifies a restore window in days for cloud backup to maintain.
updateSnapshots boolean

cluster_id str: Unique identifier of the Atlas cluster.
cluster_name str
id str: The provider-assigned unique ID for this managed resource.
next_snapshot str: UTC ISO 8601 formatted point in time when Atlas will take the next snapshot.
policies Sequence[GetCloudProviderSnapshotBackupPolicyPolicy]: A list of policy definitions for the cluster. * policies.#.id - Unique identifier of the backup policy.
project_id str
reference_hour_of_day int: UTC Hour of day between 0 and 23 representing which hour of the day that Atlas takes a snapshot.
reference_minute_of_hour int: UTC Minute of day between 0 and 59 representing which minute of the referenceHourOfDay that Atlas takes the snapshot.
restore_window_days int: Specifies a restore window in days for cloud backup to maintain.
update_snapshots bool