Module Documentation
Auto-generated Terraform module reference — inputs, outputs, resources, and sub-modules.
This page is auto-generated from the Terraform source in
[org-kickstart](https://github.com/primeharbor/org-kickstart).
Run `make generate-module-docs` in the `org-kickstart-site/` directory to refresh it.
Requirements
| Name | Version |
|---|---|
| aws | >= 5.80.0 |
Providers
| Name | Version |
|---|---|
| aws | >= 5.80.0 |
| aws.security-account | >= 5.80.0 |
| external | n/a |
Modules
| Name | Source | Version |
|---|---|---|
| accounts | ./modules/account | n/a |
| billing_alerts | ./modules/billing_alerts | n/a |
| declarative_policies | ./modules/declarative_policies | n/a |
| rcp | ./modules/rcp | n/a |
| scp | ./modules/scp | n/a |
| security_account | ./modules/account | n/a |
Resources
Inputs
| Name | Description | Type | Default | Required |
|---|---|---|---|---|
| account_configurator | n/a | any |
null |
no |
| accounts | Account Index | any |
n/a | yes |
| admin_group_name | Name of the Identity Store Group with all the admin users | string |
"AllAdmins" |
no |
| admin_permission_set_name | Name of the Permission Set to Create | string |
"AdministratorAccess" |
no |
| audit_role_name | Name of the AuditRole to deploy | string |
"security-audit" |
no |
| audit_role_stack_set_template_url | URL that points to the Audit Role Policy Template | string |
null |
no |
| backend_bucket | n/a | any |
n/a | yes |
| billing_alerts | n/a | any |
null |
no |
| billing_data_bucket_name | Name of the S3 Bucket for CUR reports. Set to null to disable | string |
null |
no |
| cloudtrail_bucket_name | Name of the S3 Bucket to create to store CloudTrail events. Set to null to disable cloudtrail management | string |
null |
no |
| cloudtrail_loggroup_name | Name of the CloudWatch Log Group in the payer account where CloudTrail will send its events | string |
null |
no |
| cur_report_frequency | Frequency CUR reports should be delivered (DAILY, HOURLY, MONTHLY). Set to NONE to disable | string |
"NONE" |
no |
| declarative_policies | Map of Declarative Policies to deploy | map |
{} |
no |
| declarative_policy_bucket_name | Name of S3 Bucket for Declarative Policy Reports | any |
null |
no |
| deploy_audit_role | Boolean to determine if org-kickstart should manage Audit Role | bool |
true |
no |
| disable_sso_management | Set to true to manage AWS Identity Center outside of org-kickstart | bool |
false |
no |
| global_billing_contact | Map for the central billing alternate contact to be applied to all accounts | any |
null |
no |
| global_operations_contact | Map for the central operations alternate contact to be applied to all accounts | any |
null |
no |
| global_primary_contact | Map for the primary account owner to be applied to all accounts | any |
null |
no |
| global_security_contact | Map for the central security alternate contact to be applied to all accounts | any |
null |
no |
| macie_bucket_name | Name of the S3 Bucket to create to store Macie Findings. Set to null to skip creation | string |
null |
no |
| organization_name | Name of the Organization. This is used for resource prefixes and general reference | string |
n/a | yes |
| organization_units | Map of OUs to deploy | map |
{} |
no |
| payer_email | Root Email address for the Organization Management account | string |
null |
no |
| payer_name | Name of the Organization Management account | string |
"AWS Payer" |
no |
| resource_control_policies | Map of RCPs to deploy | map |
{} |
no |
| security_account_name | Name of the Security Account | string |
"Security Account" |
no |
| security_account_root_email | Root Email address for the security account | string |
null |
no |
| security_services | explictly disable or not manage a security service | map |
{ |
no |
| service_control_policies | Map of SCPs to deploy | map |
{} |
no |
| session_duration | Default Session Duration | string |
"PT8H" |
no |
| tag_set | Default map of tags to be applied to all resources via all providers | map(any) |
{} |
no |
| vpc_flowlogs_bucket_name | Name of the S3 Bucket to create to store VPC Flow Logs. Set to null to skip creation | string |
null |
no |
Outputs
| Name | Description |
|---|---|
| cloudtrail_cloudwatch_log_group | n/a |
| cloudtrail_s3_notification_topic | n/a |
| declarative_policy_bucket | n/a |
| macie_key_arn | Things to pass to the Security Services Regional Modules |
| org_id | n/a |
| org_name | n/a |
| security_account_id | n/a |
| sso_instance_arn | AWS Identity Center Instance ARN managed by org-kickstart |
Feedback
Was this page helpful?
Glad to hear it! Please tell us how we can improve.
Sorry to hear that. Please tell us how we can improve.