ec2/

README

AWS SDK for Go code examples for Amazon EC2

Purpose

These examples demonstrate how to perform several Amazon Elastic Compute Cloud (Amazon EC2) operations.

Prerequisites

You must have an AWS account, and have your default credentials and AWS Region configured as described in Configuring the AWS SDK for Go in the AWS SDK for Go Developer Guide.

Running the code

AllocateAddress/AllocateAddress.go

This example allocates a VPC Elastic IP address and associates it with an instance.

go run AllocateAddress.go -i INSTANCE-ID

• INSTANCE-ID is the ID of an instance.

The unit test mocks the service client and the AllocateAddress and AssociateAddress functions.

CreateImage/CreateImage.go

This example creates an Amazon EC2 image.

go run CreateImage -d IMAGE-DESCRIPTION -i INSTANCE-ID -n IMAGE-NAME

• IMAGE-DESCRIPTION is the description of the image.
• INSTANCE-ID is the ID of the instance.
• IMAGE-NAME is the name of the image.

The unit test mocks the service client and the CreateImage function.

CreateInstance/CreateInstance.go

This example creates an Amazon EC2 instance.

go run CreateInstance -n NAME -v VALUE

• NAME is the name of the tag to attach to the instance.
• VALUE is the value of the tag to attach to the instance.

The unit test mocks the service client and the RunInstances and CreateTags functions.

CreateKeyPair/CreateKeyPair.go

This example creates an Amazon EC2 key pair.

go run CreateKeyPair.go -k KEY-NAME

• KEY-NAME is the name of the new key pair.

The unit test mocks the service client and the CreateKeyPair function.

CreateSecurityGroup/CreateSecurityGroup.go

This example creates a security group.

go run CreateSecurityGroup.go -n NAME -d DESCRIPTION [-v VPC-ID]

• NAME is the name of the security group.
• DESCRIPTION is a description of the security group.
• VPC-ID is the ID of the VPC associated with the group.

The unit test mocks the service client and the DescribeVpcs, CreateSecurityGroup, and AuthorizeSecurityGroupIngress functions.

DeleteKeyPair/DeleteKeyPair.go

This example deletes an Amazon EC2 key pair.

go run DeleteKeyPair.go -k KEY-NAME

• KEY-NAME is the name of the key pair to delete.

The unit test mocks the service client and the DeleteKeyPair function.

DeleteSecurityGroup/DeleteSecurityGroup.go

This example deletes a security group.

go run DeleteSecurityGroup.go -n NAME

• NAME is the name of the security group to delete.

The unit test mocks the service client and the DeleteSecurityGroup function.

DescribeAddresses/DescribeAddresses.go

This example displays some information about the Elastic IP addresses for your account's VPC.

go run DescribeAddresses.go

DescribeInstances/DescribeInstances.go

This example lists your reservation IDs and instance IDs.

go run DescribeInstances.go

DescribeKeyPairs/DescribeKeyPairs.go

This example retrieves a list of Key Pairs stored in Amazon EC2.

go run DescribeKeyPairs.go

DescribeSecurityGroups/DescribeSecurityGroups.go

This example displays information about your security groups.

go run DescribeSecurityGroups.go

MonitorInstances/MonitorInstances.go

This example enables or disables monitoring for an instance.

go run MonitorInstances.go -i INSTANCE-ID -m STATE

• INSTANCE-ID is the ID of the instance to monitor or stop monitoring.
• STATE is ON or OFF.

The unit test mocks the service client and the MonitorInstances and UnmonitorInstances functions.

RebootInstances/RebootInstances.go

This example reboots an Amazon EC2 instance.

go run RebootInstances.go -i INSTANCE-ID

• INSTANCE-ID is the ID of an instance.

The unit test mocks the service client and the RebootInstances function.

RegionsAndZones/RegionsAndZones.go

This example lists the AWS Regions where Amazon EC2 is available, and the Availability Zones within the current AWS Region.

go run RegionsAndZones.go

ReleaseAddress/ReleaseAddress.go

This example releases an Elastic IP address. If the address is associated with an Amazon EC2 instance, the association is removed.

go run ReleaseAddress.go -a ALLOCATION-ID

• ALLOCATION-ID is the ID of an Elastic IP address.

The unit test mocks the service client and the ReleaseAddress function.

StartStopInstances/StartStopInstances.go

This example starts or stops an Amazon EC2 instance.

go run StartStopInstances.go -i INSTANCE-ID -s STATE

• INSTANCE-ID is the ID of an instance.
• STATE is either START or STOP.

The unit test mocks the service client and the StartInstances and StopInstances functions.

Notes

• We recommend that you grant this code least privilege, or at most the minimum permissions required to perform the task. For more information, see Grant Least Privilege in the AWS Identity and Access Management User Guide.
• This code has not been tested in all AWS Regions. Some AWS services are available only in specific Regions.
• Running this code might result in charges to your AWS account.

Running the unit tests

Unit tests should delete any resources they create. However, they might result in charges to your AWS account.

To run a unit test, enter the following.

go test

You should see something like the following, where PATH is the path to the folder containing the Go files.

PASS
ok      PATH 6.593s

To see any log messages, enter the following.

go test -test.v

You should see additional log messages. The last two lines should be similar to the previous output shown.

Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. SPDX-License-Identifier: Apache-2.0