alicloud_security_group_rule
Provides a Security Group Rule resource.
For information about Security Group Rule and how to use it, see What is Rule.
-> NOTE: Available since v0.1.0.
Represents a single ingress or egress group rule, which can be added to external Security Groups.
-> NOTE: nic_type should set to intranet when security group type is vpc or specifying the source_security_group_id. In this situation it does not distinguish between intranet and internet, the rule is effective on them both.
Example Usage
Basic Usage
resource "alicloud_security_group" "default" {
security_group_name = "default"
}
resource "alicloud_security_group_rule" "allow_all_tcp" {
type = "ingress"
ip_protocol = "tcp"
nic_type = "intranet"
policy = "accept"
port_range = "1/65535"
priority = 1
security_group_id = alicloud_security_group.default.id
cidr_ip = "0.0.0.0/0"
}
Need more examples? VIEW MORE EXAMPLES
Module Support
You can use the existing security-group module to create a security group and add several rules one-click.
Argument Reference
The following arguments are supported:
-
security_group_id- (Required, ForceNew) The ID of the Security Group. -
type- (Required, ForceNew) The type of the Security Group Rule. Valid values:ingress: inbound.egress: outbound.
-
ip_protocol- (Required, ForceNew) The transport layer protocol of the Security Group Rule. Valid values:tcp,udp,icmp,icmpv6,gre,all. NOTE: From version 1.262.0,ip_protocolcan be set toicmpv6. -
policy- (Optional, ForceNew) The action of the Security Group Rule that determines whether to allow inbound access. Default value:accept. Valid values:accept,drop. -
priority- (Optional, ForceNew, Int) The priority of the Security Group Rule. Default value:1. Valid values:1to100. -
cidr_ip- (Optional, ForceNew) The target IPv4 CIDR address range. Other supported formats include 10.159.6.18/12. Only IPv4 is supported. NOTE: This field has no default value; leaving it empty does not open traffic to all sources but instead fails withMissingParameter.Source(ingress) orMissingParameter.Dest(egress). To allow all IPv4 traffic, setcidr_ip = "0.0.0.0/0"explicitly. -
ipv6_cidr_ip- (Optional, ForceNew, Available since v1.174.0) Source IPv6 CIDR address block that requires access. Supports IP address ranges in CIDR format and IPv6 format. NOTE: This parameter cannot be set at the same time as thecidr_ipparameter. -
source_security_group_id- (Optional, ForceNew) The target security group ID within the same region. If this field is specified, thenic_typecan only selectintranet. -
source_group_owner_account- (Optional, ForceNew, Deprecated) The Alibaba Cloud account of the target security group owner when security groups are authorized across accounts. This field may not take effect. Usesource_group_owner_idinstead. This parameter is invalid ifcidr_iphas already been set. -
source_group_owner_id- (Optional, ForceNew) The Alibaba Cloud account ID of the target security group owner when security groups are authorized across accounts. -
prefix_list_id- (Optional, ForceNew) The ID of the source/destination prefix list to which you want to control access. NOTE: If you specifycidr_ip,source_security_group_id,ipv6_cidr_ipparameter, this parameter is ignored. -
port_range- (Optional, ForceNew) The range of port numbers relevant to the IP protocol. Default to "-1/-1". When the protocol is tcp or udp, each side port number range from 1 to 65535 and '-1/-1' will be invalid. For example,1/200means that the range of the port numbers is 1-200. Other protocols' 'port_range' can only be "-1/-1", and other values will be invalid. -
nic_type- (Optional, ForceNew) Network type, can be eitherinternetorintranet, the default value isinternet. -
description- (Optional) The description of the security group rule. The description can be up to 1 to 512 characters in length. Defaults to null.-> NOTE: You must specify one of the following field:
cidr_ip,source_security_group_id,prefix_list_id,ipv6_cidr_ip.
Attributes Reference
The following attributes are exported:
security_group_rule_id- The ID of the Security Group Rule.id- The resource ID in terraform, which is composed by terraform provider.
NOTE: if cidr_ip is set, the id formats as <security_group_id>:<type>:<ip_protocol>:<port_range>:<nic_type>:<cidr_ip>:<policy>:<priority>.
NOTE: if ipv6_cidr_ip is set, the id formats as <security_group_id>:<type>:<ip_protocol>:<port_range>:<nic_type>:<ipv6_cidr_ip>:<policy>:<priority>.
NOTE: if source_security_group_id is set, the id formats as <security_group_id>:<type>:<ip_protocol>:<port_range>:<nic_type>:<source_security_group_id>:<policy>:<priority>.
NOTE: if prefix_list_id is set, the id formats as <security_group_id>:<type>:<ip_protocol>:<port_range>:<nic_type>:<prefix_list_id>:<policy>:<priority>.
Import
-> NOTE: Available since v1.224.0.
Security Group Rule can be imported using the ID in the format <security_group_id>:<type>:<ip_protocol>:<port_range>:<nic_type>:<cidr_ip>:<policy>:<priority>, e.g.
$ terraform import alicloud_security_group_rule.example sg-12345678:ingress:tcp:80/80:internet:10.0.0.0/8:accept:1
NOTE: The <cidr_ip> part is the source or destination of the rule: use cidr_ip for IPv4 rules, source_security_group_id when the rule references another security group, prefix_list_id for prefix list rules, or ipv6_cidr_ip for IPv6 rules — with every : in the IPv6 address replaced by _, e.g. 2408:4004:cc:400::/56 becomes 2408_4004_cc_400__/56. Every part must match the rule exactly as shown in the console, including nic_type (intranet for security groups in a VPC). Otherwise the rule cannot be found and the import fails.