你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Bicep 资源定义
可以使用目标操作部署 rdsDBClusters 资源类型:
- 资源组 - 请参阅 资源组部署命令
有关每个 API 版本中已更改属性的列表,请参阅 更改日志。
资源格式
若要创建 Microsoft.AwsConnector/rdsDBClusters 资源,请将以下 Bicep 添加到模板。
resource symbolicname 'Microsoft.AwsConnector/rdsDBClusters@2024-12-01' = {
location: 'string'
name: 'string'
properties: {
arn: 'string'
awsAccountId: 'string'
awsProperties: {
allocatedStorage: int
associatedRoles: [
{
featureName: 'string'
roleArn: 'string'
}
]
autoMinorVersionUpgrade: bool
availabilityZones: [
'string'
]
backtrackWindow: int
backupRetentionPeriod: int
copyTagsToSnapshot: bool
databaseName: 'string'
dbClusterArn: 'string'
dbClusterIdentifier: 'string'
dbClusterInstanceClass: 'string'
dbClusterParameterGroupName: 'string'
dbClusterResourceId: 'string'
dbInstanceParameterGroupName: 'string'
dbSubnetGroupName: 'string'
dbSystemId: 'string'
deletionProtection: bool
domain: 'string'
domainIAMRoleName: 'string'
enableCloudwatchLogsExports: [
'string'
]
enableGlobalWriteForwarding: bool
enableHttpEndpoint: bool
enableIAMDatabaseAuthentication: bool
endpoint: {
address: 'string'
port: 'string'
}
engine: 'string'
engineMode: 'string'
engineVersion: 'string'
globalClusterIdentifier: 'string'
iops: int
kmsKeyId: 'string'
manageMasterUserPassword: bool
masterUsername: 'string'
masterUserPassword: 'string'
masterUserSecret: {
kmsKeyId: 'string'
secretArn: 'string'
}
monitoringInterval: int
monitoringRoleArn: 'string'
networkType: 'string'
performanceInsightsEnabled: bool
performanceInsightsKmsKeyId: 'string'
performanceInsightsRetentionPeriod: int
port: int
preferredBackupWindow: 'string'
preferredMaintenanceWindow: 'string'
publiclyAccessible: bool
readEndpoint: {
address: 'string'
}
replicationSourceIdentifier: 'string'
restoreToTime: 'string'
restoreType: 'string'
scalingConfiguration: {
autoPause: bool
maxCapacity: int
minCapacity: int
secondsBeforeTimeout: int
secondsUntilAutoPause: int
timeoutAction: 'string'
}
serverlessV2ScalingConfiguration: {
maxCapacity: int
minCapacity: int
}
snapshotIdentifier: 'string'
sourceDBClusterIdentifier: 'string'
sourceRegion: 'string'
storageEncrypted: bool
storageThroughput: int
storageType: 'string'
tags: [
{
key: 'string'
value: 'string'
}
]
useLatestRestorableTime: bool
vpcSecurityGroupIds: [
'string'
]
}
awsRegion: 'string'
awsSourceSchema: 'string'
awsTags: {
{customized property}: 'string'
}
publicCloudConnectorsResourceId: 'string'
publicCloudResourceName: 'string'
}
tags: {
{customized property}: 'string'
}
}
属性值
Microsoft.AwsConnector/rdsDBClusters
名字 | 描述 | 价值 |
---|---|---|
位置 | 资源所在的地理位置 | string (必需) |
名字 | 资源名称 | 字符串 约束: 模式 = ^(?=.{0,259}[^\s.]$)(?!.*[<>%&\?/#]) (必需) |
性能 | 此资源的资源特定属性。 | RdsDBClusterProperties |
标签 | 资源标记 | 标记名称和值的字典。 请参阅模板 中的 |
AwsRdsDBClusterProperties
名字 | 描述 | 价值 |
---|---|---|
allocatedStorage | 要分配给多 AZ DB 群集中每个 DB 实例的存储量(GiB)。 | 整数 (int) |
associatedRoles | 提供与数据库群集关联的 AWS 标识和访问管理(IAM)角色的列表。 与 DB 群集关联的 IAM 角色授予数据库群集代表你访问其他 AWS 服务的权限。 | DBClusterRole[] |
autoMinorVersionUpgrade | 一个值,该值指示在维护时段内是否自动将次要引擎升级应用于数据库群集。 默认情况下,会自动应用次要引擎升级。 | 布尔 |
可用性区域 | 可在其中创建 DB 群集中的实例的可用性区域(AZ)列表。 有关 AWS 区域和可用性区域的信息,请参阅 Amazon Aurora 用户指南中的“选择区域和可用性区域”。 | 字符串[] |
backtrackWindow | 目标回溯窗口,以秒为单位。 若要禁用回溯,请将此值设置为 0。 | 整数 (int) |
backupRetentionPeriod (备份保留期) | 自动备份保留的天数。 | 整数 (int) |
copyTagsToSnapshot | 一个值,该值指示是否将所有标记从数据库群集复制到 DB 群集的快照。 默认值不是复制它们。 | 布尔 |
数据库名称 | 数据库的名称。 如果未提供名称,则 Amazon RDS 不会在此 DB 群集中创建数据库。 有关命名约束,请参阅 Amazon RDS 用户指南中的命名约束。 | 字符串 |
dbClusterArn 数据库 | DB 群集的 Amazon 资源名称(ARN)。 | 字符串 |
dbClusterIdentifier 数据库集群标识符 | DB 群集标识符。 此参数存储为小写字符串。 | 字符串 |
dbClusterInstance类 | 多 AZ DB 群集中每个 DB 实例的计算和内存容量,例如 db.m6g.xlarge。 | 字符串 |
dbClusterParameterGroupName 数据库集群参数组名称 | 要与此 DB 群集关联的 DB 群集参数组的名称。 | 字符串 |
dbClusterResourceId 数据库集群资源 Id | DB 群集的 AWS 区域唯一不可变标识符。 | 字符串 |
dbInstanceParameterGroupName 数据库实例参数组名称 | 要应用于数据库群集的所有实例的 DB 参数组的名称。 | 字符串 |
dbSubnetGroupName | 要与此 DB 群集关联的 DB 子网组。 | 字符串 |
dbSystemId 数据库系统 ID | 保留以供将来使用。 | 字符串 |
deletion保护 | 一个值,该值指示数据库群集是否已启用删除保护。 启用删除保护时,无法删除数据库。 默认情况下,删除保护处于禁用状态。 | 布尔 |
域 | 要在其中创建 DB 群集的 Active Directory 目录 ID。 | 字符串 |
domainIAMRoleName 域名 | 指定在对目录服务进行 API 调用时要使用的 IAM 角色的名称。 | 字符串 |
启用CloudwatchLogsExports | 需要启用用于导出到 CloudWatch 日志的日志类型的列表。 列表中的值取决于所使用的数据库引擎。 有关详细信息,请参阅 Amazon Aurora 用户指南中的“将数据库日志发布到 Amazon CloudWatch 日志”。 | 字符串[] |
启用GlobalWriteForwarding | 指定是否使此 DB 群集能够将写入操作转发到全局群集的主群集(极光全局数据库)。 默认情况下,不允许在是极光全局数据库中辅助群集的极光 DB 群集上执行写入操作。 | 布尔 |
enableHttpEndpoint | 一个值,该值指示是否为数据库群集启用 HTTP 终结点。 默认情况下,HTTP 终结点处于禁用状态。 | 布尔 |
enableIAMDatabaseAuthentication | 一个值,该值指示是否启用 AWS 标识和访问管理 (IAM) 帐户到数据库帐户的映射。 默认情况下,映射处于禁用状态。 | 布尔 |
端点 | 属性终结点 | 端点自动生成 |
发动机 | 要用于此 DB 群集的数据库引擎的名称。 有效值:极光(适用于 MySQL 5.6 兼容极光)、极光-mysql(适用于 MySQL 5.7 兼容极光)和极光-postgresql | 字符串 |
engineMode | 数据库群集的 DB 引擎模式(预配、无服务器、并行查询、全局或多主数据库)。 | 字符串 |
engineVersion (引擎版本) | 要使用的数据库引擎的版本号。 | 字符串 |
globalClusterIdentifier | 如果要配置极光全局数据库群集,并且希望极光数据库群集成为全局数据库群集中的辅助成员,请指定全局数据库群集的全局群集 ID。 若要定义全局群集的主数据库群集,请使用 AWS::RDS::GlobalCluster 资源。如果未配置全局数据库群集,请不要指定此属性。 | 字符串 |
IOPS (国际速率) | 为多 AZ DB 群集中的每个 DB 实例最初分配的预配 IOPS(每秒输入/输出操作数)。 | 整数 (int) |
kmsKeyId | AWS 密钥管理服务主密钥的 Amazon 资源名称(ARN),用于加密 DB 群集中的数据库实例,例如 arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef。 如果启用 StorageEncrypted 属性但未指定此属性,则使用默认主密钥。 如果指定此属性,则必须将 StorageEncrypted 属性设置为 true。 | 字符串 |
manageMasterUserPassword | 一个值,该值指示是否使用 AWS 机密管理器管理主用户密码。 | 布尔 |
master用户名 | 数据库群集的主用户的名称。 必须指定 MasterUsername,除非指定 SnapshotIdentifier。 在这种情况下,请不要指定 MasterUsername。 | 字符串 |
masterUserPassword (主用户密码) | DB 实例的主密码。 | 字符串 |
masterUserSecret | 包含由 RDS 在 AWS 机密管理器中为主用户密码管理的机密。 | MasterUserSecret (主用户密钥) |
monitoringInterval (监控间隔) | 为数据库群集收集增强型监视指标时,间隔(以秒为单位)。 若要关闭收集增强型监视指标,请指定 0。 默认值为 0。 | 整数 (int) |
monitoringRoleArn | IAM 角色的 Amazon 资源名称(ARN),该角色允许 RDS 将增强型监视指标发送到 Amazon CloudWatch 日志。 | 字符串 |
网络类型 | DB 群集的网络类型。 | 字符串 |
已启用性能洞察 | 一个值,该值指示是否为数据库群集启用 Performance Insights。 | 布尔 |
performanceInsightsKmsKeyId | 用于加密 Performance Insights 数据的 Amazon Web Services KMS 密钥标识符。 | 字符串 |
performanceInsightsRetentionPeriod (性能洞察保留期) | 保留 Performance Insights 数据所需的时间(以天为单位)。 | 整数 (int) |
港口 | DB 群集中的实例接受连接的端口号。 默认值:如果引擎设置为极光,则为 3306;如果设置为极光-postgresql,则为 5432。 | 整数 (int) |
preferredBackupWindow (首选备份窗口) | 如果使用 BackupRetentionPeriod 参数启用自动备份,则创建自动备份的每日时间范围。 默认值是从每个 AWS 区域的 8 小时时间块随机选择的 30 分钟窗口。 若要查看可用的时间块,请参阅 Amazon Aurora 用户指南中的“调整首选数据库群集维护时段”。 | 字符串 |
preferredMaintenanceWindow | 系统维护的每周时间范围(UTC)。 默认值是从每个 AWS 区域的 8 小时时间块随机选择的 30 分钟窗口,发生在一周中的随机一天。 若要查看可用的时间块,请参阅 Amazon Aurora 用户指南中的“调整首选数据库群集维护时段”。 | 字符串 |
可公开访问 | 一个值,该值指示数据库群集是否可公开访问。 | 布尔 |
readEndpoint | 属性 readEndpoint | ReadEndpoint |
replicationSourceIdentifier | 如果将此 DB 群集创建为只读副本,则源 DB 实例或 DB 群集的 Amazon 资源名称(ARN)。 | 字符串 |
restoreToTime (还原到时间) | 将数据库群集还原到的日期和时间。 值必须是世界协调时(UTC)格式的时间。 示例:2015-03-07T23:45:00Z | 字符串 |
restoreType | 要执行的还原类型。 可以指定以下值之一:full-copy - 新 DB 群集将还原为源 DB cluster.copy-on-write 的完整副本 - 新 DB 群集将还原为源 DB 群集的克隆。 | 字符串 |
scalingConfiguration | ScalingConfiguration 属性类型指定极光无服务器 DB 群集的缩放配置。 ScalingConfiguration 属性类型指定极光无服务器 DB 群集的缩放配置。 | ScalingConfiguration |
serverlessV2Scaling配置 | 包含极光无服务器 v2 DB 群集的缩放配置。 包含极光无服务器 v2 DB 群集的缩放配置。 | ServerlessV2Scaling配置 |
快照标识符 | 要从中还原的 DB 快照或数据库群集快照的标识符。可以使用名称或 Amazon 资源名称(ARN)来指定数据库群集快照。 但是,只能使用 ARN 来指定数据库快照。使用 SnapshotIdentifier 属性还原数据库群集后,必须为将来对数据库群集进行任何更新指定相同的 SnapshotIdentifier 属性。 为更新指定此属性时,不会再次从快照还原 DB 群集,并且数据库中的数据不会更改。 但是,如果未指定 SnapshotIdentifier 属性,则会创建一个空 DB 群集,并删除原始 DB 群集。 如果指定的属性与以前的快照还原属性不同,则会从指定的 SnapshotIdentifier 属性还原 DB 群集,并删除原始 DB 群集。 | 字符串 |
sourceDBClusterIdentifier | 要从中还原的源 DB 群集的标识符。 | 字符串 |
源区域 | 复制数据库群集时包含源 DB 群集的 AWS 区域。 例如,us-east-1。 | 字符串 |
存储加密 | 指示 DB 实例是否已加密。如果指定 DBClusterIdentifier、SnapshotIdentifier 或 SourceDBInstanceIdentifier 属性,请不要指定此属性。 该值继承自群集、快照或源 DB 实例。 | 布尔 |
storage吞吐量 | 指定 DB 群集的存储吞吐量值。 此设置仅适用于 gp3 存储类型。 | 整数 (int) |
存储类型 | 指定要与数据库群集关联的存储类型。 | 字符串 |
标签 | 要应用于此资源的键值对数组。 | 标签自动生成45 |
使用LatestRestorableTime | 一个值,该值指示是否将数据库群集还原到最新的可还原备份时间。 默认情况下,数据库群集不会还原到最新的可还原备份时间。 | 布尔 |
vpSecurityGroupIds | 要与此 DB 群集关联的 EC2VP 安全组列表。 | 字符串[] |
DBClusterRole
名字 | 描述 | 价值 |
---|---|---|
功能名称 | 与 AWS 标识和访问管理(IAM)角色关联的功能的名称。 有关受支持的功能名称列表,请参阅 Amazon RDS API 参考中的 DBEngineVersion。 | 字符串 |
roleArn | 与 DB 群集关联的 IAM 角色的 Amazon 资源名称(ARN)。 | 字符串 |
端点自动生成
名字 | 描述 | 价值 |
---|---|---|
地址 | DB 群集的连接终结点。 | 字符串 |
港口 | 将接受此 DB 群集上的连接的端口号。 | 字符串 |
MasterUserSecret (主用户密钥)
名字 | 描述 | 价值 |
---|---|---|
kmsKeyId | 用于加密机密的 AWS KMS 密钥标识符。 | 字符串 |
secretArn | 机密的 Amazon 资源名称(ARN)。 | 字符串 |
RdsDBClusterProperties
名字 | 描述 | 价值 |
---|---|---|
阿恩 | Amazon 资源名称 (ARN) | 字符串 |
awsAccountId | AWS 帐户 ID | 字符串 |
awsProperties | AWS 属性 | AwsRdsDBClusterProperties |
awsRegion | AWS 区域 | 字符串 |
awsSourceSchema | AWS 源架构 | 字符串 |
aws标签 | AWS 标记 | RdsDBClusterPropertiesAwsTags |
publicCloudConnectorsResourceId | 公有云连接器资源 ID | 字符串 |
publicCloudResourceName (公共云资源名称) | 公有云资源名称 | 字符串 |
RdsDBClusterPropertiesAwsTags
名字 | 描述 | 价值 |
---|
ReadEndpoint
名字 | 描述 | 价值 |
---|---|---|
地址 | DB 群集的读取器终结点。 | 字符串 |
ScalingConfiguration
名字 | 描述 | 价值 |
---|---|---|
自动暂停 | 一个值,该值指示是否允许或禁止在无服务器数据库引擎模式下为极光数据库群集自动暂停。 仅当数据库群集处于空闲状态(没有连接)时,才能暂停该群集。 | 布尔 |
最大容量 | 无服务器数据库引擎模式下极光 DB 群集的最大容量。对于 Aurora MySQL,有效容量值为 1、2、4、8、16、32、64、128 和 256。对于 Aurora PostgreSQL,有效容量值为 2、4、8、16、32、64、192 和 384。最大容量必须大于或等于最小容量。 | 整数 (int) |
最小容量 | 无服务器数据库引擎模式下极光 DB 群集的最小容量。对于 Aurora MySQL,有效容量值为 1、2、4、8、16、32、64、128 和 256。对于 Aurora PostgreSQL,有效容量值为 2、4、8、16、32、64、192 和 384。最小容量必须小于或等于最大容量。 | 整数 (int) |
secondsBeforeTimeout | 极光无服务器 v1 在强制实施超时操作之前,尝试查找缩放点以执行无缝缩放的时间(以秒为单位)。默认值为 300。 | 整数 (int) |
secondsUntilAutoPause | 处于无服务器模式的极光数据库群集暂停前的时间(以秒为单位)。 | 整数 (int) |
timeoutAction | 达到超时时要执行的操作,ForceApplyCapacityChange 或 RollbackCapacityChange.ForceApplyCapacityChange 将容量设置为指定值尽快。如果超时期间找不到缩放点,则默认值 RollbackCapacityChange 将忽略容量更改。有关详细信息,请参阅 Amazon Aurora 用户指南中的“无极光服务器 v1 自动缩放”。 | 字符串 |
ServerlessV2Scaling配置
名字 | 描述 | 价值 |
---|---|---|
最大容量 | 无服务器 v2 群集中 DB 实例的最大极光容量单位数(ATU)。 可以按半步增量指定 ACU 值,例如 40、40.5、41 等。 可以使用的最大值为 128。 | 整数 (int) |
最小容量 | 无服务器 v2 群集中 DB 实例的极光容量单位(ATU)的最小数量。 可以按半步增量指定 ACU 值,例如 8、8.5、9 等。 可以使用的最小值为 0.5。 | 整数 (int) |
标签自动生成45
名字 | 描述 | 价值 |
---|---|---|
钥匙 | 标记的键名称。 可以指定长度为 1 到 128 个 Unicode 字符的值,不能以 aws: 作为前缀。 可以使用以下任意字符:Unicode 字母、数字、空格、_、.、/、=、+和 -。 | 字符串 |
价值 | 标记的值。 可以指定长度为 0 到 256 个 Unicode 字符的值,不能以 aws: 作为前缀。 可以使用以下任意字符:Unicode 字母、数字、空格、_、.、/、=、+和 -。 | 字符串 |
TrackedResourceTags
名字 | 描述 | 价值 |
---|
ARM 模板资源定义
可以使用目标操作部署 rdsDBClusters 资源类型:
- 资源组 - 请参阅 资源组部署命令
有关每个 API 版本中已更改属性的列表,请参阅 更改日志。
资源格式
若要创建 Microsoft.AwsConnector/rdsDBClusters 资源,请将以下 JSON 添加到模板。
{
"type": "Microsoft.AwsConnector/rdsDBClusters",
"apiVersion": "2024-12-01",
"name": "string",
"location": "string",
"properties": {
"arn": "string",
"awsAccountId": "string",
"awsProperties": {
"allocatedStorage": "int",
"associatedRoles": [
{
"featureName": "string",
"roleArn": "string"
}
],
"autoMinorVersionUpgrade": "bool",
"availabilityZones": [ "string" ],
"backtrackWindow": "int",
"backupRetentionPeriod": "int",
"copyTagsToSnapshot": "bool",
"databaseName": "string",
"dbClusterArn": "string",
"dbClusterIdentifier": "string",
"dbClusterInstanceClass": "string",
"dbClusterParameterGroupName": "string",
"dbClusterResourceId": "string",
"dbInstanceParameterGroupName": "string",
"dbSubnetGroupName": "string",
"dbSystemId": "string",
"deletionProtection": "bool",
"domain": "string",
"domainIAMRoleName": "string",
"enableCloudwatchLogsExports": [ "string" ],
"enableGlobalWriteForwarding": "bool",
"enableHttpEndpoint": "bool",
"enableIAMDatabaseAuthentication": "bool",
"endpoint": {
"address": "string",
"port": "string"
},
"engine": "string",
"engineMode": "string",
"engineVersion": "string",
"globalClusterIdentifier": "string",
"iops": "int",
"kmsKeyId": "string",
"manageMasterUserPassword": "bool",
"masterUsername": "string",
"masterUserPassword": "string",
"masterUserSecret": {
"kmsKeyId": "string",
"secretArn": "string"
},
"monitoringInterval": "int",
"monitoringRoleArn": "string",
"networkType": "string",
"performanceInsightsEnabled": "bool",
"performanceInsightsKmsKeyId": "string",
"performanceInsightsRetentionPeriod": "int",
"port": "int",
"preferredBackupWindow": "string",
"preferredMaintenanceWindow": "string",
"publiclyAccessible": "bool",
"readEndpoint": {
"address": "string"
},
"replicationSourceIdentifier": "string",
"restoreToTime": "string",
"restoreType": "string",
"scalingConfiguration": {
"autoPause": "bool",
"maxCapacity": "int",
"minCapacity": "int",
"secondsBeforeTimeout": "int",
"secondsUntilAutoPause": "int",
"timeoutAction": "string"
},
"serverlessV2ScalingConfiguration": {
"maxCapacity": "int",
"minCapacity": "int"
},
"snapshotIdentifier": "string",
"sourceDBClusterIdentifier": "string",
"sourceRegion": "string",
"storageEncrypted": "bool",
"storageThroughput": "int",
"storageType": "string",
"tags": [
{
"key": "string",
"value": "string"
}
],
"useLatestRestorableTime": "bool",
"vpcSecurityGroupIds": [ "string" ]
},
"awsRegion": "string",
"awsSourceSchema": "string",
"awsTags": {
"{customized property}": "string"
},
"publicCloudConnectorsResourceId": "string",
"publicCloudResourceName": "string"
},
"tags": {
"{customized property}": "string"
}
}
属性值
Microsoft.AwsConnector/rdsDBClusters
名字 | 描述 | 价值 |
---|---|---|
apiVersion | API 版本 | '2024-12-01' |
位置 | 资源所在的地理位置 | string (必需) |
名字 | 资源名称 | 字符串 约束: 模式 = ^(?=.{0,259}[^\s.]$)(?!.*[<>%&\?/#]) (必需) |
性能 | 此资源的资源特定属性。 | RdsDBClusterProperties |
标签 | 资源标记 | 标记名称和值的字典。 请参阅模板 中的 |
类型 | 资源类型 | “Microsoft.AwsConnector/rdsDBClusters” |
AwsRdsDBClusterProperties
名字 | 描述 | 价值 |
---|---|---|
allocatedStorage | 要分配给多 AZ DB 群集中每个 DB 实例的存储量(GiB)。 | 整数 (int) |
associatedRoles | 提供与数据库群集关联的 AWS 标识和访问管理(IAM)角色的列表。 与 DB 群集关联的 IAM 角色授予数据库群集代表你访问其他 AWS 服务的权限。 | DBClusterRole[] |
autoMinorVersionUpgrade | 一个值,该值指示在维护时段内是否自动将次要引擎升级应用于数据库群集。 默认情况下,会自动应用次要引擎升级。 | 布尔 |
可用性区域 | 可在其中创建 DB 群集中的实例的可用性区域(AZ)列表。 有关 AWS 区域和可用性区域的信息,请参阅 Amazon Aurora 用户指南中的“选择区域和可用性区域”。 | 字符串[] |
backtrackWindow | 目标回溯窗口,以秒为单位。 若要禁用回溯,请将此值设置为 0。 | 整数 (int) |
backupRetentionPeriod (备份保留期) | 自动备份保留的天数。 | 整数 (int) |
copyTagsToSnapshot | 一个值,该值指示是否将所有标记从数据库群集复制到 DB 群集的快照。 默认值不是复制它们。 | 布尔 |
数据库名称 | 数据库的名称。 如果未提供名称,则 Amazon RDS 不会在此 DB 群集中创建数据库。 有关命名约束,请参阅 Amazon RDS 用户指南中的命名约束。 | 字符串 |
dbClusterArn 数据库 | DB 群集的 Amazon 资源名称(ARN)。 | 字符串 |
dbClusterIdentifier 数据库集群标识符 | DB 群集标识符。 此参数存储为小写字符串。 | 字符串 |
dbClusterInstance类 | 多 AZ DB 群集中每个 DB 实例的计算和内存容量,例如 db.m6g.xlarge。 | 字符串 |
dbClusterParameterGroupName 数据库集群参数组名称 | 要与此 DB 群集关联的 DB 群集参数组的名称。 | 字符串 |
dbClusterResourceId 数据库集群资源 Id | DB 群集的 AWS 区域唯一不可变标识符。 | 字符串 |
dbInstanceParameterGroupName 数据库实例参数组名称 | 要应用于数据库群集的所有实例的 DB 参数组的名称。 | 字符串 |
dbSubnetGroupName | 要与此 DB 群集关联的 DB 子网组。 | 字符串 |
dbSystemId 数据库系统 ID | 保留以供将来使用。 | 字符串 |
deletion保护 | 一个值,该值指示数据库群集是否已启用删除保护。 启用删除保护时,无法删除数据库。 默认情况下,删除保护处于禁用状态。 | 布尔 |
域 | 要在其中创建 DB 群集的 Active Directory 目录 ID。 | 字符串 |
domainIAMRoleName 域名 | 指定在对目录服务进行 API 调用时要使用的 IAM 角色的名称。 | 字符串 |
启用CloudwatchLogsExports | 需要启用用于导出到 CloudWatch 日志的日志类型的列表。 列表中的值取决于所使用的数据库引擎。 有关详细信息,请参阅 Amazon Aurora 用户指南中的“将数据库日志发布到 Amazon CloudWatch 日志”。 | 字符串[] |
启用GlobalWriteForwarding | 指定是否使此 DB 群集能够将写入操作转发到全局群集的主群集(极光全局数据库)。 默认情况下,不允许在是极光全局数据库中辅助群集的极光 DB 群集上执行写入操作。 | 布尔 |
enableHttpEndpoint | 一个值,该值指示是否为数据库群集启用 HTTP 终结点。 默认情况下,HTTP 终结点处于禁用状态。 | 布尔 |
enableIAMDatabaseAuthentication | 一个值,该值指示是否启用 AWS 标识和访问管理 (IAM) 帐户到数据库帐户的映射。 默认情况下,映射处于禁用状态。 | 布尔 |
端点 | 属性终结点 | 端点自动生成 |
发动机 | 要用于此 DB 群集的数据库引擎的名称。 有效值:极光(适用于 MySQL 5.6 兼容极光)、极光-mysql(适用于 MySQL 5.7 兼容极光)和极光-postgresql | 字符串 |
engineMode | 数据库群集的 DB 引擎模式(预配、无服务器、并行查询、全局或多主数据库)。 | 字符串 |
engineVersion (引擎版本) | 要使用的数据库引擎的版本号。 | 字符串 |
globalClusterIdentifier | 如果要配置极光全局数据库群集,并且希望极光数据库群集成为全局数据库群集中的辅助成员,请指定全局数据库群集的全局群集 ID。 若要定义全局群集的主数据库群集,请使用 AWS::RDS::GlobalCluster 资源。如果未配置全局数据库群集,请不要指定此属性。 | 字符串 |
IOPS (国际速率) | 为多 AZ DB 群集中的每个 DB 实例最初分配的预配 IOPS(每秒输入/输出操作数)。 | 整数 (int) |
kmsKeyId | AWS 密钥管理服务主密钥的 Amazon 资源名称(ARN),用于加密 DB 群集中的数据库实例,例如 arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef。 如果启用 StorageEncrypted 属性但未指定此属性,则使用默认主密钥。 如果指定此属性,则必须将 StorageEncrypted 属性设置为 true。 | 字符串 |
manageMasterUserPassword | 一个值,该值指示是否使用 AWS 机密管理器管理主用户密码。 | 布尔 |
master用户名 | 数据库群集的主用户的名称。 必须指定 MasterUsername,除非指定 SnapshotIdentifier。 在这种情况下,请不要指定 MasterUsername。 | 字符串 |
masterUserPassword (主用户密码) | DB 实例的主密码。 | 字符串 |
masterUserSecret | 包含由 RDS 在 AWS 机密管理器中为主用户密码管理的机密。 | MasterUserSecret (主用户密钥) |
monitoringInterval (监控间隔) | 为数据库群集收集增强型监视指标时,间隔(以秒为单位)。 若要关闭收集增强型监视指标,请指定 0。 默认值为 0。 | 整数 (int) |
monitoringRoleArn | IAM 角色的 Amazon 资源名称(ARN),该角色允许 RDS 将增强型监视指标发送到 Amazon CloudWatch 日志。 | 字符串 |
网络类型 | DB 群集的网络类型。 | 字符串 |
已启用性能洞察 | 一个值,该值指示是否为数据库群集启用 Performance Insights。 | 布尔 |
performanceInsightsKmsKeyId | 用于加密 Performance Insights 数据的 Amazon Web Services KMS 密钥标识符。 | 字符串 |
performanceInsightsRetentionPeriod (性能洞察保留期) | 保留 Performance Insights 数据所需的时间(以天为单位)。 | 整数 (int) |
港口 | DB 群集中的实例接受连接的端口号。 默认值:如果引擎设置为极光,则为 3306;如果设置为极光-postgresql,则为 5432。 | 整数 (int) |
preferredBackupWindow (首选备份窗口) | 如果使用 BackupRetentionPeriod 参数启用自动备份,则创建自动备份的每日时间范围。 默认值是从每个 AWS 区域的 8 小时时间块随机选择的 30 分钟窗口。 若要查看可用的时间块,请参阅 Amazon Aurora 用户指南中的“调整首选数据库群集维护时段”。 | 字符串 |
preferredMaintenanceWindow | 系统维护的每周时间范围(UTC)。 默认值是从每个 AWS 区域的 8 小时时间块随机选择的 30 分钟窗口,发生在一周中的随机一天。 若要查看可用的时间块,请参阅 Amazon Aurora 用户指南中的“调整首选数据库群集维护时段”。 | 字符串 |
可公开访问 | 一个值,该值指示数据库群集是否可公开访问。 | 布尔 |
readEndpoint | 属性 readEndpoint | ReadEndpoint |
replicationSourceIdentifier | 如果将此 DB 群集创建为只读副本,则源 DB 实例或 DB 群集的 Amazon 资源名称(ARN)。 | 字符串 |
restoreToTime (还原到时间) | 将数据库群集还原到的日期和时间。 值必须是世界协调时(UTC)格式的时间。 示例:2015-03-07T23:45:00Z | 字符串 |
restoreType | 要执行的还原类型。 可以指定以下值之一:full-copy - 新 DB 群集将还原为源 DB cluster.copy-on-write 的完整副本 - 新 DB 群集将还原为源 DB 群集的克隆。 | 字符串 |
scalingConfiguration | ScalingConfiguration 属性类型指定极光无服务器 DB 群集的缩放配置。 ScalingConfiguration 属性类型指定极光无服务器 DB 群集的缩放配置。 | ScalingConfiguration |
serverlessV2Scaling配置 | 包含极光无服务器 v2 DB 群集的缩放配置。 包含极光无服务器 v2 DB 群集的缩放配置。 | ServerlessV2Scaling配置 |
快照标识符 | 要从中还原的 DB 快照或数据库群集快照的标识符。可以使用名称或 Amazon 资源名称(ARN)来指定数据库群集快照。 但是,只能使用 ARN 来指定数据库快照。使用 SnapshotIdentifier 属性还原数据库群集后,必须为将来对数据库群集进行任何更新指定相同的 SnapshotIdentifier 属性。 为更新指定此属性时,不会再次从快照还原 DB 群集,并且数据库中的数据不会更改。 但是,如果未指定 SnapshotIdentifier 属性,则会创建一个空 DB 群集,并删除原始 DB 群集。 如果指定的属性与以前的快照还原属性不同,则会从指定的 SnapshotIdentifier 属性还原 DB 群集,并删除原始 DB 群集。 | 字符串 |
sourceDBClusterIdentifier | 要从中还原的源 DB 群集的标识符。 | 字符串 |
源区域 | 复制数据库群集时包含源 DB 群集的 AWS 区域。 例如,us-east-1。 | 字符串 |
存储加密 | 指示 DB 实例是否已加密。如果指定 DBClusterIdentifier、SnapshotIdentifier 或 SourceDBInstanceIdentifier 属性,请不要指定此属性。 该值继承自群集、快照或源 DB 实例。 | 布尔 |
storage吞吐量 | 指定 DB 群集的存储吞吐量值。 此设置仅适用于 gp3 存储类型。 | 整数 (int) |
存储类型 | 指定要与数据库群集关联的存储类型。 | 字符串 |
标签 | 要应用于此资源的键值对数组。 | 标签自动生成45 |
使用LatestRestorableTime | 一个值,该值指示是否将数据库群集还原到最新的可还原备份时间。 默认情况下,数据库群集不会还原到最新的可还原备份时间。 | 布尔 |
vpSecurityGroupIds | 要与此 DB 群集关联的 EC2VP 安全组列表。 | 字符串[] |
DBClusterRole
名字 | 描述 | 价值 |
---|---|---|
功能名称 | 与 AWS 标识和访问管理(IAM)角色关联的功能的名称。 有关受支持的功能名称列表,请参阅 Amazon RDS API 参考中的 DBEngineVersion。 | 字符串 |
roleArn | 与 DB 群集关联的 IAM 角色的 Amazon 资源名称(ARN)。 | 字符串 |
端点自动生成
名字 | 描述 | 价值 |
---|---|---|
地址 | DB 群集的连接终结点。 | 字符串 |
港口 | 将接受此 DB 群集上的连接的端口号。 | 字符串 |
MasterUserSecret (主用户密钥)
名字 | 描述 | 价值 |
---|---|---|
kmsKeyId | 用于加密机密的 AWS KMS 密钥标识符。 | 字符串 |
secretArn | 机密的 Amazon 资源名称(ARN)。 | 字符串 |
RdsDBClusterProperties
名字 | 描述 | 价值 |
---|---|---|
阿恩 | Amazon 资源名称 (ARN) | 字符串 |
awsAccountId | AWS 帐户 ID | 字符串 |
awsProperties | AWS 属性 | AwsRdsDBClusterProperties |
awsRegion | AWS 区域 | 字符串 |
awsSourceSchema | AWS 源架构 | 字符串 |
aws标签 | AWS 标记 | RdsDBClusterPropertiesAwsTags |
publicCloudConnectorsResourceId | 公有云连接器资源 ID | 字符串 |
publicCloudResourceName (公共云资源名称) | 公有云资源名称 | 字符串 |
RdsDBClusterPropertiesAwsTags
名字 | 描述 | 价值 |
---|
ReadEndpoint
名字 | 描述 | 价值 |
---|---|---|
地址 | DB 群集的读取器终结点。 | 字符串 |
ScalingConfiguration
名字 | 描述 | 价值 |
---|---|---|
自动暂停 | 一个值,该值指示是否允许或禁止在无服务器数据库引擎模式下为极光数据库群集自动暂停。 仅当数据库群集处于空闲状态(没有连接)时,才能暂停该群集。 | 布尔 |
最大容量 | 无服务器数据库引擎模式下极光 DB 群集的最大容量。对于 Aurora MySQL,有效容量值为 1、2、4、8、16、32、64、128 和 256。对于 Aurora PostgreSQL,有效容量值为 2、4、8、16、32、64、192 和 384。最大容量必须大于或等于最小容量。 | 整数 (int) |
最小容量 | 无服务器数据库引擎模式下极光 DB 群集的最小容量。对于 Aurora MySQL,有效容量值为 1、2、4、8、16、32、64、128 和 256。对于 Aurora PostgreSQL,有效容量值为 2、4、8、16、32、64、192 和 384。最小容量必须小于或等于最大容量。 | 整数 (int) |
secondsBeforeTimeout | 极光无服务器 v1 在强制实施超时操作之前,尝试查找缩放点以执行无缝缩放的时间(以秒为单位)。默认值为 300。 | 整数 (int) |
secondsUntilAutoPause | 处于无服务器模式的极光数据库群集暂停前的时间(以秒为单位)。 | 整数 (int) |
timeoutAction | 达到超时时要执行的操作,ForceApplyCapacityChange 或 RollbackCapacityChange.ForceApplyCapacityChange 将容量设置为指定值尽快。如果超时期间找不到缩放点,则默认值 RollbackCapacityChange 将忽略容量更改。有关详细信息,请参阅 Amazon Aurora 用户指南中的“无极光服务器 v1 自动缩放”。 | 字符串 |
ServerlessV2Scaling配置
名字 | 描述 | 价值 |
---|---|---|
最大容量 | 无服务器 v2 群集中 DB 实例的最大极光容量单位数(ATU)。 可以按半步增量指定 ACU 值,例如 40、40.5、41 等。 可以使用的最大值为 128。 | 整数 (int) |
最小容量 | 无服务器 v2 群集中 DB 实例的极光容量单位(ATU)的最小数量。 可以按半步增量指定 ACU 值,例如 8、8.5、9 等。 可以使用的最小值为 0.5。 | 整数 (int) |
标签自动生成45
名字 | 描述 | 价值 |
---|---|---|
钥匙 | 标记的键名称。 可以指定长度为 1 到 128 个 Unicode 字符的值,不能以 aws: 作为前缀。 可以使用以下任意字符:Unicode 字母、数字、空格、_、.、/、=、+和 -。 | 字符串 |
价值 | 标记的值。 可以指定长度为 0 到 256 个 Unicode 字符的值,不能以 aws: 作为前缀。 可以使用以下任意字符:Unicode 字母、数字、空格、_、.、/、=、+和 -。 | 字符串 |
TrackedResourceTags
名字 | 描述 | 价值 |
---|
用法示例
Terraform (AzAPI 提供程序)资源定义
可以使用目标操作部署 rdsDBClusters 资源类型:
- 资源组
有关每个 API 版本中已更改属性的列表,请参阅 更改日志。
资源格式
若要创建 Microsoft.AwsConnector/rdsDBClusters 资源,请将以下 Terraform 添加到模板。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.AwsConnector/rdsDBClusters@2024-12-01"
name = "string"
parent_id = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = {
properties = {
arn = "string"
awsAccountId = "string"
awsProperties = {
allocatedStorage = int
associatedRoles = [
{
featureName = "string"
roleArn = "string"
}
]
autoMinorVersionUpgrade = bool
availabilityZones = [
"string"
]
backtrackWindow = int
backupRetentionPeriod = int
copyTagsToSnapshot = bool
databaseName = "string"
dbClusterArn = "string"
dbClusterIdentifier = "string"
dbClusterInstanceClass = "string"
dbClusterParameterGroupName = "string"
dbClusterResourceId = "string"
dbInstanceParameterGroupName = "string"
dbSubnetGroupName = "string"
dbSystemId = "string"
deletionProtection = bool
domain = "string"
domainIAMRoleName = "string"
enableCloudwatchLogsExports = [
"string"
]
enableGlobalWriteForwarding = bool
enableHttpEndpoint = bool
enableIAMDatabaseAuthentication = bool
endpoint = {
address = "string"
port = "string"
}
engine = "string"
engineMode = "string"
engineVersion = "string"
globalClusterIdentifier = "string"
iops = int
kmsKeyId = "string"
manageMasterUserPassword = bool
masterUsername = "string"
masterUserPassword = "string"
masterUserSecret = {
kmsKeyId = "string"
secretArn = "string"
}
monitoringInterval = int
monitoringRoleArn = "string"
networkType = "string"
performanceInsightsEnabled = bool
performanceInsightsKmsKeyId = "string"
performanceInsightsRetentionPeriod = int
port = int
preferredBackupWindow = "string"
preferredMaintenanceWindow = "string"
publiclyAccessible = bool
readEndpoint = {
address = "string"
}
replicationSourceIdentifier = "string"
restoreToTime = "string"
restoreType = "string"
scalingConfiguration = {
autoPause = bool
maxCapacity = int
minCapacity = int
secondsBeforeTimeout = int
secondsUntilAutoPause = int
timeoutAction = "string"
}
serverlessV2ScalingConfiguration = {
maxCapacity = int
minCapacity = int
}
snapshotIdentifier = "string"
sourceDBClusterIdentifier = "string"
sourceRegion = "string"
storageEncrypted = bool
storageThroughput = int
storageType = "string"
tags = [
{
key = "string"
value = "string"
}
]
useLatestRestorableTime = bool
vpcSecurityGroupIds = [
"string"
]
}
awsRegion = "string"
awsSourceSchema = "string"
awsTags = {
{customized property} = "string"
}
publicCloudConnectorsResourceId = "string"
publicCloudResourceName = "string"
}
}
}
属性值
Microsoft.AwsConnector/rdsDBClusters
名字 | 描述 | 价值 |
---|---|---|
位置 | 资源所在的地理位置 | string (必需) |
名字 | 资源名称 | 字符串 约束: 模式 = ^(?=.{0,259}[^\s.]$)(?!.*[<>%&\?/#]) (必需) |
性能 | 此资源的资源特定属性。 | RdsDBClusterProperties |
标签 | 资源标记 | 标记名称和值的字典。 |
类型 | 资源类型 | “Microsoft.AwsConnector/rdsDBClusters@2024-12-01” |
AwsRdsDBClusterProperties
名字 | 描述 | 价值 |
---|---|---|
allocatedStorage | 要分配给多 AZ DB 群集中每个 DB 实例的存储量(GiB)。 | 整数 (int) |
associatedRoles | 提供与数据库群集关联的 AWS 标识和访问管理(IAM)角色的列表。 与 DB 群集关联的 IAM 角色授予数据库群集代表你访问其他 AWS 服务的权限。 | DBClusterRole[] |
autoMinorVersionUpgrade | 一个值,该值指示在维护时段内是否自动将次要引擎升级应用于数据库群集。 默认情况下,会自动应用次要引擎升级。 | 布尔 |
可用性区域 | 可在其中创建 DB 群集中的实例的可用性区域(AZ)列表。 有关 AWS 区域和可用性区域的信息,请参阅 Amazon Aurora 用户指南中的“选择区域和可用性区域”。 | 字符串[] |
backtrackWindow | 目标回溯窗口,以秒为单位。 若要禁用回溯,请将此值设置为 0。 | 整数 (int) |
backupRetentionPeriod (备份保留期) | 自动备份保留的天数。 | 整数 (int) |
copyTagsToSnapshot | 一个值,该值指示是否将所有标记从数据库群集复制到 DB 群集的快照。 默认值不是复制它们。 | 布尔 |
数据库名称 | 数据库的名称。 如果未提供名称,则 Amazon RDS 不会在此 DB 群集中创建数据库。 有关命名约束,请参阅 Amazon RDS 用户指南中的命名约束。 | 字符串 |
dbClusterArn 数据库 | DB 群集的 Amazon 资源名称(ARN)。 | 字符串 |
dbClusterIdentifier 数据库集群标识符 | DB 群集标识符。 此参数存储为小写字符串。 | 字符串 |
dbClusterInstance类 | 多 AZ DB 群集中每个 DB 实例的计算和内存容量,例如 db.m6g.xlarge。 | 字符串 |
dbClusterParameterGroupName 数据库集群参数组名称 | 要与此 DB 群集关联的 DB 群集参数组的名称。 | 字符串 |
dbClusterResourceId 数据库集群资源 Id | DB 群集的 AWS 区域唯一不可变标识符。 | 字符串 |
dbInstanceParameterGroupName 数据库实例参数组名称 | 要应用于数据库群集的所有实例的 DB 参数组的名称。 | 字符串 |
dbSubnetGroupName | 要与此 DB 群集关联的 DB 子网组。 | 字符串 |
dbSystemId 数据库系统 ID | 保留以供将来使用。 | 字符串 |
deletion保护 | 一个值,该值指示数据库群集是否已启用删除保护。 启用删除保护时,无法删除数据库。 默认情况下,删除保护处于禁用状态。 | 布尔 |
域 | 要在其中创建 DB 群集的 Active Directory 目录 ID。 | 字符串 |
domainIAMRoleName 域名 | 指定在对目录服务进行 API 调用时要使用的 IAM 角色的名称。 | 字符串 |
启用CloudwatchLogsExports | 需要启用用于导出到 CloudWatch 日志的日志类型的列表。 列表中的值取决于所使用的数据库引擎。 有关详细信息,请参阅 Amazon Aurora 用户指南中的“将数据库日志发布到 Amazon CloudWatch 日志”。 | 字符串[] |
启用GlobalWriteForwarding | 指定是否使此 DB 群集能够将写入操作转发到全局群集的主群集(极光全局数据库)。 默认情况下,不允许在是极光全局数据库中辅助群集的极光 DB 群集上执行写入操作。 | 布尔 |
enableHttpEndpoint | 一个值,该值指示是否为数据库群集启用 HTTP 终结点。 默认情况下,HTTP 终结点处于禁用状态。 | 布尔 |
enableIAMDatabaseAuthentication | 一个值,该值指示是否启用 AWS 标识和访问管理 (IAM) 帐户到数据库帐户的映射。 默认情况下,映射处于禁用状态。 | 布尔 |
端点 | 属性终结点 | 端点自动生成 |
发动机 | 要用于此 DB 群集的数据库引擎的名称。 有效值:极光(适用于 MySQL 5.6 兼容极光)、极光-mysql(适用于 MySQL 5.7 兼容极光)和极光-postgresql | 字符串 |
engineMode | 数据库群集的 DB 引擎模式(预配、无服务器、并行查询、全局或多主数据库)。 | 字符串 |
engineVersion (引擎版本) | 要使用的数据库引擎的版本号。 | 字符串 |
globalClusterIdentifier | 如果要配置极光全局数据库群集,并且希望极光数据库群集成为全局数据库群集中的辅助成员,请指定全局数据库群集的全局群集 ID。 若要定义全局群集的主数据库群集,请使用 AWS::RDS::GlobalCluster 资源。如果未配置全局数据库群集,请不要指定此属性。 | 字符串 |
IOPS (国际速率) | 为多 AZ DB 群集中的每个 DB 实例最初分配的预配 IOPS(每秒输入/输出操作数)。 | 整数 (int) |
kmsKeyId | AWS 密钥管理服务主密钥的 Amazon 资源名称(ARN),用于加密 DB 群集中的数据库实例,例如 arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef。 如果启用 StorageEncrypted 属性但未指定此属性,则使用默认主密钥。 如果指定此属性,则必须将 StorageEncrypted 属性设置为 true。 | 字符串 |
manageMasterUserPassword | 一个值,该值指示是否使用 AWS 机密管理器管理主用户密码。 | 布尔 |
master用户名 | 数据库群集的主用户的名称。 必须指定 MasterUsername,除非指定 SnapshotIdentifier。 在这种情况下,请不要指定 MasterUsername。 | 字符串 |
masterUserPassword (主用户密码) | DB 实例的主密码。 | 字符串 |
masterUserSecret | 包含由 RDS 在 AWS 机密管理器中为主用户密码管理的机密。 | MasterUserSecret (主用户密钥) |
monitoringInterval (监控间隔) | 为数据库群集收集增强型监视指标时,间隔(以秒为单位)。 若要关闭收集增强型监视指标,请指定 0。 默认值为 0。 | 整数 (int) |
monitoringRoleArn | IAM 角色的 Amazon 资源名称(ARN),该角色允许 RDS 将增强型监视指标发送到 Amazon CloudWatch 日志。 | 字符串 |
网络类型 | DB 群集的网络类型。 | 字符串 |
已启用性能洞察 | 一个值,该值指示是否为数据库群集启用 Performance Insights。 | 布尔 |
performanceInsightsKmsKeyId | 用于加密 Performance Insights 数据的 Amazon Web Services KMS 密钥标识符。 | 字符串 |
performanceInsightsRetentionPeriod (性能洞察保留期) | 保留 Performance Insights 数据所需的时间(以天为单位)。 | 整数 (int) |
港口 | DB 群集中的实例接受连接的端口号。 默认值:如果引擎设置为极光,则为 3306;如果设置为极光-postgresql,则为 5432。 | 整数 (int) |
preferredBackupWindow (首选备份窗口) | 如果使用 BackupRetentionPeriod 参数启用自动备份,则创建自动备份的每日时间范围。 默认值是从每个 AWS 区域的 8 小时时间块随机选择的 30 分钟窗口。 若要查看可用的时间块,请参阅 Amazon Aurora 用户指南中的“调整首选数据库群集维护时段”。 | 字符串 |
preferredMaintenanceWindow | 系统维护的每周时间范围(UTC)。 默认值是从每个 AWS 区域的 8 小时时间块随机选择的 30 分钟窗口,发生在一周中的随机一天。 若要查看可用的时间块,请参阅 Amazon Aurora 用户指南中的“调整首选数据库群集维护时段”。 | 字符串 |
可公开访问 | 一个值,该值指示数据库群集是否可公开访问。 | 布尔 |
readEndpoint | 属性 readEndpoint | ReadEndpoint |
replicationSourceIdentifier | 如果将此 DB 群集创建为只读副本,则源 DB 实例或 DB 群集的 Amazon 资源名称(ARN)。 | 字符串 |
restoreToTime (还原到时间) | 将数据库群集还原到的日期和时间。 值必须是世界协调时(UTC)格式的时间。 示例:2015-03-07T23:45:00Z | 字符串 |
restoreType | 要执行的还原类型。 可以指定以下值之一:full-copy - 新 DB 群集将还原为源 DB cluster.copy-on-write 的完整副本 - 新 DB 群集将还原为源 DB 群集的克隆。 | 字符串 |
scalingConfiguration | ScalingConfiguration 属性类型指定极光无服务器 DB 群集的缩放配置。 ScalingConfiguration 属性类型指定极光无服务器 DB 群集的缩放配置。 | ScalingConfiguration |
serverlessV2Scaling配置 | 包含极光无服务器 v2 DB 群集的缩放配置。 包含极光无服务器 v2 DB 群集的缩放配置。 | ServerlessV2Scaling配置 |
快照标识符 | 要从中还原的 DB 快照或数据库群集快照的标识符。可以使用名称或 Amazon 资源名称(ARN)来指定数据库群集快照。 但是,只能使用 ARN 来指定数据库快照。使用 SnapshotIdentifier 属性还原数据库群集后,必须为将来对数据库群集进行任何更新指定相同的 SnapshotIdentifier 属性。 为更新指定此属性时,不会再次从快照还原 DB 群集,并且数据库中的数据不会更改。 但是,如果未指定 SnapshotIdentifier 属性,则会创建一个空 DB 群集,并删除原始 DB 群集。 如果指定的属性与以前的快照还原属性不同,则会从指定的 SnapshotIdentifier 属性还原 DB 群集,并删除原始 DB 群集。 | 字符串 |
sourceDBClusterIdentifier | 要从中还原的源 DB 群集的标识符。 | 字符串 |
源区域 | 复制数据库群集时包含源 DB 群集的 AWS 区域。 例如,us-east-1。 | 字符串 |
存储加密 | 指示 DB 实例是否已加密。如果指定 DBClusterIdentifier、SnapshotIdentifier 或 SourceDBInstanceIdentifier 属性,请不要指定此属性。 该值继承自群集、快照或源 DB 实例。 | 布尔 |
storage吞吐量 | 指定 DB 群集的存储吞吐量值。 此设置仅适用于 gp3 存储类型。 | 整数 (int) |
存储类型 | 指定要与数据库群集关联的存储类型。 | 字符串 |
标签 | 要应用于此资源的键值对数组。 | 标签自动生成45 |
使用LatestRestorableTime | 一个值,该值指示是否将数据库群集还原到最新的可还原备份时间。 默认情况下,数据库群集不会还原到最新的可还原备份时间。 | 布尔 |
vpSecurityGroupIds | 要与此 DB 群集关联的 EC2VP 安全组列表。 | 字符串[] |
DBClusterRole
名字 | 描述 | 价值 |
---|---|---|
功能名称 | 与 AWS 标识和访问管理(IAM)角色关联的功能的名称。 有关受支持的功能名称列表,请参阅 Amazon RDS API 参考中的 DBEngineVersion。 | 字符串 |
roleArn | 与 DB 群集关联的 IAM 角色的 Amazon 资源名称(ARN)。 | 字符串 |
端点自动生成
名字 | 描述 | 价值 |
---|---|---|
地址 | DB 群集的连接终结点。 | 字符串 |
港口 | 将接受此 DB 群集上的连接的端口号。 | 字符串 |
MasterUserSecret (主用户密钥)
名字 | 描述 | 价值 |
---|---|---|
kmsKeyId | 用于加密机密的 AWS KMS 密钥标识符。 | 字符串 |
secretArn | 机密的 Amazon 资源名称(ARN)。 | 字符串 |
RdsDBClusterProperties
名字 | 描述 | 价值 |
---|---|---|
阿恩 | Amazon 资源名称 (ARN) | 字符串 |
awsAccountId | AWS 帐户 ID | 字符串 |
awsProperties | AWS 属性 | AwsRdsDBClusterProperties |
awsRegion | AWS 区域 | 字符串 |
awsSourceSchema | AWS 源架构 | 字符串 |
aws标签 | AWS 标记 | RdsDBClusterPropertiesAwsTags |
publicCloudConnectorsResourceId | 公有云连接器资源 ID | 字符串 |
publicCloudResourceName (公共云资源名称) | 公有云资源名称 | 字符串 |
RdsDBClusterPropertiesAwsTags
名字 | 描述 | 价值 |
---|
ReadEndpoint
名字 | 描述 | 价值 |
---|---|---|
地址 | DB 群集的读取器终结点。 | 字符串 |
ScalingConfiguration
名字 | 描述 | 价值 |
---|---|---|
自动暂停 | 一个值,该值指示是否允许或禁止在无服务器数据库引擎模式下为极光数据库群集自动暂停。 仅当数据库群集处于空闲状态(没有连接)时,才能暂停该群集。 | 布尔 |
最大容量 | 无服务器数据库引擎模式下极光 DB 群集的最大容量。对于 Aurora MySQL,有效容量值为 1、2、4、8、16、32、64、128 和 256。对于 Aurora PostgreSQL,有效容量值为 2、4、8、16、32、64、192 和 384。最大容量必须大于或等于最小容量。 | 整数 (int) |
最小容量 | 无服务器数据库引擎模式下极光 DB 群集的最小容量。对于 Aurora MySQL,有效容量值为 1、2、4、8、16、32、64、128 和 256。对于 Aurora PostgreSQL,有效容量值为 2、4、8、16、32、64、192 和 384。最小容量必须小于或等于最大容量。 | 整数 (int) |
secondsBeforeTimeout | 极光无服务器 v1 在强制实施超时操作之前,尝试查找缩放点以执行无缝缩放的时间(以秒为单位)。默认值为 300。 | 整数 (int) |
secondsUntilAutoPause | 处于无服务器模式的极光数据库群集暂停前的时间(以秒为单位)。 | 整数 (int) |
timeoutAction | 达到超时时要执行的操作,ForceApplyCapacityChange 或 RollbackCapacityChange.ForceApplyCapacityChange 将容量设置为指定值尽快。如果超时期间找不到缩放点,则默认值 RollbackCapacityChange 将忽略容量更改。有关详细信息,请参阅 Amazon Aurora 用户指南中的“无极光服务器 v1 自动缩放”。 | 字符串 |
ServerlessV2Scaling配置
名字 | 描述 | 价值 |
---|---|---|
最大容量 | 无服务器 v2 群集中 DB 实例的最大极光容量单位数(ATU)。 可以按半步增量指定 ACU 值,例如 40、40.5、41 等。 可以使用的最大值为 128。 | 整数 (int) |
最小容量 | 无服务器 v2 群集中 DB 实例的极光容量单位(ATU)的最小数量。 可以按半步增量指定 ACU 值,例如 8、8.5、9 等。 可以使用的最小值为 0.5。 | 整数 (int) |
标签自动生成45
名字 | 描述 | 价值 |
---|---|---|
钥匙 | 标记的键名称。 可以指定长度为 1 到 128 个 Unicode 字符的值,不能以 aws: 作为前缀。 可以使用以下任意字符:Unicode 字母、数字、空格、_、.、/、=、+和 -。 | 字符串 |
价值 | 标记的值。 可以指定长度为 0 到 256 个 Unicode 字符的值,不能以 aws: 作为前缀。 可以使用以下任意字符:Unicode 字母、数字、空格、_、.、/、=、+和 -。 | 字符串 |
TrackedResourceTags
名字 | 描述 | 价值 |
---|