@akamai/openapi-ts
    Preparing search index...

    Type Alias PutDatabasesMysqlInstanceData

    type PutDatabasesMysqlInstanceData = {
        body: {
            allow_list?: string[];
            engine_config?: {
                binlog_retention_period?: number;
                mysql?: {
                    connect_timeout?: number;
                    default_time_zone?: string;
                    group_concat_max_len?: number;
                    information_schema_stats_expiry?: number;
                    innodb_change_buffer_max_size?: number;
                    innodb_flush_neighbors?: number;
                    innodb_ft_min_token_size?: number;
                    innodb_ft_server_stopword_table?: string | null;
                    innodb_lock_wait_timeout?: number;
                    innodb_log_buffer_size?: number;
                    innodb_online_alter_log_max_size?: number;
                    innodb_read_io_threads?: number;
                    innodb_rollback_on_timeout?: boolean;
                    innodb_thread_concurrency?: number;
                    innodb_write_io_threads?: number;
                    interactive_timeout?: number;
                    internal_tmp_mem_storage_engine?: "TempTable" | "MEMORY";
                    max_allowed_packet?: number;
                    max_heap_table_size?: number;
                    net_buffer_length?: number;
                    net_read_timeout?: number;
                    net_write_timeout?: number;
                    sql_mode?: string;
                    sql_require_primary_key?: boolean;
                    tmp_table_size?: number;
                    wait_timeout?: number;
                };
            };
            label?: string;
            private_network?: | {
                public_access?: boolean;
                subnet_id?: number;
                vpc_id?: number;
            }
            | null;
            type?: string;
            updates?: {
                day_of_week?: number;
                duration?: number;
                frequency?: "weekly";
                hour_of_day?: number;
                pending?: {
                    deadline?: string
                    | null;
                    description?: string;
                    planned_for?: string | null;
                }[];
            };
            version?: string;
        };
        path: { instanceId: number };
        query?: never;
        url: "databases/mysql/instances/{instanceId}";
    }
    Index

    Properties

    body path query? url

    Properties

    body

    body: {
        allow_list?: string[];
        engine_config?: {
            binlog_retention_period?: number;
            mysql?: {
                connect_timeout?: number;
                default_time_zone?: string;
                group_concat_max_len?: number;
                information_schema_stats_expiry?: number;
                innodb_change_buffer_max_size?: number;
                innodb_flush_neighbors?: number;
                innodb_ft_min_token_size?: number;
                innodb_ft_server_stopword_table?: string | null;
                innodb_lock_wait_timeout?: number;
                innodb_log_buffer_size?: number;
                innodb_online_alter_log_max_size?: number;
                innodb_read_io_threads?: number;
                innodb_rollback_on_timeout?: boolean;
                innodb_thread_concurrency?: number;
                innodb_write_io_threads?: number;
                interactive_timeout?: number;
                internal_tmp_mem_storage_engine?: "TempTable" | "MEMORY";
                max_allowed_packet?: number;
                max_heap_table_size?: number;
                net_buffer_length?: number;
                net_read_timeout?: number;
                net_write_timeout?: number;
                sql_mode?: string;
                sql_require_primary_key?: boolean;
                tmp_table_size?: number;
                wait_timeout?: number;
            };
        };
        label?: string;
        private_network?: | {
            public_access?: boolean;
            subnet_id?: number;
            vpc_id?: number;
        }
        | null;
        type?: string;
        updates?: {
            day_of_week?: number;
            duration?: number;
            frequency?: "weekly";
            hour_of_day?: number;
            pending?: {
                deadline?: string
                | null;
                description?: string;
                planned_for?: string | null;
            }[];
        };
        version?: string;
    }

    Updated information for the Managed MySQL Database.

    Type Declaration

    • Optionalallow_list?: string[]

      Controls access to the Managed Database.

      • Individually included IP addresses or CIDR ranges can access the Managed Database while all other sources are blocked.

      • A standalone value of 0.0.0.0/0 allows all IP addresses access to the Managed Database.

      • An empty array ([]) blocks all public and private connections to the Managed Database.

    • Optionalengine_config?: {
          binlog_retention_period?: number;
          mysql?: {
              connect_timeout?: number;
              default_time_zone?: string;
              group_concat_max_len?: number;
              information_schema_stats_expiry?: number;
              innodb_change_buffer_max_size?: number;
              innodb_flush_neighbors?: number;
              innodb_ft_min_token_size?: number;
              innodb_ft_server_stopword_table?: string | null;
              innodb_lock_wait_timeout?: number;
              innodb_log_buffer_size?: number;
              innodb_online_alter_log_max_size?: number;
              innodb_read_io_threads?: number;
              innodb_rollback_on_timeout?: boolean;
              innodb_thread_concurrency?: number;
              innodb_write_io_threads?: number;
              interactive_timeout?: number;
              internal_tmp_mem_storage_engine?: "TempTable" | "MEMORY";
              max_allowed_packet?: number;
              max_heap_table_size?: number;
              net_buffer_length?: number;
              net_read_timeout?: number;
              net_write_timeout?: number;
              sql_mode?: string;
              sql_require_primary_key?: boolean;
              tmp_table_size?: number;
              wait_timeout?: number;
          };
      }

      Advanced parameters you can apply to a MySQL Managed Database, via our partner Aiven's specification. Only include the objects for parameters you want to set in your database. Omit objects for parameters you don't want to define or change.

      📘

      Aiven may offer additional parameters in their specification. Currently, only those listed here are supported for use in a MySQL Managed Database. You can also run the List MySQL Managed Database advanced parameters operation to see an up-to-date list.

      • Optionalbinlog_retention_period?: number

        The minimum amount of time in seconds to keep binlog entries before deletion. This may be extended for services that require binlog entries for longer than the default, for example if using the MySQL Debezium Kafka connector.

      • Optionalmysql?: {
            connect_timeout?: number;
            default_time_zone?: string;
            group_concat_max_len?: number;
            information_schema_stats_expiry?: number;
            innodb_change_buffer_max_size?: number;
            innodb_flush_neighbors?: number;
            innodb_ft_min_token_size?: number;
            innodb_ft_server_stopword_table?: string | null;
            innodb_lock_wait_timeout?: number;
            innodb_log_buffer_size?: number;
            innodb_online_alter_log_max_size?: number;
            innodb_read_io_threads?: number;
            innodb_rollback_on_timeout?: boolean;
            innodb_thread_concurrency?: number;
            innodb_write_io_threads?: number;
            interactive_timeout?: number;
            internal_tmp_mem_storage_engine?: "TempTable" | "MEMORY";
            max_allowed_packet?: number;
            max_heap_table_size?: number;
            net_buffer_length?: number;
            net_read_timeout?: number;
            net_write_timeout?: number;
            sql_mode?: string;
            sql_require_primary_key?: boolean;
            tmp_table_size?: number;
            wait_timeout?: number;
        }

        MySQL-specific advanced configuration parameters.

        • Optionalconnect_timeout?: number

          The number of seconds that the mysqld server waits for a connect packet before responding with bad handshake.

        • Optionaldefault_time_zone?: string

          Default server time zone as an offset from UTC (from -12:00 to +12:00), a time zone name, or SYSTEM to use the MySQL server default.

        • Optionalgroup_concat_max_len?: number

          The maximum permitted result length in bytes for the GROUP_CONCAT() function.

        • Optionalinformation_schema_stats_expiry?: number

          The time, in seconds, before cached statistics expire.

        • Optionalinnodb_change_buffer_max_size?: number

          Maximum size for the InnoDB change buffer, as a percentage of the total size of the buffer pool.

        • Optionalinnodb_flush_neighbors?: number

          Specifies whether flushing a page from the InnoDB buffer pool also flushes other dirty pages in the same extent: 0 - dirty pages in the same extent are not flushed, 1 - flush contiguous dirty pages in the same extent, 2 - flush dirty pages in the same extent.

        • Optionalinnodb_ft_min_token_size?: number

          Minimum length of words that are stored in an InnoDB -1FULLTEXT index. Changing this parameter will lead to a restart of the MySQL service.

        • Optionalinnodb_ft_server_stopword_table?: string | null

          This option is used to specify your own InnoDB FULLTEXT index stopword list for all InnoDB tables. Set to null for no value.

        • Optionalinnodb_lock_wait_timeout?: number

          The length of time in seconds an InnoDB transaction waits for a row lock before giving up.

        • Optionalinnodb_log_buffer_size?: number

          The size in bytes of the buffer that InnoDB uses to write to the log files on disk.

        • Optionalinnodb_online_alter_log_max_size?: number

          The upper limit in bytes on the size of the temporary log files used during online DDL operations for InnoDB tables.

        • Optionalinnodb_read_io_threads?: number

          The number of I/O threads for read operations in InnoDB. Changing this parameter will lead to a restart of the MySQL service.

        • Optionalinnodb_rollback_on_timeout?: boolean

          When enabled a transaction timeout causes InnoDB to abort and roll back the entire transaction. Changing this parameter will lead to a restart of the MySQL service.

        • Optionalinnodb_thread_concurrency?: number

          Defines the maximum number of threads permitted inside of InnoDB. The default is 0 which indicates infinite concurrency, or no limit.

        • Optionalinnodb_write_io_threads?: number

          The number of I/O threads for write operations in InnoDB. Changing this parameter will lead to a restart of the MySQL service.

        • Optionalinteractive_timeout?: number

          The number of seconds the server waits for activity on an interactive connection before closing it.

        • Optionalinternal_tmp_mem_storage_engine?: "TempTable" | "MEMORY"

          The storage engine for in-memory internal temporary tables.

        • Optionalmax_allowed_packet?: number

          Size of the largest message in bytes that can be received by the server.

        • Optionalmax_heap_table_size?: number

          Limits the size of internal in-memory tables. Also set tmp_table_size.

        • Optionalnet_buffer_length?: number

          Start sizes of connection buffer and result buffer. Changing this parameter will lead to a restart of the MySQL service.

        • Optionalnet_read_timeout?: number

          The number of seconds to wait for more data from a connection before aborting the read.

        • Optionalnet_write_timeout?: number

          The number of seconds to wait for a block to be written to a connection before aborting the write.

        • Optionalsql_mode?: string

          Global SQL mode. Set to empty to use MySQL server defaults. When creating a new service and not setting this field, Akamai defaults to SQL mode which is strict, SQL standard compliant.

        • Optionalsql_require_primary_key?: boolean

          Require primary key to be defined for new tables or old tables modified with ALTER TABLE and fail if missing. You should always have primary keys because various functionality may break if any large table is missing them.

        • Optionaltmp_table_size?: number

          Limits the size of internal in-memory tables. This also requires a max_heap_table_size.

        • Optionalwait_timeout?: number

          The number of seconds the server waits for activity on a non-interactive connection before closing it.

    • Optionallabel?: string

      Filterable A unique, user-defined string referring to the Managed Database. This string needs to be unique per Managed Database engine type.

    • Optionalprivate_network?: { public_access?: boolean; subnet_id?: number; vpc_id?: number } | null

      Beta Restricts access on a MySQL Managed Database to a specific Virtual Private Cloud (VPC) configured for the cluster.

    • Optionaltype?: string

      Request re-sizing of your cluster to a Linode Type with more disk space. For example, you could request a Linode Type that uses a higher plan.

      • Needs to be a Linode Type with more disk space than your current Linode.

      • Resizing to a larger Linode Type can accrue additional cost. Review the price output in the List types operation for more information.

      • You can't update the allow_list and set a new type in the same request.

      • Any active updates to your cluster need to complete before you can request a resize. The reverse is also true: An active resizing needs to complete before you can perform any other update.

    • Optionalupdates?: {
          day_of_week?: number;
          duration?: number;
          frequency?: "weekly";
          hour_of_day?: number;
          pending?: {
              deadline?: string | null;
              description?: string;
              planned_for?: string | null;
          }[];
      }

      Configuration settings for automated patch update maintenance for the Managed Database.

      • Optionalday_of_week?: number

        The numeric reference for the day of the week to perform maintenance. 1 is Monday, 2 is Tuesday, through to 7 which is Sunday.

      • Optionalduration?: number

        The maximum maintenance window time in hours.

      • Optionalfrequency?: "weekly"

        How frequently maintenance occurs. Currently can only be weekly.

      • Optionalhour_of_day?: number

        The hour to begin maintenance based in UTC time.

      • Optional Readonlypending?: { deadline?: string | null; description?: string; planned_for?: string | null }[]

        Read-only An array of pending updates.

    • Optionalversion?: string

      Filterable The Managed Database engine version.

    path: { instanceId: number }

    Type Declaration

    • instanceId: number

      The ID of the Managed PostgreSQL Database.

    query?: never
    url: "databases/mysql/instances/{instanceId}"

    Settings

    Member Visibility

    On This Page

    Properties