lib/aws-sdk-rds/client.rb in aws-sdk-rds-1.108.0 vs lib/aws-sdk-rds/client.rb in aws-sdk-rds-1.109.0

- old
+ new

@@ -1545,12 +1545,12 @@ # # Specify this option if you are copying a snapshot from one AWS Region # to another, and your DB instance uses a nondefault option group. If # your source DB instance uses Transparent Data Encryption for Oracle or # Microsoft SQL Server, you must specify this option when copying across - # AWS Regions. For more information, see [Option Group - # Considerations][1] in the *Amazon RDS User Guide.* + # AWS Regions. For more information, see [Option group + # considerations][1] in the *Amazon RDS User Guide.* # # # # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CopySnapshot.html#USER_CopySnapshot.Options # @@ -1765,12 +1765,12 @@ # Creates a custom Availability Zone (AZ). # # A custom AZ is an on-premises AZ that is integrated with a VMware # vSphere cluster. # - # For more information about RDS on VMware, see the [ *RDS on VMware - # User Guide.* ][1] + # For more information about RDS on VMware, see the [ RDS on VMware User + # Guide.][1] # # # # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/RDSonVMwareUserGuide/rds-on-vmware.html # @@ -3112,12 +3112,12 @@ # # <note markdown="1"> If you're creating a DB instance in an RDS on VMware environment, # specify the identifier of the custom Availability Zone to create the # DB instance in. # - # For more information about RDS on VMware, see the [ *RDS on VMware - # User Guide.* ][2] + # For more information about RDS on VMware, see the [ RDS on VMware User + # Guide.][2] # # </note> # # # @@ -3613,10 +3613,30 @@ # # @option params [Integer] :max_allocated_storage # The upper limit to which Amazon RDS can automatically scale the # storage of the DB instance. # + # @option params [Boolean] :enable_customer_owned_ip + # A value that indicates whether to enable a customer-owned IP address + # (CoIP) for an RDS on Outposts DB instance. + # + # A *CoIP* provides local or external connectivity to resources in your + # Outpost subnets through your on-premises network. For some use cases, + # a CoIP can provide lower latency for connections to the DB instance + # from outside of its virtual private cloud (VPC) on your local network. + # + # For more information about RDS on Outposts, see [Working with Amazon + # RDS on AWS Outposts][1] in the *Amazon RDS User Guide*. + # + # For more information about CoIPs, see [Customer-owned IP addresses][2] + # in the *AWS Outposts User Guide*. + # + # + # + # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html + # [2]: https://docs.aws.amazon.com/outposts/latest/userguide/outposts-networking-components.html#ip-addressing + # # @return [Types::CreateDBInstanceResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CreateDBInstanceResult#db_instance #db_instance} => Types::DBInstance # # @@ -3697,10 +3717,11 @@ # value: "String", # }, # ], # deletion_protection: false, # max_allocated_storage: 1, + # enable_customer_owned_ip: false, # }) # # @example Response structure # # resp.db_instance.db_instance_identifier #=> String @@ -3823,10 +3844,11 @@ # resp.db_instance.tag_list #=> Array # resp.db_instance.tag_list[0].key #=> String # resp.db_instance.tag_list[0].value #=> String # resp.db_instance.db_instance_automated_backups_replications #=> Array # resp.db_instance.db_instance_automated_backups_replications[0].db_instance_automated_backups_arn #=> String + # resp.db_instance.customer_owned_ip_enabled #=> Boolean # # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CreateDBInstance AWS API Documentation # # @overload create_db_instance(params = {}) # @param [Hash] params ({}) @@ -4471,10 +4493,11 @@ # resp.db_instance.tag_list #=> Array # resp.db_instance.tag_list[0].key #=> String # resp.db_instance.tag_list[0].value #=> String # resp.db_instance.db_instance_automated_backups_replications #=> Array # resp.db_instance.db_instance_automated_backups_replications[0].db_instance_automated_backups_arn #=> String + # resp.db_instance.customer_owned_ip_enabled #=> Boolean # # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CreateDBInstanceReadReplica AWS API Documentation # # @overload create_db_instance_read_replica(params = {}) # @param [Hash] params ({}) @@ -5362,12 +5385,12 @@ # Deletes a custom Availability Zone (AZ). # # A custom AZ is an on-premises AZ that is integrated with a VMware # vSphere cluster. # - # For more information about RDS on VMware, see the [ *RDS on VMware - # User Guide.* ][1] + # For more information about RDS on VMware, see the [ RDS on VMware User + # Guide.][1] # # # # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/RDSonVMwareUserGuide/rds-on-vmware.html # @@ -6019,10 +6042,11 @@ # resp.db_instance.tag_list #=> Array # resp.db_instance.tag_list[0].key #=> String # resp.db_instance.tag_list[0].value #=> String # resp.db_instance.db_instance_automated_backups_replications #=> Array # resp.db_instance.db_instance_automated_backups_replications[0].db_instance_automated_backups_arn #=> String + # resp.db_instance.customer_owned_ip_enabled #=> Boolean # # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DeleteDBInstance AWS API Documentation # # @overload delete_db_instance(params = {}) # @param [Hash] params ({}) @@ -6711,12 +6735,12 @@ # Returns information about custom Availability Zones (AZs). # # A custom AZ is an on-premises AZ that is integrated with a VMware # vSphere cluster. # - # For more information about RDS on VMware, see the [ *RDS on VMware - # User Guide.* ][1] + # For more information about RDS on VMware, see the [ RDS on VMware User + # Guide.][1] # # # # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/RDSonVMwareUserGuide/rds-on-vmware.html # @@ -7846,24 +7870,23 @@ # # * `status` # # * `active` - automated backups for current instances # - # * `retained` - automated backups for deleted instances + # * `retained` - automated backups for deleted instances and after + # backup replication is stopped # # * `creating` - automated backups that are waiting for the first # automated snapshot to be available # # * `db-instance-id` - Accepts DB instance identifiers and Amazon - # Resource Names (ARNs) for DB instances. The results list includes - # only information about the DB instance automated backupss identified - # by these ARNs. + # Resource Names (ARNs). The results list includes only information + # about the DB instance automated backups identified by these ARNs. # - # * `dbi-resource-id` - Accepts DB instance resource identifiers and DB - # Amazon Resource Names (ARNs) for DB instances. The results list - # includes only information about the DB instance resources identified - # by these ARNs. + # * `dbi-resource-id` - Accepts DB resource identifiers and Amazon + # Resource Names (ARNs). The results list includes only information + # about the DB instance resources identified by these ARNs. # # Returns all resources by default. The status for each resource is # specified in the response. # # @option params [Integer] :max_records @@ -8165,10 +8188,11 @@ # resp.db_instances[0].tag_list #=> Array # resp.db_instances[0].tag_list[0].key #=> String # resp.db_instances[0].tag_list[0].value #=> String # resp.db_instances[0].db_instance_automated_backups_replications #=> Array # resp.db_instances[0].db_instance_automated_backups_replications[0].db_instance_automated_backups_arn #=> String + # resp.db_instances[0].customer_owned_ip_enabled #=> Boolean # # # The following waiters are defined for this operation (see {Client#wait_until} for detailed usage): # # * db_instance_available @@ -10629,12 +10653,12 @@ req = build_request(:describe_reserved_db_instances_offerings, params) req.send_request(options) end # Returns a list of the source AWS Regions where the current AWS Region - # can create a read replica or copy a DB snapshot from. This API action - # supports pagination. + # can create a read replica, copy a DB snapshot from, or replicate + # automated backups from. This API action supports pagination. # # @option params [String] :region_name # The source AWS Region name. For example, `us-east-1`. # # Constraints: @@ -12203,12 +12227,12 @@ # # @option params [String] :db_subnet_group_name # The new DB subnet group for the DB instance. You can use this # parameter to move your DB instance to a different VPC. If your DB # instance isn't in a VPC, you can also use this parameter to move your - # DB instance into a VPC. For more information, see [Updating the VPC - # for a DB Instance][1] in the *Amazon RDS User Guide.* + # DB instance into a VPC. For more information, see [Working with a DB + # instance in a VPC][1] in the *Amazon RDS User Guide.* # # Changing the subnet group causes an outage during the change. The # change is applied during the next maintenance window, unless you # enable `ApplyImmediately`. # @@ -12217,11 +12241,11 @@ # # Example: `mySubnetGroup` # # # - # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html#USER_VPC.Non-VPC2VPC + # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html#USER_VPC.Non-VPC2VPC # # @option params [Array<String>] :db_security_groups # A list of DB security groups to authorize on this DB instance. # Changing this setting doesn't result in an outage and the change is # asynchronously applied as soon as possible. @@ -12797,10 +12821,30 @@ # # # # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html # + # @option params [Boolean] :enable_customer_owned_ip + # A value that indicates whether to enable a customer-owned IP address + # (CoIP) for an RDS on Outposts DB instance. + # + # A *CoIP* provides local or external connectivity to resources in your + # Outpost subnets through your on-premises network. For some use cases, + # a CoIP can provide lower latency for connections to the DB instance + # from outside of its virtual private cloud (VPC) on your local network. + # + # For more information about RDS on Outposts, see [Working with Amazon + # RDS on AWS Outposts][1] in the *Amazon RDS User Guide*. + # + # For more information about CoIPs, see [Customer-owned IP addresses][2] + # in the *AWS Outposts User Guide*. + # + # + # + # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html + # [2]: https://docs.aws.amazon.com/outposts/latest/userguide/outposts-networking-components.html#ip-addressing + # # @return [Types::ModifyDBInstanceResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ModifyDBInstanceResult#db_instance #db_instance} => Types::DBInstance # # @@ -12877,10 +12921,11 @@ # use_default_processor_features: false, # deletion_protection: false, # max_allocated_storage: 1, # certificate_rotation_restart: false, # replica_mode: "open-read-only", # accepts open-read-only, mounted + # enable_customer_owned_ip: false, # }) # # @example Response structure # # resp.db_instance.db_instance_identifier #=> String @@ -13003,10 +13048,11 @@ # resp.db_instance.tag_list #=> Array # resp.db_instance.tag_list[0].key #=> String # resp.db_instance.tag_list[0].value #=> String # resp.db_instance.db_instance_automated_backups_replications #=> Array # resp.db_instance.db_instance_automated_backups_replications[0].db_instance_automated_backups_arn #=> String + # resp.db_instance.customer_owned_ip_enabled #=> Boolean # # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/ModifyDBInstance AWS API Documentation # # @overload modify_db_instance(params = {}) # @param [Hash] params ({}) @@ -13327,15 +13373,15 @@ # The option group to identify with the upgraded DB snapshot. # # You can specify this parameter when you upgrade an Oracle DB snapshot. # The same option group considerations apply when upgrading a DB # snapshot as when upgrading a DB instance. For more information, see - # [Option Group Considerations][1] in the *Amazon RDS User Guide.* + # [Option group considerations][1] in the *Amazon RDS User Guide.* # # # - # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Oracle.html#USER_UpgradeDBInstance.Oracle.OGPG.OG + # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Oracle.html#USER_UpgradeDBInstance.Oracle.OGPG.OG # # @return [Types::ModifyDBSnapshotResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ModifyDBSnapshotResult#db_snapshot #db_snapshot} => Types::DBSnapshot # @@ -14097,10 +14143,11 @@ # resp.db_instance.tag_list #=> Array # resp.db_instance.tag_list[0].key #=> String # resp.db_instance.tag_list[0].value #=> String # resp.db_instance.db_instance_automated_backups_replications #=> Array # resp.db_instance.db_instance_automated_backups_replications[0].db_instance_automated_backups_arn #=> String + # resp.db_instance.customer_owned_ip_enabled #=> Boolean # # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/PromoteReadReplica AWS API Documentation # # @overload promote_read_replica(params = {}) # @param [Hash] params ({}) @@ -14508,10 +14555,11 @@ # resp.db_instance.tag_list #=> Array # resp.db_instance.tag_list[0].key #=> String # resp.db_instance.tag_list[0].value #=> String # resp.db_instance.db_instance_automated_backups_replications #=> Array # resp.db_instance.db_instance_automated_backups_replications[0].db_instance_automated_backups_arn #=> String + # resp.db_instance.customer_owned_ip_enabled #=> Boolean # # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RebootDBInstance AWS API Documentation # # @overload reboot_db_instance(params = {}) # @param [Hash] params ({}) @@ -16557,10 +16605,30 @@ # # # # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html # + # @option params [Boolean] :enable_customer_owned_ip + # A value that indicates whether to enable a customer-owned IP address + # (CoIP) for an RDS on Outposts DB instance. + # + # A *CoIP* provides local or external connectivity to resources in your + # Outpost subnets through your on-premises network. For some use cases, + # a CoIP can provide lower latency for connections to the DB instance + # from outside of its virtual private cloud (VPC) on your local network. + # + # For more information about RDS on Outposts, see [Working with Amazon + # RDS on AWS Outposts][1] in the *Amazon RDS User Guide*. + # + # For more information about CoIPs, see [Customer-owned IP addresses][2] + # in the *AWS Outposts User Guide*. + # + # + # + # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html + # [2]: https://docs.aws.amazon.com/outposts/latest/userguide/outposts-networking-components.html#ip-addressing + # # @return [Types::RestoreDBInstanceFromDBSnapshotResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::RestoreDBInstanceFromDBSnapshotResult#db_instance #db_instance} => Types::DBInstance # # @@ -16697,10 +16765,11 @@ # }, # ], # use_default_processor_features: false, # db_parameter_group_name: "String", # deletion_protection: false, + # enable_customer_owned_ip: false, # }) # # @example Response structure # # resp.db_instance.db_instance_identifier #=> String @@ -16823,10 +16892,11 @@ # resp.db_instance.tag_list #=> Array # resp.db_instance.tag_list[0].key #=> String # resp.db_instance.tag_list[0].value #=> String # resp.db_instance.db_instance_automated_backups_replications #=> Array # resp.db_instance.db_instance_automated_backups_replications[0].db_instance_automated_backups_arn #=> String + # resp.db_instance.customer_owned_ip_enabled #=> Boolean # # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RestoreDBInstanceFromDBSnapshot AWS API Documentation # # @overload restore_db_instance_from_db_snapshot(params = {}) # @param [Hash] params ({}) @@ -17392,10 +17462,11 @@ # resp.db_instance.tag_list #=> Array # resp.db_instance.tag_list[0].key #=> String # resp.db_instance.tag_list[0].value #=> String # resp.db_instance.db_instance_automated_backups_replications #=> Array # resp.db_instance.db_instance_automated_backups_replications[0].db_instance_automated_backups_arn #=> String + # resp.db_instance.customer_owned_ip_enabled #=> Boolean # # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RestoreDBInstanceFromS3 AWS API Documentation # # @overload restore_db_instance_from_s3(params = {}) # @param [Hash] params ({}) @@ -17716,10 +17787,30 @@ # @option params [String] :source_db_instance_automated_backups_arn # The Amazon Resource Name (ARN) of the replicated automated backups # from which to restore, for example, # `arn:aws:rds:useast-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE`. # + # @option params [Boolean] :enable_customer_owned_ip + # A value that indicates whether to enable a customer-owned IP address + # (CoIP) for an RDS on Outposts DB instance. + # + # A *CoIP* provides local or external connectivity to resources in your + # Outpost subnets through your on-premises network. For some use cases, + # a CoIP can provide lower latency for connections to the DB instance + # from outside of its virtual private cloud (VPC) on your local network. + # + # For more information about RDS on Outposts, see [Working with Amazon + # RDS on AWS Outposts][1] in the *Amazon RDS User Guide*. + # + # For more information about CoIPs, see [Customer-owned IP addresses][2] + # in the *AWS Outposts User Guide*. + # + # + # + # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html + # [2]: https://docs.aws.amazon.com/outposts/latest/userguide/outposts-networking-components.html#ip-addressing + # # @return [Types::RestoreDBInstanceToPointInTimeResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::RestoreDBInstanceToPointInTimeResult#db_instance #db_instance} => Types::DBInstance # # @@ -17862,10 +17953,11 @@ # db_parameter_group_name: "String", # deletion_protection: false, # source_dbi_resource_id: "String", # max_allocated_storage: 1, # source_db_instance_automated_backups_arn: "String", + # enable_customer_owned_ip: false, # }) # # @example Response structure # # resp.db_instance.db_instance_identifier #=> String @@ -17988,10 +18080,11 @@ # resp.db_instance.tag_list #=> Array # resp.db_instance.tag_list[0].key #=> String # resp.db_instance.tag_list[0].value #=> String # resp.db_instance.db_instance_automated_backups_replications #=> Array # resp.db_instance.db_instance_automated_backups_replications[0].db_instance_automated_backups_arn #=> String + # resp.db_instance.customer_owned_ip_enabled #=> Boolean # # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RestoreDBInstanceToPointInTime AWS API Documentation # # @overload restore_db_instance_to_point_in_time(params = {}) # @param [Hash] params ({}) @@ -18431,10 +18524,11 @@ # resp.db_instance.tag_list #=> Array # resp.db_instance.tag_list[0].key #=> String # resp.db_instance.tag_list[0].value #=> String # resp.db_instance.db_instance_automated_backups_replications #=> Array # resp.db_instance.db_instance_automated_backups_replications[0].db_instance_automated_backups_arn #=> String + # resp.db_instance.customer_owned_ip_enabled #=> Boolean # # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/StartDBInstance AWS API Documentation # # @overload start_db_instance(params = {}) # @param [Hash] params ({}) @@ -18993,10 +19087,11 @@ # resp.db_instance.tag_list #=> Array # resp.db_instance.tag_list[0].key #=> String # resp.db_instance.tag_list[0].value #=> String # resp.db_instance.db_instance_automated_backups_replications #=> Array # resp.db_instance.db_instance_automated_backups_replications[0].db_instance_automated_backups_arn #=> String + # resp.db_instance.customer_owned_ip_enabled #=> Boolean # # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/StopDBInstance AWS API Documentation # # @overload stop_db_instance(params = {}) # @param [Hash] params ({}) @@ -19080,10 +19175,10 @@ operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-rds' - context[:gem_version] = '1.108.0' + context[:gem_version] = '1.109.0' Seahorse::Client::Request.new(handlers, context) end # Polls an API operation until a resource enters a desired state. #