ALIYUN::MONGODB::AuditPolicy - Resource Orchestration Service

The ALIYUN::MONGODB::AuditPolicy type enables or disables the audit log for an instance, or sets the audit log retention duration.

Syntax

{
  "Type": "ALIYUN::MONGODB::AuditPolicy",
  "Properties": {
    "AuditStatus": String,
    "DBInstanceId": String,
    "StoragePeriod": Integer
  }
}

Properties

Parameter	Type	Required	Editable	Description	Constraints
AuditStatus	String	Yes	Yes	Specifies whether the audit log is enabled.	Valid values: enable disabled
DBInstanceId	String	Yes	No	The ID of the database instance.	None
StoragePeriod	Integer	No	Yes	The retention duration for audit logs, in days.	Range: 1 to 365. Default: 30.

Return Values

Fn::GetAtt

AuditStatus: The current audit status of the instance.

Examples

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  AuditStatus:
    Type: String
    Description:
      en: 'The audit status. Valid values: `enable`, `disabled`.'
    AllowedValues:
      - enable
      - disabled
    Required: true
  DBInstanceId:
    Type: String
    Description:
      en: The database instance ID.
    Required: true
  StoragePeriod:
    Type: Number
    Description:
      en: 'The audit log retention duration, in days. Valid values: 1 to 365. Default value: 30.'
    MinValue: 1
    MaxValue: 365
    Default: Null
    Required: false
Resources:
  ExtensionResource:
    Type: ALIYUN::MONGODB::AuditPolicy
    Properties:
      AuditStatus:
        Ref: AuditStatus
      DBInstanceId:
        Ref: DBInstanceId
      StoragePeriod:
        Ref: StoragePeriod
Outputs:
  AuditStatus:
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - AuditStatus
    Description: 'The audit status. Valid values: `enable`, `disabled`.'

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "AuditStatus": {
      "Type": "String",
      "Description": {
        "en": "The audit status. Valid values: `enable`, `disabled`."
      },
      "AllowedValues": [
        "enable",
        "disabled"
      ],
      "Required": true
    },
    "DBInstanceId": {
      "Type": "String",
      "Description": {
        "en": "The database instance ID."
      },
      "Required": true
    },
    "StoragePeriod": {
      "Type": "Number",
      "Description": {
        "en": "The audit log retention duration, in days. Valid values: 1 to 365. Default value: 30."
      },
      "MinValue": 1,
      "MaxValue": 365,
      "Default": null,
      "Required": false
    }
  },
  "Resources": {
    "ExtensionResource": {
      "Type": "ALIYUN::MONGODB::AuditPolicy",
      "Properties": {
        "AuditStatus": {
          "Ref": "AuditStatus"
        },
        "DBInstanceId": {
          "Ref": "DBInstanceId"
        },
        "StoragePeriod": {
          "Ref": "StoragePeriod"
        }
      }
    }
  },
  "Outputs": {
    "AuditStatus": {
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "AuditStatus"
        ]
      },
      "Description": "The audit status. Valid values: `enable`, `disabled`."
    }
  }
}