SecurityGroupRuleRequest¶
Structure Class¶
SecurityGroupRuleRequest
dataclass
¶
Bases: _SerdeShape
Describes a security group rule.
You must specify exactly one of the following parameters, based on the rule type:
-
CidrIpv4
-
CidrIpv6
-
PrefixListId
-
ReferencedGroupId
Note
Amazon Web Services canonicalizes IPv4 and IPv6 CIDRs. For example, if you specify 100.68.0.18/18 for the CIDR block, Amazon Web Services canonicalizes the CIDR block to 100.68.0.0/18. Any subsequent DescribeSecurityGroups and DescribeSecurityGroupRules calls will return the canonicalized form of the CIDR block. Additionally, if you attempt to add another rule with the non-canonical form of the CIDR (such as 100.68.0.18/18) and there is already a rule for the canonicalized form of the CIDR block (such as 100.68.0.0/18), the API throws an duplicate rule error.
When you modify a rule, you cannot change the rule type. For example, if
the rule uses an IPv4 address range, you must use CidrIpv4 to specify
a new IPv4 address range.
Attributes¶
cidr_ipv4
class-attribute
instance-attribute
¶
cidr_ipv4: str | None = ...
The IPv4 CIDR range. To specify a single IPv4 address, use the /32 prefix length.
cidr_ipv6
class-attribute
instance-attribute
¶
cidr_ipv6: str | None = ...
The IPv6 CIDR range. To specify a single IPv6 address, use the /128 prefix length.
description
class-attribute
instance-attribute
¶
description: str | None = ...
The description of the security group rule.
from_port
class-attribute
instance-attribute
¶
from_port: int | None = ...
If the protocol is TCP or UDP, this is the start of the port range. If the protocol is ICMP or ICMPv6, this is the ICMP type or -1 (all ICMP types).
ip_protocol
class-attribute
instance-attribute
¶
ip_protocol: str | None = ...
The IP protocol name (tcp, udp, icmp, icmpv6) or number (see
Protocol
Numbers).
Use -1 to specify all protocols.
prefix_list_id
class-attribute
instance-attribute
¶
prefix_list_id: str | None = ...
The ID of the prefix list.
referenced_group_id
class-attribute
instance-attribute
¶
referenced_group_id: str | None = ...
The ID of the security group that is referenced in the security group rule.
to_port
class-attribute
instance-attribute
¶
to_port: int | None = ...
If the protocol is TCP or UDP, this is the end of the port range. If the protocol is ICMP or ICMPv6, this is the ICMP code or -1 (all ICMP codes). If the start port is -1 (all ICMP types), then the end port must be -1 (all ICMP codes).