https://github.com/scaleway-terraform-modules/terraform-scaleway-security_group
Manage Scaleway security groups with Terraform.
https://github.com/scaleway-terraform-modules/terraform-scaleway-security_group
scaleway scaleway-security-group security-group terraform-module
Last synced: 27 days ago
JSON representation
Manage Scaleway security groups with Terraform.
- Host: GitHub
- URL: https://github.com/scaleway-terraform-modules/terraform-scaleway-security_group
- Owner: scaleway-terraform-modules
- License: mpl-2.0
- Created: 2023-01-28T13:11:42.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-03-21T06:43:43.000Z (about 2 months ago)
- Last Synced: 2025-04-22T19:11:40.107Z (27 days ago)
- Topics: scaleway, scaleway-security-group, security-group, terraform-module
- Language: HCL
- Homepage:
- Size: 75.2 KB
- Stars: 2
- Watchers: 1
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Terraform / Scaleway
## Purpose
This repository is used to create a security group on scaleway using terraform.
## Usage
- Setup the [scaleway provider](https://www.terraform.io/docs/providers/scaleway/index.html) in your tf file.
- Include this module in your tf file. Refer to [documentation](https://www.terraform.io/docs/modules/sources.html#generic-git-repository).
```hcl
module "my_sg" {
source = "scaleway-terraform-modules/security_group/scaleway"
version = "1.0.2"
}
```
## Requirements
| Name | Version |
|------|---------|
| [terraform](#requirement_terraform) | >= 0.13 |
| [scaleway](#requirement_scaleway) | >= 2.3.0 |
## Resources
| Name | Type |
|------|------|
| [scaleway_instance_security_group.this](https://registry.terraform.io/providers/scaleway/scaleway/latest/docs/resources/instance_security_group) | resource |
| [scaleway_instance_security_group_rules.this](https://registry.terraform.io/providers/scaleway/scaleway/latest/docs/resources/instance_security_group_rules) | resource |
## Inputs
| Name | Description | Type | Default | Required |
|------|-------------|------|---------|:--------:|
| [create_sg](#input_create_sg) | Whether you choose to create a new security group. Set to false if you want to use already existing group. | `bool` | `true` | no |
| [enable_default_security](#input_enable_default_security) | Whether to block SMTP on IPv4/IPv6 (Port 25, 465, 587). Set to false will unblock SMTP if your account is authorized to. If your organization is not yet authorized to send SMTP traffic, open a support ticket. | `bool` | `true` | no |
| [inbound_default_policy](#input_inbound_default_policy) | Default policy on incoming traffic. Possible values are: accept or drop. | `string` | `"drop"` | no |
| [inbound_rules](#input_inbound_rules) | List of inbound rule to add to the security group. | ```list(object({ action = string protocol = string port = optional(number) port_range = optional(string) ip = optional(string) ip_range = optional(string) }))``` | ```[ { "action": null, "ip": null, "ip_range": null, "port": null, "port_range": null, "protocol": null } ]``` | no |
| [name](#input_name) | Name of the security group. | `string` | `null` | no |
| [outbound_default_policy](#input_outbound_default_policy) | Default policy on outgoing traffic. Possible values are: accept or drop. | `string` | `"drop"` | no |
| [outbound_rules](#input_outbound_rules) | List of outbound rule to add to the security group. | ```list(object({ action = string protocol = string port = optional(number) port_range = optional(string) ip = optional(string) ip_range = optional(string) }))``` | ```[ { "action": null, "ip": null, "ip_range": null, "port": null, "port_range": null, "protocol": null } ]``` | no |
| [security_group_description](#input_security_group_description) | Security Group description | `string` | `""` | no |
| [security_group_id](#input_security_group_id) | Whether you choose to use and existing security group. | `string` | `""` | no |
| [sg_tags](#input_sg_tags) | Additional tags for the Security Groups | `list(string)` | `[]` | no |
| [stateful](#input_stateful) | Boolean to specify whether the security group should be stateful or not. | `bool` | `true` | no |
| [tags](#input_tags) | Tags associated with the security group and its rules. | `list(any)` | `[]` | no |
## Outputs
| Name | Description |
|------|-------------|
| [group_id](#output_group_id) | ID of the security group. |
| [security_group_description](#output_security_group_description) | The description of the security group |
| [security_group_id](#output_security_group_id) | The ID of the security group |
| [security_group_name](#output_security_group_name) | The name of the security group |
## Authors
Module is maintained with help from [the community](https://github.com/scaleway-terraform-modules/terraform-scaleway-security_group/graphs/contributors).
## License
Mozilla Public License 2.0 Licensed. See [LICENSE](https://github.com/scaleway-terraform-modules/terraform-scaleway-security_group/tree/master/LICENSE) for full details.