通过

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Microsoft.AwsConnector rdsDBInstances

Bicep 资源定义

可以使用目标操作部署 rdsDBInstances 资源类型：

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.AwsConnector/rdsDBInstances 资源，请将以下 Bicep 添加到模板。

resource symbolicname 'Microsoft.AwsConnector/rdsDBInstances@2024-12-01' = {
  location: 'string'
  name: 'string'
  properties: {
    arn: 'string'
    awsAccountId: 'string'
    awsProperties: {
      allocatedStorage: 'string'
      allowMajorVersionUpgrade: bool
      associatedRoles: [
        {
          featureName: 'string'
          roleArn: 'string'
        }
      ]
      automaticBackupReplicationKmsKeyId: 'string'
      automaticBackupReplicationRegion: 'string'
      autoMinorVersionUpgrade: bool
      availabilityZone: 'string'
      backupRetentionPeriod: int
      caCertificateIdentifier: 'string'
      certificateDetails: {
        caIdentifier: 'string'
        validTill: 'string'
      }
      certificateRotationRestart: bool
      characterSetName: 'string'
      copyTagsToSnapshot: bool
      customIAMInstanceProfile: 'string'
      dbClusterIdentifier: 'string'
      dbClusterSnapshotIdentifier: 'string'
      dbInstanceArn: 'string'
      dbInstanceClass: 'string'
      dbInstanceIdentifier: 'string'
      dbiResourceId: 'string'
      dbName: 'string'
      dbParameterGroupName: 'string'
      dbSecurityGroups: [
        'string'
      ]
      dbSnapshotIdentifier: 'string'
      dbSubnetGroupName: 'string'
      dbSystemId: 'string'
      dedicatedLogVolume: bool
      deleteAutomatedBackups: bool
      deletionProtection: bool
      domain: 'string'
      domainAuthSecretArn: 'string'
      domainDnsIps: [
        'string'
      ]
      domainFqdn: 'string'
      domainIAMRoleName: 'string'
      domainOu: 'string'
      enableCloudwatchLogsExports: [
        'string'
      ]
      enableIAMDatabaseAuthentication: bool
      enablePerformanceInsights: bool
      endpoint: {
        address: 'string'
        hostedZoneId: 'string'
        port: 'string'
      }
      engine: 'string'
      engineVersion: 'string'
      iops: int
      kmsKeyId: 'string'
      licenseModel: 'string'
      manageMasterUserPassword: bool
      masterUsername: 'string'
      masterUserPassword: 'string'
      masterUserSecret: {
        kmsKeyId: 'string'
        secretArn: 'string'
      }
      maxAllocatedStorage: int
      monitoringInterval: int
      monitoringRoleArn: 'string'
      multiAZ: bool
      ncharCharacterSetName: 'string'
      networkType: 'string'
      optionGroupName: 'string'
      performanceInsightsKMSKeyId: 'string'
      performanceInsightsRetentionPeriod: int
      port: 'string'
      preferredBackupWindow: 'string'
      preferredMaintenanceWindow: 'string'
      processorFeatures: [
        {
          name: 'string'
          value: 'string'
        }
      ]
      promotionTier: int
      publiclyAccessible: bool
      replicaMode: 'string'
      restoreTime: 'string'
      sourceDBClusterIdentifier: 'string'
      sourceDBInstanceAutomatedBackupsArn: 'string'
      sourceDBInstanceIdentifier: 'string'
      sourceDbiResourceId: 'string'
      sourceRegion: 'string'
      storageEncrypted: bool
      storageThroughput: int
      storageType: 'string'
      tags: [
        {
          key: 'string'
          value: 'string'
        }
      ]
      tdeCredentialArn: 'string'
      tdeCredentialPassword: 'string'
      timezone: 'string'
      useDefaultProcessorFeatures: bool
      useLatestRestorableTime: bool
      vpcSecurityGroups: [
        'string'
      ]
    }
    awsRegion: 'string'
    awsSourceSchema: 'string'
    awsTags: {
      {customized property}: 'string'
    }
    publicCloudConnectorsResourceId: 'string'
    publicCloudResourceName: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

属性值

Microsoft.AwsConnector/rdsDBInstances

名字 描述 价值
位置 资源所在的地理位置 string （必需）
名字 资源名称 字符串

约束：
模式 = ^(?=.{0,259}[^\s.]$)(?!.*[<>%&\?/#]) （必需）
性能 此资源的资源特定属性。 RdsDBInstanceProperties
标签 资源标记 标记名称和值的字典。 请参阅模板 中的 标记

AwsRdsDBInstanceProperties

名字 描述 价值
allocatedStorage 最初为数据库实例分配的存储量（GiB）。 如果在 Iops 参数中设置了任何值，则 AllocatedStorage 必须至少为 100 GiB，该值对应于 1,000 的最小 Iops 值。 如果增加 Iops 值（以 1,000 IOPS 为增量），则还必须增加 AllocatedStorage 值（以 100-GiB 增量为单位）。 亚马逊奥罗拉 不适用。 随着数据库中的数据量的增加，极光群集卷会自动增长，但只需为在极光群集卷中使用的空间付费。 Db2 每个存储类型的存储量的约束如下：+ 常规用途（SSD）存储（gp3）：必须是 20 到 64000 之间的整数。 + 预配的 IOPS 存储（io1）：必须是 100 到 64000 的整数。 MySQL 每个存储类型的存储量的约束如下：+ 常规用途（SSD）存储（gp2）：必须是 20 到 65536 之间的整数。 + 预配的 IOPS 存储（io1）：必须是 100 到 65536 的整数。 + 磁存储（标准）：必须是 5 到 3072 的整数。 MariaDB 每个存储类型的存储量的约束如下：+ 常规用途（SSD）存储（gp2）：必须是 20 到 65536 之间的整数。 + 预配的 IOPS 存储（io1）：必须是 100 到 65536 的整数。 + 磁存储（标准）：必须是 5 到 3072 的整数。 PostgreSQL 每种存储类型的存储量的约束如下：+ 常规用途（SSD）存储（gp2）：必须是 20 到 65536 之间的整数。 + 预配的 IOPS 存储（io1）：必须是 100 到 65536 的整数。 + 磁存储（标准）：必须是 5 到 3072 的整数。 Oracle 每个存储类型的存储量的约束如下：+ 常规用途（SSD）存储（gp2）：必须是 20 到 65536 之间的整数。 + 预配的 IOPS 存储（io1）：必须是 100 到 65536 的整数。 + 磁存储（标准）：必须是 10 到 3072 的整数。 SQL Server 每个存储类型的存储量的约束如下：+ 常规用途（SSD）存储（gp2）：+ 企业版和标准版：必须是 20 到 16384 之间的整数。 + Web 和 Express 版本：必须是 20 到 16384 的整数。 + 预配的 IOPS 存储（io1）：+ 企业版和标准版：必须是 20 到 16384 的整数。 + Web 和 Express 版本：必须是 20 到 16384 的整数。 + 磁存储（标准）：+ 企业版和标准版：必须是 20 到 1024 的整数。 + Web 和 Express 版本：必须是 20 到 1024 的整数。 字符串
allowMajorVersionUpgrade 一个值，该值指示是否允许主要版本升级。 更改此参数不会导致中断，并且更改会尽快异步应用。 约束：为与 DB 实例的当前版本不同的 EngineVersion 参数指定值时，必须允许主要版本升级。 布尔
associatedRoles 与 DB 实例关联的 IAMlong （IAM） 角色。 亚马逊奥罗拉 不适用。 关联的角色由数据库群集管理。 DBInstanceRole[]
automaticBackupReplicationKmsKeyId 属性 automaticBackupReplicationKmsKeyId 字符串
automaticBackupReplicationRegion 数据库实例的备份复制的目标区域。 有关详细信息，请参阅 Amazon RDS 用户指南中的 将自动备份复制到另一个区域。 字符串
autoMinorVersionUpgrade 一个值，该值指示在维护时段内是否自动将次要引擎升级应用于 DB 实例。 默认情况下，会自动应用次要引擎升级。 布尔
可用性区域 将在其中创建数据库的可用性区域（AZ）。 有关 AWS-Regions 和可用性区域的信息，请参阅 区域和可用性区域。 对于 Amazon Aurora，每个极光 DB 群集在三个单独的可用性区域中托管其存储的副本。 指定其中一个可用性区域。 如果未指定一个，极光会自动选择适当的可用性区域。 默认值：终结点 AWS 区域中的随机系统选择的可用性区域。 约束：如果 DB 实例是多 AZ 部署，则无法指定 AvailabilityZone 参数。 + 指定的可用性区域必须与当前终结点位于同一 AWS-Region。 示例：us-east-1d 字符串
backupRetentionPeriod （备份保留期） 自动备份保留的天数。 将此参数设置为正数可启用备份。 将此参数设置为 0 会禁用自动备份。 亚马逊奥罗拉 不适用。 自动备份的保留期由数据库群集管理。 默认值：1 约束：+ 必须是介于 0 到 35 的值 + 如果 DB 实例是只读副本的源，则不能设置为 0 整数 (int)
caCertificateIdentifier 此 DB 实例的 CA 证书的标识符。 有关详细信息，请参阅 使用 SSL/TLS 加密与 Amazon RDS 用户指南 中的 DB 实例的连接，使用 SSL/TLS 加密与 Amazon Aurora 用户指南中与 DB 群集的连接。 字符串
证书详细信息 DB 实例的服务器证书的详细信息。 返回 DB 实例的服务器证书的详细信息。 有关详细信息，请参阅 使用 SSL/TLS 加密与 Amazon RDS 用户指南 中的 DB 实例的连接，使用 SSL/TLS 加密与 Amazon Aurora 用户指南中与 DB 群集的连接。 证书详细信息
certificateRotationRestart 证书 指定轮换 SSL/TLS 证书时是否重启 DB 实例。 默认情况下，轮换 SSL/TLS 证书时，将重启 DB 实例。 在重启数据库实例之前，证书不会更新。 仅当 不使用 SSL/TLS 连接到 DB 实例 时才设置此参数。 如果使用 SSL/TLS 连接到 DB 实例，请按照 DB 引擎的相应说明轮换 SSL/TLS 证书：+ 有关轮换 RDS DB 引擎的 SSL/TLS 证书的详细信息，请参阅 轮换 SSL/TLS 证书。Amazon RDS 用户指南中的。 + 有关轮换极光数据库引擎 SSL/TLS 证书的详细信息，请参阅 Amazon Aurora 用户指南中的 轮换 SSL/TLS 证书。 此设置不适用于 RDS 自定义数据库实例。 布尔
字符集名称 对于支持的引擎，指示 DB 实例应与指定的字符集相关联。 亚马逊奥罗拉 不适用。 字符集由数据库群集管理。 有关详细信息，请参阅 AWS：：RDS：:D BCluster。 字符串
copyTagsToSnapshot 指定是否将标记从 DB 实例复制到 DB 实例的快照。 默认情况下，不会复制标记。 此设置不适用于 Amazon Aurora DB 实例。 将标记复制到快照由数据库群集管理。 为极光 DB 实例设置此值不会影响 DB 群集设置。 布尔
customIAMInstanceProfile 与 RDS 自定义数据库实例的基础 Amazon EC2 实例关联的实例配置文件。 RDS 自定义需要此设置。 约束：+ 配置文件必须存在于帐户中。 + 配置文件必须具有 Amazon EC2 有权承担的 IAM 角色。 + 实例配置文件名称和关联的 IAM 角色名称必须以前缀 AWSRDSCustom开头。 有关 IAM 角色所需的权限列表，请参阅 Amazon RDS 用户指南中的 配置 IAM 和你的。 字符串
dbClusterIdentifier 数据库集群标识符 实例所属的 DB 群集的标识符。 字符串
dbClusterSnapshotIdentifier 数据库集群快照标识符 要从中还原的多 AZ DB 群集快照的标识符。 有关多 AZ DB 群集的详细信息，请参阅 Amazon RDS 用户指南中的 多 AZ DB 群集部署。 约束：+ 必须与现有多 AZ DB 群集快照的标识符匹配。 指定 DBSnapshotIdentifier 时无法指定 + 。 如果未指定 DBSnapshotIdentifier，则必须指定 + 。 + 如果要从共享手动多 AZ DB 群集快照还原，DBClusterSnapshotIdentifier 必须是共享快照的 ARN。 + 不能是极光数据库群集快照的标识符。 字符串
dbInstanceArn 数据库实例 属性 dbInstanceArn 字符串
dbInstance类 DB 实例的计算和内存容量，例如 db.m5.large。 并非所有 DB 实例类在所有 AWS 区域或所有数据库引擎中都可用。 有关 DB 实例类的完整列表以及引擎的可用性，请参阅 Amazon RDS 用户指南 中的 DB 实例类，或在 Amazon Aurora 用户指南 极光 DB 实例类。 字符串
dbInstanceIdentifier 数据库实例标识符 DB 实例的名称。 如果指定名称，AWS CloudFormation 会将它转换为小写。 如果未指定名称，AWS CloudFormation 将生成唯一的物理 ID，并将该 ID 用于数据库实例。 有关详细信息，请参阅 名称类型。 有关适用于 DB 实例标识符的约束的信息，请参阅 Amazon RDS 用户指南Amazon RDS 中的命名约束。 如果指定名称，则无法执行需要替换此资源的更新。 可以执行不需要或某些中断的更新。 如果必须替换资源，请指定一个新名称。 字符串
dbiResourceId 属性 dbiResourceId 字符串
数据库名称 此参数的含义因所使用的数据库引擎而异。 如果指定 DBSnapshotIdentifier 属性，则此属性仅适用于 Oracle 的 RDS。 亚马逊奥罗拉 不适用。 数据库名称由数据库群集管理。 Db2 创建数据库实例时要创建的数据库的名称。 如果未指定此参数，则不会在 DB 实例中创建任何数据库。 约束：+ 必须包含 1 到 64 个字母或数字。 + 必须以字母开头。 后续字符可以是字母、下划线或数字（0-9）。 + 不能是指定数据库引擎保留的单词。 MySQL 创建数据库实例时要创建的数据库的名称。 如果未指定此参数，则不会在 DB 实例中创建任何数据库。 约束：+ 必须包含 1 到 64 个字母或数字。 + 不能由指定的数据库引擎保留一个单词，MariaDB 创建数据库实例时要创建的数据库的名称。 如果未指定此参数，则不会在 DB 实例中创建任何数据库。 约束：+ 必须包含 1 到 64 个字母或数字。 + 无法由指定的数据库引擎保留一个单词，PostgreSQL 创建数据库实例时要创建的数据库的名称。 如果未指定此参数，则会在 DB 实例中创建默认 postgres 数据库。 约束：+ 必须以字母开头。 后续字符可以是字母、下划线或数字（0-9）。 + 必须包含 1 到 63 个字符。 + 不能由指定的数据库引擎保留一个单词，Oracle 创建的 DB 实例的 Oracle 系统 ID （SID）。 如果指定 null，则使用默认值 ORCL。 不能为 DBName指定字符串 NULL 或任何其他保留字。 默认值：ORCL 约束：+ 不能超过 8 个字符 SQL Server 不适用。 必须为 null。 字符串
dbParameterGroupName 数据库参数组名称 现有 DB 参数组的名称或对在模板中创建的 AWS：：RDS：:D BParameterGroup 资源的引用。 若要列出所有可用的 DB 参数组名称，请使用以下命令：aws rds describe-db-parameter-groups --query 'DBParameterGroups[].DBParameterGroupName' --output text 如果在更新期间更改了引用的参数组的任何数据成员，则可能需要重启 DB 实例，这会导致一些中断。 如果参数组包含静态参数（无论它们是否已更改），则更新会触发重新启动。 如果未为 DBParameterGroupName 属性指定值，则使用指定引擎和引擎版本的默认 DB 参数组。 字符串
dbSecurity组 要分配给 DB 实例的 DB 安全组的列表。 该列表可以包括现有 DB 安全组的名称或对模板中创建的 AWS：：RDS：:D BSecurityGroup 资源引用。 如果设置了 DBSecurityGroups，则不得设置VPSecurityGroups，反之亦然。 此外，请注意，DBSecurityGroups 属性仅用于向后兼容较旧的区域，因此不再建议向 RDS DB 实例提供安全信息。 请改用VPSecurityGroups。 如果指定此属性，AWS CloudFormation 只会在创建操作期间向 Amazon RDS 发送以下属性（如果指定）：+ AllocatedStorage + AutoMinorVersionUpgrade + AvailabilityZone + BackupRetentionPeriod + CharacterSetName + DBInstanceClass + DBName + DBParameterGroupName + DBSecurityGroups + DBSubnetGroupName + Engine + EngineVersion + Iops + LicenseModel + MasterUsername + MasterUserPassword + MultiAZ + OptionGroupName + PreferredBackupWindow + PreferredMaintenanceWindow 将忽略所有其他属性。 如果要提交其他属性（例如 StorageType、StorageEncrypted或 KmsKeyId），请指定虚拟私有云（KmsKeyId） 安全组。 如果已在使用 DBSecurityGroups 属性，则无法通过更新 DB 实例以使用一个 DBSecurityGroups 安全组来使用这些其他属性。 必须重新创建 DB 实例。 字符串[]
dbSnapshotIdentifier 数据库快照标识符 用于还原 DB 实例的 DB 快照的名称或 Amazon 资源名称（ARN）。 如果要从共享手动数据库快照还原，则必须指定快照的 ARN。 通过指定此属性，可以从指定的数据库快照创建数据库实例。 如果 DBSnapshotIdentifier 属性是空字符串，或者 AWS::RDS::DBInstance 声明没有 DBSnapshotIdentifier 属性，则 AWS CloudFormation 将创建新的数据库。 如果属性包含一个值（而不是空字符串），AWS CloudFormation 将从指定的快照创建数据库。 如果具有指定名称的快照不存在，则 AWS CloudFormation 无法创建数据库，并且会回滚堆栈。 从快照（如 MasterUsername 和 MasterUserPassword 属性）还原时，某些 DB 实例属性无效。 有关可以指定的属性的信息，请参阅 RestoreDBInstanceFromDBSnapshot中的 操作。 使用 DBSnapshotIdentifier 属性还原 DB 实例后，必须为将来对 DB 实例进行任何更新指定相同的 DBSnapshotIdentifier 属性。 为更新指定此属性时，不会再次从数据库快照还原 DB 实例，并且数据库中的数据不会更改。 但是，如果未指定 DBSnapshotIdentifier 属性，则会创建一个空的 DB 实例，并删除原始 DB 实例。 如果指定的属性与以前的快照还原属性不同，则会从指定的 DBSnapshotIdentifier 属性还原新的 DB 实例，并删除原始 DB 实例。 如果指定 DBSnapshotIdentifier 属性来还原 DB 实例（而不是为数据库实例更新指定），则不要指定以下属性：+ CharacterSetName + DBClusterIdentifier + DBName + DeleteAutomatedBackups + EnablePerformanceInsights + KmsKeyId + MasterUsername + MasterUserPassword + PerformanceInsightsKMSKeyId + PerformanceInsightsRetentionPeriod + PromotionTier + SourceDBInstanceIdentifier + SourceRegion + StorageEncrypted （用于加密快照） + TimezoneAmazon Aurora 不适用。 快照还原由数据库群集管理。 字符串
dbSubnetGroupName 要与 DB 实例关联的 DB 子网组。 如果更新此值，则新子网组必须是新KB 中的子网组。 如果没有 DB 子网组，则 DB 实例不是一个VP DB 实例。 有关在 Amazon RDS 用户指南中的 将 Amazon RDS 与 Amazon 虚拟私有云配合使用（）的详细信息。 亚马逊奥罗拉 不适用。 DB 子网组由数据库群集管理。 如果指定，则设置必须与 DB 群集设置匹配。 字符串
dbSystemId 数据库系统 ID Oracle 系统标识符 （SID），它是管理数据库文件的 Oracle 数据库实例的名称。 在此上下文中，术语“Oracle 数据库实例”仅指系统全局区域（SGA）和 Oracle 后台进程。 如果未指定 SID，则值默认为 RDSCDB。 Oracle SID 也是 CDB 的名称。 字符串
dedicatedLogVolume 指示 DB 实例是否启用了专用日志卷（DLV）。 布尔
deleteAutomated备份 一个值，该值指示是否在删除 DB 实例后立即删除自动备份。 此参数不区分大小写。 默认值是在删除 DB 实例后立即删除自动备份。 亚马逊奥罗拉 不适用。 删除数据库群集时，会删除该 DB 群集的所有自动备份，并且无法恢复。 不会删除 DB 群集的手动数据库群集快照。 布尔
deletion保护 一个值，该值指示数据库实例是否已启用删除保护。 启用删除保护时，无法删除数据库。 默认情况下，删除保护处于禁用状态。 有关详细信息，请参阅 删除数据库实例。 亚马逊奥罗拉 不适用。 可以为数据库群集启用或禁用删除保护。 有关详细信息，请参阅 CreateDBCluster。 即使为数据库群集启用了删除保护，也可以删除 DB 群集中的 DB 实例。 布尔
域 要在其中创建 DB 实例的 Active Directory 目录 ID。 目前，只能在 Active Directory 域中创建 Db2、MySQL、Microsoft SQL Server、Oracle 和 PostgreSQL DB 实例。 有关详细信息，请参阅 Amazon RDS 用户指南中的 Kerberos 身份验证。 字符串
domainAuthSecretArn 域名 机密管理器机密的 ARN，其中包含用于加入域的用户的凭据。 示例：arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456 字符串
domainDnsIps 域名 主和辅助 Active Directory 域控制器的 IPv4 DNS IP 地址。 约束：必须提供 + 两个 IP 地址。 如果没有辅助域控制器，请使用主域控制器的 IP 地址作为列表中的这两个条目。 示例：123.124.125.126,234.235.236.237 字符串[]
domainFqdn 域名 Active Directory 域的完全限定域名（FQDN）。 约束：+ 不能超过 64 个字符。 示例：mymanagedADtest.mymanagedAD.mydomain 字符串
domainIAMRoleName 域名 对目录服务进行 API 调用时要使用的 IAM 角色的名称。 此设置不适用于以下 DB 实例：+ Amazon Aurora（域由数据库群集管理）。） + RDS 自定义 字符串
域Ou 要加入的 DB 实例的 Active Directory 组织单位。 约束：+ 必须采用可分辨名称格式。 + 不能超过 64 个字符。 示例：OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain 字符串
启用CloudwatchLogsExports 需要启用用于导出到 CloudWatch 日志的日志类型的列表。 列表中的值取决于所使用的数据库引擎。 有关详细信息，请参阅 Amazon Relational Database Service 用户指南中的 将数据库日志发布到 Amazon CloudWatch 日志。 亚马逊奥罗拉 不适用。 CloudWatch 日志导出由数据库群集管理。 Db2 有效值：diag.log、notify.logMariaDB 有效值：audit、error、general、slowqueryMicrosoft SQL Server 有效值：agent、errorMySQL 有效值：audit、error、general、slowqueryOracle 有效值：alert、audit、listener、trace、oemagentPostgreSQL 有效值：postgresql、upgrade 字符串[]
enableIAMDatabaseAuthentication 一个值，该值指示是否启用 AWS 标识和访问管理 （IAM） 帐户到数据库帐户的映射。 默认情况下，映射处于禁用状态。 RDS for MariaDB、RDS for MySQL 和 RDS for PostgreSQL 支持此属性。 有关详细信息，请参阅 Amazon RDS 用户指南中的 IAM Database Authentication for MariaDB、MySQL 和 PostgreSQL。亚马逊奥罗拉 不适用。 AWS IAM 帐户映射到数据库帐户由数据库群集管理。 布尔
enablePerformanceInsights 指定是否为数据库实例启用 Performance Insights。 有关详细信息，请参阅 Amazon RDS 用户指南中的 使用 Amazon Performance Insights。 此设置不适用于 RDS 自定义数据库实例。 布尔
端点 DB 实例的连接终结点。 对于状态为 creating的实例，可能不会显示终结点。 此数据类型表示连接到 Amazon RDS DB 实例所需的信息。 此数据类型在以下操作中用作响应元素：+ CreateDBInstance + DescribeDBInstances + DeleteDBInstance 对于表示 Amazon Aurora DB 群集终结点的数据结构，请参阅 DBClusterEndpoint。 端点自动生成2
发动机 要用于此 DB 实例的数据库引擎的名称。 并非每个数据库引擎在每个 AWS 区域中都可用。 创建数据库实例时，此属性是必需的。 可以通过将模板中的 Engine 值从 oracle-ee 或 oracle-ee-cdb 更新为 oracle-se2-cdb，将 Oracle 数据库的体系结构从非容器数据库 （CDB） 体系结构更改为 CDB 体系结构。 转换为 CDB 体系结构需要中断。 有效值：+ aurora-mysql （对于 Aurora MySQL DB 实例） + aurora-postgresql （对于 Aurora PostgreSQL DB 实例） + custom-oracle-ee （适用于 Oracle DB 实例的 RDS 自定义） + custom-oracle-ee-cdb （适用于 Oracle DB 的 RDS 自定义） instances） + custom-sqlserver-ee （for RDS Custom for SQL Server DB instances） + custom-sqlserver-se （for RDS Custom for SQL Server DB instances） + custom-sqlserver-web （for RDS Custom for SQL Server DB instances） + db2-ae + db2-se + mariadb + mysql + oracle-ee + oracle-ee-cdb + oracle-se2 + oracle-se2-cdb + postgres + sqlserver-ee + sqlserver-se + sqlserver-ex + sqlserver-web 字符串
engineVersion （引擎版本） 要使用的数据库引擎的版本号。 有关有效引擎版本的列表，请使用 DescribeDBEngineVersions 操作。 以下是数据库引擎以及有关 Amazon RDS 提供的主要和次要版本的信息的链接。 并非每个数据库引擎都可用于每个 AWS 区域。 亚马逊奥罗拉 不适用。 数据库实例要使用的数据库引擎的版本号由数据库群集管理。 Db2 请参阅 Amazon RDS 用户指南中的 Amazon RDS for Db2。MariaDB 请参阅 Amazon RDS 用户指南中的 amazon RDS 版本 上的 MariaDB。Microsoft SQL Server 请参阅 Amazon RDS 用户指南中的 Microsoft Amazon RDS 上的 SQL Server 版本。MySQL 请参阅 Amazon RDS 用户指南中的 Amazon RDS 版本 上的 MySQL。Oracle 请参阅 Amazon RDS 用户指南中的 Oracle 数据库引擎发行说明。PostgreSQL 请参阅 Amazon RDS 用户指南中的 支持的 PostgreSQL 数据库版本。 字符串
IOPS （国际速率） 数据库预配的每秒 I/O 操作数（IOPS）。 该值必须等于或大于 1000。 如果指定此属性，则必须遵循所请求的 IOPS 速率的允许比率范围，以及分配的存储量（分配给分配的存储的 IOPS）。 例如，可以使用 1000 IOPS 和 200 GiB 存储预配 Oracle 数据库实例（比率为 5：1），或者指定 2000 IOPS（存储 200 GiB 比率）。 有关详细信息，请参阅 Amazon RDS 预配的 IOPS 存储以提高 Amazon RDS 用户指南中的性能。 如果为 io1 属性指定 StorageType，则还必须指定 Iops 属性。 约束：+ 对于 DB2、MariaDB、MySQL、Oracle 和 PostgreSQL 的 RDS - 必须是 DB 实例的存储量的 .5 到 50 之间的倍数。 + 对于 SQL Server 的 RDS - 必须是数据库实例的存储量介于 1 到 50 之间的倍数。 整数 (int)
kmsKeyId 用于加密 DB 实例的 AWS KMS 密钥的 ARN，例如 arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef。 如果启用 StorageEncrypted 属性但未指定此属性，AWS CloudFormation 将使用默认 KMS 密钥。 如果指定此属性，则必须将 StorageEncrypted 属性设置为 true。 如果指定 SourceDBInstanceIdentifier 属性，则当在同一区域中创建只读副本时，该值将从源 DB 实例继承。 如果在不同的 AWS 区域中创建加密的只读副本，则必须为目标 AWS 区域指定 KMS 密钥。 KMS 加密密钥特定于在其中创建的区域，不能使用另一个区域中的加密密钥。 如果指定 SnapshotIdentifier 属性，则 StorageEncrypted 属性值继承自快照;如果 DB 实例已加密，则使用指定的 KmsKeyId 属性。 如果指定 DBSecurityGroups，AWS CloudFormation 将忽略此属性。 若要同时指定安全组和此属性，必须使用一个VP安全组。 有关 Amazon RDS 和 将 Amazon RDS 与 Amazon RDS 配合使用的详细信息，请参阅 Amazon RDS 用户指南中的 Amazon RDS。 亚马逊奥罗拉 不适用。 KMS 密钥标识符由数据库群集管理。 字符串
许可模型 此 DB 实例的许可证模型信息。 有效值：+ 奥罗拉 MySQL - general-public-license + 奥罗拉 PostgreSQL - postgresql-license + RDS for Db2 - bring-your-own-license。 有关 RDS for Db2 许可的详细信息，请参阅 Amazon RDS 用户指南中的 。 + RDS for MariaDB - general-public-license + RDS for Microsoft SQL Server - license-included + RDS for MySQL - general-public-license + RDS for Oracle - bring-your-own-license 或 license-included + RDS for PostgreSQL - postgresql-license 如果已指定 DBSecurityGroups，然后更新许可证模型，AWS CloudFormation 将替换基础 DB 实例。 这会导致数据库可用性出现一些中断。 字符串
manageMasterUserPassword 指定是否使用 AWS 机密管理器管理主用户密码。 有关详细信息，请参阅 Amazon RDS 用户指南中的 密码管理与机密管理器。 约束：如果指定了 MasterUserPassword，则不能使用 AWS 机密管理器管理主用户密码。 布尔
master用户名 DB 实例的主用户名。 如果指定 SourceDBInstanceIdentifier 或 DBSnapshotIdentifier 属性，请不要指定此属性。 该值继承自源 DB 实例或快照。 迁移自托管 Db2 数据库时，建议使用与自托管 Db2 实例名称相同的主用户名。 亚马逊奥罗拉 不适用。 主用户的名称由数据库群集管理。 DB2 约束的 RDS：+ 必须为 1 到 16 个字母或数字。 + 第一个字符必须是字母。 + 不能是所选数据库引擎的保留字。 RDS for MariaDB 约束：+ 必须为 1 到 16 个字母或数字。 + 不能是所选数据库引擎的保留字。 RDS Microsoft SQL Server 约束：+ 必须为 1 到 128 个字母或数字。 + 第一个字符必须是字母。 + 不能是所选数据库引擎的保留字。 RDS for MySQL 约束：+ 必须为 1 到 16 个字母或数字。 + 第一个字符必须是字母。 + 不能是所选数据库引擎的保留字。 Oracle 约束的 RDS：+ 必须为 1 到 30 个字母或数字。 + 第一个字符必须是字母。 + 不能是所选数据库引擎的保留字。 RDS for PostgreSQL 约束：+ 必须为 1 到 63 个字母或数字。 + 第一个字符必须是字母。 + 不能是所选数据库引擎的保留字。 字符串
masterUserPassword （主用户密码） 主用户的密码。 密码可以包含除“/”、“'”或“@”以外的任何可打印 ASCII 字符。 亚马逊奥罗拉 不适用。 主用户的密码由数据库群集管理。 RDS for Db2 必须包含 8 到 255 个字符。 RDS for MariaDB 约束：必须包含 8 到 41 个字符。 RDS for Microsoft SQL Server 约束：必须包含 8 到 128 个字符。 RDS for MySQL 约束：必须包含 8 到 41 个字符。 用于 Oracle 约束的 RDS：必须包含 8 到 30 个字符。 RDS for PostgreSQL 约束：必须包含 8 到 128 个字符。 字符串
masterUserSecret 由 AWS 机密管理器中 RDS 管理的机密，用于主用户密码。 有关详细信息，请参阅 Amazon RDS 用户指南中的 密码管理与机密管理器。MasterUserSecret 返回值指定主用户密码的 AWS 机密管理器中 RDS 管理的机密。 有关详细信息，请参阅 Amazon RDS 用户指南 中的 密码管理与机密管理器 密码管理，Amazon Aurora 用户指南中的机密管理器 密码管理。 MasterUserSecret （主用户密钥）
maxAllocatedStorage Amazon RDS 可以自动缩放 DB 实例存储的上限（GiB）。 有关此设置的详细信息（包括适用的限制）请参阅 Amazon RDS 用户指南中的 使用 Amazon RDS 存储自动缩放 管理容量。 此设置不适用于以下 DB 实例：+ Amazon Aurora（存储由数据库群集管理）。） + RDS 自定义 整数 (int)
monitoringInterval （监控间隔） 为 DB 实例收集增强型监视指标时，间隔（以秒为单位）。 若要禁用增强型监视指标的收集，请指定 0。 默认值为 0。 如果指定了 MonitoringRoleArn，则必须将 MonitoringInterval 设置为 0 以外的值。 此设置不适用于 RDS 自定义。 有效值：0, 1, 5, 10, 15, 30, 60 整数 (int)
monitoringRoleArn 允许 RDS 将增强的监视指标发送到 Amazon CloudWatch 日志的 IAM 角色的 ARN。 例如，arn:aws:iam:123456789012:role/emaccess。 有关创建监视角色的信息，请参阅 Amazon RDS 用户指南设置和启用增强型监视。 如果 MonitoringInterval 设置为非 0的值，则必须提供 MonitoringRoleArn 值。 此设置不适用于 RDS 自定义数据库实例。 字符串
多可用区 指定数据库实例是否为多 AZ DB 实例部署。 如果 AvailabilityZone 参数设置为 true，则无法设置 MultiAZ 参数。 有关详细信息，请参阅 Amazon RDS 用户指南中的 多 AZ 部署以实现高可用性。 亚马逊奥罗拉 不适用。 Amazon Aurora 存储跨所有可用性区域复制，不需要设置 MultiAZ 选项。 布尔
ncharCharacterSet名称 Oracle DB 实例的 NCHAR 字符集的名称。 此设置不适用于 RDS 自定义数据库实例。 字符串
网络类型 DB 实例的网络类型。 有效值：+ IPV4 + DUAL 网络类型由为 DB 实例指定的 DBSubnetGroup 确定。 DBSubnetGroup 只能支持 IPv4 协议或 IPv4 和 IPv6 协议（DUAL）。 有关详细信息，请参阅 Amazon RDS 用户指南中的 在 中处理 DB 实例。 字符串
optionGroupName （选项组名称） 指示 DB 实例应与指定的选项组相关联。 无法从选项组中删除永久选项，例如 Oracle 高级安全 TDE 的 TDE 选项。 此外，与数据库实例关联后，无法从数据库实例中删除该选项组。 字符串
performanceInsightsKMSKeyId 用于加密 Performance Insights 数据的 AWS KMS 密钥标识符。 KMS 密钥标识符是 KMS 密钥的密钥 ARN、密钥 ID、别名 ARN 或别名。 如果未为 PerformanceInsightsKMSKeyId指定值，则 Amazon RDS 将使用默认 KMS 密钥。 AWS 帐户的默认 KMS 密钥。 AWS 帐户为每个 AWS 区域使用不同的默认 KMS 密钥。 有关启用 Performance Insights 的信息，请参阅 EnablePerformanceInsights。 字符串
performanceInsightsRetentionPeriod （性能洞察保留期） 保留 Performance Insights 数据的天数。 此设置不适用于 RDS 自定义数据库实例。 有效值：+ 7 + 个月 * 31，其中 个月 为 1-23 个月的月份。 示例：93（3 个月 * 31）、341 （11 个月 * 31）、589 （19 个月 * 31） + 731 默认值：7 天（如果指定无效的保留期，如 94），Amazon RDS 将返回错误。 整数 (int)
港口 数据库接受连接的端口号。 亚马逊奥罗拉 不适用。 端口号由数据库群集管理。 Db2 默认值：50000 字符串
preferredBackupWindow （首选备份窗口） 如果启用了自动备份，则使用 BackupRetentionPeriod 参数创建自动备份的每日时间范围。 有关详细信息，请参阅 Amazon RDS 用户指南中的 备份窗口。 约束：+ 必须采用 hh24:mi-hh24:mi格式。 + 必须处于世界协调时间（UTC）。 + 不得与首选维护时段冲突。 + 必须至少为 30 分钟。 亚马逊奥罗拉 不适用。 创建自动备份的每日时间范围由数据库群集管理。 字符串
preferredMaintenanceWindow 系统维护的每周时间范围（UTC）。 格式：ddd:hh24:mi-ddd:hh24:mi 默认为从每个 AWS 区域的 8 小时时间块随机选择的 30 分钟窗口，发生在一周中的随机一天。 若要查看可用的时间块，请参阅 Amazon RDS 用户指南中 调整首选数据库实例维护时段。 当 AWS CloudFormation 最初创建 DB 实例时，此属性适用。 如果使用 AWS CloudFormation 更新 DB 实例，则立即应用这些更新。 约束：最小 30 分钟窗口。 字符串
处理器特性 DB 实例类的 CPU 内核数和每个核心的线程数。 此设置不适用于 Amazon Aurora 或 RDS 自定义数据库实例。 处理器功能
促销等级 在现有主实例发生故障后，极光副本提升到主实例的优先级顺序。 有关详细信息，请参阅 Amazon Aurora 用户指南 中对极光数据库群集的容错 。 此设置不适用于 RDS 自定义数据库实例。 默认值：1 有效值：0 - 15 整数 (int)
可公开访问 指示 DB 实例是否为面向 Internet 的实例。 如果指定 true，AWS CloudFormation 将创建具有可公开解析 DNS 名称的实例，该名称解析为公共 IP 地址。 如果指定 false，AWS CloudFormation 会创建一个内部实例，其中包含解析为专用 IP 地址的 DNS 名称。 默认行为值取决于你的VP 设置和数据库子网组。 有关详细信息，请参阅 PubliclyAccessibleCreateDBInstance 中的 参数。 布尔
replicaMode Oracle 只读副本的打开模式。 有关详细信息，请参阅 Amazon RDS 用户指南中的 使用 Amazon RDS 的 Oracle 只读副本。 此设置仅在 RDS for Oracle 中受支持。 默认值：open-read-only 有效值：open-read-only 或 mounted 字符串
恢复时间 要从中进行还原的日期和时间。 约束：+ 必须是世界协调时间（UTC）格式的时间。 + 必须在数据库实例的最新可还原时间之前。 如果启用了 UseLatestRestorableTime 参数，则无法指定 + 。 示例：2009-09-07T23:45:00Z 字符串
sourceDBClusterIdentifier 将充当只读副本的源的多 AZ DB 群集的标识符。 每个 DB 群集最多可以有 15 个只读副本。 约束：+ 必须是现有多 AZ DB 群集的标识符。 如果还指定了 SourceDBInstanceIdentifier 参数，则无法指定 + 。 + 指定的 DB 群集必须启用自动备份，即其备份保留期必须大于 0。 + 源 DB 群集必须与只读副本位于同一 AWS-Region。 不支持跨区域复制。 字符串
源DBInstanceAutomatedBackupsArn 要从中还原的自动备份的 Amazon 资源名称（ARN），例如 arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE。 此设置不适用于 RDS 自定义。 字符串
源DBInstanceIdentifier 如果要创建只读副本数据库实例，请指定源 DB 实例的 ID。 每个 DB 实例可以有有限数量的只读副本。 有关详细信息，请参阅 Amazon RDS 用户指南中的 使用只读副本。 有关适用于 DB 实例标识符的约束的信息，请参阅 Amazon RDS 用户指南Amazon RDS 中的命名约束。 SourceDBInstanceIdentifier 属性确定 DB 实例是否为只读副本。 如果从模板中删除 SourceDBInstanceIdentifier 属性，然后更新堆栈，AWS CloudFormation 会将只读副本提升为独立的 DB 实例。 + 如果指定使用 VPCSecurityGroups 安全组的源数据库实例，建议指定 VPCSecurityGroups 属性。 如果未指定该属性，只读副本会在创建副本时从源 DB 继承 VPCSecurityGroups 属性的值。 但是，如果更新堆栈，AWS CloudFormation 会将副本的 VPCSecurityGroups 属性还原为默认值，因为它未在堆栈的模板中定义。 此更改可能会导致意外问题。 + 只读副本不支持删除策略。 AWS CloudFormation 忽略与只读副本关联的任何删除策略。 + 如果指定 SourceDBInstanceIdentifier，请不要指定 DBSnapshotIdentifier 属性。 无法从快照创建只读副本。 + 不要设置 BackupRetentionPeriod、DBName、MasterUsername、MasterUserPassword和 PreferredBackupWindow 属性。 数据库属性继承自源 DB 实例，对只读副本禁用备份。 + 如果源 DB 实例位于与只读副本不同的区域中，请在 SourceRegion中指定源区域，并为 SourceDBInstanceIdentifier中的有效 DB 实例指定 ARN。 有关详细信息，请参阅 Amazon RDS 用户指南中的 构建 Amazon RDS Amazon 资源名称（ARN）。 + 对于 Amazon Aurora 群集中的 DB 实例，请勿指定此属性。 Amazon RDS 会自动分配编写器和读取器 DB 实例。 字符串
源 DbiResourceId 要从中还原的源 DB 实例的资源 ID。 字符串
源区域 包含只读副本的源 DB 实例的区域 ID。 字符串
存储加密 一个值，该值指示是否加密 DB 实例。 默认情况下，它不会加密。 如果指定 KmsKeyId 属性，则必须启用加密。 如果指定 SourceDBInstanceIdentifier 属性，请不要指定此属性。 该值继承自源 DB 实例，如果 DB 实例已加密，则使用指定的 KmsKeyId 属性。 如果指定 DBSnapshotIdentifier 且指定的快照已加密，请不要指定此属性。 该值继承自快照，并使用指定的 KmsKeyId 属性。 如果指定 DBSnapshotIdentifier 且未加密指定的快照，则可以使用此属性指定已还原的 DB 实例已加密。 指定要用于加密的 KMS 密钥的 KmsKeyId 属性。 如果不希望对还原的 DB 实例进行加密，请不要设置此属性或将其设置为 false。 亚马逊奥罗拉 不适用。 DB 实例的加密由数据库群集管理。 布尔
storage吞吐量 指定 DB 实例的存储吞吐量值。 此设置仅适用于 gp3 存储类型。 此设置不适用于 RDS 自定义或 Amazon Aurora。 整数 (int)
存储类型 要与 DB 实例关联的存储类型。 如果指定 io1、io2或 gp3，则还必须包含 Iops 参数的值。 此设置不适用于 Amazon Aurora DB 实例。 存储由数据库群集管理。 有效值：gp2 \| gp3 \| io1 \| io2 \| standard 默认值：io1，如果指定了 Iops 参数。 否则，gp2。 字符串
标签 要应用于此 DB 实例的键值对的可选数组。 标签自动生成46[]
tdeCredentialArn 属性 tdeCredentialArn 字符串
tdeCredentialPassword （tdeCredential密码） 属性 tdeCredentialPassword 字符串
时区 DB 实例的时区。 时区参数目前仅受 SQL ServerMicrosoft 支持。 字符串
useDefaultProcessorFeatures 指定 DB 实例的 DB 实例类是否使用其默认处理器功能。 此设置不适用于 RDS 自定义数据库实例。 布尔
使用LatestRestorableTime 指定是否从最新的备份时间还原 DB 实例。 默认情况下，不会从最新的备份时间还原 DB 实例。 约束：如果提供了 RestoreTime 参数，则无法指定 + 。 布尔
vpSecurityGroups 要分配给 DB 实例的VP 安全组 ID 的列表。 该列表可以包括现有 资源组的物理 ID 以及对在模板中创建的 AWS：：EC2：：SecurityGroup 资源的引用。 如果计划更新资源，请不要在共享的KB 中指定VP安全组。 如果设置 VPCSecurityGroups，则不得 DBSecurityGroups设置，反之亦然。 可以将堆栈中的 DB 实例从 RDS DB 安全组迁移到一个VP安全组，但请记住以下几点：+ 建立一个VP安全组成员身份后，不能还原为使用 RDS 安全组。 + 将数据库实例迁移到VP 安全组时，如果堆栈更新因 DB 实例更新失败或另一个 AWS CloudFormation 资源中的更新失败而回滚，则回滚会失败，因为它无法还原到 RDS 安全组。 + 若要使用使用VP安全组时可用的属性，必须重新创建 DB 实例。 否则，AWS CloudFormation 仅提交 DBSecurityGroups 属性中列出的属性值。 为了避免这种情况，请仅在堆栈模板中唯一发生更改时才将 DB 实例迁移到使用VP 安全组。 亚马逊奥罗拉 不适用。 EC2VP 安全组的关联列表由数据库群集管理。 如果指定，则设置必须与 DB 群集设置匹配。 字符串[]

证书详细信息

名字 描述 价值
ca标识符 用于 DB 实例服务器证书的 CA 证书的 CA 标识符。 字符串
validTill DB 实例的服务器证书的到期日期。 字符串

DBInstanceRole

名字 描述 价值
功能名称 与 AWS 标识和访问管理（IAM）角色关联的功能的名称。 与 DB 实例关联的 IAM 角色授予 DB 实例代表你访问其他 AWS 服务的权限。 有关受支持的功能名称列表，请参阅 SupportedFeatureNamesDBEngineVersion 中的 说明。 字符串
roleArn 与 DB 实例关联的 IAM 角色的 Amazon 资源名称（ARN）。 字符串

端点自动生成2

名字 描述 价值
地址 指定 DB 实例的 DNS 地址。 字符串
托管区域 ID 指定创建托管区域时 Amazon Route 53 分配的 ID。 字符串
港口 指定数据库引擎正在侦听的端口。 字符串

MasterUserSecret （主用户密钥）

名字 描述 价值
kmsKeyId 用于加密机密的 AWS KMS 密钥标识符。 字符串
secretArn 机密的 Amazon 资源名称（ARN）。 字符串

处理器功能

名字 描述 价值
名字 处理器功能的名称。 有效名称 coreCount 和 threadsPerCore。 “coreCount”
“threadsPerCore”
价值 处理器功能名称的值。 字符串

RdsDBInstanceProperties

名字 描述 价值
阿恩 Amazon 资源名称 （ARN） 字符串
awsAccountId AWS 帐户 ID 字符串
awsProperties AWS 属性 AwsRdsDBInstanceProperties
awsRegion AWS 区域 字符串
awsSourceSchema AWS 源架构 字符串
aws标签 AWS 标记 RdsDBInstancePropertiesAwsTags
publicCloudConnectorsResourceId 公有云连接器资源 ID 字符串
publicCloudResourceName （公共云资源名称） 公有云资源名称 字符串

RdsDBInstancePropertiesAwsTags

名字 描述 价值

标签自动生成46

名字 描述 价值
钥匙 键是标记的必需名称。 字符串值可以是长度为 1 到 128 个 Unicode 字符，不能以 aws: 或 rds:为前缀。 该字符串只能包含 Unicode 字母、数字、空格、''、'.'、'：'、'/'、'='、'+'、'-'、'@'（Java 正则表达式：'^（[\p{L}\p{Z}\p{N}.：/=+\-@]*）$ 。 字符串
价值 值是标记的可选值。 字符串值可以是长度为 1 到 256 个 Unicode 字符，不能以 aws: 或 rds:为前缀。 该字符串只能包含 Unicode 字母、数字、空格、''、'.'、'：'、'/'、'='、'+'、'-'、'@'（Java 正则表达式：'^（[\p{L}\p{Z}\p{N}.：/=+\-@]*）$ 。 字符串

TrackedResourceTags

名字 描述 价值

ARM 模板资源定义

可以使用目标操作部署 rdsDBInstances 资源类型：

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.AwsConnector/rdsDBInstances 资源，请将以下 JSON 添加到模板。

{
  "type": "Microsoft.AwsConnector/rdsDBInstances",
  "apiVersion": "2024-12-01",
  "name": "string",
  "location": "string",
  "properties": {
    "arn": "string",
    "awsAccountId": "string",
    "awsProperties": {
      "allocatedStorage": "string",
      "allowMajorVersionUpgrade": "bool",
      "associatedRoles": [
        {
          "featureName": "string",
          "roleArn": "string"
        }
      ],
      "automaticBackupReplicationKmsKeyId": "string",
      "automaticBackupReplicationRegion": "string",
      "autoMinorVersionUpgrade": "bool",
      "availabilityZone": "string",
      "backupRetentionPeriod": "int",
      "caCertificateIdentifier": "string",
      "certificateDetails": {
        "caIdentifier": "string",
        "validTill": "string"
      },
      "certificateRotationRestart": "bool",
      "characterSetName": "string",
      "copyTagsToSnapshot": "bool",
      "customIAMInstanceProfile": "string",
      "dbClusterIdentifier": "string",
      "dbClusterSnapshotIdentifier": "string",
      "dbInstanceArn": "string",
      "dbInstanceClass": "string",
      "dbInstanceIdentifier": "string",
      "dbiResourceId": "string",
      "dbName": "string",
      "dbParameterGroupName": "string",
      "dbSecurityGroups": [ "string" ],
      "dbSnapshotIdentifier": "string",
      "dbSubnetGroupName": "string",
      "dbSystemId": "string",
      "dedicatedLogVolume": "bool",
      "deleteAutomatedBackups": "bool",
      "deletionProtection": "bool",
      "domain": "string",
      "domainAuthSecretArn": "string",
      "domainDnsIps": [ "string" ],
      "domainFqdn": "string",
      "domainIAMRoleName": "string",
      "domainOu": "string",
      "enableCloudwatchLogsExports": [ "string" ],
      "enableIAMDatabaseAuthentication": "bool",
      "enablePerformanceInsights": "bool",
      "endpoint": {
        "address": "string",
        "hostedZoneId": "string",
        "port": "string"
      },
      "engine": "string",
      "engineVersion": "string",
      "iops": "int",
      "kmsKeyId": "string",
      "licenseModel": "string",
      "manageMasterUserPassword": "bool",
      "masterUsername": "string",
      "masterUserPassword": "string",
      "masterUserSecret": {
        "kmsKeyId": "string",
        "secretArn": "string"
      },
      "maxAllocatedStorage": "int",
      "monitoringInterval": "int",
      "monitoringRoleArn": "string",
      "multiAZ": "bool",
      "ncharCharacterSetName": "string",
      "networkType": "string",
      "optionGroupName": "string",
      "performanceInsightsKMSKeyId": "string",
      "performanceInsightsRetentionPeriod": "int",
      "port": "string",
      "preferredBackupWindow": "string",
      "preferredMaintenanceWindow": "string",
      "processorFeatures": [
        {
          "name": "string",
          "value": "string"
        }
      ],
      "promotionTier": "int",
      "publiclyAccessible": "bool",
      "replicaMode": "string",
      "restoreTime": "string",
      "sourceDBClusterIdentifier": "string",
      "sourceDBInstanceAutomatedBackupsArn": "string",
      "sourceDBInstanceIdentifier": "string",
      "sourceDbiResourceId": "string",
      "sourceRegion": "string",
      "storageEncrypted": "bool",
      "storageThroughput": "int",
      "storageType": "string",
      "tags": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "tdeCredentialArn": "string",
      "tdeCredentialPassword": "string",
      "timezone": "string",
      "useDefaultProcessorFeatures": "bool",
      "useLatestRestorableTime": "bool",
      "vpcSecurityGroups": [ "string" ]
    },
    "awsRegion": "string",
    "awsSourceSchema": "string",
    "awsTags": {
      "{customized property}": "string"
    },
    "publicCloudConnectorsResourceId": "string",
    "publicCloudResourceName": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

属性值

Microsoft.AwsConnector/rdsDBInstances

名字 描述 价值
apiVersion API 版本 '2024-12-01'
位置 资源所在的地理位置 string （必需）
名字 资源名称 字符串

约束：
模式 = ^(?=.{0,259}[^\s.]$)(?!.*[<>%&\?/#]) （必需）
性能 此资源的资源特定属性。 RdsDBInstanceProperties
标签 资源标记 标记名称和值的字典。 请参阅模板 中的 标记
类型 资源类型 “Microsoft.AwsConnector/rdsDBInstances”

AwsRdsDBInstanceProperties

名字 描述 价值
allocatedStorage 最初为数据库实例分配的存储量（GiB）。 如果在 Iops 参数中设置了任何值，则 AllocatedStorage 必须至少为 100 GiB，该值对应于 1,000 的最小 Iops 值。 如果增加 Iops 值（以 1,000 IOPS 为增量），则还必须增加 AllocatedStorage 值（以 100-GiB 增量为单位）。 亚马逊奥罗拉 不适用。 随着数据库中的数据量的增加，极光群集卷会自动增长，但只需为在极光群集卷中使用的空间付费。 Db2 每个存储类型的存储量的约束如下：+ 常规用途（SSD）存储（gp3）：必须是 20 到 64000 之间的整数。 + 预配的 IOPS 存储（io1）：必须是 100 到 64000 的整数。 MySQL 每个存储类型的存储量的约束如下：+ 常规用途（SSD）存储（gp2）：必须是 20 到 65536 之间的整数。 + 预配的 IOPS 存储（io1）：必须是 100 到 65536 的整数。 + 磁存储（标准）：必须是 5 到 3072 的整数。 MariaDB 每个存储类型的存储量的约束如下：+ 常规用途（SSD）存储（gp2）：必须是 20 到 65536 之间的整数。 + 预配的 IOPS 存储（io1）：必须是 100 到 65536 的整数。 + 磁存储（标准）：必须是 5 到 3072 的整数。 PostgreSQL 每种存储类型的存储量的约束如下：+ 常规用途（SSD）存储（gp2）：必须是 20 到 65536 之间的整数。 + 预配的 IOPS 存储（io1）：必须是 100 到 65536 的整数。 + 磁存储（标准）：必须是 5 到 3072 的整数。 Oracle 每个存储类型的存储量的约束如下：+ 常规用途（SSD）存储（gp2）：必须是 20 到 65536 之间的整数。 + 预配的 IOPS 存储（io1）：必须是 100 到 65536 的整数。 + 磁存储（标准）：必须是 10 到 3072 的整数。 SQL Server 每个存储类型的存储量的约束如下：+ 常规用途（SSD）存储（gp2）：+ 企业版和标准版：必须是 20 到 16384 之间的整数。 + Web 和 Express 版本：必须是 20 到 16384 的整数。 + 预配的 IOPS 存储（io1）：+ 企业版和标准版：必须是 20 到 16384 的整数。 + Web 和 Express 版本：必须是 20 到 16384 的整数。 + 磁存储（标准）：+ 企业版和标准版：必须是 20 到 1024 的整数。 + Web 和 Express 版本：必须是 20 到 1024 的整数。 字符串
allowMajorVersionUpgrade 一个值，该值指示是否允许主要版本升级。 更改此参数不会导致中断，并且更改会尽快异步应用。 约束：为与 DB 实例的当前版本不同的 EngineVersion 参数指定值时，必须允许主要版本升级。 布尔
associatedRoles 与 DB 实例关联的 IAMlong （IAM） 角色。 亚马逊奥罗拉 不适用。 关联的角色由数据库群集管理。 DBInstanceRole[]
automaticBackupReplicationKmsKeyId 属性 automaticBackupReplicationKmsKeyId 字符串
automaticBackupReplicationRegion 数据库实例的备份复制的目标区域。 有关详细信息，请参阅 Amazon RDS 用户指南中的 将自动备份复制到另一个区域。 字符串
autoMinorVersionUpgrade 一个值，该值指示在维护时段内是否自动将次要引擎升级应用于 DB 实例。 默认情况下，会自动应用次要引擎升级。 布尔
可用性区域 将在其中创建数据库的可用性区域（AZ）。 有关 AWS-Regions 和可用性区域的信息，请参阅 区域和可用性区域。 对于 Amazon Aurora，每个极光 DB 群集在三个单独的可用性区域中托管其存储的副本。 指定其中一个可用性区域。 如果未指定一个，极光会自动选择适当的可用性区域。 默认值：终结点 AWS 区域中的随机系统选择的可用性区域。 约束：如果 DB 实例是多 AZ 部署，则无法指定 AvailabilityZone 参数。 + 指定的可用性区域必须与当前终结点位于同一 AWS-Region。 示例：us-east-1d 字符串
backupRetentionPeriod （备份保留期） 自动备份保留的天数。 将此参数设置为正数可启用备份。 将此参数设置为 0 会禁用自动备份。 亚马逊奥罗拉 不适用。 自动备份的保留期由数据库群集管理。 默认值：1 约束：+ 必须是介于 0 到 35 的值 + 如果 DB 实例是只读副本的源，则不能设置为 0 整数 (int)
caCertificateIdentifier 此 DB 实例的 CA 证书的标识符。 有关详细信息，请参阅 使用 SSL/TLS 加密与 Amazon RDS 用户指南 中的 DB 实例的连接，使用 SSL/TLS 加密与 Amazon Aurora 用户指南中与 DB 群集的连接。 字符串
证书详细信息 DB 实例的服务器证书的详细信息。 返回 DB 实例的服务器证书的详细信息。 有关详细信息，请参阅 使用 SSL/TLS 加密与 Amazon RDS 用户指南 中的 DB 实例的连接，使用 SSL/TLS 加密与 Amazon Aurora 用户指南中与 DB 群集的连接。 证书详细信息
certificateRotationRestart 证书 指定轮换 SSL/TLS 证书时是否重启 DB 实例。 默认情况下，轮换 SSL/TLS 证书时，将重启 DB 实例。 在重启数据库实例之前，证书不会更新。 仅当 不使用 SSL/TLS 连接到 DB 实例 时才设置此参数。 如果使用 SSL/TLS 连接到 DB 实例，请按照 DB 引擎的相应说明轮换 SSL/TLS 证书：+ 有关轮换 RDS DB 引擎的 SSL/TLS 证书的详细信息，请参阅 轮换 SSL/TLS 证书。Amazon RDS 用户指南中的。 + 有关轮换极光数据库引擎 SSL/TLS 证书的详细信息，请参阅 Amazon Aurora 用户指南中的 轮换 SSL/TLS 证书。 此设置不适用于 RDS 自定义数据库实例。 布尔
字符集名称 对于支持的引擎，指示 DB 实例应与指定的字符集相关联。 亚马逊奥罗拉 不适用。 字符集由数据库群集管理。 有关详细信息，请参阅 AWS：：RDS：:D BCluster。 字符串
copyTagsToSnapshot 指定是否将标记从 DB 实例复制到 DB 实例的快照。 默认情况下，不会复制标记。 此设置不适用于 Amazon Aurora DB 实例。 将标记复制到快照由数据库群集管理。 为极光 DB 实例设置此值不会影响 DB 群集设置。 布尔
customIAMInstanceProfile 与 RDS 自定义数据库实例的基础 Amazon EC2 实例关联的实例配置文件。 RDS 自定义需要此设置。 约束：+ 配置文件必须存在于帐户中。 + 配置文件必须具有 Amazon EC2 有权承担的 IAM 角色。 + 实例配置文件名称和关联的 IAM 角色名称必须以前缀 AWSRDSCustom开头。 有关 IAM 角色所需的权限列表，请参阅 Amazon RDS 用户指南中的 配置 IAM 和你的。 字符串
dbClusterIdentifier 数据库集群标识符 实例所属的 DB 群集的标识符。 字符串
dbClusterSnapshotIdentifier 数据库集群快照标识符 要从中还原的多 AZ DB 群集快照的标识符。 有关多 AZ DB 群集的详细信息，请参阅 Amazon RDS 用户指南中的 多 AZ DB 群集部署。 约束：+ 必须与现有多 AZ DB 群集快照的标识符匹配。 指定 DBSnapshotIdentifier 时无法指定 + 。 如果未指定 DBSnapshotIdentifier，则必须指定 + 。 + 如果要从共享手动多 AZ DB 群集快照还原，DBClusterSnapshotIdentifier 必须是共享快照的 ARN。 + 不能是极光数据库群集快照的标识符。 字符串
dbInstanceArn 数据库实例 属性 dbInstanceArn 字符串
dbInstance类 DB 实例的计算和内存容量，例如 db.m5.large。 并非所有 DB 实例类在所有 AWS 区域或所有数据库引擎中都可用。 有关 DB 实例类的完整列表以及引擎的可用性，请参阅 Amazon RDS 用户指南 中的 DB 实例类，或在 Amazon Aurora 用户指南 极光 DB 实例类。 字符串
dbInstanceIdentifier 数据库实例标识符 DB 实例的名称。 如果指定名称，AWS CloudFormation 会将它转换为小写。 如果未指定名称，AWS CloudFormation 将生成唯一的物理 ID，并将该 ID 用于数据库实例。 有关详细信息，请参阅 名称类型。 有关适用于 DB 实例标识符的约束的信息，请参阅 Amazon RDS 用户指南Amazon RDS 中的命名约束。 如果指定名称，则无法执行需要替换此资源的更新。 可以执行不需要或某些中断的更新。 如果必须替换资源，请指定一个新名称。 字符串
dbiResourceId 属性 dbiResourceId 字符串
数据库名称 此参数的含义因所使用的数据库引擎而异。 如果指定 DBSnapshotIdentifier 属性，则此属性仅适用于 Oracle 的 RDS。 亚马逊奥罗拉 不适用。 数据库名称由数据库群集管理。 Db2 创建数据库实例时要创建的数据库的名称。 如果未指定此参数，则不会在 DB 实例中创建任何数据库。 约束：+ 必须包含 1 到 64 个字母或数字。 + 必须以字母开头。 后续字符可以是字母、下划线或数字（0-9）。 + 不能是指定数据库引擎保留的单词。 MySQL 创建数据库实例时要创建的数据库的名称。 如果未指定此参数，则不会在 DB 实例中创建任何数据库。 约束：+ 必须包含 1 到 64 个字母或数字。 + 不能由指定的数据库引擎保留一个单词，MariaDB 创建数据库实例时要创建的数据库的名称。 如果未指定此参数，则不会在 DB 实例中创建任何数据库。 约束：+ 必须包含 1 到 64 个字母或数字。 + 无法由指定的数据库引擎保留一个单词，PostgreSQL 创建数据库实例时要创建的数据库的名称。 如果未指定此参数，则会在 DB 实例中创建默认 postgres 数据库。 约束：+ 必须以字母开头。 后续字符可以是字母、下划线或数字（0-9）。 + 必须包含 1 到 63 个字符。 + 不能由指定的数据库引擎保留一个单词，Oracle 创建的 DB 实例的 Oracle 系统 ID （SID）。 如果指定 null，则使用默认值 ORCL。 不能为 DBName指定字符串 NULL 或任何其他保留字。 默认值：ORCL 约束：+ 不能超过 8 个字符 SQL Server 不适用。 必须为 null。 字符串
dbParameterGroupName 数据库参数组名称 现有 DB 参数组的名称或对在模板中创建的 AWS：：RDS：:D BParameterGroup 资源的引用。 若要列出所有可用的 DB 参数组名称，请使用以下命令：aws rds describe-db-parameter-groups --query 'DBParameterGroups[].DBParameterGroupName' --output text 如果在更新期间更改了引用的参数组的任何数据成员，则可能需要重启 DB 实例，这会导致一些中断。 如果参数组包含静态参数（无论它们是否已更改），则更新会触发重新启动。 如果未为 DBParameterGroupName 属性指定值，则使用指定引擎和引擎版本的默认 DB 参数组。 字符串
dbSecurity组 要分配给 DB 实例的 DB 安全组的列表。 该列表可以包括现有 DB 安全组的名称或对模板中创建的 AWS：：RDS：:D BSecurityGroup 资源引用。 如果设置了 DBSecurityGroups，则不得设置VPSecurityGroups，反之亦然。 此外，请注意，DBSecurityGroups 属性仅用于向后兼容较旧的区域，因此不再建议向 RDS DB 实例提供安全信息。 请改用VPSecurityGroups。 如果指定此属性，AWS CloudFormation 只会在创建操作期间向 Amazon RDS 发送以下属性（如果指定）：+ AllocatedStorage + AutoMinorVersionUpgrade + AvailabilityZone + BackupRetentionPeriod + CharacterSetName + DBInstanceClass + DBName + DBParameterGroupName + DBSecurityGroups + DBSubnetGroupName + Engine + EngineVersion + Iops + LicenseModel + MasterUsername + MasterUserPassword + MultiAZ + OptionGroupName + PreferredBackupWindow + PreferredMaintenanceWindow 将忽略所有其他属性。 如果要提交其他属性（例如 StorageType、StorageEncrypted或 KmsKeyId），请指定虚拟私有云（KmsKeyId） 安全组。 如果已在使用 DBSecurityGroups 属性，则无法通过更新 DB 实例以使用一个 DBSecurityGroups 安全组来使用这些其他属性。 必须重新创建 DB 实例。 字符串[]
dbSnapshotIdentifier 数据库快照标识符 用于还原 DB 实例的 DB 快照的名称或 Amazon 资源名称（ARN）。 如果要从共享手动数据库快照还原，则必须指定快照的 ARN。 通过指定此属性，可以从指定的数据库快照创建数据库实例。 如果 DBSnapshotIdentifier 属性是空字符串，或者 AWS::RDS::DBInstance 声明没有 DBSnapshotIdentifier 属性，则 AWS CloudFormation 将创建新的数据库。 如果属性包含一个值（而不是空字符串），AWS CloudFormation 将从指定的快照创建数据库。 如果具有指定名称的快照不存在，则 AWS CloudFormation 无法创建数据库，并且会回滚堆栈。 从快照（如 MasterUsername 和 MasterUserPassword 属性）还原时，某些 DB 实例属性无效。 有关可以指定的属性的信息，请参阅 RestoreDBInstanceFromDBSnapshot中的 操作。 使用 DBSnapshotIdentifier 属性还原 DB 实例后，必须为将来对 DB 实例进行任何更新指定相同的 DBSnapshotIdentifier 属性。 为更新指定此属性时，不会再次从数据库快照还原 DB 实例，并且数据库中的数据不会更改。 但是，如果未指定 DBSnapshotIdentifier 属性，则会创建一个空的 DB 实例，并删除原始 DB 实例。 如果指定的属性与以前的快照还原属性不同，则会从指定的 DBSnapshotIdentifier 属性还原新的 DB 实例，并删除原始 DB 实例。 如果指定 DBSnapshotIdentifier 属性来还原 DB 实例（而不是为数据库实例更新指定），则不要指定以下属性：+ CharacterSetName + DBClusterIdentifier + DBName + DeleteAutomatedBackups + EnablePerformanceInsights + KmsKeyId + MasterUsername + MasterUserPassword + PerformanceInsightsKMSKeyId + PerformanceInsightsRetentionPeriod + PromotionTier + SourceDBInstanceIdentifier + SourceRegion + StorageEncrypted （用于加密快照） + TimezoneAmazon Aurora 不适用。 快照还原由数据库群集管理。 字符串
dbSubnetGroupName 要与 DB 实例关联的 DB 子网组。 如果更新此值，则新子网组必须是新KB 中的子网组。 如果没有 DB 子网组，则 DB 实例不是一个VP DB 实例。 有关在 Amazon RDS 用户指南中的 将 Amazon RDS 与 Amazon 虚拟私有云配合使用（）的详细信息。 亚马逊奥罗拉 不适用。 DB 子网组由数据库群集管理。 如果指定，则设置必须与 DB 群集设置匹配。 字符串
dbSystemId 数据库系统 ID Oracle 系统标识符 （SID），它是管理数据库文件的 Oracle 数据库实例的名称。 在此上下文中，术语“Oracle 数据库实例”仅指系统全局区域（SGA）和 Oracle 后台进程。 如果未指定 SID，则值默认为 RDSCDB。 Oracle SID 也是 CDB 的名称。 字符串
dedicatedLogVolume 指示 DB 实例是否启用了专用日志卷（DLV）。 布尔
deleteAutomated备份 一个值，该值指示是否在删除 DB 实例后立即删除自动备份。 此参数不区分大小写。 默认值是在删除 DB 实例后立即删除自动备份。 亚马逊奥罗拉 不适用。 删除数据库群集时，会删除该 DB 群集的所有自动备份，并且无法恢复。 不会删除 DB 群集的手动数据库群集快照。 布尔
deletion保护 一个值，该值指示数据库实例是否已启用删除保护。 启用删除保护时，无法删除数据库。 默认情况下，删除保护处于禁用状态。 有关详细信息，请参阅 删除数据库实例。 亚马逊奥罗拉 不适用。 可以为数据库群集启用或禁用删除保护。 有关详细信息，请参阅 CreateDBCluster。 即使为数据库群集启用了删除保护，也可以删除 DB 群集中的 DB 实例。 布尔
域 要在其中创建 DB 实例的 Active Directory 目录 ID。 目前，只能在 Active Directory 域中创建 Db2、MySQL、Microsoft SQL Server、Oracle 和 PostgreSQL DB 实例。 有关详细信息，请参阅 Amazon RDS 用户指南中的 Kerberos 身份验证。 字符串
domainAuthSecretArn 域名 机密管理器机密的 ARN，其中包含用于加入域的用户的凭据。 示例：arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456 字符串
domainDnsIps 域名 主和辅助 Active Directory 域控制器的 IPv4 DNS IP 地址。 约束：必须提供 + 两个 IP 地址。 如果没有辅助域控制器，请使用主域控制器的 IP 地址作为列表中的这两个条目。 示例：123.124.125.126,234.235.236.237 字符串[]
domainFqdn 域名 Active Directory 域的完全限定域名（FQDN）。 约束：+ 不能超过 64 个字符。 示例：mymanagedADtest.mymanagedAD.mydomain 字符串
domainIAMRoleName 域名 对目录服务进行 API 调用时要使用的 IAM 角色的名称。 此设置不适用于以下 DB 实例：+ Amazon Aurora（域由数据库群集管理）。） + RDS 自定义 字符串
域Ou 要加入的 DB 实例的 Active Directory 组织单位。 约束：+ 必须采用可分辨名称格式。 + 不能超过 64 个字符。 示例：OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain 字符串
启用CloudwatchLogsExports 需要启用用于导出到 CloudWatch 日志的日志类型的列表。 列表中的值取决于所使用的数据库引擎。 有关详细信息，请参阅 Amazon Relational Database Service 用户指南中的 将数据库日志发布到 Amazon CloudWatch 日志。 亚马逊奥罗拉 不适用。 CloudWatch 日志导出由数据库群集管理。 Db2 有效值：diag.log、notify.logMariaDB 有效值：audit、error、general、slowqueryMicrosoft SQL Server 有效值：agent、errorMySQL 有效值：audit、error、general、slowqueryOracle 有效值：alert、audit、listener、trace、oemagentPostgreSQL 有效值：postgresql、upgrade 字符串[]
enableIAMDatabaseAuthentication 一个值，该值指示是否启用 AWS 标识和访问管理 （IAM） 帐户到数据库帐户的映射。 默认情况下，映射处于禁用状态。 RDS for MariaDB、RDS for MySQL 和 RDS for PostgreSQL 支持此属性。 有关详细信息，请参阅 Amazon RDS 用户指南中的 IAM Database Authentication for MariaDB、MySQL 和 PostgreSQL。亚马逊奥罗拉 不适用。 AWS IAM 帐户映射到数据库帐户由数据库群集管理。 布尔
enablePerformanceInsights 指定是否为数据库实例启用 Performance Insights。 有关详细信息，请参阅 Amazon RDS 用户指南中的 使用 Amazon Performance Insights。 此设置不适用于 RDS 自定义数据库实例。 布尔
端点 DB 实例的连接终结点。 对于状态为 creating的实例，可能不会显示终结点。 此数据类型表示连接到 Amazon RDS DB 实例所需的信息。 此数据类型在以下操作中用作响应元素：+ CreateDBInstance + DescribeDBInstances + DeleteDBInstance 对于表示 Amazon Aurora DB 群集终结点的数据结构，请参阅 DBClusterEndpoint。 端点自动生成2
发动机 要用于此 DB 实例的数据库引擎的名称。 并非每个数据库引擎在每个 AWS 区域中都可用。 创建数据库实例时，此属性是必需的。 可以通过将模板中的 Engine 值从 oracle-ee 或 oracle-ee-cdb 更新为 oracle-se2-cdb，将 Oracle 数据库的体系结构从非容器数据库 （CDB） 体系结构更改为 CDB 体系结构。 转换为 CDB 体系结构需要中断。 有效值：+ aurora-mysql （对于 Aurora MySQL DB 实例） + aurora-postgresql （对于 Aurora PostgreSQL DB 实例） + custom-oracle-ee （适用于 Oracle DB 实例的 RDS 自定义） + custom-oracle-ee-cdb （适用于 Oracle DB 的 RDS 自定义） instances） + custom-sqlserver-ee （for RDS Custom for SQL Server DB instances） + custom-sqlserver-se （for RDS Custom for SQL Server DB instances） + custom-sqlserver-web （for RDS Custom for SQL Server DB instances） + db2-ae + db2-se + mariadb + mysql + oracle-ee + oracle-ee-cdb + oracle-se2 + oracle-se2-cdb + postgres + sqlserver-ee + sqlserver-se + sqlserver-ex + sqlserver-web 字符串
engineVersion （引擎版本） 要使用的数据库引擎的版本号。 有关有效引擎版本的列表，请使用 DescribeDBEngineVersions 操作。 以下是数据库引擎以及有关 Amazon RDS 提供的主要和次要版本的信息的链接。 并非每个数据库引擎都可用于每个 AWS 区域。 亚马逊奥罗拉 不适用。 数据库实例要使用的数据库引擎的版本号由数据库群集管理。 Db2 请参阅 Amazon RDS 用户指南中的 Amazon RDS for Db2。MariaDB 请参阅 Amazon RDS 用户指南中的 amazon RDS 版本 上的 MariaDB。Microsoft SQL Server 请参阅 Amazon RDS 用户指南中的 Microsoft Amazon RDS 上的 SQL Server 版本。MySQL 请参阅 Amazon RDS 用户指南中的 Amazon RDS 版本 上的 MySQL。Oracle 请参阅 Amazon RDS 用户指南中的 Oracle 数据库引擎发行说明。PostgreSQL 请参阅 Amazon RDS 用户指南中的 支持的 PostgreSQL 数据库版本。 字符串
IOPS （国际速率） 数据库预配的每秒 I/O 操作数（IOPS）。 该值必须等于或大于 1000。 如果指定此属性，则必须遵循所请求的 IOPS 速率的允许比率范围，以及分配的存储量（分配给分配的存储的 IOPS）。 例如，可以使用 1000 IOPS 和 200 GiB 存储预配 Oracle 数据库实例（比率为 5：1），或者指定 2000 IOPS（存储 200 GiB 比率）。 有关详细信息，请参阅 Amazon RDS 预配的 IOPS 存储以提高 Amazon RDS 用户指南中的性能。 如果为 io1 属性指定 StorageType，则还必须指定 Iops 属性。 约束：+ 对于 DB2、MariaDB、MySQL、Oracle 和 PostgreSQL 的 RDS - 必须是 DB 实例的存储量的 .5 到 50 之间的倍数。 + 对于 SQL Server 的 RDS - 必须是数据库实例的存储量介于 1 到 50 之间的倍数。 整数 (int)
kmsKeyId 用于加密 DB 实例的 AWS KMS 密钥的 ARN，例如 arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef。 如果启用 StorageEncrypted 属性但未指定此属性，AWS CloudFormation 将使用默认 KMS 密钥。 如果指定此属性，则必须将 StorageEncrypted 属性设置为 true。 如果指定 SourceDBInstanceIdentifier 属性，则当在同一区域中创建只读副本时，该值将从源 DB 实例继承。 如果在不同的 AWS 区域中创建加密的只读副本，则必须为目标 AWS 区域指定 KMS 密钥。 KMS 加密密钥特定于在其中创建的区域，不能使用另一个区域中的加密密钥。 如果指定 SnapshotIdentifier 属性，则 StorageEncrypted 属性值继承自快照;如果 DB 实例已加密，则使用指定的 KmsKeyId 属性。 如果指定 DBSecurityGroups，AWS CloudFormation 将忽略此属性。 若要同时指定安全组和此属性，必须使用一个VP安全组。 有关 Amazon RDS 和 将 Amazon RDS 与 Amazon RDS 配合使用的详细信息，请参阅 Amazon RDS 用户指南中的 Amazon RDS。 亚马逊奥罗拉 不适用。 KMS 密钥标识符由数据库群集管理。 字符串
许可模型 此 DB 实例的许可证模型信息。 有效值：+ 奥罗拉 MySQL - general-public-license + 奥罗拉 PostgreSQL - postgresql-license + RDS for Db2 - bring-your-own-license。 有关 RDS for Db2 许可的详细信息，请参阅 Amazon RDS 用户指南中的 。 + RDS for MariaDB - general-public-license + RDS for Microsoft SQL Server - license-included + RDS for MySQL - general-public-license + RDS for Oracle - bring-your-own-license 或 license-included + RDS for PostgreSQL - postgresql-license 如果已指定 DBSecurityGroups，然后更新许可证模型，AWS CloudFormation 将替换基础 DB 实例。 这会导致数据库可用性出现一些中断。 字符串
manageMasterUserPassword 指定是否使用 AWS 机密管理器管理主用户密码。 有关详细信息，请参阅 Amazon RDS 用户指南中的 密码管理与机密管理器。 约束：如果指定了 MasterUserPassword，则不能使用 AWS 机密管理器管理主用户密码。 布尔
master用户名 DB 实例的主用户名。 如果指定 SourceDBInstanceIdentifier 或 DBSnapshotIdentifier 属性，请不要指定此属性。 该值继承自源 DB 实例或快照。 迁移自托管 Db2 数据库时，建议使用与自托管 Db2 实例名称相同的主用户名。 亚马逊奥罗拉 不适用。 主用户的名称由数据库群集管理。 DB2 约束的 RDS：+ 必须为 1 到 16 个字母或数字。 + 第一个字符必须是字母。 + 不能是所选数据库引擎的保留字。 RDS for MariaDB 约束：+ 必须为 1 到 16 个字母或数字。 + 不能是所选数据库引擎的保留字。 RDS Microsoft SQL Server 约束：+ 必须为 1 到 128 个字母或数字。 + 第一个字符必须是字母。 + 不能是所选数据库引擎的保留字。 RDS for MySQL 约束：+ 必须为 1 到 16 个字母或数字。 + 第一个字符必须是字母。 + 不能是所选数据库引擎的保留字。 Oracle 约束的 RDS：+ 必须为 1 到 30 个字母或数字。 + 第一个字符必须是字母。 + 不能是所选数据库引擎的保留字。 RDS for PostgreSQL 约束：+ 必须为 1 到 63 个字母或数字。 + 第一个字符必须是字母。 + 不能是所选数据库引擎的保留字。 字符串
masterUserPassword （主用户密码） 主用户的密码。 密码可以包含除“/”、“'”或“@”以外的任何可打印 ASCII 字符。 亚马逊奥罗拉 不适用。 主用户的密码由数据库群集管理。 RDS for Db2 必须包含 8 到 255 个字符。 RDS for MariaDB 约束：必须包含 8 到 41 个字符。 RDS for Microsoft SQL Server 约束：必须包含 8 到 128 个字符。 RDS for MySQL 约束：必须包含 8 到 41 个字符。 用于 Oracle 约束的 RDS：必须包含 8 到 30 个字符。 RDS for PostgreSQL 约束：必须包含 8 到 128 个字符。 字符串
masterUserSecret 由 AWS 机密管理器中 RDS 管理的机密，用于主用户密码。 有关详细信息，请参阅 Amazon RDS 用户指南中的 密码管理与机密管理器。MasterUserSecret 返回值指定主用户密码的 AWS 机密管理器中 RDS 管理的机密。 有关详细信息，请参阅 Amazon RDS 用户指南 中的 密码管理与机密管理器 密码管理，Amazon Aurora 用户指南中的机密管理器 密码管理。 MasterUserSecret （主用户密钥）
maxAllocatedStorage Amazon RDS 可以自动缩放 DB 实例存储的上限（GiB）。 有关此设置的详细信息（包括适用的限制）请参阅 Amazon RDS 用户指南中的 使用 Amazon RDS 存储自动缩放 管理容量。 此设置不适用于以下 DB 实例：+ Amazon Aurora（存储由数据库群集管理）。） + RDS 自定义 整数 (int)
monitoringInterval （监控间隔） 为 DB 实例收集增强型监视指标时，间隔（以秒为单位）。 若要禁用增强型监视指标的收集，请指定 0。 默认值为 0。 如果指定了 MonitoringRoleArn，则必须将 MonitoringInterval 设置为 0 以外的值。 此设置不适用于 RDS 自定义。 有效值：0, 1, 5, 10, 15, 30, 60 整数 (int)
monitoringRoleArn 允许 RDS 将增强的监视指标发送到 Amazon CloudWatch 日志的 IAM 角色的 ARN。 例如，arn:aws:iam:123456789012:role/emaccess。 有关创建监视角色的信息，请参阅 Amazon RDS 用户指南设置和启用增强型监视。 如果 MonitoringInterval 设置为非 0的值，则必须提供 MonitoringRoleArn 值。 此设置不适用于 RDS 自定义数据库实例。 字符串
多可用区 指定数据库实例是否为多 AZ DB 实例部署。 如果 AvailabilityZone 参数设置为 true，则无法设置 MultiAZ 参数。 有关详细信息，请参阅 Amazon RDS 用户指南中的 多 AZ 部署以实现高可用性。 亚马逊奥罗拉 不适用。 Amazon Aurora 存储跨所有可用性区域复制，不需要设置 MultiAZ 选项。 布尔
ncharCharacterSet名称 Oracle DB 实例的 NCHAR 字符集的名称。 此设置不适用于 RDS 自定义数据库实例。 字符串
网络类型 DB 实例的网络类型。 有效值：+ IPV4 + DUAL 网络类型由为 DB 实例指定的 DBSubnetGroup 确定。 DBSubnetGroup 只能支持 IPv4 协议或 IPv4 和 IPv6 协议（DUAL）。 有关详细信息，请参阅 Amazon RDS 用户指南中的 在 中处理 DB 实例。 字符串
optionGroupName （选项组名称） 指示 DB 实例应与指定的选项组相关联。 无法从选项组中删除永久选项，例如 Oracle 高级安全 TDE 的 TDE 选项。 此外，与数据库实例关联后，无法从数据库实例中删除该选项组。 字符串
performanceInsightsKMSKeyId 用于加密 Performance Insights 数据的 AWS KMS 密钥标识符。 KMS 密钥标识符是 KMS 密钥的密钥 ARN、密钥 ID、别名 ARN 或别名。 如果未为 PerformanceInsightsKMSKeyId指定值，则 Amazon RDS 将使用默认 KMS 密钥。 AWS 帐户的默认 KMS 密钥。 AWS 帐户为每个 AWS 区域使用不同的默认 KMS 密钥。 有关启用 Performance Insights 的信息，请参阅 EnablePerformanceInsights。 字符串
performanceInsightsRetentionPeriod （性能洞察保留期） 保留 Performance Insights 数据的天数。 此设置不适用于 RDS 自定义数据库实例。 有效值：+ 7 + 个月 * 31，其中 个月 为 1-23 个月的月份。 示例：93（3 个月 * 31）、341 （11 个月 * 31）、589 （19 个月 * 31） + 731 默认值：7 天（如果指定无效的保留期，如 94），Amazon RDS 将返回错误。 整数 (int)
港口 数据库接受连接的端口号。 亚马逊奥罗拉 不适用。 端口号由数据库群集管理。 Db2 默认值：50000 字符串
preferredBackupWindow （首选备份窗口） 如果启用了自动备份，则使用 BackupRetentionPeriod 参数创建自动备份的每日时间范围。 有关详细信息，请参阅 Amazon RDS 用户指南中的 备份窗口。 约束：+ 必须采用 hh24:mi-hh24:mi格式。 + 必须处于世界协调时间（UTC）。 + 不得与首选维护时段冲突。 + 必须至少为 30 分钟。 亚马逊奥罗拉 不适用。 创建自动备份的每日时间范围由数据库群集管理。 字符串
preferredMaintenanceWindow 系统维护的每周时间范围（UTC）。 格式：ddd:hh24:mi-ddd:hh24:mi 默认为从每个 AWS 区域的 8 小时时间块随机选择的 30 分钟窗口，发生在一周中的随机一天。 若要查看可用的时间块，请参阅 Amazon RDS 用户指南中 调整首选数据库实例维护时段。 当 AWS CloudFormation 最初创建 DB 实例时，此属性适用。 如果使用 AWS CloudFormation 更新 DB 实例，则立即应用这些更新。 约束：最小 30 分钟窗口。 字符串
处理器特性 DB 实例类的 CPU 内核数和每个核心的线程数。 此设置不适用于 Amazon Aurora 或 RDS 自定义数据库实例。 处理器功能
促销等级 在现有主实例发生故障后，极光副本提升到主实例的优先级顺序。 有关详细信息，请参阅 Amazon Aurora 用户指南 中对极光数据库群集的容错 。 此设置不适用于 RDS 自定义数据库实例。 默认值：1 有效值：0 - 15 整数 (int)
可公开访问 指示 DB 实例是否为面向 Internet 的实例。 如果指定 true，AWS CloudFormation 将创建具有可公开解析 DNS 名称的实例，该名称解析为公共 IP 地址。 如果指定 false，AWS CloudFormation 会创建一个内部实例，其中包含解析为专用 IP 地址的 DNS 名称。 默认行为值取决于你的VP 设置和数据库子网组。 有关详细信息，请参阅 PubliclyAccessibleCreateDBInstance 中的 参数。 布尔
replicaMode Oracle 只读副本的打开模式。 有关详细信息，请参阅 Amazon RDS 用户指南中的 使用 Amazon RDS 的 Oracle 只读副本。 此设置仅在 RDS for Oracle 中受支持。 默认值：open-read-only 有效值：open-read-only 或 mounted 字符串
恢复时间 要从中进行还原的日期和时间。 约束：+ 必须是世界协调时间（UTC）格式的时间。 + 必须在数据库实例的最新可还原时间之前。 如果启用了 UseLatestRestorableTime 参数，则无法指定 + 。 示例：2009-09-07T23:45:00Z 字符串
sourceDBClusterIdentifier 将充当只读副本的源的多 AZ DB 群集的标识符。 每个 DB 群集最多可以有 15 个只读副本。 约束：+ 必须是现有多 AZ DB 群集的标识符。 如果还指定了 SourceDBInstanceIdentifier 参数，则无法指定 + 。 + 指定的 DB 群集必须启用自动备份，即其备份保留期必须大于 0。 + 源 DB 群集必须与只读副本位于同一 AWS-Region。 不支持跨区域复制。 字符串
源DBInstanceAutomatedBackupsArn 要从中还原的自动备份的 Amazon 资源名称（ARN），例如 arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE。 此设置不适用于 RDS 自定义。 字符串
源DBInstanceIdentifier 如果要创建只读副本数据库实例，请指定源 DB 实例的 ID。 每个 DB 实例可以有有限数量的只读副本。 有关详细信息，请参阅 Amazon RDS 用户指南中的 使用只读副本。 有关适用于 DB 实例标识符的约束的信息，请参阅 Amazon RDS 用户指南Amazon RDS 中的命名约束。 SourceDBInstanceIdentifier 属性确定 DB 实例是否为只读副本。 如果从模板中删除 SourceDBInstanceIdentifier 属性，然后更新堆栈，AWS CloudFormation 会将只读副本提升为独立的 DB 实例。 + 如果指定使用 VPCSecurityGroups 安全组的源数据库实例，建议指定 VPCSecurityGroups 属性。 如果未指定该属性，只读副本会在创建副本时从源 DB 继承 VPCSecurityGroups 属性的值。 但是，如果更新堆栈，AWS CloudFormation 会将副本的 VPCSecurityGroups 属性还原为默认值，因为它未在堆栈的模板中定义。 此更改可能会导致意外问题。 + 只读副本不支持删除策略。 AWS CloudFormation 忽略与只读副本关联的任何删除策略。 + 如果指定 SourceDBInstanceIdentifier，请不要指定 DBSnapshotIdentifier 属性。 无法从快照创建只读副本。 + 不要设置 BackupRetentionPeriod、DBName、MasterUsername、MasterUserPassword和 PreferredBackupWindow 属性。 数据库属性继承自源 DB 实例，对只读副本禁用备份。 + 如果源 DB 实例位于与只读副本不同的区域中，请在 SourceRegion中指定源区域，并为 SourceDBInstanceIdentifier中的有效 DB 实例指定 ARN。 有关详细信息，请参阅 Amazon RDS 用户指南中的 构建 Amazon RDS Amazon 资源名称（ARN）。 + 对于 Amazon Aurora 群集中的 DB 实例，请勿指定此属性。 Amazon RDS 会自动分配编写器和读取器 DB 实例。 字符串
源 DbiResourceId 要从中还原的源 DB 实例的资源 ID。 字符串
源区域 包含只读副本的源 DB 实例的区域 ID。 字符串
存储加密 一个值，该值指示是否加密 DB 实例。 默认情况下，它不会加密。 如果指定 KmsKeyId 属性，则必须启用加密。 如果指定 SourceDBInstanceIdentifier 属性，请不要指定此属性。 该值继承自源 DB 实例，如果 DB 实例已加密，则使用指定的 KmsKeyId 属性。 如果指定 DBSnapshotIdentifier 且指定的快照已加密，请不要指定此属性。 该值继承自快照，并使用指定的 KmsKeyId 属性。 如果指定 DBSnapshotIdentifier 且未加密指定的快照，则可以使用此属性指定已还原的 DB 实例已加密。 指定要用于加密的 KMS 密钥的 KmsKeyId 属性。 如果不希望对还原的 DB 实例进行加密，请不要设置此属性或将其设置为 false。 亚马逊奥罗拉 不适用。 DB 实例的加密由数据库群集管理。 布尔
storage吞吐量 指定 DB 实例的存储吞吐量值。 此设置仅适用于 gp3 存储类型。 此设置不适用于 RDS 自定义或 Amazon Aurora。 整数 (int)
存储类型 要与 DB 实例关联的存储类型。 如果指定 io1、io2或 gp3，则还必须包含 Iops 参数的值。 此设置不适用于 Amazon Aurora DB 实例。 存储由数据库群集管理。 有效值：gp2 \| gp3 \| io1 \| io2 \| standard 默认值：io1，如果指定了 Iops 参数。 否则，gp2。 字符串
标签 要应用于此 DB 实例的键值对的可选数组。 标签自动生成46[]
tdeCredentialArn 属性 tdeCredentialArn 字符串
tdeCredentialPassword （tdeCredential密码） 属性 tdeCredentialPassword 字符串
时区 DB 实例的时区。 时区参数目前仅受 SQL ServerMicrosoft 支持。 字符串
useDefaultProcessorFeatures 指定 DB 实例的 DB 实例类是否使用其默认处理器功能。 此设置不适用于 RDS 自定义数据库实例。 布尔
使用LatestRestorableTime 指定是否从最新的备份时间还原 DB 实例。 默认情况下，不会从最新的备份时间还原 DB 实例。 约束：如果提供了 RestoreTime 参数，则无法指定 + 。 布尔
vpSecurityGroups 要分配给 DB 实例的VP 安全组 ID 的列表。 该列表可以包括现有 资源组的物理 ID 以及对在模板中创建的 AWS：：EC2：：SecurityGroup 资源的引用。 如果计划更新资源，请不要在共享的KB 中指定VP安全组。 如果设置 VPCSecurityGroups，则不得 DBSecurityGroups设置，反之亦然。 可以将堆栈中的 DB 实例从 RDS DB 安全组迁移到一个VP安全组，但请记住以下几点：+ 建立一个VP安全组成员身份后，不能还原为使用 RDS 安全组。 + 将数据库实例迁移到VP 安全组时，如果堆栈更新因 DB 实例更新失败或另一个 AWS CloudFormation 资源中的更新失败而回滚，则回滚会失败，因为它无法还原到 RDS 安全组。 + 若要使用使用VP安全组时可用的属性，必须重新创建 DB 实例。 否则，AWS CloudFormation 仅提交 DBSecurityGroups 属性中列出的属性值。 为了避免这种情况，请仅在堆栈模板中唯一发生更改时才将 DB 实例迁移到使用VP 安全组。 亚马逊奥罗拉 不适用。 EC2VP 安全组的关联列表由数据库群集管理。 如果指定，则设置必须与 DB 群集设置匹配。 字符串[]

证书详细信息

名字 描述 价值
ca标识符 用于 DB 实例服务器证书的 CA 证书的 CA 标识符。 字符串
validTill DB 实例的服务器证书的到期日期。 字符串

DBInstanceRole

名字 描述 价值
功能名称 与 AWS 标识和访问管理（IAM）角色关联的功能的名称。 与 DB 实例关联的 IAM 角色授予 DB 实例代表你访问其他 AWS 服务的权限。 有关受支持的功能名称列表，请参阅 SupportedFeatureNamesDBEngineVersion 中的 说明。 字符串
roleArn 与 DB 实例关联的 IAM 角色的 Amazon 资源名称（ARN）。 字符串

端点自动生成2

名字 描述 价值
地址 指定 DB 实例的 DNS 地址。 字符串
托管区域 ID 指定创建托管区域时 Amazon Route 53 分配的 ID。 字符串
港口 指定数据库引擎正在侦听的端口。 字符串

MasterUserSecret （主用户密钥）

名字 描述 价值
kmsKeyId 用于加密机密的 AWS KMS 密钥标识符。 字符串
secretArn 机密的 Amazon 资源名称（ARN）。 字符串

处理器功能

名字 描述 价值
名字 处理器功能的名称。 有效名称 coreCount 和 threadsPerCore。 “coreCount”
“threadsPerCore”
价值 处理器功能名称的值。 字符串

RdsDBInstanceProperties

名字 描述 价值
阿恩 Amazon 资源名称 （ARN） 字符串
awsAccountId AWS 帐户 ID 字符串
awsProperties AWS 属性 AwsRdsDBInstanceProperties
awsRegion AWS 区域 字符串
awsSourceSchema AWS 源架构 字符串
aws标签 AWS 标记 RdsDBInstancePropertiesAwsTags
publicCloudConnectorsResourceId 公有云连接器资源 ID 字符串
publicCloudResourceName （公共云资源名称） 公有云资源名称 字符串

RdsDBInstancePropertiesAwsTags

名字 描述 价值

标签自动生成46

名字 描述 价值
钥匙 键是标记的必需名称。 字符串值可以是长度为 1 到 128 个 Unicode 字符，不能以 aws: 或 rds:为前缀。 该字符串只能包含 Unicode 字母、数字、空格、''、'.'、'：'、'/'、'='、'+'、'-'、'@'（Java 正则表达式：'^（[\p{L}\p{Z}\p{N}.：/=+\-@]*）$ 。 字符串
价值 值是标记的可选值。 字符串值可以是长度为 1 到 256 个 Unicode 字符，不能以 aws: 或 rds:为前缀。 该字符串只能包含 Unicode 字母、数字、空格、''、'.'、'：'、'/'、'='、'+'、'-'、'@'（Java 正则表达式：'^（[\p{L}\p{Z}\p{N}.：/=+\-@]*）$ 。 字符串

TrackedResourceTags

名字 描述 价值

用法示例

Terraform （AzAPI 提供程序）资源定义

可以使用目标操作部署 rdsDBInstances 资源类型：

  • 资源组

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.AwsConnector/rdsDBInstances 资源，请将以下 Terraform 添加到模板。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.AwsConnector/rdsDBInstances@2024-12-01"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      arn = "string"
      awsAccountId = "string"
      awsProperties = {
        allocatedStorage = "string"
        allowMajorVersionUpgrade = bool
        associatedRoles = [
          {
            featureName = "string"
            roleArn = "string"
          }
        ]
        automaticBackupReplicationKmsKeyId = "string"
        automaticBackupReplicationRegion = "string"
        autoMinorVersionUpgrade = bool
        availabilityZone = "string"
        backupRetentionPeriod = int
        caCertificateIdentifier = "string"
        certificateDetails = {
          caIdentifier = "string"
          validTill = "string"
        }
        certificateRotationRestart = bool
        characterSetName = "string"
        copyTagsToSnapshot = bool
        customIAMInstanceProfile = "string"
        dbClusterIdentifier = "string"
        dbClusterSnapshotIdentifier = "string"
        dbInstanceArn = "string"
        dbInstanceClass = "string"
        dbInstanceIdentifier = "string"
        dbiResourceId = "string"
        dbName = "string"
        dbParameterGroupName = "string"
        dbSecurityGroups = [
          "string"
        ]
        dbSnapshotIdentifier = "string"
        dbSubnetGroupName = "string"
        dbSystemId = "string"
        dedicatedLogVolume = bool
        deleteAutomatedBackups = bool
        deletionProtection = bool
        domain = "string"
        domainAuthSecretArn = "string"
        domainDnsIps = [
          "string"
        ]
        domainFqdn = "string"
        domainIAMRoleName = "string"
        domainOu = "string"
        enableCloudwatchLogsExports = [
          "string"
        ]
        enableIAMDatabaseAuthentication = bool
        enablePerformanceInsights = bool
        endpoint = {
          address = "string"
          hostedZoneId = "string"
          port = "string"
        }
        engine = "string"
        engineVersion = "string"
        iops = int
        kmsKeyId = "string"
        licenseModel = "string"
        manageMasterUserPassword = bool
        masterUsername = "string"
        masterUserPassword = "string"
        masterUserSecret = {
          kmsKeyId = "string"
          secretArn = "string"
        }
        maxAllocatedStorage = int
        monitoringInterval = int
        monitoringRoleArn = "string"
        multiAZ = bool
        ncharCharacterSetName = "string"
        networkType = "string"
        optionGroupName = "string"
        performanceInsightsKMSKeyId = "string"
        performanceInsightsRetentionPeriod = int
        port = "string"
        preferredBackupWindow = "string"
        preferredMaintenanceWindow = "string"
        processorFeatures = [
          {
            name = "string"
            value = "string"
          }
        ]
        promotionTier = int
        publiclyAccessible = bool
        replicaMode = "string"
        restoreTime = "string"
        sourceDBClusterIdentifier = "string"
        sourceDBInstanceAutomatedBackupsArn = "string"
        sourceDBInstanceIdentifier = "string"
        sourceDbiResourceId = "string"
        sourceRegion = "string"
        storageEncrypted = bool
        storageThroughput = int
        storageType = "string"
        tags = [
          {
            key = "string"
            value = "string"
          }
        ]
        tdeCredentialArn = "string"
        tdeCredentialPassword = "string"
        timezone = "string"
        useDefaultProcessorFeatures = bool
        useLatestRestorableTime = bool
        vpcSecurityGroups = [
          "string"
        ]
      }
      awsRegion = "string"
      awsSourceSchema = "string"
      awsTags = {
        {customized property} = "string"
      }
      publicCloudConnectorsResourceId = "string"
      publicCloudResourceName = "string"
    }
  }
}

属性值

Microsoft.AwsConnector/rdsDBInstances

名字 描述 价值
位置 资源所在的地理位置 string （必需）
名字 资源名称 字符串

约束：
模式 = ^(?=.{0,259}[^\s.]$)(?!.*[<>%&\?/#]) （必需）
性能 此资源的资源特定属性。 RdsDBInstanceProperties
标签 资源标记 标记名称和值的字典。
类型 资源类型 “Microsoft.AwsConnector/rdsDBInstances@2024-12-01”

AwsRdsDBInstanceProperties

名字 描述 价值
allocatedStorage 最初为数据库实例分配的存储量（GiB）。 如果在 Iops 参数中设置了任何值，则 AllocatedStorage 必须至少为 100 GiB，该值对应于 1,000 的最小 Iops 值。 如果增加 Iops 值（以 1,000 IOPS 为增量），则还必须增加 AllocatedStorage 值（以 100-GiB 增量为单位）。 亚马逊奥罗拉 不适用。 随着数据库中的数据量的增加，极光群集卷会自动增长，但只需为在极光群集卷中使用的空间付费。 Db2 每个存储类型的存储量的约束如下：+ 常规用途（SSD）存储（gp3）：必须是 20 到 64000 之间的整数。 + 预配的 IOPS 存储（io1）：必须是 100 到 64000 的整数。 MySQL 每个存储类型的存储量的约束如下：+ 常规用途（SSD）存储（gp2）：必须是 20 到 65536 之间的整数。 + 预配的 IOPS 存储（io1）：必须是 100 到 65536 的整数。 + 磁存储（标准）：必须是 5 到 3072 的整数。 MariaDB 每个存储类型的存储量的约束如下：+ 常规用途（SSD）存储（gp2）：必须是 20 到 65536 之间的整数。 + 预配的 IOPS 存储（io1）：必须是 100 到 65536 的整数。 + 磁存储（标准）：必须是 5 到 3072 的整数。 PostgreSQL 每种存储类型的存储量的约束如下：+ 常规用途（SSD）存储（gp2）：必须是 20 到 65536 之间的整数。 + 预配的 IOPS 存储（io1）：必须是 100 到 65536 的整数。 + 磁存储（标准）：必须是 5 到 3072 的整数。 Oracle 每个存储类型的存储量的约束如下：+ 常规用途（SSD）存储（gp2）：必须是 20 到 65536 之间的整数。 + 预配的 IOPS 存储（io1）：必须是 100 到 65536 的整数。 + 磁存储（标准）：必须是 10 到 3072 的整数。 SQL Server 每个存储类型的存储量的约束如下：+ 常规用途（SSD）存储（gp2）：+ 企业版和标准版：必须是 20 到 16384 之间的整数。 + Web 和 Express 版本：必须是 20 到 16384 的整数。 + 预配的 IOPS 存储（io1）：+ 企业版和标准版：必须是 20 到 16384 的整数。 + Web 和 Express 版本：必须是 20 到 16384 的整数。 + 磁存储（标准）：+ 企业版和标准版：必须是 20 到 1024 的整数。 + Web 和 Express 版本：必须是 20 到 1024 的整数。 字符串
allowMajorVersionUpgrade 一个值，该值指示是否允许主要版本升级。 更改此参数不会导致中断，并且更改会尽快异步应用。 约束：为与 DB 实例的当前版本不同的 EngineVersion 参数指定值时，必须允许主要版本升级。 布尔
associatedRoles 与 DB 实例关联的 IAMlong （IAM） 角色。 亚马逊奥罗拉 不适用。 关联的角色由数据库群集管理。 DBInstanceRole[]
automaticBackupReplicationKmsKeyId 属性 automaticBackupReplicationKmsKeyId 字符串
automaticBackupReplicationRegion 数据库实例的备份复制的目标区域。 有关详细信息，请参阅 Amazon RDS 用户指南中的 将自动备份复制到另一个区域。 字符串
autoMinorVersionUpgrade 一个值，该值指示在维护时段内是否自动将次要引擎升级应用于 DB 实例。 默认情况下，会自动应用次要引擎升级。 布尔
可用性区域 将在其中创建数据库的可用性区域（AZ）。 有关 AWS-Regions 和可用性区域的信息，请参阅 区域和可用性区域。 对于 Amazon Aurora，每个极光 DB 群集在三个单独的可用性区域中托管其存储的副本。 指定其中一个可用性区域。 如果未指定一个，极光会自动选择适当的可用性区域。 默认值：终结点 AWS 区域中的随机系统选择的可用性区域。 约束：如果 DB 实例是多 AZ 部署，则无法指定 AvailabilityZone 参数。 + 指定的可用性区域必须与当前终结点位于同一 AWS-Region。 示例：us-east-1d 字符串
backupRetentionPeriod （备份保留期） 自动备份保留的天数。 将此参数设置为正数可启用备份。 将此参数设置为 0 会禁用自动备份。 亚马逊奥罗拉 不适用。 自动备份的保留期由数据库群集管理。 默认值：1 约束：+ 必须是介于 0 到 35 的值 + 如果 DB 实例是只读副本的源，则不能设置为 0 整数 (int)
caCertificateIdentifier 此 DB 实例的 CA 证书的标识符。 有关详细信息，请参阅 使用 SSL/TLS 加密与 Amazon RDS 用户指南 中的 DB 实例的连接，使用 SSL/TLS 加密与 Amazon Aurora 用户指南中与 DB 群集的连接。 字符串
证书详细信息 DB 实例的服务器证书的详细信息。 返回 DB 实例的服务器证书的详细信息。 有关详细信息，请参阅 使用 SSL/TLS 加密与 Amazon RDS 用户指南 中的 DB 实例的连接，使用 SSL/TLS 加密与 Amazon Aurora 用户指南中与 DB 群集的连接。 证书详细信息
certificateRotationRestart 证书 指定轮换 SSL/TLS 证书时是否重启 DB 实例。 默认情况下，轮换 SSL/TLS 证书时，将重启 DB 实例。 在重启数据库实例之前，证书不会更新。 仅当 不使用 SSL/TLS 连接到 DB 实例 时才设置此参数。 如果使用 SSL/TLS 连接到 DB 实例，请按照 DB 引擎的相应说明轮换 SSL/TLS 证书：+ 有关轮换 RDS DB 引擎的 SSL/TLS 证书的详细信息，请参阅 轮换 SSL/TLS 证书。Amazon RDS 用户指南中的。 + 有关轮换极光数据库引擎 SSL/TLS 证书的详细信息，请参阅 Amazon Aurora 用户指南中的 轮换 SSL/TLS 证书。 此设置不适用于 RDS 自定义数据库实例。 布尔
字符集名称 对于支持的引擎，指示 DB 实例应与指定的字符集相关联。 亚马逊奥罗拉 不适用。 字符集由数据库群集管理。 有关详细信息，请参阅 AWS：：RDS：:D BCluster。 字符串
copyTagsToSnapshot 指定是否将标记从 DB 实例复制到 DB 实例的快照。 默认情况下，不会复制标记。 此设置不适用于 Amazon Aurora DB 实例。 将标记复制到快照由数据库群集管理。 为极光 DB 实例设置此值不会影响 DB 群集设置。 布尔
customIAMInstanceProfile 与 RDS 自定义数据库实例的基础 Amazon EC2 实例关联的实例配置文件。 RDS 自定义需要此设置。 约束：+ 配置文件必须存在于帐户中。 + 配置文件必须具有 Amazon EC2 有权承担的 IAM 角色。 + 实例配置文件名称和关联的 IAM 角色名称必须以前缀 AWSRDSCustom开头。 有关 IAM 角色所需的权限列表，请参阅 Amazon RDS 用户指南中的 配置 IAM 和你的。 字符串
dbClusterIdentifier 数据库集群标识符 实例所属的 DB 群集的标识符。 字符串
dbClusterSnapshotIdentifier 数据库集群快照标识符 要从中还原的多 AZ DB 群集快照的标识符。 有关多 AZ DB 群集的详细信息，请参阅 Amazon RDS 用户指南中的 多 AZ DB 群集部署。 约束：+ 必须与现有多 AZ DB 群集快照的标识符匹配。 指定 DBSnapshotIdentifier 时无法指定 + 。 如果未指定 DBSnapshotIdentifier，则必须指定 + 。 + 如果要从共享手动多 AZ DB 群集快照还原，DBClusterSnapshotIdentifier 必须是共享快照的 ARN。 + 不能是极光数据库群集快照的标识符。 字符串
dbInstanceArn 数据库实例 属性 dbInstanceArn 字符串
dbInstance类 DB 实例的计算和内存容量，例如 db.m5.large。 并非所有 DB 实例类在所有 AWS 区域或所有数据库引擎中都可用。 有关 DB 实例类的完整列表以及引擎的可用性，请参阅 Amazon RDS 用户指南 中的 DB 实例类，或在 Amazon Aurora 用户指南 极光 DB 实例类。 字符串
dbInstanceIdentifier 数据库实例标识符 DB 实例的名称。 如果指定名称，AWS CloudFormation 会将它转换为小写。 如果未指定名称，AWS CloudFormation 将生成唯一的物理 ID，并将该 ID 用于数据库实例。 有关详细信息，请参阅 名称类型。 有关适用于 DB 实例标识符的约束的信息，请参阅 Amazon RDS 用户指南Amazon RDS 中的命名约束。 如果指定名称，则无法执行需要替换此资源的更新。 可以执行不需要或某些中断的更新。 如果必须替换资源，请指定一个新名称。 字符串
dbiResourceId 属性 dbiResourceId 字符串
数据库名称 此参数的含义因所使用的数据库引擎而异。 如果指定 DBSnapshotIdentifier 属性，则此属性仅适用于 Oracle 的 RDS。 亚马逊奥罗拉 不适用。 数据库名称由数据库群集管理。 Db2 创建数据库实例时要创建的数据库的名称。 如果未指定此参数，则不会在 DB 实例中创建任何数据库。 约束：+ 必须包含 1 到 64 个字母或数字。 + 必须以字母开头。 后续字符可以是字母、下划线或数字（0-9）。 + 不能是指定数据库引擎保留的单词。 MySQL 创建数据库实例时要创建的数据库的名称。 如果未指定此参数，则不会在 DB 实例中创建任何数据库。 约束：+ 必须包含 1 到 64 个字母或数字。 + 不能由指定的数据库引擎保留一个单词，MariaDB 创建数据库实例时要创建的数据库的名称。 如果未指定此参数，则不会在 DB 实例中创建任何数据库。 约束：+ 必须包含 1 到 64 个字母或数字。 + 无法由指定的数据库引擎保留一个单词，PostgreSQL 创建数据库实例时要创建的数据库的名称。 如果未指定此参数，则会在 DB 实例中创建默认 postgres 数据库。 约束：+ 必须以字母开头。 后续字符可以是字母、下划线或数字（0-9）。 + 必须包含 1 到 63 个字符。 + 不能由指定的数据库引擎保留一个单词，Oracle 创建的 DB 实例的 Oracle 系统 ID （SID）。 如果指定 null，则使用默认值 ORCL。 不能为 DBName指定字符串 NULL 或任何其他保留字。 默认值：ORCL 约束：+ 不能超过 8 个字符 SQL Server 不适用。 必须为 null。 字符串
dbParameterGroupName 数据库参数组名称 现有 DB 参数组的名称或对在模板中创建的 AWS：：RDS：:D BParameterGroup 资源的引用。 若要列出所有可用的 DB 参数组名称，请使用以下命令：aws rds describe-db-parameter-groups --query 'DBParameterGroups[].DBParameterGroupName' --output text 如果在更新期间更改了引用的参数组的任何数据成员，则可能需要重启 DB 实例，这会导致一些中断。 如果参数组包含静态参数（无论它们是否已更改），则更新会触发重新启动。 如果未为 DBParameterGroupName 属性指定值，则使用指定引擎和引擎版本的默认 DB 参数组。 字符串
dbSecurity组 要分配给 DB 实例的 DB 安全组的列表。 该列表可以包括现有 DB 安全组的名称或对模板中创建的 AWS：：RDS：:D BSecurityGroup 资源引用。 如果设置了 DBSecurityGroups，则不得设置VPSecurityGroups，反之亦然。 此外，请注意，DBSecurityGroups 属性仅用于向后兼容较旧的区域，因此不再建议向 RDS DB 实例提供安全信息。 请改用VPSecurityGroups。 如果指定此属性，AWS CloudFormation 只会在创建操作期间向 Amazon RDS 发送以下属性（如果指定）：+ AllocatedStorage + AutoMinorVersionUpgrade + AvailabilityZone + BackupRetentionPeriod + CharacterSetName + DBInstanceClass + DBName + DBParameterGroupName + DBSecurityGroups + DBSubnetGroupName + Engine + EngineVersion + Iops + LicenseModel + MasterUsername + MasterUserPassword + MultiAZ + OptionGroupName + PreferredBackupWindow + PreferredMaintenanceWindow 将忽略所有其他属性。 如果要提交其他属性（例如 StorageType、StorageEncrypted或 KmsKeyId），请指定虚拟私有云（KmsKeyId） 安全组。 如果已在使用 DBSecurityGroups 属性，则无法通过更新 DB 实例以使用一个 DBSecurityGroups 安全组来使用这些其他属性。 必须重新创建 DB 实例。 字符串[]
dbSnapshotIdentifier 数据库快照标识符 用于还原 DB 实例的 DB 快照的名称或 Amazon 资源名称（ARN）。 如果要从共享手动数据库快照还原，则必须指定快照的 ARN。 通过指定此属性，可以从指定的数据库快照创建数据库实例。 如果 DBSnapshotIdentifier 属性是空字符串，或者 AWS::RDS::DBInstance 声明没有 DBSnapshotIdentifier 属性，则 AWS CloudFormation 将创建新的数据库。 如果属性包含一个值（而不是空字符串），AWS CloudFormation 将从指定的快照创建数据库。 如果具有指定名称的快照不存在，则 AWS CloudFormation 无法创建数据库，并且会回滚堆栈。 从快照（如 MasterUsername 和 MasterUserPassword 属性）还原时，某些 DB 实例属性无效。 有关可以指定的属性的信息，请参阅 RestoreDBInstanceFromDBSnapshot中的 操作。 使用 DBSnapshotIdentifier 属性还原 DB 实例后，必须为将来对 DB 实例进行任何更新指定相同的 DBSnapshotIdentifier 属性。 为更新指定此属性时，不会再次从数据库快照还原 DB 实例，并且数据库中的数据不会更改。 但是，如果未指定 DBSnapshotIdentifier 属性，则会创建一个空的 DB 实例，并删除原始 DB 实例。 如果指定的属性与以前的快照还原属性不同，则会从指定的 DBSnapshotIdentifier 属性还原新的 DB 实例，并删除原始 DB 实例。 如果指定 DBSnapshotIdentifier 属性来还原 DB 实例（而不是为数据库实例更新指定），则不要指定以下属性：+ CharacterSetName + DBClusterIdentifier + DBName + DeleteAutomatedBackups + EnablePerformanceInsights + KmsKeyId + MasterUsername + MasterUserPassword + PerformanceInsightsKMSKeyId + PerformanceInsightsRetentionPeriod + PromotionTier + SourceDBInstanceIdentifier + SourceRegion + StorageEncrypted （用于加密快照） + TimezoneAmazon Aurora 不适用。 快照还原由数据库群集管理。 字符串
dbSubnetGroupName 要与 DB 实例关联的 DB 子网组。 如果更新此值，则新子网组必须是新KB 中的子网组。 如果没有 DB 子网组，则 DB 实例不是一个VP DB 实例。 有关在 Amazon RDS 用户指南中的 将 Amazon RDS 与 Amazon 虚拟私有云配合使用（）的详细信息。 亚马逊奥罗拉 不适用。 DB 子网组由数据库群集管理。 如果指定，则设置必须与 DB 群集设置匹配。 字符串
dbSystemId 数据库系统 ID Oracle 系统标识符 （SID），它是管理数据库文件的 Oracle 数据库实例的名称。 在此上下文中，术语“Oracle 数据库实例”仅指系统全局区域（SGA）和 Oracle 后台进程。 如果未指定 SID，则值默认为 RDSCDB。 Oracle SID 也是 CDB 的名称。 字符串
dedicatedLogVolume 指示 DB 实例是否启用了专用日志卷（DLV）。 布尔
deleteAutomated备份 一个值，该值指示是否在删除 DB 实例后立即删除自动备份。 此参数不区分大小写。 默认值是在删除 DB 实例后立即删除自动备份。 亚马逊奥罗拉 不适用。 删除数据库群集时，会删除该 DB 群集的所有自动备份，并且无法恢复。 不会删除 DB 群集的手动数据库群集快照。 布尔
deletion保护 一个值，该值指示数据库实例是否已启用删除保护。 启用删除保护时，无法删除数据库。 默认情况下，删除保护处于禁用状态。 有关详细信息，请参阅 删除数据库实例。 亚马逊奥罗拉 不适用。 可以为数据库群集启用或禁用删除保护。 有关详细信息，请参阅 CreateDBCluster。 即使为数据库群集启用了删除保护，也可以删除 DB 群集中的 DB 实例。 布尔
域 要在其中创建 DB 实例的 Active Directory 目录 ID。 目前，只能在 Active Directory 域中创建 Db2、MySQL、Microsoft SQL Server、Oracle 和 PostgreSQL DB 实例。 有关详细信息，请参阅 Amazon RDS 用户指南中的 Kerberos 身份验证。 字符串
domainAuthSecretArn 域名 机密管理器机密的 ARN，其中包含用于加入域的用户的凭据。 示例：arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456 字符串
domainDnsIps 域名 主和辅助 Active Directory 域控制器的 IPv4 DNS IP 地址。 约束：必须提供 + 两个 IP 地址。 如果没有辅助域控制器，请使用主域控制器的 IP 地址作为列表中的这两个条目。 示例：123.124.125.126,234.235.236.237 字符串[]
domainFqdn 域名 Active Directory 域的完全限定域名（FQDN）。 约束：+ 不能超过 64 个字符。 示例：mymanagedADtest.mymanagedAD.mydomain 字符串
domainIAMRoleName 域名 对目录服务进行 API 调用时要使用的 IAM 角色的名称。 此设置不适用于以下 DB 实例：+ Amazon Aurora（域由数据库群集管理）。） + RDS 自定义 字符串
域Ou 要加入的 DB 实例的 Active Directory 组织单位。 约束：+ 必须采用可分辨名称格式。 + 不能超过 64 个字符。 示例：OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain 字符串
启用CloudwatchLogsExports 需要启用用于导出到 CloudWatch 日志的日志类型的列表。 列表中的值取决于所使用的数据库引擎。 有关详细信息，请参阅 Amazon Relational Database Service 用户指南中的 将数据库日志发布到 Amazon CloudWatch 日志。 亚马逊奥罗拉 不适用。 CloudWatch 日志导出由数据库群集管理。 Db2 有效值：diag.log、notify.logMariaDB 有效值：audit、error、general、slowqueryMicrosoft SQL Server 有效值：agent、errorMySQL 有效值：audit、error、general、slowqueryOracle 有效值：alert、audit、listener、trace、oemagentPostgreSQL 有效值：postgresql、upgrade 字符串[]
enableIAMDatabaseAuthentication 一个值，该值指示是否启用 AWS 标识和访问管理 （IAM） 帐户到数据库帐户的映射。 默认情况下，映射处于禁用状态。 RDS for MariaDB、RDS for MySQL 和 RDS for PostgreSQL 支持此属性。 有关详细信息，请参阅 Amazon RDS 用户指南中的 IAM Database Authentication for MariaDB、MySQL 和 PostgreSQL。亚马逊奥罗拉 不适用。 AWS IAM 帐户映射到数据库帐户由数据库群集管理。 布尔
enablePerformanceInsights 指定是否为数据库实例启用 Performance Insights。 有关详细信息，请参阅 Amazon RDS 用户指南中的 使用 Amazon Performance Insights。 此设置不适用于 RDS 自定义数据库实例。 布尔
端点 DB 实例的连接终结点。 对于状态为 creating的实例，可能不会显示终结点。 此数据类型表示连接到 Amazon RDS DB 实例所需的信息。 此数据类型在以下操作中用作响应元素：+ CreateDBInstance + DescribeDBInstances + DeleteDBInstance 对于表示 Amazon Aurora DB 群集终结点的数据结构，请参阅 DBClusterEndpoint。 端点自动生成2
发动机 要用于此 DB 实例的数据库引擎的名称。 并非每个数据库引擎在每个 AWS 区域中都可用。 创建数据库实例时，此属性是必需的。 可以通过将模板中的 Engine 值从 oracle-ee 或 oracle-ee-cdb 更新为 oracle-se2-cdb，将 Oracle 数据库的体系结构从非容器数据库 （CDB） 体系结构更改为 CDB 体系结构。 转换为 CDB 体系结构需要中断。 有效值：+ aurora-mysql （对于 Aurora MySQL DB 实例） + aurora-postgresql （对于 Aurora PostgreSQL DB 实例） + custom-oracle-ee （适用于 Oracle DB 实例的 RDS 自定义） + custom-oracle-ee-cdb （适用于 Oracle DB 的 RDS 自定义） instances） + custom-sqlserver-ee （for RDS Custom for SQL Server DB instances） + custom-sqlserver-se （for RDS Custom for SQL Server DB instances） + custom-sqlserver-web （for RDS Custom for SQL Server DB instances） + db2-ae + db2-se + mariadb + mysql + oracle-ee + oracle-ee-cdb + oracle-se2 + oracle-se2-cdb + postgres + sqlserver-ee + sqlserver-se + sqlserver-ex + sqlserver-web 字符串
engineVersion （引擎版本） 要使用的数据库引擎的版本号。 有关有效引擎版本的列表，请使用 DescribeDBEngineVersions 操作。 以下是数据库引擎以及有关 Amazon RDS 提供的主要和次要版本的信息的链接。 并非每个数据库引擎都可用于每个 AWS 区域。 亚马逊奥罗拉 不适用。 数据库实例要使用的数据库引擎的版本号由数据库群集管理。 Db2 请参阅 Amazon RDS 用户指南中的 Amazon RDS for Db2。MariaDB 请参阅 Amazon RDS 用户指南中的 amazon RDS 版本 上的 MariaDB。Microsoft SQL Server 请参阅 Amazon RDS 用户指南中的 Microsoft Amazon RDS 上的 SQL Server 版本。MySQL 请参阅 Amazon RDS 用户指南中的 Amazon RDS 版本 上的 MySQL。Oracle 请参阅 Amazon RDS 用户指南中的 Oracle 数据库引擎发行说明。PostgreSQL 请参阅 Amazon RDS 用户指南中的 支持的 PostgreSQL 数据库版本。 字符串
IOPS （国际速率） 数据库预配的每秒 I/O 操作数（IOPS）。 该值必须等于或大于 1000。 如果指定此属性，则必须遵循所请求的 IOPS 速率的允许比率范围，以及分配的存储量（分配给分配的存储的 IOPS）。 例如，可以使用 1000 IOPS 和 200 GiB 存储预配 Oracle 数据库实例（比率为 5：1），或者指定 2000 IOPS（存储 200 GiB 比率）。 有关详细信息，请参阅 Amazon RDS 预配的 IOPS 存储以提高 Amazon RDS 用户指南中的性能。 如果为 io1 属性指定 StorageType，则还必须指定 Iops 属性。 约束：+ 对于 DB2、MariaDB、MySQL、Oracle 和 PostgreSQL 的 RDS - 必须是 DB 实例的存储量的 .5 到 50 之间的倍数。 + 对于 SQL Server 的 RDS - 必须是数据库实例的存储量介于 1 到 50 之间的倍数。 整数 (int)
kmsKeyId 用于加密 DB 实例的 AWS KMS 密钥的 ARN，例如 arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef。 如果启用 StorageEncrypted 属性但未指定此属性，AWS CloudFormation 将使用默认 KMS 密钥。 如果指定此属性，则必须将 StorageEncrypted 属性设置为 true。 如果指定 SourceDBInstanceIdentifier 属性，则当在同一区域中创建只读副本时，该值将从源 DB 实例继承。 如果在不同的 AWS 区域中创建加密的只读副本，则必须为目标 AWS 区域指定 KMS 密钥。 KMS 加密密钥特定于在其中创建的区域，不能使用另一个区域中的加密密钥。 如果指定 SnapshotIdentifier 属性，则 StorageEncrypted 属性值继承自快照;如果 DB 实例已加密，则使用指定的 KmsKeyId 属性。 如果指定 DBSecurityGroups，AWS CloudFormation 将忽略此属性。 若要同时指定安全组和此属性，必须使用一个VP安全组。 有关 Amazon RDS 和 将 Amazon RDS 与 Amazon RDS 配合使用的详细信息，请参阅 Amazon RDS 用户指南中的 Amazon RDS。 亚马逊奥罗拉 不适用。 KMS 密钥标识符由数据库群集管理。 字符串
许可模型 此 DB 实例的许可证模型信息。 有效值：+ 奥罗拉 MySQL - general-public-license + 奥罗拉 PostgreSQL - postgresql-license + RDS for Db2 - bring-your-own-license。 有关 RDS for Db2 许可的详细信息，请参阅 Amazon RDS 用户指南中的 。 + RDS for MariaDB - general-public-license + RDS for Microsoft SQL Server - license-included + RDS for MySQL - general-public-license + RDS for Oracle - bring-your-own-license 或 license-included + RDS for PostgreSQL - postgresql-license 如果已指定 DBSecurityGroups，然后更新许可证模型，AWS CloudFormation 将替换基础 DB 实例。 这会导致数据库可用性出现一些中断。 字符串
manageMasterUserPassword 指定是否使用 AWS 机密管理器管理主用户密码。 有关详细信息，请参阅 Amazon RDS 用户指南中的 密码管理与机密管理器。 约束：如果指定了 MasterUserPassword，则不能使用 AWS 机密管理器管理主用户密码。 布尔
master用户名 DB 实例的主用户名。 如果指定 SourceDBInstanceIdentifier 或 DBSnapshotIdentifier 属性，请不要指定此属性。 该值继承自源 DB 实例或快照。 迁移自托管 Db2 数据库时，建议使用与自托管 Db2 实例名称相同的主用户名。 亚马逊奥罗拉 不适用。 主用户的名称由数据库群集管理。 DB2 约束的 RDS：+ 必须为 1 到 16 个字母或数字。 + 第一个字符必须是字母。 + 不能是所选数据库引擎的保留字。 RDS for MariaDB 约束：+ 必须为 1 到 16 个字母或数字。 + 不能是所选数据库引擎的保留字。 RDS Microsoft SQL Server 约束：+ 必须为 1 到 128 个字母或数字。 + 第一个字符必须是字母。 + 不能是所选数据库引擎的保留字。 RDS for MySQL 约束：+ 必须为 1 到 16 个字母或数字。 + 第一个字符必须是字母。 + 不能是所选数据库引擎的保留字。 Oracle 约束的 RDS：+ 必须为 1 到 30 个字母或数字。 + 第一个字符必须是字母。 + 不能是所选数据库引擎的保留字。 RDS for PostgreSQL 约束：+ 必须为 1 到 63 个字母或数字。 + 第一个字符必须是字母。 + 不能是所选数据库引擎的保留字。 字符串
masterUserPassword （主用户密码） 主用户的密码。 密码可以包含除“/”、“'”或“@”以外的任何可打印 ASCII 字符。 亚马逊奥罗拉 不适用。 主用户的密码由数据库群集管理。 RDS for Db2 必须包含 8 到 255 个字符。 RDS for MariaDB 约束：必须包含 8 到 41 个字符。 RDS for Microsoft SQL Server 约束：必须包含 8 到 128 个字符。 RDS for MySQL 约束：必须包含 8 到 41 个字符。 用于 Oracle 约束的 RDS：必须包含 8 到 30 个字符。 RDS for PostgreSQL 约束：必须包含 8 到 128 个字符。 字符串
masterUserSecret 由 AWS 机密管理器中 RDS 管理的机密，用于主用户密码。 有关详细信息，请参阅 Amazon RDS 用户指南中的 密码管理与机密管理器。MasterUserSecret 返回值指定主用户密码的 AWS 机密管理器中 RDS 管理的机密。 有关详细信息，请参阅 Amazon RDS 用户指南 中的 密码管理与机密管理器 密码管理，Amazon Aurora 用户指南中的机密管理器 密码管理。 MasterUserSecret （主用户密钥）
maxAllocatedStorage Amazon RDS 可以自动缩放 DB 实例存储的上限（GiB）。 有关此设置的详细信息（包括适用的限制）请参阅 Amazon RDS 用户指南中的 使用 Amazon RDS 存储自动缩放 管理容量。 此设置不适用于以下 DB 实例：+ Amazon Aurora（存储由数据库群集管理）。） + RDS 自定义 整数 (int)
monitoringInterval （监控间隔） 为 DB 实例收集增强型监视指标时，间隔（以秒为单位）。 若要禁用增强型监视指标的收集，请指定 0。 默认值为 0。 如果指定了 MonitoringRoleArn，则必须将 MonitoringInterval 设置为 0 以外的值。 此设置不适用于 RDS 自定义。 有效值：0, 1, 5, 10, 15, 30, 60 整数 (int)
monitoringRoleArn 允许 RDS 将增强的监视指标发送到 Amazon CloudWatch 日志的 IAM 角色的 ARN。 例如，arn:aws:iam:123456789012:role/emaccess。 有关创建监视角色的信息，请参阅 Amazon RDS 用户指南设置和启用增强型监视。 如果 MonitoringInterval 设置为非 0的值，则必须提供 MonitoringRoleArn 值。 此设置不适用于 RDS 自定义数据库实例。 字符串
多可用区 指定数据库实例是否为多 AZ DB 实例部署。 如果 AvailabilityZone 参数设置为 true，则无法设置 MultiAZ 参数。 有关详细信息，请参阅 Amazon RDS 用户指南中的 多 AZ 部署以实现高可用性。 亚马逊奥罗拉 不适用。 Amazon Aurora 存储跨所有可用性区域复制，不需要设置 MultiAZ 选项。 布尔
ncharCharacterSet名称 Oracle DB 实例的 NCHAR 字符集的名称。 此设置不适用于 RDS 自定义数据库实例。 字符串
网络类型 DB 实例的网络类型。 有效值：+ IPV4 + DUAL 网络类型由为 DB 实例指定的 DBSubnetGroup 确定。 DBSubnetGroup 只能支持 IPv4 协议或 IPv4 和 IPv6 协议（DUAL）。 有关详细信息，请参阅 Amazon RDS 用户指南中的 在 中处理 DB 实例。 字符串
optionGroupName （选项组名称） 指示 DB 实例应与指定的选项组相关联。 无法从选项组中删除永久选项，例如 Oracle 高级安全 TDE 的 TDE 选项。 此外，与数据库实例关联后，无法从数据库实例中删除该选项组。 字符串
performanceInsightsKMSKeyId 用于加密 Performance Insights 数据的 AWS KMS 密钥标识符。 KMS 密钥标识符是 KMS 密钥的密钥 ARN、密钥 ID、别名 ARN 或别名。 如果未为 PerformanceInsightsKMSKeyId指定值，则 Amazon RDS 将使用默认 KMS 密钥。 AWS 帐户的默认 KMS 密钥。 AWS 帐户为每个 AWS 区域使用不同的默认 KMS 密钥。 有关启用 Performance Insights 的信息，请参阅 EnablePerformanceInsights。 字符串
performanceInsightsRetentionPeriod （性能洞察保留期） 保留 Performance Insights 数据的天数。 此设置不适用于 RDS 自定义数据库实例。 有效值：+ 7 + 个月 * 31，其中 个月 为 1-23 个月的月份。 示例：93（3 个月 * 31）、341 （11 个月 * 31）、589 （19 个月 * 31） + 731 默认值：7 天（如果指定无效的保留期，如 94），Amazon RDS 将返回错误。 整数 (int)
港口 数据库接受连接的端口号。 亚马逊奥罗拉 不适用。 端口号由数据库群集管理。 Db2 默认值：50000 字符串
preferredBackupWindow （首选备份窗口） 如果启用了自动备份，则使用 BackupRetentionPeriod 参数创建自动备份的每日时间范围。 有关详细信息，请参阅 Amazon RDS 用户指南中的 备份窗口。 约束：+ 必须采用 hh24:mi-hh24:mi格式。 + 必须处于世界协调时间（UTC）。 + 不得与首选维护时段冲突。 + 必须至少为 30 分钟。 亚马逊奥罗拉 不适用。 创建自动备份的每日时间范围由数据库群集管理。 字符串
preferredMaintenanceWindow 系统维护的每周时间范围（UTC）。 格式：ddd:hh24:mi-ddd:hh24:mi 默认为从每个 AWS 区域的 8 小时时间块随机选择的 30 分钟窗口，发生在一周中的随机一天。 若要查看可用的时间块，请参阅 Amazon RDS 用户指南中 调整首选数据库实例维护时段。 当 AWS CloudFormation 最初创建 DB 实例时，此属性适用。 如果使用 AWS CloudFormation 更新 DB 实例，则立即应用这些更新。 约束：最小 30 分钟窗口。 字符串
处理器特性 DB 实例类的 CPU 内核数和每个核心的线程数。 此设置不适用于 Amazon Aurora 或 RDS 自定义数据库实例。 处理器功能
促销等级 在现有主实例发生故障后，极光副本提升到主实例的优先级顺序。 有关详细信息，请参阅 Amazon Aurora 用户指南 中对极光数据库群集的容错 。 此设置不适用于 RDS 自定义数据库实例。 默认值：1 有效值：0 - 15 整数 (int)
可公开访问 指示 DB 实例是否为面向 Internet 的实例。 如果指定 true，AWS CloudFormation 将创建具有可公开解析 DNS 名称的实例，该名称解析为公共 IP 地址。 如果指定 false，AWS CloudFormation 会创建一个内部实例，其中包含解析为专用 IP 地址的 DNS 名称。 默认行为值取决于你的VP 设置和数据库子网组。 有关详细信息，请参阅 PubliclyAccessibleCreateDBInstance 中的 参数。 布尔
replicaMode Oracle 只读副本的打开模式。 有关详细信息，请参阅 Amazon RDS 用户指南中的 使用 Amazon RDS 的 Oracle 只读副本。 此设置仅在 RDS for Oracle 中受支持。 默认值：open-read-only 有效值：open-read-only 或 mounted 字符串
恢复时间 要从中进行还原的日期和时间。 约束：+ 必须是世界协调时间（UTC）格式的时间。 + 必须在数据库实例的最新可还原时间之前。 如果启用了 UseLatestRestorableTime 参数，则无法指定 + 。 示例：2009-09-07T23:45:00Z 字符串
sourceDBClusterIdentifier 将充当只读副本的源的多 AZ DB 群集的标识符。 每个 DB 群集最多可以有 15 个只读副本。 约束：+ 必须是现有多 AZ DB 群集的标识符。 如果还指定了 SourceDBInstanceIdentifier 参数，则无法指定 + 。 + 指定的 DB 群集必须启用自动备份，即其备份保留期必须大于 0。 + 源 DB 群集必须与只读副本位于同一 AWS-Region。 不支持跨区域复制。 字符串
源DBInstanceAutomatedBackupsArn 要从中还原的自动备份的 Amazon 资源名称（ARN），例如 arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE。 此设置不适用于 RDS 自定义。 字符串
源DBInstanceIdentifier 如果要创建只读副本数据库实例，请指定源 DB 实例的 ID。 每个 DB 实例可以有有限数量的只读副本。 有关详细信息，请参阅 Amazon RDS 用户指南中的 使用只读副本。 有关适用于 DB 实例标识符的约束的信息，请参阅 Amazon RDS 用户指南Amazon RDS 中的命名约束。 SourceDBInstanceIdentifier 属性确定 DB 实例是否为只读副本。 如果从模板中删除 SourceDBInstanceIdentifier 属性，然后更新堆栈，AWS CloudFormation 会将只读副本提升为独立的 DB 实例。 + 如果指定使用 VPCSecurityGroups 安全组的源数据库实例，建议指定 VPCSecurityGroups 属性。 如果未指定该属性，只读副本会在创建副本时从源 DB 继承 VPCSecurityGroups 属性的值。 但是，如果更新堆栈，AWS CloudFormation 会将副本的 VPCSecurityGroups 属性还原为默认值，因为它未在堆栈的模板中定义。 此更改可能会导致意外问题。 + 只读副本不支持删除策略。 AWS CloudFormation 忽略与只读副本关联的任何删除策略。 + 如果指定 SourceDBInstanceIdentifier，请不要指定 DBSnapshotIdentifier 属性。 无法从快照创建只读副本。 + 不要设置 BackupRetentionPeriod、DBName、MasterUsername、MasterUserPassword和 PreferredBackupWindow 属性。 数据库属性继承自源 DB 实例，对只读副本禁用备份。 + 如果源 DB 实例位于与只读副本不同的区域中，请在 SourceRegion中指定源区域，并为 SourceDBInstanceIdentifier中的有效 DB 实例指定 ARN。 有关详细信息，请参阅 Amazon RDS 用户指南中的 构建 Amazon RDS Amazon 资源名称（ARN）。 + 对于 Amazon Aurora 群集中的 DB 实例，请勿指定此属性。 Amazon RDS 会自动分配编写器和读取器 DB 实例。 字符串
源 DbiResourceId 要从中还原的源 DB 实例的资源 ID。 字符串
源区域 包含只读副本的源 DB 实例的区域 ID。 字符串
存储加密 一个值，该值指示是否加密 DB 实例。 默认情况下，它不会加密。 如果指定 KmsKeyId 属性，则必须启用加密。 如果指定 SourceDBInstanceIdentifier 属性，请不要指定此属性。 该值继承自源 DB 实例，如果 DB 实例已加密，则使用指定的 KmsKeyId 属性。 如果指定 DBSnapshotIdentifier 且指定的快照已加密，请不要指定此属性。 该值继承自快照，并使用指定的 KmsKeyId 属性。 如果指定 DBSnapshotIdentifier 且未加密指定的快照，则可以使用此属性指定已还原的 DB 实例已加密。 指定要用于加密的 KMS 密钥的 KmsKeyId 属性。 如果不希望对还原的 DB 实例进行加密，请不要设置此属性或将其设置为 false。 亚马逊奥罗拉 不适用。 DB 实例的加密由数据库群集管理。 布尔
storage吞吐量 指定 DB 实例的存储吞吐量值。 此设置仅适用于 gp3 存储类型。 此设置不适用于 RDS 自定义或 Amazon Aurora。 整数 (int)
存储类型 要与 DB 实例关联的存储类型。 如果指定 io1、io2或 gp3，则还必须包含 Iops 参数的值。 此设置不适用于 Amazon Aurora DB 实例。 存储由数据库群集管理。 有效值：gp2 \| gp3 \| io1 \| io2 \| standard 默认值：io1，如果指定了 Iops 参数。 否则，gp2。 字符串
标签 要应用于此 DB 实例的键值对的可选数组。 标签自动生成46[]
tdeCredentialArn 属性 tdeCredentialArn 字符串
tdeCredentialPassword （tdeCredential密码） 属性 tdeCredentialPassword 字符串
时区 DB 实例的时区。 时区参数目前仅受 SQL ServerMicrosoft 支持。 字符串
useDefaultProcessorFeatures 指定 DB 实例的 DB 实例类是否使用其默认处理器功能。 此设置不适用于 RDS 自定义数据库实例。 布尔
使用LatestRestorableTime 指定是否从最新的备份时间还原 DB 实例。 默认情况下，不会从最新的备份时间还原 DB 实例。 约束：如果提供了 RestoreTime 参数，则无法指定 + 。 布尔
vpSecurityGroups 要分配给 DB 实例的VP 安全组 ID 的列表。 该列表可以包括现有 资源组的物理 ID 以及对在模板中创建的 AWS：：EC2：：SecurityGroup 资源的引用。 如果计划更新资源，请不要在共享的KB 中指定VP安全组。 如果设置 VPCSecurityGroups，则不得 DBSecurityGroups设置，反之亦然。 可以将堆栈中的 DB 实例从 RDS DB 安全组迁移到一个VP安全组，但请记住以下几点：+ 建立一个VP安全组成员身份后，不能还原为使用 RDS 安全组。 + 将数据库实例迁移到VP 安全组时，如果堆栈更新因 DB 实例更新失败或另一个 AWS CloudFormation 资源中的更新失败而回滚，则回滚会失败，因为它无法还原到 RDS 安全组。 + 若要使用使用VP安全组时可用的属性，必须重新创建 DB 实例。 否则，AWS CloudFormation 仅提交 DBSecurityGroups 属性中列出的属性值。 为了避免这种情况，请仅在堆栈模板中唯一发生更改时才将 DB 实例迁移到使用VP 安全组。 亚马逊奥罗拉 不适用。 EC2VP 安全组的关联列表由数据库群集管理。 如果指定，则设置必须与 DB 群集设置匹配。 字符串[]

证书详细信息

名字 描述 价值
ca标识符 用于 DB 实例服务器证书的 CA 证书的 CA 标识符。 字符串
validTill DB 实例的服务器证书的到期日期。 字符串

DBInstanceRole

名字 描述 价值
功能名称 与 AWS 标识和访问管理（IAM）角色关联的功能的名称。 与 DB 实例关联的 IAM 角色授予 DB 实例代表你访问其他 AWS 服务的权限。 有关受支持的功能名称列表，请参阅 SupportedFeatureNamesDBEngineVersion 中的 说明。 字符串
roleArn 与 DB 实例关联的 IAM 角色的 Amazon 资源名称（ARN）。 字符串

端点自动生成2

名字 描述 价值
地址 指定 DB 实例的 DNS 地址。 字符串
托管区域 ID 指定创建托管区域时 Amazon Route 53 分配的 ID。 字符串
港口 指定数据库引擎正在侦听的端口。 字符串

MasterUserSecret （主用户密钥）

名字 描述 价值
kmsKeyId 用于加密机密的 AWS KMS 密钥标识符。 字符串
secretArn 机密的 Amazon 资源名称（ARN）。 字符串

处理器功能

名字 描述 价值
名字 处理器功能的名称。 有效名称 coreCount 和 threadsPerCore。 “coreCount”
“threadsPerCore”
价值 处理器功能名称的值。 字符串

RdsDBInstanceProperties

名字 描述 价值
阿恩 Amazon 资源名称 （ARN） 字符串
awsAccountId AWS 帐户 ID 字符串
awsProperties AWS 属性 AwsRdsDBInstanceProperties
awsRegion AWS 区域 字符串
awsSourceSchema AWS 源架构 字符串
aws标签 AWS 标记 RdsDBInstancePropertiesAwsTags
publicCloudConnectorsResourceId 公有云连接器资源 ID 字符串
publicCloudResourceName （公共云资源名称） 公有云资源名称 字符串

RdsDBInstancePropertiesAwsTags

名字 描述 价值

标签自动生成46

名字 描述 价值
钥匙 键是标记的必需名称。 字符串值可以是长度为 1 到 128 个 Unicode 字符，不能以 aws: 或 rds:为前缀。 该字符串只能包含 Unicode 字母、数字、空格、''、'.'、'：'、'/'、'='、'+'、'-'、'@'（Java 正则表达式：'^（[\p{L}\p{Z}\p{N}.：/=+\-@]*）$ 。 字符串
价值 值是标记的可选值。 字符串值可以是长度为 1 到 256 个 Unicode 字符，不能以 aws: 或 rds:为前缀。 该字符串只能包含 Unicode 字母、数字、空格、''、'.'、'：'、'/'、'='、'+'、'-'、'@'（Java 正则表达式：'^（[\p{L}\p{Z}\p{N}.：/=+\-@]*）$ 。 字符串

TrackedResourceTags

名字 描述 价值