Skip to content

EC2  >  Structures  >  SecurityGroupRule

SecurityGroupRule

Structure Class

SecurityGroupRule dataclass

Bases: _SerdeShape

Describes a security group rule.

Attributes

cidr_ipv4 class-attribute instance-attribute
cidr_ipv4: str | None = ...

The IPv4 CIDR range.

cidr_ipv6 class-attribute instance-attribute
cidr_ipv6: str | None = ...

The IPv6 CIDR range.

description class-attribute instance-attribute
description: str | None = ...

The security group rule description.

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).

group_id class-attribute instance-attribute
group_id: str | None = ...

The ID of the security group.

group_owner_id class-attribute instance-attribute
group_owner_id: str | None = ...

The ID of the Amazon Web Services account that owns the security group.

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.

is_egress class-attribute instance-attribute
is_egress: bool | None = ...

Indicates whether the security group rule is an outbound rule.

prefix_list_id class-attribute instance-attribute
prefix_list_id: str | None = ...

The ID of the prefix list.

referenced_group_info class-attribute instance-attribute
referenced_group_info: ReferencedSecurityGroup | None = ...

Describes the security group that is referenced in the rule.

security_group_rule_arn class-attribute instance-attribute
security_group_rule_arn: str | None = ...

The ARN of the security group rule.

security_group_rule_id class-attribute instance-attribute
security_group_rule_id: str | None = ...

The ID of the security group rule.

tags class-attribute instance-attribute
tags: list[Tag] | None = ...

The tags applied to 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).