Class: AWSCDK::EC2::Peer

Inherits:
Jsii::Object
  • Object
show all
Defined in:
ec2/peer.rb

Overview

Peer object factories (to be used in Security Group management).

The static methods on this object can be used to create peer objects which represent a connection partner in Security Group rules.

Use this object if you need to represent connection partners using plain IP addresses, or a prefix list ID.

If you want to address a connection partner by Security Group, you can just use the Security Group (or the construct that contains a Security Group) directly, as it already implements IPeer.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Peer

Returns a new instance of Peer.



18
19
20
 
# File 'ec2/peer.rb', line 18

def initialize
  Jsii::Object.instance_method(:initialize).bind(self).call
end

Class Method Details

.any_ipv4 ⇒ AWSCDK::EC2::IPeer

Any IPv4 address.

Returns:



30
31
32
 
# File 'ec2/peer.rb', line 30

def self.any_ipv4()
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ec2.Peer", "anyIpv4", [])
end

.any_ipv6 ⇒ AWSCDK::EC2::IPeer

Any IPv6 address.

Returns:



37
38
39
 
# File 'ec2/peer.rb', line 37

def self.any_ipv6()
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ec2.Peer", "anyIpv6", [])
end

.ipv4(cidr_ip) ⇒ AWSCDK::EC2::IPeer

Create an IPv4 peer from a CIDR.

Parameters:

  • cidr_ip (String)

Returns:



45
46
47
48
 
# File 'ec2/peer.rb', line 45

def self.ipv4(cidr_ip)
  Jsii::Type.check_type(cidr_ip, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cidrIp")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ec2.Peer", "ipv4", [cidr_ip])
end

.ipv6(cidr_ip) ⇒ AWSCDK::EC2::IPeer

Create an IPv6 peer from a CIDR.

Parameters:

  • cidr_ip (String)

Returns:



54
55
56
57
 
# File 'ec2/peer.rb', line 54

def self.ipv6(cidr_ip)
  Jsii::Type.check_type(cidr_ip, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cidrIp")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ec2.Peer", "ipv6", [cidr_ip])
end

.jsii_overridable_methods ⇒ Object 



22
23
24
25
 
# File 'ec2/peer.rb', line 22

def self.jsii_overridable_methods
  {
  }
end

.prefix_list(prefix_list_id) ⇒ AWSCDK::EC2::IPeer

A prefix list.

Parameters:

  • prefix_list_id (String)

Returns:



63
64
65
66
 
# File 'ec2/peer.rb', line 63

def self.prefix_list(prefix_list_id)
  Jsii::Type.check_type(prefix_list_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "prefixListId")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ec2.Peer", "prefixList", [prefix_list_id])
end

.security_group_id(security_group_id, source_security_group_owner_id = nil) ⇒ AWSCDK::EC2::IPeer

A security group ID.

Parameters:

  • security_group_id (String)
  • source_security_group_owner_id (String, nil) (defaults to: nil)

Returns:



73
74
75
76
77
 
# File 'ec2/peer.rb', line 73

def self.security_group_id(security_group_id, source_security_group_owner_id = nil)
  Jsii::Type.check_type(security_group_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "securityGroupId")
  Jsii::Type.check_type(source_security_group_owner_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "sourceSecurityGroupOwnerId") unless source_security_group_owner_id.nil?
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ec2.Peer", "securityGroupId", [security_group_id, source_security_group_owner_id])
end