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

Class: Aws::EC2::Types::RevokeSecurityGroupIngressRequest

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 RevokeSecurityGroupIngressRequest data as a hash:

{
  cidr_ip: "String",
  from_port: 1,
  group_id: "String",
  group_name: "String",
  ip_permissions: [
    {
      from_port: 1,
      ip_protocol: "String",
      ip_ranges: [
        {
          cidr_ip: "String",
          description: "String",
        },
      ],
      ipv_6_ranges: [
        {
          cidr_ipv_6: "String",
          description: "String",
        },
      ],
      prefix_list_ids: [
        {
          description: "String",
          prefix_list_id: "String",
        },
      ],
      to_port: 1,
      user_id_group_pairs: [
        {
          description: "String",
          group_id: "String",
          group_name: "String",
          peering_status: "String",
          user_id: "String",
          vpc_id: "String",
          vpc_peering_connection_id: "String",
        },
      ],
    },
  ],
  ip_protocol: "String",
  source_security_group_name: "String",
  source_security_group_owner_id: "String",
  to_port: 1,
  dry_run: false,
}

Contains the parameters for RevokeSecurityGroupIngress.

Instance Attribute Summary collapse

Instance Attribute Details

#cidr_ipString

The CIDR IP address range. You can't specify this parameter when specifying a source security group.

Returns:

  • (String)


21311
21312
21313
21314
21315
21316
21317
21318
21319
21320
21321
21322
21323
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 21311

class RevokeSecurityGroupIngressRequest < Struct.new(
  :cidr_ip,
  :from_port,
  :group_id,
  :group_name,
  :ip_permissions,
  :ip_protocol,
  :source_security_group_name,
  :source_security_group_owner_id,
  :to_port,
  :dry_run)
  include Aws::Structure
end

#dry_runBoolean

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Returns:

  • (Boolean)


21311
21312
21313
21314
21315
21316
21317
21318
21319
21320
21321
21322
21323
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 21311

class RevokeSecurityGroupIngressRequest < Struct.new(
  :cidr_ip,
  :from_port,
  :group_id,
  :group_name,
  :ip_permissions,
  :ip_protocol,
  :source_security_group_name,
  :source_security_group_owner_id,
  :to_port,
  :dry_run)
  include Aws::Structure
end

#from_portInteger

The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, use -1 to specify all ICMP types.

Returns:

  • (Integer)


21311
21312
21313
21314
21315
21316
21317
21318
21319
21320
21321
21322
21323
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 21311

class RevokeSecurityGroupIngressRequest < Struct.new(
  :cidr_ip,
  :from_port,
  :group_id,
  :group_name,
  :ip_permissions,
  :ip_protocol,
  :source_security_group_name,
  :source_security_group_owner_id,
  :to_port,
  :dry_run)
  include Aws::Structure
end

#group_idString

The ID of the security group. You must specify either the security group ID or the security group name in the request. For security groups in a nondefault VPC, you must specify the security group ID.

Returns:

  • (String)


21311
21312
21313
21314
21315
21316
21317
21318
21319
21320
21321
21322
21323
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 21311

class RevokeSecurityGroupIngressRequest < Struct.new(
  :cidr_ip,
  :from_port,
  :group_id,
  :group_name,
  :ip_permissions,
  :ip_protocol,
  :source_security_group_name,
  :source_security_group_owner_id,
  :to_port,
  :dry_run)
  include Aws::Structure
end

#group_nameString

[EC2-Classic, default VPC] The name of the security group. You must specify either the security group ID or the security group name in the request.

Returns:

  • (String)


21311
21312
21313
21314
21315
21316
21317
21318
21319
21320
21321
21322
21323
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 21311

class RevokeSecurityGroupIngressRequest < Struct.new(
  :cidr_ip,
  :from_port,
  :group_id,
  :group_name,
  :ip_permissions,
  :ip_protocol,
  :source_security_group_name,
  :source_security_group_owner_id,
  :to_port,
  :dry_run)
  include Aws::Structure
end

#ip_permissionsArray<Types::IpPermission>

One or more sets of IP permissions. You can't specify a source security group and a CIDR IP address range in the same set of permissions.

Returns:



21311
21312
21313
21314
21315
21316
21317
21318
21319
21320
21321
21322
21323
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 21311

class RevokeSecurityGroupIngressRequest < Struct.new(
  :cidr_ip,
  :from_port,
  :group_id,
  :group_name,
  :ip_permissions,
  :ip_protocol,
  :source_security_group_name,
  :source_security_group_owner_id,
  :to_port,
  :dry_run)
  include Aws::Structure
end

#ip_protocolString

The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). Use -1 to specify all.

Returns:

  • (String)


21311
21312
21313
21314
21315
21316
21317
21318
21319
21320
21321
21322
21323
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 21311

class RevokeSecurityGroupIngressRequest < Struct.new(
  :cidr_ip,
  :from_port,
  :group_id,
  :group_name,
  :ip_permissions,
  :ip_protocol,
  :source_security_group_name,
  :source_security_group_owner_id,
  :to_port,
  :dry_run)
  include Aws::Structure
end

#source_security_group_nameString

[EC2-Classic, default VPC] The name of the source security group. You can't specify this parameter in combination with the following parameters: the CIDR IP address range, the start of the port range, the IP protocol, and the end of the port range. For EC2-VPC, the source security group must be in the same VPC. To revoke a specific rule for an IP protocol and port range, use a set of IP permissions instead.

Returns:

  • (String)


21311
21312
21313
21314
21315
21316
21317
21318
21319
21320
21321
21322
21323
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 21311

class RevokeSecurityGroupIngressRequest < Struct.new(
  :cidr_ip,
  :from_port,
  :group_id,
  :group_name,
  :ip_permissions,
  :ip_protocol,
  :source_security_group_name,
  :source_security_group_owner_id,
  :to_port,
  :dry_run)
  include Aws::Structure
end

#source_security_group_owner_idString

[EC2-Classic] The AWS account ID of the source security group, if the source security group is in a different account. You can't specify this parameter in combination with the following parameters: the CIDR IP address range, the IP protocol, the start of the port range, and the end of the port range. To revoke a specific rule for an IP protocol and port range, use a set of IP permissions instead.

Returns:

  • (String)


21311
21312
21313
21314
21315
21316
21317
21318
21319
21320
21321
21322
21323
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 21311

class RevokeSecurityGroupIngressRequest < Struct.new(
  :cidr_ip,
  :from_port,
  :group_id,
  :group_name,
  :ip_permissions,
  :ip_protocol,
  :source_security_group_name,
  :source_security_group_owner_id,
  :to_port,
  :dry_run)
  include Aws::Structure
end

#to_portInteger

The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, use -1 to specify all ICMP codes for the ICMP type.

Returns:

  • (Integer)


21311
21312
21313
21314
21315
21316
21317
21318
21319
21320
21321
21322
21323
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 21311

class RevokeSecurityGroupIngressRequest < Struct.new(
  :cidr_ip,
  :from_port,
  :group_id,
  :group_name,
  :ip_permissions,
  :ip_protocol,
  :source_security_group_name,
  :source_security_group_owner_id,
  :to_port,
  :dry_run)
  include Aws::Structure
end