com.amazonaws.services.machinelearning.model

Class RDSDataSpec

java.lang.Object

com.amazonaws.services.machinelearning.model.RDSDataSpec

All Implemented Interfaces:

Serializable, Cloneable

public class RDSDataSpec
extends Object
implements Serializable, Cloneable

The data specification of an Amazon Relational Database Service (Amazon RDS) DataSource .

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
RDSDataSpec()

Method Summary

Methods

Modifier and Type	Method and Description
RDSDataSpec	clone()
boolean	equals(Object obj)
RDSDatabaseCredentials	getDatabaseCredentials() The AWS Identity and Access Management (IAM) credentials that are used connect to the Amazon RDS database.
RDSDatabase	getDatabaseInformation() Describes the DatabaseName and InstanceIdentifier of an an Amazon RDS database.
String	getDataRearrangement() DataRearrangement - A JSON string that represents the splitting requirement of a DataSource.
String	getDataSchema() A JSON string that represents the schema.
String	getDataSchemaUri() The Amazon S3 location of the DataSchema.
String	getResourceRole() The role (DataPipelineDefaultResourceRole) assumed by an Amazon Elastic Compute Cloud (Amazon EC2) instance to carry out the copy operation from Amazon RDS to an Amazon S3 task.
String	getS3StagingLocation() The Amazon S3 location for staging Amazon RDS data.
List<String>	getSecurityGroupIds() The security group IDs to be used to access a VPC-based RDS DB instance.
String	getSelectSqlQuery() The query that is used to retrieve the observation data for the DataSource.
String	getServiceRole() The role (DataPipelineDefaultRole) assumed by AWS Data Pipeline service to monitor the progress of the copy task from Amazon RDS to Amazon S3.
String	getSubnetId() The subnet ID to be used to access a VPC-based RDS DB instance.
int	hashCode()
void	setDatabaseCredentials(RDSDatabaseCredentials databaseCredentials) The AWS Identity and Access Management (IAM) credentials that are used connect to the Amazon RDS database.
void	setDatabaseInformation(RDSDatabase databaseInformation) Describes the DatabaseName and InstanceIdentifier of an an Amazon RDS database.
void	setDataRearrangement(String dataRearrangement) DataRearrangement - A JSON string that represents the splitting requirement of a DataSource.
void	setDataSchema(String dataSchema) A JSON string that represents the schema.
void	setDataSchemaUri(String dataSchemaUri) The Amazon S3 location of the DataSchema.
void	setResourceRole(String resourceRole) The role (DataPipelineDefaultResourceRole) assumed by an Amazon Elastic Compute Cloud (Amazon EC2) instance to carry out the copy operation from Amazon RDS to an Amazon S3 task.
void	setS3StagingLocation(String s3StagingLocation) The Amazon S3 location for staging Amazon RDS data.
void	setSecurityGroupIds(Collection<String> securityGroupIds) The security group IDs to be used to access a VPC-based RDS DB instance.
void	setSelectSqlQuery(String selectSqlQuery) The query that is used to retrieve the observation data for the DataSource.
void	setServiceRole(String serviceRole) The role (DataPipelineDefaultRole) assumed by AWS Data Pipeline service to monitor the progress of the copy task from Amazon RDS to Amazon S3.
void	setSubnetId(String subnetId) The subnet ID to be used to access a VPC-based RDS DB instance.
String	toString() Returns a string representation of this object; useful for testing and debugging.
RDSDataSpec	withDatabaseCredentials(RDSDatabaseCredentials databaseCredentials) The AWS Identity and Access Management (IAM) credentials that are used connect to the Amazon RDS database.
RDSDataSpec	withDatabaseInformation(RDSDatabase databaseInformation) Describes the DatabaseName and InstanceIdentifier of an an Amazon RDS database.
RDSDataSpec	withDataRearrangement(String dataRearrangement) DataRearrangement - A JSON string that represents the splitting requirement of a DataSource.
RDSDataSpec	withDataSchema(String dataSchema) A JSON string that represents the schema.
RDSDataSpec	withDataSchemaUri(String dataSchemaUri) The Amazon S3 location of the DataSchema.
RDSDataSpec	withResourceRole(String resourceRole) The role (DataPipelineDefaultResourceRole) assumed by an Amazon Elastic Compute Cloud (Amazon EC2) instance to carry out the copy operation from Amazon RDS to an Amazon S3 task.
RDSDataSpec	withS3StagingLocation(String s3StagingLocation) The Amazon S3 location for staging Amazon RDS data.
RDSDataSpec	withSecurityGroupIds(Collection<String> securityGroupIds) The security group IDs to be used to access a VPC-based RDS DB instance.
RDSDataSpec	withSecurityGroupIds(String... securityGroupIds) The security group IDs to be used to access a VPC-based RDS DB instance.
RDSDataSpec	withSelectSqlQuery(String selectSqlQuery) The query that is used to retrieve the observation data for the DataSource.
RDSDataSpec	withServiceRole(String serviceRole) The role (DataPipelineDefaultRole) assumed by AWS Data Pipeline service to monitor the progress of the copy task from Amazon RDS to Amazon S3.
RDSDataSpec	withSubnetId(String subnetId) The subnet ID to be used to access a VPC-based RDS DB instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

RDSDataSpec

public RDSDataSpec()

Method Detail

getDatabaseInformation

public RDSDatabase getDatabaseInformation()

Describes the DatabaseName and InstanceIdentifier of an an Amazon RDS database.

Returns:

Describes the DatabaseName and InstanceIdentifier of an an Amazon RDS database.

setDatabaseInformation

public void setDatabaseInformation(RDSDatabase databaseInformation)

Describes the DatabaseName and InstanceIdentifier of an an Amazon RDS database.

Parameters:

databaseInformation - Describes the DatabaseName and InstanceIdentifier of an an Amazon RDS database.

withDatabaseInformation

public RDSDataSpec withDatabaseInformation(RDSDatabase databaseInformation)

Describes the DatabaseName and InstanceIdentifier of an an Amazon RDS database.

Returns a reference to this object so that method calls can be chained together.

Parameters:

databaseInformation - Describes the DatabaseName and InstanceIdentifier of an an Amazon RDS database.

Returns:

A reference to this updated object so that method calls can be chained together.

getSelectSqlQuery

public String getSelectSqlQuery()

The query that is used to retrieve the observation data for the DataSource.

Constraints:
Length: 1 - 16777216

Returns:

The query that is used to retrieve the observation data for the DataSource.

setSelectSqlQuery

public void setSelectSqlQuery(String selectSqlQuery)

The query that is used to retrieve the observation data for the DataSource.

Constraints:
Length: 1 - 16777216

Parameters:

selectSqlQuery - The query that is used to retrieve the observation data for the DataSource.

withSelectSqlQuery

public RDSDataSpec withSelectSqlQuery(String selectSqlQuery)

The query that is used to retrieve the observation data for the DataSource.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 16777216

Parameters:

selectSqlQuery - The query that is used to retrieve the observation data for the DataSource.

Returns:

A reference to this updated object so that method calls can be chained together.

getDatabaseCredentials

public RDSDatabaseCredentials getDatabaseCredentials()

The AWS Identity and Access Management (IAM) credentials that are used connect to the Amazon RDS database.

Returns:

The AWS Identity and Access Management (IAM) credentials that are used connect to the Amazon RDS database.

setDatabaseCredentials

public void setDatabaseCredentials(RDSDatabaseCredentials databaseCredentials)

The AWS Identity and Access Management (IAM) credentials that are used connect to the Amazon RDS database.

Parameters:

databaseCredentials - The AWS Identity and Access Management (IAM) credentials that are used connect to the Amazon RDS database.

withDatabaseCredentials

public RDSDataSpec withDatabaseCredentials(RDSDatabaseCredentials databaseCredentials)

The AWS Identity and Access Management (IAM) credentials that are used connect to the Amazon RDS database.

Returns a reference to this object so that method calls can be chained together.

Parameters:

databaseCredentials - The AWS Identity and Access Management (IAM) credentials that are used connect to the Amazon RDS database.

Returns:

A reference to this updated object so that method calls can be chained together.

getS3StagingLocation

public String getS3StagingLocation()

The Amazon S3 location for staging Amazon RDS data. The data retrieved from Amazon RDS using SelectSqlQuery is stored in this location.

Constraints:
Length: 0 - 2048
Pattern: s3://([^/]+)(/.*)?

Returns:

The Amazon S3 location for staging Amazon RDS data. The data retrieved from Amazon RDS using SelectSqlQuery is stored in this location.

setS3StagingLocation

public void setS3StagingLocation(String s3StagingLocation)

The Amazon S3 location for staging Amazon RDS data. The data retrieved from Amazon RDS using SelectSqlQuery is stored in this location.

Constraints:
Length: 0 - 2048
Pattern: s3://([^/]+)(/.*)?

Parameters:

s3StagingLocation - The Amazon S3 location for staging Amazon RDS data. The data retrieved from Amazon RDS using SelectSqlQuery is stored in this location.

withS3StagingLocation

public RDSDataSpec withS3StagingLocation(String s3StagingLocation)

The Amazon S3 location for staging Amazon RDS data. The data retrieved from Amazon RDS using SelectSqlQuery is stored in this location.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 0 - 2048
Pattern: s3://([^/]+)(/.*)?

Parameters:

s3StagingLocation - The Amazon S3 location for staging Amazon RDS data. The data retrieved from Amazon RDS using SelectSqlQuery is stored in this location.

Returns:

A reference to this updated object so that method calls can be chained together.

getDataRearrangement

public String getDataRearrangement()

DataRearrangement - A JSON string that represents the splitting requirement of a DataSource.

Sample - "{\"randomSeed\":\"some-random-seed\", \"splitting\":{\"percentBegin\":10,\"percentEnd\":60}}"

Returns:

DataRearrangement - A JSON string that represents the splitting requirement of a DataSource.

Sample - "{\"randomSeed\":\"some-random-seed\", \"splitting\":{\"percentBegin\":10,\"percentEnd\":60}}"

setDataRearrangement

public void setDataRearrangement(String dataRearrangement)

DataRearrangement - A JSON string that represents the splitting requirement of a DataSource.

Sample - "{\"randomSeed\":\"some-random-seed\", \"splitting\":{\"percentBegin\":10,\"percentEnd\":60}}"

Parameters:

dataRearrangement - DataRearrangement - A JSON string that represents the splitting requirement of a DataSource.

Sample - "{\"randomSeed\":\"some-random-seed\", \"splitting\":{\"percentBegin\":10,\"percentEnd\":60}}"

withDataRearrangement

public RDSDataSpec withDataRearrangement(String dataRearrangement)

DataRearrangement - A JSON string that represents the splitting requirement of a DataSource.

Sample - "{\"randomSeed\":\"some-random-seed\", \"splitting\":{\"percentBegin\":10,\"percentEnd\":60}}"

Returns a reference to this object so that method calls can be chained together.

Parameters:

dataRearrangement - DataRearrangement - A JSON string that represents the splitting requirement of a DataSource.

Sample - "{\"randomSeed\":\"some-random-seed\", \"splitting\":{\"percentBegin\":10,\"percentEnd\":60}}"

Returns:

A reference to this updated object so that method calls can be chained together.

getDataSchema

public String getDataSchema()

A JSON string that represents the schema. This is not required if DataSchemaUri is specified.

Constraints:
Length: 0 - 131071

Returns:

A JSON string that represents the schema. This is not required if DataSchemaUri is specified.

setDataSchema

public void setDataSchema(String dataSchema)

A JSON string that represents the schema. This is not required if DataSchemaUri is specified.

Constraints:
Length: 0 - 131071

Parameters:

dataSchema - A JSON string that represents the schema. This is not required if DataSchemaUri is specified.

withDataSchema

public RDSDataSpec withDataSchema(String dataSchema)

A JSON string that represents the schema. This is not required if DataSchemaUri is specified.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 0 - 131071

Parameters:

dataSchema - A JSON string that represents the schema. This is not required if DataSchemaUri is specified.

Returns:

A reference to this updated object so that method calls can be chained together.

getDataSchemaUri

public String getDataSchemaUri()

The Amazon S3 location of the DataSchema.

Constraints:
Length: 0 - 2048
Pattern: s3://([^/]+)(/.*)?

Returns:

The Amazon S3 location of the DataSchema.

setDataSchemaUri

public void setDataSchemaUri(String dataSchemaUri)

The Amazon S3 location of the DataSchema.

Constraints:
Length: 0 - 2048
Pattern: s3://([^/]+)(/.*)?

Parameters:

dataSchemaUri - The Amazon S3 location of the DataSchema.

withDataSchemaUri

public RDSDataSpec withDataSchemaUri(String dataSchemaUri)

The Amazon S3 location of the DataSchema.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 0 - 2048
Pattern: s3://([^/]+)(/.*)?

Parameters:

dataSchemaUri - The Amazon S3 location of the DataSchema.

Returns:

A reference to this updated object so that method calls can be chained together.

getResourceRole

public String getResourceRole()

The role (DataPipelineDefaultResourceRole) assumed by an Amazon Elastic Compute Cloud (Amazon EC2) instance to carry out the copy operation from Amazon RDS to an Amazon S3 task. For more information, see Role templates for data pipelines.

Constraints:
Length: 1 - 64

Returns:

The role (DataPipelineDefaultResourceRole) assumed by an Amazon Elastic Compute Cloud (Amazon EC2) instance to carry out the copy operation from Amazon RDS to an Amazon S3 task. For more information, see Role templates for data pipelines.

setResourceRole

public void setResourceRole(String resourceRole)

The role (DataPipelineDefaultResourceRole) assumed by an Amazon Elastic Compute Cloud (Amazon EC2) instance to carry out the copy operation from Amazon RDS to an Amazon S3 task. For more information, see Role templates for data pipelines.

Constraints:
Length: 1 - 64

Parameters:

resourceRole - The role (DataPipelineDefaultResourceRole) assumed by an Amazon Elastic Compute Cloud (Amazon EC2) instance to carry out the copy operation from Amazon RDS to an Amazon S3 task. For more information, see Role templates for data pipelines.

withResourceRole

public RDSDataSpec withResourceRole(String resourceRole)

The role (DataPipelineDefaultResourceRole) assumed by an Amazon Elastic Compute Cloud (Amazon EC2) instance to carry out the copy operation from Amazon RDS to an Amazon S3 task. For more information, see Role templates for data pipelines.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 64

Parameters:

resourceRole - The role (DataPipelineDefaultResourceRole) assumed by an Amazon Elastic Compute Cloud (Amazon EC2) instance to carry out the copy operation from Amazon RDS to an Amazon S3 task. For more information, see Role templates for data pipelines.

Returns:

A reference to this updated object so that method calls can be chained together.

getServiceRole

public String getServiceRole()

The role (DataPipelineDefaultRole) assumed by AWS Data Pipeline service to monitor the progress of the copy task from Amazon RDS to Amazon S3. For more information, see Role templates for data pipelines.

Constraints:
Length: 1 - 64

Returns:

The role (DataPipelineDefaultRole) assumed by AWS Data Pipeline service to monitor the progress of the copy task from Amazon RDS to Amazon S3. For more information, see Role templates for data pipelines.

setServiceRole

public void setServiceRole(String serviceRole)

The role (DataPipelineDefaultRole) assumed by AWS Data Pipeline service to monitor the progress of the copy task from Amazon RDS to Amazon S3. For more information, see Role templates for data pipelines.

Constraints:
Length: 1 - 64

Parameters:

serviceRole - The role (DataPipelineDefaultRole) assumed by AWS Data Pipeline service to monitor the progress of the copy task from Amazon RDS to Amazon S3. For more information, see Role templates for data pipelines.

withServiceRole

public RDSDataSpec withServiceRole(String serviceRole)

The role (DataPipelineDefaultRole) assumed by AWS Data Pipeline service to monitor the progress of the copy task from Amazon RDS to Amazon S3. For more information, see Role templates for data pipelines.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 64

Parameters:

serviceRole - The role (DataPipelineDefaultRole) assumed by AWS Data Pipeline service to monitor the progress of the copy task from Amazon RDS to Amazon S3. For more information, see Role templates for data pipelines.

Returns:

A reference to this updated object so that method calls can be chained together.

getSubnetId

public String getSubnetId()

The subnet ID to be used to access a VPC-based RDS DB instance. This attribute is used by Data Pipeline to carry out the copy task from Amazon RDS to Amazon S3.

Constraints:
Length: 1 - 255

Returns:

The subnet ID to be used to access a VPC-based RDS DB instance. This attribute is used by Data Pipeline to carry out the copy task from Amazon RDS to Amazon S3.

setSubnetId

public void setSubnetId(String subnetId)

The subnet ID to be used to access a VPC-based RDS DB instance. This attribute is used by Data Pipeline to carry out the copy task from Amazon RDS to Amazon S3.

Constraints:
Length: 1 - 255

Parameters:

subnetId - The subnet ID to be used to access a VPC-based RDS DB instance. This attribute is used by Data Pipeline to carry out the copy task from Amazon RDS to Amazon S3.

withSubnetId

public RDSDataSpec withSubnetId(String subnetId)

The subnet ID to be used to access a VPC-based RDS DB instance. This attribute is used by Data Pipeline to carry out the copy task from Amazon RDS to Amazon S3.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 255

Parameters:

subnetId - The subnet ID to be used to access a VPC-based RDS DB instance. This attribute is used by Data Pipeline to carry out the copy task from Amazon RDS to Amazon S3.

Returns:

A reference to this updated object so that method calls can be chained together.

getSecurityGroupIds

public List<String> getSecurityGroupIds()

The security group IDs to be used to access a VPC-based RDS DB instance. Ensure that there are appropriate ingress rules set up to allow access to the RDS DB instance. This attribute is used by Data Pipeline to carry out the copy operation from Amazon RDS to an Amazon S3 task.

Returns:

The security group IDs to be used to access a VPC-based RDS DB instance. Ensure that there are appropriate ingress rules set up to allow access to the RDS DB instance. This attribute is used by Data Pipeline to carry out the copy operation from Amazon RDS to an Amazon S3 task.

setSecurityGroupIds

public void setSecurityGroupIds(Collection<String> securityGroupIds)

The security group IDs to be used to access a VPC-based RDS DB instance. Ensure that there are appropriate ingress rules set up to allow access to the RDS DB instance. This attribute is used by Data Pipeline to carry out the copy operation from Amazon RDS to an Amazon S3 task.

Parameters:

securityGroupIds - The security group IDs to be used to access a VPC-based RDS DB instance. Ensure that there are appropriate ingress rules set up to allow access to the RDS DB instance. This attribute is used by Data Pipeline to carry out the copy operation from Amazon RDS to an Amazon S3 task.

withSecurityGroupIds

public RDSDataSpec withSecurityGroupIds(String... securityGroupIds)

The security group IDs to be used to access a VPC-based RDS DB instance. Ensure that there are appropriate ingress rules set up to allow access to the RDS DB instance. This attribute is used by Data Pipeline to carry out the copy operation from Amazon RDS to an Amazon S3 task.

NOTE: This method appends the values to the existing list (if any). Use setSecurityGroupIds(java.util.Collection) or withSecurityGroupIds(java.util.Collection) if you want to override the existing values.

Returns a reference to this object so that method calls can be chained together.

Parameters:

securityGroupIds - The security group IDs to be used to access a VPC-based RDS DB instance. Ensure that there are appropriate ingress rules set up to allow access to the RDS DB instance. This attribute is used by Data Pipeline to carry out the copy operation from Amazon RDS to an Amazon S3 task.

Returns:

A reference to this updated object so that method calls can be chained together.

withSecurityGroupIds

public RDSDataSpec withSecurityGroupIds(Collection<String> securityGroupIds)

The security group IDs to be used to access a VPC-based RDS DB instance. Ensure that there are appropriate ingress rules set up to allow access to the RDS DB instance. This attribute is used by Data Pipeline to carry out the copy operation from Amazon RDS to an Amazon S3 task.

Returns a reference to this object so that method calls can be chained together.

Parameters:

securityGroupIds - The security group IDs to be used to access a VPC-based RDS DB instance. Ensure that there are appropriate ingress rules set up to allow access to the RDS DB instance. This attribute is used by Data Pipeline to carry out the copy operation from Amazon RDS to an Amazon S3 task.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public RDSDataSpec clone()

Overrides:

clone in class Object