/* * 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.machinelearning.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.protocol.StructuredPojo; import com.amazonaws.protocol.ProtocolMarshaller; /** *

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

*/ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class RDSDataSpec implements Serializable, Cloneable, StructuredPojo { /** *

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

*/ private RDSDatabase databaseInformation; /** *

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

*/ private String selectSqlQuery; /** *

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

*/ private RDSDatabaseCredentials databaseCredentials; /** *

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

*/ private String s3StagingLocation; /** *

* A JSON string that represents the splitting and rearrangement processing to be applied to a * DataSource. If the DataRearrangement parameter is not provided, all of the input data * is used to create the Datasource. *

*

* There are multiple parameters that control what data is used to create a datasource: *

* */ private String dataRearrangement; /** *

* A JSON string that represents the schema for an Amazon RDS DataSource. The DataSchema * defines the structure of the observation data in the data file(s) referenced in the DataSource. *

*

* A DataSchema is not required if you specify a DataSchemaUri *

*

* Define your DataSchema as a series of key-value pairs. attributes and * excludedVariableNames have an array of key-value pairs for their value. Use the following format to * define your DataSchema. *

*

* { "version": "1.0", *

*

* "recordAnnotationFieldName": "F1", *

*

* "recordWeightFieldName": "F2", *

*

* "targetFieldName": "F3", *

*

* "dataFormat": "CSV", *

*

* "dataFileContainsHeader": true, *

*

* "attributes": [ *

*

* { "fieldName": "F1", "fieldType": "TEXT" }, { "fieldName": "F2", "fieldType": "NUMERIC" }, { "fieldName": "F3", * "fieldType": "CATEGORICAL" }, { "fieldName": "F4", "fieldType": "NUMERIC" }, { "fieldName": "F5", "fieldType": * "CATEGORICAL" }, { "fieldName": "F6", "fieldType": "TEXT" }, { "fieldName": "F7", "fieldType": * "WEIGHTED_INT_SEQUENCE" }, { "fieldName": "F8", "fieldType": "WEIGHTED_STRING_SEQUENCE" } ], *

*

* "excludedVariableNames": [ "F6" ] } *

*/ private String dataSchema; /** *

* The Amazon S3 location of the DataSchema. *

*/ private String dataSchemaUri; /** *

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

*/ private String resourceRole; /** *

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

*/ private String serviceRole; /** *

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

*/ private String subnetId; /** *

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

*/ private com.amazonaws.internal.SdkInternalList securityGroupIds; /** *

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

* * @param databaseInformation * Describes the DatabaseName and InstanceIdentifier of an Amazon RDS database. */ public void setDatabaseInformation(RDSDatabase databaseInformation) { this.databaseInformation = databaseInformation; } /** *

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

* * @return Describes the DatabaseName and InstanceIdentifier of an Amazon RDS database. */ public RDSDatabase getDatabaseInformation() { return this.databaseInformation; } /** *

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

* * @param databaseInformation * Describes the DatabaseName and InstanceIdentifier of an Amazon RDS database. * @return Returns a reference to this object so that method calls can be chained together. */ public RDSDataSpec withDatabaseInformation(RDSDatabase databaseInformation) { setDatabaseInformation(databaseInformation); return this; } /** *

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

* * @param selectSqlQuery * The query that is used to retrieve the observation data for the DataSource. */ public void setSelectSqlQuery(String selectSqlQuery) { this.selectSqlQuery = selectSqlQuery; } /** *

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

* * @return The query that is used to retrieve the observation data for the DataSource. */ public String getSelectSqlQuery() { return this.selectSqlQuery; } /** *

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

* * @param selectSqlQuery * The query that is used to retrieve the observation data for the DataSource. * @return Returns a reference to this object so that method calls can be chained together. */ public RDSDataSpec withSelectSqlQuery(String selectSqlQuery) { setSelectSqlQuery(selectSqlQuery); return this; } /** *

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

* * @param databaseCredentials * The AWS Identity and Access Management (IAM) credentials that are used connect to the Amazon RDS database. */ public void setDatabaseCredentials(RDSDatabaseCredentials databaseCredentials) { this.databaseCredentials = databaseCredentials; } /** *

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

* * @return The AWS Identity and Access Management (IAM) credentials that are used connect to the Amazon RDS * database. */ public RDSDatabaseCredentials getDatabaseCredentials() { return this.databaseCredentials; } /** *

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

* * @param databaseCredentials * The AWS Identity and Access Management (IAM) credentials that are used connect to the Amazon RDS database. * @return Returns a reference to this object so that method calls can be chained together. */ public RDSDataSpec withDatabaseCredentials(RDSDatabaseCredentials databaseCredentials) { setDatabaseCredentials(databaseCredentials); return this; } /** *

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

* * @param s3StagingLocation * The Amazon S3 location for staging Amazon RDS data. The data retrieved from Amazon RDS using * SelectSqlQuery is stored in this location. */ public void setS3StagingLocation(String s3StagingLocation) { this.s3StagingLocation = s3StagingLocation; } /** *

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

* * @return The Amazon S3 location for staging Amazon RDS data. The data retrieved from Amazon RDS using * SelectSqlQuery is stored in this location. */ public String getS3StagingLocation() { return this.s3StagingLocation; } /** *

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

* * @param s3StagingLocation * The Amazon S3 location for staging Amazon RDS data. The data retrieved from Amazon RDS using * SelectSqlQuery is stored in this location. * @return Returns a reference to this object so that method calls can be chained together. */ public RDSDataSpec withS3StagingLocation(String s3StagingLocation) { setS3StagingLocation(s3StagingLocation); return this; } /** *

* A JSON string that represents the splitting and rearrangement processing to be applied to a * DataSource. If the DataRearrangement parameter is not provided, all of the input data * is used to create the Datasource. *

*

* There are multiple parameters that control what data is used to create a datasource: *

* * * @param dataRearrangement * A JSON string that represents the splitting and rearrangement processing to be applied to a * DataSource. If the DataRearrangement parameter is not provided, all of the input * data is used to create the Datasource.

*

* There are multiple parameters that control what data is used to create a datasource: *

*