ec2

package
v1.1.7 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 29, 2024 License: MIT Imports: 9 Imported by: 0

README

awsutils/ec2

The ec2 package is a collection of utility functions designed to simplify common ec2 tasks.

Table of contents

Functions

Connection.CheckInstanceExists(string)
CheckInstanceExists(string) error

CheckInstanceExists checks whether an instance with the provided ID exists.

Parameters:

instanceID: the ID of the instance to check

Returns:

error: an error if any issue occurs while trying to check the instance

Connection.CreateInstance(Params)
CreateInstance(Params) *ec2.Reservation, error

CreateInstance creates a new EC2 instance with the provided parameters.

Parameters:

ec2Params: the parameters to use

Returns:

*ec2.Reservation: the reservation of the created instance

error: an error if any issue occurs while trying to create the instance

Connection.CreateSecurityGroup(string)
CreateSecurityGroup(string) string, error

CreateSecurityGroup creates a new security group with the provided name, description and VPC ID.

Parameters:

groupName: the name of the security group to use

description: the description of the security group to use

vpcID: the ID of the VPC to use

Returns:

string: the ID of the created security group

error: an error if any issue occurs while trying to create the security group

Connection.DestroyInstance(string)
DestroyInstance(string) error

DestroyInstance destroys the instance with the provided ID.

Parameters:

instanceID: the ID of the instance to destroy

Returns:

error: an error if any issue occurs while trying to destroy the instance

Connection.DestroySecurityGroup(string)
DestroySecurityGroup(string) error

DestroySecurityGroup destroys the security group with the provided ID.

Parameters:

groupId: the ID of the security group to destroy

Returns:

error: an error if any issue occurs while trying to destroy the security group

Connection.FindOverlyPermissiveInboundRules(string)
FindOverlyPermissiveInboundRules(string) bool, error

FindOverlyPermissiveInboundRules checks if a specific security group permits all inbound traffic.

Specifically, it checks if the security group has an inbound rule with the IP protocol set to "-1", which allows all IP traffic. This is useful for identifying security groups that are configured with lenient security rules, especially in testing environments. The function uses AWS SDK to describe security groups in AWS EC2 and checks their inbound rules.

Parameters:

secGrpID: A string containing the ID of the security group which needs to be checked for the all traffic inbound rule.

Returns:

bool: A boolean value indicating whether the security group permits all inbound traffic or not.

error: An error if any issue occurs while trying to describe the security group or check its inbound rules.

Connection.GetInstancePublicIP(string)
GetInstancePublicIP(string) string, error

GetInstancePublicIP retrieves the public IP address of the instance with the provided ID.

Parameters:

instanceID: the ID of the instance to use

Returns:

string: the public IP address of the instance

error: an error if any issue occurs while trying to retrieve the public IP address

Connection.GetInstanceState(string)
GetInstanceState(string) string, error

GetInstanceState retrieves the state of the instance with the provided ID.

Parameters:

instanceID: the ID of the instance to use

Returns:

string: the state of the instance

error: an error if any issue occurs while trying to retrieve the state

Connection.GetInstances([]*ec2.Filter)
GetInstances([]*ec2.Filter) []*ec2.Instance, error

GetInstances retrieves all instances matching the provided filters.

Parameters:

filters: the filters to use

Returns:

[]*ec2.Instance: the instances matching the provided filters

error: an error if any issue occurs while trying to retrieve the instances

Connection.GetInstancesRunningForMoreThan24Hours()
GetInstancesRunningForMoreThan24Hours() []*ec2.Instance, error

GetInstancesRunningForMoreThan24Hours retrieves all instances that have been running for more than 24 hours.

Returns:

[]*ec2.Instance: the instances that have been running for more than 24 hours

error: an error if any issue occurs while trying to retrieve the instances

Connection.GetLatestAMI(AMIInfo)
GetLatestAMI(AMIInfo) string, error

GetLatestAMI retrieves the latest Amazon Machine Image (AMI) for a specified distribution, version and architecture. It utilizes AWS SDK to query AWS EC2 for the AMIs matching the provided pattern and returns the latest one based on the creation date.

Parameters:

info: An AMIInfo struct containing necessary details like Distro, Version, Architecture, and Region for which the AMI needs to be retrieved.

Returns:

string: The ID of the latest AMI found based on the provided information.

error: An error if any issue occurs while trying to get the latest AMI.

Connection.GetRegion()
GetRegion() string, error

GetRegion retrieves the region of the connection.

Returns:

string: the region of the connection

error: an error if any issue occurs while trying to retrieve the region

Connection.GetRunningInstances()
GetRunningInstances() *ec2.DescribeInstancesOutput, error

GetRunningInstances retrieves all running instances.

Returns:

*ec2.DescribeInstancesOutput: the output of the DescribeInstances operation

error: an error if any issue occurs while trying to retrieve the running instances

Connection.GetSubnetID(string)
GetSubnetID(string) string, error

GetSubnetID retrieves the ID of the subnet with the provided name.

Parameters:

subnetName: the name of the subnet to use

Returns:

string: the ID of the subnet with the provided name

error: an error if any issue occurs while trying to retrieve the ID of the subnet with the provided name

Connection.GetSubnetRouteTable(string)
GetSubnetRouteTable(string) string, error

GetSubnetRouteTable retrieves the route table ID associated with a specific subnet.

Connection.GetVPCID(string)
GetVPCID(string) string, error

GetVPCID retrieves the information of a VPC with the provided name.

Parameters:

vpcName: the name of the VPC to use. If "default" is provided, the function will return the ID of the default VPC.

Returns:

string: the ID of the VPC with the provided name

error: an error if any issue occurs while trying to retrieve the ID of the VPC with the provided name

Connection.IsSubnetPublic(string)
IsSubnetPublic(string) bool, error

IsSubnetPublic checks whether the provided subnet ID is publicly routable.

Parameters:

subnetID: the ID of the subnet to use

Returns:

bool: a boolean value indicating whether the provided subnet ID is publicly routable

error: an error if any issue occurs while trying to check whether the provided subnet ID is publicly routable

Connection.ListSecurityGroups()
ListSecurityGroups() []*ec2.SecurityGroup, error

ListSecurityGroups lists all security groups.

Returns:

[]*ec2.SecurityGroup: all security groups

error: an error if any issue occurs while trying to list the security groups

Connection.ListSecurityGroupsForSubnet(string)
ListSecurityGroupsForSubnet(string) []*ec2.SecurityGroup, error

ListSecurityGroupsForSubnet lists all security groups for the provided subnet ID.

Parameters:

subnetID: the ID of the subnet to use

Returns:

[]*ec2.SecurityGroup: all security groups for the provided subnet ID

error: an error if any issue occurs while trying to list the security groups

Connection.ListSecurityGroupsForVpc(string)
ListSecurityGroupsForVpc(string) []*ec2.SecurityGroup, error

ListSecurityGroupsForVpc lists all security groups for the provided VPC ID.

Parameters:

vpcID: the ID of the VPC to use

Returns:

[]*ec2.SecurityGroup: all security groups for the provided VPC ID

error: an error if any issue occurs while trying to list the security groups

Connection.ListVPCSubnets(string, string)
ListVPCSubnets(string, string) []*ec2.Subnet, error

ListVPCSubnets lists subnets for the provided VPC name and subnet location.

Parameters:

vpcID: the ID of the VPC to use. subnetLocation: the location of the subnet. Can be "public", "private", or "all".

Returns:

[]*ec2.Subnet: the list of subnets for the provided VPC name and location

error: an error if any issue occurs while trying to list the subnets

Connection.ListVPCs()
ListVPCs() []*ec2.Vpc, error

ListVPCs lists all VPCs.

Returns:

[]*ec2.Vpc: all VPCs

error: an error if any issue occurs while trying to list the VPCs

Connection.TagInstance(string, string, string)
TagInstance(string, string, string) error

TagInstance tags an instance with the provided key and value.

Parameters:

instanceID: the ID of the instance to tag

tagKey: the key of the tag to use

tagValue: the value of the tag to use

Returns:

error: an error if any issue occurs while trying to tag the instance

Connection.WaitForInstance(string)
WaitForInstance(string) error

WaitForInstance waits until the instance with the provided ID is in the running state.

Parameters:

instanceID: the ID of the instance to wait for

Returns:

error: an error if any issue occurs while trying to wait for the instance

IsEC2Instance()
IsEC2Instance() bool

IsEC2Instance checks whether the code is running on an AWS EC2 instance by checking the existence of the file /sys/devices/virtual/dmi/id/product_uuid. If the file exists, the code is running on an EC2 instance, and the function returns true. If the file does not exist, the function returns false, indicating that the code is not running on an EC2 instance.

Returns:

bool: A boolean value that indicates whether the code is running on an EC2 instance.

NewConnection()
NewConnection() *Connection

NewConnection creates a new connection to AWS EC2.

Returns:

*Connection: a new connection to AWS EC2

Installation

To use the awsutils/ec2 package, you first need to install it. Follow the steps below to install via go get.

go get github.com/l50/awsutils/ec2

Usage

After installation, you can import the package in your Go project using the following import statement:

import "github.com/l50/awsutils/ec2"

Tests

To ensure the package is working correctly, run the following command to execute the tests for awsutils/ec2:

go test -v

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Documentation

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

func IsEC2Instance 

func IsEC2Instance() bool

IsEC2Instance checks whether the code is running on an AWS EC2 instance by checking the existence of the file /sys/devices/virtual/dmi/id/product_uuid. If the file exists, the code is running on an EC2 instance, and the function returns true. If the file does not exist, the function returns false, indicating that the code is not running on an EC2 instance.

**Returns:**

bool: A boolean value that indicates whether the code is running on an EC2 instance.

Example 
package main

import (
	"log"

	ec2utils "github.com/l50/awsutils/ec2"
)

func main() {
	isEC2 := ec2utils.IsEC2Instance()
	if isEC2 {
		log.Println("Running on an EC2 instance")
	} else {
		log.Println("Not running on an EC2 instance")
	}
}

Output:

Types

type AMIInfo added in v1.1.1 

type AMIInfo struct {
	Distro       string
	Version      string
	Architecture string
	Region       string
}

AMIInfo provides information about an AMI.

**Attributes:**

Distro: the distro to use Version: the version to use Architecture: the architecture to use Region: the region to use

type Connection 

type Connection struct {
	Client *ec2.EC2
}

Connection provides a connection to AWS EC2.

**Attributes:**

Client: the EC2 client

func NewConnection added in v1.1.3 

func NewConnection() *Connection

NewConnection creates a new connection to AWS EC2.

**Returns:**

*Connection: a new connection to AWS EC2

func (*Connection) CheckInstanceExists added in v1.1.3 

func (c *Connection) CheckInstanceExists(instanceID string) error

CheckInstanceExists checks whether an instance with the provided ID exists.

**Parameters:**

instanceID: the ID of the instance to check

**Returns:**

error: an error if any issue occurs while trying to check the instance

func (*Connection) CreateInstance added in v1.1.3 

func (c *Connection) CreateInstance(ec2Params Params) (*ec2.Reservation, error)

CreateInstance creates a new EC2 instance with the provided parameters.

**Parameters:**

ec2Params: the parameters to use

**Returns:**

*ec2.Reservation: the reservation of the created instance

error: an error if any issue occurs while trying to create the instance

func (*Connection) CreateSecurityGroup added in v1.1.3 

func (c *Connection) CreateSecurityGroup(groupName, description, vpcID string) (string, error)

CreateSecurityGroup creates a new security group with the provided name, description and VPC ID.

**Parameters:**

groupName: the name of the security group to use

description: the description of the security group to use

vpcID: the ID of the VPC to use

**Returns:**

string: the ID of the created security group

error: an error if any issue occurs while trying to create the security group

func (*Connection) DestroyInstance added in v1.1.3 

func (c *Connection) DestroyInstance(instanceID string) error

DestroyInstance destroys the instance with the provided ID.

**Parameters:**

instanceID: the ID of the instance to destroy

**Returns:**

error: an error if any issue occurs while trying to destroy the instance

func (*Connection) DestroySecurityGroup added in v1.1.3 

func (c *Connection) DestroySecurityGroup(groupID string) error

DestroySecurityGroup destroys the security group with the provided ID.

**Parameters:**

groupId: the ID of the security group to destroy

**Returns:**

error: an error if any issue occurs while trying to destroy the security group

func (*Connection) FindOverlyPermissiveInboundRules added in v1.1.3 

func (c *Connection) FindOverlyPermissiveInboundRules(secGrpID string) (bool, error)

FindOverlyPermissiveInboundRules checks if a specific security group permits all inbound traffic.

Specifically, it checks if the security group has an inbound rule with the IP protocol set to "-1", which allows all IP traffic. This is useful for identifying security groups that are configured with lenient security rules, especially in testing environments. The function uses AWS SDK to describe security groups in AWS EC2 and checks their inbound rules.

**Parameters:**

secGrpID: A string containing the ID of the security group which needs to be checked for the all traffic inbound rule.

**Returns:**

bool: A boolean value indicating whether the security group permits all inbound traffic or not.

error: An error if any issue occurs while trying to describe the security group or check its inbound rules.

func (*Connection) GetInstancePublicIP added in v1.1.3 

func (c *Connection) GetInstancePublicIP(instanceID string) (string, error)

GetInstancePublicIP retrieves the public IP address of the instance with the provided ID.

**Parameters:**

instanceID: the ID of the instance to use

**Returns:**

string: the public IP address of the instance

error: an error if any issue occurs while trying to retrieve the public IP address

func (*Connection) GetInstanceState added in v1.1.3 

func (c *Connection) GetInstanceState(instanceID string) (string, error)

GetInstanceState retrieves the state of the instance with the provided ID.

**Parameters:**

instanceID: the ID of the instance to use

**Returns:**

string: the state of the instance

error: an error if any issue occurs while trying to retrieve the state

func (*Connection) GetInstances added in v1.1.3 

func (c *Connection) GetInstances(filters []*ec2.Filter) ([]*ec2.Instance, error)

GetInstances retrieves all instances matching the provided filters.

**Parameters:**

filters: the filters to use

**Returns:**

[]*ec2.Instance: the instances matching the provided filters

error: an error if any issue occurs while trying to retrieve the instances

func (*Connection) GetInstancesRunningForMoreThan24Hours added in v1.1.3 

func (c *Connection) GetInstancesRunningForMoreThan24Hours() ([]*ec2.Instance, error)

GetInstancesRunningForMoreThan24Hours retrieves all instances that have been running for more than 24 hours.

**Returns:**

[]*ec2.Instance: the instances that have been running for more than 24 hours

error: an error if any issue occurs while trying to retrieve the instances

func (*Connection) GetLatestAMI added in v1.1.3 

func (c *Connection) GetLatestAMI(info AMIInfo) (string, error)

GetLatestAMI retrieves the latest Amazon Machine Image (AMI) for a specified distribution, version and architecture. It utilizes AWS SDK to query AWS EC2 for the AMIs matching the provided pattern and returns the latest one based on the creation date.

**Parameters:**

info: An AMIInfo struct containing necessary details like Distro, Version, Architecture, and Region for which the AMI needs to be retrieved.

**Returns:**

string: The ID of the latest AMI found based on the provided information.

error: An error if any issue occurs while trying to get the latest AMI.

Example 
package main

import (
	"fmt"

	ec2utils "github.com/l50/awsutils/ec2"
)

func main() {
	c := ec2utils.NewConnection()
	info := ec2utils.AMIInfo{
		Distro:       "ubuntu",
		Version:      "20.04",
		Architecture: "amd64",
		Region:       "us-west-1",
	}

	amiID, err := c.GetLatestAMI(info)

	if err != nil {
		fmt.Println(err)
		return
	}

	fmt.Println(amiID)
}

Output:

func (*Connection) GetRegion added in v1.1.3 

func (c *Connection) GetRegion() (string, error)

GetRegion retrieves the region of the connection.

**Returns:**

string: the region of the connection

error: an error if any issue occurs while trying to retrieve the region

func (*Connection) GetRunningInstances added in v1.1.3 

func (c *Connection) GetRunningInstances() (*ec2.DescribeInstancesOutput, error)

GetRunningInstances retrieves all running instances.

**Returns:**

*ec2.DescribeInstancesOutput: the output of the DescribeInstances operation

error: an error if any issue occurs while trying to retrieve the running instances

func (*Connection) GetSubnetID added in v1.1.3 

func (c *Connection) GetSubnetID(subnetName string) (string, error)

GetSubnetID retrieves the ID of the subnet with the provided name.

**Parameters:**

subnetName: the name of the subnet to use

**Returns:**

string: the ID of the subnet with the provided name

error: an error if any issue occurs while trying to retrieve the ID of the subnet with the provided name

func (*Connection) GetSubnetRouteTable added in v1.1.7 

func (c *Connection) GetSubnetRouteTable(subnetID string) (string, error)

GetSubnetRouteTable retrieves the route table ID associated with a specific subnet.

func (*Connection) GetVPCID added in v1.1.3 

func (c *Connection) GetVPCID(vpcName string) (string, error)

GetVPCID retrieves the information of a VPC with the provided name.

**Parameters:**

vpcName: the name of the VPC to use. If "default" is provided, the function will return the ID of the default VPC.

**Returns:**

string: the ID of the VPC with the provided name

error: an error if any issue occurs while trying to retrieve the ID of the VPC with the provided name

func (*Connection) IsSubnetPublic added in v1.1.7 

func (c *Connection) IsSubnetPublic(subnetID string) (bool, error)

IsSubnetPublic checks whether the provided subnet ID is publicly routable.

**Parameters:**

subnetID: the ID of the subnet to use

**Returns:**

bool: a boolean value indicating whether the provided subnet ID is publicly routable

error: an error if any issue occurs while trying to check whether the provided subnet ID is publicly routable

func (*Connection) ListSecurityGroups added in v1.1.3 

func (c *Connection) ListSecurityGroups() ([]*ec2.SecurityGroup, error)

ListSecurityGroups lists all security groups.

**Returns:**

[]*ec2.SecurityGroup: all security groups

error: an error if any issue occurs while trying to list the security groups

func (*Connection) ListSecurityGroupsForSubnet added in v1.1.3 

func (c *Connection) ListSecurityGroupsForSubnet(subnetID string) ([]*ec2.SecurityGroup, error)

ListSecurityGroupsForSubnet lists all security groups for the provided subnet ID.

**Parameters:**

subnetID: the ID of the subnet to use

**Returns:**

[]*ec2.SecurityGroup: all security groups for the provided subnet ID

error: an error if any issue occurs while trying to list the security groups

func (*Connection) ListSecurityGroupsForVpc added in v1.1.3 

func (c *Connection) ListSecurityGroupsForVpc(vpcID string) ([]*ec2.SecurityGroup, error)

ListSecurityGroupsForVpc lists all security groups for the provided VPC ID.

**Parameters:**

vpcID: the ID of the VPC to use

**Returns:**

[]*ec2.SecurityGroup: all security groups for the provided VPC ID

error: an error if any issue occurs while trying to list the security groups

func (*Connection) ListVPCSubnets added in v1.1.7 

func (c *Connection) ListVPCSubnets(vpcID string, subnetLocation string) ([]*ec2.Subnet, error)

ListVPCSubnets lists subnets for the provided VPC name and subnet location.

**Parameters:**

vpcID: the ID of the VPC to use. subnetLocation: the location of the subnet. Can be "public", "private", or "all".

**Returns:**

[]*ec2.Subnet: the list of subnets for the provided VPC name and location

error: an error if any issue occurs while trying to list the subnets

func (*Connection) ListVPCs added in v1.1.7 

func (c *Connection) ListVPCs() ([]*ec2.Vpc, error)

ListVPCs lists all VPCs.

**Returns:**

[]*ec2.Vpc: all VPCs

error: an error if any issue occurs while trying to list the VPCs

func (*Connection) TagInstance added in v1.1.3 

func (c *Connection) TagInstance(instanceID string, tagKey string, tagValue string) error

TagInstance tags an instance with the provided key and value.

**Parameters:**

instanceID: the ID of the instance to tag

tagKey: the key of the tag to use

tagValue: the value of the tag to use

**Returns:**

error: an error if any issue occurs while trying to tag the instance

func (*Connection) WaitForInstance added in v1.1.3 

func (c *Connection) WaitForInstance(instanceID string) error

WaitForInstance waits until the instance with the provided ID is in the running state.

**Parameters:**

instanceID: the ID of the instance to wait for

**Returns:**

error: an error if any issue occurs while trying to wait for the instance

type Params 

type Params struct {
	AssociatePublicIPAddress bool
	ImageID                  string
	InstanceProfile          string
	InstanceType             string
	MinCount                 int
	MaxCount                 int
	SecurityGroupIDs         []string
	KeyName                  string
	SubnetID                 string
	VolumeSize               int64
	InstanceName             string
}

Params provides information about an EC2 instance.

**Attributes:**

AssociatePublicIPAddress: whether to associate a public IP address ImageID: the ID of the AMI to use InstanceProfile: the name of the instance profile to use InstanceType: the type of the instance to use MinCount: the minimum number of instances to launch MaxCount: the maximum number of instances to launch SecurityGroupIDs: the IDs of the security groups to use KeyName: the name of the key pair to use SubnetID: the ID of the subnet to use VolumeSize: the size of the volume to use InstanceName: the name of the instance to use

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.