software.amazon.awssdk.services.redshiftserverless.model

Class UpdateNamespaceRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.redshiftserverless.model.RedshiftServerlessRequest

software.amazon.awssdk.services.redshiftserverless.model.UpdateNamespaceRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateNamespaceRequest.Builder,UpdateNamespaceRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class UpdateNamespaceRequest
extends RedshiftServerlessRequest
implements ToCopyableBuilder<UpdateNamespaceRequest.Builder,UpdateNamespaceRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UpdateNamespaceRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	adminPasswordSecretKmsKeyId() The ID of the Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret.
String	adminUsername() The username of the administrator for the first database created in the namespace.
String	adminUserPassword() The password of the administrator for the first database created in the namespace.
static UpdateNamespaceRequest.Builder	builder()
String	defaultIamRoleArn() The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasIamRoles() For responses, this returns true if the service returned a value for the IamRoles property.
boolean	hasLogExports() For responses, this returns true if the service returned a value for the LogExports property.
List<String>	iamRoles() A list of IAM roles to associate with the namespace.
String	kmsKeyId() The ID of the Amazon Web Services Key Management Service key used to encrypt your data.
List<LogExport>	logExports() The types of logs the namespace can export.
List<String>	logExportsAsStrings() The types of logs the namespace can export.
Boolean	manageAdminPassword() If true, Amazon Redshift uses Secrets Manager to manage the namespace's admin credentials.
String	namespaceName() The name of the namespace to update.
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateNamespaceRequest.Builder>	serializableBuilderClass()
UpdateNamespaceRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

adminPasswordSecretKmsKeyId

public final String adminPasswordSecretKmsKeyId()

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.

Returns:

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.

adminUserPassword

public final String adminUserPassword()

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.

Returns:

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.

adminUsername

public final String adminUsername()

The username of the administrator for the first database created in the namespace. This parameter must be updated together with adminUserPassword.

Returns:

The username of the administrator for the first database created in the namespace. This parameter must be updated together with adminUserPassword.

defaultIamRoleArn

public final String defaultIamRoleArn()

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.

Returns:

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.

hasIamRoles

public final boolean hasIamRoles()

For responses, this returns true if the service returned a value for the IamRoles property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

iamRoles

public final List<String> iamRoles()

A list of IAM roles to associate with the namespace. This parameter must be updated together with defaultIamRoleArn.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasIamRoles() method.

Returns:

A list of IAM roles to associate with the namespace. This parameter must be updated together with defaultIamRoleArn.

kmsKeyId

public final String kmsKeyId()

The ID of the Amazon Web Services Key Management Service key used to encrypt your data.

Returns:

The ID of the Amazon Web Services Key Management Service key used to encrypt your data.

logExports

public final List<LogExport> logExports()

The types of logs the namespace can export. The export types are userlog, connectionlog , and useractivitylog.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasLogExports() method.

Returns:

The types of logs the namespace can export. The export types are userlog, connectionlog, and useractivitylog.

hasLogExports

public final boolean hasLogExports()

For responses, this returns true if the service returned a value for the LogExports property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

logExportsAsStrings

public final List<String> logExportsAsStrings()

The types of logs the namespace can export. The export types are userlog, connectionlog , and useractivitylog.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasLogExports() method.

Returns:

The types of logs the namespace can export. The export types are userlog, connectionlog, and useractivitylog.

manageAdminPassword

public final Boolean manageAdminPassword()

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.

Returns:

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.

namespaceName

public final String namespaceName()

The name of the namespace to update. You can't update the name of a namespace once it is created.

Returns:

The name of the namespace to update. You can't update the name of a namespace once it is created.

toBuilder

public UpdateNamespaceRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateNamespaceRequest.Builder,UpdateNamespaceRequest>

Specified by:

toBuilder in class RedshiftServerlessRequest

builder

public static UpdateNamespaceRequest.Builder builder()

serializableBuilderClass

public static Class<? extends UpdateNamespaceRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo