/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.kinesisfirehose.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.protocol.StructuredPojo; import com.amazonaws.protocol.ProtocolMarshaller; /** *
* Describes the configuration of a destination in Amazon Redshift. *
* * @see AWS API Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class RedshiftDestinationConfiguration implements Serializable, Cloneable, StructuredPojo { /** ** The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more information, see Amazon Resource Names (ARNs) * and Amazon Web Services Service Namespaces. *
*/ private String roleARN; /** ** The database connection string. *
*/ private String clusterJDBCURL; /** *
* The COPY
command.
*
* The name of the user. *
*/ private String username; /** ** The user password. *
*/ private String password; /** ** The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon Redshift. Default value * is 3600 (60 minutes). *
*/ private RedshiftRetryOptions retryOptions; /** ** The configuration for the intermediate Amazon S3 location from which Amazon Redshift obtains data. Restrictions * are described in the topic for CreateDeliveryStream. *
*
* The compression formats SNAPPY
or ZIP
cannot be specified in
* RedshiftDestinationConfiguration.S3Configuration
because the Amazon Redshift COPY
* operation that reads from the S3 bucket doesn't support these compression formats.
*
* The data processing configuration. *
*/ private ProcessingConfiguration processingConfiguration; /** ** The Amazon S3 backup mode. After you create a delivery stream, you can update it to enable Amazon S3 backup if it * is disabled. If backup is enabled, you can't update the delivery stream to disable it. *
*/ private String s3BackupMode; /** ** The configuration for backup in Amazon S3. *
*/ private S3DestinationConfiguration s3BackupConfiguration; /** ** The CloudWatch logging options for your delivery stream. *
*/ private CloudWatchLoggingOptions cloudWatchLoggingOptions; /** ** The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more information, see Amazon Resource Names (ARNs) * and Amazon Web Services Service Namespaces. *
* * @param roleARN * The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more information, see Amazon Resource Names * (ARNs) and Amazon Web Services Service Namespaces. */ public void setRoleARN(String roleARN) { this.roleARN = roleARN; } /** ** The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more information, see Amazon Resource Names (ARNs) * and Amazon Web Services Service Namespaces. *
* * @return The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more information, see Amazon Resource Names * (ARNs) and Amazon Web Services Service Namespaces. */ public String getRoleARN() { return this.roleARN; } /** ** The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more information, see Amazon Resource Names (ARNs) * and Amazon Web Services Service Namespaces. *
* * @param roleARN * The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more information, see Amazon Resource Names * (ARNs) and Amazon Web Services Service Namespaces. * @return Returns a reference to this object so that method calls can be chained together. */ public RedshiftDestinationConfiguration withRoleARN(String roleARN) { setRoleARN(roleARN); return this; } /** ** The database connection string. *
* * @param clusterJDBCURL * The database connection string. */ public void setClusterJDBCURL(String clusterJDBCURL) { this.clusterJDBCURL = clusterJDBCURL; } /** ** The database connection string. *
* * @return The database connection string. */ public String getClusterJDBCURL() { return this.clusterJDBCURL; } /** ** The database connection string. *
* * @param clusterJDBCURL * The database connection string. * @return Returns a reference to this object so that method calls can be chained together. */ public RedshiftDestinationConfiguration withClusterJDBCURL(String clusterJDBCURL) { setClusterJDBCURL(clusterJDBCURL); return this; } /** *
* The COPY
command.
*
COPY
command.
*/
public void setCopyCommand(CopyCommand copyCommand) {
this.copyCommand = copyCommand;
}
/**
*
* The COPY
command.
*
COPY
command.
*/
public CopyCommand getCopyCommand() {
return this.copyCommand;
}
/**
*
* The COPY
command.
*
COPY
command.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RedshiftDestinationConfiguration withCopyCommand(CopyCommand copyCommand) {
setCopyCommand(copyCommand);
return this;
}
/**
* * The name of the user. *
* * @param username * The name of the user. */ public void setUsername(String username) { this.username = username; } /** ** The name of the user. *
* * @return The name of the user. */ public String getUsername() { return this.username; } /** ** The name of the user. *
* * @param username * The name of the user. * @return Returns a reference to this object so that method calls can be chained together. */ public RedshiftDestinationConfiguration withUsername(String username) { setUsername(username); return this; } /** ** The user password. *
* * @param password * The user password. */ public void setPassword(String password) { this.password = password; } /** ** The user password. *
* * @return The user password. */ public String getPassword() { return this.password; } /** ** The user password. *
* * @param password * The user password. * @return Returns a reference to this object so that method calls can be chained together. */ public RedshiftDestinationConfiguration withPassword(String password) { setPassword(password); return this; } /** ** The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon Redshift. Default value * is 3600 (60 minutes). *
* * @param retryOptions * The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon Redshift. * Default value is 3600 (60 minutes). */ public void setRetryOptions(RedshiftRetryOptions retryOptions) { this.retryOptions = retryOptions; } /** ** The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon Redshift. Default value * is 3600 (60 minutes). *
* * @return The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon Redshift. * Default value is 3600 (60 minutes). */ public RedshiftRetryOptions getRetryOptions() { return this.retryOptions; } /** ** The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon Redshift. Default value * is 3600 (60 minutes). *
* * @param retryOptions * The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon Redshift. * Default value is 3600 (60 minutes). * @return Returns a reference to this object so that method calls can be chained together. */ public RedshiftDestinationConfiguration withRetryOptions(RedshiftRetryOptions retryOptions) { setRetryOptions(retryOptions); return this; } /** ** The configuration for the intermediate Amazon S3 location from which Amazon Redshift obtains data. Restrictions * are described in the topic for CreateDeliveryStream. *
*
* The compression formats SNAPPY
or ZIP
cannot be specified in
* RedshiftDestinationConfiguration.S3Configuration
because the Amazon Redshift COPY
* operation that reads from the S3 bucket doesn't support these compression formats.
*
* The compression formats SNAPPY
or ZIP
cannot be specified in
* RedshiftDestinationConfiguration.S3Configuration
because the Amazon Redshift
* COPY
operation that reads from the S3 bucket doesn't support these compression formats.
*/
public void setS3Configuration(S3DestinationConfiguration s3Configuration) {
this.s3Configuration = s3Configuration;
}
/**
*
* The configuration for the intermediate Amazon S3 location from which Amazon Redshift obtains data. Restrictions * are described in the topic for CreateDeliveryStream. *
*
* The compression formats SNAPPY
or ZIP
cannot be specified in
* RedshiftDestinationConfiguration.S3Configuration
because the Amazon Redshift COPY
* operation that reads from the S3 bucket doesn't support these compression formats.
*
* The compression formats SNAPPY
or ZIP
cannot be specified in
* RedshiftDestinationConfiguration.S3Configuration
because the Amazon Redshift
* COPY
operation that reads from the S3 bucket doesn't support these compression formats.
*/
public S3DestinationConfiguration getS3Configuration() {
return this.s3Configuration;
}
/**
*
* The configuration for the intermediate Amazon S3 location from which Amazon Redshift obtains data. Restrictions * are described in the topic for CreateDeliveryStream. *
*
* The compression formats SNAPPY
or ZIP
cannot be specified in
* RedshiftDestinationConfiguration.S3Configuration
because the Amazon Redshift COPY
* operation that reads from the S3 bucket doesn't support these compression formats.
*
* The compression formats SNAPPY
or ZIP
cannot be specified in
* RedshiftDestinationConfiguration.S3Configuration
because the Amazon Redshift
* COPY
operation that reads from the S3 bucket doesn't support these compression formats.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RedshiftDestinationConfiguration withS3Configuration(S3DestinationConfiguration s3Configuration) {
setS3Configuration(s3Configuration);
return this;
}
/**
*
* The data processing configuration. *
* * @param processingConfiguration * The data processing configuration. */ public void setProcessingConfiguration(ProcessingConfiguration processingConfiguration) { this.processingConfiguration = processingConfiguration; } /** ** The data processing configuration. *
* * @return The data processing configuration. */ public ProcessingConfiguration getProcessingConfiguration() { return this.processingConfiguration; } /** ** The data processing configuration. *
* * @param processingConfiguration * The data processing configuration. * @return Returns a reference to this object so that method calls can be chained together. */ public RedshiftDestinationConfiguration withProcessingConfiguration(ProcessingConfiguration processingConfiguration) { setProcessingConfiguration(processingConfiguration); return this; } /** ** The Amazon S3 backup mode. After you create a delivery stream, you can update it to enable Amazon S3 backup if it * is disabled. If backup is enabled, you can't update the delivery stream to disable it. *
* * @param s3BackupMode * The Amazon S3 backup mode. After you create a delivery stream, you can update it to enable Amazon S3 * backup if it is disabled. If backup is enabled, you can't update the delivery stream to disable it. * @see RedshiftS3BackupMode */ public void setS3BackupMode(String s3BackupMode) { this.s3BackupMode = s3BackupMode; } /** ** The Amazon S3 backup mode. After you create a delivery stream, you can update it to enable Amazon S3 backup if it * is disabled. If backup is enabled, you can't update the delivery stream to disable it. *
* * @return The Amazon S3 backup mode. After you create a delivery stream, you can update it to enable Amazon S3 * backup if it is disabled. If backup is enabled, you can't update the delivery stream to disable it. * @see RedshiftS3BackupMode */ public String getS3BackupMode() { return this.s3BackupMode; } /** ** The Amazon S3 backup mode. After you create a delivery stream, you can update it to enable Amazon S3 backup if it * is disabled. If backup is enabled, you can't update the delivery stream to disable it. *
* * @param s3BackupMode * The Amazon S3 backup mode. After you create a delivery stream, you can update it to enable Amazon S3 * backup if it is disabled. If backup is enabled, you can't update the delivery stream to disable it. * @return Returns a reference to this object so that method calls can be chained together. * @see RedshiftS3BackupMode */ public RedshiftDestinationConfiguration withS3BackupMode(String s3BackupMode) { setS3BackupMode(s3BackupMode); return this; } /** ** The Amazon S3 backup mode. After you create a delivery stream, you can update it to enable Amazon S3 backup if it * is disabled. If backup is enabled, you can't update the delivery stream to disable it. *
* * @param s3BackupMode * The Amazon S3 backup mode. After you create a delivery stream, you can update it to enable Amazon S3 * backup if it is disabled. If backup is enabled, you can't update the delivery stream to disable it. * @see RedshiftS3BackupMode */ public void setS3BackupMode(RedshiftS3BackupMode s3BackupMode) { withS3BackupMode(s3BackupMode); } /** ** The Amazon S3 backup mode. After you create a delivery stream, you can update it to enable Amazon S3 backup if it * is disabled. If backup is enabled, you can't update the delivery stream to disable it. *
* * @param s3BackupMode * The Amazon S3 backup mode. After you create a delivery stream, you can update it to enable Amazon S3 * backup if it is disabled. If backup is enabled, you can't update the delivery stream to disable it. * @return Returns a reference to this object so that method calls can be chained together. * @see RedshiftS3BackupMode */ public RedshiftDestinationConfiguration withS3BackupMode(RedshiftS3BackupMode s3BackupMode) { this.s3BackupMode = s3BackupMode.toString(); return this; } /** ** The configuration for backup in Amazon S3. *
* * @param s3BackupConfiguration * The configuration for backup in Amazon S3. */ public void setS3BackupConfiguration(S3DestinationConfiguration s3BackupConfiguration) { this.s3BackupConfiguration = s3BackupConfiguration; } /** ** The configuration for backup in Amazon S3. *
* * @return The configuration for backup in Amazon S3. */ public S3DestinationConfiguration getS3BackupConfiguration() { return this.s3BackupConfiguration; } /** ** The configuration for backup in Amazon S3. *
* * @param s3BackupConfiguration * The configuration for backup in Amazon S3. * @return Returns a reference to this object so that method calls can be chained together. */ public RedshiftDestinationConfiguration withS3BackupConfiguration(S3DestinationConfiguration s3BackupConfiguration) { setS3BackupConfiguration(s3BackupConfiguration); return this; } /** ** The CloudWatch logging options for your delivery stream. *
* * @param cloudWatchLoggingOptions * The CloudWatch logging options for your delivery stream. */ public void setCloudWatchLoggingOptions(CloudWatchLoggingOptions cloudWatchLoggingOptions) { this.cloudWatchLoggingOptions = cloudWatchLoggingOptions; } /** ** The CloudWatch logging options for your delivery stream. *
* * @return The CloudWatch logging options for your delivery stream. */ public CloudWatchLoggingOptions getCloudWatchLoggingOptions() { return this.cloudWatchLoggingOptions; } /** ** The CloudWatch logging options for your delivery stream. *
* * @param cloudWatchLoggingOptions * The CloudWatch logging options for your delivery stream. * @return Returns a reference to this object so that method calls can be chained together. */ public RedshiftDestinationConfiguration withCloudWatchLoggingOptions(CloudWatchLoggingOptions cloudWatchLoggingOptions) { setCloudWatchLoggingOptions(cloudWatchLoggingOptions); return this; } /** * 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. * * @return A string representation of this object. * * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getRoleARN() != null) sb.append("RoleARN: ").append(getRoleARN()).append(","); if (getClusterJDBCURL() != null) sb.append("ClusterJDBCURL: ").append(getClusterJDBCURL()).append(","); if (getCopyCommand() != null) sb.append("CopyCommand: ").append(getCopyCommand()).append(","); if (getUsername() != null) sb.append("Username: ").append("***Sensitive Data Redacted***").append(","); if (getPassword() != null) sb.append("Password: ").append("***Sensitive Data Redacted***").append(","); if (getRetryOptions() != null) sb.append("RetryOptions: ").append(getRetryOptions()).append(","); if (getS3Configuration() != null) sb.append("S3Configuration: ").append(getS3Configuration()).append(","); if (getProcessingConfiguration() != null) sb.append("ProcessingConfiguration: ").append(getProcessingConfiguration()).append(","); if (getS3BackupMode() != null) sb.append("S3BackupMode: ").append(getS3BackupMode()).append(","); if (getS3BackupConfiguration() != null) sb.append("S3BackupConfiguration: ").append(getS3BackupConfiguration()).append(","); if (getCloudWatchLoggingOptions() != null) sb.append("CloudWatchLoggingOptions: ").append(getCloudWatchLoggingOptions()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof RedshiftDestinationConfiguration == false) return false; RedshiftDestinationConfiguration other = (RedshiftDestinationConfiguration) obj; if (other.getRoleARN() == null ^ this.getRoleARN() == null) return false; if (other.getRoleARN() != null && other.getRoleARN().equals(this.getRoleARN()) == false) return false; if (other.getClusterJDBCURL() == null ^ this.getClusterJDBCURL() == null) return false; if (other.getClusterJDBCURL() != null && other.getClusterJDBCURL().equals(this.getClusterJDBCURL()) == false) return false; if (other.getCopyCommand() == null ^ this.getCopyCommand() == null) return false; if (other.getCopyCommand() != null && other.getCopyCommand().equals(this.getCopyCommand()) == false) return false; if (other.getUsername() == null ^ this.getUsername() == null) return false; if (other.getUsername() != null && other.getUsername().equals(this.getUsername()) == false) return false; if (other.getPassword() == null ^ this.getPassword() == null) return false; if (other.getPassword() != null && other.getPassword().equals(this.getPassword()) == false) return false; if (other.getRetryOptions() == null ^ this.getRetryOptions() == null) return false; if (other.getRetryOptions() != null && other.getRetryOptions().equals(this.getRetryOptions()) == false) return false; if (other.getS3Configuration() == null ^ this.getS3Configuration() == null) return false; if (other.getS3Configuration() != null && other.getS3Configuration().equals(this.getS3Configuration()) == false) return false; if (other.getProcessingConfiguration() == null ^ this.getProcessingConfiguration() == null) return false; if (other.getProcessingConfiguration() != null && other.getProcessingConfiguration().equals(this.getProcessingConfiguration()) == false) return false; if (other.getS3BackupMode() == null ^ this.getS3BackupMode() == null) return false; if (other.getS3BackupMode() != null && other.getS3BackupMode().equals(this.getS3BackupMode()) == false) return false; if (other.getS3BackupConfiguration() == null ^ this.getS3BackupConfiguration() == null) return false; if (other.getS3BackupConfiguration() != null && other.getS3BackupConfiguration().equals(this.getS3BackupConfiguration()) == false) return false; if (other.getCloudWatchLoggingOptions() == null ^ this.getCloudWatchLoggingOptions() == null) return false; if (other.getCloudWatchLoggingOptions() != null && other.getCloudWatchLoggingOptions().equals(this.getCloudWatchLoggingOptions()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getRoleARN() == null) ? 0 : getRoleARN().hashCode()); hashCode = prime * hashCode + ((getClusterJDBCURL() == null) ? 0 : getClusterJDBCURL().hashCode()); hashCode = prime * hashCode + ((getCopyCommand() == null) ? 0 : getCopyCommand().hashCode()); hashCode = prime * hashCode + ((getUsername() == null) ? 0 : getUsername().hashCode()); hashCode = prime * hashCode + ((getPassword() == null) ? 0 : getPassword().hashCode()); hashCode = prime * hashCode + ((getRetryOptions() == null) ? 0 : getRetryOptions().hashCode()); hashCode = prime * hashCode + ((getS3Configuration() == null) ? 0 : getS3Configuration().hashCode()); hashCode = prime * hashCode + ((getProcessingConfiguration() == null) ? 0 : getProcessingConfiguration().hashCode()); hashCode = prime * hashCode + ((getS3BackupMode() == null) ? 0 : getS3BackupMode().hashCode()); hashCode = prime * hashCode + ((getS3BackupConfiguration() == null) ? 0 : getS3BackupConfiguration().hashCode()); hashCode = prime * hashCode + ((getCloudWatchLoggingOptions() == null) ? 0 : getCloudWatchLoggingOptions().hashCode()); return hashCode; } @Override public RedshiftDestinationConfiguration clone() { try { return (RedshiftDestinationConfiguration) super.clone(); } catch (CloneNotSupportedException e) { throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e); } } @com.amazonaws.annotation.SdkInternalApi @Override public void marshall(ProtocolMarshaller protocolMarshaller) { com.amazonaws.services.kinesisfirehose.model.transform.RedshiftDestinationConfigurationMarshaller.getInstance().marshall(this, protocolMarshaller); } }