software.amazon.awssdk.services.machinelearning.model

Class CreateDataSourceFromRdsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.machinelearning.model.MachineLearningRequest

software.amazon.awssdk.services.machinelearning.model.CreateDataSourceFromRdsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateDataSourceFromRdsRequest.Builder,CreateDataSourceFromRdsRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateDataSourceFromRdsRequest
extends MachineLearningRequest
implements ToCopyableBuilder<CreateDataSourceFromRdsRequest.Builder,CreateDataSourceFromRdsRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateDataSourceFromRdsRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateDataSourceFromRdsRequest.Builder	builder()
Boolean	computeStatistics() The compute statistics for a DataSource.
String	dataSourceId() A user-supplied ID that uniquely identifies the DataSource.
String	dataSourceName() A user-supplied name or description of the DataSource.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
RDSDataSpec	rdsData() The data specification of an Amazon RDS DataSource:
String	roleARN() The role that Amazon ML assumes on behalf of the user to create and activate a data pipeline in the user's account and copy data using the SelectSqlQuery query from Amazon RDS to Amazon S3.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateDataSourceFromRdsRequest.Builder>	serializableBuilderClass()
CreateDataSourceFromRdsRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

dataSourceId

public final String dataSourceId()

A user-supplied ID that uniquely identifies the DataSource. Typically, an Amazon Resource Number (ARN) becomes the ID for a DataSource.

Returns:

A user-supplied ID that uniquely identifies the DataSource. Typically, an Amazon Resource Number (ARN) becomes the ID for a DataSource.

dataSourceName

public final String dataSourceName()

A user-supplied name or description of the DataSource.

Returns:

A user-supplied name or description of the DataSource.

rdsData

public final RDSDataSpec rdsData()

The data specification of an Amazon RDS DataSource:

• DatabaseInformation -

  • DatabaseName - The name of the Amazon RDS database.

  • InstanceIdentifier - A unique identifier for the Amazon RDS database instance.

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

• ResourceRole - A role (DataPipelineDefaultResourceRole) assumed by an EC2 instance to carry out the copy task from Amazon RDS to Amazon Simple Storage Service (Amazon S3). For more information, see Role templates for data pipelines.

• ServiceRole - A role (DataPipelineDefaultRole) assumed by the 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.

• SecurityInfo - The security information to use to access an RDS DB instance. You need to set up appropriate ingress rules for the security entity IDs provided to allow access to the Amazon RDS instance. Specify a [ SubnetId, SecurityGroupIds] pair for a VPC-based RDS DB instance.

• SelectSqlQuery - A query that is used to retrieve the observation data for the Datasource.

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

• DataSchemaUri - The Amazon S3 location of the DataSchema.

• DataSchema - A JSON string representing the schema. This is not required if DataSchemaUri is specified.

• DataRearrangement - A JSON string that represents the splitting and rearrangement requirements for the Datasource.

  Sample - "{\"splitting\":{\"percentBegin\":10,\"percentEnd\":60}}"

Returns:

The data specification of an Amazon RDS DataSource:

• DatabaseInformation -

  • DatabaseName - The name of the Amazon RDS database.

  • InstanceIdentifier - A unique identifier for the Amazon RDS database instance.

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

• ResourceRole - A role (DataPipelineDefaultResourceRole) assumed by an EC2 instance to carry out the copy task from Amazon RDS to Amazon Simple Storage Service (Amazon S3). For more information, see Role templates for data pipelines.

• ServiceRole - A role (DataPipelineDefaultRole) assumed by the 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.

• SecurityInfo - The security information to use to access an RDS DB instance. You need to set up appropriate ingress rules for the security entity IDs provided to allow access to the Amazon RDS instance. Specify a [SubnetId, SecurityGroupIds] pair for a VPC-based RDS DB instance.

• SelectSqlQuery - A query that is used to retrieve the observation data for the Datasource.

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

• DataSchemaUri - The Amazon S3 location of the DataSchema.

• DataSchema - A JSON string representing the schema. This is not required if DataSchemaUri is specified.

• DataRearrangement - A JSON string that represents the splitting and rearrangement requirements for the Datasource.

  Sample - "{\"splitting\":{\"percentBegin\":10,\"percentEnd\":60}}"

roleARN

public final String roleARN()

The role that Amazon ML assumes on behalf of the user to create and activate a data pipeline in the user's account and copy data using the SelectSqlQuery query from Amazon RDS to Amazon S3.

Returns:

The role that Amazon ML assumes on behalf of the user to create and activate a data pipeline in the user's account and copy data using the SelectSqlQuery query from Amazon RDS to Amazon S3.

computeStatistics

public final Boolean computeStatistics()

The compute statistics for a DataSource. The statistics are generated from the observation data referenced by a DataSource. Amazon ML uses the statistics internally during MLModel training. This parameter must be set to true if the DataSource needs to be used for MLModel training.

Returns:

The compute statistics for a DataSource. The statistics are generated from the observation data referenced by a DataSource. Amazon ML uses the statistics internally during MLModel training. This parameter must be set to true if the DataSource needs to be used for MLModel training.

toBuilder

public CreateDataSourceFromRdsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateDataSourceFromRdsRequest.Builder,CreateDataSourceFromRdsRequest>

Specified by:

toBuilder in class MachineLearningRequest

builder

public static CreateDataSourceFromRdsRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateDataSourceFromRdsRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo