com.amazonaws.services.databasemigrationservice.model.CreateEndpointRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-dms Show documentation
/*
* Copyright 2014-2019 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.databasemigrationservice.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class CreateEndpointRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The database endpoint identifier. Identifiers must begin with a letter; must contain only ASCII letters, digits,
* and hyphens; and must not end with a hyphen or contain two consecutive hyphens.
*
*/
private String endpointIdentifier;
/**
*
* The type of endpoint.
*
*/
private String endpointType;
/**
*
* The type of engine for the endpoint. Valid values, depending on the EndPointType value, include
* mysql, oracle, postgres, mariadb, aurora,
* aurora-postgresql, redshift, s3, db2, azuredb,
* sybase, dynamodb, mongodb, and sqlserver.
*
*/
private String engineName;
/**
*
* The user name to be used to log in to the endpoint database.
*
*/
private String username;
/**
*
* The password to be used to log in to the endpoint database.
*
*/
private String password;
/**
*
* The name of the server where the endpoint database resides.
*
*/
private String serverName;
/**
*
* The port used by the endpoint database.
*
*/
private Integer port;
/**
*
* The name of the endpoint database.
*
*/
private String databaseName;
/**
*
* Additional attributes associated with the connection.
*
*/
private String extraConnectionAttributes;
/**
*
* The AWS KMS key identifier to use to encrypt the connection parameters. If you don't specify a value for the
* KmsKeyId parameter, then AWS DMS uses your default encryption key. AWS KMS creates the default
* encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.
*
*/
private String kmsKeyId;
/**
*
* Tags to be added to the endpoint.
*
*/
private java.util.List tags;
/**
*
* The Amazon Resource Name (ARN) for the certificate.
*
*/
private String certificateArn;
/**
*
* The Secure Sockets Layer (SSL) mode to use for the SSL connection. The SSL mode can be one of four values:
* none, require, verify-ca, verify-full. The default value is
* none.
*
*/
private String sslMode;
/**
*
* The Amazon Resource Name (ARN) for the service access role that you want to use to create the endpoint.
*
*/
private String serviceAccessRoleArn;
/**
*
* The external table definition.
*
*/
private String externalTableDefinition;
/**
*
* Settings in JSON format for the target Amazon DynamoDB endpoint. For more information about the available
* settings, see Using Object
* Mapping to Migrate Data to DynamoDB in the AWS Database Migration Service User Guide.
*
*/
private DynamoDbSettings dynamoDbSettings;
/**
*
* Settings in JSON format for the target Amazon S3 endpoint. For more information about the available settings, see
* Extra
* Connection Attributes When Using Amazon S3 as a Target for AWS DMS in the AWS Database Migration Service
* User Guide.
*
*/
private S3Settings s3Settings;
/**
*
* The settings in JSON format for the DMS transfer type of source endpoint.
*
*
* Possible attributes include the following:
*
*
* -
*
* serviceAccessRoleArn - The IAM role that has permission to access the Amazon S3 bucket.
*
*
* -
*
* bucketName - The name of the S3 bucket to use.
*
*
* -
*
* compressionType - An optional parameter to use GZIP to compress the target files. To use GZIP, set
* this value to NONE (the default). To keep the files uncompressed, don't use this value.
*
*
*
*
* Shorthand syntax for these attributes is as follows:
* ServiceAccessRoleArn=string,BucketName=string,CompressionType=string
*
*
* JSON syntax for these attributes is as follows:
* { "ServiceAccessRoleArn": "string", "BucketName": "string", "CompressionType": "none"|"gzip" }
*
*/
private DmsTransferSettings dmsTransferSettings;
/**
*
* Settings in JSON format for the source MongoDB endpoint. For more information about the available settings, see
* the configuration properties section in Using MongoDB as a Target for
* AWS Database Migration Service in the AWS Database Migration Service User Guide.
*
*/
private MongoDbSettings mongoDbSettings;
/**
*
* Settings in JSON format for the target Amazon Kinesis Data Streams endpoint. For more information about the
* available settings, see Using Object Mapping to Migrate Data to a Kinesis Data Stream in the AWS Database Migration User
* Guide.
*
*/
private KinesisSettings kinesisSettings;
/**
*
* Settings in JSON format for the target Elasticsearch endpoint. For more information about the available settings,
* see Extra Connection Attributes When Using Elasticsearch as a Target for AWS DMS in the AWS Database
* Migration User Guide.
*
*/
private ElasticsearchSettings elasticsearchSettings;
private RedshiftSettings redshiftSettings;
/**
*
* The database endpoint identifier. Identifiers must begin with a letter; must contain only ASCII letters, digits,
* and hyphens; and must not end with a hyphen or contain two consecutive hyphens.
*
*
* @param endpointIdentifier
* The database endpoint identifier. Identifiers must begin with a letter; must contain only ASCII letters,
* digits, and hyphens; and must not end with a hyphen or contain two consecutive hyphens.
*/
public void setEndpointIdentifier(String endpointIdentifier) {
this.endpointIdentifier = endpointIdentifier;
}
/**
*
* The database endpoint identifier. Identifiers must begin with a letter; must contain only ASCII letters, digits,
* and hyphens; and must not end with a hyphen or contain two consecutive hyphens.
*
*
* @return The database endpoint identifier. Identifiers must begin with a letter; must contain only ASCII letters,
* digits, and hyphens; and must not end with a hyphen or contain two consecutive hyphens.
*/
public String getEndpointIdentifier() {
return this.endpointIdentifier;
}
/**
*
* The database endpoint identifier. Identifiers must begin with a letter; must contain only ASCII letters, digits,
* and hyphens; and must not end with a hyphen or contain two consecutive hyphens.
*
*
* @param endpointIdentifier
* The database endpoint identifier. Identifiers must begin with a letter; must contain only ASCII letters,
* digits, and hyphens; and must not end with a hyphen or contain two consecutive hyphens.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateEndpointRequest withEndpointIdentifier(String endpointIdentifier) {
setEndpointIdentifier(endpointIdentifier);
return this;
}
/**
*
* The type of endpoint.
*
*
* @param endpointType
* The type of endpoint.
* @see ReplicationEndpointTypeValue
*/
public void setEndpointType(String endpointType) {
this.endpointType = endpointType;
}
/**
*
* The type of endpoint.
*
*
* @return The type of endpoint.
* @see ReplicationEndpointTypeValue
*/
public String getEndpointType() {
return this.endpointType;
}
/**
*
* The type of endpoint.
*
*
* @param endpointType
* The type of endpoint.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ReplicationEndpointTypeValue
*/
public CreateEndpointRequest withEndpointType(String endpointType) {
setEndpointType(endpointType);
return this;
}
/**
*
* The type of endpoint.
*
*
* @param endpointType
* The type of endpoint.
* @see ReplicationEndpointTypeValue
*/
public void setEndpointType(ReplicationEndpointTypeValue endpointType) {
withEndpointType(endpointType);
}
/**
*
* The type of endpoint.
*
*
* @param endpointType
* The type of endpoint.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ReplicationEndpointTypeValue
*/
public CreateEndpointRequest withEndpointType(ReplicationEndpointTypeValue endpointType) {
this.endpointType = endpointType.toString();
return this;
}
/**
*
* The type of engine for the endpoint. Valid values, depending on the EndPointType value, include
* mysql, oracle, postgres, mariadb, aurora,
* aurora-postgresql, redshift, s3, db2, azuredb,
* sybase, dynamodb, mongodb, and sqlserver.
*
*
* @param engineName
* The type of engine for the endpoint. Valid values, depending on the EndPointType value,
* include mysql, oracle, postgres, mariadb,
* aurora, aurora-postgresql, redshift, s3,
* db2, azuredb, sybase, dynamodb, mongodb,
* and sqlserver.
*/
public void setEngineName(String engineName) {
this.engineName = engineName;
}
/**
*
* The type of engine for the endpoint. Valid values, depending on the EndPointType value, include
* mysql, oracle, postgres, mariadb, aurora,
* aurora-postgresql, redshift, s3, db2, azuredb,
* sybase, dynamodb, mongodb, and sqlserver.
*
*
* @return The type of engine for the endpoint. Valid values, depending on the EndPointType value,
* include mysql, oracle, postgres, mariadb,
* aurora, aurora-postgresql, redshift, s3,
* db2, azuredb, sybase, dynamodb, mongodb,
* and sqlserver.
*/
public String getEngineName() {
return this.engineName;
}
/**
*
* The type of engine for the endpoint. Valid values, depending on the EndPointType value, include
* mysql, oracle, postgres, mariadb, aurora,
* aurora-postgresql, redshift, s3, db2, azuredb,
* sybase, dynamodb, mongodb, and sqlserver.
*
*
* @param engineName
* The type of engine for the endpoint. Valid values, depending on the EndPointType value,
* include mysql, oracle, postgres, mariadb,
* aurora, aurora-postgresql, redshift, s3,
* db2, azuredb, sybase, dynamodb, mongodb,
* and sqlserver.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateEndpointRequest withEngineName(String engineName) {
setEngineName(engineName);
return this;
}
/**
*
* The user name to be used to log in to the endpoint database.
*
*
* @param username
* The user name to be used to log in to the endpoint database.
*/
public void setUsername(String username) {
this.username = username;
}
/**
*
* The user name to be used to log in to the endpoint database.
*
*
* @return The user name to be used to log in to the endpoint database.
*/
public String getUsername() {
return this.username;
}
/**
*
* The user name to be used to log in to the endpoint database.
*
*
* @param username
* The user name to be used to log in to the endpoint database.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateEndpointRequest withUsername(String username) {
setUsername(username);
return this;
}
/**
*
* The password to be used to log in to the endpoint database.
*
*
* @param password
* The password to be used to log in to the endpoint database.
*/
public void setPassword(String password) {
this.password = password;
}
/**
*
* The password to be used to log in to the endpoint database.
*
*
* @return The password to be used to log in to the endpoint database.
*/
public String getPassword() {
return this.password;
}
/**
*
* The password to be used to log in to the endpoint database.
*
*
* @param password
* The password to be used to log in to the endpoint database.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateEndpointRequest withPassword(String password) {
setPassword(password);
return this;
}
/**
*
* The name of the server where the endpoint database resides.
*
*
* @param serverName
* The name of the server where the endpoint database resides.
*/
public void setServerName(String serverName) {
this.serverName = serverName;
}
/**
*
* The name of the server where the endpoint database resides.
*
*
* @return The name of the server where the endpoint database resides.
*/
public String getServerName() {
return this.serverName;
}
/**
*
* The name of the server where the endpoint database resides.
*
*
* @param serverName
* The name of the server where the endpoint database resides.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateEndpointRequest withServerName(String serverName) {
setServerName(serverName);
return this;
}
/**
*
* The port used by the endpoint database.
*
*
* @param port
* The port used by the endpoint database.
*/
public void setPort(Integer port) {
this.port = port;
}
/**
*
* The port used by the endpoint database.
*
*
* @return The port used by the endpoint database.
*/
public Integer getPort() {
return this.port;
}
/**
*
* The port used by the endpoint database.
*
*
* @param port
* The port used by the endpoint database.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateEndpointRequest withPort(Integer port) {
setPort(port);
return this;
}
/**
*
* The name of the endpoint database.
*
*
* @param databaseName
* The name of the endpoint database.
*/
public void setDatabaseName(String databaseName) {
this.databaseName = databaseName;
}
/**
*
* The name of the endpoint database.
*
*
* @return The name of the endpoint database.
*/
public String getDatabaseName() {
return this.databaseName;
}
/**
*
* The name of the endpoint database.
*
*
* @param databaseName
* The name of the endpoint database.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateEndpointRequest withDatabaseName(String databaseName) {
setDatabaseName(databaseName);
return this;
}
/**
*
* Additional attributes associated with the connection.
*
*
* @param extraConnectionAttributes
* Additional attributes associated with the connection.
*/
public void setExtraConnectionAttributes(String extraConnectionAttributes) {
this.extraConnectionAttributes = extraConnectionAttributes;
}
/**
*
* Additional attributes associated with the connection.
*
*
* @return Additional attributes associated with the connection.
*/
public String getExtraConnectionAttributes() {
return this.extraConnectionAttributes;
}
/**
*
* Additional attributes associated with the connection.
*
*
* @param extraConnectionAttributes
* Additional attributes associated with the connection.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateEndpointRequest withExtraConnectionAttributes(String extraConnectionAttributes) {
setExtraConnectionAttributes(extraConnectionAttributes);
return this;
}
/**
*
* The AWS KMS key identifier to use to encrypt the connection parameters. If you don't specify a value for the
* KmsKeyId parameter, then AWS DMS uses your default encryption key. AWS KMS creates the default
* encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.
*
*
* @param kmsKeyId
* The AWS KMS key identifier to use to encrypt the connection parameters. If you don't specify a value for
* the KmsKeyId parameter, then AWS DMS uses your default encryption key. AWS KMS creates the
* default encryption key for your AWS account. Your AWS account has a different default encryption key for
* each AWS Region.
*/
public void setKmsKeyId(String kmsKeyId) {
this.kmsKeyId = kmsKeyId;
}
/**
*
* The AWS KMS key identifier to use to encrypt the connection parameters. If you don't specify a value for the
* KmsKeyId parameter, then AWS DMS uses your default encryption key. AWS KMS creates the default
* encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.
*
*
* @return The AWS KMS key identifier to use to encrypt the connection parameters. If you don't specify a value for
* the KmsKeyId parameter, then AWS DMS uses your default encryption key. AWS KMS creates the
* default encryption key for your AWS account. Your AWS account has a different default encryption key for
* each AWS Region.
*/
public String getKmsKeyId() {
return this.kmsKeyId;
}
/**
*
* The AWS KMS key identifier to use to encrypt the connection parameters. If you don't specify a value for the
* KmsKeyId parameter, then AWS DMS uses your default encryption key. AWS KMS creates the default
* encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.
*
*
* @param kmsKeyId
* The AWS KMS key identifier to use to encrypt the connection parameters. If you don't specify a value for
* the KmsKeyId parameter, then AWS DMS uses your default encryption key. AWS KMS creates the
* default encryption key for your AWS account. Your AWS account has a different default encryption key for
* each AWS Region.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateEndpointRequest withKmsKeyId(String kmsKeyId) {
setKmsKeyId(kmsKeyId);
return this;
}
/**
*
* Tags to be added to the endpoint.
*
*
* @return Tags to be added to the endpoint.
*/
public java.util.List getTags() {
return tags;
}
/**
*
* Tags to be added to the endpoint.
*
*
* @param tags
* Tags to be added to the endpoint.
*/
public void setTags(java.util.Collection tags) {
if (tags == null) {
this.tags = null;
return;
}
this.tags = new java.util.ArrayList(tags);
}
/**
*
* Tags to be added to the endpoint.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setTags(java.util.Collection)} or {@link #withTags(java.util.Collection)} if you want to override the
* existing values.
*
*
* @param tags
* Tags to be added to the endpoint.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateEndpointRequest withTags(Tag... tags) {
if (this.tags == null) {
setTags(new java.util.ArrayList(tags.length));
}
for (Tag ele : tags) {
this.tags.add(ele);
}
return this;
}
/**
*
* Tags to be added to the endpoint.
*
*
* @param tags
* Tags to be added to the endpoint.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateEndpointRequest withTags(java.util.Collection tags) {
setTags(tags);
return this;
}
/**
*
* The Amazon Resource Name (ARN) for the certificate.
*
*
* @param certificateArn
* The Amazon Resource Name (ARN) for the certificate.
*/
public void setCertificateArn(String certificateArn) {
this.certificateArn = certificateArn;
}
/**
*
* The Amazon Resource Name (ARN) for the certificate.
*
*
* @return The Amazon Resource Name (ARN) for the certificate.
*/
public String getCertificateArn() {
return this.certificateArn;
}
/**
*
* The Amazon Resource Name (ARN) for the certificate.
*
*
* @param certificateArn
* The Amazon Resource Name (ARN) for the certificate.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateEndpointRequest withCertificateArn(String certificateArn) {
setCertificateArn(certificateArn);
return this;
}
/**
*
* The Secure Sockets Layer (SSL) mode to use for the SSL connection. The SSL mode can be one of four values:
* none, require, verify-ca, verify-full. The default value is
* none.
*
*
* @param sslMode
* The Secure Sockets Layer (SSL) mode to use for the SSL connection. The SSL mode can be one of four values:
* none, require, verify-ca, verify-full. The default
* value is none.
* @see DmsSslModeValue
*/
public void setSslMode(String sslMode) {
this.sslMode = sslMode;
}
/**
*
* The Secure Sockets Layer (SSL) mode to use for the SSL connection. The SSL mode can be one of four values:
* none, require, verify-ca, verify-full. The default value is
* none.
*
*
* @return The Secure Sockets Layer (SSL) mode to use for the SSL connection. The SSL mode can be one of four
* values: none, require, verify-ca, verify-full. The
* default value is none.
* @see DmsSslModeValue
*/
public String getSslMode() {
return this.sslMode;
}
/**
*
* The Secure Sockets Layer (SSL) mode to use for the SSL connection. The SSL mode can be one of four values:
* none, require, verify-ca, verify-full. The default value is
* none.
*
*
* @param sslMode
* The Secure Sockets Layer (SSL) mode to use for the SSL connection. The SSL mode can be one of four values:
* none, require, verify-ca, verify-full. The default
* value is none.
* @return Returns a reference to this object so that method calls can be chained together.
* @see DmsSslModeValue
*/
public CreateEndpointRequest withSslMode(String sslMode) {
setSslMode(sslMode);
return this;
}
/**
*
* The Secure Sockets Layer (SSL) mode to use for the SSL connection. The SSL mode can be one of four values:
* none, require, verify-ca, verify-full. The default value is
* none.
*
*
* @param sslMode
* The Secure Sockets Layer (SSL) mode to use for the SSL connection. The SSL mode can be one of four values:
* none, require, verify-ca, verify-full. The default
* value is none.
* @see DmsSslModeValue
*/
public void setSslMode(DmsSslModeValue sslMode) {
withSslMode(sslMode);
}
/**
*
* The Secure Sockets Layer (SSL) mode to use for the SSL connection. The SSL mode can be one of four values:
* none, require, verify-ca, verify-full. The default value is
* none.
*
*
* @param sslMode
* The Secure Sockets Layer (SSL) mode to use for the SSL connection. The SSL mode can be one of four values:
* none, require, verify-ca, verify-full. The default
* value is none.
* @return Returns a reference to this object so that method calls can be chained together.
* @see DmsSslModeValue
*/
public CreateEndpointRequest withSslMode(DmsSslModeValue sslMode) {
this.sslMode = sslMode.toString();
return this;
}
/**
*
* The Amazon Resource Name (ARN) for the service access role that you want to use to create the endpoint.
*
*
* @param serviceAccessRoleArn
* The Amazon Resource Name (ARN) for the service access role that you want to use to create the endpoint.
*/
public void setServiceAccessRoleArn(String serviceAccessRoleArn) {
this.serviceAccessRoleArn = serviceAccessRoleArn;
}
/**
*
* The Amazon Resource Name (ARN) for the service access role that you want to use to create the endpoint.
*
*
* @return The Amazon Resource Name (ARN) for the service access role that you want to use to create the endpoint.
*/
public String getServiceAccessRoleArn() {
return this.serviceAccessRoleArn;
}
/**
*
* The Amazon Resource Name (ARN) for the service access role that you want to use to create the endpoint.
*
*
* @param serviceAccessRoleArn
* The Amazon Resource Name (ARN) for the service access role that you want to use to create the endpoint.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateEndpointRequest withServiceAccessRoleArn(String serviceAccessRoleArn) {
setServiceAccessRoleArn(serviceAccessRoleArn);
return this;
}
/**
*
* The external table definition.
*
*
* @param externalTableDefinition
* The external table definition.
*/
public void setExternalTableDefinition(String externalTableDefinition) {
this.externalTableDefinition = externalTableDefinition;
}
/**
*
* The external table definition.
*
*
* @return The external table definition.
*/
public String getExternalTableDefinition() {
return this.externalTableDefinition;
}
/**
*
* The external table definition.
*
*
* @param externalTableDefinition
* The external table definition.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateEndpointRequest withExternalTableDefinition(String externalTableDefinition) {
setExternalTableDefinition(externalTableDefinition);
return this;
}
/**
*
* Settings in JSON format for the target Amazon DynamoDB endpoint. For more information about the available
* settings, see Using Object
* Mapping to Migrate Data to DynamoDB in the AWS Database Migration Service User Guide.
*
*
* @param dynamoDbSettings
* Settings in JSON format for the target Amazon DynamoDB endpoint. For more information about the available
* settings, see Using
* Object Mapping to Migrate Data to DynamoDB in the AWS Database Migration Service User Guide.
*/
public void setDynamoDbSettings(DynamoDbSettings dynamoDbSettings) {
this.dynamoDbSettings = dynamoDbSettings;
}
/**
*
* Settings in JSON format for the target Amazon DynamoDB endpoint. For more information about the available
* settings, see Using Object
* Mapping to Migrate Data to DynamoDB in the AWS Database Migration Service User Guide.
*
*
* @return Settings in JSON format for the target Amazon DynamoDB endpoint. For more information about the available
* settings, see Using
* Object Mapping to Migrate Data to DynamoDB in the AWS Database Migration Service User Guide.
*/
public DynamoDbSettings getDynamoDbSettings() {
return this.dynamoDbSettings;
}
/**
*
* Settings in JSON format for the target Amazon DynamoDB endpoint. For more information about the available
* settings, see Using Object
* Mapping to Migrate Data to DynamoDB in the AWS Database Migration Service User Guide.
*
*
* @param dynamoDbSettings
* Settings in JSON format for the target Amazon DynamoDB endpoint. For more information about the available
* settings, see Using
* Object Mapping to Migrate Data to DynamoDB in the AWS Database Migration Service User Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateEndpointRequest withDynamoDbSettings(DynamoDbSettings dynamoDbSettings) {
setDynamoDbSettings(dynamoDbSettings);
return this;
}
/**
*
* Settings in JSON format for the target Amazon S3 endpoint. For more information about the available settings, see
* Extra
* Connection Attributes When Using Amazon S3 as a Target for AWS DMS in the AWS Database Migration Service
* User Guide.
*
*
* @param s3Settings
* Settings in JSON format for the target Amazon S3 endpoint. For more information about the available
* settings, see Extra Connection Attributes When Using Amazon S3 as a Target for AWS DMS in the AWS Database
* Migration Service User Guide.
*/
public void setS3Settings(S3Settings s3Settings) {
this.s3Settings = s3Settings;
}
/**
*
* Settings in JSON format for the target Amazon S3 endpoint. For more information about the available settings, see
* Extra
* Connection Attributes When Using Amazon S3 as a Target for AWS DMS in the AWS Database Migration Service
* User Guide.
*
*
* @return Settings in JSON format for the target Amazon S3 endpoint. For more information about the available
* settings, see Extra Connection Attributes When Using Amazon S3 as a Target for AWS DMS in the AWS Database
* Migration Service User Guide.
*/
public S3Settings getS3Settings() {
return this.s3Settings;
}
/**
*
* Settings in JSON format for the target Amazon S3 endpoint. For more information about the available settings, see
* Extra
* Connection Attributes When Using Amazon S3 as a Target for AWS DMS in the AWS Database Migration Service
* User Guide.
*
*
* @param s3Settings
* Settings in JSON format for the target Amazon S3 endpoint. For more information about the available
* settings, see Extra Connection Attributes When Using Amazon S3 as a Target for AWS DMS in the AWS Database
* Migration Service User Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateEndpointRequest withS3Settings(S3Settings s3Settings) {
setS3Settings(s3Settings);
return this;
}
/**
*
* The settings in JSON format for the DMS transfer type of source endpoint.
*
*
* Possible attributes include the following:
*
*
* -
*
* serviceAccessRoleArn - The IAM role that has permission to access the Amazon S3 bucket.
*
*
* -
*
* bucketName - The name of the S3 bucket to use.
*
*
* -
*
* compressionType - An optional parameter to use GZIP to compress the target files. To use GZIP, set
* this value to NONE (the default). To keep the files uncompressed, don't use this value.
*
*
*
*
* Shorthand syntax for these attributes is as follows:
* ServiceAccessRoleArn=string,BucketName=string,CompressionType=string
*
*
* JSON syntax for these attributes is as follows:
* { "ServiceAccessRoleArn": "string", "BucketName": "string", "CompressionType": "none"|"gzip" }
*
*
* @param dmsTransferSettings
* The settings in JSON format for the DMS transfer type of source endpoint.
*
* Possible attributes include the following:
*
*
* -
*
* serviceAccessRoleArn - The IAM role that has permission to access the Amazon S3 bucket.
*
*
* -
*
* bucketName - The name of the S3 bucket to use.
*
*
* -
*
* compressionType - An optional parameter to use GZIP to compress the target files. To use
* GZIP, set this value to NONE (the default). To keep the files uncompressed, don't use this
* value.
*
*
*
*
* Shorthand syntax for these attributes is as follows:
* ServiceAccessRoleArn=string,BucketName=string,CompressionType=string
*
*
* JSON syntax for these attributes is as follows:
* { "ServiceAccessRoleArn": "string", "BucketName": "string", "CompressionType": "none"|"gzip" }
*/
public void setDmsTransferSettings(DmsTransferSettings dmsTransferSettings) {
this.dmsTransferSettings = dmsTransferSettings;
}
/**
*
* The settings in JSON format for the DMS transfer type of source endpoint.
*
*
* Possible attributes include the following:
*
*
* -
*
* serviceAccessRoleArn - The IAM role that has permission to access the Amazon S3 bucket.
*
*
* -
*
* bucketName - The name of the S3 bucket to use.
*
*
* -
*
* compressionType - An optional parameter to use GZIP to compress the target files. To use GZIP, set
* this value to NONE (the default). To keep the files uncompressed, don't use this value.
*
*
*
*
* Shorthand syntax for these attributes is as follows:
* ServiceAccessRoleArn=string,BucketName=string,CompressionType=string
*
*
* JSON syntax for these attributes is as follows:
* { "ServiceAccessRoleArn": "string", "BucketName": "string", "CompressionType": "none"|"gzip" }
*
*
* @return The settings in JSON format for the DMS transfer type of source endpoint.
*
* Possible attributes include the following:
*
*
* -
*
* serviceAccessRoleArn - The IAM role that has permission to access the Amazon S3 bucket.
*
*
* -
*
* bucketName - The name of the S3 bucket to use.
*
*
* -
*
* compressionType - An optional parameter to use GZIP to compress the target files. To use
* GZIP, set this value to NONE (the default). To keep the files uncompressed, don't use this
* value.
*
*
*
*
* Shorthand syntax for these attributes is as follows:
* ServiceAccessRoleArn=string,BucketName=string,CompressionType=string
*
*
* JSON syntax for these attributes is as follows:
* { "ServiceAccessRoleArn": "string", "BucketName": "string", "CompressionType": "none"|"gzip" }
*/
public DmsTransferSettings getDmsTransferSettings() {
return this.dmsTransferSettings;
}
/**
*
* The settings in JSON format for the DMS transfer type of source endpoint.
*
*
* Possible attributes include the following:
*
*
* -
*
* serviceAccessRoleArn - The IAM role that has permission to access the Amazon S3 bucket.
*
*
* -
*
* bucketName - The name of the S3 bucket to use.
*
*
* -
*
* compressionType - An optional parameter to use GZIP to compress the target files. To use GZIP, set
* this value to NONE (the default). To keep the files uncompressed, don't use this value.
*
*
*
*
* Shorthand syntax for these attributes is as follows:
* ServiceAccessRoleArn=string,BucketName=string,CompressionType=string
*
*
* JSON syntax for these attributes is as follows:
* { "ServiceAccessRoleArn": "string", "BucketName": "string", "CompressionType": "none"|"gzip" }
*
*
* @param dmsTransferSettings
* The settings in JSON format for the DMS transfer type of source endpoint.
*
* Possible attributes include the following:
*
*
* -
*
* serviceAccessRoleArn - The IAM role that has permission to access the Amazon S3 bucket.
*
*
* -
*
* bucketName - The name of the S3 bucket to use.
*
*
* -
*
* compressionType - An optional parameter to use GZIP to compress the target files. To use
* GZIP, set this value to NONE (the default). To keep the files uncompressed, don't use this
* value.
*
*
*
*
* Shorthand syntax for these attributes is as follows:
* ServiceAccessRoleArn=string,BucketName=string,CompressionType=string
*
*
* JSON syntax for these attributes is as follows:
* { "ServiceAccessRoleArn": "string", "BucketName": "string", "CompressionType": "none"|"gzip" }
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateEndpointRequest withDmsTransferSettings(DmsTransferSettings dmsTransferSettings) {
setDmsTransferSettings(dmsTransferSettings);
return this;
}
/**
*
* Settings in JSON format for the source MongoDB endpoint. For more information about the available settings, see
* the configuration properties section in Using MongoDB as a Target for
* AWS Database Migration Service in the AWS Database Migration Service User Guide.
*
*
* @param mongoDbSettings
* Settings in JSON format for the source MongoDB endpoint. For more information about the available
* settings, see the configuration properties section in Using MongoDB as a
* Target for AWS Database Migration Service in the AWS Database Migration Service User Guide.
*/
public void setMongoDbSettings(MongoDbSettings mongoDbSettings) {
this.mongoDbSettings = mongoDbSettings;
}
/**
*
* Settings in JSON format for the source MongoDB endpoint. For more information about the available settings, see
* the configuration properties section in Using MongoDB as a Target for
* AWS Database Migration Service in the AWS Database Migration Service User Guide.
*
*
* @return Settings in JSON format for the source MongoDB endpoint. For more information about the available
* settings, see the configuration properties section in Using MongoDB as a
* Target for AWS Database Migration Service in the AWS Database Migration Service User Guide.
*/
public MongoDbSettings getMongoDbSettings() {
return this.mongoDbSettings;
}
/**
*
* Settings in JSON format for the source MongoDB endpoint. For more information about the available settings, see
* the configuration properties section in Using MongoDB as a Target for
* AWS Database Migration Service in the AWS Database Migration Service User Guide.
*
*
* @param mongoDbSettings
* Settings in JSON format for the source MongoDB endpoint. For more information about the available
* settings, see the configuration properties section in Using MongoDB as a
* Target for AWS Database Migration Service in the AWS Database Migration Service User Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateEndpointRequest withMongoDbSettings(MongoDbSettings mongoDbSettings) {
setMongoDbSettings(mongoDbSettings);
return this;
}
/**
*
* Settings in JSON format for the target Amazon Kinesis Data Streams endpoint. For more information about the
* available settings, see Using Object Mapping to Migrate Data to a Kinesis Data Stream in the AWS Database Migration User
* Guide.
*
*
* @param kinesisSettings
* Settings in JSON format for the target Amazon Kinesis Data Streams endpoint. For more information about
* the available settings, see Using Object Mapping to Migrate Data to a Kinesis Data Stream in the AWS Database Migration User
* Guide.
*/
public void setKinesisSettings(KinesisSettings kinesisSettings) {
this.kinesisSettings = kinesisSettings;
}
/**
*
* Settings in JSON format for the target Amazon Kinesis Data Streams endpoint. For more information about the
* available settings, see Using Object Mapping to Migrate Data to a Kinesis Data Stream in the AWS Database Migration User
* Guide.
*
*
* @return Settings in JSON format for the target Amazon Kinesis Data Streams endpoint. For more information about
* the available settings, see Using Object Mapping to Migrate Data to a Kinesis Data Stream in the AWS Database Migration User
* Guide.
*/
public KinesisSettings getKinesisSettings() {
return this.kinesisSettings;
}
/**
*
* Settings in JSON format for the target Amazon Kinesis Data Streams endpoint. For more information about the
* available settings, see Using Object Mapping to Migrate Data to a Kinesis Data Stream in the AWS Database Migration User
* Guide.
*
*
* @param kinesisSettings
* Settings in JSON format for the target Amazon Kinesis Data Streams endpoint. For more information about
* the available settings, see Using Object Mapping to Migrate Data to a Kinesis Data Stream in the AWS Database Migration User
* Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateEndpointRequest withKinesisSettings(KinesisSettings kinesisSettings) {
setKinesisSettings(kinesisSettings);
return this;
}
/**
*
* Settings in JSON format for the target Elasticsearch endpoint. For more information about the available settings,
* see Extra Connection Attributes When Using Elasticsearch as a Target for AWS DMS in the AWS Database
* Migration User Guide.
*
*
* @param elasticsearchSettings
* Settings in JSON format for the target Elasticsearch endpoint. For more information about the available
* settings, see Extra Connection Attributes When Using Elasticsearch as a Target for AWS DMS in the AWS Database
* Migration User Guide.
*/
public void setElasticsearchSettings(ElasticsearchSettings elasticsearchSettings) {
this.elasticsearchSettings = elasticsearchSettings;
}
/**
*
* Settings in JSON format for the target Elasticsearch endpoint. For more information about the available settings,
* see Extra Connection Attributes When Using Elasticsearch as a Target for AWS DMS in the AWS Database
* Migration User Guide.
*
*
* @return Settings in JSON format for the target Elasticsearch endpoint. For more information about the available
* settings, see Extra Connection Attributes When Using Elasticsearch as a Target for AWS DMS in the AWS Database
* Migration User Guide.
*/
public ElasticsearchSettings getElasticsearchSettings() {
return this.elasticsearchSettings;
}
/**
*
* Settings in JSON format for the target Elasticsearch endpoint. For more information about the available settings,
* see Extra Connection Attributes When Using Elasticsearch as a Target for AWS DMS in the AWS Database
* Migration User Guide.
*
*
* @param elasticsearchSettings
* Settings in JSON format for the target Elasticsearch endpoint. For more information about the available
* settings, see Extra Connection Attributes When Using Elasticsearch as a Target for AWS DMS in the AWS Database
* Migration User Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateEndpointRequest withElasticsearchSettings(ElasticsearchSettings elasticsearchSettings) {
setElasticsearchSettings(elasticsearchSettings);
return this;
}
/**
* @param redshiftSettings
*/
public void setRedshiftSettings(RedshiftSettings redshiftSettings) {
this.redshiftSettings = redshiftSettings;
}
/**
* @return
*/
public RedshiftSettings getRedshiftSettings() {
return this.redshiftSettings;
}
/**
* @param redshiftSettings
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateEndpointRequest withRedshiftSettings(RedshiftSettings redshiftSettings) {
setRedshiftSettings(redshiftSettings);
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 (getEndpointIdentifier() != null)
sb.append("EndpointIdentifier: ").append(getEndpointIdentifier()).append(",");
if (getEndpointType() != null)
sb.append("EndpointType: ").append(getEndpointType()).append(",");
if (getEngineName() != null)
sb.append("EngineName: ").append(getEngineName()).append(",");
if (getUsername() != null)
sb.append("Username: ").append(getUsername()).append(",");
if (getPassword() != null)
sb.append("Password: ").append("***Sensitive Data Redacted***").append(",");
if (getServerName() != null)
sb.append("ServerName: ").append(getServerName()).append(",");
if (getPort() != null)
sb.append("Port: ").append(getPort()).append(",");
if (getDatabaseName() != null)
sb.append("DatabaseName: ").append(getDatabaseName()).append(",");
if (getExtraConnectionAttributes() != null)
sb.append("ExtraConnectionAttributes: ").append(getExtraConnectionAttributes()).append(",");
if (getKmsKeyId() != null)
sb.append("KmsKeyId: ").append(getKmsKeyId()).append(",");
if (getTags() != null)
sb.append("Tags: ").append(getTags()).append(",");
if (getCertificateArn() != null)
sb.append("CertificateArn: ").append(getCertificateArn()).append(",");
if (getSslMode() != null)
sb.append("SslMode: ").append(getSslMode()).append(",");
if (getServiceAccessRoleArn() != null)
sb.append("ServiceAccessRoleArn: ").append(getServiceAccessRoleArn()).append(",");
if (getExternalTableDefinition() != null)
sb.append("ExternalTableDefinition: ").append(getExternalTableDefinition()).append(",");
if (getDynamoDbSettings() != null)
sb.append("DynamoDbSettings: ").append(getDynamoDbSettings()).append(",");
if (getS3Settings() != null)
sb.append("S3Settings: ").append(getS3Settings()).append(",");
if (getDmsTransferSettings() != null)
sb.append("DmsTransferSettings: ").append(getDmsTransferSettings()).append(",");
if (getMongoDbSettings() != null)
sb.append("MongoDbSettings: ").append(getMongoDbSettings()).append(",");
if (getKinesisSettings() != null)
sb.append("KinesisSettings: ").append(getKinesisSettings()).append(",");
if (getElasticsearchSettings() != null)
sb.append("ElasticsearchSettings: ").append(getElasticsearchSettings()).append(",");
if (getRedshiftSettings() != null)
sb.append("RedshiftSettings: ").append(getRedshiftSettings());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof CreateEndpointRequest == false)
return false;
CreateEndpointRequest other = (CreateEndpointRequest) obj;
if (other.getEndpointIdentifier() == null ^ this.getEndpointIdentifier() == null)
return false;
if (other.getEndpointIdentifier() != null && other.getEndpointIdentifier().equals(this.getEndpointIdentifier()) == false)
return false;
if (other.getEndpointType() == null ^ this.getEndpointType() == null)
return false;
if (other.getEndpointType() != null && other.getEndpointType().equals(this.getEndpointType()) == false)
return false;
if (other.getEngineName() == null ^ this.getEngineName() == null)
return false;
if (other.getEngineName() != null && other.getEngineName().equals(this.getEngineName()) == 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.getServerName() == null ^ this.getServerName() == null)
return false;
if (other.getServerName() != null && other.getServerName().equals(this.getServerName()) == false)
return false;
if (other.getPort() == null ^ this.getPort() == null)
return false;
if (other.getPort() != null && other.getPort().equals(this.getPort()) == false)
return false;
if (other.getDatabaseName() == null ^ this.getDatabaseName() == null)
return false;
if (other.getDatabaseName() != null && other.getDatabaseName().equals(this.getDatabaseName()) == false)
return false;
if (other.getExtraConnectionAttributes() == null ^ this.getExtraConnectionAttributes() == null)
return false;
if (other.getExtraConnectionAttributes() != null && other.getExtraConnectionAttributes().equals(this.getExtraConnectionAttributes()) == false)
return false;
if (other.getKmsKeyId() == null ^ this.getKmsKeyId() == null)
return false;
if (other.getKmsKeyId() != null && other.getKmsKeyId().equals(this.getKmsKeyId()) == false)
return false;
if (other.getTags() == null ^ this.getTags() == null)
return false;
if (other.getTags() != null && other.getTags().equals(this.getTags()) == false)
return false;
if (other.getCertificateArn() == null ^ this.getCertificateArn() == null)
return false;
if (other.getCertificateArn() != null && other.getCertificateArn().equals(this.getCertificateArn()) == false)
return false;
if (other.getSslMode() == null ^ this.getSslMode() == null)
return false;
if (other.getSslMode() != null && other.getSslMode().equals(this.getSslMode()) == false)
return false;
if (other.getServiceAccessRoleArn() == null ^ this.getServiceAccessRoleArn() == null)
return false;
if (other.getServiceAccessRoleArn() != null && other.getServiceAccessRoleArn().equals(this.getServiceAccessRoleArn()) == false)
return false;
if (other.getExternalTableDefinition() == null ^ this.getExternalTableDefinition() == null)
return false;
if (other.getExternalTableDefinition() != null && other.getExternalTableDefinition().equals(this.getExternalTableDefinition()) == false)
return false;
if (other.getDynamoDbSettings() == null ^ this.getDynamoDbSettings() == null)
return false;
if (other.getDynamoDbSettings() != null && other.getDynamoDbSettings().equals(this.getDynamoDbSettings()) == false)
return false;
if (other.getS3Settings() == null ^ this.getS3Settings() == null)
return false;
if (other.getS3Settings() != null && other.getS3Settings().equals(this.getS3Settings()) == false)
return false;
if (other.getDmsTransferSettings() == null ^ this.getDmsTransferSettings() == null)
return false;
if (other.getDmsTransferSettings() != null && other.getDmsTransferSettings().equals(this.getDmsTransferSettings()) == false)
return false;
if (other.getMongoDbSettings() == null ^ this.getMongoDbSettings() == null)
return false;
if (other.getMongoDbSettings() != null && other.getMongoDbSettings().equals(this.getMongoDbSettings()) == false)
return false;
if (other.getKinesisSettings() == null ^ this.getKinesisSettings() == null)
return false;
if (other.getKinesisSettings() != null && other.getKinesisSettings().equals(this.getKinesisSettings()) == false)
return false;
if (other.getElasticsearchSettings() == null ^ this.getElasticsearchSettings() == null)
return false;
if (other.getElasticsearchSettings() != null && other.getElasticsearchSettings().equals(this.getElasticsearchSettings()) == false)
return false;
if (other.getRedshiftSettings() == null ^ this.getRedshiftSettings() == null)
return false;
if (other.getRedshiftSettings() != null && other.getRedshiftSettings().equals(this.getRedshiftSettings()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getEndpointIdentifier() == null) ? 0 : getEndpointIdentifier().hashCode());
hashCode = prime * hashCode + ((getEndpointType() == null) ? 0 : getEndpointType().hashCode());
hashCode = prime * hashCode + ((getEngineName() == null) ? 0 : getEngineName().hashCode());
hashCode = prime * hashCode + ((getUsername() == null) ? 0 : getUsername().hashCode());
hashCode = prime * hashCode + ((getPassword() == null) ? 0 : getPassword().hashCode());
hashCode = prime * hashCode + ((getServerName() == null) ? 0 : getServerName().hashCode());
hashCode = prime * hashCode + ((getPort() == null) ? 0 : getPort().hashCode());
hashCode = prime * hashCode + ((getDatabaseName() == null) ? 0 : getDatabaseName().hashCode());
hashCode = prime * hashCode + ((getExtraConnectionAttributes() == null) ? 0 : getExtraConnectionAttributes().hashCode());
hashCode = prime * hashCode + ((getKmsKeyId() == null) ? 0 : getKmsKeyId().hashCode());
hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode());
hashCode = prime * hashCode + ((getCertificateArn() == null) ? 0 : getCertificateArn().hashCode());
hashCode = prime * hashCode + ((getSslMode() == null) ? 0 : getSslMode().hashCode());
hashCode = prime * hashCode + ((getServiceAccessRoleArn() == null) ? 0 : getServiceAccessRoleArn().hashCode());
hashCode = prime * hashCode + ((getExternalTableDefinition() == null) ? 0 : getExternalTableDefinition().hashCode());
hashCode = prime * hashCode + ((getDynamoDbSettings() == null) ? 0 : getDynamoDbSettings().hashCode());
hashCode = prime * hashCode + ((getS3Settings() == null) ? 0 : getS3Settings().hashCode());
hashCode = prime * hashCode + ((getDmsTransferSettings() == null) ? 0 : getDmsTransferSettings().hashCode());
hashCode = prime * hashCode + ((getMongoDbSettings() == null) ? 0 : getMongoDbSettings().hashCode());
hashCode = prime * hashCode + ((getKinesisSettings() == null) ? 0 : getKinesisSettings().hashCode());
hashCode = prime * hashCode + ((getElasticsearchSettings() == null) ? 0 : getElasticsearchSettings().hashCode());
hashCode = prime * hashCode + ((getRedshiftSettings() == null) ? 0 : getRedshiftSettings().hashCode());
return hashCode;
}
@Override
public CreateEndpointRequest clone() {
return (CreateEndpointRequest) super.clone();
}
}