ALIYUN::RDS::PostgresExtensions - Resource Orchestration Service

ALIYUN::RDS::PostgresExtensions is used to install extensions on a database.

Syntax

{
  "Type": "ALIYUN::RDS::PostgresExtensions",
  "Properties": {
    "AccountName": String,
    "DBInstanceId": String,
    "DBName": String,
    "Extensions": List,
    "ResourceGroupId": String,
    "RiskConfirmed": Boolean,
    "SourceDatabase": String
  }
}

Properties

Property	Type	Required	Editable	Description	Constraint
AccountName	String	Yes	No	The account to which the extensions belong.	Only privileged accounts are supported.
DBInstanceId	String	Yes	No	The instance ID.	None.
DBName	String	Yes	No	The name of the database on the instance.	None.
Extensions	List	No	No	The extensions that you want to install.	You can install up to 10 extensions.
ResourceGroupId	String	No	No	The ID of the resource group.	None.
RiskConfirmed	Boolean	No	No	Specifies whether to confirm security risks. Security risks may occur if you install specific extensions on an instance that uses an outdated minor engine version. Proceed with the installation only after you acknowledge the risks.	Valid values: true false
SourceDatabase	String	No	No	The source database from which you want to synchronize the extensions to the destination database.	You must specify this property when Extensions is left empty.

Return values

Fn::GetAtt

InstalledExtensionNames: the names of the installed extensions.

Examples

Note

You must change the masked values of properties, such as the DBInstanceId property, based on your business requirements.

`YAML` format

ROSTemplateFormatVersion: '2015-09-01'
Parameters: {}
Resources:
  PostgresExtensions:
    Type: ALIYUN::RDS::PostgresExtensions
    Properties:
      DBInstanceId: pgm-gc7f1****
      DBName: test_db
      AccountName: test_user
Outputs:
  InstalledExtensionNames:
    Description: Extension names installed via ROS
    Value:
      Fn::GetAtt:
        - PostgresExtensions
        - InstalledExtensionNames

`JSON` format

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
  },
  "Resources": {
    "PostgresExtensions": {
      "Type": "ALIYUN::RDS::PostgresExtensions",
      "Properties": {
        "DBInstanceId": "pgm-gc7f1****",
        "DBName": "test_db",
        "AccountName": "test_user"
      }
    }
  },
  "Outputs": {
    "InstalledExtensionNames": {
      "Description": "Extension names installed via ROS",
      "Value": {
        "Fn::GetAtt": [
          "PostgresExtensions",
          "InstalledExtensionNames"
        ]
      }
    }
  }
}