Package software.amazon.awssdk.services.machinelearning.model

Interface CreateDataSourceFromRedshiftRequest.Builder

    • Method Detail

      • dataSourceId

        CreateDataSourceFromRedshiftRequest.Builder dataSourceId​(String dataSourceId)

        A user-supplied ID that uniquely identifies the DataSource.

        Parameters:
        dataSourceId - A user-supplied ID that uniquely identifies the DataSource.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • dataSourceName

        CreateDataSourceFromRedshiftRequest.Builder dataSourceName​(String dataSourceName)

        A user-supplied name or description of the DataSource.

        Parameters:
        dataSourceName - A user-supplied name or description of the DataSource.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • dataSpec

        CreateDataSourceFromRedshiftRequest.Builder dataSpec​(RedshiftDataSpec dataSpec)

        The data specification of an Amazon Redshift DataSource:

        • DatabaseInformation -

          • DatabaseName - The name of the Amazon Redshift database.

          • ClusterIdentifier - The unique ID for the Amazon Redshift cluster.

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

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

        • S3StagingLocation - The Amazon Simple Storage Service (Amazon S3) location for staging Amazon Redshift data. The data retrieved from Amazon Redshift using the SelectSqlQuery query 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}}"

        Parameters:
        dataSpec - The data specification of an Amazon Redshift DataSource:

        • DatabaseInformation -

          • DatabaseName - The name of the Amazon Redshift database.

          • ClusterIdentifier - The unique ID for the Amazon Redshift cluster.

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

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

        • S3StagingLocation - The Amazon Simple Storage Service (Amazon S3) location for staging Amazon Redshift data. The data retrieved from Amazon Redshift using the SelectSqlQuery query 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:
        Returns a reference to this object so that method calls can be chained together.

      • dataSpec

        default CreateDataSourceFromRedshiftRequest.Builder dataSpec​(Consumer<RedshiftDataSpec.Builder> dataSpec)

        The data specification of an Amazon Redshift DataSource:

        • DatabaseInformation -

          • DatabaseName - The name of the Amazon Redshift database.

          • ClusterIdentifier - The unique ID for the Amazon Redshift cluster.

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

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

        • S3StagingLocation - The Amazon Simple Storage Service (Amazon S3) location for staging Amazon Redshift data. The data retrieved from Amazon Redshift using the SelectSqlQuery query 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}}"

        This is a convenience method that creates an instance of the RedshiftDataSpec.Builder avoiding the need to create one manually via RedshiftDataSpec.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to dataSpec(RedshiftDataSpec).

        Parameters:
        dataSpec - a consumer that will call methods on RedshiftDataSpec.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        dataSpec(RedshiftDataSpec)

      • roleARN

        CreateDataSourceFromRedshiftRequest.Builder roleARN​(String roleARN)

        A fully specified role Amazon Resource Name (ARN). Amazon ML assumes the role on behalf of the user to create the following:

        • A security group to allow Amazon ML to execute the SelectSqlQuery query on an Amazon Redshift cluster

        • An Amazon S3 bucket policy to grant Amazon ML read/write permissions on the S3StagingLocation

        Parameters:
        roleARN - A fully specified role Amazon Resource Name (ARN). Amazon ML assumes the role on behalf of the user to create the following:

        • A security group to allow Amazon ML to execute the SelectSqlQuery query on an Amazon Redshift cluster

        • An Amazon S3 bucket policy to grant Amazon ML read/write permissions on the S3StagingLocation

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

      • computeStatistics

        CreateDataSourceFromRedshiftRequest.Builder computeStatistics​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.