Class: Aws::EC2::SecurityGroup

Inherits:

Resources::Resource

• Object
• Resources::Resource
• Aws::EC2::SecurityGroup

Defined in:

(unknown)

Instance Attribute Summary

• #description ⇒ String readonly

  A description of the security group.

• #group_id ⇒ String readonly

  The ID of the security group.

• #group_name ⇒ String readonly

  The name of the security group.

• #id ⇒ String readonly
• #ip_permissions ⇒ Array<Types::IpPermission> readonly

  The inbound rules associated with the security group.

• #ip_permissions_egress ⇒ Array<Types::IpPermission> readonly

  [VPC only] The outbound rules associated with the security group.

• #owner_id ⇒ String readonly

  The AWS account ID of the owner of the security group.

• #tags ⇒ Array<Types::Tag> readonly

  Any tags assigned to the security group.

• #vpc_id ⇒ String readonly

  [VPC only] The ID of the VPC for the security group.

Attributes inherited from Resources::Resource

#client, #identifiers

Instance Method Summary

• #authorize_egress(options = {}) ⇒ Struct

  [VPC only] Adds the specified egress rules to a security group for use with a VPC.

  An outbound rule permits instances to send traffic to the specified IPv4 or IPv6 CIDR address ranges, or to the instances associated with the specified destination security groups.

  You specify a protocol for each rule (for example, TCP).

• #authorize_ingress(options = {}) ⇒ Struct

  Adds the specified ingress rules to a security group.

  An inbound rule permits instances to receive traffic from the specified IPv4 or IPv6 CIDR address ranges, or from the instances associated with the specified destination security groups.

  You specify a protocol for each rule (for example, TCP).

• #create_tags(options = {}) ⇒ Array<Tag>
• #delete(options = {}) ⇒ Struct

  Deletes a security group.

  If you attempt to delete a security group that is associated with an instance, or is referenced by another security group, the operation fails with InvalidGroup.InUse in EC2-Classic or DependencyViolation in EC2-VPC.

  .

• #delete_tags(options = {}) ⇒ Array<Tag>
• #initialize ⇒ Object constructor
• #revoke_egress(options = {}) ⇒ Types::RevokeSecurityGroupEgressResult

  [VPC only] Removes the specified egress rules from a security group for EC2-VPC.

• #revoke_ingress(options = {}) ⇒ Types::RevokeSecurityGroupIngressResult

  Removes the specified ingress rules from a security group.

Methods inherited from Resources::Resource

add_data_attribute, add_identifier, #data, data_attributes, #data_loaded?, identifiers, #load, #wait_until

Methods included from Resources::OperationMethods

#add_batch_operation, #add_operation, #batch_operation, #batch_operation_names, #batch_operations, #operation, #operation_names, #operations

Constructor Details

#initialize(id, options = {}) ⇒ Object #initialize(options = {}) ⇒ Object

Overloads:

• #initialize(id, options = {}) ⇒ Object

  Parameters:

  • id (String)

  Options Hash (options):

  • :client (Client) —

    When `:client is not given, the options hash is used to construct a new Client object.

• #initialize(options = {}) ⇒ Object

  Options Hash (options):

  • :id (required, String)
  • :client (Client) —

    When `:client is not given, the options hash is used to construct a new Client object.

Instance Attribute Details

#description ⇒ String (readonly)

A description of the security group.

Returns:

• (String) —

  A description of the security group.

#group_id ⇒ String (readonly)

The ID of the security group.

Returns:

• (String) —

  The ID of the security group.

#group_name ⇒ String (readonly)

The name of the security group.

Returns:

• (String) —

  The name of the security group.

#id ⇒ String (readonly)

Returns:

• (String)

#ip_permissions ⇒ Array<Types::IpPermission> (readonly)

The inbound rules associated with the security group.

Returns:

• (Array<Types::IpPermission>) —

  The inbound rules associated with the security group.

#ip_permissions_egress ⇒ Array<Types::IpPermission> (readonly)

[VPC only] The outbound rules associated with the security group.

Returns:

• (Array<Types::IpPermission>) —

  [VPC only] The outbound rules associated with the security group.

#owner_id ⇒ String (readonly)

The AWS account ID of the owner of the security group.

Returns:

• (String) —

  The AWS account ID of the owner of the security group.

#tags ⇒ Array<Types::Tag> (readonly)

Any tags assigned to the security group.

Returns:

• (Array<Types::Tag>) —

  Any tags assigned to the security group.

#vpc_id ⇒ String (readonly)

[VPC only] The ID of the VPC for the security group.

Returns:

• (String) —

  [VPC only] The ID of the VPC for the security group.

Instance Method Details

#authorize_egress(options = {}) ⇒ Struct

[VPC only] Adds the specified egress rules to a security group for use with a VPC.

An outbound rule permits instances to send traffic to the specified IPv4 or IPv6 CIDR address ranges, or to the instances associated with the specified destination security groups.

You specify a protocol for each rule (for example, TCP). For the TCP and UDP protocols, you must also specify the destination port or port range. For the ICMP protocol, you must also specify the ICMP type and code. You can use -1 for the type or code to mean all types or all codes.

Rule changes are propagated to affected instances as quickly as possible. However, a small delay might occur.

For more information about VPC security group limits, see Amazon VPC Limits.

Examples:

Request syntax example with placeholder values

securitygroup.authorize_egress({
  dry_run: false,
  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",
        },
      ],
    },
  ],
  cidr_ip: "String",
  from_port: 1,
  ip_protocol: "String",
  to_port: 1,
  source_security_group_name: "String",
  source_security_group_owner_id: "String",
})

Options Hash (options):

• :dry_run (Boolean) —

  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.

• :ip_permissions (Array<Types::IpPermission>) —

  The sets of IP permissions. You can\'t specify a destination security group and a CIDR IP address range in the same set of permissions.

• :cidr_ip (String) —

  Not supported. Use a set of IP permissions to specify the CIDR.

• :from_port (Integer) —

  Not supported. Use a set of IP permissions to specify the port.

• :ip_protocol (String) —

  Not supported. Use a set of IP permissions to specify the protocol name or number.

• :to_port (Integer) —

  Not supported. Use a set of IP permissions to specify the port.

• :source_security_group_name (String) —

  Not supported. Use a set of IP permissions to specify a destination security group.

• :source_security_group_owner_id (String) —

  Not supported. Use a set of IP permissions to specify a destination security group.

Returns:

• (Struct) —

  Returns an empty response.

See Also:

• Client#authorize_security_group_egress

#authorize_ingress(options = {}) ⇒ Struct

Adds the specified ingress rules to a security group.

An inbound rule permits instances to receive traffic from the specified IPv4 or IPv6 CIDR address ranges, or from the instances associated with the specified destination security groups.

You specify a protocol for each rule (for example, TCP). For TCP and UDP, you must also specify the destination port or port range. For ICMP/ICMPv6, you must also specify the ICMP/ICMPv6 type and code. You can use -1 to mean all types or all codes.

Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.

For more information about VPC security group limits, see Amazon VPC Limits.

Examples:

Request syntax example with placeholder values

securitygroup.authorize_ingress({
  cidr_ip: "String",
  from_port: 1,
  group_name: "SecurityGroupName",
  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,
})

Options Hash (options):

• :cidr_ip (String) —

  The IPv4 address range, in CIDR format. You can\'t specify this parameter when specifying a source security group. To specify an IPv6 address range, use a set of IP permissions.

  Alternatively, use a set of IP permissions to specify multiple rules and a description for the rule.

• :from_port (Integer) —

  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 types. If you specify all ICMP types, you must specify all codes.

  Alternatively, use a set of IP permissions to specify multiple rules and a description for the rule.

• :group_name (String) —

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

• :ip_permissions (Array<Types::IpPermission>) —

  The sets of IP permissions.

• :ip_protocol (String) —

  The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). To specify icmpv6, use a set of IP permissions.

  [VPC only] Use -1 to specify all protocols. If you specify -1 or a protocol other than tcp, udp, or icmp, traffic on all ports is allowed, regardless of any ports you specify.

  Alternatively, use a set of IP permissions to specify multiple rules and a description for the rule.

• :source_security_group_name (String) —

  [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. Creates rules that grant full ICMP, UDP, and TCP access. To create a rule with a specific IP protocol and port range, use a set of IP permissions instead. For EC2-VPC, the source security group must be in the same VPC.

• :source_security_group_owner_id (String) —

  [nondefault VPC] The AWS account ID for 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. Creates rules that grant full ICMP, UDP, and TCP access. To create a rule with a specific IP protocol and port range, use a set of IP permissions instead.

• :to_port (Integer) —

  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 codes. If you specify all ICMP types, you must specify all codes.

  Alternatively, use a set of IP permissions to specify multiple rules and a description for the rule.

• :dry_run (Boolean) —

  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:

• (Struct) —

  Returns an empty response.

See Also:

• Client#authorize_security_group_ingress

#create_tags(options = {}) ⇒ Array<Tag>

Examples:

Request syntax example with placeholder values

securitygroup.create_tags({
  dry_run: false,
  tags: [ # required
    {
      key: "String",
      value: "String",
    },
  ],
})

Basic usage

tags = securitygroup.create_tags(options)
tags.map(&:value)
#=> ["tag-value", ...]

Options Hash (options):

• :dry_run (Boolean) —

  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.

• :tags (required, Array<Types::Tag>) —

  The tags. The value parameter is required, but if you don\'t want the tag to have a value, specify the parameter with no value, and we set the value to an empty string.

Returns:

• (Array<Tag>)

See Also:

• #delete_tags
• Client#create_tags

#delete(options = {}) ⇒ Struct

Deletes a security group.

If you attempt to delete a security group that is associated with an instance, or is referenced by another security group, the operation fails with InvalidGroup.InUse in EC2-Classic or DependencyViolation in EC2-VPC.

Examples:

Request syntax example with placeholder values

securitygroup.delete({
  group_name: "SecurityGroupName",
  dry_run: false,
})

Options Hash (options):

• :group_name (String) —

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

• :dry_run (Boolean) —

  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:

• (Struct) —

  Returns an empty response.

See Also:

• Client#delete_security_group

#delete_tags(options = {}) ⇒ Array<Tag>

Examples:

Request syntax example with placeholder values

securitygroup.delete_tags({
  dry_run: false,
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
})

Basic usage

tags = securitygroup.delete_tags(options)
tags.map(&:value)
#=> ["tag-value", ...]

Options Hash (options):

• :dry_run (Boolean) —

  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.

• :tags (Array<Types::Tag>) —

  The tags to delete. Specify a tag key and an optional tag value to delete specific tags. If you specify a tag key without a tag value, we delete any tag with this key regardless of its value. If you specify a tag key with an empty string as the tag value, we delete the tag only if its value is an empty string.

  If you omit this parameter, we delete all user-defined tags for the specified resources. We do not delete AWS-generated tags (tags that have the aws: prefix).

Returns:

• (Array<Tag>)

See Also:

• #create_tags
• Client#delete_tags

#revoke_egress(options = {}) ⇒ Types::RevokeSecurityGroupEgressResult

[VPC only] Removes the specified egress rules from a security group for EC2-VPC. This action does not apply to security groups for use in EC2-Classic. To remove a rule, the values that you specify (for example, ports) must match the existing rule's values exactly.

[Default VPC] If the values you specify do not match the existing rule's values, no error is returned, and the output describes the security group rules that were not revoked.

AWS recommends that you use DescribeSecurityGroups to verify that the rule has been removed.

Each rule consists of the protocol and the IPv4 or IPv6 CIDR range or source security group. For the TCP and UDP protocols, you must also specify the destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type and code. If the security group rule has a description, you do not have to specify the description to revoke the rule.

Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.

Examples:

Request syntax example with placeholder values

securitygroup.revoke_egress({
  dry_run: false,
  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",
        },
      ],
    },
  ],
  cidr_ip: "String",
  from_port: 1,
  ip_protocol: "String",
  to_port: 1,
  source_security_group_name: "String",
  source_security_group_owner_id: "String",
})

Options Hash (options):

• :dry_run (Boolean) —

  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.

• :ip_permissions (Array<Types::IpPermission>) —

  The sets of IP permissions. You can\'t specify a destination security group and a CIDR IP address range in the same set of permissions.

• :cidr_ip (String) —

  Not supported. Use a set of IP permissions to specify the CIDR.

• :from_port (Integer) —

  Not supported. Use a set of IP permissions to specify the port.

• :ip_protocol (String) —

  Not supported. Use a set of IP permissions to specify the protocol name or number.

• :to_port (Integer) —

  Not supported. Use a set of IP permissions to specify the port.

• :source_security_group_name (String) —

  Not supported. Use a set of IP permissions to specify a destination security group.

• :source_security_group_owner_id (String) —

  Not supported. Use a set of IP permissions to specify a destination security group.

Returns:

• (Types::RevokeSecurityGroupEgressResult) —

  Returns a response object which responds to the following methods:

  • #return => Boolean
  • #unknown_ip_permissions => Array<Types::IpPermission>

See Also:

• Client#revoke_security_group_egress

#revoke_ingress(options = {}) ⇒ Types::RevokeSecurityGroupIngressResult

Removes the specified ingress rules from a security group. To remove a rule, the values that you specify (for example, ports) must match the existing rule's values exactly.

[EC2-Classic , default VPC] If the values you specify do not match the existing rule's values, no error is returned, and the output describes the security group rules that were not revoked.

AWS recommends that you use DescribeSecurityGroups to verify that the rule has been removed.

Each rule consists of the protocol and the CIDR range or source security group. For the TCP and UDP protocols, you must also specify the destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type and code. If the security group rule has a description, you do not have to specify the description to revoke the rule.

Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.

Examples:

Request syntax example with placeholder values

securitygroup.revoke_ingress({
  cidr_ip: "String",
  from_port: 1,
  group_name: "SecurityGroupName",
  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,
})

Options Hash (options):

• :cidr_ip (String) —

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

• :from_port (Integer) —

  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.

• :group_name (String) —

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

• :ip_permissions (Array<Types::IpPermission>) —

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

• :ip_protocol (String) —

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

• :source_security_group_name (String) —

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

• :source_security_group_owner_id (String) —

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

• :to_port (Integer) —

  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.

• :dry_run (Boolean) —

  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:

• (Types::RevokeSecurityGroupIngressResult) —

  Returns a response object which responds to the following methods:

  • #return => Boolean
  • #unknown_ip_permissions => Array<Types::IpPermission>

See Also:

• Client#revoke_security_group_ingress