Skip to content

SecurityGroupRule

Source code in docs_src/capo_ec2/types/security_group_rule.py
class SecurityGroupRule(TypedDict, closed=True):
    security_group_rule_id: NotRequired[
        "capo_ec2.types.security_group_rule_id.SecurityGroupRuleId"
    ]
    """<p>The ID of the security group rule.</p>"""
    group_id: NotRequired["capo_ec2.types.security_group_id.SecurityGroupId"]
    """<p>The ID of the security group.</p>"""
    group_owner_id: NotRequired["capo_ec2.types.string.String"]
    """<p>The ID of the Amazon Web Services account that owns the security group. </p>"""
    is_egress: NotRequired["capo_ec2.types.boolean.Boolean"]
    """<p>Indicates whether the security group rule is an outbound rule.</p>"""
    ip_protocol: NotRequired["capo_ec2.types.string.String"]
    """<p>The IP protocol name (<code>tcp</code>, <code>udp</code>, <code>icmp</code>, <code>icmpv6</code>) or number (see <a href="http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml">Protocol Numbers</a>). </p> <p>Use <code>-1</code> to specify all protocols.</p>"""
    from_port: NotRequired["capo_ec2.types.integer.Integer"]
    """<p>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).</p>"""
    to_port: NotRequired["capo_ec2.types.integer.Integer"]
    """<p>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).</p>"""
    cidr_ipv4: NotRequired["capo_ec2.types.string.String"]
    """<p>The IPv4 CIDR range.</p>"""
    cidr_ipv6: NotRequired["capo_ec2.types.string.String"]
    """<p>The IPv6 CIDR range.</p>"""
    prefix_list_id: NotRequired[
        "capo_ec2.types.prefix_list_resource_id.PrefixListResourceId"
    ]
    """<p>The ID of the prefix list.</p>"""
    referenced_group_info: NotRequired[
        "capo_ec2.types.referenced_security_group.ReferencedSecurityGroup"
    ]
    """<p>Describes the security group that is referenced in the rule.</p>"""
    description: NotRequired["capo_ec2.types.string.String"]
    """<p>The security group rule description.</p>"""
    tags: NotRequired["capo_ec2.types.tag_list.TagList"]
    """<p>The tags applied to the security group rule.</p>"""
    security_group_rule_arn: NotRequired["capo_ec2.types.string.String"]
    """<p>The ARN of the security group rule.</p>"""

cidr_ipv4 instance-attribute

cidr_ipv4: NotRequired[String]

The IPv4 CIDR range.

cidr_ipv6 instance-attribute

cidr_ipv6: NotRequired[String]

The IPv6 CIDR range.

description instance-attribute

description: NotRequired[String]

The security group rule description.

from_port instance-attribute

from_port: NotRequired[Integer]

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 instance-attribute

group_id: NotRequired[SecurityGroupId]

The ID of the security group.

group_owner_id instance-attribute

group_owner_id: NotRequired[String]

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

ip_protocol instance-attribute

ip_protocol: NotRequired[String]

The IP protocol name (tcp, udp, icmp, icmpv6) or number (see Protocol Numbers).

Use -1 to specify all protocols.

is_egress instance-attribute

is_egress: NotRequired[Boolean]

Indicates whether the security group rule is an outbound rule.

prefix_list_id instance-attribute

prefix_list_id: NotRequired[PrefixListResourceId]

The ID of the prefix list.

referenced_group_info instance-attribute

referenced_group_info: NotRequired[ReferencedSecurityGroup]

Describes the security group that is referenced in the rule.

security_group_rule_arn instance-attribute

security_group_rule_arn: NotRequired[String]

The ARN of the security group rule.

security_group_rule_id instance-attribute

security_group_rule_id: NotRequired[SecurityGroupRuleId]

The ID of the security group rule.

tags instance-attribute

tags: NotRequired[TagList]

The tags applied to the security group rule.

to_port instance-attribute

to_port: NotRequired[Integer]

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