AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Redshift Serverless UpdateNamespace API operation.

Syntax

Update-RSSNamespace
-NamespaceName <String>
-AdminPasswordSecretKmsKeyId <String>
-AdminUsername <String>
-AdminUserPassword <String>
-DefaultIamRoleArn <String>
-IamRole <String[]>
-KmsKeyId <String>
-LogDestinationType <LogDestinationType>
-LogExport <String[]>
-ManageAdminPassword <Boolean>
-S3TableAction <S3TableAction>
-S3TableGranularity <S3TableGranularity>
-S3TableKmsKeyId <String>
-S3TableName <String[]>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonRedshiftServerlessConfig>

Description

Updates a namespace with the specified settings. Unless required, you 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. Similarly, an S3 Tables log-publishing update (a request where logDestinationType is s3table) cannot be combined with any other namespace configuration change and must be submitted as its own request.

Parameters

-AdminPasswordSecretKmsKeyId <String>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AdminUsername <String>
The username of the administrator for the first database created in the namespace. This parameter must be updated together with adminUserPassword.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AdminUserPassword <String>
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. If your admin user account is locked, this operation also unlocks your account and resets the failed-login counter. This option is available only when account lockout security is enabled for the namespace.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientConfig <AmazonRedshiftServerlessConfig>
Amazon.PowerShell.Cmdlets.RSS.AmazonRedshiftServerlessClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DefaultIamRoleArn <String>
The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace. This parameter must be updated together with iamRoles.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-IamRole <String[]>
A list of IAM roles to associate with the namespace. This parameter must be updated together with defaultIamRoleArn. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesIamRoles
-KmsKeyId <String>
The ID of the Amazon Web Services Key Management Service key used to encrypt your data.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-LogDestinationType <LogDestinationType>
The destination for the log data. Valid values are s3table and cloudwatch.Set this to s3table to manage Amazon S3 Tables system-table publishing for the namespace.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-LogExport <String[]>
The types of logs the namespace can export. The export types are userlog, connectionlog, and useractivitylog. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesLogExports
-ManageAdminPassword <Boolean>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NamespaceName <String>
The name of the namespace to update. You can't update the name of a namespace once it is created.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-S3TableAction <S3TableAction>
Whether to enable or disable Amazon S3 Tables publishing. Valid values are Enable and Disable, matched case-insensitively.When omitted, defaults to Enable. Valid only when logDestinationType is s3table.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-S3TableGranularity <S3TableGranularity>
The scope of the Amazon S3 Tables destination. Valid values are namespace and account, matched case-insensitively. namespace scopes the published tables to this namespace; account scopes them to the Amazon Web Services account.Required when enabling. Omitting this parameter or passing a blank value fails with ValidationException. Valid only when logDestinationType is s3table.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-S3TableKmsKeyId <String>
The identifier of the Key Management Service key used to encrypt the published Amazon S3 Tables data. When omitted, the data is encrypted with SSE-S3 (Amazon S3 managed keys).Valid only when logDestinationType is s3table.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-S3TableName <String[]>
The system tables to publish (on enable) or to stop publishing (on disable). Each value is either a system table view name that begins with sys_ or the keyword all.Omitting this parameter, passing an empty list, or including all each select every current and future system table. Each name must be 1-128 characters, and the list can contain up to 256 names.Valid only when logDestinationType is s3table. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesS3TableNames
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'Namespace'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.RedshiftServerless.Model.UpdateNamespaceResponse). Specifying the name of a property of type Amazon.RedshiftServerless.Model.UpdateNamespaceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.RedshiftServerless.Model.Namespace or Amazon.RedshiftServerless.Model.UpdateNamespaceResponse
This cmdlet returns an Amazon.RedshiftServerless.Model.Namespace object. The service call response (type Amazon.RedshiftServerless.Model.UpdateNamespaceResponse) can be returned by specifying '-Select *'.
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z