Alibaba Cloud v3.38.0, Jun 2 23

alicloud.dbs.BackupPlan

Explore with Pulumi AI

Provides a DBS Backup Plan resource.

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

NOTE: Available in v1.185.0+.

Create BackupPlan Resource

new BackupPlan(name: string, args: BackupPlanArgs, opts?: CustomResourceOptions);

@overload
def BackupPlan(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               backup_gateway_id: Optional[str] = None,
               backup_log_interval_seconds: Optional[int] = None,
               backup_method: Optional[str] = None,
               backup_objects: Optional[str] = None,
               backup_period: Optional[str] = None,
               backup_plan_name: Optional[str] = None,
               backup_rate_limit: Optional[str] = None,
               backup_retention_period: Optional[int] = None,
               backup_speed_limit: Optional[str] = None,
               backup_start_time: Optional[str] = None,
               backup_storage_type: Optional[str] = None,
               backup_strategy_type: Optional[str] = None,
               cross_aliyun_id: Optional[str] = None,
               cross_role_name: Optional[str] = None,
               database_region: Optional[str] = None,
               database_type: Optional[str] = None,
               duplication_archive_period: Optional[int] = None,
               duplication_infrequent_access_period: Optional[int] = None,
               enable_backup_log: Optional[bool] = None,
               instance_class: Optional[str] = None,
               instance_type: Optional[str] = None,
               oss_bucket_name: Optional[str] = None,
               payment_type: Optional[str] = None,
               period: Optional[str] = None,
               resource_group_id: Optional[str] = None,
               source_endpoint_database_name: Optional[str] = None,
               source_endpoint_instance_id: Optional[str] = None,
               source_endpoint_instance_type: Optional[str] = None,
               source_endpoint_ip: Optional[str] = None,
               source_endpoint_oracle_sid: Optional[str] = None,
               source_endpoint_password: Optional[str] = None,
               source_endpoint_port: Optional[int] = None,
               source_endpoint_region: Optional[str] = None,
               source_endpoint_sid: Optional[str] = None,
               source_endpoint_user_name: Optional[str] = None,
               status: Optional[str] = None,
               storage_region: Optional[str] = None,
               used_time: 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:dbs: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:

BackupMethod string: Backup method. Valid values: duplication, logical, physical.
BackupPlanName string: The name of the resource.
DatabaseType string: Database type. Valid values: DRDS, FIle, MSSQL, MariaDB, MongoDB, MySQL, Oracle, PPAS, PostgreSQL, Redis.
InstanceClass string: The instance class. Valid values: large, medium, micro, small, xlarge.
SourceEndpointInstanceType string: The location of the database. Valid values: RDS, ECS, Express, Agent, DDS, Other.
BackupGatewayId string: The ID of the backup gateway. This parameter is required when the source_endpoint_instance_type is Agent.
BackupLogIntervalSeconds int: The backup log interval seconds.
BackupObjects string: The backup object.
BackupPeriod string: Full backup cycle, Valid values: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday. supports the selection of multiple fetch values, separated by English commas (,).
BackupRateLimit string: The backup rate limit.
BackupRetentionPeriod int: The retention time of backup data. Valid values: 0 to 1825. Default value: 730 days.
BackupSpeedLimit string: The backup speed limit.
BackupStartTime string: The start time of full Backup. The format is  HH:mm Z(UTC time).
BackupStorageType string: Built-in storage type, Valid values: system.
BackupStrategyType string: The backup strategy type. Valid values: simple, manual.
CrossAliyunId string: The UID that is backed up across Alibaba cloud accounts.
CrossRoleName string: The name of the RAM role that is backed up across Alibaba cloud accounts.
DatabaseRegion string: The database region.
DuplicationArchivePeriod int: The storage time for conversion to archive cold standby is 365 days by default.
DuplicationInfrequentAccessPeriod int: The storage time is converted to low-frequency access. The default time is 180 days.
EnableBackupLog bool: Whether to enable incremental log Backup.
InstanceType string: The instance type. Valid values: RDS, PolarDB, DDS, Kvstore, Other.
OssBucketName string: The OSS Bucket name. The system automatically generates a new name by default.
PaymentType string: The payment type of the resource. Valid values: PayAsYouGo, Subscription.
Period string: Specify that the prepaid instance is of the package year or monthly type. Valid values: Month, Year.
ResourceGroupId string: The ID of the resource group.
SourceEndpointDatabaseName string: The name of the database. This parameter is required when the database_type is PostgreSQL or MongoDB.
SourceEndpointInstanceId string: The ID of the database instance. This parameter is required when the source_endpoint_instance_type is RDS, ECS, DDS, or Express.
SourceEndpointIp string: The source endpoint ip.
SourceEndpointOracleSid string: Oracle SID name. This parameter is required when the database_type is Oracle.
SourceEndpointPassword string: The source endpoint password. This parameter is not required when the database_type is Redis, or when the source_endpoint_instance_type is Agent and the database_type is MSSQL. This parameter is required in other scenarios.
SourceEndpointPort int: The source endpoint port.
SourceEndpointRegion string: The region of the database. This parameter is required when the source_endpoint_instance_type is RDS, ECS, DDS, Express, or Agent.
SourceEndpointSid string: Oracle SID name. This parameter is required when the database_type is Oracle.
SourceEndpointUserName string: The source endpoint username. This parameter is not required when the database_type is Redis, or when the source_endpoint_instance_type is Agent and the database_type is MSSQL. This parameter is required in other scenarios.
Status string: The status of the resource. Valid values: pause, running.
StorageRegion string: The storage region.
UsedTime int: Specify purchase duration. When the parameter period is Year, the used_time value is 1 to 9. When the parameter period is Month, the used_time value is 1 to 11.

BackupMethod string: Backup method. Valid values: duplication, logical, physical.
BackupPlanName string: The name of the resource.
DatabaseType string: Database type. Valid values: DRDS, FIle, MSSQL, MariaDB, MongoDB, MySQL, Oracle, PPAS, PostgreSQL, Redis.
InstanceClass string: The instance class. Valid values: large, medium, micro, small, xlarge.
SourceEndpointInstanceType string: The location of the database. Valid values: RDS, ECS, Express, Agent, DDS, Other.
BackupGatewayId string: The ID of the backup gateway. This parameter is required when the source_endpoint_instance_type is Agent.
BackupLogIntervalSeconds int: The backup log interval seconds.
BackupObjects string: The backup object.
BackupPeriod string: Full backup cycle, Valid values: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday. supports the selection of multiple fetch values, separated by English commas (,).
BackupRateLimit string: The backup rate limit.
BackupRetentionPeriod int: The retention time of backup data. Valid values: 0 to 1825. Default value: 730 days.
BackupSpeedLimit string: The backup speed limit.
BackupStartTime string: The start time of full Backup. The format is  HH:mm Z(UTC time).
BackupStorageType string: Built-in storage type, Valid values: system.
BackupStrategyType string: The backup strategy type. Valid values: simple, manual.
CrossAliyunId string: The UID that is backed up across Alibaba cloud accounts.
CrossRoleName string: The name of the RAM role that is backed up across Alibaba cloud accounts.
DatabaseRegion string: The database region.
DuplicationArchivePeriod int: The storage time for conversion to archive cold standby is 365 days by default.
DuplicationInfrequentAccessPeriod int: The storage time is converted to low-frequency access. The default time is 180 days.
EnableBackupLog bool: Whether to enable incremental log Backup.
InstanceType string: The instance type. Valid values: RDS, PolarDB, DDS, Kvstore, Other.
OssBucketName string: The OSS Bucket name. The system automatically generates a new name by default.
PaymentType string: The payment type of the resource. Valid values: PayAsYouGo, Subscription.
Period string: Specify that the prepaid instance is of the package year or monthly type. Valid values: Month, Year.
ResourceGroupId string: The ID of the resource group.
SourceEndpointDatabaseName string: The name of the database. This parameter is required when the database_type is PostgreSQL or MongoDB.
SourceEndpointInstanceId string: The ID of the database instance. This parameter is required when the source_endpoint_instance_type is RDS, ECS, DDS, or Express.
SourceEndpointIp string: The source endpoint ip.
SourceEndpointOracleSid string: Oracle SID name. This parameter is required when the database_type is Oracle.
SourceEndpointPassword string: The source endpoint password. This parameter is not required when the database_type is Redis, or when the source_endpoint_instance_type is Agent and the database_type is MSSQL. This parameter is required in other scenarios.
SourceEndpointPort int: The source endpoint port.
SourceEndpointRegion string: The region of the database. This parameter is required when the source_endpoint_instance_type is RDS, ECS, DDS, Express, or Agent.
SourceEndpointSid string: Oracle SID name. This parameter is required when the database_type is Oracle.
SourceEndpointUserName string: The source endpoint username. This parameter is not required when the database_type is Redis, or when the source_endpoint_instance_type is Agent and the database_type is MSSQL. This parameter is required in other scenarios.
Status string: The status of the resource. Valid values: pause, running.
StorageRegion string: The storage region.
UsedTime int: Specify purchase duration. When the parameter period is Year, the used_time value is 1 to 9. When the parameter period is Month, the used_time value is 1 to 11.

backupMethod String: Backup method. Valid values: duplication, logical, physical.
backupPlanName String: The name of the resource.
databaseType String: Database type. Valid values: DRDS, FIle, MSSQL, MariaDB, MongoDB, MySQL, Oracle, PPAS, PostgreSQL, Redis.
instanceClass String: The instance class. Valid values: large, medium, micro, small, xlarge.
sourceEndpointInstanceType String: The location of the database. Valid values: RDS, ECS, Express, Agent, DDS, Other.
backupGatewayId String: The ID of the backup gateway. This parameter is required when the source_endpoint_instance_type is Agent.
backupLogIntervalSeconds Integer: The backup log interval seconds.
backupObjects String: The backup object.
backupPeriod String: Full backup cycle, Valid values: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday. supports the selection of multiple fetch values, separated by English commas (,).
backupRateLimit String: The backup rate limit.
backupRetentionPeriod Integer: The retention time of backup data. Valid values: 0 to 1825. Default value: 730 days.
backupSpeedLimit String: The backup speed limit.
backupStartTime String: The start time of full Backup. The format is  HH:mm Z(UTC time).
backupStorageType String: Built-in storage type, Valid values: system.
backupStrategyType String: The backup strategy type. Valid values: simple, manual.
crossAliyunId String: The UID that is backed up across Alibaba cloud accounts.
crossRoleName String: The name of the RAM role that is backed up across Alibaba cloud accounts.
databaseRegion String: The database region.
duplicationArchivePeriod Integer: The storage time for conversion to archive cold standby is 365 days by default.
duplicationInfrequentAccessPeriod Integer: The storage time is converted to low-frequency access. The default time is 180 days.
enableBackupLog Boolean: Whether to enable incremental log Backup.
instanceType String: The instance type. Valid values: RDS, PolarDB, DDS, Kvstore, Other.
ossBucketName String: The OSS Bucket name. The system automatically generates a new name by default.
paymentType String: The payment type of the resource. Valid values: PayAsYouGo, Subscription.
period String: Specify that the prepaid instance is of the package year or monthly type. Valid values: Month, Year.
resourceGroupId String: The ID of the resource group.
sourceEndpointDatabaseName String: The name of the database. This parameter is required when the database_type is PostgreSQL or MongoDB.
sourceEndpointInstanceId String: The ID of the database instance. This parameter is required when the source_endpoint_instance_type is RDS, ECS, DDS, or Express.
sourceEndpointIp String: The source endpoint ip.
sourceEndpointOracleSid String: Oracle SID name. This parameter is required when the database_type is Oracle.
sourceEndpointPassword String: The source endpoint password. This parameter is not required when the database_type is Redis, or when the source_endpoint_instance_type is Agent and the database_type is MSSQL. This parameter is required in other scenarios.
sourceEndpointPort Integer: The source endpoint port.
sourceEndpointRegion String: The region of the database. This parameter is required when the source_endpoint_instance_type is RDS, ECS, DDS, Express, or Agent.
sourceEndpointSid String: Oracle SID name. This parameter is required when the database_type is Oracle.
sourceEndpointUserName String: The source endpoint username. This parameter is not required when the database_type is Redis, or when the source_endpoint_instance_type is Agent and the database_type is MSSQL. This parameter is required in other scenarios.
status String: The status of the resource. Valid values: pause, running.
storageRegion String: The storage region.
usedTime Integer: Specify purchase duration. When the parameter period is Year, the used_time value is 1 to 9. When the parameter period is Month, the used_time value is 1 to 11.

backupMethod string: Backup method. Valid values: duplication, logical, physical.
backupPlanName string: The name of the resource.
databaseType string: Database type. Valid values: DRDS, FIle, MSSQL, MariaDB, MongoDB, MySQL, Oracle, PPAS, PostgreSQL, Redis.
instanceClass string: The instance class. Valid values: large, medium, micro, small, xlarge.
sourceEndpointInstanceType string: The location of the database. Valid values: RDS, ECS, Express, Agent, DDS, Other.
backupGatewayId string: The ID of the backup gateway. This parameter is required when the source_endpoint_instance_type is Agent.
backupLogIntervalSeconds number: The backup log interval seconds.
backupObjects string: The backup object.
backupPeriod string: Full backup cycle, Valid values: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday. supports the selection of multiple fetch values, separated by English commas (,).
backupRateLimit string: The backup rate limit.
backupRetentionPeriod number: The retention time of backup data. Valid values: 0 to 1825. Default value: 730 days.
backupSpeedLimit string: The backup speed limit.
backupStartTime string: The start time of full Backup. The format is  HH:mm Z(UTC time).
backupStorageType string: Built-in storage type, Valid values: system.
backupStrategyType string: The backup strategy type. Valid values: simple, manual.
crossAliyunId string: The UID that is backed up across Alibaba cloud accounts.
crossRoleName string: The name of the RAM role that is backed up across Alibaba cloud accounts.
databaseRegion string: The database region.
duplicationArchivePeriod number: The storage time for conversion to archive cold standby is 365 days by default.
duplicationInfrequentAccessPeriod number: The storage time is converted to low-frequency access. The default time is 180 days.
enableBackupLog boolean: Whether to enable incremental log Backup.
instanceType string: The instance type. Valid values: RDS, PolarDB, DDS, Kvstore, Other.
ossBucketName string: The OSS Bucket name. The system automatically generates a new name by default.
paymentType string: The payment type of the resource. Valid values: PayAsYouGo, Subscription.
period string: Specify that the prepaid instance is of the package year or monthly type. Valid values: Month, Year.
resourceGroupId string: The ID of the resource group.
sourceEndpointDatabaseName string: The name of the database. This parameter is required when the database_type is PostgreSQL or MongoDB.
sourceEndpointInstanceId string: The ID of the database instance. This parameter is required when the source_endpoint_instance_type is RDS, ECS, DDS, or Express.
sourceEndpointIp string: The source endpoint ip.
sourceEndpointOracleSid string: Oracle SID name. This parameter is required when the database_type is Oracle.
sourceEndpointPassword string: The source endpoint password. This parameter is not required when the database_type is Redis, or when the source_endpoint_instance_type is Agent and the database_type is MSSQL. This parameter is required in other scenarios.
sourceEndpointPort number: The source endpoint port.
sourceEndpointRegion string: The region of the database. This parameter is required when the source_endpoint_instance_type is RDS, ECS, DDS, Express, or Agent.
sourceEndpointSid string: Oracle SID name. This parameter is required when the database_type is Oracle.
sourceEndpointUserName string: The source endpoint username. This parameter is not required when the database_type is Redis, or when the source_endpoint_instance_type is Agent and the database_type is MSSQL. This parameter is required in other scenarios.
status string: The status of the resource. Valid values: pause, running.
storageRegion string: The storage region.
usedTime number: Specify purchase duration. When the parameter period is Year, the used_time value is 1 to 9. When the parameter period is Month, the used_time value is 1 to 11.

backup_method str: Backup method. Valid values: duplication, logical, physical.
backup_plan_name str: The name of the resource.
database_type str: Database type. Valid values: DRDS, FIle, MSSQL, MariaDB, MongoDB, MySQL, Oracle, PPAS, PostgreSQL, Redis.
instance_class str: The instance class. Valid values: large, medium, micro, small, xlarge.
source_endpoint_instance_type str: The location of the database. Valid values: RDS, ECS, Express, Agent, DDS, Other.
backup_gateway_id str: The ID of the backup gateway. This parameter is required when the source_endpoint_instance_type is Agent.
backup_log_interval_seconds int: The backup log interval seconds.
backup_objects str: The backup object.
backup_period str: Full backup cycle, Valid values: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday. supports the selection of multiple fetch values, separated by English commas (,).
backup_rate_limit str: The backup rate limit.
backup_retention_period int: The retention time of backup data. Valid values: 0 to 1825. Default value: 730 days.
backup_speed_limit str: The backup speed limit.
backup_start_time str: The start time of full Backup. The format is  HH:mm Z(UTC time).
backup_storage_type str: Built-in storage type, Valid values: system.
backup_strategy_type str: The backup strategy type. Valid values: simple, manual.
cross_aliyun_id str: The UID that is backed up across Alibaba cloud accounts.
cross_role_name str: The name of the RAM role that is backed up across Alibaba cloud accounts.
database_region str: The database region.
duplication_archive_period int: The storage time for conversion to archive cold standby is 365 days by default.
duplication_infrequent_access_period int: The storage time is converted to low-frequency access. The default time is 180 days.
enable_backup_log bool: Whether to enable incremental log Backup.
instance_type str: The instance type. Valid values: RDS, PolarDB, DDS, Kvstore, Other.
oss_bucket_name str: The OSS Bucket name. The system automatically generates a new name by default.
payment_type str: The payment type of the resource. Valid values: PayAsYouGo, Subscription.
period str: Specify that the prepaid instance is of the package year or monthly type. Valid values: Month, Year.
resource_group_id str: The ID of the resource group.
source_endpoint_database_name str: The name of the database. This parameter is required when the database_type is PostgreSQL or MongoDB.
source_endpoint_instance_id str: The ID of the database instance. This parameter is required when the source_endpoint_instance_type is RDS, ECS, DDS, or Express.
source_endpoint_ip str: The source endpoint ip.
source_endpoint_oracle_sid str: Oracle SID name. This parameter is required when the database_type is Oracle.
source_endpoint_password str: The source endpoint password. This parameter is not required when the database_type is Redis, or when the source_endpoint_instance_type is Agent and the database_type is MSSQL. This parameter is required in other scenarios.
source_endpoint_port int: The source endpoint port.
source_endpoint_region str: The region of the database. This parameter is required when the source_endpoint_instance_type is RDS, ECS, DDS, Express, or Agent.
source_endpoint_sid str: Oracle SID name. This parameter is required when the database_type is Oracle.
source_endpoint_user_name str: The source endpoint username. This parameter is not required when the database_type is Redis, or when the source_endpoint_instance_type is Agent and the database_type is MSSQL. This parameter is required in other scenarios.
status str: The status of the resource. Valid values: pause, running.
storage_region str: The storage region.
used_time int: Specify purchase duration. When the parameter period is Year, the used_time value is 1 to 9. When the parameter period is Month, the used_time value is 1 to 11.

backupMethod String: Backup method. Valid values: duplication, logical, physical.
backupPlanName String: The name of the resource.
databaseType String: Database type. Valid values: DRDS, FIle, MSSQL, MariaDB, MongoDB, MySQL, Oracle, PPAS, PostgreSQL, Redis.
instanceClass String: The instance class. Valid values: large, medium, micro, small, xlarge.
sourceEndpointInstanceType String: The location of the database. Valid values: RDS, ECS, Express, Agent, DDS, Other.
backupGatewayId String: The ID of the backup gateway. This parameter is required when the source_endpoint_instance_type is Agent.
backupLogIntervalSeconds Number: The backup log interval seconds.
backupObjects String: The backup object.
backupPeriod String: Full backup cycle, Valid values: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday. supports the selection of multiple fetch values, separated by English commas (,).
backupRateLimit String: The backup rate limit.
backupRetentionPeriod Number: The retention time of backup data. Valid values: 0 to 1825. Default value: 730 days.
backupSpeedLimit String: The backup speed limit.
backupStartTime String: The start time of full Backup. The format is  HH:mm Z(UTC time).
backupStorageType String: Built-in storage type, Valid values: system.
backupStrategyType String: The backup strategy type. Valid values: simple, manual.
crossAliyunId String: The UID that is backed up across Alibaba cloud accounts.
crossRoleName String: The name of the RAM role that is backed up across Alibaba cloud accounts.
databaseRegion String: The database region.
duplicationArchivePeriod Number: The storage time for conversion to archive cold standby is 365 days by default.
duplicationInfrequentAccessPeriod Number: The storage time is converted to low-frequency access. The default time is 180 days.
enableBackupLog Boolean: Whether to enable incremental log Backup.
instanceType String: The instance type. Valid values: RDS, PolarDB, DDS, Kvstore, Other.
ossBucketName String: The OSS Bucket name. The system automatically generates a new name by default.
paymentType String: The payment type of the resource. Valid values: PayAsYouGo, Subscription.
period String: Specify that the prepaid instance is of the package year or monthly type. Valid values: Month, Year.
resourceGroupId String: The ID of the resource group.
sourceEndpointDatabaseName String: The name of the database. This parameter is required when the database_type is PostgreSQL or MongoDB.
sourceEndpointInstanceId String: The ID of the database instance. This parameter is required when the source_endpoint_instance_type is RDS, ECS, DDS, or Express.
sourceEndpointIp String: The source endpoint ip.
sourceEndpointOracleSid String: Oracle SID name. This parameter is required when the database_type is Oracle.
sourceEndpointPassword String: The source endpoint password. This parameter is not required when the database_type is Redis, or when the source_endpoint_instance_type is Agent and the database_type is MSSQL. This parameter is required in other scenarios.
sourceEndpointPort Number: The source endpoint port.
sourceEndpointRegion String: The region of the database. This parameter is required when the source_endpoint_instance_type is RDS, ECS, DDS, Express, or Agent.
sourceEndpointSid String: Oracle SID name. This parameter is required when the database_type is Oracle.
sourceEndpointUserName String: The source endpoint username. This parameter is not required when the database_type is Redis, or when the source_endpoint_instance_type is Agent and the database_type is MSSQL. This parameter is required in other scenarios.
status String: The status of the resource. Valid values: pause, running.
storageRegion String: The storage region.
usedTime Number: Specify purchase duration. When the parameter period is Year, the used_time value is 1 to 9. When the parameter period is Month, the used_time value is 1 to 11.

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 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,
        backup_gateway_id: Optional[str] = None,
        backup_log_interval_seconds: Optional[int] = None,
        backup_method: Optional[str] = None,
        backup_objects: Optional[str] = None,
        backup_period: Optional[str] = None,
        backup_plan_name: Optional[str] = None,
        backup_rate_limit: Optional[str] = None,
        backup_retention_period: Optional[int] = None,
        backup_speed_limit: Optional[str] = None,
        backup_start_time: Optional[str] = None,
        backup_storage_type: Optional[str] = None,
        backup_strategy_type: Optional[str] = None,
        cross_aliyun_id: Optional[str] = None,
        cross_role_name: Optional[str] = None,
        database_region: Optional[str] = None,
        database_type: Optional[str] = None,
        duplication_archive_period: Optional[int] = None,
        duplication_infrequent_access_period: Optional[int] = None,
        enable_backup_log: Optional[bool] = None,
        instance_class: Optional[str] = None,
        instance_type: Optional[str] = None,
        oss_bucket_name: Optional[str] = None,
        payment_type: Optional[str] = None,
        period: Optional[str] = None,
        resource_group_id: Optional[str] = None,
        source_endpoint_database_name: Optional[str] = None,
        source_endpoint_instance_id: Optional[str] = None,
        source_endpoint_instance_type: Optional[str] = None,
        source_endpoint_ip: Optional[str] = None,
        source_endpoint_oracle_sid: Optional[str] = None,
        source_endpoint_password: Optional[str] = None,
        source_endpoint_port: Optional[int] = None,
        source_endpoint_region: Optional[str] = None,
        source_endpoint_sid: Optional[str] = None,
        source_endpoint_user_name: Optional[str] = None,
        status: Optional[str] = None,
        storage_region: Optional[str] = None,
        used_time: 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:

BackupGatewayId string: The ID of the backup gateway. This parameter is required when the source_endpoint_instance_type is Agent.
BackupLogIntervalSeconds int: The backup log interval seconds.
BackupMethod string: Backup method. Valid values: duplication, logical, physical.
BackupObjects string: The backup object.
BackupPeriod string: Full backup cycle, Valid values: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday. supports the selection of multiple fetch values, separated by English commas (,).
BackupPlanName string: The name of the resource.
BackupRateLimit string: The backup rate limit.
BackupRetentionPeriod int: The retention time of backup data. Valid values: 0 to 1825. Default value: 730 days.
BackupSpeedLimit string: The backup speed limit.
BackupStartTime string: The start time of full Backup. The format is  HH:mm Z(UTC time).
BackupStorageType string: Built-in storage type, Valid values: system.
BackupStrategyType string: The backup strategy type. Valid values: simple, manual.
CrossAliyunId string: The UID that is backed up across Alibaba cloud accounts.
CrossRoleName string: The name of the RAM role that is backed up across Alibaba cloud accounts.
DatabaseRegion string: The database region.
DatabaseType string: Database type. Valid values: DRDS, FIle, MSSQL, MariaDB, MongoDB, MySQL, Oracle, PPAS, PostgreSQL, Redis.
DuplicationArchivePeriod int: The storage time for conversion to archive cold standby is 365 days by default.
DuplicationInfrequentAccessPeriod int: The storage time is converted to low-frequency access. The default time is 180 days.
EnableBackupLog bool: Whether to enable incremental log Backup.
InstanceClass string: The instance class. Valid values: large, medium, micro, small, xlarge.
InstanceType string: The instance type. Valid values: RDS, PolarDB, DDS, Kvstore, Other.
OssBucketName string: The OSS Bucket name. The system automatically generates a new name by default.
PaymentType string: The payment type of the resource. Valid values: PayAsYouGo, Subscription.
Period string: Specify that the prepaid instance is of the package year or monthly type. Valid values: Month, Year.
ResourceGroupId string: The ID of the resource group.
SourceEndpointDatabaseName string: The name of the database. This parameter is required when the database_type is PostgreSQL or MongoDB.
SourceEndpointInstanceId string: The ID of the database instance. This parameter is required when the source_endpoint_instance_type is RDS, ECS, DDS, or Express.
SourceEndpointInstanceType string: The location of the database. Valid values: RDS, ECS, Express, Agent, DDS, Other.
SourceEndpointIp string: The source endpoint ip.
SourceEndpointOracleSid string: Oracle SID name. This parameter is required when the database_type is Oracle.
SourceEndpointPassword string: The source endpoint password. This parameter is not required when the database_type is Redis, or when the source_endpoint_instance_type is Agent and the database_type is MSSQL. This parameter is required in other scenarios.
SourceEndpointPort int: The source endpoint port.
SourceEndpointRegion string: The region of the database. This parameter is required when the source_endpoint_instance_type is RDS, ECS, DDS, Express, or Agent.
SourceEndpointSid string: Oracle SID name. This parameter is required when the database_type is Oracle.
SourceEndpointUserName string: The source endpoint username. This parameter is not required when the database_type is Redis, or when the source_endpoint_instance_type is Agent and the database_type is MSSQL. This parameter is required in other scenarios.
Status string: The status of the resource. Valid values: pause, running.
StorageRegion string: The storage region.
UsedTime int: Specify purchase duration. When the parameter period is Year, the used_time value is 1 to 9. When the parameter period is Month, the used_time value is 1 to 11.

BackupGatewayId string: The ID of the backup gateway. This parameter is required when the source_endpoint_instance_type is Agent.
BackupLogIntervalSeconds int: The backup log interval seconds.
BackupMethod string: Backup method. Valid values: duplication, logical, physical.
BackupObjects string: The backup object.
BackupPeriod string: Full backup cycle, Valid values: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday. supports the selection of multiple fetch values, separated by English commas (,).
BackupPlanName string: The name of the resource.
BackupRateLimit string: The backup rate limit.
BackupRetentionPeriod int: The retention time of backup data. Valid values: 0 to 1825. Default value: 730 days.
BackupSpeedLimit string: The backup speed limit.
BackupStartTime string: The start time of full Backup. The format is  HH:mm Z(UTC time).
BackupStorageType string: Built-in storage type, Valid values: system.
BackupStrategyType string: The backup strategy type. Valid values: simple, manual.
CrossAliyunId string: The UID that is backed up across Alibaba cloud accounts.
CrossRoleName string: The name of the RAM role that is backed up across Alibaba cloud accounts.
DatabaseRegion string: The database region.
DatabaseType string: Database type. Valid values: DRDS, FIle, MSSQL, MariaDB, MongoDB, MySQL, Oracle, PPAS, PostgreSQL, Redis.
DuplicationArchivePeriod int: The storage time for conversion to archive cold standby is 365 days by default.
DuplicationInfrequentAccessPeriod int: The storage time is converted to low-frequency access. The default time is 180 days.
EnableBackupLog bool: Whether to enable incremental log Backup.
InstanceClass string: The instance class. Valid values: large, medium, micro, small, xlarge.
InstanceType string: The instance type. Valid values: RDS, PolarDB, DDS, Kvstore, Other.
OssBucketName string: The OSS Bucket name. The system automatically generates a new name by default.
PaymentType string: The payment type of the resource. Valid values: PayAsYouGo, Subscription.
Period string: Specify that the prepaid instance is of the package year or monthly type. Valid values: Month, Year.
ResourceGroupId string: The ID of the resource group.
SourceEndpointDatabaseName string: The name of the database. This parameter is required when the database_type is PostgreSQL or MongoDB.
SourceEndpointInstanceId string: The ID of the database instance. This parameter is required when the source_endpoint_instance_type is RDS, ECS, DDS, or Express.
SourceEndpointInstanceType string: The location of the database. Valid values: RDS, ECS, Express, Agent, DDS, Other.
SourceEndpointIp string: The source endpoint ip.
SourceEndpointOracleSid string: Oracle SID name. This parameter is required when the database_type is Oracle.
SourceEndpointPassword string: The source endpoint password. This parameter is not required when the database_type is Redis, or when the source_endpoint_instance_type is Agent and the database_type is MSSQL. This parameter is required in other scenarios.
SourceEndpointPort int: The source endpoint port.
SourceEndpointRegion string: The region of the database. This parameter is required when the source_endpoint_instance_type is RDS, ECS, DDS, Express, or Agent.
SourceEndpointSid string: Oracle SID name. This parameter is required when the database_type is Oracle.
SourceEndpointUserName string: The source endpoint username. This parameter is not required when the database_type is Redis, or when the source_endpoint_instance_type is Agent and the database_type is MSSQL. This parameter is required in other scenarios.
Status string: The status of the resource. Valid values: pause, running.
StorageRegion string: The storage region.
UsedTime int: Specify purchase duration. When the parameter period is Year, the used_time value is 1 to 9. When the parameter period is Month, the used_time value is 1 to 11.

backupGatewayId String: The ID of the backup gateway. This parameter is required when the source_endpoint_instance_type is Agent.
backupLogIntervalSeconds Integer: The backup log interval seconds.
backupMethod String: Backup method. Valid values: duplication, logical, physical.
backupObjects String: The backup object.
backupPeriod String: Full backup cycle, Valid values: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday. supports the selection of multiple fetch values, separated by English commas (,).
backupPlanName String: The name of the resource.
backupRateLimit String: The backup rate limit.
backupRetentionPeriod Integer: The retention time of backup data. Valid values: 0 to 1825. Default value: 730 days.
backupSpeedLimit String: The backup speed limit.
backupStartTime String: The start time of full Backup. The format is  HH:mm Z(UTC time).
backupStorageType String: Built-in storage type, Valid values: system.
backupStrategyType String: The backup strategy type. Valid values: simple, manual.
crossAliyunId String: The UID that is backed up across Alibaba cloud accounts.
crossRoleName String: The name of the RAM role that is backed up across Alibaba cloud accounts.
databaseRegion String: The database region.
databaseType String: Database type. Valid values: DRDS, FIle, MSSQL, MariaDB, MongoDB, MySQL, Oracle, PPAS, PostgreSQL, Redis.
duplicationArchivePeriod Integer: The storage time for conversion to archive cold standby is 365 days by default.
duplicationInfrequentAccessPeriod Integer: The storage time is converted to low-frequency access. The default time is 180 days.
enableBackupLog Boolean: Whether to enable incremental log Backup.
instanceClass String: The instance class. Valid values: large, medium, micro, small, xlarge.
instanceType String: The instance type. Valid values: RDS, PolarDB, DDS, Kvstore, Other.
ossBucketName String: The OSS Bucket name. The system automatically generates a new name by default.
paymentType String: The payment type of the resource. Valid values: PayAsYouGo, Subscription.
period String: Specify that the prepaid instance is of the package year or monthly type. Valid values: Month, Year.
resourceGroupId String: The ID of the resource group.
sourceEndpointDatabaseName String: The name of the database. This parameter is required when the database_type is PostgreSQL or MongoDB.
sourceEndpointInstanceId String: The ID of the database instance. This parameter is required when the source_endpoint_instance_type is RDS, ECS, DDS, or Express.
sourceEndpointInstanceType String: The location of the database. Valid values: RDS, ECS, Express, Agent, DDS, Other.
sourceEndpointIp String: The source endpoint ip.
sourceEndpointOracleSid String: Oracle SID name. This parameter is required when the database_type is Oracle.
sourceEndpointPassword String: The source endpoint password. This parameter is not required when the database_type is Redis, or when the source_endpoint_instance_type is Agent and the database_type is MSSQL. This parameter is required in other scenarios.
sourceEndpointPort Integer: The source endpoint port.
sourceEndpointRegion String: The region of the database. This parameter is required when the source_endpoint_instance_type is RDS, ECS, DDS, Express, or Agent.
sourceEndpointSid String: Oracle SID name. This parameter is required when the database_type is Oracle.
sourceEndpointUserName String: The source endpoint username. This parameter is not required when the database_type is Redis, or when the source_endpoint_instance_type is Agent and the database_type is MSSQL. This parameter is required in other scenarios.
status String: The status of the resource. Valid values: pause, running.
storageRegion String: The storage region.
usedTime Integer: Specify purchase duration. When the parameter period is Year, the used_time value is 1 to 9. When the parameter period is Month, the used_time value is 1 to 11.

backupGatewayId string: The ID of the backup gateway. This parameter is required when the source_endpoint_instance_type is Agent.
backupLogIntervalSeconds number: The backup log interval seconds.
backupMethod string: Backup method. Valid values: duplication, logical, physical.
backupObjects string: The backup object.
backupPeriod string: Full backup cycle, Valid values: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday. supports the selection of multiple fetch values, separated by English commas (,).
backupPlanName string: The name of the resource.
backupRateLimit string: The backup rate limit.
backupRetentionPeriod number: The retention time of backup data. Valid values: 0 to 1825. Default value: 730 days.
backupSpeedLimit string: The backup speed limit.
backupStartTime string: The start time of full Backup. The format is  HH:mm Z(UTC time).
backupStorageType string: Built-in storage type, Valid values: system.
backupStrategyType string: The backup strategy type. Valid values: simple, manual.
crossAliyunId string: The UID that is backed up across Alibaba cloud accounts.
crossRoleName string: The name of the RAM role that is backed up across Alibaba cloud accounts.
databaseRegion string: The database region.
databaseType string: Database type. Valid values: DRDS, FIle, MSSQL, MariaDB, MongoDB, MySQL, Oracle, PPAS, PostgreSQL, Redis.
duplicationArchivePeriod number: The storage time for conversion to archive cold standby is 365 days by default.
duplicationInfrequentAccessPeriod number: The storage time is converted to low-frequency access. The default time is 180 days.
enableBackupLog boolean: Whether to enable incremental log Backup.
instanceClass string: The instance class. Valid values: large, medium, micro, small, xlarge.
instanceType string: The instance type. Valid values: RDS, PolarDB, DDS, Kvstore, Other.
ossBucketName string: The OSS Bucket name. The system automatically generates a new name by default.
paymentType string: The payment type of the resource. Valid values: PayAsYouGo, Subscription.
period string: Specify that the prepaid instance is of the package year or monthly type. Valid values: Month, Year.
resourceGroupId string: The ID of the resource group.
sourceEndpointDatabaseName string: The name of the database. This parameter is required when the database_type is PostgreSQL or MongoDB.
sourceEndpointInstanceId string: The ID of the database instance. This parameter is required when the source_endpoint_instance_type is RDS, ECS, DDS, or Express.
sourceEndpointInstanceType string: The location of the database. Valid values: RDS, ECS, Express, Agent, DDS, Other.
sourceEndpointIp string: The source endpoint ip.
sourceEndpointOracleSid string: Oracle SID name. This parameter is required when the database_type is Oracle.
sourceEndpointPassword string: The source endpoint password. This parameter is not required when the database_type is Redis, or when the source_endpoint_instance_type is Agent and the database_type is MSSQL. This parameter is required in other scenarios.
sourceEndpointPort number: The source endpoint port.
sourceEndpointRegion string: The region of the database. This parameter is required when the source_endpoint_instance_type is RDS, ECS, DDS, Express, or Agent.
sourceEndpointSid string: Oracle SID name. This parameter is required when the database_type is Oracle.
sourceEndpointUserName string: The source endpoint username. This parameter is not required when the database_type is Redis, or when the source_endpoint_instance_type is Agent and the database_type is MSSQL. This parameter is required in other scenarios.
status string: The status of the resource. Valid values: pause, running.
storageRegion string: The storage region.
usedTime number: Specify purchase duration. When the parameter period is Year, the used_time value is 1 to 9. When the parameter period is Month, the used_time value is 1 to 11.

backup_gateway_id str: The ID of the backup gateway. This parameter is required when the source_endpoint_instance_type is Agent.
backup_log_interval_seconds int: The backup log interval seconds.
backup_method str: Backup method. Valid values: duplication, logical, physical.
backup_objects str: The backup object.
backup_period str: Full backup cycle, Valid values: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday. supports the selection of multiple fetch values, separated by English commas (,).
backup_plan_name str: The name of the resource.
backup_rate_limit str: The backup rate limit.
backup_retention_period int: The retention time of backup data. Valid values: 0 to 1825. Default value: 730 days.
backup_speed_limit str: The backup speed limit.
backup_start_time str: The start time of full Backup. The format is  HH:mm Z(UTC time).
backup_storage_type str: Built-in storage type, Valid values: system.
backup_strategy_type str: The backup strategy type. Valid values: simple, manual.
cross_aliyun_id str: The UID that is backed up across Alibaba cloud accounts.
cross_role_name str: The name of the RAM role that is backed up across Alibaba cloud accounts.
database_region str: The database region.
database_type str: Database type. Valid values: DRDS, FIle, MSSQL, MariaDB, MongoDB, MySQL, Oracle, PPAS, PostgreSQL, Redis.
duplication_archive_period int: The storage time for conversion to archive cold standby is 365 days by default.
duplication_infrequent_access_period int: The storage time is converted to low-frequency access. The default time is 180 days.
enable_backup_log bool: Whether to enable incremental log Backup.
instance_class str: The instance class. Valid values: large, medium, micro, small, xlarge.
instance_type str: The instance type. Valid values: RDS, PolarDB, DDS, Kvstore, Other.
oss_bucket_name str: The OSS Bucket name. The system automatically generates a new name by default.
payment_type str: The payment type of the resource. Valid values: PayAsYouGo, Subscription.
period str: Specify that the prepaid instance is of the package year or monthly type. Valid values: Month, Year.
resource_group_id str: The ID of the resource group.
source_endpoint_database_name str: The name of the database. This parameter is required when the database_type is PostgreSQL or MongoDB.
source_endpoint_instance_id str: The ID of the database instance. This parameter is required when the source_endpoint_instance_type is RDS, ECS, DDS, or Express.
source_endpoint_instance_type str: The location of the database. Valid values: RDS, ECS, Express, Agent, DDS, Other.
source_endpoint_ip str: The source endpoint ip.
source_endpoint_oracle_sid str: Oracle SID name. This parameter is required when the database_type is Oracle.
source_endpoint_password str: The source endpoint password. This parameter is not required when the database_type is Redis, or when the source_endpoint_instance_type is Agent and the database_type is MSSQL. This parameter is required in other scenarios.
source_endpoint_port int: The source endpoint port.
source_endpoint_region str: The region of the database. This parameter is required when the source_endpoint_instance_type is RDS, ECS, DDS, Express, or Agent.
source_endpoint_sid str: Oracle SID name. This parameter is required when the database_type is Oracle.
source_endpoint_user_name str: The source endpoint username. This parameter is not required when the database_type is Redis, or when the source_endpoint_instance_type is Agent and the database_type is MSSQL. This parameter is required in other scenarios.
status str: The status of the resource. Valid values: pause, running.
storage_region str: The storage region.
used_time int: Specify purchase duration. When the parameter period is Year, the used_time value is 1 to 9. When the parameter period is Month, the used_time value is 1 to 11.

backupGatewayId String: The ID of the backup gateway. This parameter is required when the source_endpoint_instance_type is Agent.
backupLogIntervalSeconds Number: The backup log interval seconds.
backupMethod String: Backup method. Valid values: duplication, logical, physical.
backupObjects String: The backup object.
backupPeriod String: Full backup cycle, Valid values: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday. supports the selection of multiple fetch values, separated by English commas (,).
backupPlanName String: The name of the resource.
backupRateLimit String: The backup rate limit.
backupRetentionPeriod Number: The retention time of backup data. Valid values: 0 to 1825. Default value: 730 days.
backupSpeedLimit String: The backup speed limit.
backupStartTime String: The start time of full Backup. The format is  HH:mm Z(UTC time).
backupStorageType String: Built-in storage type, Valid values: system.
backupStrategyType String: The backup strategy type. Valid values: simple, manual.
crossAliyunId String: The UID that is backed up across Alibaba cloud accounts.
crossRoleName String: The name of the RAM role that is backed up across Alibaba cloud accounts.
databaseRegion String: The database region.
databaseType String: Database type. Valid values: DRDS, FIle, MSSQL, MariaDB, MongoDB, MySQL, Oracle, PPAS, PostgreSQL, Redis.
duplicationArchivePeriod Number: The storage time for conversion to archive cold standby is 365 days by default.
duplicationInfrequentAccessPeriod Number: The storage time is converted to low-frequency access. The default time is 180 days.
enableBackupLog Boolean: Whether to enable incremental log Backup.
instanceClass String: The instance class. Valid values: large, medium, micro, small, xlarge.
instanceType String: The instance type. Valid values: RDS, PolarDB, DDS, Kvstore, Other.
ossBucketName String: The OSS Bucket name. The system automatically generates a new name by default.
paymentType String: The payment type of the resource. Valid values: PayAsYouGo, Subscription.
period String: Specify that the prepaid instance is of the package year or monthly type. Valid values: Month, Year.
resourceGroupId String: The ID of the resource group.
sourceEndpointDatabaseName String: The name of the database. This parameter is required when the database_type is PostgreSQL or MongoDB.
sourceEndpointInstanceId String: The ID of the database instance. This parameter is required when the source_endpoint_instance_type is RDS, ECS, DDS, or Express.
sourceEndpointInstanceType String: The location of the database. Valid values: RDS, ECS, Express, Agent, DDS, Other.
sourceEndpointIp String: The source endpoint ip.
sourceEndpointOracleSid String: Oracle SID name. This parameter is required when the database_type is Oracle.
sourceEndpointPassword String: The source endpoint password. This parameter is not required when the database_type is Redis, or when the source_endpoint_instance_type is Agent and the database_type is MSSQL. This parameter is required in other scenarios.
sourceEndpointPort Number: The source endpoint port.
sourceEndpointRegion String: The region of the database. This parameter is required when the source_endpoint_instance_type is RDS, ECS, DDS, Express, or Agent.
sourceEndpointSid String: Oracle SID name. This parameter is required when the database_type is Oracle.
sourceEndpointUserName String: The source endpoint username. This parameter is not required when the database_type is Redis, or when the source_endpoint_instance_type is Agent and the database_type is MSSQL. This parameter is required in other scenarios.
status String: The status of the resource. Valid values: pause, running.
storageRegion String: The storage region.
usedTime Number: Specify purchase duration. When the parameter period is Year, the used_time value is 1 to 9. When the parameter period is Month, the used_time value is 1 to 11.

Import

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

 $ pulumi import alicloud:dbs/backupPlan:BackupPlan example <id>

Package Details

Repository: Alibaba Cloud pulumi/pulumi-alicloud
License: Apache-2.0
Notes: This Pulumi package is based on the alicloud Terraform Provider.