ec2/aws.sdk.kotlin.services.ec2.model/SecurityGroupRuleRequest

SecurityGroupRuleRequest

Describes a security group rule.

You must specify exactly one of the following parameters, based on the rule type:

CidrIpv4
CidrIpv6
PrefixListId
ReferencedGroupId

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.

Types

Builder

class Builder

Companion

object Companion

Properties

cidrIpv4

val cidrIpv4: String?

The IPv4 CIDR range. To specify a single IPv4 address, use the /32 prefix length.

cidrIpv6

val cidrIpv6: String?

The IPv6 CIDR range. To specify a single IPv6 address, use the /128 prefix length.

description

val description: String?

The description of the security group rule.

fromPort

val fromPort: Int?

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

ipProtocol

val ipProtocol: String?

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

prefixListId

val prefixListId: String?

The ID of the prefix list.

referencedGroupId

val referencedGroupId: String?

The ID of the security group that is referenced in the security group rule.

toPort

val toPort: Int?

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

Functions

copy

inline fun copy(block: SecurityGroupRuleRequest.Builder.() -> Unit = {}): SecurityGroupRuleRequest

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String