Resource: aws_default_security_group#
Provides a resource to manage a default security group. This resource can manage the default security group of the default or a non-default VPC.
Note
This is an advanced resource with special caveats. Please read this document in its entirety before using this resource. The aws_default_security_group
resource behaves differently from normal resources. Terraform does not create this resource but instead attempts to "adopt" it into management.
immediately removes all ingress and egress rules in the Security Group
When Terraform first adopts the default security group, it . It then creates any rules specified in the configuration. This way only the rules specified in the configuration are created.
This resource treats its inline rules as absolute; only the rules defined inline are created, and any additions/removals external to this resource will result in diff shown. For these reasons, this resource is incompatible with the aws_security_group_rule
resource.
For more information about default security groups, see the documentation on Default Security Groups. To manage normal security groups, see the aws_security_group
resource.
Example Usage#
The following config gives the default security group the same rules that the cloud provides by default but under management by Terraform. This means that any ingress or egress rules added or changed will be detected as drift.
resource "aws_vpc" "mainvpc" {
cidr_block = "10.1.0.0/16"
}
resource "aws_default_security_group" "example" {
vpc_id = aws_vpc.mainvpc.id
ingress {
protocol = -1
self = true
from_port = 0
to_port = 0
}
egress {
from_port = 0
to_port = 0
protocol = "-1"
cidr_blocks = ["0.0.0.0/0"]
}
}
Example Config To Deny All Egress Traffic, Allowing Ingress#
The following denies all Egress traffic by omitting any egress
rules, while including the default ingress
rule to allow all traffic.
resource "aws_vpc" "mainvpc" {
cidr_block = "10.1.0.0/16"
}
resource "aws_default_security_group" "example" {
vpc_id = aws_vpc.mainvpc.id
ingress {
protocol = -1
self = true
from_port = 0
to_port = 0
}
}
Removing aws_default_security_group
From Your Configuration#
Removing this resource from your configuration will remove it from your statefile and management, but will not destroy the security group. All ingress or egress rules will be left as they are at the time of removal. You can resume managing them via the cloud console.
Argument Reference#
The following arguments are optional:
egress
- (Optional, VPC only) Configuration block. Detailed below.ingress
- (Optional) Configuration block. Detailed below.tags
- (Optional) Map of tags to assign to the resource. If configured with a providerdefault_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.vpc_id
- (Optional, Forces new resource) VPC ID. Note that changing thevpc_id
will not restore any default security group rules that were modified, added, or removed. It will be left in its current state.
egress and ingress#
Both arguments are processed in attribute-as-blocks mode.
Both egress
and ingress
objects have the same arguments.
cidr_blocks
- (Optional) List of CIDR blocks.description
- (Optional) Description of this rule.from_port
- (Required) Start port (or ICMP type number if protocol isicmp
)ipv6_cidr_blocks
- (Optional) List of IPv6 CIDR blocks.protocol
- (Required) Protocol. If you select a protocol of "-1" (semantically equivalent toall
, which is not a valid value here), you must specify afrom_port
andto_port
equal to0
. If noticmp
,tcp
,udp
, or-1
use the protocol number.security_groups
- (Optional) List of security group names or IDs.self
- (Optional) Whether the security group itself will be added as a source to this egress rule.to_port
- (Required) End range port (or ICMP code if protocol isicmp
).
Attributes Reference#
Supported attributes#
In addition to all arguments above, the following attributes are exported:
arn
- ARN of the security group.description
- Description of the security group.id
- ID of the security group.name
- Name of the security group.owner_id
- The project ID.tags_all
- A map of tags assigned to the resource, including those inherited from the providerdefault_tags
configuration block.
Unsupported attributes#
Note
These attributes may be present in the terraform.tfstate
file but they have preset values and cannot be specified in configuration files.
The following attributes are not currently supported: prefix_list_ids
.
Import#
Security Groups can be imported using the security group id
, e.g.,
$ terraform import aws_default_security_group.default_sg sg-12345678