Skip to main content

ModifyS3DataSourceInput

fields

  • connectionSettings optional PartialS3ConnectionSettingsInput

    The S3 Data Source's new connection settings. If not provided this property will not be modified.

    The connection settings for an S3 Data Source. These include the S3 bucket name, the AWS access key ID, and the tables (along with their paths). We do not allow fetching the AWS secret access key after it has been set.

    • connectionSettings.awsAccessKeyId optional String

      The AWS access key ID for an IAM user with sufficient access to the S3 bucket. If not provided this property will not be modified.

    • connectionSettings.awsSecretAccessKey optional String

      The AWS secret access key for an IAM user with sufficient access to the S3 bucket. If not provided this property will not be modified.

    • connectionSettings.bucket optional String

      The name of the S3 bucket. If not provided this property will not be modified.

    • connectionSettings.tables optional array of S3DataSourceTableInput

      The S3 Data Source's tables. If not provided this property will not be modified.

      The fields for specifying an S3 Data Source's table.

      • connectionSettings.tables.name required String

        The name of the table

      • connectionSettings.tables.path optional String

        The path to the table's files in S3.

      • connectionSettings.tables.columns required array of S3DataSourceColumnInput

        All the columns present in the table

        The fields for specifying a column in an S3 Data Source's table.

        • connectionSettings.tables.columns.name required String

          The column name. It has to be unique within a Table.

        • connectionSettings.tables.columns.type required ColumnType

          The column type.

          The Propel data types.

          • BOOLEAN

            True or false.

          • STRING

            A variable-length string.

          • FLOAT

            A 32-bit signed double-precision floating point number.

          • DOUBLE

            A 64-bit signed double-precision floating point number.

          • INT8

            An 8-bit signed integer, with a minimum value of -2⁷ and a maximum value of 2⁷-1.

          • INT16

            A 16-bit signed integer, with a minimum value of -2¹⁵ and a maximum value of 2¹⁵-1.

          • INT32

            A 32-bit signed integer, with a minimum value of -2³¹ and a maximum value of 2³¹-1.

          • INT64

            A 64-bit signed integer, with a minimum value of -2⁶³ and a maximum value of 2⁶³-1.

          • DATE

            A date without a timestamp. For example, "YYYY-MM-DD".

          • TIMESTAMP

            A date with a timestamp. For example, "yyy-MM-dd HH:mm:ss".

        • connectionSettings.tables.columns.nullable required Boolean

          Whether the column's type is nullable or not.

  • description optional String

    The S3 Data Source's new description. If not provided this property will not be modified.

  • idOrUniqueName required idOrUniqueName

    The ID or unique name of the S3 Data Source to modify.

    The ID or unique name input.

    If both ID and unique name are provided, the ID will take precedence.

  • uniqueName optional String

    The S3 Data Source's new unique name. If not provided this property will not be modified.