You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::MachineLearning::Types::CreateDataSourceFromRDSInput

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-machinelearning/lib/aws-sdk-machinelearning/types.rb

Overview

Note:

When making an API call, you may pass CreateDataSourceFromRDSInput data as a hash:

{
  data_source_id: "EntityId", # required
  data_source_name: "EntityName",
  rds_data: { # required
    database_information: { # required
      instance_identifier: "RDSInstanceIdentifier", # required
      database_name: "RDSDatabaseName", # required
    },
    select_sql_query: "RDSSelectSqlQuery", # required
    database_credentials: { # required
      username: "RDSDatabaseUsername", # required
      password: "RDSDatabasePassword", # required
    },
    s3_staging_location: "S3Url", # required
    data_rearrangement: "DataRearrangement",
    data_schema: "DataSchema",
    data_schema_uri: "S3Url",
    resource_role: "EDPResourceRole", # required
    service_role: "EDPServiceRole", # required
    subnet_id: "EDPSubnetId", # required
    security_group_ids: ["EDPSecurityGroupId"], # required
  },
  role_arn: "RoleARN", # required
  compute_statistics: false,
}

Instance Attribute Summary collapse

Instance Attribute Details

#compute_statisticsBoolean

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:

  • (Boolean)


350
351
352
353
354
355
356
357
# File 'gems/aws-sdk-machinelearning/lib/aws-sdk-machinelearning/types.rb', line 350

class CreateDataSourceFromRDSInput < Struct.new(
  :data_source_id,
  :data_source_name,
  :rds_data,
  :role_arn,
  :compute_statistics)
  include Aws::Structure
end

#data_source_idString

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

Returns:

  • (String)


350
351
352
353
354
355
356
357
# File 'gems/aws-sdk-machinelearning/lib/aws-sdk-machinelearning/types.rb', line 350

class CreateDataSourceFromRDSInput < Struct.new(
  :data_source_id,
  :data_source_name,
  :rds_data,
  :role_arn,
  :compute_statistics)
  include Aws::Structure
end

#data_source_nameString

A user-supplied name or description of the DataSource.

Returns:

  • (String)


350
351
352
353
354
355
356
357
# File 'gems/aws-sdk-machinelearning/lib/aws-sdk-machinelearning/types.rb', line 350

class CreateDataSourceFromRDSInput < Struct.new(
  :data_source_id,
  :data_source_name,
  :rds_data,
  :role_arn,
  :compute_statistics)
  include Aws::Structure
end

#rds_dataTypes::RDSDataSpec

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:



350
351
352
353
354
355
356
357
# File 'gems/aws-sdk-machinelearning/lib/aws-sdk-machinelearning/types.rb', line 350

class CreateDataSourceFromRDSInput < Struct.new(
  :data_source_id,
  :data_source_name,
  :rds_data,
  :role_arn,
  :compute_statistics)
  include Aws::Structure
end

#role_arnString

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:

  • (String)


350
351
352
353
354
355
356
357
# File 'gems/aws-sdk-machinelearning/lib/aws-sdk-machinelearning/types.rb', line 350

class CreateDataSourceFromRDSInput < Struct.new(
  :data_source_id,
  :data_source_name,
  :rds_data,
  :role_arn,
  :compute_statistics)
  include Aws::Structure
end