aws_sdk_machinelearning/client/create_data_source_from_rds.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3 /// Constructs a fluent builder for the [`CreateDataSourceFromRDS`](crate::operation::create_data_source_from_rds::builders::CreateDataSourceFromRDSFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`data_source_id(impl Into<String>)`](crate::operation::create_data_source_from_rds::builders::CreateDataSourceFromRDSFluentBuilder::data_source_id) / [`set_data_source_id(Option<String>)`](crate::operation::create_data_source_from_rds::builders::CreateDataSourceFromRDSFluentBuilder::set_data_source_id):<br>required: **true**<br><p>A user-supplied ID that uniquely identifies the <code>DataSource</code>. Typically, an Amazon Resource Number (ARN) becomes the ID for a <code>DataSource</code>.</p><br>
7 /// - [`data_source_name(impl Into<String>)`](crate::operation::create_data_source_from_rds::builders::CreateDataSourceFromRDSFluentBuilder::data_source_name) / [`set_data_source_name(Option<String>)`](crate::operation::create_data_source_from_rds::builders::CreateDataSourceFromRDSFluentBuilder::set_data_source_name):<br>required: **false**<br><p>A user-supplied name or description of the <code>DataSource</code>.</p><br>
8 /// - [`rds_data(RdsDataSpec)`](crate::operation::create_data_source_from_rds::builders::CreateDataSourceFromRDSFluentBuilder::rds_data) / [`set_rds_data(Option<RdsDataSpec>)`](crate::operation::create_data_source_from_rds::builders::CreateDataSourceFromRDSFluentBuilder::set_rds_data):<br>required: **true**<br><p>The data specification of an Amazon RDS <code>DataSource</code>:</p> <ul> <li> <p>DatabaseInformation -</p> <ul> <li> <p><code>DatabaseName</code> - The name of the Amazon RDS database.</p></li> <li> <p><code>InstanceIdentifier </code> - A unique identifier for the Amazon RDS database instance.</p></li> </ul></li> <li> <p>DatabaseCredentials - AWS Identity and Access Management (IAM) credentials that are used to connect to the Amazon RDS database.</p></li> <li> <p>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 <a href="https://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-iam-roles.html">Role templates</a> for data pipelines.</p></li> <li> <p>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 <a href="https://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-iam-roles.html">Role templates</a> for data pipelines.</p></li> <li> <p>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.</p></li> <li> <p>SelectSqlQuery - A query that is used to retrieve the observation data for the <code>Datasource</code>.</p></li> <li> <p>S3StagingLocation - The Amazon S3 location for staging Amazon RDS data. The data retrieved from Amazon RDS using <code>SelectSqlQuery</code> is stored in this location.</p></li> <li> <p>DataSchemaUri - The Amazon S3 location of the <code>DataSchema</code>.</p></li> <li> <p>DataSchema - A JSON string representing the schema. This is not required if <code>DataSchemaUri</code> is specified.</p></li> <li> <p>DataRearrangement - A JSON string that represents the splitting and rearrangement requirements for the <code>Datasource</code>.</p> <p>Sample - <code> "{\"splitting\":{\"percentBegin\":10,\"percentEnd\":60}}"</code></p></li> </ul><br>
9 /// - [`role_arn(impl Into<String>)`](crate::operation::create_data_source_from_rds::builders::CreateDataSourceFromRDSFluentBuilder::role_arn) / [`set_role_arn(Option<String>)`](crate::operation::create_data_source_from_rds::builders::CreateDataSourceFromRDSFluentBuilder::set_role_arn):<br>required: **true**<br><p>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 <code>SelectSqlQuery</code> query from Amazon RDS to Amazon S3.</p> <p></p><br>
10 /// - [`compute_statistics(bool)`](crate::operation::create_data_source_from_rds::builders::CreateDataSourceFromRDSFluentBuilder::compute_statistics) / [`set_compute_statistics(Option<bool>)`](crate::operation::create_data_source_from_rds::builders::CreateDataSourceFromRDSFluentBuilder::set_compute_statistics):<br>required: **false**<br><p>The compute statistics for a <code>DataSource</code>. The statistics are generated from the observation data referenced by a <code>DataSource</code>. Amazon ML uses the statistics internally during <code>MLModel</code> training. This parameter must be set to <code>true</code> if the <code></code>DataSource<code></code> needs to be used for <code>MLModel</code> training.</p><br>
11 /// - On success, responds with [`CreateDataSourceFromRdsOutput`](crate::operation::create_data_source_from_rds::CreateDataSourceFromRdsOutput) with field(s):
12 /// - [`data_source_id(Option<String>)`](crate::operation::create_data_source_from_rds::CreateDataSourceFromRdsOutput::data_source_id): <p>A user-supplied ID that uniquely identifies the datasource. This value should be identical to the value of the <code>DataSourceID</code> in the request.</p>
13 /// - On failure, responds with [`SdkError<CreateDataSourceFromRDSError>`](crate::operation::create_data_source_from_rds::CreateDataSourceFromRDSError)
14 pub fn create_data_source_from_rds(&self) -> crate::operation::create_data_source_from_rds::builders::CreateDataSourceFromRDSFluentBuilder {
15 crate::operation::create_data_source_from_rds::builders::CreateDataSourceFromRDSFluentBuilder::new(self.handle.clone())
16 }
17}