All Products
Search

This Product

    Resource Orchestration Service:DATASOURCE::DBS::BackupPlans

    Document Center

    Resource Orchestration Service:DATASOURCE::DBS::BackupPlans

    Last Updated:Nov 01, 2024

    DATASOURCE::DBS::BackupPlans is used to query the information about backup schedules.

    Syntax

    {
  "Type": "DATASOURCE::DBS::BackupPlans",
  "Properties": {
    "BackupPlanName": String,
    "ResourceGroupId": String,
    "BackupPlanId": String,
    "RefreshOptions": String
  }
}

    Properties

    Property

    Type

    Required

    Editable

    Description

    Constraint

    BackupPlanName

    String

    No

    Yes

    The name of the backup schedule.

    None.

    ResourceGroupId

    String

    No

    Yes

    The ID of the resource group.

    None.

    BackupPlanId

    String

    No

    Yes

    The ID of the backup schedule.

    None.

    RefreshOptions

    String

    No

    Yes

    The refresh policy for data source resources when the stack is updated.

    Valid values:

    • Never (default): does not refresh data source resources when the stack is updated.

    • Always: refreshes data source resources when the stack is updated.

    Return values

    Fn::GetAtt

    • BackupPlanIds: the IDs of the backup schedules.

    • BackupPlans: details of the backup schedules.

    Property

    Type

    Description

    Constraint

    BackupPlanIds

    List

    The IDs of the backup schedules.

    None.

    BackupPlans

    List

    Details of the backup schedules.

    None.

    SourceEndpointUserName

    String

    The database account.

    None.

    BackupObjects

    String

    The objects that are backed up.

    None.

    EnableBackupLog

    String

    Indicates whether incremental log backup is enabled.

    None.

    DuplicationArchivePeriod

    String

    The number of days after which the storage class of the backup data is changed to Archive.

    None.

    CrossAliyunId

    String

    The unique identifier (UID) of the account that is used for backups performed across Alibaba Cloud accounts.

    None.

    BackupStorageType

    String

    The built-in storage type.

    None.

    SourceEndpointInstanceId

    String

    The ID of the database instance.

    None.

    BackupPlanId

    String

    The ID of the backup schedule.

    None.

    Status

    String

    The status of the backup schedule.

    None.

    OssBucketName

    String

    The name of the Object Storage Service (OSS) bucket.

    None.

    SourceEndpointDatabaseName

    String

    The database name.

    None.

    ResourceGroupId

    String

    The ID of the resource group.

    None.

    InstanceClass

    String

    The backup schedule type.

    None.

    SourceEndpointRegion

    String

    The region of the database.

    None.

    CrossRoleName

    String

    The name of the Resource Access Management (RAM) role that is used for backups performed across Alibaba Cloud accounts.

    None.

    BackupRetentionPeriod

    String

    The retention period of the backup data.

    Valid values: 0 to 1825.

    Unit: day.

    BackupMethod

    String

    The backup method.

    None.

    BackupPeriod

    String

    The full backup cycle.

    None.

    BackupGatewayId

    String

    The ID of the backup gateway.

    None.

    SourceEndpointSid

    String

    The system ID (SID) of the database instance.

    None.

    DuplicationInfrequentAccessPeriod

    String

    The number of days after which the storage class of the backup data is changed to Infrequent Access (IA).

    Unit: day.

    SourceEndpointInstanceType

    String

    The location of the database.

    None.

    BackupStartTime

    String

    The start time of the full backup.

    The time follows the ISO 8601 standard in the HH:mm format.

    DatabaseType

    String

    The type of the database engine.

    None.

    BackupPlanName

    String

    The name of the backup schedule.

    None.

    CreateTime

    String

    The time when the backup schedule was created.

    None.

    Examples

    YAML format

    ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  BackupPlanName:
    Description: The name of the backup schedule.
    Type: String
Resources:
  ExtensionDataSource:
    Properties:
      BackupPlanName:
        Ref: BackupPlanName
    Type: DATASOURCE::DBS::BackupPlans
Outputs:
  BackupPlanIds:
    Description: The list of backup plan IDs.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - BackupPlanIds
  BackupPlans:
    Description: The list of backup plans.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - BackupPlans

    JSON format 

    {
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "BackupPlanName": {
      "Type": "String",
      "Description": "The name of the backup schedule."
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::DBS::BackupPlans",
      "Properties": {
        "BackupPlanName": {
          "Ref": "BackupPlanName"
        }
      }
    }
  },
  "Outputs": {
    "BackupPlanIds": {
      "Description": "The list of backup plan IDs.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "BackupPlanIds"
        ]
      }
    },
    "BackupPlans": {
      "Description": "The list of backup plans.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "BackupPlans"
        ]
      }
    }
  }
}