You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::EC2::Types::UserIdGroupPair

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb

Overview

Note:

When making an API call, you may pass UserIdGroupPair data as a hash:

{
  description: "String",
  group_id: "String",
  group_name: "String",
  peering_status: "String",
  user_id: "String",
  vpc_id: "String",
  vpc_peering_connection_id: "String",
}

Describes a security group and AWS account ID pair.

Instance Attribute Summary collapse

Instance Attribute Details

#descriptionString

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 ._-:/()#,@[]+=;{\}!$*

Returns:

  • (String)


25052
25053
25054
25055
25056
25057
25058
25059
25060
25061
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 25052

class UserIdGroupPair < Struct.new(
  :description,
  :group_id,
  :group_name,
  :peering_status,
  :user_id,
  :vpc_id,
  :vpc_peering_connection_id)
  include Aws::Structure
end

#group_idString

The ID of the security group.

Returns:

  • (String)


25052
25053
25054
25055
25056
25057
25058
25059
25060
25061
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 25052

class UserIdGroupPair < Struct.new(
  :description,
  :group_id,
  :group_name,
  :peering_status,
  :user_id,
  :vpc_id,
  :vpc_peering_connection_id)
  include Aws::Structure
end

#group_nameString

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.

Returns:

  • (String)


25052
25053
25054
25055
25056
25057
25058
25059
25060
25061
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 25052

class UserIdGroupPair < Struct.new(
  :description,
  :group_id,
  :group_name,
  :peering_status,
  :user_id,
  :vpc_id,
  :vpc_peering_connection_id)
  include Aws::Structure
end

#peering_statusString

The status of a VPC peering connection, if applicable.

Returns:

  • (String)


25052
25053
25054
25055
25056
25057
25058
25059
25060
25061
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 25052

class UserIdGroupPair < Struct.new(
  :description,
  :group_id,
  :group_name,
  :peering_status,
  :user_id,
  :vpc_id,
  :vpc_peering_connection_id)
  include Aws::Structure
end

#user_idString

The ID of an AWS account. For a referenced security group in another VPC, the account ID of the referenced security group is returned.

[EC2-Classic] Required when adding or removing rules that reference a security group in another AWS account.

Returns:

  • (String)


25052
25053
25054
25055
25056
25057
25058
25059
25060
25061
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 25052

class UserIdGroupPair < Struct.new(
  :description,
  :group_id,
  :group_name,
  :peering_status,
  :user_id,
  :vpc_id,
  :vpc_peering_connection_id)
  include Aws::Structure
end

#vpc_idString

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

Returns:

  • (String)


25052
25053
25054
25055
25056
25057
25058
25059
25060
25061
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 25052

class UserIdGroupPair < Struct.new(
  :description,
  :group_id,
  :group_name,
  :peering_status,
  :user_id,
  :vpc_id,
  :vpc_peering_connection_id)
  include Aws::Structure
end

#vpc_peering_connection_idString

The ID of the VPC peering connection, if applicable.

Returns:

  • (String)


25052
25053
25054
25055
25056
25057
25058
25059
25060
25061
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 25052

class UserIdGroupPair < Struct.new(
  :description,
  :group_id,
  :group_name,
  :peering_status,
  :user_id,
  :vpc_id,
  :vpc_peering_connection_id)
  include Aws::Structure
end