Alibaba Cloud

Pulumi Official
Package maintained by Pulumi
v3.27.0 published on Monday, Aug 8, 2022 by Pulumi

BackupPlan

Provides a Cassandra Backup Plan resource.

For information about Cassandra Backup Plan and how to use it, see What is Backup Plan.

NOTE: Available in v1.128.0+.

Create a BackupPlan Resource

new BackupPlan(name: string, args: BackupPlanArgs, opts?: CustomResourceOptions);
@overload
def BackupPlan(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               active: Optional[bool] = None,
               backup_period: Optional[str] = None,
               backup_time: Optional[str] = None,
               cluster_id: Optional[str] = None,
               data_center_id: Optional[str] = None,
               retention_period: Optional[int] = None)
@overload
def BackupPlan(resource_name: str,
               args: BackupPlanArgs,
               opts: Optional[ResourceOptions] = None)
func NewBackupPlan(ctx *Context, name string, args BackupPlanArgs, opts ...ResourceOption) (*BackupPlan, error)
public BackupPlan(string name, BackupPlanArgs args, CustomResourceOptions? opts = null)
public BackupPlan(String name, BackupPlanArgs args)
public BackupPlan(String name, BackupPlanArgs args, CustomResourceOptions options)
type: alicloud:cassandra:BackupPlan
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args BackupPlanArgs
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 BackupPlanArgs
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 BackupPlanArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args BackupPlanArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args BackupPlanArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

BackupPlan 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 BackupPlan resource accepts the following input properties:

BackupTime string

The start time of the backup task each day. The time is displayed in UTC and denoted by Z.

ClusterId string

The ID of the cluster for the backup.

DataCenterId string

The ID of the data center for the backup in the cluster.

Active bool

Specifies whether to activate the backup plan. Valid values: True, False. Default value: True.

BackupPeriod string

The backup cycle. Valid values: Friday, Monday, Saturday, Sunday, Thursday, Tuesday, Wednesday.

RetentionPeriod int

The duration for which you want to retain the backup. Valid values: 1 to 30. Unit: days. Default value: 30.

BackupTime string

The start time of the backup task each day. The time is displayed in UTC and denoted by Z.

ClusterId string

The ID of the cluster for the backup.

DataCenterId string

The ID of the data center for the backup in the cluster.

Active bool

Specifies whether to activate the backup plan. Valid values: True, False. Default value: True.

BackupPeriod string

The backup cycle. Valid values: Friday, Monday, Saturday, Sunday, Thursday, Tuesday, Wednesday.

RetentionPeriod int

The duration for which you want to retain the backup. Valid values: 1 to 30. Unit: days. Default value: 30.

backupTime String

The start time of the backup task each day. The time is displayed in UTC and denoted by Z.

clusterId String

The ID of the cluster for the backup.

dataCenterId String

The ID of the data center for the backup in the cluster.

active Boolean

Specifies whether to activate the backup plan. Valid values: True, False. Default value: True.

backupPeriod String

The backup cycle. Valid values: Friday, Monday, Saturday, Sunday, Thursday, Tuesday, Wednesday.

retentionPeriod Integer

The duration for which you want to retain the backup. Valid values: 1 to 30. Unit: days. Default value: 30.

backupTime string

The start time of the backup task each day. The time is displayed in UTC and denoted by Z.

clusterId string

The ID of the cluster for the backup.

dataCenterId string

The ID of the data center for the backup in the cluster.

active boolean

Specifies whether to activate the backup plan. Valid values: True, False. Default value: True.

backupPeriod string

The backup cycle. Valid values: Friday, Monday, Saturday, Sunday, Thursday, Tuesday, Wednesday.

retentionPeriod number

The duration for which you want to retain the backup. Valid values: 1 to 30. Unit: days. Default value: 30.

backup_time str

The start time of the backup task each day. The time is displayed in UTC and denoted by Z.

cluster_id str

The ID of the cluster for the backup.

data_center_id str

The ID of the data center for the backup in the cluster.

active bool

Specifies whether to activate the backup plan. Valid values: True, False. Default value: True.

backup_period str

The backup cycle. Valid values: Friday, Monday, Saturday, Sunday, Thursday, Tuesday, Wednesday.

retention_period int

The duration for which you want to retain the backup. Valid values: 1 to 30. Unit: days. Default value: 30.

backupTime String

The start time of the backup task each day. The time is displayed in UTC and denoted by Z.

clusterId String

The ID of the cluster for the backup.

dataCenterId String

The ID of the data center for the backup in the cluster.

active Boolean

Specifies whether to activate the backup plan. Valid values: True, False. Default value: True.

backupPeriod String

The backup cycle. Valid values: Friday, Monday, Saturday, Sunday, Thursday, Tuesday, Wednesday.

retentionPeriod Number

The duration for which you want to retain the backup. Valid values: 1 to 30. Unit: days. Default value: 30.

Outputs

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

Id string

The provider-assigned unique ID for this managed resource.

Id string

The provider-assigned unique ID for this managed resource.

id String

The provider-assigned unique ID for this managed resource.

id string

The provider-assigned unique ID for this managed resource.

id str

The provider-assigned unique ID for this managed resource.

id String

The provider-assigned unique ID for this managed resource.

Look up an Existing BackupPlan Resource

Get an existing BackupPlan 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?: BackupPlanState, opts?: CustomResourceOptions): BackupPlan
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        active: Optional[bool] = None,
        backup_period: Optional[str] = None,
        backup_time: Optional[str] = None,
        cluster_id: Optional[str] = None,
        data_center_id: Optional[str] = None,
        retention_period: Optional[int] = None) -> BackupPlan
func GetBackupPlan(ctx *Context, name string, id IDInput, state *BackupPlanState, opts ...ResourceOption) (*BackupPlan, error)
public static BackupPlan Get(string name, Input<string> id, BackupPlanState? state, CustomResourceOptions? opts = null)
public static BackupPlan get(String name, Output<String> id, BackupPlanState 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:
Active bool

Specifies whether to activate the backup plan. Valid values: True, False. Default value: True.

BackupPeriod string

The backup cycle. Valid values: Friday, Monday, Saturday, Sunday, Thursday, Tuesday, Wednesday.

BackupTime string

The start time of the backup task each day. The time is displayed in UTC and denoted by Z.

ClusterId string

The ID of the cluster for the backup.

DataCenterId string

The ID of the data center for the backup in the cluster.

RetentionPeriod int

The duration for which you want to retain the backup. Valid values: 1 to 30. Unit: days. Default value: 30.

Active bool

Specifies whether to activate the backup plan. Valid values: True, False. Default value: True.

BackupPeriod string

The backup cycle. Valid values: Friday, Monday, Saturday, Sunday, Thursday, Tuesday, Wednesday.

BackupTime string

The start time of the backup task each day. The time is displayed in UTC and denoted by Z.

ClusterId string

The ID of the cluster for the backup.

DataCenterId string

The ID of the data center for the backup in the cluster.

RetentionPeriod int

The duration for which you want to retain the backup. Valid values: 1 to 30. Unit: days. Default value: 30.

active Boolean

Specifies whether to activate the backup plan. Valid values: True, False. Default value: True.

backupPeriod String

The backup cycle. Valid values: Friday, Monday, Saturday, Sunday, Thursday, Tuesday, Wednesday.

backupTime String

The start time of the backup task each day. The time is displayed in UTC and denoted by Z.

clusterId String

The ID of the cluster for the backup.

dataCenterId String

The ID of the data center for the backup in the cluster.

retentionPeriod Integer

The duration for which you want to retain the backup. Valid values: 1 to 30. Unit: days. Default value: 30.

active boolean

Specifies whether to activate the backup plan. Valid values: True, False. Default value: True.

backupPeriod string

The backup cycle. Valid values: Friday, Monday, Saturday, Sunday, Thursday, Tuesday, Wednesday.

backupTime string

The start time of the backup task each day. The time is displayed in UTC and denoted by Z.

clusterId string

The ID of the cluster for the backup.

dataCenterId string

The ID of the data center for the backup in the cluster.

retentionPeriod number

The duration for which you want to retain the backup. Valid values: 1 to 30. Unit: days. Default value: 30.

active bool

Specifies whether to activate the backup plan. Valid values: True, False. Default value: True.

backup_period str

The backup cycle. Valid values: Friday, Monday, Saturday, Sunday, Thursday, Tuesday, Wednesday.

backup_time str

The start time of the backup task each day. The time is displayed in UTC and denoted by Z.

cluster_id str

The ID of the cluster for the backup.

data_center_id str

The ID of the data center for the backup in the cluster.

retention_period int

The duration for which you want to retain the backup. Valid values: 1 to 30. Unit: days. Default value: 30.

active Boolean

Specifies whether to activate the backup plan. Valid values: True, False. Default value: True.

backupPeriod String

The backup cycle. Valid values: Friday, Monday, Saturday, Sunday, Thursday, Tuesday, Wednesday.

backupTime String

The start time of the backup task each day. The time is displayed in UTC and denoted by Z.

clusterId String

The ID of the cluster for the backup.

dataCenterId String

The ID of the data center for the backup in the cluster.

retentionPeriod Number

The duration for which you want to retain the backup. Valid values: 1 to 30. Unit: days. Default value: 30.

Import

Cassandra Backup Plan can be imported using the id, e.g.

 $ pulumi import alicloud:cassandra/backupPlan:BackupPlan example <cluster_id>:<data_center_id>

Package Details

Repository
https://github.com/pulumi/pulumi-alicloud
License
Apache-2.0
Notes

This Pulumi package is based on the alicloud Terraform Provider.