aws

package
v0.19.0 Latest Latest
Warning

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

 Go to latest Published: Sep 8, 2022 License: Apache-2.0 Imports: 27 Imported by: 0

Documentation

Overview

Copyright The Mantle Authors SPDX-License-Identifier: Apache-2.0

Index

Constants

View Source 
const ContainerLinuxDiskSizeGiB = 8

The default size of Container Linux disks on AWS, in GiB. See discussion in https://github.com/coreos/mantle/pull/944

View Source 
const (
	// ContentTypeJSON is canonical content-type for JSON objects
	ContentTypeJSON = "application/json"
)

Variables

This section is empty.

Functions

func AmiArchForBoard added in v0.18.0 

func AmiArchForBoard(board string) (string, error)

Types

type API 

type API struct {
	// contains filtered or unexported fields
}

func New 

func New(opts *Options) (*API, error)

New creates a new AWS API wrapper. It uses credentials from any of the standard credentials sources, including the environment and the profile configured in ~/.aws. No validation is done that credentials exist and before using the API a preflight check is recommended via api.PreflightCheck Note that this method may modify Options to update the AMI ID

func (*API) AddKey 

func (a *API) AddKey(name, key string) error

func (*API) CopyBucket added in v0.18.0 

func (a *API) CopyBucket(srcBucket, prefix, destBucket, policy string) error

Copies all objects in srcBucket to destBucket with a given canned ACL policy

func (*API) CopyImage added in v0.4.0 

func (a *API) CopyImage(sourceImageID string, regions []string) (map[string]string, error)

func (*API) CopyObject added in v0.18.0 

func (a *API) CopyObject(srcBucket, srcPath, destBucket, destPath, policy string) error

Copy an Object to a new location with a given canned ACL policy

func (*API) CreateHVMImage added in v0.4.0 

func (a *API) CreateHVMImage(snapshotID string, diskSizeGiB uint, name string, description string, arch string) (string, error)

func (*API) CreateImportRole added in v0.4.0 

func (a *API) CreateImportRole(bucket string) error

func (*API) CreateInstances 

func (a *API) CreateInstances(name, keyname, userdata string, count uint64) ([]*ec2.Instance, error)

CreateInstances creates EC2 instances with a given name tag, optional ssh key name, user data. The image ID, instance type, and security group set in the API will be used. CreateInstances will block until all instances are running and have an IP address.

func (*API) CreateSnapshot added in v0.4.0 

func (a *API) CreateSnapshot(imageName, sourceURL string, format EC2ImageFormat) (*Snapshot, error)

CreateSnapshot creates an AWS Snapshot

func (*API) CreateTags added in v0.4.0 

func (a *API) CreateTags(resources []string, tags map[string]string) error

func (*API) DeleteKey 

func (a *API) DeleteKey(name string) error

func (*API) DeleteObject added in v0.5.0 

func (a *API) DeleteObject(bucket, path string) error

func (*API) DownloadFile added in v0.18.0 

func (a *API) DownloadFile(srcBucket, srcPath string) (*os.File, error)

Downloads a file from S3 to a temporary file. This file must be closed by the caller.

func (*API) FindImage added in v0.5.0 

func (a *API) FindImage(name string) (string, error)

Find an image we own with the specified name. Return ID or "".

func (*API) FindSnapshot added in v0.5.0 

func (a *API) FindSnapshot(imageName string) (*Snapshot, error)

Look up a Snapshot by name. Return nil if not found.

func (*API) FindSnapshots added in v0.19.0 

func (a *API) FindSnapshots(imageName string) ([]Snapshot, error)

func (*API) GC added in v0.8.0 

func (a *API) GC(gracePeriod time.Duration) error

GC removes AWS resources that are at least gracePeriod old. It attempts to only operate on resources that were created by a mantle tool.

func (*API) GetConsoleOutput added in v0.6.0 

func (a *API) GetConsoleOutput(instanceID string) (string, error)

GetConsoleOutput returns the console output. Returns "", nil if no logs are available.

func (*API) GetImageLastLaunchedTime added in v0.19.0 

func (a *API) GetImageLastLaunchedTime(imageID string) (time.Time, error)

func (*API) GetImagesByTag added in v0.18.0 

func (a *API) GetImagesByTag(tag, value string) ([]*ec2.Image, error)

GetImagesByTag returns all EC2 images with that tag

func (*API) GrantLaunchPermission added in v0.5.0 

func (a *API) GrantLaunchPermission(imageID string, userIDs []string) error

func (*API) InitializeBucket added in v0.4.0 

func (a *API) InitializeBucket(bucket string) error

func (*API) PreflightCheck added in v0.4.0 

func (a *API) PreflightCheck() error

PreflightCheck validates that the aws configuration provided has valid credentials

func (*API) PublishImage added in v0.5.0 

func (a *API) PublishImage(imageID string) error

Grant everyone launch permission on the specified image and create-volume permission on its underlying snapshot.

func (*API) PutObjectAcl added in v0.18.0 

func (a *API) PutObjectAcl(bucket, path, policy string) error

This will modify the ACL on Objects to one of the canned ACL policies

func (*API) RemoveImage added in v0.18.0 

func (a *API) RemoveImage(amiName, imageName string, s3object BucketObject, otherRegions []string) error

Remove all uploaded data associated with an AMI, also in other given regions.

func (*API) RemoveLaunchPermission added in v0.19.0 

func (a *API) RemoveLaunchPermission(imageid string) ([]byte, error)

func (*API) TerminateInstances added in v0.6.0 

func (a *API) TerminateInstances(ids []string) error

TerminateInstances schedules EC2 instances to be terminated.

func (*API) UpdateBucketObjectsACL added in v0.18.0 

func (a *API) UpdateBucketObjectsACL(srcBucket, prefix, policy string) error

TODO: bikeshed this name modifies the ACL of all objects of a given prefix in srcBucket to a given canned ACL policy

func (*API) UpdateProduct added in v0.19.0 

func (a *API) UpdateProduct(amiID, accessRoleARN, username, version, productID, instanceType string, dryRun bool) error

UpdateProduct takes care of publishing the AMI to the AWS Marketplace by updating the existing product version. It takes care of scanning the AMI too.

func (*API) UploadObject added in v0.4.0 

func (a *API) UploadObject(r io.Reader, bucket, path string, force bool) error

UploadObject uploads an object to S3

func (*API) UploadObjectExt added in v0.18.0 

func (a *API) UploadObjectExt(r io.Reader, bucket, path string, force bool, policy string, contentType string, max_age int) error

UploadObjectExt uploads an object to S3 with more control over options.

type BucketObject added in v0.19.0 

type BucketObject struct {
	Region string
	Bucket string
	Path   string
}

type EC2ImageFormat added in v0.4.0 

type EC2ImageFormat string
const (
	EC2ImageFormatRaw  EC2ImageFormat = ec2.DiskImageFormatRaw
	EC2ImageFormatVmdk EC2ImageFormat = ec2.DiskImageFormatVmdk
)

func (*EC2ImageFormat) Set added in v0.4.0 

func (e *EC2ImageFormat) Set(s string) error

func (*EC2ImageFormat) String added in v0.4.0 

func (e *EC2ImageFormat) String() string

func (*EC2ImageFormat) Type added in v0.4.0 

func (e *EC2ImageFormat) Type() string

type EC2ImageType added in v0.4.0 

type EC2ImageType string
const (
	EC2ImageTypeHVM EC2ImageType = "hvm"
)

type Options 

type Options struct {
	*platform.Options
	// The AWS region regional api calls should use
	Region string

	// The path to the shared credentials file, if not ~/.aws/credentials
	CredentialsFile string
	// The profile to use when resolving credentials, if applicable
	Profile string

	// AccessKeyID is the optional access key to use. It will override all other sources
	AccessKeyID string
	// SecretKey is the optional secret key to use. It will override all other sources
	SecretKey string

	// AMI is the AWS AMI to launch EC2 instances with.
	// If it is one of the special strings alpha|beta|stable, it will be resolved
	// to an actual ID.
	AMI                string
	InstanceType       string
	SecurityGroup      string
	IAMInstanceProfile string
}

type Snapshot added in v0.4.0 

type Snapshot struct {
	SnapshotID string
}

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.