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:
- Cluster
Name string The name of the Atlas cluster that contains the snapshots backup policy you want to retrieve.
- Project
Id string The unique identifier of the project for the Atlas cluster.
- Cluster
Name string The name of the Atlas cluster that contains the snapshots backup policy you want to retrieve.
- Project
Id string The unique identifier of the project for the Atlas cluster.
- cluster
Name string The name of the Atlas cluster that contains the snapshots backup policy you want to retrieve.
- project
Id 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:
- Cluster
Id string Unique identifier of the Atlas cluster.
- Cluster
Name string - Id string
The provider-assigned unique ID for this managed resource.
- Next
Snapshot string UTC ISO 8601 formatted point in time when Atlas will take the next snapshot.
- Policies
List<Get
Cloud Provider Snapshot Backup Policy Policy> A list of policy definitions for the cluster. *
policies.#.id
- Unique identifier of the backup policy.- Project
Id string - Reference
Hour intOf Day UTC Hour of day between 0 and 23 representing which hour of the day that Atlas takes a snapshot.
- Reference
Minute intOf Hour UTC Minute of day between 0 and 59 representing which minute of the referenceHourOfDay that Atlas takes the snapshot.
- Restore
Window intDays Specifies a restore window in days for cloud backup to maintain.
- Update
Snapshots bool
- Cluster
Id string Unique identifier of the Atlas cluster.
- Cluster
Name string - Id string
The provider-assigned unique ID for this managed resource.
- Next
Snapshot string UTC ISO 8601 formatted point in time when Atlas will take the next snapshot.
- Policies
[]Get
Cloud Provider Snapshot Backup Policy Policy A list of policy definitions for the cluster. *
policies.#.id
- Unique identifier of the backup policy.- Project
Id string - Reference
Hour intOf Day UTC Hour of day between 0 and 23 representing which hour of the day that Atlas takes a snapshot.
- Reference
Minute intOf Hour UTC Minute of day between 0 and 59 representing which minute of the referenceHourOfDay that Atlas takes the snapshot.
- Restore
Window intDays Specifies a restore window in days for cloud backup to maintain.
- Update
Snapshots bool
- cluster
Id string Unique identifier of the Atlas cluster.
- cluster
Name string - id string
The provider-assigned unique ID for this managed resource.
- next
Snapshot string UTC ISO 8601 formatted point in time when Atlas will take the next snapshot.
- policies
Get
Cloud Provider Snapshot Backup Policy Policy[] A list of policy definitions for the cluster. *
policies.#.id
- Unique identifier of the backup policy.- project
Id string - reference
Hour numberOf Day UTC Hour of day between 0 and 23 representing which hour of the day that Atlas takes a snapshot.
- reference
Minute numberOf Hour UTC Minute of day between 0 and 59 representing which minute of the referenceHourOfDay that Atlas takes the snapshot.
- restore
Window numberDays Specifies a restore window in days for cloud backup to maintain.
- update
Snapshots 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[Get
Cloud Provider Snapshot Backup Policy Policy] A list of policy definitions for the cluster. *
policies.#.id
- Unique identifier of the backup policy.- project_
id str - reference_
hour_ intof_ day UTC Hour of day between 0 and 23 representing which hour of the day that Atlas takes a snapshot.
- reference_
minute_ intof_ hour UTC Minute of day between 0 and 59 representing which minute of the referenceHourOfDay that Atlas takes the snapshot.
- restore_
window_ intdays Specifies a restore window in days for cloud backup to maintain.
- update_
snapshots bool
Supporting Types
GetCloudProviderSnapshotBackupPolicyPolicy
See the output API doc for this type.
See the output API doc for this type.
See the output API doc for this type.
GetCloudProviderSnapshotBackupPolicyPolicyPolicyItem
See the output API doc for this type.
See the output API doc for this type.
See the output API doc for this type.
- Frequency
Interval int - Frequency
Type string - Id string
- Retention
Unit string - Retention
Value int
- Frequency
Interval int - Frequency
Type string - Id string
- Retention
Unit string - Retention
Value int
- frequency
Interval number - frequency
Type string - id string
- retention
Unit string - retention
Value number
- frequency_
interval int - frequency_
type str - id str
- retention_
unit str - retention_
value int
Package Details
- Repository
- https://github.com/pulumi/pulumi-mongodbatlas
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
mongodbatlas
Terraform Provider.