Want to learn about running containers in Lambda? Join our free hands-on workshop. Register Now

CloudProviderSnapshotBackupPolicy

Create a CloudProviderSnapshotBackupPolicy Resource

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)
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.
opts ResourceOptions
A bag of options that control this 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.

CloudProviderSnapshotBackupPolicy Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model 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>

Contains a document for each backup policy item in the desired updated backup policy. * policies.#.id - (Required) Unique identifier of the backup policy that you want to update. policies.#.id is a value obtained via the mongodbatlas.Cluster resource. provider_backup_enabled of the mongodbatlas.Cluster resource must be set to true. See the example above for how to refer to the mongodbatlas.Cluster resource for policies.#.id

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 []CloudProviderSnapshotBackupPolicyPolicy

Contains a document for each backup policy item in the desired updated backup policy. * policies.#.id - (Required) Unique identifier of the backup policy that you want to update. policies.#.id is a value obtained via the mongodbatlas.Cluster resource. provider_backup_enabled of the mongodbatlas.Cluster resource must be set to true. See the example above for how to refer to the mongodbatlas.Cluster resource for policies.#.id

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 CloudProviderSnapshotBackupPolicyPolicy[]

Contains a document for each backup policy item in the desired updated backup policy. * policies.#.id - (Required) Unique identifier of the backup policy that you want to update. policies.#.id is a value obtained via the mongodbatlas.Cluster resource. provider_backup_enabled of the mongodbatlas.Cluster resource must be set to true. See the example above for how to refer to the mongodbatlas.Cluster resource for policies.#.id

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]

Contains a document for each backup policy item in the desired updated backup policy. * policies.#.id - (Required) Unique identifier of the backup policy that you want to update. policies.#.id is a value obtained via the mongodbatlas.Cluster resource. provider_backup_enabled of the mongodbatlas.Cluster resource must be set to true. See the example above for how to refer to the mongodbatlas.Cluster resource for policies.#.id

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.

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.

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.

Look up an Existing CloudProviderSnapshotBackupPolicy Resource

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

@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)
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.

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>

Contains a document for each backup policy item in the desired updated backup policy. * policies.#.id - (Required) Unique identifier of the backup policy that you want to update. policies.#.id is a value obtained via the mongodbatlas.Cluster resource. provider_backup_enabled of the mongodbatlas.Cluster resource must be set to true. See the example above for how to refer to the mongodbatlas.Cluster resource for policies.#.id

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 []CloudProviderSnapshotBackupPolicyPolicy

Contains a document for each backup policy item in the desired updated backup policy. * policies.#.id - (Required) Unique identifier of the backup policy that you want to update. policies.#.id is a value obtained via the mongodbatlas.Cluster resource. provider_backup_enabled of the mongodbatlas.Cluster resource must be set to true. See the example above for how to refer to the mongodbatlas.Cluster resource for policies.#.id

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 CloudProviderSnapshotBackupPolicyPolicy[]

Contains a document for each backup policy item in the desired updated backup policy. * policies.#.id - (Required) Unique identifier of the backup policy that you want to update. policies.#.id is a value obtained via the mongodbatlas.Cluster resource. provider_backup_enabled of the mongodbatlas.Cluster resource must be set to true. See the example above for how to refer to the mongodbatlas.Cluster resource for policies.#.id

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]

Contains a document for each backup policy item in the desired updated backup policy. * policies.#.id - (Required) Unique identifier of the backup policy that you want to update. policies.#.id is a value obtained via the mongodbatlas.Cluster resource. provider_backup_enabled of the mongodbatlas.Cluster resource must be set to true. See the example above for how to refer to the mongodbatlas.Cluster resource for policies.#.id

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.

Supporting Types

CloudProviderSnapshotBackupPolicyPolicy

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

Id string
PolicyItems List<CloudProviderSnapshotBackupPolicyPolicyPolicyItemArgs>
Id string
PolicyItems []CloudProviderSnapshotBackupPolicyPolicyPolicyItem
id string
policyItems CloudProviderSnapshotBackupPolicyPolicyPolicyItem[]
id str
policy_items Sequence[CloudProviderSnapshotBackupPolicyPolicyPolicyItemArgs]

CloudProviderSnapshotBackupPolicyPolicyPolicyItem

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

FrequencyInterval int
FrequencyType string
Id string
RetentionUnit string
RetentionValue int
FrequencyInterval int
FrequencyType string
Id string
RetentionUnit string
RetentionValue int
frequencyInterval number
frequencyType string
id string
retentionUnit string
retentionValue 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.