Class ModifyLakehouseConfigurationRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.redshift.model.RedshiftRequest
software.amazon.awssdk.services.redshift.model.ModifyLakehouseConfigurationRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<ModifyLakehouseConfigurationRequest.Builder,ModifyLakehouseConfigurationRequest>
@Generated("software.amazon.awssdk:codegen") public final class ModifyLakehouseConfigurationRequest extends RedshiftRequest implements ToCopyableBuilder<ModifyLakehouseConfigurationRequest.Builder,ModifyLakehouseConfigurationRequest>

  • Method Details

    • clusterIdentifier

      public final String clusterIdentifier()

      The unique identifier of the cluster whose lakehouse configuration you want to modify.

      Returns:
      The unique identifier of the cluster whose lakehouse configuration you want to modify.

    • lakehouseRegistration

      public final LakehouseRegistration lakehouseRegistration()

      Specifies whether to register or deregister the cluster with Amazon Redshift federated permissions. Valid values are Register or Deregister.

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

      Returns:
      Specifies whether to register or deregister the cluster with Amazon Redshift federated permissions. Valid values are Register or Deregister.
      See Also:

    • lakehouseRegistrationAsString

      public final String lakehouseRegistrationAsString()

      Specifies whether to register or deregister the cluster with Amazon Redshift federated permissions. Valid values are Register or Deregister.

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

      Returns:
      Specifies whether to register or deregister the cluster with Amazon Redshift federated permissions. Valid values are Register or Deregister.
      See Also:

    • catalogName

      public final String catalogName()

      The name of the Glue data catalog that will be associated with the cluster enabled with Amazon Redshift federated permissions.

      Constraints:

      • Must contain at least one lowercase letter.

      • Can only contain lowercase letters (a-z), numbers (0-9), underscores (_), and hyphens (-).

      Pattern: ^[a-z0-9_-]*[a-z]+[a-z0-9_-]*$

      Example: my-catalog_01

      Returns:
      The name of the Glue data catalog that will be associated with the cluster enabled with Amazon Redshift federated permissions.

      Constraints:

      • Must contain at least one lowercase letter.

      • Can only contain lowercase letters (a-z), numbers (0-9), underscores (_), and hyphens (-).

      Pattern: ^[a-z0-9_-]*[a-z]+[a-z0-9_-]*$

      Example: my-catalog_01

    • lakehouseIdcRegistration

      public final LakehouseIdcRegistration lakehouseIdcRegistration()

      Modifies the Amazon Web Services IAM Identity Center trusted identity propagation on a cluster enabled with Amazon Redshift federated permissions. Valid values are Associate or Disassociate.

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

      Returns:
      Modifies the Amazon Web Services IAM Identity Center trusted identity propagation on a cluster enabled with Amazon Redshift federated permissions. Valid values are Associate or Disassociate.
      See Also:

    • lakehouseIdcRegistrationAsString

      public final String lakehouseIdcRegistrationAsString()

      Modifies the Amazon Web Services IAM Identity Center trusted identity propagation on a cluster enabled with Amazon Redshift federated permissions. Valid values are Associate or Disassociate.

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

      Returns:
      Modifies the Amazon Web Services IAM Identity Center trusted identity propagation on a cluster enabled with Amazon Redshift federated permissions. Valid values are Associate or Disassociate.
      See Also:

    • lakehouseIdcApplicationArn

      public final String lakehouseIdcApplicationArn()

      The Amazon Resource Name (ARN) of the IAM Identity Center application used for enabling Amazon Web Services IAM Identity Center trusted identity propagation on a cluster enabled with Amazon Redshift federated permissions.

      Returns:
      The Amazon Resource Name (ARN) of the IAM Identity Center application used for enabling Amazon Web Services IAM Identity Center trusted identity propagation on a cluster enabled with Amazon Redshift federated permissions.

    • dryRun

      public final Boolean dryRun()

      A boolean value that, if true, validates the request without actually modifying the lakehouse configuration. Use this to check for errors before making changes.

      Returns:
      A boolean value that, if true, validates the request without actually modifying the lakehouse configuration. Use this to check for errors before making changes.

    • toBuilder

      public ModifyLakehouseConfigurationRequest.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<ModifyLakehouseConfigurationRequest.Builder,ModifyLakehouseConfigurationRequest>
      Specified by:
      toBuilder in class RedshiftRequest
      Returns:
      a builder for type T

    • builder

      public static ModifyLakehouseConfigurationRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ModifyLakehouseConfigurationRequest.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.