Neptune 实例 API - Amazon Neptune
AWS 文档中描述的 AWS 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 AWS 服务入门

如果我们为英文版本指南提供翻译,那么如果存在任何冲突,将以英文版本指南为准。在提供翻译时使用机器翻译。

Neptune 实例 API

结构:

操作:

DBInstance(结构)

包含 Amazon Neptune 数据库实例的详细信息。

此数据类型用作DescribeDBInstances(操作)操作中的响应元素。

字段

  • AllocatedStorage – 数字(整数)。

    指定已分配存储的大小,以 GB 为单位。

  • AutoMinorVersionUpgrade – 布尔值。

    指示自动应用次要版本补丁。

  • AvailabilityZone – UTF-8 字符串。

    指定数据库实例所在可用区域的名称。

  • BackupRetentionPeriod – 数字(整数)。

    指定自动数据库快照的保留天数。

  • CACertificateIdentifier – UTF-8 字符串。

    此数据库实例的 CA 证书的标识符。

  • CopyTagsToSnapshot – 布尔值。

    指定是否将标签从数据库实例复制到数据库实例的快照。

  • DBClusterIdentifier – UTF-8 字符串。

    如果数据库实例属于某个数据库集群,则包含数据库实例所属的数据库集群的名称。

  • DBInstanceArn – UTF-8 字符串。

    数据库实例的 Amazon 资源名称 (ARN)。

  • DBInstanceClass – UTF-8 字符串。

    包含数据库实例的计算和内存容量级别名称。

  • DBInstanceIdentifier – UTF-8 字符串。

    包含用户提供的数据库标识符。此标识符是标识数据库实例的唯一密钥。

  • DbInstancePort – 数字(整数)。

    指定数据库实例侦听的端口。如果数据库实例属于某个数据库集群,则此端口可能不同于数据库集群的端口。

  • DBInstanceStatus – UTF-8 字符串。

    指定此数据库的当前状态。

  • DbiResourceId – UTF-8 字符串。

    数据库实例在 AWS 区域中唯一的不可变标识符。只要访问了用户数据库实例的 AWS KMS 密钥,就可在 AWS CloudTrail 日志条目中找到此标识符。

  • DBName – UTF-8 字符串。

    数据库名称。

  • DBParameterGroupsDBParameterGroupStatus DBParameterGroup 对象的数组。

    提供应用到此数据库实例的数据库参数组的列表。

  • DBSecurityGroupsDBSecurityGroupMembership DBSecurityGroup 对象的数组。

    提供仅包含 DBSecurityGroup.NameDBSecurityGroup.Status 子元素的数据库安全组元素的列表。

  • DBSubnetGroupDBSubnetGroup对象。

    指定与数据库实例关联的子网组的信息,包括名称、描述和子网组中的子网。

  • DeletionProtection – 布尔值。

    指示数据库实例是否已启用删除保护。在启用删除保护时,无法删除实例。请参阅删除数据库实例

  • DomainMembershipsDomainMembership DomainMembership 对象的数组。

    不支持

  • EnabledCloudwatchLogsExports – UTF-8 字符串的数组。

    此数据库实例配置为导出到 CloudWatch Logs 的日志类型的列表。

  • Endpoint终端节点对象。

    指定连接终端节点。

  • Engine – UTF-8 字符串。

    提供要用于此数据库实例的数据库引擎的名称。

  • EngineVersion – UTF-8 字符串。

    指示数据库引擎版本。

  • EnhancedMonitoringResourceArn – UTF-8 字符串。

    接收数据库实例的增强监控指标数据的 Amazon CloudWatch Logs 日志流的 Amazon 资源名称 (ARN)。

  • IAMDatabaseAuthenticationEnabled – 布尔值。

    如果 AWS Identity and Access Management (IAM) 身份验证已启用,则为 true;否则为 false。

  • InstanceCreateTime – 时间戳。

    提供创建数据库实例的日期和时间。

  • Iops – 数字(整数)。

    指定预配置的 IOPS(每秒 I/O 操作数)值。

  • KmsKeyId – UTF-8 字符串。

    不支持:数据库实例的加密由数据库集群管理。

  • LatestRestorableTime – 时间戳。

    指定数据库可以使用时间点还原的最新还原时间。

  • LicenseModel – UTF-8 字符串。

    该数据库实例的许可模式信息。

  • MasterUsername – UTF-8 字符串。

    包含数据库实例的主用户名。

  • MonitoringInterval – 数字(整数)。

    收集数据库实例的增强监控指标的时间点之间的间隔,以秒为单位。

  • MonitoringRoleArn – UTF-8 字符串。

    允许 Neptune 将增强监控指标发送到 Amazon CloudWatch Logs 的 IAM 角色的 ARN。

  • MultiAZ – 布尔值。

    指定数据库实例是否为多可用区部署。

  • PendingModifiedValuesPendingModifiedValues 对象。

    指定对数据库实例的更改待处理。仅在更改待处理时包含此元素。特定更改由子元素标识。

  • PreferredBackupWindow – UTF-8 字符串。

    指定在启用自动备份时,自动执行备份的日常时间范围,如 BackupRetentionPeriod 所规定。

  • PreferredMaintenanceWindow – UTF-8 字符串。

    指定可进行系统维护的每周时间范围(采用通用协调时间 (UTC))。

  • PromotionTier – 数字(整数)。

    该值指定在现有主实例发生故障后将只读副本提升为主实例的顺序。

  • PubliclyAccessible – 布尔值。

    此标记不应再使用。

  • ReadReplicaDBClusterIdentifiers – ReadReplicaDBClusterIdentifier 的数组 — UTF-8 字符串。

    包含一个或多个数据集集群(作为此数据库实例只读副本的集群)的标识符。

  • ReadReplicaDBInstanceIdentifiers – ReadReplicaDBInstanceIdentifier 的数组 — UTF-8 字符串。

    包含一个或多个与此数据库实例关联的只读副本的标识符。

  • ReadReplicaSourceDBInstanceIdentifier – UTF-8 字符串。

    包含源数据库实例(在此数据库实例是只读副本时)的标识符。

  • SecondaryAvailabilityZone – UTF-8 字符串。

    如果存在,则指定带多可用区支持的数据库实例辅助可用区的名称。

  • StatusInfosDBInstanceStatusInfo DBInstanceStatusInfo 对象的数组。

    只读副本的状态。如果实例不是只读副本,则此项空白。

  • StorageEncrypted – 布尔值。

    不支持:数据库实例的加密由数据库集群管理。

  • StorageType – UTF-8 字符串。

    指定与数据库实例关联的存储类型。

  • TdeCredentialArn – UTF-8 字符串。

    来自密钥存储的 ARN,实例通过它进行关联用于 TDE 加密。

  • Timezone – UTF-8 字符串。

    不支持。

  • VpcSecurityGroupsVpcSecurityGroupMembership VpcSecurityGroupMembership 对象的数组。

    提供数据库实例所属的 VPC 安全组元素的列表。

DBInstance 用作下列对象的响应元素:

DBInstanceStatusInfo(结构)

提供数据库实例状态信息的列表。

字段

  • Message – UTF-8 字符串。

    实例出现错误时,错误的详细信息。如果实例未处于出错状态,则此值为空白。

  • Normal – 布尔值。

    布尔值,如果实例正常运行则为 true,如果实例处于错误状态则为 false。

  • Status – UTF-8 字符串。

    数据库实例的状态。对于只读副本的 StatusType,该值可以为 replicating、error、stopped 或 terminated。

  • StatusType – UTF-8 字符串。

    此值当前是“只读复制”。

OrderableDBInstanceOption(结构)

包含数据库实例的可用选项列表。

此数据类型用作DescribeOrderableDBInstanceOptions(操作)操作中的响应元素。

字段

  • AvailabilityZones可用区 AvailabilityZone 对象的数组。

    数据库实例的可用区域列表。

  • DBInstanceClass – UTF-8 字符串。

    数据库实例的数据库实例类。

  • Engine – UTF-8 字符串。

    数据库实例的引擎类型。

  • EngineVersion – UTF-8 字符串。

    数据库实例的引擎版本。

  • LicenseModel – UTF-8 字符串。

    数据库实例的许可模式

  • MaxIopsPerDbInstance – 数字(整数)。

    数据库实例的最大总预配置 IOPS。

  • MaxIopsPerGib – 数字(双精度)。

    数据库实例每 Gib 的最大预配置 IOPS。

  • MaxStorageSize – 数字(整数)。

    数据库实例的最大存储大小。

  • MinIopsPerDbInstance – 数字(整数)。

    数据库实例的最小总预配置 IOPS。

  • MinIopsPerGib – 数字(双精度)。

    数据库实例每 Gib 的最小预配置 IOPS。

  • MinStorageSize – 数字(整数)。

    数据库实例的最小存储大小。

  • MultiAZCapable – 布尔值。

    指示数据库实例是否有多可用区。

  • ReadReplicaCapable – 布尔值。

    指示数据库实例是否可以有只读副本。

  • StorageType – UTF-8 字符串。

    指示数据库实例的存储类型。

  • SupportsEnhancedMonitoring – 布尔值。

    指示数据库实例是否支持增强监控(间隔从 1 到 60 秒)。

  • SupportsIAMDatabaseAuthentication – 布尔值。

    指示数据库实例是否支持 IAM 数据库身份验证。

  • SupportsIops – 布尔值。

    指示数据库实例是否支持预配置的 IOPS。

  • SupportsStorageEncryption – 布尔值。

    指示数据库实例是否支持加密存储。

  • Vpc – 布尔值。

    指示数据库实例是否在 VPC 中。

ValidDBInstanceModificationsMessage(结构)

有关您可对数据库实例进行的有效更改的信息。包含对 DescribeValidDBInstanceModifications(操作) 操作的成功调用的结果。您可在调用 ModifyDBInstance(操作) 时使用此信息。

字段

  • Storage – ValidStorageOptions 的数组 — 一个结构。

    数据库实例的有效存储选项。

ValidDBInstanceModificationsMessage 用作下列对象的响应元素:

CreateDBInstance(操作)

       此 API 的 AWS CLI 名称为 create-db-instance,Python 名称为 create_db_instance

创建新的数据库实例。

请求

  • AllocatedStorage(在 CLI 中:--allocated-storage,或在 Python 中:allocated_storage)– 数字(整数)。

    要为数据库实例分配的存储量(以 GB 为单位)。

    类型:整数

    不适用。随着数据库中的数据量增长,Neptune 集群卷自动增长,不过您只需要为在 Neptune 集群卷中使用的空间付费。

  • AutoMinorVersionUpgrade(在 CLI 中:--auto-minor-version-upgrade,或在 Python 中:auto_minor_version_upgrade)– 布尔值。

    指示在维护时段期间,将对该数据库实例自动应用次要引擎升级。

    默认值:true

  • AvailabilityZone(在 CLI 中:--availability-zone,或在 Python 中:availability_zone)– UTF-8 字符串。

    在其中创建了数据库实例的 EC2 可用区

    默认值:终端节点的 AWS 区域中系统随机选择的可用区。

    示例:us-east-1d

    约束:如果 MultiAZ 设置为 true,则不能指定 AvailabilityZone 参数。指定的可用区必须与当前终端节点位于相同 AWS 区域中。

  • BackupRetentionPeriod(在 CLI 中:--backup-retention-period,或在 Python 中:backup_retention_period)– 数字(整数)。

    自动备份的保留天数。

    不适用。自动备份保留期由数据库集群管理。有关更多信息,请参阅 CreateDBCluster(操作)

    默认值:1

    约束:

    • 值必须介于 0 到 35 之间

    • 如果数据库实例是只读副本的源,则不能设置为 0。

  • CopyTagsToSnapshot(在 CLI 中:--copy-tags-to-snapshot,或在 Python 中:copy_tags_to_snapshot)– 布尔值。

    如果为 true,则将数据库实例的所有标签复制到数据库实例的快照中,否则为 false。默认为 false。

  • DBClusterIdentifier(在 CLI 中:--db-cluster-identifier,或在 Python 中:db_cluster_identifier)– UTF-8 字符串。

    实例所属的数据库集群的标识符。

    有关创建数据库集群的信息,请参阅CreateDBCluster(操作)

    类型:字符串

  • DBInstanceClass(在 CLI 中:--db-instance-class,或在 Python 中:db_instance_class)– 必需:UTF-8 字符串。

    数据库实例的计算和内存容量,例如,db.m4.large。并非所有数据库实例类在所有 AWS 区域中都可用。

  • DBInstanceIdentifier(在 CLI 中:--db-instance-identifier,或在 Python 中:db_instance_identifier)– 必需:UTF-8 字符串。

    数据库实例标识符。该参数作为一个小写字符串存储。

    约束:

    • 必须包含 1 到 63 个字母、数字或连字符。

    • 第一个字符必须是字母。

    • 不能以连字符结束或包含两个连续连字符。

    示例:mydbinstance

  • DBName(在 CLI 中:--db-name,或在 Python 中:db_name)– UTF-8 字符串。

    不支持。

  • DBParameterGroupName(在 CLI 中:--db-parameter-group-name,或在 Python 中:db_parameter_group_name)– UTF-8 字符串。

    要与此数据库实例关联的数据库参数组的名称。如果省略此参数,则使用指定引擎的默认 DBParameterGroup。

    约束:

    • 必须为 1 到 255 个字母、数字或连字符。

    • 第一个字符必须是字母

    • 不能以连字符结束或包含两个连续连字符

  • DBSecurityGroups(在 CLI 中:--db-security-groups,或在 Python 中:db_security_groups)– DBSecurityGroupName 的数组—UTF-8 字符串。

    要与此数据库实例关联的数据库安全组的列表。

    默认值:数据库引擎的默认数据库安全组。

  • DBSubnetGroupName(在 CLI 中:--db-subnet-group-name,或在 Python 中:db_subnet_group_name)– UTF-8 字符串。

    与此数据库实例关联的数据库子网组。

    如果不存在数据库子网组,则该实例为非 VPC 数据库实例。

  • DeletionProtection(在 CLI 中:--deletion-protection,或在 Python 中:deletion_protection)– 布尔值。

    指示数据库实例是否已启用删除保护的值。在启用删除保护时,无法删除数据库。默认情况下,将禁用删除保护。请参阅删除数据库实例

    可以删除数据库集群中的数据库实例,即使在其父数据库集群中启用了删除保护也是如此。

  • Domain(在 CLI 中:--domain,或在 Python 中:domain)– UTF-8 字符串。

    指定在其中创建实例的 Active Directory 域。

  • DomainIAMRoleName(在 CLI 中:--domain-iam-role-name,或在 Python 中:domain_iam_role_name)– UTF-8 字符串。

    指定在对 Directory Service 进行 API 调用时使用的 IAM 角色的名称。

  • EnableCloudwatchLogsExports(在 CLI 中:--enable-cloudwatch-logs-exports,或在 Python 中:enable_cloudwatch_logs_exports)– UTF-8 字符串的数组。

    需要启用以导出到 CloudWatch Logs 的日志类型的列表。

  • EnableIAMDatabaseAuthentication(在 CLI 中:--enable-iam-database-authentication,或在 Python 中:enable_iam_database_authentication)– 布尔值。

    如果为 True,则为 Neptune 启用 AWS Identity and Access Management (IAM) 身份验证。

    默认值:false

  • Engine(在 CLI 中:--engine,或在 Python 中:engine)– 必需:UTF-8 字符串。

    要用于此实例的数据库引擎的名称。

    有效值:neptune

  • EngineVersion(在 CLI 中:--engine-version,或在 Python 中:engine_version)– UTF-8 字符串。

    要使用的数据库引擎的版本号。目前,设置此参数不起作用。

  • Iops(在 CLI 中:--iops,或在 Python 中:iops)– 数字(整数)。

    最初为数据库实例分配的预配置 IOPS(每秒输入/输出操作数)量。

  • KmsKeyId(在 CLI 中:--kms-key-id,或在 Python 中:kms_key_id)– UTF-8 字符串。

    加密数据库实例的 AWS KMS 密钥标识符。

    KMS 密钥标识符是 KMS 加密密钥的 Amazon 资源名称 (ARN)。如果您创建数据库实例时使用的 AWS 账户,是拥有加密新数据库实例所用 KMS 加密密钥的同一个账户,则您可以使用 KMS 密钥别名,而不用 KMS 加密密钥的 ARN。

    不适用。KMS 密钥标识符由数据库集群管理。有关更多信息,请参阅CreateDBCluster(操作)

    如果 StorageEncrypted 参数为 true,并且您没有为 KmsKeyId 参数指定值,则 Amazon Neptune 将使用您的默认加密密钥。AWS KMS 将为您的 AWS 账户创建默认加密密钥。您的 AWS 账户在每个 AWS 区域都有一个不同的默认加密密钥。

  • LicenseModel(在 CLI 中:--license-model,或在 Python 中:license_model)– UTF-8 字符串。

    该数据库实例的许可模式信息。

    有效值:license-included | bring-your-own-license | general-public-license

  • MasterUsername(在 CLI 中:--master-username,或在 Python 中:master_username)– UTF-8 字符串。

    主用户的名称。未使用。

  • MasterUserPassword(在 CLI 中:--master-user-password,或在 Python 中:master_user_password)– UTF-8 字符串。

    主用户的密码。密码可以包含除“/”、“"”或“@”之外的任意可打印 ASCII 字符。

    未使用。

  • MonitoringInterval(在 CLI 中:--monitoring-interval,或在 Python 中:monitoring_interval)– 数字(整数)。

    收集数据库实例的增强监控指标的时间点之间的间隔,以秒为单位。要禁用收集增强监控指标,请指定 0。默认值为 0。

    如果指定 MonitoringRoleArn,则您还必须将 MonitoringInterval 设置为 0 以外的值。

    有效值:0, 1, 5, 10, 15, 30, 60

  • MonitoringRoleArn(在 CLI 中:--monitoring-role-arn,或在 Python 中:monitoring_role_arn)– UTF-8 字符串。

    允许 Neptune 将增强监控指标发送到 Amazon CloudWatch Logs 的 IAM 角色的 ARN。例如:arn:aws:iam:123456789012:role/emaccess

    如果 MonitoringInterval 设置为 0 以外的值,则您必须提供 MonitoringRoleArn 值。

  • MultiAZ(在 CLI 中:--multi-az,或在 Python 中:multi_az)– 布尔值。

    指定数据库实例是否为多可用区部署。如果 MultiAZ 参数设为 true,则不能设置 AvailabilityZone 参数。

  • Port(在 CLI 中:--port,或在 Python 中:port)– 数字(整数)。

    数据库实例接受连接的端口编号。

    不适用。端口由数据库集群管理。有关更多信息,请参阅CreateDBCluster(操作)

    默认值:8182

    类型:整数

  • PreferredBackupWindow(在 CLI 中:--preferred-backup-window,或在 Python 中:preferred_backup_window)– UTF-8 字符串。

    创建自动备份的每日时间范围。

    不适用。每天创建自动备份的时间范围由数据库集群管理。有关更多信息,请参阅 CreateDBCluster(操作)

  • PreferredMaintenanceWindow(在 CLI 中:--preferred-maintenance-window,或在 Python 中:preferred_maintenance_window)– UTF-8 字符串。

    每周可以进行系统维护的时间范围,采用通用协调时间 (UTC)。

    格式:ddd:hh24:mi-ddd:hh24:mi

    默认值是每个 AWS 区域 8 小时的时间段中随机选择的 30 分钟时段(随机选取周中的某天进行)。

    有效值:Mon、Tue、Wed、Thu、Fri、Sat、Sun。

    约束:至少为 30 分钟的时段。

  • PromotionTier(在 CLI 中:--promotion-tier,或在 Python 中:promotion_tier)– 数字(整数)。

    该值指定在现有主实例发生故障后将只读副本提升为主实例的顺序。

    默认值:1

    有效值:0 - 15

  • PubliclyAccessible(在 CLI 中:--publicly-accessible,或在 Python 中:publicly_accessible)– 布尔值。

    此标记不应再使用。

  • StorageEncrypted(在 CLI 中:--storage-encrypted,或在 Python 中:storage_encrypted)– 布尔值。

    指定是否已对数据库实例加密。

    不适用。数据库实例的加密由数据库集群管理。有关更多信息,请参阅CreateDBCluster(操作)

    默认值:false

  • StorageType(在 CLI 中:--storage-type,或在 Python 中:storage_type)– UTF-8 字符串。

    指定要与数据库实例关联的存储类型。

    不适用。存储由数据库集群管理。

  • Tags(在 CLI 中:--tags,或在 Python 中:tags)– 标签 Tag 对象的数组。

    分配到新实例的标签。

  • TdeCredentialArn(在 CLI 中:--tde-credential-arn,或在 Python 中:tde_credential_arn)– UTF-8 字符串。

    来自密钥存储的 ARN,实例通过它进行关联用于 TDE 加密。

  • TdeCredentialPassword(在 CLI 中:--tde-credential-password,或在 Python 中:tde_credential_password)– UTF-8 字符串。

    密钥存储中指定 ARN 的密码,以便访问设备。

  • Timezone(在 CLI 中:--timezone,或在 Python 中:timezone)– UTF-8 字符串。

    数据库实例的时区。

  • VpcSecurityGroupIds(在 CLI 中:--vpc-security-group-ids,或在 Python 中:vpc_security_group_ids)– VpcSecurityGroupId 的数组—UTF-8 字符串。

    要与此数据库实例关联的 EC2 VPC 安全组的列表。

    不适用。关联的 EC2 VPC 安全组列表由数据库集群管理。有关更多信息,请参阅CreateDBCluster(操作)

    默认值:数据库子网组的 VPC 的默认 EC2 VPC 安全组。

响应

包含 Amazon Neptune 数据库实例的详细信息。

此数据类型用作DescribeDBInstances(操作)操作中的响应元素。

  • AllocatedStorage(在 CLI 中:--allocated-storage,或在 Python 中:allocated_storage)– 数字(整数)。

    指定已分配存储的大小,以 GB 为单位。

  • AutoMinorVersionUpgrade(在 CLI 中:--auto-minor-version-upgrade,或在 Python 中:auto_minor_version_upgrade)– 布尔值。

    指示自动应用次要版本补丁。

  • AvailabilityZone(在 CLI 中:--availability-zone,或在 Python 中:availability_zone)– UTF-8 字符串。

    指定数据库实例所在可用区域的名称。

  • BackupRetentionPeriod(在 CLI 中:--backup-retention-period,或在 Python 中:backup_retention_period)– 数字(整数)。

    指定自动数据库快照的保留天数。

  • CACertificateIdentifier(在 CLI 中:--ca-certificate-identifier,或在 Python 中:ca_certificate_identifier)– UTF-8 字符串。

    此数据库实例的 CA 证书的标识符。

  • CopyTagsToSnapshot(在 CLI 中:--copy-tags-to-snapshot,或在 Python 中:copy_tags_to_snapshot)– 布尔值。

    指定是否将标签从数据库实例复制到数据库实例的快照。

  • DBClusterIdentifier(在 CLI 中:--db-cluster-identifier,或在 Python 中:db_cluster_identifier)– UTF-8 字符串。

    如果数据库实例属于某个数据库集群,则包含数据库实例所属的数据库集群的名称。

  • DBInstanceArn(在 CLI 中:--db-instance-arn,或在 Python 中:db_instance_arn)– UTF-8 字符串。

    数据库实例的 Amazon 资源名称 (ARN)。

  • DBInstanceClass(在 CLI 中:--db-instance-class,或在 Python 中:db_instance_class)– UTF-8 字符串。

    包含数据库实例的计算和内存容量级别名称。

  • DBInstanceIdentifier(在 CLI 中:--db-instance-identifier,或在 Python 中:db_instance_identifier)– UTF-8 字符串。

    包含用户提供的数据库标识符。此标识符是标识数据库实例的唯一密钥。

  • DbInstancePort(在 CLI 中:--db-instance-port,或在 Python 中:db_instance_port)– 数字(整数)。

    指定数据库实例侦听的端口。如果数据库实例属于某个数据库集群,则此端口可能不同于数据库集群的端口。

  • DBInstanceStatus(在 CLI 中:--db-instance-status,或在 Python 中:db_instance_status)– UTF-8 字符串。

    指定此数据库的当前状态。

  • DbiResourceId(在 CLI 中:--dbi-resource-id,或在 Python 中:dbi_resource_id)– UTF-8 字符串。

    数据库实例在 AWS 区域中唯一的不可变标识符。只要访问了用户数据库实例的 AWS KMS 密钥,就可在 AWS CloudTrail 日志条目中找到此标识符。

  • DBName(在 CLI 中:--db-name,或在 Python 中:db_name)– UTF-8 字符串。

    数据库名称。

  • DBParameterGroups(在 CLI 中:--db-parameter-groups,或在 Python 中:db_parameter_groups)– DBParameterGroupStatus DBParameterGroup 对象的数组。

    提供应用到此数据库实例的数据库参数组的列表。

  • DBSecurityGroups(在 CLI 中:--db-security-groups,或在 Python 中:db_security_groups)– DBSecurityGroupMembership DBSecurityGroup 对象的数组。

    提供仅包含 DBSecurityGroup.NameDBSecurityGroup.Status 子元素的数据库安全组元素的列表。

  • DBSubnetGroup(在 CLI 中:--db-subnet-group,或在 Python 中:db_subnet_group)– DBSubnetGroup 对象。

    指定与数据库实例关联的子网组的信息,包括名称、描述和子网组中的子网。

  • DeletionProtection(在 CLI 中:--deletion-protection,或在 Python 中:deletion_protection)– 布尔值。

    指示数据库实例是否已启用删除保护。在启用删除保护时,无法删除实例。请参阅删除数据库实例

  • DomainMemberships(在 CLI 中:--domain-memberships,或在 Python 中:domain_memberships)– DomainMembership DomainMembership 对象的数组。

    不支持

  • EnabledCloudwatchLogsExports(在 CLI 中:--enabled-cloudwatch-logs-exports,或在 Python 中:enabled_cloudwatch_logs_exports)– UTF-8 字符串的数组。

    此数据库实例配置为导出到 CloudWatch Logs 的日志类型的列表。

  • Endpoint(在 CLI 中:--endpoint,或在 Python 中:endpoint)– 终端节点 对象。

    指定连接终端节点。

  • Engine(在 CLI 中:--engine,或在 Python 中:engine)– UTF-8 字符串。

    提供要用于此数据库实例的数据库引擎的名称。

  • EngineVersion(在 CLI 中:--engine-version,或在 Python 中:engine_version)– UTF-8 字符串。

    指示数据库引擎版本。

  • EnhancedMonitoringResourceArn(在 CLI 中:--enhanced-monitoring-resource-arn,或在 Python 中:enhanced_monitoring_resource_arn)– UTF-8 字符串。

    接收数据库实例的增强监控指标数据的 Amazon CloudWatch Logs 日志流的 Amazon 资源名称 (ARN)。

  • IAMDatabaseAuthenticationEnabled(在 CLI 中:--iam-database-authentication-enabled,或在 Python 中:iam_database_authentication_enabled)– 布尔值。

    如果 AWS Identity and Access Management (IAM) 身份验证已启用,则为 true;否则为 false。

  • InstanceCreateTime(在 CLI 中:--instance-create-time,或在 Python 中:instance_create_time)– 时间戳。

    提供创建数据库实例的日期和时间。

  • Iops(在 CLI 中:--iops,或在 Python 中:iops)– 数字(整数)。

    指定预配置的 IOPS(每秒 I/O 操作数)值。

  • KmsKeyId(在 CLI 中:--kms-key-id,或在 Python 中:kms_key_id)– UTF-8 字符串。

    不支持:数据库实例的加密由数据库集群管理。

  • LatestRestorableTime(在 CLI 中:--latest-restorable-time,或在 Python 中:latest_restorable_time)– 时间戳。

    指定数据库可以使用时间点还原的最新还原时间。

  • LicenseModel(在 CLI 中:--license-model,或在 Python 中:license_model)– UTF-8 字符串。

    该数据库实例的许可模式信息。

  • MasterUsername(在 CLI 中:--master-username,或在 Python 中:master_username)– UTF-8 字符串。

    包含数据库实例的主用户名。

  • MonitoringInterval(在 CLI 中:--monitoring-interval,或在 Python 中:monitoring_interval)– 数字(整数)。

    收集数据库实例的增强监控指标的时间点之间的间隔,以秒为单位。

  • MonitoringRoleArn(在 CLI 中:--monitoring-role-arn,或在 Python 中:monitoring_role_arn)– UTF-8 字符串。

    允许 Neptune 将增强监控指标发送到 Amazon CloudWatch Logs 的 IAM 角色的 ARN。

  • MultiAZ(在 CLI 中:--multi-az,或在 Python 中:multi_az)– 布尔值。

    指定数据库实例是否为多可用区部署。

  • PendingModifiedValues(在 CLI 中:--pending-modified-values,或在 Python 中:pending_modified_values)– PendingModifiedValues 对象。

    指定对数据库实例的更改待处理。仅在更改待处理时包含此元素。特定更改由子元素标识。

  • PreferredBackupWindow(在 CLI 中:--preferred-backup-window,或在 Python 中:preferred_backup_window)– UTF-8 字符串。

    指定在启用自动备份时,自动执行备份的日常时间范围,如 BackupRetentionPeriod 所规定。

  • PreferredMaintenanceWindow(在 CLI 中:--preferred-maintenance-window,或在 Python 中:preferred_maintenance_window)– UTF-8 字符串。

    指定可进行系统维护的每周时间范围(采用通用协调时间 (UTC))。

  • PromotionTier(在 CLI 中:--promotion-tier,或在 Python 中:promotion_tier)– 数字(整数)。

    该值指定在现有主实例发生故障后将只读副本提升为主实例的顺序。

  • PubliclyAccessible(在 CLI 中:--publicly-accessible,或在 Python 中:publicly_accessible)– 布尔值。

    此标记不应再使用。

  • ReadReplicaDBClusterIdentifiers(在 CLI 中:--read-replica-db-cluster-identifiers,或在 Python 中:read_replica_db_cluster_identifiers)– ReadReplicaDBClusterIdentifier 的数组—UTF-8 字符串。

    包含一个或多个数据集集群(作为此数据库实例只读副本的集群)的标识符。

  • ReadReplicaDBInstanceIdentifiers(在 CLI 中:--read-replica-db-instance-identifiers,或在 Python 中:read_replica_db_instance_identifiers)– ReadReplicaDBInstanceIdentifier 的数组—UTF-8 字符串。

    包含一个或多个与此数据库实例关联的只读副本的标识符。

  • ReadReplicaSourceDBInstanceIdentifier(在 CLI 中:--read-replica-source-db-instance-identifier,或在 Python 中:read_replica_source_db_instance_identifier)– UTF-8 字符串。

    包含源数据库实例(在此数据库实例是只读副本时)的标识符。

  • SecondaryAvailabilityZone(在 CLI 中:--secondary-availability-zone,或在 Python 中:secondary_availability_zone)– UTF-8 字符串。

    如果存在,则指定带多可用区支持的数据库实例辅助可用区的名称。

  • StatusInfos(在 CLI 中:--status-infos,或在 Python 中:status_infos)– DBInstanceStatusInfo DBInstanceStatusInfo 对象的数组。

    只读副本的状态。如果实例不是只读副本,则此项空白。

  • StorageEncrypted(在 CLI 中:--storage-encrypted,或在 Python 中:storage_encrypted)– 布尔值。

    不支持:数据库实例的加密由数据库集群管理。

  • StorageType(在 CLI 中:--storage-type,或在 Python 中:storage_type)– UTF-8 字符串。

    指定与数据库实例关联的存储类型。

  • TdeCredentialArn(在 CLI 中:--tde-credential-arn,或在 Python 中:tde_credential_arn)– UTF-8 字符串。

    来自密钥存储的 ARN,实例通过它进行关联用于 TDE 加密。

  • Timezone(在 CLI 中:--timezone,或在 Python 中:timezone)– UTF-8 字符串。

    不支持。

  • VpcSecurityGroups(在 CLI 中:--vpc-security-groups,或在 Python 中:vpc_security_groups)– VpcSecurityGroupMembership VpcSecurityGroupMembership 对象的数组。

    提供数据库实例所属的 VPC 安全组元素的列表。

DeleteDBInstance(操作)

       此 API 的 AWS CLI 名称为 delete-db-instance,Python 名称为 delete_db_instance

DeleteDBInstance 操作将删除先前预配置的数据库实例。删除数据库实例时,会删除该实例的所有自动备份,且无法恢复。使用 DeleteDBInstance 删除数据库实例时,不删除其手动数据库快照。

如果您请求最终数据库快照,则在创建数据库快照之前,Amazon Neptune 数据库实例的状态为 deleting。API 操作 DescribeDBInstance 可用于监控此操作的状态。操作一旦提交就无法取消或恢复。

请注意,当数据库实例处于 failedincompatible-restoreincompatible-network 的失败状态时,只有在将 SkipFinalSnapshot 参数设置为 true 时才能删除它。

如果数据库实例是数据库集群中的唯一实例,或者启用了删除保护,则无法删除该实例。

请求

  • DBInstanceIdentifier(在 CLI 中:--db-instance-identifier,或在 Python 中:db_instance_identifier)– 必需:UTF-8 字符串。

    要删除的数据库实例的数据库实例标识符。该参数不区分大小写。

    约束:

    • 必须与现有数据库实例的名称匹配。

  • FinalDBSnapshotIdentifier(在 CLI 中:--final-db-snapshot-identifier,或在 Python 中:final_db_snapshot_identifier)– UTF-8 字符串。

    SkipFinalSnapshot 设置为 false 时,所创建新 DBSnapshot 的 DBSnapshotIdentifier。

    注意

    指定此参数并且将 SkipFinalShapshot 参数设置为 true 会导致错误。

    约束:

    • 必须为 1 到 255 个字母或数字。

    • 第一个字符必须是字母

    • 不能以连字符结束或包含两个连续连字符

    • 删除只读副本时无法指定。

  • SkipFinalSnapshot(在 CLI 中:--skip-final-snapshot,或在 Python 中:skip_final_snapshot)– 布尔值。

    确定删除数据库实例之前是否创建最终数据库快照。如果指定 true,则不创建 DBSnapshot。如果指定 false,则删除数据库实例之前创建一个数据库快照。

    请注意,当数据库实例处于“failed”、“incompatible-restore”或“incompatible-network”的失败状态时,只能在 SkipFinalSnapshot 参数设置为“true”时删除该实例。

    删除只读副本时指定 true

    注意

    如果 SkipFinalSnapshot 为 false,则必须指定 FinalDBSnapshotIdentifier 参数。

    默认值:false

响应

包含 Amazon Neptune 数据库实例的详细信息。

此数据类型用作DescribeDBInstances(操作)操作中的响应元素。

  • AllocatedStorage(在 CLI 中:--allocated-storage,或在 Python 中:allocated_storage)– 数字(整数)。

    指定已分配存储的大小,以 GB 为单位。

  • AutoMinorVersionUpgrade(在 CLI 中:--auto-minor-version-upgrade,或在 Python 中:auto_minor_version_upgrade)– 布尔值。

    指示自动应用次要版本补丁。

  • AvailabilityZone(在 CLI 中:--availability-zone,或在 Python 中:availability_zone)– UTF-8 字符串。

    指定数据库实例所在可用区域的名称。

  • BackupRetentionPeriod(在 CLI 中:--backup-retention-period,或在 Python 中:backup_retention_period)– 数字(整数)。

    指定自动数据库快照的保留天数。

  • CACertificateIdentifier(在 CLI 中:--ca-certificate-identifier,或在 Python 中:ca_certificate_identifier)– UTF-8 字符串。

    此数据库实例的 CA 证书的标识符。

  • CopyTagsToSnapshot(在 CLI 中:--copy-tags-to-snapshot,或在 Python 中:copy_tags_to_snapshot)– 布尔值。

    指定是否将标签从数据库实例复制到数据库实例的快照。

  • DBClusterIdentifier(在 CLI 中:--db-cluster-identifier,或在 Python 中:db_cluster_identifier)– UTF-8 字符串。

    如果数据库实例属于某个数据库集群,则包含数据库实例所属的数据库集群的名称。

  • DBInstanceArn(在 CLI 中:--db-instance-arn,或在 Python 中:db_instance_arn)– UTF-8 字符串。

    数据库实例的 Amazon 资源名称 (ARN)。

  • DBInstanceClass(在 CLI 中:--db-instance-class,或在 Python 中:db_instance_class)– UTF-8 字符串。

    包含数据库实例的计算和内存容量级别名称。

  • DBInstanceIdentifier(在 CLI 中:--db-instance-identifier,或在 Python 中:db_instance_identifier)– UTF-8 字符串。

    包含用户提供的数据库标识符。此标识符是标识数据库实例的唯一密钥。

  • DbInstancePort(在 CLI 中:--db-instance-port,或在 Python 中:db_instance_port)– 数字(整数)。

    指定数据库实例侦听的端口。如果数据库实例属于某个数据库集群,则此端口可能不同于数据库集群的端口。

  • DBInstanceStatus(在 CLI 中:--db-instance-status,或在 Python 中:db_instance_status)– UTF-8 字符串。

    指定此数据库的当前状态。

  • DbiResourceId(在 CLI 中:--dbi-resource-id,或在 Python 中:dbi_resource_id)– UTF-8 字符串。

    数据库实例在 AWS 区域中唯一的不可变标识符。只要访问了用户数据库实例的 AWS KMS 密钥,就可在 AWS CloudTrail 日志条目中找到此标识符。

  • DBName(在 CLI 中:--db-name,或在 Python 中:db_name)– UTF-8 字符串。

    数据库名称。

  • DBParameterGroups(在 CLI 中:--db-parameter-groups,或在 Python 中:db_parameter_groups)– DBParameterGroupStatus DBParameterGroup 对象的数组。

    提供应用到此数据库实例的数据库参数组的列表。

  • DBSecurityGroups(在 CLI 中:--db-security-groups,或在 Python 中:db_security_groups)– DBSecurityGroupMembership DBSecurityGroup 对象的数组。

    提供仅包含 DBSecurityGroup.NameDBSecurityGroup.Status 子元素的数据库安全组元素的列表。

  • DBSubnetGroup(在 CLI 中:--db-subnet-group,或在 Python 中:db_subnet_group)– DBSubnetGroup 对象。

    指定与数据库实例关联的子网组的信息,包括名称、描述和子网组中的子网。

  • DeletionProtection(在 CLI 中:--deletion-protection,或在 Python 中:deletion_protection)– 布尔值。

    指示数据库实例是否已启用删除保护。在启用删除保护时,无法删除实例。请参阅删除数据库实例

  • DomainMemberships(在 CLI 中:--domain-memberships,或在 Python 中:domain_memberships)– DomainMembership DomainMembership 对象的数组。

    不支持

  • EnabledCloudwatchLogsExports(在 CLI 中:--enabled-cloudwatch-logs-exports,或在 Python 中:enabled_cloudwatch_logs_exports)– UTF-8 字符串的数组。

    此数据库实例配置为导出到 CloudWatch Logs 的日志类型的列表。

  • Endpoint(在 CLI 中:--endpoint,或在 Python 中:endpoint)– 终端节点 对象。

    指定连接终端节点。

  • Engine(在 CLI 中:--engine,或在 Python 中:engine)– UTF-8 字符串。

    提供要用于此数据库实例的数据库引擎的名称。

  • EngineVersion(在 CLI 中:--engine-version,或在 Python 中:engine_version)– UTF-8 字符串。

    指示数据库引擎版本。

  • EnhancedMonitoringResourceArn(在 CLI 中:--enhanced-monitoring-resource-arn,或在 Python 中:enhanced_monitoring_resource_arn)– UTF-8 字符串。

    接收数据库实例的增强监控指标数据的 Amazon CloudWatch Logs 日志流的 Amazon 资源名称 (ARN)。

  • IAMDatabaseAuthenticationEnabled(在 CLI 中:--iam-database-authentication-enabled,或在 Python 中:iam_database_authentication_enabled)– 布尔值。

    如果 AWS Identity and Access Management (IAM) 身份验证已启用,则为 true;否则为 false。

  • InstanceCreateTime(在 CLI 中:--instance-create-time,或在 Python 中:instance_create_time)– 时间戳。

    提供创建数据库实例的日期和时间。

  • Iops(在 CLI 中:--iops,或在 Python 中:iops)– 数字(整数)。

    指定预配置的 IOPS(每秒 I/O 操作数)值。

  • KmsKeyId(在 CLI 中:--kms-key-id,或在 Python 中:kms_key_id)– UTF-8 字符串。

    不支持:数据库实例的加密由数据库集群管理。

  • LatestRestorableTime(在 CLI 中:--latest-restorable-time,或在 Python 中:latest_restorable_time)– 时间戳。

    指定数据库可以使用时间点还原的最新还原时间。

  • LicenseModel(在 CLI 中:--license-model,或在 Python 中:license_model)– UTF-8 字符串。

    该数据库实例的许可模式信息。

  • MasterUsername(在 CLI 中:--master-username,或在 Python 中:master_username)– UTF-8 字符串。

    包含数据库实例的主用户名。

  • MonitoringInterval(在 CLI 中:--monitoring-interval,或在 Python 中:monitoring_interval)– 数字(整数)。

    收集数据库实例的增强监控指标的时间点之间的间隔,以秒为单位。

  • MonitoringRoleArn(在 CLI 中:--monitoring-role-arn,或在 Python 中:monitoring_role_arn)– UTF-8 字符串。

    允许 Neptune 将增强监控指标发送到 Amazon CloudWatch Logs 的 IAM 角色的 ARN。

  • MultiAZ(在 CLI 中:--multi-az,或在 Python 中:multi_az)– 布尔值。

    指定数据库实例是否为多可用区部署。

  • PendingModifiedValues(在 CLI 中:--pending-modified-values,或在 Python 中:pending_modified_values)– PendingModifiedValues 对象。

    指定对数据库实例的更改待处理。仅在更改待处理时包含此元素。特定更改由子元素标识。

  • PreferredBackupWindow(在 CLI 中:--preferred-backup-window,或在 Python 中:preferred_backup_window)– UTF-8 字符串。

    指定在启用自动备份时,自动执行备份的日常时间范围,如 BackupRetentionPeriod 所规定。

  • PreferredMaintenanceWindow(在 CLI 中:--preferred-maintenance-window,或在 Python 中:preferred_maintenance_window)– UTF-8 字符串。

    指定可进行系统维护的每周时间范围(采用通用协调时间 (UTC))。

  • PromotionTier(在 CLI 中:--promotion-tier,或在 Python 中:promotion_tier)– 数字(整数)。

    该值指定在现有主实例发生故障后将只读副本提升为主实例的顺序。

  • PubliclyAccessible(在 CLI 中:--publicly-accessible,或在 Python 中:publicly_accessible)– 布尔值。

    此标记不应再使用。

  • ReadReplicaDBClusterIdentifiers(在 CLI 中:--read-replica-db-cluster-identifiers,或在 Python 中:read_replica_db_cluster_identifiers)– ReadReplicaDBClusterIdentifier 的数组—UTF-8 字符串。

    包含一个或多个数据集集群(作为此数据库实例只读副本的集群)的标识符。

  • ReadReplicaDBInstanceIdentifiers(在 CLI 中:--read-replica-db-instance-identifiers,或在 Python 中:read_replica_db_instance_identifiers)– ReadReplicaDBInstanceIdentifier 的数组—UTF-8 字符串。

    包含一个或多个与此数据库实例关联的只读副本的标识符。

  • ReadReplicaSourceDBInstanceIdentifier(在 CLI 中:--read-replica-source-db-instance-identifier,或在 Python 中:read_replica_source_db_instance_identifier)– UTF-8 字符串。

    包含源数据库实例(在此数据库实例是只读副本时)的标识符。

  • SecondaryAvailabilityZone(在 CLI 中:--secondary-availability-zone,或在 Python 中:secondary_availability_zone)– UTF-8 字符串。

    如果存在,则指定带多可用区支持的数据库实例辅助可用区的名称。

  • StatusInfos(在 CLI 中:--status-infos,或在 Python 中:status_infos)– DBInstanceStatusInfo DBInstanceStatusInfo 对象的数组。

    只读副本的状态。如果实例不是只读副本,则此项空白。

  • StorageEncrypted(在 CLI 中:--storage-encrypted,或在 Python 中:storage_encrypted)– 布尔值。

    不支持:数据库实例的加密由数据库集群管理。

  • StorageType(在 CLI 中:--storage-type,或在 Python 中:storage_type)– UTF-8 字符串。

    指定与数据库实例关联的存储类型。

  • TdeCredentialArn(在 CLI 中:--tde-credential-arn,或在 Python 中:tde_credential_arn)– UTF-8 字符串。

    来自密钥存储的 ARN,实例通过它进行关联用于 TDE 加密。

  • Timezone(在 CLI 中:--timezone,或在 Python 中:timezone)– UTF-8 字符串。

    不支持。

  • VpcSecurityGroups(在 CLI 中:--vpc-security-groups,或在 Python 中:vpc_security_groups)– VpcSecurityGroupMembership VpcSecurityGroupMembership 对象的数组。

    提供数据库实例所属的 VPC 安全组元素的列表。

ModifyDBInstance(操作)

       此 API 的 AWS CLI 名称为 modify-db-instance,Python 名称为 modify_db_instance

修改数据库实例的设置。您可通过在请求中指定这些参数以及新值,更改一个或多个数据库配置参数。要了解您可对数据库实例进行哪些修改,请在调用ModifyDBInstance(操作)之前调用DescribeValidDBInstanceModifications(操作)

请求

  • AllocatedStorage(在 CLI 中:--allocated-storage,或在 Python 中:allocated_storage)– 数字(整数)。

    要为数据库实例分配的新存储量(以 GB 为单位)。

    不适用。存储由数据库集群管理。

  • AllowMajorVersionUpgrade(在 CLI 中:--allow-major-version-upgrade,或在 Python 中:allow_major_version_upgrade)– 布尔值。

    指示允许主要版本升级。更改此参数不会导致中断,所做更改会尽快以异步方式应用。

  • ApplyImmediately(在 CLI 中:--apply-immediately,或在 Python 中:apply_immediately)– 布尔值。

    指定是否应尽快异步应用此请求中修改及任何待处理修改,无论数据库实例的 PreferredMaintenanceWindow 设置如何。

    如果此参数设置为 false,则在下一个维护时段中应用对数据库实例的更改。某些参数更改会导致中断,在下次调用 RebootDBInstance(操作) 时或者下次故障重启时应用。

    默认值:false

  • AutoMinorVersionUpgrade(在 CLI 中:--auto-minor-version-upgrade,或在 Python 中:auto_minor_version_upgrade)– 布尔值。

    指示在维护时段期间,将对该数据库实例自动应用次要版本升级。更改此参数不会导致中断(除非在下列情况中),所做更改会尽快以异步方式应用。如果在维护时段内将此参数设置为 true,有较新的次要版本可用,并且 Neptune 已启用对该引擎版本的自动修补,则将导致服务中断。

  • BackupRetentionPeriod(在 CLI 中:--backup-retention-period,或在 Python 中:backup_retention_period)– 数字(整数)。

    不适用。自动备份保留期由数据库集群管理。有关更多信息,请参阅 ModifyDBCluster(操作)

    默认值:使用现有设置

  • CACertificateIdentifier(在 CLI 中:--ca-certificate-identifier,或在 Python 中:ca_certificate_identifier)– UTF-8 字符串。

    指示需要与实例相关联的证书。

  • CloudwatchLogsExportConfiguration(在 CLI 中:--cloudwatch-logs-export-configuration,或在 Python 中:cloudwatch_logs_export_configuration)– CloudwatchLogsExportConfiguration 对象。

    要启用日志类型的配置设置,以便针对特定数据库实例或数据库集群导出到 CloudWatch Logs。

  • CopyTagsToSnapshot(在 CLI 中:--copy-tags-to-snapshot,或在 Python 中:copy_tags_to_snapshot)– 布尔值。

    如果为 true,则将数据库实例的所有标签复制到数据库实例的快照中,否则为 false。默认为 false。

  • DBInstanceClass(在 CLI 中:--db-instance-class,或在 Python 中:db_instance_class)– UTF-8 字符串。

    数据库实例的新计算和内存容量,例如,db.m4.large。并非所有数据库实例类在所有 AWS 区域中都可用。

    如果您修改数据库实例类,则在更改期间会发生中断。更改在下一个维护时段内应用,除非此请求的 ApplyImmediately 指定为 true

    默认值:使用现有设置

  • DBInstanceIdentifier(在 CLI 中:--db-instance-identifier,或在 Python 中:db_instance_identifier)– 必需:UTF-8 字符串。

    数据库实例标识符。此值以一个小写字符串存储。

    约束:

    • 必须匹配现有 DBInstance 的标识符。

  • DBParameterGroupName(在 CLI 中:--db-parameter-group-name,或在 Python 中:db_parameter_group_name)– UTF-8 字符串。

    要应用到数据库实例的数据库参数组的名称。更改此设置不会导致中断。参数组名称本身将立即发生更改,但在您重新启动实例而不进行故障转移之前,不会应用实际参数更改。在下一个维护时段内,将不自动重启数据库实例,并且不应用参数更改。

    默认值:使用现有设置

    约束:数据库参数组必须与此数据库实例位于同一个数据库参数组系列中。

  • DBPortNumber(在 CLI 中:--db-port-number,或在 Python 中:db_port_number)– 数字(整数)。

    数据库实例接受连接的端口编号。

    DBPortNumber 参数的值不能与为数据库实例选项组中的选项指定的任何端口值相同。

    不论 ApplyImmediately 参数的值如何,在您更改 DBPortNumber 值时,数据库将重启。

    默认值:8182

  • DBSecurityGroups(在 CLI 中:--db-security-groups,或在 Python 中:db_security_groups)– DBSecurityGroupName 的数组—UTF-8 字符串。

    在此数据库实例上授权的数据库安全组的列表。更改此设置不会导致中断,所做更改会尽快以异步方式应用。

    约束:

    • 如果提供,则必须匹配现有 DBSecurityGroups。

  • DBSubnetGroupName(在 CLI 中:--db-subnet-group-name,或在 Python 中:db_subnet_group_name)– UTF-8 字符串。

    数据库实例的新数据库子网组。您可以使用此参数将数据库实例移动到其他 VPC。

    更改子网组将导致更改期间发生中断。更改在下一个维护时段内应用,除非您为 ApplyImmediately 参数指定 true

    约束:如果提供,则必须与现有 DBSubnetGroup 的名称匹配。

    示例:mySubnetGroup

  • DeletionProtection(在 CLI 中:--deletion-protection,或在 Python 中:deletion_protection)– 布尔值。

    指示数据库实例是否已启用删除保护的值。在启用删除保护时,无法删除数据库。默认情况下,将禁用删除保护。请参阅删除数据库实例

  • Domain(在 CLI 中:--domain,或在 Python 中:domain)– UTF-8 字符串。

    不支持。

  • DomainIAMRoleName(在 CLI 中:--domain-iam-role-name,或在 Python 中:domain_iam_role_name)– UTF-8 字符串。

    不支持

  • EnableIAMDatabaseAuthentication(在 CLI 中:--enable-iam-database-authentication,或在 Python 中:enable_iam_database_authentication)– 布尔值。

    如果为 true,则启用 AWS Identity and Access Management (IAM) 账户与数据库账户之间的映射;否则为 false。

    您可以为以下数据库引擎启用 IAM 数据库身份验证

    不适用。将 AWS IAM 账户映射到数据库账户是由数据库集群管理的。有关更多信息,请参阅 ModifyDBCluster(操作)

    默认值:false

  • EngineVersion(在 CLI 中:--engine-version,或在 Python 中:engine_version)– UTF-8 字符串。

    数据库引擎要升级到的版本号。目前,设置此参数不起作用。要将数据库引擎升级到最新版本,请使用 ApplyPendingMaintenanceAction(操作) API。

  • Iops(在 CLI 中:--iops,或在 Python 中:iops)– 数字(整数)。

    实例的新预配置 IOPS(每秒 I/O 操作数)值。

    更改此设置不会导致中断,除非此请求的 ApplyImmediately 参数设置为 true,否则将在下个维护时段应用更改。

    默认值:使用现有设置

  • LicenseModel(在 CLI 中:--license-model,或在 Python 中:license_model)– UTF-8 字符串。

    不支持。

  • MasterUserPassword(在 CLI 中:--master-user-password,或在 Python 中:master_user_password)– UTF-8 字符串。

    不适用。

  • MonitoringInterval(在 CLI 中:--monitoring-interval,或在 Python 中:monitoring_interval)– 数字(整数)。

    收集数据库实例的增强监控指标的时间点之间的间隔,以秒为单位。要禁用收集增强监控指标,请指定 0。默认值为 0。

    如果指定 MonitoringRoleArn,则您还必须将 MonitoringInterval 设置为 0 以外的值。

    有效值:0, 1, 5, 10, 15, 30, 60

  • MonitoringRoleArn(在 CLI 中:--monitoring-role-arn,或在 Python 中:monitoring_role_arn)– UTF-8 字符串。

    允许 Neptune 将增强监控指标发送到 Amazon CloudWatch Logs 的 IAM 角色的 ARN。例如:arn:aws:iam:123456789012:role/emaccess

    如果 MonitoringInterval 设置为 0 以外的值,则您必须提供 MonitoringRoleArn 值。

  • MultiAZ(在 CLI 中:--multi-az,或在 Python 中:multi_az)– 布尔值。

    指定数据库实例是否为多可用区部署。更改此参数不会导致中断,除非此请求的 ApplyImmediately 参数设置为 true,否则将在下个维护时段应用更改。

  • NewDBInstanceIdentifier(在 CLI 中:--new-db-instance-identifier,或在 Python 中:new_db_instance_identifier)– UTF-8 字符串。

    重命名数据库实例时数据库实例的新标识符。在更改数据库实例标识符的时候,若将 Apply Immediately 设置为 true,则实例立即重启;若将 Apply Immediately 设置为 false,则实例将在下一个维护时段重启。此值以一个小写字符串存储。

    约束:

    • 必须包含 1 到 63 个字母、数字或连字符。

    • 第一个字符必须是字母。

    • 不能以连字符结束或包含两个连续连字符。

    示例:mydbinstance

  • PreferredBackupWindow(在 CLI 中:--preferred-backup-window,或在 Python 中:preferred_backup_window)– UTF-8 字符串。

    如果启用自动备份,该属性指定创建自动备份的日常时间范围。

    不适用。每天创建自动备份的时间范围由数据库集群管理。有关更多信息,请参阅 ModifyDBCluster(操作)

    约束:

    • 必须采用 hh24:mi-hh24:mi 格式

    • 必须采用协调世界时 (UTC)

    • 不得与首选维护时段冲突

    • 必须至少为 30 分钟

  • PreferredMaintenanceWindow(在 CLI 中:--preferred-maintenance-window,或在 Python 中:preferred_maintenance_window)– UTF-8 字符串。

    可进行系统维护的每周时间范围(采用 UTC),这可能导致中断。更改此参数不会导致中断(除非在下列情况中),所做更改会尽快以异步方式应用。如果有待处理的操作导致服务重启,并且维护时段经过更改,加入了当前时间,则更改此参数将导致数据库实例重启。如果将此时段移动到当前时间,则当前时间与时段结束之间必须相隔至少 30 分钟以确保应用待处理的更改。

    默认值:使用现有设置

    格式:ddd:hh24:mi-ddd:hh24:mi

    有效值:Mon | Tue | Wed | Thu | Fri | Sat | Sun

    约束:必须至少为 30 分钟

  • PromotionTier(在 CLI 中:--promotion-tier,或在 Python 中:promotion_tier)– 数字(整数)。

    该值指定在现有主实例发生故障后将只读副本提升为主实例的顺序。

    默认值:1

    有效值:0 - 15

  • PubliclyAccessible(在 CLI 中:--publicly-accessible,或在 Python 中:publicly_accessible)– 布尔值。

    此标记不应再使用。

  • StorageType(在 CLI 中:--storage-type,或在 Python 中:storage_type)– UTF-8 字符串。

    不支持。

  • TdeCredentialArn(在 CLI 中:--tde-credential-arn,或在 Python 中:tde_credential_arn)– UTF-8 字符串。

    来自密钥存储的 ARN,实例通过它进行关联用于 TDE 加密。

  • TdeCredentialPassword(在 CLI 中:--tde-credential-password,或在 Python 中:tde_credential_password)– UTF-8 字符串。

    密钥存储中指定 ARN 的密码,以便访问设备。

  • VpcSecurityGroupIds(在 CLI 中:--vpc-security-group-ids,或在 Python 中:vpc_security_group_ids)– VpcSecurityGroupId 的数组—UTF-8 字符串。

    在此数据库实例上授权的 EC2 VPC 安全组的列表。此更改会尽快异步应用。

    不适用。关联的 EC2 VPC 安全组列表由数据库集群管理。有关更多信息,请参阅 ModifyDBCluster(操作)

    约束:

    • 如果提供,则必须匹配现有 VpcSecurityGroupIds。

响应

包含 Amazon Neptune 数据库实例的详细信息。

此数据类型用作DescribeDBInstances(操作)操作中的响应元素。

  • AllocatedStorage(在 CLI 中:--allocated-storage,或在 Python 中:allocated_storage)– 数字(整数)。

    指定已分配存储的大小,以 GB 为单位。

  • AutoMinorVersionUpgrade(在 CLI 中:--auto-minor-version-upgrade,或在 Python 中:auto_minor_version_upgrade)– 布尔值。

    指示自动应用次要版本补丁。

  • AvailabilityZone(在 CLI 中:--availability-zone,或在 Python 中:availability_zone)– UTF-8 字符串。

    指定数据库实例所在可用区域的名称。

  • BackupRetentionPeriod(在 CLI 中:--backup-retention-period,或在 Python 中:backup_retention_period)– 数字(整数)。

    指定自动数据库快照的保留天数。

  • CACertificateIdentifier(在 CLI 中:--ca-certificate-identifier,或在 Python 中:ca_certificate_identifier)– UTF-8 字符串。

    此数据库实例的 CA 证书的标识符。

  • CopyTagsToSnapshot(在 CLI 中:--copy-tags-to-snapshot,或在 Python 中:copy_tags_to_snapshot)– 布尔值。

    指定是否将标签从数据库实例复制到数据库实例的快照。

  • DBClusterIdentifier(在 CLI 中:--db-cluster-identifier,或在 Python 中:db_cluster_identifier)– UTF-8 字符串。

    如果数据库实例属于某个数据库集群,则包含数据库实例所属的数据库集群的名称。

  • DBInstanceArn(在 CLI 中:--db-instance-arn,或在 Python 中:db_instance_arn)– UTF-8 字符串。

    数据库实例的 Amazon 资源名称 (ARN)。

  • DBInstanceClass(在 CLI 中:--db-instance-class,或在 Python 中:db_instance_class)– UTF-8 字符串。

    包含数据库实例的计算和内存容量级别名称。

  • DBInstanceIdentifier(在 CLI 中:--db-instance-identifier,或在 Python 中:db_instance_identifier)– UTF-8 字符串。

    包含用户提供的数据库标识符。此标识符是标识数据库实例的唯一密钥。

  • DbInstancePort(在 CLI 中:--db-instance-port,或在 Python 中:db_instance_port)– 数字(整数)。

    指定数据库实例侦听的端口。如果数据库实例属于某个数据库集群,则此端口可能不同于数据库集群的端口。

  • DBInstanceStatus(在 CLI 中:--db-instance-status,或在 Python 中:db_instance_status)– UTF-8 字符串。

    指定此数据库的当前状态。

  • DbiResourceId(在 CLI 中:--dbi-resource-id,或在 Python 中:dbi_resource_id)– UTF-8 字符串。

    数据库实例在 AWS 区域中唯一的不可变标识符。只要访问了用户数据库实例的 AWS KMS 密钥,就可在 AWS CloudTrail 日志条目中找到此标识符。

  • DBName(在 CLI 中:--db-name,或在 Python 中:db_name)– UTF-8 字符串。

    数据库名称。

  • DBParameterGroups(在 CLI 中:--db-parameter-groups,或在 Python 中:db_parameter_groups)– DBParameterGroupStatus DBParameterGroup 对象的数组。

    提供应用到此数据库实例的数据库参数组的列表。

  • DBSecurityGroups(在 CLI 中:--db-security-groups,或在 Python 中:db_security_groups)– DBSecurityGroupMembership DBSecurityGroup 对象的数组。

    提供仅包含 DBSecurityGroup.NameDBSecurityGroup.Status 子元素的数据库安全组元素的列表。

  • DBSubnetGroup(在 CLI 中:--db-subnet-group,或在 Python 中:db_subnet_group)– DBSubnetGroup 对象。

    指定与数据库实例关联的子网组的信息,包括名称、描述和子网组中的子网。

  • DeletionProtection(在 CLI 中:--deletion-protection,或在 Python 中:deletion_protection)– 布尔值。

    指示数据库实例是否已启用删除保护。在启用删除保护时,无法删除实例。请参阅删除数据库实例

  • DomainMemberships(在 CLI 中:--domain-memberships,或在 Python 中:domain_memberships)– DomainMembership DomainMembership 对象的数组。

    不支持

  • EnabledCloudwatchLogsExports(在 CLI 中:--enabled-cloudwatch-logs-exports,或在 Python 中:enabled_cloudwatch_logs_exports)– UTF-8 字符串的数组。

    此数据库实例配置为导出到 CloudWatch Logs 的日志类型的列表。

  • Endpoint(在 CLI 中:--endpoint,或在 Python 中:endpoint)– 终端节点 对象。

    指定连接终端节点。

  • Engine(在 CLI 中:--engine,或在 Python 中:engine)– UTF-8 字符串。

    提供要用于此数据库实例的数据库引擎的名称。

  • EngineVersion(在 CLI 中:--engine-version,或在 Python 中:engine_version)– UTF-8 字符串。

    指示数据库引擎版本。

  • EnhancedMonitoringResourceArn(在 CLI 中:--enhanced-monitoring-resource-arn,或在 Python 中:enhanced_monitoring_resource_arn)– UTF-8 字符串。

    接收数据库实例的增强监控指标数据的 Amazon CloudWatch Logs 日志流的 Amazon 资源名称 (ARN)。

  • IAMDatabaseAuthenticationEnabled(在 CLI 中:--iam-database-authentication-enabled,或在 Python 中:iam_database_authentication_enabled)– 布尔值。

    如果 AWS Identity and Access Management (IAM) 身份验证已启用,则为 true;否则为 false。

  • InstanceCreateTime(在 CLI 中:--instance-create-time,或在 Python 中:instance_create_time)– 时间戳。

    提供创建数据库实例的日期和时间。

  • Iops(在 CLI 中:--iops,或在 Python 中:iops)– 数字(整数)。

    指定预配置的 IOPS(每秒 I/O 操作数)值。

  • KmsKeyId(在 CLI 中:--kms-key-id,或在 Python 中:kms_key_id)– UTF-8 字符串。

    不支持:数据库实例的加密由数据库集群管理。

  • LatestRestorableTime(在 CLI 中:--latest-restorable-time,或在 Python 中:latest_restorable_time)– 时间戳。

    指定数据库可以使用时间点还原的最新还原时间。

  • LicenseModel(在 CLI 中:--license-model,或在 Python 中:license_model)– UTF-8 字符串。

    该数据库实例的许可模式信息。

  • MasterUsername(在 CLI 中:--master-username,或在 Python 中:master_username)– UTF-8 字符串。

    包含数据库实例的主用户名。

  • MonitoringInterval(在 CLI 中:--monitoring-interval,或在 Python 中:monitoring_interval)– 数字(整数)。

    收集数据库实例的增强监控指标的时间点之间的间隔,以秒为单位。

  • MonitoringRoleArn(在 CLI 中:--monitoring-role-arn,或在 Python 中:monitoring_role_arn)– UTF-8 字符串。

    允许 Neptune 将增强监控指标发送到 Amazon CloudWatch Logs 的 IAM 角色的 ARN。

  • MultiAZ(在 CLI 中:--multi-az,或在 Python 中:multi_az)– 布尔值。

    指定数据库实例是否为多可用区部署。

  • PendingModifiedValues(在 CLI 中:--pending-modified-values,或在 Python 中:pending_modified_values)– PendingModifiedValues 对象。

    指定对数据库实例的更改待处理。仅在更改待处理时包含此元素。特定更改由子元素标识。

  • PreferredBackupWindow(在 CLI 中:--preferred-backup-window,或在 Python 中:preferred_backup_window)– UTF-8 字符串。

    指定在启用自动备份时,自动执行备份的日常时间范围,如 BackupRetentionPeriod 所规定。

  • PreferredMaintenanceWindow(在 CLI 中:--preferred-maintenance-window,或在 Python 中:preferred_maintenance_window)– UTF-8 字符串。

    指定可进行系统维护的每周时间范围(采用通用协调时间 (UTC))。

  • PromotionTier(在 CLI 中:--promotion-tier,或在 Python 中:promotion_tier)– 数字(整数)。

    该值指定在现有主实例发生故障后将只读副本提升为主实例的顺序。

  • PubliclyAccessible(在 CLI 中:--publicly-accessible,或在 Python 中:publicly_accessible)– 布尔值。

    此标记不应再使用。

  • ReadReplicaDBClusterIdentifiers(在 CLI 中:--read-replica-db-cluster-identifiers,或在 Python 中:read_replica_db_cluster_identifiers)– ReadReplicaDBClusterIdentifier 的数组—UTF-8 字符串。

    包含一个或多个数据集集群(作为此数据库实例只读副本的集群)的标识符。

  • ReadReplicaDBInstanceIdentifiers(在 CLI 中:--read-replica-db-instance-identifiers,或在 Python 中:read_replica_db_instance_identifiers)– ReadReplicaDBInstanceIdentifier 的数组—UTF-8 字符串。

    包含一个或多个与此数据库实例关联的只读副本的标识符。

  • ReadReplicaSourceDBInstanceIdentifier(在 CLI 中:--read-replica-source-db-instance-identifier,或在 Python 中:read_replica_source_db_instance_identifier)– UTF-8 字符串。

    包含源数据库实例(在此数据库实例是只读副本时)的标识符。

  • SecondaryAvailabilityZone(在 CLI 中:--secondary-availability-zone,或在 Python 中:secondary_availability_zone)– UTF-8 字符串。

    如果存在,则指定带多可用区支持的数据库实例辅助可用区的名称。

  • StatusInfos(在 CLI 中:--status-infos,或在 Python 中:status_infos)– DBInstanceStatusInfo DBInstanceStatusInfo 对象的数组。

    只读副本的状态。如果实例不是只读副本,则此项空白。

  • StorageEncrypted(在 CLI 中:--storage-encrypted,或在 Python 中:storage_encrypted)– 布尔值。

    不支持:数据库实例的加密由数据库集群管理。

  • StorageType(在 CLI 中:--storage-type,或在 Python 中:storage_type)– UTF-8 字符串。

    指定与数据库实例关联的存储类型。

  • TdeCredentialArn(在 CLI 中:--tde-credential-arn,或在 Python 中:tde_credential_arn)– UTF-8 字符串。

    来自密钥存储的 ARN,实例通过它进行关联用于 TDE 加密。

  • Timezone(在 CLI 中:--timezone,或在 Python 中:timezone)– UTF-8 字符串。

    不支持。

  • VpcSecurityGroups(在 CLI 中:--vpc-security-groups,或在 Python 中:vpc_security_groups)– VpcSecurityGroupMembership VpcSecurityGroupMembership 对象的数组。

    提供数据库实例所属的 VPC 安全组元素的列表。

RebootDBInstance(操作)

       此 API 的 AWS CLI 名称为 reboot-db-instance,Python 名称为 reboot_db_instance

您可能需要重启数据库实例,通常是出于维护目的。例如,如果进行某些修改或更改与数据库实例关联的数据库参数组,您必须重启该实例以使更改生效。

重启数据库实例会重新启动数据库引擎服务。重启数据库实例将导致短暂中断,在此期间,数据库实例状态将设置为正在重启。

请求

  • DBInstanceIdentifier(在 CLI 中:--db-instance-identifier,或在 Python 中:db_instance_identifier)– 必需:UTF-8 字符串。

    数据库实例标识符。该参数作为一个小写字符串存储。

    约束:

    • 必须匹配现有 DBInstance 的标识符。

  • ForceFailover(在 CLI 中:--force-failover,或在 Python 中:force_failover)– 布尔值。

    如果为 true,则通过多可用区故障转移进行重启。

    约束:如果没有为多可用区配置实例,则无法指定 true

响应

包含 Amazon Neptune 数据库实例的详细信息。

此数据类型用作DescribeDBInstances(操作)操作中的响应元素。

  • AllocatedStorage(在 CLI 中:--allocated-storage,或在 Python 中:allocated_storage)– 数字(整数)。

    指定已分配存储的大小,以 GB 为单位。

  • AutoMinorVersionUpgrade(在 CLI 中:--auto-minor-version-upgrade,或在 Python 中:auto_minor_version_upgrade)– 布尔值。

    指示自动应用次要版本补丁。

  • AvailabilityZone(在 CLI 中:--availability-zone,或在 Python 中:availability_zone)– UTF-8 字符串。

    指定数据库实例所在可用区域的名称。

  • BackupRetentionPeriod(在 CLI 中:--backup-retention-period,或在 Python 中:backup_retention_period)– 数字(整数)。

    指定自动数据库快照的保留天数。

  • CACertificateIdentifier(在 CLI 中:--ca-certificate-identifier,或在 Python 中:ca_certificate_identifier)– UTF-8 字符串。

    此数据库实例的 CA 证书的标识符。

  • CopyTagsToSnapshot(在 CLI 中:--copy-tags-to-snapshot,或在 Python 中:copy_tags_to_snapshot)– 布尔值。

    指定是否将标签从数据库实例复制到数据库实例的快照。

  • DBClusterIdentifier(在 CLI 中:--db-cluster-identifier,或在 Python 中:db_cluster_identifier)– UTF-8 字符串。

    如果数据库实例属于某个数据库集群,则包含数据库实例所属的数据库集群的名称。

  • DBInstanceArn(在 CLI 中:--db-instance-arn,或在 Python 中:db_instance_arn)– UTF-8 字符串。

    数据库实例的 Amazon 资源名称 (ARN)。

  • DBInstanceClass(在 CLI 中:--db-instance-class,或在 Python 中:db_instance_class)– UTF-8 字符串。

    包含数据库实例的计算和内存容量级别名称。

  • DBInstanceIdentifier(在 CLI 中:--db-instance-identifier,或在 Python 中:db_instance_identifier)– UTF-8 字符串。

    包含用户提供的数据库标识符。此标识符是标识数据库实例的唯一密钥。

  • DbInstancePort(在 CLI 中:--db-instance-port,或在 Python 中:db_instance_port)– 数字(整数)。

    指定数据库实例侦听的端口。如果数据库实例属于某个数据库集群,则此端口可能不同于数据库集群的端口。

  • DBInstanceStatus(在 CLI 中:--db-instance-status,或在 Python 中:db_instance_status)– UTF-8 字符串。

    指定此数据库的当前状态。

  • DbiResourceId(在 CLI 中:--dbi-resource-id,或在 Python 中:dbi_resource_id)– UTF-8 字符串。

    数据库实例在 AWS 区域中唯一的不可变标识符。只要访问了用户数据库实例的 AWS KMS 密钥,就可在 AWS CloudTrail 日志条目中找到此标识符。

  • DBName(在 CLI 中:--db-name,或在 Python 中:db_name)– UTF-8 字符串。

    数据库名称。

  • DBParameterGroups(在 CLI 中:--db-parameter-groups,或在 Python 中:db_parameter_groups)– DBParameterGroupStatus DBParameterGroup 对象的数组。

    提供应用到此数据库实例的数据库参数组的列表。

  • DBSecurityGroups(在 CLI 中:--db-security-groups,或在 Python 中:db_security_groups)– DBSecurityGroupMembership DBSecurityGroup 对象的数组。

    提供仅包含 DBSecurityGroup.NameDBSecurityGroup.Status 子元素的数据库安全组元素的列表。

  • DBSubnetGroup(在 CLI 中:--db-subnet-group,或在 Python 中:db_subnet_group)– DBSubnetGroup 对象。

    指定与数据库实例关联的子网组的信息,包括名称、描述和子网组中的子网。

  • DeletionProtection(在 CLI 中:--deletion-protection,或在 Python 中:deletion_protection)– 布尔值。

    指示数据库实例是否已启用删除保护。在启用删除保护时,无法删除实例。请参阅删除数据库实例

  • DomainMemberships(在 CLI 中:--domain-memberships,或在 Python 中:domain_memberships)– DomainMembership DomainMembership 对象的数组。

    不支持

  • EnabledCloudwatchLogsExports(在 CLI 中:--enabled-cloudwatch-logs-exports,或在 Python 中:enabled_cloudwatch_logs_exports)– UTF-8 字符串的数组。

    此数据库实例配置为导出到 CloudWatch Logs 的日志类型的列表。

  • Endpoint(在 CLI 中:--endpoint,或在 Python 中:endpoint)– 终端节点 对象。

    指定连接终端节点。

  • Engine(在 CLI 中:--engine,或在 Python 中:engine)– UTF-8 字符串。

    提供要用于此数据库实例的数据库引擎的名称。

  • EngineVersion(在 CLI 中:--engine-version,或在 Python 中:engine_version)– UTF-8 字符串。

    指示数据库引擎版本。

  • EnhancedMonitoringResourceArn(在 CLI 中:--enhanced-monitoring-resource-arn,或在 Python 中:enhanced_monitoring_resource_arn)– UTF-8 字符串。

    接收数据库实例的增强监控指标数据的 Amazon CloudWatch Logs 日志流的 Amazon 资源名称 (ARN)。

  • IAMDatabaseAuthenticationEnabled(在 CLI 中:--iam-database-authentication-enabled,或在 Python 中:iam_database_authentication_enabled)– 布尔值。

    如果 AWS Identity and Access Management (IAM) 身份验证已启用,则为 true;否则为 false。

  • InstanceCreateTime(在 CLI 中:--instance-create-time,或在 Python 中:instance_create_time)– 时间戳。

    提供创建数据库实例的日期和时间。

  • Iops(在 CLI 中:--iops,或在 Python 中:iops)– 数字(整数)。

    指定预配置的 IOPS(每秒 I/O 操作数)值。

  • KmsKeyId(在 CLI 中:--kms-key-id,或在 Python 中:kms_key_id)– UTF-8 字符串。

    不支持:数据库实例的加密由数据库集群管理。

  • LatestRestorableTime(在 CLI 中:--latest-restorable-time,或在 Python 中:latest_restorable_time)– 时间戳。

    指定数据库可以使用时间点还原的最新还原时间。

  • LicenseModel(在 CLI 中:--license-model,或在 Python 中:license_model)– UTF-8 字符串。

    该数据库实例的许可模式信息。

  • MasterUsername(在 CLI 中:--master-username,或在 Python 中:master_username)– UTF-8 字符串。

    包含数据库实例的主用户名。

  • MonitoringInterval(在 CLI 中:--monitoring-interval,或在 Python 中:monitoring_interval)– 数字(整数)。

    收集数据库实例的增强监控指标的时间点之间的间隔,以秒为单位。

  • MonitoringRoleArn(在 CLI 中:--monitoring-role-arn,或在 Python 中:monitoring_role_arn)– UTF-8 字符串。

    允许 Neptune 将增强监控指标发送到 Amazon CloudWatch Logs 的 IAM 角色的 ARN。

  • MultiAZ(在 CLI 中:--multi-az,或在 Python 中:multi_az)– 布尔值。

    指定数据库实例是否为多可用区部署。

  • PendingModifiedValues(在 CLI 中:--pending-modified-values,或在 Python 中:pending_modified_values)– PendingModifiedValues 对象。

    指定对数据库实例的更改待处理。仅在更改待处理时包含此元素。特定更改由子元素标识。

  • PreferredBackupWindow(在 CLI 中:--preferred-backup-window,或在 Python 中:preferred_backup_window)– UTF-8 字符串。

    指定在启用自动备份时,自动执行备份的日常时间范围,如 BackupRetentionPeriod 所规定。

  • PreferredMaintenanceWindow(在 CLI 中:--preferred-maintenance-window,或在 Python 中:preferred_maintenance_window)– UTF-8 字符串。

    指定可进行系统维护的每周时间范围(采用通用协调时间 (UTC))。

  • PromotionTier(在 CLI 中:--promotion-tier,或在 Python 中:promotion_tier)– 数字(整数)。

    该值指定在现有主实例发生故障后将只读副本提升为主实例的顺序。

  • PubliclyAccessible(在 CLI 中:--publicly-accessible,或在 Python 中:publicly_accessible)– 布尔值。

    此标记不应再使用。

  • ReadReplicaDBClusterIdentifiers(在 CLI 中:--read-replica-db-cluster-identifiers,或在 Python 中:read_replica_db_cluster_identifiers)– ReadReplicaDBClusterIdentifier 的数组—UTF-8 字符串。

    包含一个或多个数据集集群(作为此数据库实例只读副本的集群)的标识符。

  • ReadReplicaDBInstanceIdentifiers(在 CLI 中:--read-replica-db-instance-identifiers,或在 Python 中:read_replica_db_instance_identifiers)– ReadReplicaDBInstanceIdentifier 的数组—UTF-8 字符串。

    包含一个或多个与此数据库实例关联的只读副本的标识符。

  • ReadReplicaSourceDBInstanceIdentifier(在 CLI 中:--read-replica-source-db-instance-identifier,或在 Python 中:read_replica_source_db_instance_identifier)– UTF-8 字符串。

    包含源数据库实例(在此数据库实例是只读副本时)的标识符。

  • SecondaryAvailabilityZone(在 CLI 中:--secondary-availability-zone,或在 Python 中:secondary_availability_zone)– UTF-8 字符串。

    如果存在,则指定带多可用区支持的数据库实例辅助可用区的名称。

  • StatusInfos(在 CLI 中:--status-infos,或在 Python 中:status_infos)– DBInstanceStatusInfo DBInstanceStatusInfo 对象的数组。

    只读副本的状态。如果实例不是只读副本,则此项空白。

  • StorageEncrypted(在 CLI 中:--storage-encrypted,或在 Python 中:storage_encrypted)– 布尔值。

    不支持:数据库实例的加密由数据库集群管理。

  • StorageType(在 CLI 中:--storage-type,或在 Python 中:storage_type)– UTF-8 字符串。

    指定与数据库实例关联的存储类型。

  • TdeCredentialArn(在 CLI 中:--tde-credential-arn,或在 Python 中:tde_credential_arn)– UTF-8 字符串。

    来自密钥存储的 ARN,实例通过它进行关联用于 TDE 加密。

  • Timezone(在 CLI 中:--timezone,或在 Python 中:timezone)– UTF-8 字符串。

    不支持。

  • VpcSecurityGroups(在 CLI 中:--vpc-security-groups,或在 Python 中:vpc_security_groups)– VpcSecurityGroupMembership VpcSecurityGroupMembership 对象的数组。

    提供数据库实例所属的 VPC 安全组元素的列表。

DescribeDBInstances(操作)

       此 API 的 AWS CLI 名称为 describe-db-instances,Python 名称为 describe_db_instances

返回有关预配置的实例的信息,并支持分页。

注意

此操作还可以返回 Amazon RDS 实例和 Amazon DocDB 实例的信息。

请求

  • DBInstanceIdentifier(在 CLI 中:--db-instance-identifier,或在 Python 中:db_instance_identifier)– UTF-8 字符串。

    用户提供的实例标识符。如果指定了此参数,则只返回特定数据库实例的信息。该参数不区分大小写。

    约束:

    • 如果提供,必须匹配现有 DBInstance 的标识符。

  • Filters(在 CLI 中:--filters,或在 Python 中:filters)– Filter Filter 对象的数组。

    筛选条件指定要描述的一个或多个数据库实例。

    支持的筛选条件:

    • db-cluster-id - 接受数据库集群标识符和数据库集群 Amazon 资源名称 (ARN)。该结果列表仅包括与这些 ARN 所标识数据库集群关联的数据库实例的相关信息。

    • engine - 接受引擎名称(例如 neptune),并将结果列表限制为由该引擎创建的数据库实例。

    例如,要从 AWS CLI 调用此 API 并进行筛选,以便仅返回 Neptune 数据库实例,您可以使用以下命令:

    aws neptune describe-db-instances \ --filters Name=engine,Values=neptune
  • Marker(在 CLI 中:--marker,或在 Python 中:marker)– UTF-8 字符串。

    由之前的 DescribeDBInstances 请求提供的可选分页标记。如果指定此参数,则响应仅包含标记之外的记录,最大数量为 MaxRecords 指定的值。

  • MaxRecords(在 CLI 中:--max-records,或在 Python 中:max_records)– 数字(整数)。

    包括在响应中的最大记录数。如果存在的记录数超过了指定的MaxRecords 值,则在响应中包含称为标记的分页记号,以便检索剩余的结果。

    默认值:100

    约束:最低为 20,最高为 100。

响应

  • DBInstances(在 CLI 中:--db-instances,或在 Python 中:db_instances)– DBInstance DBInstance 对象的数组。

    DBInstance(结构) 实例的列表。

  • Marker(在 CLI 中:--marker,或在 Python 中:marker)– UTF-8 字符串。

    由之前的请求提供的可选分页标记。如果指定此参数,则响应仅包含标记之外的记录,最大数量为 MaxRecords 指定的值。

DescribeOrderableDBInstanceOptions(操作)

       此 API 的 AWS CLI 名称为 describe-orderable-db-instance-options,Python 名称为 describe_orderable_db_instance_options

返回指定引擎的可订购数据库实例选项的列表。

请求

  • DBInstanceClass(在 CLI 中:--db-instance-class,或在 Python 中:db_instance_class)– UTF-8 字符串。

    数据库实例类筛选值。指定此参数以只显示与指定数据库实例类匹配的可用产品。

  • Engine(在 CLI 中:--engine,或在 Python 中:engine)– 必需:UTF-8 字符串。

    为其检索数据库实例选项的引擎的名称。

  • EngineVersion(在 CLI 中:--engine-version,或在 Python 中:engine_version)– UTF-8 字符串。

    引擎版本筛选值。指定此参数以只显示与指定引擎版本匹配的可用产品。

  • Filters(在 CLI 中:--filters,或在 Python 中:filters)– Filter Filter 对象的数组。

    当前不支持此参数。

  • LicenseModel(在 CLI 中:--license-model,或在 Python 中:license_model)– UTF-8 字符串。

    许可模式筛选值。指定此参数以只显示与指定许可模式匹配的可用产品。

  • Marker(在 CLI 中:--marker,或在 Python 中:marker)– UTF-8 字符串。

    由之前的 DescribeOrderableDBInstanceOptions 请求提供的可选分页标记。如果指定此参数,则响应仅包含标记之外的记录,最大数量为 MaxRecords 指定的值。

  • MaxRecords(在 CLI 中:--max-records,或在 Python 中:max_records)– 数字(整数)。

    包括在响应中的最大记录数。如果存在的记录数超过了指定的MaxRecords 值,则在响应中包含称为标记的分页记号,以便检索剩余的结果。

    默认值:100

    约束:最低为 20,最高为 100。

  • Vpc(在 CLI 中:--vpc,或在 Python 中:vpc)– 布尔值。

    VPC 筛选值。指定此参数以只显示可用的 VPC 或非 VPC 产品。

响应

  • Marker(在 CLI 中:--marker,或在 Python 中:marker)– UTF-8 字符串。

    由之前的 OrderableDBInstanceOptions 请求提供的可选分页标记。如果指定此参数,则响应仅包含标记之外的记录,最大数量为 MaxRecords 指定的值。

  • OrderableDBInstanceOptions(在 CLI 中:--orderable-db-instance-options,或在 Python 中:orderable_db_instance_options)– OrderableDBInstanceOption OrderableDBInstanceOption 对象的数组。

    一个 OrderableDBInstanceOption(结构) 结构,其中包含有关数据库实例可订购选项的信息。

DescribeValidDBInstanceModifications(操作)

       此 API 的 AWS CLI 名称为 describe-valid-db-instance-modifications,Python 名称为 describe_valid_db_instance_modifications

您可以调用 DescribeValidDBInstanceModifications(操作) 来了解可以对数据库实例进行哪些修改。您可在调用 ModifyDBInstance(操作) 时使用此信息。

请求

  • DBInstanceIdentifier(在 CLI 中:--db-instance-identifier,或在 Python 中:db_instance_identifier)– 必需:UTF-8 字符串。

    客户标识符或数据库实例的 ARN。

响应

有关您可对数据库实例进行的有效更改的信息。包含对 DescribeValidDBInstanceModifications(操作) 操作的成功调用的结果。您可在调用 ModifyDBInstance(操作) 时使用此信息。

  • Storage(在 CLI 中:--storage,或在 Python 中:storage)– ValidStorageOptions 的数组—一个结构。

    数据库实例的有效存储选项。