MongoDB Atlas v3.7.1, Mar 10 23

mongodbatlas.getCloudProviderSnapshotBackupPolicy

WARNING: This data source is deprecated, use mongodbatlas.CloudBackupSchedule

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

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 getCloudProviderSnapshotBackupPolicy(args: GetCloudProviderSnapshotBackupPolicyArgs, opts?: InvokeOptions): Promise<GetCloudProviderSnapshotBackupPolicyResult>
function getCloudProviderSnapshotBackupPolicyOutput(args: GetCloudProviderSnapshotBackupPolicyOutputArgs, opts?: InvokeOptions): Output<GetCloudProviderSnapshotBackupPolicyResult>

def get_cloud_provider_snapshot_backup_policy(cluster_name: Optional[str] = None,
                                              project_id: Optional[str] = None,
                                              opts: Optional[InvokeOptions] = None) -> GetCloudProviderSnapshotBackupPolicyResult
def get_cloud_provider_snapshot_backup_policy_output(cluster_name: Optional[pulumi.Input[str]] = None,
                                              project_id: Optional[pulumi.Input[str]] = None,
                                              opts: Optional[InvokeOptions] = None) -> Output[GetCloudProviderSnapshotBackupPolicyResult]

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

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

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

public static CompletableFuture<GetCloudProviderSnapshotBackupPolicyResult> getCloudProviderSnapshotBackupPolicy(GetCloudProviderSnapshotBackupPolicyArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: mongodbatlas:index/getCloudProviderSnapshotBackupPolicy:getCloudProviderSnapshotBackupPolicy
  arguments:
    # arguments dictionary

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.

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.

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.

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 List<GetCloudProviderSnapshotBackupPolicyPolicy>

A list of policy definitions for the cluster.

policies.#.id - Unique identifier of the backup policy.

projectId String

referenceHourOfDay Integer

UTC Hour of day between 0 and 23 representing which hour of the day that Atlas takes a snapshot.

referenceMinuteOfHour Integer

UTC Minute of day between 0 and 59 representing which minute of the referenceHourOfDay that Atlas takes the snapshot.

restoreWindowDays Integer

Specifies a restore window in days for cloud backup to maintain.

updateSnapshots Boolean

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

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<Property Map>

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

Supporting Types

GetCloudProviderSnapshotBackupPolicyPolicy

Id string
PolicyItems List<GetCloudProviderSnapshotBackupPolicyPolicyPolicyItem>

Id string
PolicyItems []GetCloudProviderSnapshotBackupPolicyPolicyPolicyItem

id String
policyItems List<GetCloudProviderSnapshotBackupPolicyPolicyPolicyItem>

id string
policyItems GetCloudProviderSnapshotBackupPolicyPolicyPolicyItem[]

id str
policy_items Sequence[GetCloudProviderSnapshotBackupPolicyPolicyPolicyItem]

id String
policyItems List<Property Map>

GetCloudProviderSnapshotBackupPolicyPolicyPolicyItem

FrequencyInterval int
FrequencyType string
Id string
RetentionUnit string
RetentionValue int

FrequencyInterval int
FrequencyType string
Id string
RetentionUnit string
RetentionValue int

frequencyInterval Integer
frequencyType String
id String
retentionUnit String
retentionValue Integer

frequencyInterval number
frequencyType string
id string
retentionUnit string
retentionValue number

frequency_interval int
frequency_type str
id str
retention_unit str
retention_value int

frequencyInterval Number
frequencyType String
id String
retentionUnit String
retentionValue Number

Package Details

Repository: MongoDB Atlas pulumi/pulumi-mongodbatlas
License: Apache-2.0
Notes: This Pulumi package is based on the mongodbatlas Terraform Provider.

mongodbatlas.getCloudProviderSnapshotBackupPolicy

Using getCloudProviderSnapshotBackupPolicy

getCloudProviderSnapshotBackupPolicy Result

Supporting Types

GetCloudProviderSnapshotBackupPolicyPolicy

GetCloudProviderSnapshotBackupPolicyPolicyPolicyItem

Package Details

Contents