Skip to content

tfdocs.md

Latest commit

 

History

History
239 lines (232 loc) · 31.5 KB

tfdocs.md

File metadata and controls

239 lines (232 loc) · 31.5 KB
Raw

Providers

Name Version
aws 5.12.0
null 3.2.4
random 3.7.2
tls 4.1.0

Modules

Name Source Version
alb terraform-aws-modules/alb/aws 8.7.0
connection_strings ./modules/connection_strings/v1.0.0 n/a
elasticache_wave_lite ./modules/elasticache n/a
rds terraform-aws-modules/rds/aws 6.1.1
rds-wave-lite terraform-aws-modules/rds/aws 6.1.1
sg_alb_core terraform-aws-modules/security-group/aws 5.1.0
sg_batch terraform-aws-modules/security-group/aws 5.1.0
sg_db terraform-aws-modules/security-group/aws 5.1.0
sg_ec2_core terraform-aws-modules/security-group/aws 5.1.0
sg_ec2_noalb_connect terraform-aws-modules/security-group/aws 5.1.0
sg_ec2_noalb_no_https terraform-aws-modules/security-group/aws 5.1.0
sg_ec2_noalb_with_private_certificate terraform-aws-modules/security-group/aws 5.1.0
sg_eice terraform-aws-modules/security-group/aws 5.1.0
sg_from_alb_connect terraform-aws-modules/security-group/aws 5.1.0
sg_from_alb_core terraform-aws-modules/security-group/aws 5.1.0
sg_from_alb_wave terraform-aws-modules/security-group/aws 5.1.0
sg_redis terraform-aws-modules/security-group/aws 5.1.0
sg_vpc_endpoint terraform-aws-modules/security-group/aws 5.1.0
subnet_collector ./modules/subnet_collector/v1.0.0 n/a
vpc terraform-aws-modules/vpc/aws 5.1.2

Inputs

Name Description Type Default Required
alb_certificate_arn n/a string n/a yes
app_name n/a string n/a yes
aws_account n/a string n/a yes
aws_profile n/a string n/a yes
aws_region n/a string n/a yes
custom_resource_naming_prefix n/a string n/a yes
data_explorer_disabled_workspaces n/a string n/a yes
data_studio_container_version n/a string n/a yes
data_studio_eligible_workspaces n/a string n/a yes
data_studio_options n/a 
map(object({
    qualifier = string
    icon      = string
    tool      = optional(string)
    status    = optional(string)
    container = string
  }))
 n/a yes
data_studio_path_routing_url Domain where Connect Proxy is available. string n/a yes
db_allocated_storage n/a number n/a yes
db_backup_retention_period n/a number n/a yes
db_container_engine n/a string n/a yes
db_container_engine_version n/a string n/a yes
db_database_name n/a string n/a yes
db_deletion_protection n/a bool n/a yes
db_enable_storage_encrypted n/a bool n/a yes
db_engine n/a string n/a yes
db_engine_version n/a string n/a yes
db_instance_class n/a string n/a yes
db_param_group n/a string n/a yes
default_tags n/a map(string) n/a yes
docker_cidr_range n/a string n/a yes
ec2_ebs_kms_key n/a string n/a yes
ec2_host_instance_type n/a string n/a yes
ec2_require_imds_token n/a bool n/a yes
ec2_root_volume_size n/a number n/a yes
ec2_update_ami_if_available n/a bool n/a yes
enable_vpc_flow_logs n/a bool n/a yes
existing_route53_private_zone_name n/a string n/a yes
existing_route53_public_zone_name n/a string n/a yes
flag_create_external_db n/a bool n/a yes
flag_create_external_redis n/a bool n/a yes
flag_create_hosts_file_entry n/a bool n/a yes
flag_create_load_balancer n/a bool n/a yes
flag_create_new_vpc n/a bool n/a yes
flag_create_route53_private_zone n/a bool n/a yes
flag_data_explorer_enabled n/a bool n/a yes
flag_disable_email_login n/a bool n/a yes
flag_do_not_use_https n/a bool n/a yes
flag_docker_logging_journald n/a bool n/a yes
flag_docker_logging_jsonfile n/a bool n/a yes
flag_docker_logging_local n/a bool n/a yes
flag_enable_data_studio n/a bool n/a yes
flag_enable_groundswell n/a bool n/a yes
flag_encrypt_ebs n/a bool n/a yes
flag_iam_use_prexisting_role_arn n/a bool n/a yes
flag_limit_data_studio_to_some_workspaces n/a bool n/a yes
flag_make_instance_private n/a bool n/a yes
flag_make_instance_private_behind_public_alb n/a bool n/a yes
flag_make_instance_public n/a bool n/a yes
flag_oidc_use_generic n/a bool n/a yes
flag_oidc_use_github n/a bool n/a yes
flag_oidc_use_google n/a bool n/a yes
flag_overwrite_ssm_keys Not to be used in PROD but helpful when sharing same instance in DEV. bool false no
flag_private_tower_without_eice n/a bool n/a yes
flag_run_seqerakit n/a bool n/a yes
flag_studio_enable_path_routing n/a bool n/a yes
flag_use_aws_ses_iam_integration n/a bool n/a yes
flag_use_container_db n/a bool n/a yes
flag_use_container_redis n/a bool n/a yes
flag_use_custom_resource_naming_prefix n/a bool n/a yes
flag_use_existing_external_db n/a bool n/a yes
flag_use_existing_route53_private_zone n/a bool n/a yes
flag_use_existing_route53_public_zone n/a bool n/a yes
flag_use_existing_smtp n/a bool n/a yes
flag_use_existing_vpc n/a bool n/a yes
flag_use_kms_key n/a bool n/a yes
flag_use_private_cacert n/a bool n/a yes
flag_use_wave n/a bool n/a yes
flag_use_wave_lite n/a bool n/a yes
flag_vm_copy_files_to_instance n/a bool n/a yes
iam_prexisting_instance_role_arn n/a string n/a yes
new_route53_private_zone_name n/a string n/a yes
num_wave_lite_replicas n/a number n/a yes
private_cacert_bucket_prefix n/a string n/a yes
secrets_bootstrap_groundswell SSM SecureString for Groundswell secrets. string n/a yes
secrets_bootstrap_seqerakit SSM SecureString for Seqerakit secrets. string n/a yes
secrets_bootstrap_tower SSM SecureString for Tower secrets. string n/a yes
secrets_bootstrap_wave_lite SSM SecureString for Wave Lite secrets. string n/a yes
seqerakit_aws_fusion_instances n/a string n/a yes
seqerakit_aws_manual_compute_queue n/a string n/a yes
seqerakit_aws_manual_head_queue n/a string n/a yes
seqerakit_aws_normal_instances n/a string n/a yes
seqerakit_aws_use_batch n/a bool n/a yes
seqerakit_aws_use_forge n/a bool n/a yes
seqerakit_aws_use_fusion_v2 n/a bool n/a yes
seqerakit_compute_env_name n/a string n/a yes
seqerakit_compute_env_region n/a string n/a yes
seqerakit_flag_credential_create_aws n/a bool n/a yes
seqerakit_flag_credential_create_codecommit n/a bool n/a yes
seqerakit_flag_credential_create_docker n/a bool n/a yes
seqerakit_flag_credential_create_github n/a bool n/a yes
seqerakit_flag_credential_use_aws_role n/a bool n/a yes
seqerakit_flag_credential_use_codecommit_baseurl n/a bool n/a yes
seqerakit_org_fullname n/a string n/a yes
seqerakit_org_name n/a string n/a yes
seqerakit_org_url n/a string n/a yes
seqerakit_outdir n/a string n/a yes
seqerakit_root_bucket n/a string n/a yes
seqerakit_team_members n/a string n/a yes
seqerakit_team_name n/a string n/a yes
seqerakit_workdir n/a string n/a yes
seqerakit_workspace_fullname n/a string n/a yes
seqerakit_workspace_name n/a string n/a yes
sg_egress_batch_ec2 n/a list(string) n/a yes
sg_egress_eice n/a list(string) n/a yes
sg_egress_interface_endpoint n/a list(string) n/a yes
sg_egress_tower_alb n/a list(string) n/a yes
sg_egress_tower_ec2 n/a list(string) n/a yes
sg_ingress_cidrs n/a list(string) n/a yes
sg_ssh_cidrs n/a list(string) n/a yes
skip_final_snapshot n/a bool n/a yes
swell_container_version n/a string n/a yes
swell_database_name n/a string n/a yes
tower_audit_retention_days n/a number n/a yes
tower_contact_email n/a string n/a yes
tower_container_version Harbor container version (i.e. tag: v23.2.0) string n/a yes
tower_db_dialect n/a string n/a yes
tower_db_driver n/a string n/a yes
tower_db_max_lifetime n/a number n/a yes
tower_db_max_pool_size n/a number n/a yes
tower_db_min_pool_size n/a number n/a yes
tower_db_url n/a string n/a yes
tower_email_trusted_orgs n/a string n/a yes
tower_email_trusted_users n/a string n/a yes
tower_enable_platforms n/a string n/a yes
tower_root_users n/a string n/a yes
tower_server_port n/a string n/a yes
tower_server_url n/a string n/a yes
tower_smtp_auth n/a bool n/a yes
tower_smtp_host n/a string n/a yes
tower_smtp_port n/a string n/a yes
tower_smtp_ssl_protocols n/a string n/a yes
tower_smtp_starttls_enable n/a bool n/a yes
tower_smtp_starttls_required n/a bool n/a yes
use_mocks Use to drive mocking behaviour for to-be-created resources. bool false no
vpc_existing_alb_subnets n/a list(string) n/a yes
vpc_existing_batch_subnets n/a list(string) n/a yes
vpc_existing_db_subnets n/a list(string) n/a yes
vpc_existing_ec2_subnets n/a list(string) n/a yes
vpc_existing_id n/a string n/a yes
vpc_existing_redis_subnets n/a list(string) n/a yes
vpc_gateway_endpoints_all n/a list(any) n/a yes
vpc_interface_endpoints_batch n/a list(any) n/a yes
vpc_interface_endpoints_tower n/a list(any) n/a yes
vpc_new_alb_subnets n/a list(string) n/a yes
vpc_new_azs n/a list(string) n/a yes
vpc_new_batch_subnets n/a list(string) n/a yes
vpc_new_cidr_range n/a string n/a yes
vpc_new_db_subnets n/a list(string) n/a yes
vpc_new_ec2_subnets n/a list(string) n/a yes
vpc_new_private_subnets n/a list(string) n/a yes
vpc_new_public_subnets n/a list(string) n/a yes
vpc_new_redis_subnets n/a list(string) n/a yes
wave_lite_db_allocated_storage n/a number n/a yes
wave_lite_db_backup_retention_period n/a number n/a yes
wave_lite_db_deletion_protection n/a bool n/a yes
wave_lite_db_enable_storage_encrypted n/a bool n/a yes
wave_lite_db_engine n/a string n/a yes
wave_lite_db_engine_version n/a string n/a yes
wave_lite_db_instance_class n/a string n/a yes
wave_lite_db_param_group n/a string n/a yes
wave_lite_elasticache Configuration for the Wave Elasticache instance including networking, clustering, and encryption settings 
object({
    apply_immediately = bool
    engine            = string
    engine_version    = string
    node_type         = string
    port              = number

    security_group_ids = list(string)
    subnet_ids         = list(string)

    unclustered = object({
      num_cache_nodes = number
    })

    clustered = object({
      multi_az_enabled           = bool
      automatic_failover_enabled = bool
      num_node_groups            = optional(number)
      replicas_per_node_group    = optional(number)
      parameter_group_name       = string
    })

    encryption = object({
      auth_token                 = optional(string)
      at_rest_encryption_enabled = bool
      transit_encryption_enabled = bool
      kms_key_id                 = optional(string)
    })
  })
 n/a yes
wave_lite_skip_final_snapshot n/a bool n/a yes
wave_server_url n/a string n/a yes

Outputs

Name Description
aws_account_id n/a
aws_caller_arn n/a
aws_caller_user n/a
aws_ec2_private_ip n/a
aws_ec2_public_ip n/a
ec2_ssh_key n/a
route53_record_status n/a
swell_db_dns The DNS for Groundswell
swell_db_url The complete database URL for Groundswell
tower_api_endpoint n/a
tower_base_url n/a
tower_connect_dns The DNS name for Connect
tower_connect_redis_dns The DNS for the Redis instance used by Connect.
tower_connect_redis_url The URL for the Redis instance used by Connect.
tower_connect_server_url The server URL for Connect with appropriate protocol and port
tower_connect_wildcard_dns The DNS name for Connect
tower_db_dns The DB root.
tower_db_url The complete database URL for Tower including database name and connection string
tower_redis_dns The Redis DNS for Tower
tower_redis_url The Redis URL for Tower
tower_server_url n/a
tower_wave_dns The DNS name for Wave without protocol prefix
tower_wave_url The URL for Wave-Lite
wave_lite_db_dns The database DNS for Wave-Lite
wave_lite_db_url The database URL for Wave-Lite
wave_lite_redis_dns The Redis DNS for Wave-Lite
wave_lite_redis_url The Redis URL for Wave-Lite