lib/aws-sdk-redshiftserverless/client.rb in aws-sdk-redshiftserverless-1.14.0 vs lib/aws-sdk-redshiftserverless/client.rb in aws-sdk-redshiftserverless-1.15.0
- old
+ new
@@ -445,10 +445,12 @@
# resp.snapshot.accounts_with_provisioned_restore_access #=> Array
# resp.snapshot.accounts_with_provisioned_restore_access[0] #=> String
# resp.snapshot.accounts_with_restore_access #=> Array
# resp.snapshot.accounts_with_restore_access[0] #=> String
# resp.snapshot.actual_incremental_backup_size_in_mega_bytes #=> Float
+ # resp.snapshot.admin_password_secret_arn #=> String
+ # resp.snapshot.admin_password_secret_kms_key_id #=> String
# resp.snapshot.admin_username #=> String
# resp.snapshot.backup_progress_in_mega_bytes #=> Float
# resp.snapshot.current_backup_rate_in_mega_bytes_per_second #=> Float
# resp.snapshot.elapsed_time_in_seconds #=> Integer
# resp.snapshot.estimated_seconds_to_completion #=> Integer
@@ -538,14 +540,21 @@
req.send_request(options)
end
# Creates a namespace in Amazon Redshift Serverless.
#
+ # @option params [String] :admin_password_secret_kms_key_id
+ # The ID of the Key Management Service (KMS) key used to encrypt and
+ # store the namespace's admin credentials secret. You can only use this
+ # parameter if `manageAdminPassword` is true.
+ #
# @option params [String] :admin_user_password
# The password of the administrator for the first database created in
# the namespace.
#
+ # You can't use `adminUserPassword` if `manageAdminPassword` is true.
+ #
# @option params [String] :admin_username
# The username of the administrator for the first database created in
# the namespace.
#
# @option params [String] :db_name
@@ -564,10 +573,17 @@
#
# @option params [Array<String>] :log_exports
# The types of logs the namespace can export. Available export types are
# `userlog`, `connectionlog`, and `useractivitylog`.
#
+ # @option params [Boolean] :manage_admin_password
+ # If `true`, Amazon Redshift uses Secrets Manager to manage the
+ # namespace's admin credentials. You can't use `adminUserPassword` if
+ # `manageAdminPassword` is true. If `manageAdminPassword` is false or
+ # not set, Amazon Redshift uses `adminUserPassword` for the admin user
+ # account's password.
+ #
# @option params [required, String] :namespace_name
# The name of the namespace.
#
# @option params [Array<Types::Tag>] :tags
# A list of tag instances.
@@ -577,17 +593,19 @@
# * {Types::CreateNamespaceResponse#namespace #namespace} => Types::Namespace
#
# @example Request syntax with placeholder values
#
# resp = client.create_namespace({
+ # admin_password_secret_kms_key_id: "KmsKeyId",
# admin_user_password: "DbPassword",
# admin_username: "DbUser",
# db_name: "String",
# default_iam_role_arn: "String",
# iam_roles: ["IamRoleArn"],
# kms_key_id: "String",
# log_exports: ["useractivitylog"], # accepts useractivitylog, userlog, connectionlog
+ # manage_admin_password: false,
# namespace_name: "NamespaceName", # required
# tags: [
# {
# key: "TagKey", # required
# value: "TagValue", # required
@@ -595,10 +613,12 @@
# ],
# })
#
# @example Response structure
#
+ # resp.namespace.admin_password_secret_arn #=> String
+ # resp.namespace.admin_password_secret_kms_key_id #=> String
# resp.namespace.admin_username #=> String
# resp.namespace.creation_date #=> Time
# resp.namespace.db_name #=> String
# resp.namespace.default_iam_role_arn #=> String
# resp.namespace.iam_roles #=> Array
@@ -667,10 +687,12 @@
# resp.snapshot.accounts_with_provisioned_restore_access #=> Array
# resp.snapshot.accounts_with_provisioned_restore_access[0] #=> String
# resp.snapshot.accounts_with_restore_access #=> Array
# resp.snapshot.accounts_with_restore_access[0] #=> String
# resp.snapshot.actual_incremental_backup_size_in_mega_bytes #=> Float
+ # resp.snapshot.admin_password_secret_arn #=> String
+ # resp.snapshot.admin_password_secret_kms_key_id #=> String
# resp.snapshot.admin_username #=> String
# resp.snapshot.backup_progress_in_mega_bytes #=> Float
# resp.snapshot.current_backup_rate_in_mega_bytes_per_second #=> Float
# resp.snapshot.elapsed_time_in_seconds #=> Integer
# resp.snapshot.estimated_seconds_to_completion #=> Integer
@@ -942,10 +964,12 @@
# namespace_name: "NamespaceName", # required
# })
#
# @example Response structure
#
+ # resp.namespace.admin_password_secret_arn #=> String
+ # resp.namespace.admin_password_secret_kms_key_id #=> String
# resp.namespace.admin_username #=> String
# resp.namespace.creation_date #=> Time
# resp.namespace.db_name #=> String
# resp.namespace.default_iam_role_arn #=> String
# resp.namespace.iam_roles #=> Array
@@ -1009,10 +1033,12 @@
# resp.snapshot.accounts_with_provisioned_restore_access #=> Array
# resp.snapshot.accounts_with_provisioned_restore_access[0] #=> String
# resp.snapshot.accounts_with_restore_access #=> Array
# resp.snapshot.accounts_with_restore_access[0] #=> String
# resp.snapshot.actual_incremental_backup_size_in_mega_bytes #=> Float
+ # resp.snapshot.admin_password_secret_arn #=> String
+ # resp.snapshot.admin_password_secret_kms_key_id #=> String
# resp.snapshot.admin_username #=> String
# resp.snapshot.backup_progress_in_mega_bytes #=> Float
# resp.snapshot.current_backup_rate_in_mega_bytes_per_second #=> Float
# resp.snapshot.elapsed_time_in_seconds #=> Integer
# resp.snapshot.estimated_seconds_to_completion #=> Integer
@@ -1255,10 +1281,12 @@
# namespace_name: "NamespaceName", # required
# })
#
# @example Response structure
#
+ # resp.namespace.admin_password_secret_arn #=> String
+ # resp.namespace.admin_password_secret_kms_key_id #=> String
# resp.namespace.admin_username #=> String
# resp.namespace.creation_date #=> Time
# resp.namespace.db_name #=> String
# resp.namespace.default_iam_role_arn #=> String
# resp.namespace.iam_roles #=> Array
@@ -1371,10 +1399,12 @@
# resp.snapshot.accounts_with_provisioned_restore_access #=> Array
# resp.snapshot.accounts_with_provisioned_restore_access[0] #=> String
# resp.snapshot.accounts_with_restore_access #=> Array
# resp.snapshot.accounts_with_restore_access[0] #=> String
# resp.snapshot.actual_incremental_backup_size_in_mega_bytes #=> Float
+ # resp.snapshot.admin_password_secret_arn #=> String
+ # resp.snapshot.admin_password_secret_kms_key_id #=> String
# resp.snapshot.admin_username #=> String
# resp.snapshot.backup_progress_in_mega_bytes #=> Float
# resp.snapshot.current_backup_rate_in_mega_bytes_per_second #=> Float
# resp.snapshot.elapsed_time_in_seconds #=> Integer
# resp.snapshot.estimated_seconds_to_completion #=> Integer
@@ -1624,10 +1654,12 @@
# })
#
# @example Response structure
#
# resp.namespaces #=> Array
+ # resp.namespaces[0].admin_password_secret_arn #=> String
+ # resp.namespaces[0].admin_password_secret_kms_key_id #=> String
# resp.namespaces[0].admin_username #=> String
# resp.namespaces[0].creation_date #=> Time
# resp.namespaces[0].db_name #=> String
# resp.namespaces[0].default_iam_role_arn #=> String
# resp.namespaces[0].iam_roles #=> Array
@@ -1766,10 +1798,12 @@
# resp.snapshots[0].accounts_with_provisioned_restore_access #=> Array
# resp.snapshots[0].accounts_with_provisioned_restore_access[0] #=> String
# resp.snapshots[0].accounts_with_restore_access #=> Array
# resp.snapshots[0].accounts_with_restore_access[0] #=> String
# resp.snapshots[0].actual_incremental_backup_size_in_mega_bytes #=> Float
+ # resp.snapshots[0].admin_password_secret_arn #=> String
+ # resp.snapshots[0].admin_password_secret_kms_key_id #=> String
# resp.snapshots[0].admin_username #=> String
# resp.snapshots[0].backup_progress_in_mega_bytes #=> Float
# resp.snapshots[0].current_backup_rate_in_mega_bytes_per_second #=> Float
# resp.snapshots[0].elapsed_time_in_seconds #=> Integer
# resp.snapshots[0].estimated_seconds_to_completion #=> Integer
@@ -2078,10 +2112,12 @@
# workgroup_name: "WorkgroupName", # required
# })
#
# @example Response structure
#
+ # resp.namespace.admin_password_secret_arn #=> String
+ # resp.namespace.admin_password_secret_kms_key_id #=> String
# resp.namespace.admin_username #=> String
# resp.namespace.creation_date #=> Time
# resp.namespace.db_name #=> String
# resp.namespace.default_iam_role_arn #=> String
# resp.namespace.iam_roles #=> Array
@@ -2104,10 +2140,20 @@
req.send_request(options)
end
# Restores a namespace from a snapshot.
#
+ # @option params [String] :admin_password_secret_kms_key_id
+ # The ID of the Key Management Service (KMS) key used to encrypt and
+ # store the namespace's admin credentials secret.
+ #
+ # @option params [Boolean] :manage_admin_password
+ # If `true`, Amazon Redshift uses Secrets Manager to manage the restored
+ # snapshot's admin credentials. If `MmanageAdminPassword` is false or
+ # not set, Amazon Redshift uses the admin credentials that the namespace
+ # or cluster had at the time the snapshot was taken.
+ #
# @option params [required, String] :namespace_name
# The name of the namespace to restore the snapshot to.
#
# @option params [String] :owner_account
# The Amazon Web Services account that owns the snapshot.
@@ -2134,19 +2180,23 @@
# * {Types::RestoreFromSnapshotResponse#snapshot_name #snapshot_name} => String
#
# @example Request syntax with placeholder values
#
# resp = client.restore_from_snapshot({
+ # admin_password_secret_kms_key_id: "KmsKeyId",
+ # manage_admin_password: false,
# namespace_name: "NamespaceName", # required
# owner_account: "String",
# snapshot_arn: "String",
# snapshot_name: "String",
# workgroup_name: "WorkgroupName", # required
# })
#
# @example Response structure
#
+ # resp.namespace.admin_password_secret_arn #=> String
+ # resp.namespace.admin_password_secret_kms_key_id #=> String
# resp.namespace.admin_username #=> String
# resp.namespace.creation_date #=> Time
# resp.namespace.db_name #=> String
# resp.namespace.default_iam_role_arn #=> String
# resp.namespace.iam_roles #=> Array
@@ -2369,15 +2419,22 @@
# can't update multiple parameters in one request. For example, you
# must specify both `adminUsername` and `adminUserPassword` to update
# either field, but you can't update both `kmsKeyId` and `logExports`
# in a single request.
#
+ # @option params [String] :admin_password_secret_kms_key_id
+ # The ID of the Key Management Service (KMS) key used to encrypt and
+ # store the namespace's admin credentials secret. You can only use this
+ # parameter if `manageAdminPassword` is true.
+ #
# @option params [String] :admin_user_password
# The password of the administrator for the first database created in
# the namespace. This parameter must be updated together with
# `adminUsername`.
#
+ # You can't use `adminUserPassword` if `manageAdminPassword` is true.
+ #
# @option params [String] :admin_username
# The username of the administrator for the first database created in
# the namespace. This parameter must be updated together with
# `adminUserPassword`.
#
@@ -2396,10 +2453,17 @@
#
# @option params [Array<String>] :log_exports
# The types of logs the namespace can export. The export types are
# `userlog`, `connectionlog`, and `useractivitylog`.
#
+ # @option params [Boolean] :manage_admin_password
+ # If `true`, Amazon Redshift uses Secrets Manager to manage the
+ # namespace's admin credentials. You can't use `adminUserPassword` if
+ # `manageAdminPassword` is true. If `manageAdminPassword` is false or
+ # not set, Amazon Redshift uses `adminUserPassword` for the admin user
+ # account's password.
+ #
# @option params [required, String] :namespace_name
# The name of the namespace to update. You can't update the name of a
# namespace once it is created.
#
# @return [Types::UpdateNamespaceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
@@ -2407,21 +2471,25 @@
# * {Types::UpdateNamespaceResponse#namespace #namespace} => Types::Namespace
#
# @example Request syntax with placeholder values
#
# resp = client.update_namespace({
+ # admin_password_secret_kms_key_id: "KmsKeyId",
# admin_user_password: "DbPassword",
# admin_username: "DbUser",
# default_iam_role_arn: "String",
# iam_roles: ["IamRoleArn"],
# kms_key_id: "String",
# log_exports: ["useractivitylog"], # accepts useractivitylog, userlog, connectionlog
+ # manage_admin_password: false,
# namespace_name: "NamespaceName", # required
# })
#
# @example Response structure
#
+ # resp.namespace.admin_password_secret_arn #=> String
+ # resp.namespace.admin_password_secret_kms_key_id #=> String
# resp.namespace.admin_username #=> String
# resp.namespace.creation_date #=> Time
# resp.namespace.db_name #=> String
# resp.namespace.default_iam_role_arn #=> String
# resp.namespace.iam_roles #=> Array
@@ -2467,10 +2535,12 @@
# resp.snapshot.accounts_with_provisioned_restore_access #=> Array
# resp.snapshot.accounts_with_provisioned_restore_access[0] #=> String
# resp.snapshot.accounts_with_restore_access #=> Array
# resp.snapshot.accounts_with_restore_access[0] #=> String
# resp.snapshot.actual_incremental_backup_size_in_mega_bytes #=> Float
+ # resp.snapshot.admin_password_secret_arn #=> String
+ # resp.snapshot.admin_password_secret_kms_key_id #=> String
# resp.snapshot.admin_username #=> String
# resp.snapshot.backup_progress_in_mega_bytes #=> Float
# resp.snapshot.current_backup_rate_in_mega_bytes_per_second #=> Float
# resp.snapshot.elapsed_time_in_seconds #=> Integer
# resp.snapshot.estimated_seconds_to_completion #=> Integer
@@ -2660,10 +2730,10 @@
operation: config.api.operation(operation_name),
client: self,
params: params,
config: config)
context[:gem_name] = 'aws-sdk-redshiftserverless'
- context[:gem_version] = '1.14.0'
+ context[:gem_version] = '1.15.0'
Seahorse::Client::Request.new(handlers, context)
end
# @api private
# @deprecated