lib/aws-sdk-neptune/client.rb in aws-sdk-neptune-1.19.0 vs lib/aws-sdk-neptune/client.rb in aws-sdk-neptune-1.20.0

- old
+ new

@@ -563,14 +563,10 @@ # @option params [String] :kms_key_id # The AWS AWS KMS key ID for an encrypted DB cluster snapshot. The KMS # key ID is the Amazon Resource Name (ARN), KMS key identifier, or the # KMS key alias for the KMS encryption key. # - # If you copy an unencrypted DB cluster snapshot and specify a value for - # the `KmsKeyId` parameter, Amazon Neptune encrypts the target DB - # cluster snapshot using the specified KMS encryption key. - # # If you copy an encrypted DB cluster snapshot from your AWS account, # you can specify a value for `KmsKeyId` to encrypt the copy with a new # KMS encryption key. If you don't specify a value for `KmsKeyId`, then # the copy of the DB cluster snapshot is encrypted with the same KMS key # as the source DB cluster snapshot. @@ -580,10 +576,14 @@ # # 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. # + # You cannot encrypt an unencrypted DB cluster snapshot when you copy + # it. If you try to copy an unencrypted DB cluster snapshot and specify + # a value for the KmsKeyId parameter, an error is returned. + # # @option params [String] :pre_signed_url # Not currently supported. # # @option params [Boolean] :copy_tags # True to copy all tags from the source DB cluster snapshot to the @@ -739,12 +739,11 @@ # * Must be a value from 1 to 35 # # ^ # # @option params [String] :character_set_name - # A value that indicates that the DB cluster should be associated with - # the specified CharacterSet. + # *(Not supported by Neptune)* # # @option params [String] :database_name # The name for your database of up to 64 alpha-numeric characters. If # you do not provide a name, Amazon Neptune will not create a database # in the DB cluster you are creating. @@ -789,11 +788,12 @@ # The name of the database engine to be used for this DB cluster. # # Valid Values: `neptune` # # @option params [String] :engine_version - # The version number of the database engine to use. + # The version number of the database engine to use. Currently, setting + # this parameter has no effect. # # Example: `1.0.1` # # @option params [Integer] :port # The port number on which the instances in the DB cluster accept @@ -817,17 +817,12 @@ # any printable ASCII character except "/", """, or "@". # # Constraints: Must contain from 8 to 41 characters. # # @option params [String] :option_group_name - # A value that indicates that the DB cluster should be associated with - # the specified option group. + # *(Not supported by Neptune)* # - # Permanent options can't be removed from an option group. The option - # group can't be removed from a DB cluster once it is associated with a - # DB cluster. - # # @option params [String] :preferred_backup_window # The daily time range during which automated backups are created if # automated backups are enabled using the `BackupRetentionPeriod` # parameter. # @@ -919,10 +914,15 @@ # # @option params [Array<String>] :enable_cloudwatch_logs_exports # The list of log types that need to be enabled for exporting to # CloudWatch Logs. # + # @option params [Boolean] :deletion_protection + # A value that indicates whether the DB cluster has deletion protection + # enabled. The database can't be deleted when deletion protection is + # enabled. By default, deletion protection is disabled. + # # @return [Types::CreateDBClusterResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CreateDBClusterResult#db_cluster #db_cluster} => Types::DBCluster # # @example Request syntax with placeholder values @@ -954,10 +954,11 @@ # storage_encrypted: false, # kms_key_id: "String", # pre_signed_url: "String", # enable_iam_database_authentication: false, # enable_cloudwatch_logs_exports: ["String"], + # deletion_protection: false, # }) # # @example Response structure # # resp.db_cluster.allocated_storage #=> Integer @@ -1007,10 +1008,11 @@ # resp.db_cluster.iam_database_authentication_enabled #=> Boolean # resp.db_cluster.clone_group_id #=> String # resp.db_cluster.cluster_create_time #=> Time # resp.db_cluster.enabled_cloudwatch_logs_exports #=> Array # resp.db_cluster.enabled_cloudwatch_logs_exports[0] #=> String + # resp.db_cluster.deletion_protection #=> Boolean # # @see http://docs.aws.amazon.com/goto/WebAPI/neptune-2014-10-31/CreateDBCluster AWS API Documentation # # @overload create_db_cluster(params = {}) # @param [Hash] params ({}) @@ -1332,11 +1334,12 @@ # Specifies if the DB instance is a Multi-AZ deployment. You can't set # the AvailabilityZone parameter if the MultiAZ parameter is set to # true. # # @option params [String] :engine_version - # The version number of the database engine to use. + # The version number of the database engine to use. Currently, setting + # this parameter has no effect. # # @option params [Boolean] :auto_minor_version_upgrade # Indicates that minor engine upgrades are applied automatically to the # DB instance during the maintenance window. # @@ -1351,25 +1354,15 @@ # @option params [Integer] :iops # The amount of Provisioned IOPS (input/output operations per second) to # be initially allocated for the DB instance. # # @option params [String] :option_group_name - # Indicates that the DB instance should be associated with the specified - # option group. + # *(Not supported by Neptune)* # - # Permanent options, such as the TDE option for Oracle Advanced Security - # TDE, can't be removed from an option group, and that option group - # can't be removed from a DB instance once it is associated with a DB - # instance - # # @option params [String] :character_set_name - # Indicates that the DB instance should be associated with the specified - # CharacterSet. + # *(Not supported by Neptune)* # - # Not applicable. The character set is managed by the DB cluster. For - # more information, see CreateDBCluster. - # # @option params [Boolean] :publicly_accessible # This flag should no longer be used. # # @option params [Array<Types::Tag>] :tags # The tags to assign to the new instance. @@ -1466,22 +1459,29 @@ # for Neptune. # # Default: `false` # # @option params [Boolean] :enable_performance_insights - # True to enable Performance Insights for the DB instance, and otherwise - # false. + # *(Not supported by Neptune)* # # @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 by Neptune)* # # @option params [Array<String>] :enable_cloudwatch_logs_exports # The list of log types that need to be enabled for exporting to # CloudWatch Logs. # + # @option params [Boolean] :deletion_protection + # A value that indicates whether the DB instance has deletion protection + # enabled. The database can't be deleted when deletion protection is + # enabled. By default, deletion protection is disabled. + # + # You can enable or disable deletion protection for the DB cluster. For + # more information, see CreateDBCluster. DB instances in a DB cluster + # can be deleted even when deletion protection is enabled for the DB + # cluster. + # # @return [Types::CreateDBInstanceResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CreateDBInstanceResult#db_instance #db_instance} => Types::DBInstance # # @example Request syntax with placeholder values @@ -1532,10 +1532,11 @@ # timezone: "String", # enable_iam_database_authentication: false, # enable_performance_insights: false, # performance_insights_kms_key_id: "String", # enable_cloudwatch_logs_exports: ["String"], + # deletion_protection: false, # }) # # @example Response structure # # resp.db_instance.db_instance_identifier #=> String @@ -1633,10 +1634,11 @@ # resp.db_instance.iam_database_authentication_enabled #=> Boolean # resp.db_instance.performance_insights_enabled #=> Boolean # resp.db_instance.performance_insights_kms_key_id #=> String # resp.db_instance.enabled_cloudwatch_logs_exports #=> Array # resp.db_instance.enabled_cloudwatch_logs_exports[0] #=> String + # resp.db_instance.deletion_protection #=> Boolean # # @see http://docs.aws.amazon.com/goto/WebAPI/neptune-2014-10-31/CreateDBInstance AWS API Documentation # # @overload create_db_instance(params = {}) # @param [Hash] params ({}) @@ -2017,10 +2019,11 @@ # resp.db_cluster.iam_database_authentication_enabled #=> Boolean # resp.db_cluster.clone_group_id #=> String # resp.db_cluster.cluster_create_time #=> Time # resp.db_cluster.enabled_cloudwatch_logs_exports #=> Array # resp.db_cluster.enabled_cloudwatch_logs_exports[0] #=> String + # resp.db_cluster.deletion_protection #=> Boolean # # @see http://docs.aws.amazon.com/goto/WebAPI/neptune-2014-10-31/DeleteDBCluster AWS API Documentation # # @overload delete_db_cluster(params = {}) # @param [Hash] params ({}) @@ -2295,10 +2298,11 @@ # resp.db_instance.iam_database_authentication_enabled #=> Boolean # resp.db_instance.performance_insights_enabled #=> Boolean # resp.db_instance.performance_insights_kms_key_id #=> String # resp.db_instance.enabled_cloudwatch_logs_exports #=> Array # resp.db_instance.enabled_cloudwatch_logs_exports[0] #=> String + # resp.db_instance.deletion_protection #=> Boolean # # @see http://docs.aws.amazon.com/goto/WebAPI/neptune-2014-10-31/DeleteDBInstance AWS API Documentation # # @overload delete_db_instance(params = {}) # @param [Hash] params ({}) @@ -2873,10 +2877,11 @@ # resp.db_clusters[0].iam_database_authentication_enabled #=> Boolean # resp.db_clusters[0].clone_group_id #=> String # resp.db_clusters[0].cluster_create_time #=> Time # resp.db_clusters[0].enabled_cloudwatch_logs_exports #=> Array # resp.db_clusters[0].enabled_cloudwatch_logs_exports[0] #=> String + # resp.db_clusters[0].deletion_protection #=> Boolean # # @see http://docs.aws.amazon.com/goto/WebAPI/neptune-2014-10-31/DescribeDBClusters AWS API Documentation # # @overload describe_db_clusters(params = {}) # @param [Hash] params ({}) @@ -3159,10 +3164,11 @@ # resp.db_instances[0].iam_database_authentication_enabled #=> Boolean # resp.db_instances[0].performance_insights_enabled #=> Boolean # resp.db_instances[0].performance_insights_kms_key_id #=> String # resp.db_instances[0].enabled_cloudwatch_logs_exports #=> Array # resp.db_instances[0].enabled_cloudwatch_logs_exports[0] #=> String + # resp.db_instances[0].deletion_protection #=> Boolean # # @see http://docs.aws.amazon.com/goto/WebAPI/neptune-2014-10-31/DescribeDBInstances AWS API Documentation # # @overload describe_db_instances(params = {}) # @param [Hash] params ({}) @@ -4086,10 +4092,11 @@ # resp.db_cluster.iam_database_authentication_enabled #=> Boolean # resp.db_cluster.clone_group_id #=> String # resp.db_cluster.cluster_create_time #=> Time # resp.db_cluster.enabled_cloudwatch_logs_exports #=> Array # resp.db_cluster.enabled_cloudwatch_logs_exports[0] #=> String + # resp.db_cluster.deletion_protection #=> Boolean # # @see http://docs.aws.amazon.com/goto/WebAPI/neptune-2014-10-31/FailoverDBCluster AWS API Documentation # # @overload failover_db_cluster(params = {}) # @param [Hash] params ({}) @@ -4218,23 +4225,12 @@ # contain any printable ASCII character except "/", """, or "@". # # Constraints: Must contain from 8 to 41 characters. # # @option params [String] :option_group_name - # A value that indicates that the DB cluster should be associated with - # the specified option group. Changing this parameter doesn't result in - # an outage except in the following case, and the change is applied - # during the next maintenance window unless the `ApplyImmediately` - # parameter is set to `true` for this request. If the parameter change - # results in an option group that enables OEM, this change can cause a - # brief (sub-second) period during which new connections are rejected - # but existing connections are not interrupted. + # *(Not supported by Neptune)* # - # Permanent options can't be removed from an option group. The option - # group can't be removed from a DB cluster once it is associated with a - # DB cluster. - # # @option params [String] :preferred_backup_window # The daily time range during which automated backups are created if # automated backups are enabled, using the `BackupRetentionPeriod` # parameter. # @@ -4274,18 +4270,22 @@ # @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 cluster. # # @option params [String] :engine_version - # The version number of the database engine to which you want to - # upgrade. Changing this parameter results in an outage. The change is - # applied during the next maintenance window unless the ApplyImmediately - # parameter is set to true. + # The version number of the database engine. Currently, setting this + # parameter has no effect. To upgrade your database engine to the most + # recent release, use the ApplyPendingMaintenanceAction API. # # For a list of valid engine versions, see CreateDBInstance, or call # DescribeDBEngineVersions. # + # @option params [Boolean] :deletion_protection + # A value that indicates whether the DB cluster has deletion protection + # enabled. The database can't be deleted when deletion protection is + # enabled. By default, deletion protection is disabled. + # # @return [Types::ModifyDBClusterResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ModifyDBClusterResult#db_cluster #db_cluster} => Types::DBCluster # # @example Request syntax with placeholder values @@ -4306,10 +4306,11 @@ # cloudwatch_logs_export_configuration: { # enable_log_types: ["String"], # disable_log_types: ["String"], # }, # engine_version: "String", + # deletion_protection: false, # }) # # @example Response structure # # resp.db_cluster.allocated_storage #=> Integer @@ -4359,10 +4360,11 @@ # resp.db_cluster.iam_database_authentication_enabled #=> Boolean # resp.db_cluster.clone_group_id #=> String # resp.db_cluster.cluster_create_time #=> Time # resp.db_cluster.enabled_cloudwatch_logs_exports #=> Array # resp.db_cluster.enabled_cloudwatch_logs_exports[0] #=> String + # resp.db_cluster.deletion_protection #=> Boolean # # @see http://docs.aws.amazon.com/goto/WebAPI/neptune-2014-10-31/ModifyDBCluster AWS API Documentation # # @overload modify_db_cluster(params = {}) # @param [Hash] params ({}) @@ -4666,29 +4668,19 @@ # parameter doesn't result in an outage and the change is applied # during the next maintenance window unless the `ApplyImmediately` # parameter is set to `true` for this request. # # @option params [String] :engine_version - # The version number of the database engine to upgrade to. Changing this - # parameter results in an outage and the change is applied during the - # next maintenance window unless the `ApplyImmediately` parameter is set - # to `true` for this request. + # The version number of the database engine to upgrade to. Currently, + # setting this parameter has no effect. To upgrade your database engine + # to the most recent release, use the ApplyPendingMaintenanceAction API. # - # For major version upgrades, if a nondefault DB parameter group is - # currently in use, a new DB parameter group in the DB parameter group - # family for the new engine version must be specified. The new DB - # parameter group can be the default for that DB parameter group family. - # # @option params [Boolean] :allow_major_version_upgrade # Indicates that major version upgrades are allowed. Changing this # parameter doesn't result in an outage and the change is # asynchronously applied as soon as possible. # - # Constraints: This parameter must be set to true when specifying a - # value for the EngineVersion parameter that is a different major - # version than the DB instance's current version. - # # @option params [Boolean] :auto_minor_version_upgrade # Indicates that minor version upgrades are applied automatically to the # DB instance during the maintenance window. Changing this parameter # doesn't result in an outage except in the following case and the # change is asynchronously applied as soon as possible. An outage will @@ -4708,24 +4700,12 @@ # `ApplyImmediately` parameter is set to `true` for this request. # # Default: Uses existing setting # # @option params [String] :option_group_name - # Indicates that the DB instance should be associated with the specified - # option group. Changing this parameter doesn't result in an outage - # except in the following case and the change is applied during the next - # maintenance window unless the `ApplyImmediately` parameter is set to - # `true` for this request. If the parameter change results in an option - # group that enables OEM, this change can cause a brief (sub-second) - # period during which new connections are rejected but existing - # connections are not interrupted. + # *(Not supported by Neptune)* # - # Permanent options, such as the TDE option for Oracle Advanced Security - # TDE, can't be removed from an option group, and that option group - # can't be removed from a DB instance once it is associated with a DB - # instance - # # @option params [String] :new_db_instance_identifier # The new DB instance identifier for the DB instance when renaming a DB # instance. When you change the DB instance identifier, an instance # reboot will occur immediately if you set `Apply Immediately` to true, # or will occur during the next maintenance window if `Apply @@ -4819,19 +4799,24 @@ # managed by the DB cluster. For more information, see ModifyDBCluster. # # Default: `false` # # @option params [Boolean] :enable_performance_insights - # Not supported. + # *(Not supported by Neptune)* # # @option params [String] :performance_insights_kms_key_id - # Not supported. + # *(Not supported by Neptune)* # # @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. # + # @option params [Boolean] :deletion_protection + # A value that indicates whether the DB instance has deletion protection + # enabled. The database can't be deleted when deletion protection is + # enabled. By default, deletion protection is disabled. + # # @return [Types::ModifyDBInstanceResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ModifyDBInstanceResult#db_instance #db_instance} => Types::DBInstance # # @example Request syntax with placeholder values @@ -4874,10 +4859,11 @@ # performance_insights_kms_key_id: "String", # cloudwatch_logs_export_configuration: { # enable_log_types: ["String"], # disable_log_types: ["String"], # }, + # deletion_protection: false, # }) # # @example Response structure # # resp.db_instance.db_instance_identifier #=> String @@ -4975,10 +4961,11 @@ # resp.db_instance.iam_database_authentication_enabled #=> Boolean # resp.db_instance.performance_insights_enabled #=> Boolean # resp.db_instance.performance_insights_kms_key_id #=> String # resp.db_instance.enabled_cloudwatch_logs_exports #=> Array # resp.db_instance.enabled_cloudwatch_logs_exports[0] #=> String + # resp.db_instance.deletion_protection #=> Boolean # # @see http://docs.aws.amazon.com/goto/WebAPI/neptune-2014-10-31/ModifyDBInstance AWS API Documentation # # @overload modify_db_instance(params = {}) # @param [Hash] params ({}) @@ -5259,10 +5246,11 @@ # resp.db_cluster.iam_database_authentication_enabled #=> Boolean # resp.db_cluster.clone_group_id #=> String # resp.db_cluster.cluster_create_time #=> Time # resp.db_cluster.enabled_cloudwatch_logs_exports #=> Array # resp.db_cluster.enabled_cloudwatch_logs_exports[0] #=> String + # resp.db_cluster.deletion_protection #=> Boolean # # @see http://docs.aws.amazon.com/goto/WebAPI/neptune-2014-10-31/PromoteReadReplicaDBCluster AWS API Documentation # # @overload promote_read_replica_db_cluster(params = {}) # @param [Hash] params ({}) @@ -5404,10 +5392,11 @@ # resp.db_instance.iam_database_authentication_enabled #=> Boolean # resp.db_instance.performance_insights_enabled #=> Boolean # resp.db_instance.performance_insights_kms_key_id #=> String # resp.db_instance.enabled_cloudwatch_logs_exports #=> Array # resp.db_instance.enabled_cloudwatch_logs_exports[0] #=> String + # resp.db_instance.deletion_protection #=> Boolean # # @see http://docs.aws.amazon.com/goto/WebAPI/neptune-2014-10-31/RebootDBInstance AWS API Documentation # # @overload reboot_db_instance(params = {}) # @param [Hash] params ({}) @@ -5729,11 +5718,11 @@ # # @option params [String] :database_name # Not supported. # # @option params [String] :option_group_name - # The name of the option group to use for the restored DB cluster. + # *(Not supported by Neptune)* # # @option params [Array<String>] :vpc_security_group_ids # A list of VPC security groups that the new DB cluster will belong to. # # @option params [Array<Types::Tag>] :tags @@ -5778,10 +5767,15 @@ # * If supplied, must match the name of an existing # DBClusterParameterGroup. # # ^ # + # @option params [Boolean] :deletion_protection + # A value that indicates whether the DB cluster has deletion protection + # enabled. The database can't be deleted when deletion protection is + # enabled. By default, deletion protection is disabled. + # # @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 @@ -5805,10 +5799,11 @@ # ], # kms_key_id: "String", # enable_iam_database_authentication: false, # enable_cloudwatch_logs_exports: ["String"], # db_cluster_parameter_group_name: "String", + # deletion_protection: false, # }) # # @example Response structure # # resp.db_cluster.allocated_storage #=> Integer @@ -5858,10 +5853,11 @@ # resp.db_cluster.iam_database_authentication_enabled #=> Boolean # resp.db_cluster.clone_group_id #=> String # resp.db_cluster.cluster_create_time #=> Time # resp.db_cluster.enabled_cloudwatch_logs_exports #=> Array # resp.db_cluster.enabled_cloudwatch_logs_exports[0] #=> String + # resp.db_cluster.deletion_protection #=> Boolean # # @see http://docs.aws.amazon.com/goto/WebAPI/neptune-2014-10-31/RestoreDBClusterFromSnapshot AWS API Documentation # # @overload restore_db_cluster_from_snapshot(params = {}) # @param [Hash] params ({}) @@ -5961,11 +5957,11 @@ # DBSubnetGroup. # # Example: `mySubnetgroup` # # @option params [String] :option_group_name - # The name of the option group for the new DB cluster. + # *(Not supported by Neptune)* # # @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 @@ -6018,10 +6014,15 @@ # * If supplied, must match the name of an existing # DBClusterParameterGroup. # # ^ # + # @option params [Boolean] :deletion_protection + # A value that indicates whether the DB cluster has deletion protection + # enabled. The database can't be deleted when deletion protection is + # enabled. By default, deletion protection is disabled. + # # @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 @@ -6044,10 +6045,11 @@ # ], # kms_key_id: "String", # enable_iam_database_authentication: false, # enable_cloudwatch_logs_exports: ["String"], # db_cluster_parameter_group_name: "String", + # deletion_protection: false, # }) # # @example Response structure # # resp.db_cluster.allocated_storage #=> Integer @@ -6097,10 +6099,11 @@ # resp.db_cluster.iam_database_authentication_enabled #=> Boolean # resp.db_cluster.clone_group_id #=> String # resp.db_cluster.cluster_create_time #=> Time # resp.db_cluster.enabled_cloudwatch_logs_exports #=> Array # resp.db_cluster.enabled_cloudwatch_logs_exports[0] #=> String + # resp.db_cluster.deletion_protection #=> Boolean # # @see http://docs.aws.amazon.com/goto/WebAPI/neptune-2014-10-31/RestoreDBClusterToPointInTime AWS API Documentation # # @overload restore_db_cluster_to_point_in_time(params = {}) # @param [Hash] params ({}) @@ -6120,10 +6123,10 @@ operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-neptune' - context[:gem_version] = '1.19.0' + context[:gem_version] = '1.20.0' Seahorse::Client::Request.new(handlers, context) end # Polls an API operation until a resource enters a desired state. #