Data Source: aws_paas_service#

Provides information about a PaaS service.

Example Usage#

data "aws_paas_service" "selected" {
  id = "fm-cluster-12345678"
}

output "paas_service_name" {
  value = data.aws_paas_service.selected.name
}

Argument Reference#

The following arguments are supported:

id - (Required) The ID of the PaaS service (e.g. fm-cluster-12345678).

Attribute Reference#

In addition to all arguments above, the following attributes are exported:

available_environment_versions - The environment versions to which the current version can be updated.
auto_created_security_group_ids - List of security group IDs that cloud created for the service.
backup_settings - The backup settings for the service. The structure of this block is described below.
data_volume - The data volume parameters for the service. The structure of this block is described below.
endpoints - List of endpoints for connecting to the service. The structure of this block is described below.
environment_version - The current version of the service environment.
error_code - The service error code.
error_description - The detailed description of the service error.
high_availability - Indicates whether this is a high-availability service.
instances - List of instances that refers to the service. The structure of this block is described below.
instance_type - The instance type.
name - The service name.
network_interface_ids - List of network interface IDs.
root_volume - The root volume parameters for the service. The structure of this block is described below.
security_group_ids - List of security group IDs that were specified for the service.
service_class - The service class.
service_type - The service type. This value determines which service parameters are included in the corresponding block.
- elasticsearch - Elasticsearch parameters. The structure of this block is described below.
- memcached - Memcached parameters. The structure of this block is described below.
- mongodb - MongoDB parameters. The structure of this block is described below.
- mysql - MySQL parameters. The structure of this block is described below.
- pgsql - PostgreSQL parameters. The structure of this block is described below.
- rabbitmq - RabbitMQ parameters. The structure of this block is described below.
- redis - Redis parameters. The structure of this block is described below.
ssh_key_name - The name of the SSH key for accessing instances.
status - The current status of the service.
subnet_ids - List of subnet IDs.
supported_features - List of service features.
total_cpu_count - Total number of CPU cores in use.
total_memory - Total RAM in use in MiB.
vpc_id - The ID of the VPC.

backup_settings#

The backup_settings block has the following structure:

bucket_name - The name of the bucket in object storage where the service backup is saved.
enabled - Indicates whether backup is enabled for the service.
expiration_days - The backup retention period in days.
notification_email - The email address to which a notification that backup was created is sent.
start_time - The time when the daily backup process starts. It is set as a string in the HH:MM format Moscow time.
user_id - The ID of a user with write permissions to the bucket in object storage.
user_login - The login of a user with write permissions to the bucket in object storage.

data_volume#

The data_volume block has the following structure:

iops - The number of read/write operations per second for the data volume.
size - The size of the data volume in GiB.
type - The type of the data volume.

endpoints#

The endpoints block has the following structure:

addresses - List of addresses for connecting to the service.
name - The name of the endpoint.

instances#

The instances block has the following structure:

endpoints - List of service endpoints on the instance. The structure of this block is described below.
index - The instance index.
instance_id - The ID of the instance.
interface_id - The ID of the instance network interface.
name - The instance name.
private_ip - The private IP address of the instance.
role - The instance role.
status - The current status of the instance.

instance endpoints#

The endpoints block has the following structure:

address - The address of the endpoint.
name - The name of the endpoint.

root_volume#

The root_volume block has the following structure:

iops - The number of read/write operations per second for the root volume.
size - The size of the root volume in GiB.
type - The type of the root volume.

Elasticsearch Attribute Reference#

~> Note The following attributes contain default parameter values or user-defined values used when the service is created.

In addition to the common attributes for all services described above, the following attributes are exported only for an Elasticsearch service:

allow_anonymous - Indicates whether anonymous access is enabled.
anonymous_role - The role for anonymous access.
class - The service class.
kibana - Indicates whether the Kibana deployment is enabled.
logging - The logging settings for the service. The structure of this block is described below.
monitoring - The monitoring settings for the service. The structure of this block is described below.
options - Other Elasticsearch parameters.
password - The Elasticsearch user password.
version - The installed version.

Memcached Attribute Reference#

~> Note The following attributes contain default parameter values or user-defined values used when the service is created.

In addition to the common attributes for all services described above, the following attributes are exported only for a Memcached service:

class - The service class.
logging - The logging settings for the service. The structure of this block is described below.
monitoring - The monitoring settings for the service. The structure of this block is described below.

MongoDB Attribute Reference#

~> Note The following attributes contain default parameter values or user-defined values used when the service is created.

In addition to the common attributes for all services described above, the following attributes are exported only for a Memcached service:

class - The service class.
database - List of MongoDB databases with parameters. The structure of this block is described below.
journal_commit_interval - The maximum interval in milliseconds between saving log data.
logging - The logging settings for the service. The structure of this block is described below.
maxconns - The maximum number of concurrent connections allowed for mongos or mongod.
monitoring - The monitoring settings for the service. The structure of this block is described below.
options - Other MongoDB parameters.
profile - Indicates which operations to profile.
slowms - The operation time threshold in milliseconds, above which the operation is considered slow.
storage_engine_cache_size - The maximum size of internal cache in GiB used to store all data.
user - List of MongoDB users with parameters. The structure of this block is described below.
quiet - Indicates whether the quiet mode of mongos or mongod is enabled.
verbositylevel - The level of message detail in the message log.
version - The installed version.

MongoDB database#

The database block has the following structure:

id - The ID of the database.
name - The database name.
user - List of database users with parameters. The structure of this block is described below.

MongoDB database user#

The user block has the following structure:

id - The ID of the user.
name - The MongoDB user name.
roles - List of user roles.

MongoDB user#

The user block has the following structure:

id - The ID of the user.
name - The MongoDB user name.
password - The MongoDB user password.

MySQL Attribute Reference#

~> Note The following attributes contain default parameter values or user-defined values used when the service is created.

In addition to the common attributes for all services described above, the following attributes are exported only for a MySQL service:

class - The service class.
connect_timeout - The number of seconds that the mysqld server waits for a connect packet before responding with Bad handshake.
database - List of MySQL databases with parameters. The structure of this block is described below.
galera_options - Other Galera parameters.
gcache_size - A Galera parameter. The size of GCache circular buffer storage preallocated on startup, in bytes.
gcs_fc_factor - A Galera parameter. The fraction of gcs_fc_limit at which replication is resumed when the recv queue length falls below this value.
gcs_fc_limit - A Galera parameter. The number of writesets. If the recv queue length exceeds it replication is suspended.
gcs_fc_master_slave - A Galera parameter. Indicates whether the cluster has only one source node.
gcs_fc_single_primary - A Galera parameter. Indicates whether there is more than one replication source.
innodb_buffer_pool_instances - The number of regions that innodb_buffer_pool_size is divided into when innodb_buffer_pool_size > 1 GiB.
innodb_buffer_pool_size - The size, in bytes, of the buffer pool used to cache table data and indexes.
innodb_change_buffering - Operations for which change buffering optimization is enabled.
innodb_flush_log_at_trx_commit - The value of the parameter controls the behaviour for transaction commit operations.
innodb_io_capacity - The number of I/O operations per second (IOPS) available to InnoDB background tasks.
innodb_io_capacity_max - The maximum number of IOPS that InnoDB background tasks can perform.
innodb_log_file_size - The size of a single file, in bytes, in the redo system log.
innodb_log_files_in_group - The number of system log files in a log group.
innodb_purge_threads - The number of background threads allocated for the InnoDB purge operation.
innodb_thread_concurrency - The maximum number of threads permitted inside of InnoDB.
innodb_strict_mode - The MySQL operation mode.
innodb_sync_array_size - The size of the mutex/lock wait array.
max_allowed_packet - The maximum size of one packet, any generated/intermediate string or any parameter sent by the mysql_stmt_send_long_data() C API function.
max_connect_errors - The maximum number of connection errors, at which the server blocks the host from further connections.
max_connections - The maximum permitted number of simultaneous client connections that a host can handle.
max_heap_table_size - The maximum size, in bytes, to which user-created MEMORY tables are permitted to grow.
logging - The logging settings for the service. The structure of this block is described below.
monitoring - The monitoring settings for the service. The structure of this block is described below.
options - Other MySQL parameters.
pxc_strict_mode - PXC mode.
table_open_cache - The number of open tables for all threads.
thread_cache_size - The number of threads that the server caches to establish new network connections.
tmp_table_size - The maximum size of internal in-memory temporary tables in bytes.
transaction_isolation - The transaction isolation level.
user - List of MySQL users with parameters. The structure of this block is described below.
vendor - The engine vendor.
version - The installed version.
wait_timeout - The number of seconds the server waits for activity on a noninteractive connection before closing it.

MySQL database#

The database block has the following structure:

backup_enabled - Indicates whether backup is enabled for the database.
backup_id - The database backup ID.
backup_db_name - The name of a database from the backup specified in the backup_id parameter.
charset - The database charset.
collate - The database collation.
id - The ID of the database.
name - The database name.
user - List of database users with parameters. The structure of this block is described below.

MySQL database user#

The user block has the following structure:

id - The ID of the user.
name - The MySQL user name.
options - List of user options.
privileges - List of user privileges.

MySQL user#

The user block has the following structure:

host - The hostname or IP address.
id - The ID of the user.
name - The MySQL user name.
password - The MySQL user password.

PostgreSQL Attribute Reference#

~> Note The following attributes contain default parameter values or user-defined values used when the service is created.

In addition to the common attributes for all services described above, the following attributes are exported only for a PostgreSQL service:

autovacuum - Indicates whether the server must run the autovacuum launcher daemon.
autovacuum_max_workers - The maximum number of autovacuum processes (other than the autovacuum launcher) that can run simultaneously.
autovacuum_vacuum_cost_delay - The cost delay value in milliseconds used in automatic VACUUM operations.
autovacuum_vacuum_cost_limit - The cost limit value used in automatic VACUUM operations.
autovacuum_analyze_scale_factor - The fraction of the table size to add to autovacuum_analyze_threshold when deciding whether to trigger ANALYZE.
autovacuum_vacuum_scale_factor - The fraction of the table size to add to autovacuum_vacuum_threshold when deciding whether to trigger VACUUM.
class - The service class.
database - List of PostgreSQL databases with parameters. The structure of this block is described below.
effective_cache_size - The planner’s assumption about the effective size of the disk cache, in bytes, that is available to a single query.
effective_io_concurrency - The number of concurrent disk I/O operations.
logging - The logging settings for the service. The structure of this block is described below.
maintenance_work_mem - The maximum amount of memory, in bytes, used by maintenance operations, such as VACUUM, CREATE INDEX, and ALTER TABLE ADD FOREIGN KEY.
max_connections - The maximum number of simultaneous connections to the database server.
max_wal_size - The maximum size, in bytes, that WAL can reach at automatic checkpoints.
max_parallel_maintenance_workers - The maximum number of parallel workers that a single utility command can start.
max_parallel_workers - The maximum number of workers that the system can support for parallel operations.
max_parallel_workers_per_gather - The maximum number of workers that a single Gather node can start.
max_worker_processes - The maximum number of background processes that the system can support.
min_wal_size - The minimum size, in bytes, to shrink the WAL to. As long as WAL disk usage stays below this setting, old WAL files are always recycled for future use at a checkpoint, rather than removed.
monitoring - The monitoring settings for the service. The structure of this block is described below.
options - Other PostgreSQL parameters.
replication_mode - The replication mode in the Patroni cluster.
shared_buffers - The amount of memory, in bytes, the database server uses for shared memory buffers.
user - List of PostgreSQL users with parameters. The structure of this block is described below.
version - The installed version.
wal_buffers - The amount of shared memory used for WAL data not yet written to a volume.
wal_keep_segments - The minimum number of log files segments that must be kept in the pg_xlog directory, in case a standby server needs to fetch them for streaming replication.
work_mem - The base maximum amount of memory, in bytes, to be used by a query operation (such as a sort or hash table) before writing to temporary disk files.

PostgreSQL database#

The database block has the following structure:

backup_enabled - Indicates whether backup is enabled for the database.
backup_id - The database backup ID.
backup_db_name - The name of a database from the backup specified in the backup_id parameter.
encoding - The database encoding.
extensions - List of extensions for the database.
id - The ID of the database.
locale - The database locale.
name - The database name.
owner - The name of the user who is the database owner.
user - List of database users with parameters. The structure of this block is described below.

PostgreSQL database user#

The user block has the following structure:

id - The ID of the user.
name - The PostgreSQL user name.

PostgreSQL user#

The user block has the following structure:

id - The ID of the user.
name - The PostgreSQL user name.
password - The PostgreSQL user password.

RabbitMQ Attribute Reference#

~> Note The following attributes contain default parameter values or user-defined values used when the service is created.

In addition to the common attributes for all services described above, the following attributes are exported only for a RabbitMQ service:

class - The service class.
logging - The logging settings for the service. The structure of this block is described below.
monitoring - The monitoring settings for the service. The structure of this block is described below.
options - Other RabbitMQ parameters.
password - The RabbitMQ admin password.
version - The installed version.

Redis Attribute Reference#

~> Note The following attributes contain default parameter values or user-defined values used when the service is created.

In addition to the common attributes for all services described above, the following attributes are exported only for a Redis service:

class - The service class.
cluster_type - The clustering option.
databases - The number of databases.
logging - The logging settings for the service. The structure of this block is described below.
maxmemory_policy - The memory management mode.
monitoring - The monitoring settings for the service. The structure of this block is described below.
options - Other Redis parameters.
password - The Redis user password.
persistence_aof - Indicates whether the AOF storage mode is enabled.
persistence_rdb - Indicates whether the RDB storage mode is enabled.
timeout - The time in seconds during which the connection to an inactive client is retained.
tcp_backlog - The size of a connection queue.
tcp_keepalive - The time in seconds during which the service sends ACKs to detect dead peers (unreachable clients).
version - The installed version.

Common Service Attribute Reference#

logging#

The logging block has the following structure:

log_to - The ID of the logging service.
logging_tags - List of tags that are assigned to the log records of the service.

monitoring#

The monitoring block has the following structure:

monitor_by - The ID of the monitoring service.
monitoring_labels - Map containing labels that are assigned to the metrics of the service.