lib/aws-sdk-neptune/client.rb in aws-sdk-neptune-1.11.0 vs lib/aws-sdk-neptune/client.rb in aws-sdk-neptune-1.12.0
- old
+ new
@@ -197,10 +197,53 @@
#
# @option options [Boolean] :validate_params (true)
# When `true`, request parameters are validated before
# sending the request.
#
+ # @option options [URI::HTTP,String] :http_proxy A proxy to send
+ # requests through. Formatted like 'http://proxy.com:123'.
+ #
+ # @option options [Float] :http_open_timeout (15) The number of
+ # seconds to wait when opening a HTTP session before rasing a
+ # `Timeout::Error`.
+ #
+ # @option options [Integer] :http_read_timeout (60) The default
+ # number of seconds to wait for response data. This value can
+ # safely be set
+ # per-request on the session yeidled by {#session_for}.
+ #
+ # @option options [Float] :http_idle_timeout (5) The number of
+ # seconds a connection is allowed to sit idble before it is
+ # considered stale. Stale connections are closed and removed
+ # from the pool before making a request.
+ #
+ # @option options [Float] :http_continue_timeout (1) The number of
+ # seconds to wait for a 100-continue response before sending the
+ # request body. This option has no effect unless the request has
+ # "Expect" header set to "100-continue". Defaults to `nil` which
+ # disables this behaviour. This value can safely be set per
+ # request on the session yeidled by {#session_for}.
+ #
+ # @option options [Boolean] :http_wire_trace (false) When `true`,
+ # HTTP debug output will be sent to the `:logger`.
+ #
+ # @option options [Boolean] :ssl_verify_peer (true) When `true`,
+ # SSL peer certificates are verified when establishing a
+ # connection.
+ #
+ # @option options [String] :ssl_ca_bundle Full path to the SSL
+ # certificate authority bundle file that should be used when
+ # verifying peer certificates. If you do not pass
+ # `:ssl_ca_bundle` or `:ssl_ca_directory` the the system default
+ # will be used if available.
+ #
+ # @option options [String] :ssl_ca_directory Full path of the
+ # directory that contains the unbundled SSL certificate
+ # authority files for verifying peer certificates. If you do
+ # not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the
+ # system default will be used if available.
+ #
def initialize(*args)
super
end
# @!group API Operations
@@ -303,11 +346,11 @@
# an Amazon Resource Name (ARN). For information about creating an ARN,
# see [ Constructing an Amazon Resource Name (ARN)][1].
#
#
#
- # [1]: http://docs.aws.amazon.com/neptune/latest/UserGuide/tagging.ARN.html#tagging.ARN.Constructing
+ # [1]: https://docs.aws.amazon.com/neptune/latest/UserGuide/tagging.ARN.html#tagging.ARN.Constructing
#
# @option params [required, Array<Types::Tag>] :tags
# The tags to be assigned to the Amazon Neptune resource.
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
@@ -341,11 +384,11 @@
# maintenance action applies to. For information about creating an ARN,
# see [ Constructing an Amazon Resource Name (ARN)][1].
#
#
#
- # [1]: http://docs.aws.amazon.com/neptune/latest/UserGuide/tagging.ARN.html#tagging.ARN.Constructing
+ # [1]: https://docs.aws.amazon.com/neptune/latest/UserGuide/tagging.ARN.html#tagging.ARN.Constructing
#
# @option params [required, String] :apply_action
# The pending maintenance action to apply to this resource.
#
# Valid values: `system-update`, `db-upgrade`
@@ -416,11 +459,11 @@
# example
# `arn:aws:rds:us-east-1:123456789012:cluster-pg:custom-cluster-group1`.
#
#
#
- # [1]: http://docs.aws.amazon.com/neptune/latest/UserGuide/tagging.ARN.html#tagging.ARN.Constructing
+ # [1]: https://docs.aws.amazon.com/neptune/latest/UserGuide/tagging.ARN.html#tagging.ARN.Constructing
#
# @option params [required, String] :target_db_cluster_parameter_group_identifier
# The identifier for the copied DB cluster parameter group.
#
# Constraints:
@@ -437,17 +480,12 @@
#
# @option params [required, String] :target_db_cluster_parameter_group_description
# A description for the copied DB cluster parameter group.
#
# @option params [Array<Types::Tag>] :tags
- # A list of tags. For more information, see [Tagging Amazon Neptune
- # Resources][1].
+ # The tags to be assigned to the copied DB cluster parameter group.
#
- #
- #
- # [1]: http://docs.aws.amazon.com/neptune/latest/UserGuide/tagging.ARN.html
- #
# @return [Types::CopyDBClusterParameterGroupResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::CopyDBClusterParameterGroupResult#db_cluster_parameter_group #db_cluster_parameter_group} => Types::DBClusterParameterGroup
#
# @example Request syntax with placeholder values
@@ -484,89 +522,24 @@
#
# To copy a DB cluster snapshot from a shared manual DB cluster
# snapshot, `SourceDBClusterSnapshotIdentifier` must be the Amazon
# Resource Name (ARN) of the shared DB cluster snapshot.
#
- # You can copy an encrypted DB cluster snapshot from another AWS Region.
- # In that case, the AWS Region where you call the
- # `CopyDBClusterSnapshot` action is the destination AWS Region for the
- # encrypted DB cluster snapshot to be copied to. To copy an encrypted DB
- # cluster snapshot from another AWS Region, you must provide the
- # following values:
+ # You can't copy from one AWS Region to another.
#
- # * `KmsKeyId` - The AWS Key Management System (AWS KMS) key identifier
- # for the key to use to encrypt the copy of the DB cluster snapshot in
- # the destination AWS Region.
- #
- # * `PreSignedUrl` - A URL that contains a Signature Version 4 signed
- # request for the `CopyDBClusterSnapshot` action to be called in the
- # source AWS Region where the DB cluster snapshot is copied from. The
- # pre-signed URL must be a valid request for the
- # `CopyDBClusterSnapshot` API action that can be executed in the
- # source AWS Region that contains the encrypted DB cluster snapshot to
- # be copied.
- #
- # The pre-signed URL request must contain the following parameter
- # values:
- #
- # * `KmsKeyId` - The KMS key identifier for the key to use to encrypt
- # the copy of the DB cluster snapshot in the destination AWS Region.
- # This is the same identifier for both the `CopyDBClusterSnapshot`
- # action that is called in the destination AWS Region, and the
- # action contained in the pre-signed URL.
- #
- # * `DestinationRegion` - The name of the AWS Region that the DB
- # cluster snapshot will be created in.
- #
- # * `SourceDBClusterSnapshotIdentifier` - The DB cluster snapshot
- # identifier for the encrypted DB cluster snapshot to be copied.
- # This identifier must be in the Amazon Resource Name (ARN) format
- # for the source AWS Region. For example, if you are copying an
- # encrypted DB cluster snapshot from the us-west-2 AWS Region, then
- # your `SourceDBClusterSnapshotIdentifier` looks like the following
- # example:
- # `arn:aws:rds:us-west-2:123456789012:cluster-snapshot:neptune-cluster1-snapshot-20161115`.
- #
- # To learn how to generate a Signature Version 4 signed request, see [
- # Authenticating Requests: Using Query Parameters (AWS Signature
- # Version 4)][1] and [ Signature Version 4 Signing Process][2].
- #
- # * `TargetDBClusterSnapshotIdentifier` - The identifier for the new
- # copy of the DB cluster snapshot in the destination AWS Region.
- #
- # * `SourceDBClusterSnapshotIdentifier` - The DB cluster snapshot
- # identifier for the encrypted DB cluster snapshot to be copied. This
- # identifier must be in the ARN format for the source AWS Region and
- # is the same value as the `SourceDBClusterSnapshotIdentifier` in the
- # pre-signed URL.
- #
- # To cancel the copy operation once it is in progress, delete the target
- # DB cluster snapshot identified by `TargetDBClusterSnapshotIdentifier`
- # while that DB cluster snapshot is in "copying" status.
- #
- #
- #
- # [1]: http://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html
- # [2]: http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html
- #
# @option params [required, String] :source_db_cluster_snapshot_identifier
# The identifier of the DB cluster snapshot to copy. This parameter is
# not case-sensitive.
#
- # You can't copy an encrypted, shared DB cluster snapshot from one AWS
- # Region to another.
+ # You can't copy from one AWS Region to another.
#
# Constraints:
#
# * Must specify a valid system snapshot in the "available" state.
#
- # * If the source snapshot is in the same AWS Region as the copy,
- # specify a valid DB snapshot identifier.
+ # * Specify a valid DB snapshot identifier.
#
- # * If the source snapshot is in a different AWS Region than the copy,
- # specify a valid DB cluster snapshot ARN.
- #
# Example: `my-cluster-snapshot1`
#
# @option params [required, String] :target_db_cluster_snapshot_identifier
# The identifier of the new DB cluster snapshot to create from the
# source DB cluster snapshot. This parameter is not case-sensitive.
@@ -597,69 +570,24 @@
# as the source DB cluster snapshot.
#
# If you copy an encrypted DB cluster snapshot that is shared from
# another AWS account, then you must specify a value for `KmsKeyId`.
#
- # To copy an encrypted DB cluster snapshot to another AWS Region, you
- # must set `KmsKeyId` to the KMS key ID you want to use to encrypt the
- # copy of the DB cluster snapshot in the destination AWS Region. KMS
- # encryption keys are specific to the AWS Region that they are created
- # in, and you can't use encryption keys from one AWS Region in another
- # AWS Region.
+ # KMS encryption keys are specific to the AWS Region that they are
+ # created in, and you can't use encryption keys from one AWS Region in
+ # another AWS Region.
#
# @option params [String] :pre_signed_url
- # The URL that contains a Signature Version 4 signed request for the
- # `CopyDBClusterSnapshot` API action in the AWS Region that contains the
- # source DB cluster snapshot to copy. The `PreSignedUrl` parameter must
- # be used when copying an encrypted DB cluster snapshot from another AWS
- # Region.
+ # Not currently supported.
#
- # The pre-signed URL must be a valid request for the
- # `CopyDBSClusterSnapshot` API action that can be executed in the source
- # AWS Region that contains the encrypted DB cluster snapshot to be
- # copied. The pre-signed URL request must contain the following
- # parameter values:
- #
- # * `KmsKeyId` - The AWS KMS key identifier for the key to use to
- # encrypt the copy of the DB cluster snapshot in the destination AWS
- # Region. This is the same identifier for both the
- # `CopyDBClusterSnapshot` action that is called in the destination AWS
- # Region, and the action contained in the pre-signed URL.
- #
- # * `DestinationRegion` - The name of the AWS Region that the DB cluster
- # snapshot will be created in.
- #
- # * `SourceDBClusterSnapshotIdentifier` - The DB cluster snapshot
- # identifier for the encrypted DB cluster snapshot to be copied. This
- # identifier must be in the Amazon Resource Name (ARN) format for the
- # source AWS Region. For example, if you are copying an encrypted DB
- # cluster snapshot from the us-west-2 AWS Region, then your
- # `SourceDBClusterSnapshotIdentifier` looks like the following
- # example:
- # `arn:aws:rds:us-west-2:123456789012:cluster-snapshot:neptune-cluster1-snapshot-20161115`.
- #
- # To learn how to generate a Signature Version 4 signed request, see [
- # Authenticating Requests: Using Query Parameters (AWS Signature Version
- # 4)][1] and [ Signature Version 4 Signing Process][2].
- #
- #
- #
- # [1]: http://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html
- # [2]: http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html
- #
# @option params [Boolean] :copy_tags
# True to copy all tags from the source DB cluster snapshot to the
# target DB cluster snapshot, and otherwise false. The default is false.
#
# @option params [Array<Types::Tag>] :tags
- # A list of tags. For more information, see [Tagging Amazon Neptune
- # Resources][1].
+ # The tags to assign to the new DB cluster snapshot copy.
#
- #
- #
- # [1]: http://docs.aws.amazon.com/neptune/latest/UserGuide/tagging.ARN.html
- #
# @return [Types::CopyDBClusterSnapshotResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::CopyDBClusterSnapshotResult#db_cluster_snapshot #db_cluster_snapshot} => Types::DBClusterSnapshot
#
# @example Request syntax with placeholder values
@@ -725,38 +653,33 @@
# * Must specify a valid DB parameter group identifier, for example
# `my-db-param-group`, or a valid ARN.
#
#
#
- # [1]: http://docs.aws.amazon.com/neptune/latest/UserGuide/tagging.ARN.html#tagging.ARN.Constructing
+ # [1]: https://docs.aws.amazon.com/neptune/latest/UserGuide/tagging.ARN.html#tagging.ARN.Constructing
#
# @option params [required, String] :target_db_parameter_group_identifier
# The identifier for the copied DB parameter group.
#
# Constraints:
#
- # * Cannot be null, empty, or blank
+ # * Cannot be null, empty, or blank.
#
- # * Must contain from 1 to 255 letters, numbers, or hyphens
+ # * Must contain from 1 to 255 letters, numbers, or hyphens.
#
- # * First character must be a letter
+ # * First character must be a letter.
#
- # * Cannot end with a hyphen or contain two consecutive hyphens
+ # * Cannot end with a hyphen or contain two consecutive hyphens.
#
# Example: `my-db-parameter-group`
#
# @option params [required, String] :target_db_parameter_group_description
# A description for the copied DB parameter group.
#
# @option params [Array<Types::Tag>] :tags
- # A list of tags. For more information, see [Tagging Amazon Neptune
- # Resources][1].
+ # The tags to be assigned to the copied DB parameter group.
#
- #
- #
- # [1]: http://docs.aws.amazon.com/neptune/latest/UserGuide/tagging.ARN.html
- #
# @return [Types::CopyDBParameterGroupResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::CopyDBParameterGroupResult#db_parameter_group #db_parameter_group} => Types::DBParameterGroup
#
# @example Request syntax with placeholder values
@@ -791,13 +714,11 @@
# Creates a new Amazon Neptune DB cluster.
#
# You can use the `ReplicationSourceIdentifier` parameter to create the
# DB cluster as a Read Replica of another DB cluster or Amazon Neptune
- # DB instance. For cross-region replication where the DB cluster
- # identified by `ReplicationSourceIdentifier` is encrypted, you must
- # also specify the `PreSignedUrl` parameter.
+ # DB instance.
#
# @option params [Array<String>] :availability_zones
# A list of EC2 Availability Zones that instances in the DB cluster can
# be created in.
#
@@ -919,11 +840,11 @@
#
# * Must be at least 30 minutes.
#
#
#
- # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/AdjustingTheMaintenanceWindow.html
+ # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/AdjustingTheMaintenanceWindow.html
#
# @option params [String] :preferred_maintenance_window
# The weekly time range during which system maintenance can occur, in
# Universal Coordinated Time (UTC).
#
@@ -938,24 +859,19 @@
#
# Constraints: Minimum 30-minute window.
#
#
#
- # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/AdjustingTheMaintenanceWindow.html
+ # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/AdjustingTheMaintenanceWindow.html
#
# @option params [String] :replication_source_identifier
# The Amazon Resource Name (ARN) of the source DB instance or DB cluster
# if this DB cluster is created as a Read Replica.
#
# @option params [Array<Types::Tag>] :tags
- # A list of tags. For more information, see [Tagging Amazon Neptune
- # Resources][1].
+ # The tags to assign to the new DB cluster.
#
- #
- #
- # [1]: http://docs.aws.amazon.com/neptune/latest/UserGuide/tagging.ARN.html
- #
# @option params [Boolean] :storage_encrypted
# Specifies whether the DB cluster is encrypted.
#
# @option params [String] :kms_key_id
# The AWS KMS key identifier for an encrypted DB cluster.
@@ -985,49 +901,12 @@
# Region, you must set `KmsKeyId` to a KMS key ID that is valid in the
# destination AWS Region. This key is used to encrypt the Read Replica
# in that AWS Region.
#
# @option params [String] :pre_signed_url
- # A URL that contains a Signature Version 4 signed request for the
- # `CreateDBCluster` action to be called in the source AWS Region where
- # the DB cluster is replicated from. You only need to specify
- # `PreSignedUrl` when you are performing cross-region replication from
- # an encrypted DB cluster.
+ # This parameter is not currently supported.
#
- # The pre-signed URL must be a valid request for the `CreateDBCluster`
- # API action that can be executed in the source AWS Region that contains
- # the encrypted DB cluster to be copied.
- #
- # The pre-signed URL request must contain the following parameter
- # values:
- #
- # * `KmsKeyId` - The AWS KMS key identifier for the key to use to
- # encrypt the copy of the DB cluster in the destination AWS Region.
- # This should refer to the same KMS key for both the `CreateDBCluster`
- # action that is called in the destination AWS Region, and the action
- # contained in the pre-signed URL.
- #
- # * `DestinationRegion` - The name of the AWS Region that Read Replica
- # will be created in.
- #
- # * `ReplicationSourceIdentifier` - The DB cluster identifier for the
- # encrypted DB cluster to be copied. This identifier must be in the
- # Amazon Resource Name (ARN) format for the source AWS Region. For
- # example, if you are copying an encrypted DB cluster from the
- # us-west-2 AWS Region, then your `ReplicationSourceIdentifier` would
- # look like Example:
- # `arn:aws:rds:us-west-2:123456789012:cluster:neptune-cluster1`.
- #
- # To learn how to generate a Signature Version 4 signed request, see [
- # Authenticating Requests: Using Query Parameters (AWS Signature Version
- # 4)][1] and [ Signature Version 4 Signing Process][2].
- #
- #
- #
- # [1]: http://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html
- # [2]: http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html
- #
# @option params [Boolean] :enable_iam_database_authentication
# True to enable mapping of AWS Identity and Access Management (IAM)
# accounts to database accounts, and otherwise false.
#
# Default: `false`
@@ -1182,17 +1061,12 @@
#
# @option params [required, String] :description
# The description for the DB cluster parameter group.
#
# @option params [Array<Types::Tag>] :tags
- # A list of tags. For more information, see [Tagging Amazon Neptune
- # Resources][1].
+ # The tags to be assigned to the new DB cluster parameter group.
#
- #
- #
- # [1]: http://docs.aws.amazon.com/neptune/latest/UserGuide/tagging.ARN.html
- #
# @return [Types::CreateDBClusterParameterGroupResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::CreateDBClusterParameterGroupResult#db_cluster_parameter_group #db_cluster_parameter_group} => Types::DBClusterParameterGroup
#
# @example Request syntax with placeholder values
@@ -1307,14 +1181,12 @@
end
# Creates a new DB instance.
#
# @option params [String] :db_name
- # The database name.
+ # Not supported.
#
- # Type: String
- #
# @option params [required, String] :db_instance_identifier
# The DB instance identifier. This parameter is stored as a lowercase
# string.
#
# Constraints:
@@ -1368,11 +1240,11 @@
#
# Default: The default EC2 VPC security group for the DB subnet group's
# VPC.
#
# @option params [String] :availability_zone
- # The EC2 Availability Zone that the DB instance is created in.
+ # The EC2 Availability Zone that the DB instance is created in
#
# Default: A random, system-chosen Availability Zone in the endpoint's
# AWS Region.
#
# Example: `us-east-1d`
@@ -1482,20 +1354,15 @@
#
# Not applicable. The character set is managed by the DB cluster. For
# more information, see CreateDBCluster.
#
# @option params [Boolean] :publicly_accessible
- # This parameter is not supported.
+ # This flag should no longer be used.
#
# @option params [Array<Types::Tag>] :tags
- # A list of tags. For more information, see [Tagging Amazon Neptune
- # Resources][1].
+ # The tags to assign to the new instance.
#
- #
- #
- # [1]: http://docs.aws.amazon.com/neptune/latest/UserGuide/tagging.ARN.html
- #
# @option params [String] :db_cluster_identifier
# The identifier of the DB cluster that the instance will belong to.
#
# For information on creating a DB cluster, see CreateDBCluster.
#
@@ -1812,17 +1679,12 @@
#
# @option params [required, String] :description
# The description for the DB parameter group.
#
# @option params [Array<Types::Tag>] :tags
- # A list of tags. For more information, see [Tagging Amazon Neptune
- # Resources][1].
+ # The tags to be assigned to the new DB parameter group.
#
- #
- #
- # [1]: http://docs.aws.amazon.com/neptune/latest/UserGuide/tagging.ARN.html
- #
# @return [Types::CreateDBParameterGroupResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::CreateDBParameterGroupResult#db_parameter_group #db_parameter_group} => Types::DBParameterGroup
#
# @example Request syntax with placeholder values
@@ -1872,17 +1734,12 @@
#
# @option params [required, Array<String>] :subnet_ids
# The EC2 Subnet IDs for the DB subnet group.
#
# @option params [Array<Types::Tag>] :tags
- # A list of tags. For more information, see [Tagging Amazon Neptune
- # Resources][1].
+ # The tags to be assigned to the new DB subnet group.
#
- #
- #
- # [1]: http://docs.aws.amazon.com/neptune/latest/UserGuide/tagging.ARN.html
- #
# @return [Types::CreateDBSubnetGroupResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::CreateDBSubnetGroupResult#db_subnet_group #db_subnet_group} => Types::DBSubnetGroup
#
# @example Request syntax with placeholder values
@@ -1992,17 +1849,12 @@
# @option params [Boolean] :enabled
# A Boolean value; set to **true** to activate the subscription, set to
# **false** to create the subscription but not active it.
#
# @option params [Array<Types::Tag>] :tags
- # A list of tags. For more information, see [Tagging Amazon Neptune
- # Resources][1].
+ # The tags to be applied to the new event subscription.
#
- #
- #
- # [1]: http://docs.aws.amazon.com/neptune/latest/UserGuide/tagging.ARN.html
- #
# @return [Types::CreateEventSubscriptionResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::CreateEventSubscriptionResult#event_subscription #event_subscription} => Types::EventSubscription
#
# @example Request syntax with placeholder values
@@ -2268,19 +2120,13 @@
# `true`.
#
# If the specified DB instance is part of a DB cluster, you can't
# delete the DB instance if both of the following conditions are true:
#
- # * The DB cluster is a Read Replica of another DB cluster.
- #
# * The DB instance is the only instance in the DB cluster.
#
- # To delete a DB instance in this case, first call the
- # PromoteReadReplicaDBCluster API action to promote the DB cluster so
- # it's no longer a Read Replica. After the promotion completes, then
- # call the `DeleteDBInstance` API action to delete the final instance in
- # the DB cluster.
+ # ^
#
# @option params [required, String] :db_instance_identifier
# The DB instance identifier for the DB instance to be deleted. This
# parameter isn't case-sensitive.
#
@@ -4244,11 +4090,11 @@
# Amazon Resource Name (ARN). For information about creating an ARN, see
# [ Constructing an Amazon Resource Name (ARN)][1].
#
#
#
- # [1]: http://docs.aws.amazon.com/neptune/latest/UserGuide/tagging.ARN.html#tagging.ARN.Constructing
+ # [1]: https://docs.aws.amazon.com/neptune/latest/UserGuide/tagging.ARN.html#tagging.ARN.Constructing
#
# @option params [Array<Types::Filter>] :filters
# This parameter is not currently supported.
#
# @return [Types::TagListMessage] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
@@ -4730,17 +4576,12 @@
# or the next failure reboot.
#
# Default: `false`
#
# @option params [String] :master_user_password
- # The new password for the master user. The password can include any
- # printable ASCII character except "/", """, or "@".
- #
# Not applicable.
#
- # Default: Uses existing setting
- #
# @option params [String] :db_parameter_group_name
# The name of the DB parameter group to apply to the DB instance.
# Changing this setting doesn't result in an outage. The parameter
# group name itself is changed immediately, but the actual parameter
# changes are not applied until you reboot the instance without
@@ -4752,14 +4593,10 @@
#
# Constraints: The DB parameter group must be in the same DB parameter
# group family as this DB instance.
#
# @option params [Integer] :backup_retention_period
- # The number of days to retain automated backups. Setting this parameter
- # to a positive number enables backups. Setting this parameter to 0
- # disables automated backups.
- #
# Not applicable. The retention period for automated backups is managed
# by the DB cluster. For more information, see ModifyDBCluster.
#
# Default: Uses existing setting
#
@@ -4833,15 +4670,12 @@
# result if this parameter is set to `true` during the maintenance
# window, and a newer minor version is available, and Neptune has
# enabled auto patching for that engine version.
#
# @option params [String] :license_model
- # The license model for the DB instance.
+ # Not supported.
#
- # Valid values: `license-included` \| `bring-your-own-license` \|
- # `general-public-license`
- #
# @option params [Integer] :iops
# The new Provisioned IOPS (I/O operations per second) value for the
# instance.
#
# Changing this setting doesn't result in an outage and the change is
@@ -4881,36 +4715,12 @@
# * Cannot end with a hyphen or contain two consecutive hyphens.
#
# Example: `mydbinstance`
#
# @option params [String] :storage_type
- # Specifies the storage type to be associated with the DB instance.
+ # Not supported.
#
- # If you specify Provisioned IOPS (`io1`), you must also include a value
- # for the `Iops` parameter.
- #
- # If you choose to migrate your DB instance from using standard storage
- # to using Provisioned IOPS, or from using Provisioned IOPS to using
- # standard storage, the process can take time. The duration of the
- # migration depends on several factors such as database load, storage
- # size, storage type (standard or Provisioned IOPS), amount of IOPS
- # provisioned (if any), and the number of prior scale storage
- # operations. Typical migration times are under 24 hours, but the
- # process can take up to several days in some cases. During the
- # migration, the DB instance is available for use, but might experience
- # performance degradation. While the migration takes place, nightly
- # backups for the instance are suspended. No other Amazon Neptune
- # operations can take place for the instance, including modifying the
- # instance, rebooting the instance, deleting the instance, creating a
- # Read Replica for the instance, and creating a DB snapshot of the
- # instance.
- #
- # Valid values: `standard | gp2 | io1`
- #
- # Default: `io1` if the `Iops` parameter is specified, otherwise
- # `standard`
- #
# @option params [String] :tde_credential_arn
# The ARN from the key store with which to associate the instance for
# TDE encryption.
#
# @option params [String] :tde_credential_password
@@ -4949,11 +4759,11 @@
# regardless of the value of the `ApplyImmediately` parameter.
#
# Default: `8182`
#
# @option params [Boolean] :publicly_accessible
- # This parameter is not supported.
+ # This flag should no longer be used.
#
# @option params [String] :monitoring_role_arn
# The ARN for the IAM role that permits Neptune to send enhanced
# monitoring metrics to Amazon CloudWatch Logs. For example,
# `arn:aws:iam:123456789012:role/emaccess`.
@@ -4984,17 +4794,14 @@
# managed by the DB cluster. For more information, see ModifyDBCluster.
#
# Default: `false`
#
# @option params [Boolean] :enable_performance_insights
- # True to enable Performance Insights for the DB instance, and otherwise
- # false.
+ # Not supported.
#
# @option params [String] :performance_insights_kms_key_id
- # The AWS KMS key identifier for encryption of Performance Insights
- # data. The KMS key ID is the Amazon Resource Name (ARN), KMS key
- # identifier, or the KMS key alias for the KMS encryption key.
+ # Not supported.
#
# @option params [Types::CloudwatchLogsExportConfiguration] :cloudwatch_logs_export_configuration
# The configuration setting for the log types to be enabled for export
# to CloudWatch Logs for a specific DB instance or DB cluster.
#
@@ -5361,24 +5168,15 @@
def modify_event_subscription(params = {}, options = {})
req = build_request(:modify_event_subscription, params)
req.send_request(options)
end
- # Promotes a Read Replica DB cluster to a standalone DB cluster.
+ # Not supported.
#
# @option params [required, String] :db_cluster_identifier
- # The identifier of the DB cluster Read Replica to promote. This
- # parameter is not case-sensitive.
+ # Not supported.
#
- # Constraints:
- #
- # * Must match the identifier of an existing DBCluster Read Replica.
- #
- # ^
- #
- # Example: `my-cluster-replica1`
- #
# @return [Types::PromoteReadReplicaDBClusterResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::PromoteReadReplicaDBClusterResult#db_cluster #db_cluster} => Types::DBCluster
#
# @example Request syntax with placeholder values
@@ -5674,11 +5472,11 @@
# is an Amazon Resource Name (ARN). For information about creating an
# ARN, see [ Constructing an Amazon Resource Name (ARN)][1].
#
#
#
- # [1]: http://docs.aws.amazon.com/neptune/latest/UserGuide/tagging.ARN.html#tagging.ARN.Constructing
+ # [1]: https://docs.aws.amazon.com/neptune/latest/UserGuide/tagging.ARN.html#tagging.ARN.Constructing
#
# @option params [required, Array<String>] :tag_keys
# The tag key (name) of the tag to be removed.
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
@@ -5901,11 +5699,11 @@
# DBSubnetGroup.
#
# Example: `mySubnetgroup`
#
# @option params [String] :database_name
- # The database name for the restored DB cluster.
+ # Not supported.
#
# @option params [String] :option_group_name
# The name of the option group to use for the restored DB cluster.
#
# @option params [Array<String>] :vpc_security_group_ids
@@ -5938,10 +5736,21 @@
# True to enable mapping of AWS Identity and Access Management (IAM)
# accounts to database accounts, and otherwise false.
#
# Default: `false`
#
+ # @option params [String] :db_cluster_parameter_group_name
+ # The name of the DB cluster parameter group to associate with the new
+ # DB cluster.
+ #
+ # Constraints:
+ #
+ # * If supplied, must match the name of an existing
+ # DBClusterParameterGroup.
+ #
+ # ^
+ #
# @return [Types::RestoreDBClusterFromSnapshotResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::RestoreDBClusterFromSnapshotResult#db_cluster #db_cluster} => Types::DBCluster
#
# @example Request syntax with placeholder values
@@ -5963,10 +5772,11 @@
# value: "String",
# },
# ],
# kms_key_id: "String",
# enable_iam_database_authentication: false,
+ # db_cluster_parameter_group_name: "String",
# })
#
# @example Response structure
#
# resp.db_cluster.allocated_storage #=> Integer
@@ -6052,25 +5862,13 @@
# * First character must be a letter
#
# * Cannot end with a hyphen or contain two consecutive hyphens
#
# @option params [String] :restore_type
- # The type of restore to be performed. You can specify one of the
- # following values:
+ # The type of restore to be performed. The only type of restore
+ # currently supported is `full-copy` (the default).
#
- # * `full-copy` - The new DB cluster is restored as a full copy of the
- # source DB cluster.
- #
- # * `copy-on-write` - The new DB cluster is restored as a clone of the
- # source DB cluster.
- #
- # Constraints: You can't specify `copy-on-write` if the engine version
- # of the source DB cluster is earlier than 1.11.
- #
- # If you don't specify a `RestoreType` value, then the new DB cluster
- # is restored as a full copy of the source DB cluster.
- #
# @option params [required, String] :source_db_cluster_identifier
# The identifier of the source DB cluster from which to restore.
#
# Constraints:
#
@@ -6126,17 +5924,12 @@
#
# @option params [Array<String>] :vpc_security_group_ids
# A list of VPC security groups that the new DB cluster belongs to.
#
# @option params [Array<Types::Tag>] :tags
- # A list of tags. For more information, see [Tagging Amazon Neptune
- # Resources][1].
+ # The tags to be applied to the restored DB cluster.
#
- #
- #
- # [1]: http://docs.aws.amazon.com/neptune/latest/UserGuide/tagging.ARN.html
- #
# @option params [String] :kms_key_id
# The AWS KMS key identifier to use when restoring an encrypted DB
# cluster from an encrypted DB cluster.
#
# The KMS key identifier is the Amazon Resource Name (ARN) for the KMS
@@ -6167,10 +5960,21 @@
# True to enable mapping of AWS Identity and Access Management (IAM)
# accounts to database accounts, and otherwise false.
#
# Default: `false`
#
+ # @option params [String] :db_cluster_parameter_group_name
+ # The name of the DB cluster parameter group to associate with the new
+ # DB cluster.
+ #
+ # Constraints:
+ #
+ # * If supplied, must match the name of an existing
+ # DBClusterParameterGroup.
+ #
+ # ^
+ #
# @return [Types::RestoreDBClusterToPointInTimeResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::RestoreDBClusterToPointInTimeResult#db_cluster #db_cluster} => Types::DBCluster
#
# @example Request syntax with placeholder values
@@ -6191,10 +5995,11 @@
# value: "String",
# },
# ],
# kms_key_id: "String",
# enable_iam_database_authentication: false,
+ # db_cluster_parameter_group_name: "String",
# })
#
# @example Response structure
#
# resp.db_cluster.allocated_storage #=> Integer
@@ -6265,10 +6070,10 @@
operation: config.api.operation(operation_name),
client: self,
params: params,
config: config)
context[:gem_name] = 'aws-sdk-neptune'
- context[:gem_version] = '1.11.0'
+ context[:gem_version] = '1.12.0'
Seahorse::Client::Request.new(handlers, context)
end
# Polls an API operation until a resource enters a desired state.
#