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("software.amazon.awssdk:codegen") public final class UpdateNamespaceRequest extends RedshiftServerlessRequest implements ToCopyableBuilder<UpdateNamespaceRequest.Builder,UpdateNamespaceRequest>

  • Method Details

    • 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.

      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.

      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.

      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.

    • 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.

    • logDestinationType

      public final 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.

      If the service returns an enum value that is not available in the current SDK version, logDestinationType will return LogDestinationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from logDestinationTypeAsString().

      Returns:
      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.

      See Also:

    • logDestinationTypeAsString

      public final String logDestinationTypeAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, logDestinationType will return LogDestinationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from logDestinationTypeAsString().

      Returns:
      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.

      See Also:

    • 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.

    • s3TableAction

      public final 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.

      If the service returns an enum value that is not available in the current SDK version, s3TableAction will return S3TableAction.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from s3TableActionAsString().

      Returns:
      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.

      See Also:

    • s3TableActionAsString

      public final String s3TableActionAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, s3TableAction will return S3TableAction.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from s3TableActionAsString().

      Returns:
      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.

      See Also:

    • s3TableGranularity

      public final 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.

      If the service returns an enum value that is not available in the current SDK version, s3TableGranularity will return S3TableGranularity.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from s3TableGranularityAsString().

      Returns:
      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.

      See Also:

    • s3TableGranularityAsString

      public final String s3TableGranularityAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, s3TableGranularity will return S3TableGranularity.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from s3TableGranularityAsString().

      Returns:
      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.

      See Also:

    • s3TableKmsKeyId

      public final String s3TableKmsKeyId()

      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.

      Returns:
      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.

    • hasS3TableNames

      public final boolean hasS3TableNames()
      For responses, this returns true if the service returned a value for the S3TableNames 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.

    • s3TableNames

      public final List<String> s3TableNames()

      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.

      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 hasS3TableNames() method.

      Returns:
      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.

    • toBuilder

      public UpdateNamespaceRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<UpdateNamespaceRequest.Builder,UpdateNamespaceRequest>
      Specified by:
      toBuilder in class RedshiftServerlessRequest
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.