MongoDB Atlas v3.7.2, Mar 31 23

mongodbatlas.CloudProviderSnapshotBackupPolicy

Import

Cloud Backup Snapshot Policy entries can be imported using project project_id and cluster_name, in the format PROJECTID-CLUSTERNAME, e.g.

 $ pulumi import mongodbatlas:index/cloudProviderSnapshotBackupPolicy:CloudProviderSnapshotBackupPolicy test 5d0f1f73cf09a29120e173cf-MyClusterTest

For more information seeMongoDB Atlas API Reference.

Create CloudProviderSnapshotBackupPolicy Resource

new CloudProviderSnapshotBackupPolicy(name: string, args: CloudProviderSnapshotBackupPolicyArgs, opts?: CustomResourceOptions);

@overload
def CloudProviderSnapshotBackupPolicy(resource_name: str,
                                      opts: Optional[ResourceOptions] = None,
                                      cluster_name: Optional[str] = None,
                                      policies: Optional[Sequence[CloudProviderSnapshotBackupPolicyPolicyArgs]] = None,
                                      project_id: Optional[str] = None,
                                      reference_hour_of_day: Optional[int] = None,
                                      reference_minute_of_hour: Optional[int] = None,
                                      restore_window_days: Optional[int] = None,
                                      update_snapshots: Optional[bool] = None)
@overload
def CloudProviderSnapshotBackupPolicy(resource_name: str,
                                      args: CloudProviderSnapshotBackupPolicyArgs,
                                      opts: Optional[ResourceOptions] = None)

func NewCloudProviderSnapshotBackupPolicy(ctx *Context, name string, args CloudProviderSnapshotBackupPolicyArgs, opts ...ResourceOption) (*CloudProviderSnapshotBackupPolicy, error)

public CloudProviderSnapshotBackupPolicy(string name, CloudProviderSnapshotBackupPolicyArgs args, CustomResourceOptions? opts = null)

public CloudProviderSnapshotBackupPolicy(String name, CloudProviderSnapshotBackupPolicyArgs args)
public CloudProviderSnapshotBackupPolicy(String name, CloudProviderSnapshotBackupPolicyArgs args, CustomResourceOptions options)

type: mongodbatlas:CloudProviderSnapshotBackupPolicy
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string: The unique name of the resource.
args CloudProviderSnapshotBackupPolicyArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args CloudProviderSnapshotBackupPolicyArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args CloudProviderSnapshotBackupPolicyArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args CloudProviderSnapshotBackupPolicyArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args CloudProviderSnapshotBackupPolicyArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

CloudProviderSnapshotBackupPolicy Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The CloudProviderSnapshotBackupPolicy resource accepts the following input properties:

ClusterName string: The name of the Atlas cluster that contains the snapshot backup policy you want to retrieve.
Policies List<CloudProviderSnapshotBackupPolicyPolicyArgs>
ProjectId string: The unique identifier of the project for the Atlas cluster.
ReferenceHourOfDay int: UTC Hour of day between 0 and 23, inclusive, representing which hour of the day that Atlas takes snapshots for backup policy items.
ReferenceMinuteOfHour int: UTC Minutes after referenceHourOfDay that Atlas takes snapshots for backup policy items. Must be between 0 and 59, inclusive.
RestoreWindowDays int: Number of days back in time you can restore to with point-in-time accuracy. Must be a positive, non-zero integer.
UpdateSnapshots bool: Specify true to apply the retention changes in the updated backup policy to snapshots that Atlas took previously.

ClusterName string: The name of the Atlas cluster that contains the snapshot backup policy you want to retrieve.
Policies []CloudProviderSnapshotBackupPolicyPolicyArgs
ProjectId string: The unique identifier of the project for the Atlas cluster.
ReferenceHourOfDay int: UTC Hour of day between 0 and 23, inclusive, representing which hour of the day that Atlas takes snapshots for backup policy items.
ReferenceMinuteOfHour int: UTC Minutes after referenceHourOfDay that Atlas takes snapshots for backup policy items. Must be between 0 and 59, inclusive.
RestoreWindowDays int: Number of days back in time you can restore to with point-in-time accuracy. Must be a positive, non-zero integer.
UpdateSnapshots bool: Specify true to apply the retention changes in the updated backup policy to snapshots that Atlas took previously.

clusterName String: The name of the Atlas cluster that contains the snapshot backup policy you want to retrieve.
policies List<CloudProviderSnapshotBackupPolicyPolicyArgs>
projectId String: The unique identifier of the project for the Atlas cluster.
referenceHourOfDay Integer: UTC Hour of day between 0 and 23, inclusive, representing which hour of the day that Atlas takes snapshots for backup policy items.
referenceMinuteOfHour Integer: UTC Minutes after referenceHourOfDay that Atlas takes snapshots for backup policy items. Must be between 0 and 59, inclusive.
restoreWindowDays Integer: Number of days back in time you can restore to with point-in-time accuracy. Must be a positive, non-zero integer.
updateSnapshots Boolean: Specify true to apply the retention changes in the updated backup policy to snapshots that Atlas took previously.

clusterName string: The name of the Atlas cluster that contains the snapshot backup policy you want to retrieve.
policies CloudProviderSnapshotBackupPolicyPolicyArgs[]
projectId string: The unique identifier of the project for the Atlas cluster.
referenceHourOfDay number: UTC Hour of day between 0 and 23, inclusive, representing which hour of the day that Atlas takes snapshots for backup policy items.
referenceMinuteOfHour number: UTC Minutes after referenceHourOfDay that Atlas takes snapshots for backup policy items. Must be between 0 and 59, inclusive.
restoreWindowDays number: Number of days back in time you can restore to with point-in-time accuracy. Must be a positive, non-zero integer.
updateSnapshots boolean: Specify true to apply the retention changes in the updated backup policy to snapshots that Atlas took previously.

cluster_name str: The name of the Atlas cluster that contains the snapshot backup policy you want to retrieve.
policies Sequence[CloudProviderSnapshotBackupPolicyPolicyArgs]
project_id str: The unique identifier of the project for the Atlas cluster.
reference_hour_of_day int: UTC Hour of day between 0 and 23, inclusive, representing which hour of the day that Atlas takes snapshots for backup policy items.
reference_minute_of_hour int: UTC Minutes after referenceHourOfDay that Atlas takes snapshots for backup policy items. Must be between 0 and 59, inclusive.
restore_window_days int: Number of days back in time you can restore to with point-in-time accuracy. Must be a positive, non-zero integer.
update_snapshots bool: Specify true to apply the retention changes in the updated backup policy to snapshots that Atlas took previously.

clusterName String: The name of the Atlas cluster that contains the snapshot backup policy you want to retrieve.
policies List<Property Map>
projectId String: The unique identifier of the project for the Atlas cluster.
referenceHourOfDay Number: UTC Hour of day between 0 and 23, inclusive, representing which hour of the day that Atlas takes snapshots for backup policy items.
referenceMinuteOfHour Number: UTC Minutes after referenceHourOfDay that Atlas takes snapshots for backup policy items. Must be between 0 and 59, inclusive.
restoreWindowDays Number: Number of days back in time you can restore to with point-in-time accuracy. Must be a positive, non-zero integer.
updateSnapshots Boolean: Specify true to apply the retention changes in the updated backup policy to snapshots that Atlas took previously.

Outputs

All input properties are implicitly available as output properties. Additionally, the CloudProviderSnapshotBackupPolicy resource produces the following output properties:

ClusterId string: Unique identifier of the Atlas cluster.
Id string: The provider-assigned unique ID for this managed resource.
NextSnapshot string: Timestamp in the number of seconds that have elapsed since the UNIX epoch when Atlas takes the next snapshot.

ClusterId string: Unique identifier of the Atlas cluster.
Id string: The provider-assigned unique ID for this managed resource.
NextSnapshot string: Timestamp in the number of seconds that have elapsed since the UNIX epoch when Atlas takes the next snapshot.

clusterId String: Unique identifier of the Atlas cluster.
id String: The provider-assigned unique ID for this managed resource.
nextSnapshot String: Timestamp in the number of seconds that have elapsed since the UNIX epoch when Atlas takes the next snapshot.

clusterId string: Unique identifier of the Atlas cluster.
id string: The provider-assigned unique ID for this managed resource.
nextSnapshot string: Timestamp in the number of seconds that have elapsed since the UNIX epoch when Atlas takes the next snapshot.

cluster_id str: Unique identifier of the Atlas cluster.
id str: The provider-assigned unique ID for this managed resource.
next_snapshot str: Timestamp in the number of seconds that have elapsed since the UNIX epoch when Atlas takes the next snapshot.

clusterId String: Unique identifier of the Atlas cluster.
id String: The provider-assigned unique ID for this managed resource.
nextSnapshot String: Timestamp in the number of seconds that have elapsed since the UNIX epoch when Atlas takes the next snapshot.

Look up Existing CloudProviderSnapshotBackupPolicy Resource

Get an existing CloudProviderSnapshotBackupPolicy resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: CloudProviderSnapshotBackupPolicyState, opts?: CustomResourceOptions): CloudProviderSnapshotBackupPolicy

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cluster_id: Optional[str] = None,
        cluster_name: Optional[str] = None,
        next_snapshot: Optional[str] = None,
        policies: Optional[Sequence[CloudProviderSnapshotBackupPolicyPolicyArgs]] = None,
        project_id: Optional[str] = None,
        reference_hour_of_day: Optional[int] = None,
        reference_minute_of_hour: Optional[int] = None,
        restore_window_days: Optional[int] = None,
        update_snapshots: Optional[bool] = None) -> CloudProviderSnapshotBackupPolicy

func GetCloudProviderSnapshotBackupPolicy(ctx *Context, name string, id IDInput, state *CloudProviderSnapshotBackupPolicyState, opts ...ResourceOption) (*CloudProviderSnapshotBackupPolicy, error)

public static CloudProviderSnapshotBackupPolicy Get(string name, Input<string> id, CloudProviderSnapshotBackupPolicyState? state, CustomResourceOptions? opts = null)

public static CloudProviderSnapshotBackupPolicy get(String name, Output<String> id, CloudProviderSnapshotBackupPolicyState state, CustomResourceOptions options)

Resource lookup is not supported in YAML

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

ClusterId string: Unique identifier of the Atlas cluster.
ClusterName string: The name of the Atlas cluster that contains the snapshot backup policy you want to retrieve.
NextSnapshot string: Timestamp in the number of seconds that have elapsed since the UNIX epoch when Atlas takes the next snapshot.
Policies List<CloudProviderSnapshotBackupPolicyPolicyArgs>
ProjectId string: The unique identifier of the project for the Atlas cluster.
ReferenceHourOfDay int: UTC Hour of day between 0 and 23, inclusive, representing which hour of the day that Atlas takes snapshots for backup policy items.
ReferenceMinuteOfHour int: UTC Minutes after referenceHourOfDay that Atlas takes snapshots for backup policy items. Must be between 0 and 59, inclusive.
RestoreWindowDays int: Number of days back in time you can restore to with point-in-time accuracy. Must be a positive, non-zero integer.
UpdateSnapshots bool: Specify true to apply the retention changes in the updated backup policy to snapshots that Atlas took previously.

ClusterId string: Unique identifier of the Atlas cluster.
ClusterName string: The name of the Atlas cluster that contains the snapshot backup policy you want to retrieve.
NextSnapshot string: Timestamp in the number of seconds that have elapsed since the UNIX epoch when Atlas takes the next snapshot.
Policies []CloudProviderSnapshotBackupPolicyPolicyArgs
ProjectId string: The unique identifier of the project for the Atlas cluster.
ReferenceHourOfDay int: UTC Hour of day between 0 and 23, inclusive, representing which hour of the day that Atlas takes snapshots for backup policy items.
ReferenceMinuteOfHour int: UTC Minutes after referenceHourOfDay that Atlas takes snapshots for backup policy items. Must be between 0 and 59, inclusive.
RestoreWindowDays int: Number of days back in time you can restore to with point-in-time accuracy. Must be a positive, non-zero integer.
UpdateSnapshots bool: Specify true to apply the retention changes in the updated backup policy to snapshots that Atlas took previously.

clusterId String: Unique identifier of the Atlas cluster.
clusterName String: The name of the Atlas cluster that contains the snapshot backup policy you want to retrieve.
nextSnapshot String: Timestamp in the number of seconds that have elapsed since the UNIX epoch when Atlas takes the next snapshot.
policies List<CloudProviderSnapshotBackupPolicyPolicyArgs>
projectId String: The unique identifier of the project for the Atlas cluster.
referenceHourOfDay Integer: UTC Hour of day between 0 and 23, inclusive, representing which hour of the day that Atlas takes snapshots for backup policy items.
referenceMinuteOfHour Integer: UTC Minutes after referenceHourOfDay that Atlas takes snapshots for backup policy items. Must be between 0 and 59, inclusive.
restoreWindowDays Integer: Number of days back in time you can restore to with point-in-time accuracy. Must be a positive, non-zero integer.
updateSnapshots Boolean: Specify true to apply the retention changes in the updated backup policy to snapshots that Atlas took previously.

clusterId string: Unique identifier of the Atlas cluster.
clusterName string: The name of the Atlas cluster that contains the snapshot backup policy you want to retrieve.
nextSnapshot string: Timestamp in the number of seconds that have elapsed since the UNIX epoch when Atlas takes the next snapshot.
policies CloudProviderSnapshotBackupPolicyPolicyArgs[]
projectId string: The unique identifier of the project for the Atlas cluster.
referenceHourOfDay number: UTC Hour of day between 0 and 23, inclusive, representing which hour of the day that Atlas takes snapshots for backup policy items.
referenceMinuteOfHour number: UTC Minutes after referenceHourOfDay that Atlas takes snapshots for backup policy items. Must be between 0 and 59, inclusive.
restoreWindowDays number: Number of days back in time you can restore to with point-in-time accuracy. Must be a positive, non-zero integer.
updateSnapshots boolean: Specify true to apply the retention changes in the updated backup policy to snapshots that Atlas took previously.

cluster_id str: Unique identifier of the Atlas cluster.
cluster_name str: The name of the Atlas cluster that contains the snapshot backup policy you want to retrieve.
next_snapshot str: Timestamp in the number of seconds that have elapsed since the UNIX epoch when Atlas takes the next snapshot.
policies Sequence[CloudProviderSnapshotBackupPolicyPolicyArgs]
project_id str: The unique identifier of the project for the Atlas cluster.
reference_hour_of_day int: UTC Hour of day between 0 and 23, inclusive, representing which hour of the day that Atlas takes snapshots for backup policy items.
reference_minute_of_hour int: UTC Minutes after referenceHourOfDay that Atlas takes snapshots for backup policy items. Must be between 0 and 59, inclusive.
restore_window_days int: Number of days back in time you can restore to with point-in-time accuracy. Must be a positive, non-zero integer.
update_snapshots bool: Specify true to apply the retention changes in the updated backup policy to snapshots that Atlas took previously.

clusterId String: Unique identifier of the Atlas cluster.
clusterName String: The name of the Atlas cluster that contains the snapshot backup policy you want to retrieve.
nextSnapshot String: Timestamp in the number of seconds that have elapsed since the UNIX epoch when Atlas takes the next snapshot.
policies List<Property Map>
projectId String: The unique identifier of the project for the Atlas cluster.
referenceHourOfDay Number: UTC Hour of day between 0 and 23, inclusive, representing which hour of the day that Atlas takes snapshots for backup policy items.
referenceMinuteOfHour Number: UTC Minutes after referenceHourOfDay that Atlas takes snapshots for backup policy items. Must be between 0 and 59, inclusive.
restoreWindowDays Number: Number of days back in time you can restore to with point-in-time accuracy. Must be a positive, non-zero integer.
updateSnapshots Boolean: Specify true to apply the retention changes in the updated backup policy to snapshots that Atlas took previously.