Class: Aws::EC2::SecurityGroup

Inherits:

Object

Object
Aws::EC2::SecurityGroup

show all

Extended by:: Deprecations

Defined in:: sig/security_group.rbs,
lib/aws-sdk-ec2/security_group.rb

Overview

https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/EC2/SecurityGroup.html

Defined Under Namespace

Classes: Collection

Read-Only Attributes collapse

#description ⇒ String
A description of the security group.
#group_name ⇒ String
The name of the security group.
#id ⇒ String (also: #group_id)
#ip_permissions ⇒ Array<Types::IpPermission>
The inbound rules associated with the security group.
#ip_permissions_egress ⇒ Array<Types::IpPermission>
The outbound rules associated with the security group.
#owner_id ⇒ String
The Amazon Web Services account ID of the owner of the security group.
#security_group_arn ⇒ String
The ARN of the security group.
#tags ⇒ Array<Types::Tag>
Any tags assigned to the security group.
#vpc_id ⇒ String
The ID of the VPC for the security group.

Actions collapse

#authorize_egress(options = {}) ⇒ Types::AuthorizeSecurityGroupEgressResult
#authorize_ingress(options = {}) ⇒ Types::AuthorizeSecurityGroupIngressResult
#create_tags(options = {}) ⇒ Tag::Collection
#delete(options = {}) ⇒ Types::DeleteSecurityGroupResult
#delete_tags(options = {}) ⇒ Tag::Collection
#identifiers ⇒ Object deprecated private Deprecated.
#revoke_egress(options = {}) ⇒ Types::RevokeSecurityGroupEgressResult
#revoke_ingress(options = {}) ⇒ Types::RevokeSecurityGroupIngressResult

Instance Method Summary collapse

#client ⇒ Client
#data ⇒ Types::SecurityGroup
Returns the data for this SecurityGroup.
#data_loaded? ⇒ Boolean
Returns true if this resource is loaded.
#initialize(*args) ⇒ SecurityGroup constructor
A new instance of SecurityGroup.
#load ⇒ self (also: #reload)
Loads, or reloads #data for the current SecurityGroup.
#wait_until(options = {}) {|resource| ... } ⇒ Resource deprecated Deprecated.
Use [Aws::EC2::Client] #wait_until instead

Constructor Details

#initialize(id, options = {}) ⇒ `SecurityGroup` #initialize(options = {}) ⇒ `SecurityGroup`

Returns a new instance of SecurityGroup.

Overloads:

#initialize(id, options = {}) ⇒ SecurityGroup
Parameters:
- id (String)
Options Hash (options):
- :client (Client)
#initialize(options = {}) ⇒ SecurityGroup
Options Hash (options):
- :id (required, String)
- :client (Client)



13
14
15

# File 'sig/security_group.rbs', line 13

def initialize: (String id, Hash[Symbol, untyped] options) -> void
| (id: String, ?client: Client) -> void
| (Hash[Symbol, untyped] args) -> void

Instance Method Details

#authorize_egress(options = {}) ⇒ `Types::AuthorizeSecurityGroupEgressResult`

Examples:

Request syntax with placeholder values


security_group.authorize_egress({
  tag_specifications: [
    {
      resource_type: "capacity-reservation", # accepts capacity-reservation, client-vpn-endpoint, customer-gateway, carrier-gateway, coip-pool, declarative-policies-report, dedicated-host, dhcp-options, egress-only-internet-gateway, elastic-ip, elastic-gpu, export-image-task, export-instance-task, fleet, fpga-image, host-reservation, image, image-usage-report, import-image-task, import-snapshot-task, instance, instance-event-window, internet-gateway, ipam, ipam-pool, ipam-scope, ipv4pool-ec2, ipv6pool-ec2, key-pair, launch-template, local-gateway, local-gateway-route-table, local-gateway-virtual-interface, local-gateway-virtual-interface-group, local-gateway-route-table-vpc-association, local-gateway-route-table-virtual-interface-group-association, natgateway, network-acl, network-interface, network-insights-analysis, network-insights-path, network-insights-access-scope, network-insights-access-scope-analysis, outpost-lag, placement-group, prefix-list, replace-root-volume-task, reserved-instances, route-table, security-group, security-group-rule, service-link-virtual-interface, snapshot, spot-fleet-request, spot-instances-request, subnet, subnet-cidr-reservation, traffic-mirror-filter, traffic-mirror-session, traffic-mirror-target, transit-gateway, transit-gateway-attachment, transit-gateway-connect-peer, transit-gateway-multicast-domain, transit-gateway-policy-table, transit-gateway-metering-policy, transit-gateway-route-table, transit-gateway-route-table-announcement, volume, vpc, vpc-endpoint, vpc-endpoint-connection, vpc-endpoint-service, vpc-endpoint-service-permission, vpc-peering-connection, vpn-connection, vpn-gateway, vpc-flow-log, capacity-reservation-fleet, traffic-mirror-filter-rule, vpc-endpoint-connection-device-type, verified-access-instance, verified-access-group, verified-access-endpoint, verified-access-policy, verified-access-trust-provider, vpn-connection-device-type, vpc-block-public-access-exclusion, vpc-encryption-control, route-server, route-server-endpoint, route-server-peer, ipam-resource-discovery, ipam-resource-discovery-association, instance-connect-endpoint, verified-access-endpoint-target, ipam-external-resource-verification-token, capacity-block, mac-modification-task, ipam-prefix-list-resolver, ipam-policy, ipam-prefix-list-resolver-target, secondary-interface, secondary-network, secondary-subnet, capacity-manager-data-export, vpn-concentrator, ipam-pool-allocation, capacity-reservation-cancellation-quote
      tags: [
        {
          key: "String",
          value: "String",
        },
      ],
    },
  ],
  dry_run: false,
  source_security_group_name: "String",
  source_security_group_owner_id: "String",
  ip_protocol: "String",
  from_port: 1,
  to_port: 1,
  cidr_ip: "String",
  ip_permissions: [
    {
      ip_protocol: "String",
      from_port: 1,
      to_port: 1,
      user_id_group_pairs: [
        {
          description: "String",
          user_id: "String",
          group_name: "String",
          group_id: "String",
          vpc_id: "String",
          vpc_peering_connection_id: "String",
          peering_status: "String",
        },
      ],
      ip_ranges: [
        {
          description: "String",
          cidr_ip: "String",
        },
      ],
      ipv_6_ranges: [
        {
          description: "String",
          cidr_ipv_6: "String",
        },
      ],
      prefix_list_ids: [
        {
          description: "String",
          prefix_list_id: "String",
        },
      ],
    },
  ],
})

Parameters:

options (Hash) (defaults to: {}) —
({})

Options Hash (options):

:tag_specifications (Array<Types::TagSpecification>) —
The tags applied to the security group 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.
:source_security_group_name (String) —
Not supported. Use IP permissions instead.
:source_security_group_owner_id (String) —
Not supported. Use IP permissions instead.
:ip_protocol (String) —
Not supported. Use IP permissions instead.
:from_port (Integer) —
Not supported. Use IP permissions instead.
:to_port (Integer) —
Not supported. Use IP permissions instead.
:cidr_ip (String) —
Not supported. Use IP permissions instead.
:ip_permissions (Array<Types::IpPermission>) —
The permissions for the security group rules.

Returns:

(Types::AuthorizeSecurityGroupEgressResult)

59	# File 'sig/security_group.rbs', line 59 def authorize_egress: (

#authorize_ingress(options = {}) ⇒ `Types::AuthorizeSecurityGroupIngressResult`

Examples:

Request syntax with placeholder values


security_group.authorize_ingress({
  cidr_ip: "String",
  from_port: 1,
  group_name: "SecurityGroupName",
  ip_permissions: [
    {
      ip_protocol: "String",
      from_port: 1,
      to_port: 1,
      user_id_group_pairs: [
        {
          description: "String",
          user_id: "String",
          group_name: "String",
          group_id: "String",
          vpc_id: "String",
          vpc_peering_connection_id: "String",
          peering_status: "String",
        },
      ],
      ip_ranges: [
        {
          description: "String",
          cidr_ip: "String",
        },
      ],
      ipv_6_ranges: [
        {
          description: "String",
          cidr_ipv_6: "String",
        },
      ],
      prefix_list_ids: [
        {
          description: "String",
          prefix_list_id: "String",
        },
      ],
    },
  ],
  ip_protocol: "String",
  source_security_group_name: "String",
  source_security_group_owner_id: "String",
  to_port: 1,
  tag_specifications: [
    {
      resource_type: "capacity-reservation", # accepts capacity-reservation, client-vpn-endpoint, customer-gateway, carrier-gateway, coip-pool, declarative-policies-report, dedicated-host, dhcp-options, egress-only-internet-gateway, elastic-ip, elastic-gpu, export-image-task, export-instance-task, fleet, fpga-image, host-reservation, image, image-usage-report, import-image-task, import-snapshot-task, instance, instance-event-window, internet-gateway, ipam, ipam-pool, ipam-scope, ipv4pool-ec2, ipv6pool-ec2, key-pair, launch-template, local-gateway, local-gateway-route-table, local-gateway-virtual-interface, local-gateway-virtual-interface-group, local-gateway-route-table-vpc-association, local-gateway-route-table-virtual-interface-group-association, natgateway, network-acl, network-interface, network-insights-analysis, network-insights-path, network-insights-access-scope, network-insights-access-scope-analysis, outpost-lag, placement-group, prefix-list, replace-root-volume-task, reserved-instances, route-table, security-group, security-group-rule, service-link-virtual-interface, snapshot, spot-fleet-request, spot-instances-request, subnet, subnet-cidr-reservation, traffic-mirror-filter, traffic-mirror-session, traffic-mirror-target, transit-gateway, transit-gateway-attachment, transit-gateway-connect-peer, transit-gateway-multicast-domain, transit-gateway-policy-table, transit-gateway-metering-policy, transit-gateway-route-table, transit-gateway-route-table-announcement, volume, vpc, vpc-endpoint, vpc-endpoint-connection, vpc-endpoint-service, vpc-endpoint-service-permission, vpc-peering-connection, vpn-connection, vpn-gateway, vpc-flow-log, capacity-reservation-fleet, traffic-mirror-filter-rule, vpc-endpoint-connection-device-type, verified-access-instance, verified-access-group, verified-access-endpoint, verified-access-policy, verified-access-trust-provider, vpn-connection-device-type, vpc-block-public-access-exclusion, vpc-encryption-control, route-server, route-server-endpoint, route-server-peer, ipam-resource-discovery, ipam-resource-discovery-association, instance-connect-endpoint, verified-access-endpoint-target, ipam-external-resource-verification-token, capacity-block, mac-modification-task, ipam-prefix-list-resolver, ipam-policy, ipam-prefix-list-resolver-target, secondary-interface, secondary-network, secondary-subnet, capacity-manager-data-export, vpn-concentrator, ipam-pool-allocation, capacity-reservation-cancellation-quote
      tags: [
        {
          key: "String",
          value: "String",
        },
      ],
    },
  ],
  dry_run: false,
})

Parameters:

options (Hash) (defaults to: {}) —
({})

Options Hash (options):

:cidr_ip (String) —
The IPv4 address range, in CIDR format.

Amazon Web Services canonicalizes IPv4 and IPv6 CIDRs. For example, if you specify 100.68.0.18/18 for the CIDR block, Amazon Web Services canonicalizes the CIDR block to 100.68.0.0/18. Any subsequent DescribeSecurityGroups and DescribeSecurityGroupRules calls will return the canonicalized form of the CIDR block. Additionally, if you attempt to add another rule with the non-canonical form of the CIDR (such as 100.68.0.18/18) and there is already a rule for the canonicalized form of the CIDR block (such as 100.68.0.0/18), the API throws an duplicate rule error.

To specify an IPv6 address range, use IP permissions instead.

To specify multiple rules and descriptions for the rules, use IP permissions instead.
:from_port (Integer) —
If the protocol is TCP or UDP, this is the start of the port range. If the protocol is ICMP, this is the ICMP type or -1 (all ICMP types).

To specify multiple rules and descriptions for the rules, use IP permissions instead.
:group_name (String) —
[Default VPC] The name of the security group. For security groups for a default VPC you can specify either the ID or the name of the security group. For security groups for a nondefault VPC, you must specify the ID of the security group.
:ip_permissions (Array<Types::IpPermission>) —
The permissions for the security group rules.
:ip_protocol (String) —
The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). To specify all protocols, use -1.

To specify icmpv6, use IP permissions instead.

If you specify a protocol other than one of the supported values, traffic is allowed on all ports, regardless of any ports that you specify.

To specify multiple rules and descriptions for the rules, use IP permissions instead.
:source_security_group_name (String) —
[Default VPC] The name of the source security group.

The rule grants full ICMP, UDP, and TCP access. To create a rule with a specific protocol and port range, specify a set of IP permissions instead.
:source_security_group_owner_id (String) —
The Amazon Web Services account ID for the source security group, if the source security group is in a different account.

The rule grants full ICMP, UDP, and TCP access. To create a rule with a specific protocol and port range, use IP permissions instead.
:to_port (Integer) —
If the protocol is TCP or UDP, this is the end of the port range. If the protocol is ICMP, this is the ICMP code or -1 (all ICMP codes). If the start port is -1 (all ICMP types), then the end port must be -1 (all ICMP codes).

To specify multiple rules and descriptions for the rules, use IP permissions instead.
:tag_specifications (Array<Types::TagSpecification>) —
The tags applied to the security group 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:

(Types::AuthorizeSecurityGroupIngressResult)

118	# File 'sig/security_group.rbs', line 118 def authorize_ingress: (

#client ⇒ `Client`

Returns:

(Client)

89	# File 'lib/aws-sdk-ec2/security_group.rb', line 89 def client: () -> Client

#create_tags(options = {}) ⇒ `Tag::Collection`

Examples:

Request syntax with placeholder values


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

Parameters:

options (Hash) (defaults to: {}) —
({})

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:

(Tag::Collection)

178	# File 'sig/security_group.rbs', line 178 def create_tags: (

#data ⇒ `Types::SecurityGroup`

Returns the data for this Aws::EC2::SecurityGroup. Calls Client#describe_security_groups if #data_loaded? is false.

Returns:

(Types::SecurityGroup) —
Returns the data for this Aws::EC2::SecurityGroup. Calls Client#describe_security_groups if #data_loaded? is false.

52	# File 'sig/security_group.rbs', line 52 def data: () -> Types::SecurityGroup

#data_loaded? ⇒ `Boolean`

Returns true if this resource is loaded. Accessing attributes or #data on an unloaded resource will trigger a call to #load.

Returns:

(Boolean) —
Returns true if this resource is loaded. Accessing attributes or #data on an unloaded resource will trigger a call to #load.

55	# File 'sig/security_group.rbs', line 55 def data_loaded?: () -> bool

#delete(options = {}) ⇒ `Types::DeleteSecurityGroupResult`

Examples:

Request syntax with placeholder values


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

Parameters:

options (Hash) (defaults to: {}) —
({})

Options Hash (options):

:group_name (String) —
[Default VPC] The name of the security group. You can specify either the security group name or the security group ID. For security groups in a nondefault VPC, you must specify 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:

(Types::DeleteSecurityGroupResult)

202	# File 'sig/security_group.rbs', line 202 def delete: (

#delete_tags(options = {}) ⇒ `Tag::Collection`

Examples:

Request syntax with placeholder values


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

Parameters:

options (Hash) (defaults to: {}) —
({})

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 Amazon Web Services-generated tags (tags that have the aws: prefix).

Constraints: Up to 1000 tags.

Returns:

(Tag::Collection)

190	# File 'sig/security_group.rbs', line 190 def delete_tags: (

#description ⇒ `String`

A description of the security group.

Returns:

(String)

40	# File 'sig/security_group.rbs', line 40 def description: () -> ::String

#group_name ⇒ `String`

The name of the security group.

Returns:

(String)

37	# File 'sig/security_group.rbs', line 37 def group_name: () -> ::String

#id ⇒ `String` Also known as: group_id

Returns:

(String)

18	# File 'sig/security_group.rbs', line 18 def id: () -> String

#identifiers ⇒ `Object`

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Deprecated.



756
757
758

# File 'lib/aws-sdk-ec2/security_group.rb', line 756

def identifiers
  { id: @id }
end

#ip_permissions ⇒ `Array<Types::IpPermission>`

The inbound rules associated with the security group.

Returns:

(Array<Types::IpPermission>)

43	# File 'sig/security_group.rbs', line 43 def ip_permissions: () -> ::Array[Types::IpPermission]

#ip_permissions_egress ⇒ `Array<Types::IpPermission>`

The outbound rules associated with the security group.

Returns:

(Array<Types::IpPermission>)

22	# File 'sig/security_group.rbs', line 22 def ip_permissions_egress: () -> ::Array[Types::IpPermission]

#load ⇒ `self` Also known as: reload

Loads, or reloads #data for the current Aws::EC2::SecurityGroup. Returns self making it possible to chain methods.

security_group.reload.data

Returns:

(self)

48	# File 'sig/security_group.rbs', line 48 def load: () -> self

#owner_id ⇒ `String`

The Amazon Web Services account ID of the owner of the security group.

Returns:

(String)

34	# File 'sig/security_group.rbs', line 34 def owner_id: () -> ::String

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

Examples:

Request syntax with placeholder values


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

Parameters:

options (Hash) (defaults to: {}) —
({})

Options Hash (options):

:security_group_rule_ids (Array<String>) —
The IDs of the security group rules.
: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.
: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.
:ip_protocol (String) —
Not supported. Use a set of IP permissions to specify the protocol name or number.
:from_port (Integer) —
Not supported. Use a set of IP permissions to specify the port.
:to_port (Integer) —
Not supported. Use a set of IP permissions to specify the port.
:cidr_ip (String) —
Not supported. Use a set of IP permissions to specify the CIDR.
: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.

Returns:

(Types::RevokeSecurityGroupEgressResult)

209	# File 'sig/security_group.rbs', line 209 def revoke_egress: (

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

Examples:

Request syntax with placeholder values


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

Parameters:

options (Hash) (defaults to: {}) —
({})

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) —
If the protocol is TCP or UDP, this is the start of the port range. If the protocol is ICMP, this is the ICMP type or -1 (all ICMP types).
:group_name (String) —
[Default VPC] The name 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.
: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) —
[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. 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) —
Not supported.
:to_port (Integer) —
If the protocol is TCP or UDP, this is the end of the port range. If the protocol is ICMP, this is the ICMP code or -1 (all ICMP codes).
:security_group_rule_ids (Array<String>) —
The IDs of the security group rules.
: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)

258	# File 'sig/security_group.rbs', line 258 def revoke_ingress: (

#security_group_arn ⇒ `String`

The ARN of the security group.

Returns:

(String)

31	# File 'sig/security_group.rbs', line 31 def security_group_arn: () -> ::String

#tags ⇒ `Array<Types::Tag>`

Any tags assigned to the security group.

Returns:

(Array<Types::Tag>)

25	# File 'sig/security_group.rbs', line 25 def tags: () -> ::Array[Types::Tag]

#vpc_id ⇒ `String`

The ID of the VPC for the security group.

Returns:

(String)

28	# File 'sig/security_group.rbs', line 28 def vpc_id: () -> ::String

#wait_until(options = {}) {|resource| ... } ⇒ `Resource`

Deprecated.

Use [Aws::EC2::Client] #wait_until instead

Note:

The waiting operation is performed on a copy. The original resource remains unchanged.

Waiter polls an API operation until a resource enters a desired state.

Basic Usage

Waiter will polls until it is successful, it fails by entering a terminal state, or until a maximum number of attempts are made.

# polls in a loop until condition is true
resource.wait_until(options) {|resource| condition}

Example

instance.wait_until(max_attempts:10, delay:5) do |instance|
  instance.state.name == 'running'
end

Configuration

You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. The waiting condition is set by passing a block to #wait_until:

# poll for ~25 seconds
resource.wait_until(max_attempts:5,delay:5) {|resource|...}

Callbacks

You can be notified before each polling attempt and before each delay. If you throw :success or :failure from these callbacks, it will terminate the waiter.

started_at = Time.now
# poll for 1 hour, instead of a number of attempts
proc = Proc.new do |attempts, response|
  throw :failure if Time.now - started_at > 3600
end

  # disable max attempts
instance.wait_until(before_wait:proc, max_attempts:nil) {...}

Handling Errors

When a waiter is successful, it returns the Resource. When a waiter fails, it raises an error.

begin
  resource.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
  # resource did not enter the desired state in time
end

attempts attempt in seconds invoked before each attempt invoked before each wait

Parameters:

options (Hash) (defaults to: {}) —
a customizable set of options

Options Hash (options):

:max_attempts (Integer) — default: 10 —
Maximum number of
:delay (Integer) — default: 10 —
Delay between each
:before_attempt (Proc) — default: nil —
Callback
:before_wait (Proc) — default: nil —
Callback

Yield Parameters:

resource (Resource) —
to be used in the waiting condition.

Returns:

(Resource) —
if the waiter was successful

Raises:

(Aws::Waiters::Errors::FailureStateError) —
Raised when the waiter terminates because the waiter has entered a state that it will not transition out of, preventing success.

yet successful.
(Aws::Waiters::Errors::UnexpectedError) —
Raised when an error is encountered while polling for a resource that is not expected.
(NotImplementedError) —
Raised when the resource does not

# File 'lib/aws-sdk-ec2/security_group.rb', line 203

def wait_until(options = {}, &block)
  self_copy = self.dup
  attempts = 0
  options[:max_attempts] = 10 unless options.key?(:max_attempts)
  options[:delay] ||= 10
  options[:poller] = Proc.new do
    attempts += 1
    if block.call(self_copy)
      [:success, self_copy]
    else
      self_copy.reload unless attempts == options[:max_attempts]
      :retry
    end
  end
  Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    Aws::Waiters::Waiter.new(options).wait({})
  end
end

Class: Aws::EC2::SecurityGroup

Overview

Defined Under Namespace

Read-Only Attributes collapse

Actions collapse

Instance Method Summary collapse

Constructor Details

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

Instance Method Details

#authorize_egress(options = {}) ⇒ Types::AuthorizeSecurityGroupEgressResult

Examples:

Request syntax with placeholder values

#authorize_ingress(options = {}) ⇒ Types::AuthorizeSecurityGroupIngressResult

Examples:

Request syntax with placeholder values

#client ⇒ Client

#create_tags(options = {}) ⇒ Tag::Collection

Examples:

Request syntax with placeholder values

#data ⇒ Types::SecurityGroup

#data_loaded? ⇒ Boolean

#delete(options = {}) ⇒ Types::DeleteSecurityGroupResult

Examples:

Request syntax with placeholder values

#delete_tags(options = {}) ⇒ Tag::Collection

Examples:

Request syntax with placeholder values

#description ⇒ String

#group_name ⇒ String

#id ⇒ String Also known as: group_id

#identifiers ⇒ Object

#ip_permissions ⇒ Array<Types::IpPermission>

#ip_permissions_egress ⇒ Array<Types::IpPermission>

#load ⇒ self Also known as: reload

#owner_id ⇒ String

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

Examples:

Request syntax with placeholder values

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

Examples:

Request syntax with placeholder values

#security_group_arn ⇒ String

#tags ⇒ Array<Types::Tag>

#vpc_id ⇒ String

#wait_until(options = {}) {|resource| ... } ⇒ Resource

Basic Usage

Example

Configuration

Callbacks

Handling Errors

#initialize(id, options = {}) ⇒ `SecurityGroup` #initialize(options = {}) ⇒ `SecurityGroup`

#authorize_egress(options = {}) ⇒ `Types::AuthorizeSecurityGroupEgressResult`

#authorize_ingress(options = {}) ⇒ `Types::AuthorizeSecurityGroupIngressResult`

#client ⇒ `Client`

#create_tags(options = {}) ⇒ `Tag::Collection`

#data ⇒ `Types::SecurityGroup`

#data_loaded? ⇒ `Boolean`

#delete(options = {}) ⇒ `Types::DeleteSecurityGroupResult`

#delete_tags(options = {}) ⇒ `Tag::Collection`

#description ⇒ `String`

#group_name ⇒ `String`

#id ⇒ `String` Also known as: group_id

#identifiers ⇒ `Object`

#ip_permissions ⇒ `Array<Types::IpPermission>`

#ip_permissions_egress ⇒ `Array<Types::IpPermission>`

#load ⇒ `self` Also known as: reload

#owner_id ⇒ `String`

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

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

#security_group_arn ⇒ `String`

#tags ⇒ `Array<Types::Tag>`

#vpc_id ⇒ `String`

#wait_until(options = {}) {|resource| ... } ⇒ `Resource`