Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.EC2.Types.IpPermission

Description

Synopsis

data IpPermission = IpPermission' {
- fromPort :: Maybe Int
- ipRanges :: Maybe [IpRange]
- ipv6Ranges :: Maybe [Ipv6Range]
- prefixListIds :: Maybe [PrefixListId]
- toPort :: Maybe Int
- userIdGroupPairs :: Maybe [UserIdGroupPair]
- ipProtocol :: Text
}
newIpPermission :: Text -> IpPermission
ipPermission_fromPort :: Lens' IpPermission (Maybe Int)
ipPermission_ipRanges :: Lens' IpPermission (Maybe [IpRange])
ipPermission_ipv6Ranges :: Lens' IpPermission (Maybe [Ipv6Range])
ipPermission_prefixListIds :: Lens' IpPermission (Maybe [PrefixListId])
ipPermission_toPort :: Lens' IpPermission (Maybe Int)
ipPermission_userIdGroupPairs :: Lens' IpPermission (Maybe [UserIdGroupPair])
ipPermission_ipProtocol :: Lens' IpPermission Text

Documentation

data IpPermission Source #

Describes a set of permissions for a security group rule.

See: newIpPermission smart constructor.

Constructors

IpPermission'

Fields

fromPort :: Maybe Int
The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number. A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes.
ipRanges :: Maybe [IpRange]
The IPv4 ranges.
ipv6Ranges :: Maybe [Ipv6Range]
VPC only
The IPv6 ranges.
prefixListIds :: Maybe [PrefixListId]
VPC only
The prefix list IDs.
toPort :: Maybe Int
The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. A value of -1 indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 types, you must specify all codes.
userIdGroupPairs :: Maybe [UserIdGroupPair]
The security group and Amazon Web Services account ID pairs.
ipProtocol :: Text
The IP protocol name (tcp, udp, icmp, icmpv6) or number (see Protocol Numbers).
VPC only
Use -1 to specify all protocols. When authorizing security group rules, specifying -1 or a protocol number other than tcp, udp, icmp, or icmpv6 allows traffic on all ports, regardless of any port range you specify. For tcp, udp, and icmp, you must specify a port range. For icmpv6, the port range is optional; if you omit the port range, traffic for all types and codes is allowed.

Instances

Instances details

ToQuery IpPermission Source #
Instance details Defined in Amazonka.EC2.Types.IpPermission Methods toQuery :: IpPermission -> QueryString #
FromXML IpPermission Source #
Instance details Defined in Amazonka.EC2.Types.IpPermission Methods parseXML :: [Node] -> Either String IpPermission #
Generic IpPermission Source #
Instance details Defined in Amazonka.EC2.Types.IpPermission Associated Types type Rep IpPermission :: Type -> Type # Methods from :: IpPermission -> Rep IpPermission x # to :: Rep IpPermission x -> IpPermission #
Read IpPermission Source #
Instance details Defined in Amazonka.EC2.Types.IpPermission Methods readsPrec :: Int -> ReadS IpPermission # readList :: ReadS [IpPermission] # readPrec :: ReadPrec IpPermission # readListPrec :: ReadPrec [IpPermission] #
Show IpPermission Source #
Instance details Defined in Amazonka.EC2.Types.IpPermission Methods showsPrec :: Int -> IpPermission -> ShowS # show :: IpPermission -> String # showList :: [IpPermission] -> ShowS #
NFData IpPermission Source #
Instance details Defined in Amazonka.EC2.Types.IpPermission Methods rnf :: IpPermission -> () #
Eq IpPermission Source #
Instance details Defined in Amazonka.EC2.Types.IpPermission Methods (==) :: IpPermission -> IpPermission -> Bool # (/=) :: IpPermission -> IpPermission -> Bool #
Hashable IpPermission Source #
Instance details Defined in Amazonka.EC2.Types.IpPermission Methods hashWithSalt :: Int -> IpPermission -> Int # hash :: IpPermission -> Int #
type Rep IpPermission Source #
Instance details Defined in Amazonka.EC2.Types.IpPermission type Rep IpPermission = D1 ('MetaData "IpPermission" "Amazonka.EC2.Types.IpPermission" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "IpPermission'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "fromPort") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: (S1 ('MetaSel ('Just "ipRanges") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [IpRange])) :: S1 ('MetaSel ('Just "ipv6Ranges") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Ipv6Range])))) :: ((S1 ('MetaSel ('Just "prefixListIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PrefixListId])) :: S1 ('MetaSel ('Just "toPort") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :: (S1 ('MetaSel ('Just "userIdGroupPairs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [UserIdGroupPair])) :: S1 ('MetaSel ('Just "ipProtocol") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newIpPermission Source #

Arguments

:: Text	`$sel:ipProtocol:IpPermission'`
-> IpPermission

Create a value of IpPermission with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:fromPort:IpPermission', ipPermission_fromPort - The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number. A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes.

$sel:ipRanges:IpPermission', ipPermission_ipRanges - The IPv4 ranges.

$sel:ipv6Ranges:IpPermission', ipPermission_ipv6Ranges - [VPC only] The IPv6 ranges.

$sel:prefixListIds:IpPermission', ipPermission_prefixListIds - [VPC only] The prefix list IDs.

$sel:toPort:IpPermission', ipPermission_toPort - The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. A value of -1 indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 types, you must specify all codes.

$sel:userIdGroupPairs:IpPermission', ipPermission_userIdGroupPairs - The security group and Amazon Web Services account ID pairs.

$sel:ipProtocol:IpPermission', ipPermission_ipProtocol - The IP protocol name (tcp, udp, icmp, icmpv6) or number (see Protocol Numbers).

VPC only: Use -1 to specify all protocols. When authorizing security group rules, specifying -1 or a protocol number other than tcp, udp, icmp, or icmpv6 allows traffic on all ports, regardless of any port range you specify. For tcp, udp, and icmp, you must specify a port range. For icmpv6, the port range is optional; if you omit the port range, traffic for all types and codes is allowed.

ipPermission_fromPort :: Lens' IpPermission (Maybe Int) Source #

The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number. A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes.

ipPermission_ipRanges :: Lens' IpPermission (Maybe [IpRange]) Source #

The IPv4 ranges.

ipPermission_ipv6Ranges :: Lens' IpPermission (Maybe [Ipv6Range]) Source #

VPC only: The IPv6 ranges.

ipPermission_prefixListIds :: Lens' IpPermission (Maybe [PrefixListId]) Source #

VPC only: The prefix list IDs.

ipPermission_toPort :: Lens' IpPermission (Maybe Int) Source #

The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. A value of -1 indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 types, you must specify all codes.

ipPermission_userIdGroupPairs :: Lens' IpPermission (Maybe [UserIdGroupPair]) Source #

The security group and Amazon Web Services account ID pairs.

ipPermission_ipProtocol :: Lens' IpPermission Text Source #

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

VPC only: Use -1 to specify all protocols. When authorizing security group rules, specifying -1 or a protocol number other than tcp, udp, icmp, or icmpv6 allows traffic on all ports, regardless of any port range you specify. For tcp, udp, and icmp, you must specify a port range. For icmpv6, the port range is optional; if you omit the port range, traffic for all types and codes is allowed.