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

Description

Documentation

data UserIdGroupPair Source #

Describes a security group and Amazon Web Services account ID pair.

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

See: newUserIdGroupPair smart constructor.

Constructors

UserIdGroupPair'

Fields

description :: Maybe Text
A description for the security group rule that references this user ID group pair.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*
groupId :: Maybe Text
The ID of the security group.
groupName :: Maybe Text
The name of the security group. In a request, use this parameter for a security group in EC2-Classic or a default VPC only. For a security group in a nondefault VPC, use the security group ID.
For a referenced security group in another VPC, this value is not returned if the referenced security group is deleted.
peeringStatus :: Maybe Text
The status of a VPC peering connection, if applicable.
userId :: Maybe Text
The ID of an Amazon Web Services account.
For a referenced security group in another VPC, the account ID of the referenced security group is returned in the response. If the referenced security group is deleted, this value is not returned.
EC2-Classic
Required when adding or removing rules that reference a security group in another Amazon Web Services account.
vpcId :: Maybe Text
The ID of the VPC for the referenced security group, if applicable.
vpcPeeringConnectionId :: Maybe Text
The ID of the VPC peering connection, if applicable.

Instances

Instances details

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

newUserIdGroupPair :: UserIdGroupPair Source #

Create a value of UserIdGroupPair 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:description:UserIdGroupPair', userIdGroupPair_description - A description for the security group rule that references this user ID group pair.

Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*

$sel:groupId:UserIdGroupPair', userIdGroupPair_groupId - The ID of the security group.

$sel:groupName:UserIdGroupPair', userIdGroupPair_groupName - The name of the security group. In a request, use this parameter for a security group in EC2-Classic or a default VPC only. For a security group in a nondefault VPC, use the security group ID.

For a referenced security group in another VPC, this value is not returned if the referenced security group is deleted.

$sel:peeringStatus:UserIdGroupPair', userIdGroupPair_peeringStatus - The status of a VPC peering connection, if applicable.

$sel:userId:UserIdGroupPair', userIdGroupPair_userId - The ID of an Amazon Web Services account.

For a referenced security group in another VPC, the account ID of the referenced security group is returned in the response. If the referenced security group is deleted, this value is not returned.

EC2-Classic: Required when adding or removing rules that reference a security group in another Amazon Web Services account.

$sel:vpcId:UserIdGroupPair', userIdGroupPair_vpcId - The ID of the VPC for the referenced security group, if applicable.

$sel:vpcPeeringConnectionId:UserIdGroupPair', userIdGroupPair_vpcPeeringConnectionId - The ID of the VPC peering connection, if applicable.

userIdGroupPair_description :: Lens' UserIdGroupPair (Maybe Text) Source #

A description for the security group rule that references this user ID group pair.

Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*

userIdGroupPair_groupId :: Lens' UserIdGroupPair (Maybe Text) Source #

The ID of the security group.

userIdGroupPair_groupName :: Lens' UserIdGroupPair (Maybe Text) Source #

The name of the security group. In a request, use this parameter for a security group in EC2-Classic or a default VPC only. For a security group in a nondefault VPC, use the security group ID.

For a referenced security group in another VPC, this value is not returned if the referenced security group is deleted.

userIdGroupPair_peeringStatus :: Lens' UserIdGroupPair (Maybe Text) Source #

The status of a VPC peering connection, if applicable.

userIdGroupPair_userId :: Lens' UserIdGroupPair (Maybe Text) Source #

The ID of an Amazon Web Services account.

For a referenced security group in another VPC, the account ID of the referenced security group is returned in the response. If the referenced security group is deleted, this value is not returned.

EC2-Classic: Required when adding or removing rules that reference a security group in another Amazon Web Services account.

userIdGroupPair_vpcId :: Lens' UserIdGroupPair (Maybe Text) Source #

The ID of the VPC for the referenced security group, if applicable.

userIdGroupPair_vpcPeeringConnectionId :: Lens' UserIdGroupPair (Maybe Text) Source #

The ID of the VPC peering connection, if applicable.