# Functions
AddTagsToResource adds the tags to the given taggable AWS resource such as EC2, AMI or VPC.
AddTagsToResourceE adds the tags to the given taggable AWS resource such as EC2, AMI or VPC.
AssertS3BucketExists checks if the given S3 bucket exists in the given region and fail the test if it does not.
AssertS3BucketExistsE checks if the given S3 bucket exists in the given region and return an error if it does not.
AssumeRole mutates the provided session by obtaining new credentials by assuming the role provided in roleARN.
CreateAndImportEC2KeyPair generates a public/private KeyPair and import it into EC2 in the given region under the given name.
CreateAndImportEC2KeyPairE generates a public/private KeyPair and import it into EC2 in the given region under the given name.
CreateAwsCredentials creates an AWS Credentials configuration with specific AWS credentials.
CreateAwsCredentialsWithSessionToken creates an AWS Credentials configuration with temporary AWS credentials by including a session token (used for authenticating with MFA).
CreateAwsSessionFromRole returns a new AWS session after assuming the role whose ARN is provided in roleARN.
CreateAwsSessionWithCreds creates a new AWS session using explicit credentials.
CreateAwsSessionWithMfa creates a new AWS session authenticated using an MFA token retrieved using the given STS client and MFA Device.
CreateEcsCluster creates ECS cluster in the given region under the given name.
CreateEcsClusterE creates ECS cluster in the given region under the given name.
CreateMfaDevice creates an MFA device using the given IAM client.
CreateMfaDeviceE creates an MFA device using the given IAM client.
CreateRandomQueue creates a new SQS queue with a random name that starts with the given prefix and return the queue URL.
CreateRandomQueueE creates a new SQS queue with a random name that starts with the given prefix and return the queue URL.
CreateS3Bucket creates an S3 bucket in the given region with the given name.
CreateS3BucketE creates an S3 bucket in the given region with the given name.
CreateSnsTopic creates an SNS Topic and return the ARN.
CreateSnsTopicE creates an SNS Topic and return the ARN.
DeleteAmi deletes the given AMI in the given region.
DeleteAmiAndAllSnapshots will delete the given AMI along with all EBS snapshots that backed that AMI.
DeleteAmiAndAllSnapshotsE will delete the given AMI along with all EBS snapshots that backed that AMI.
DeleteAmiE deletes the given AMI in the given region.
DeleteEbsSnapshot deletes the given EBS snapshot.
DeleteEbsSnapshot deletes the given EBS snapshot.
DeleteEC2KeyPair deletes an EC2 key pair.
DeleteEC2KeyPairE deletes an EC2 key pair.
No description provided by the author
DeleteEcsClusterE deletes existing ECS cluster in the given region.
DeleteMessageFromQueue deletes the message with the given receipt from the SQS queue with the given URL.
DeleteMessageFromQueueE deletes the message with the given receipt from the SQS queue with the given URL.
DeleteQueue deletes the SQS queue with the given URL.
DeleteQueueE deletes the SQS queue with the given URL.
DeleteS3Bucket destroys the S3 bucket in the given region with the given name.
DeleteS3BucketE destroys the S3 bucket in the given region with the given name.
DeleteSNSTopic deletes an SNS Topic.
DeleteSNSTopicE deletes an SNS Topic.
EmptyS3BucketE removes the contents of an S3 bucket in the given region with the given name.
EmptyS3BucketE removes the contents of an S3 bucket in the given region with the given name.
EnableMfaDevice enables a newly created MFA Device by supplying the first two one-time passwords, so that it can be used for future logins by the given IAM User.
EnableMfaDeviceE enables a newly created MFA Device by supplying the first two one-time passwords, so that it can be used for future logins by the given IAM User.
FetchContentsOfFileFromAsg looks up the EC2 Instances in the given ASG, looks up the public IPs of those EC2 Instances, connects to each Instance via SSH using the given username and Key Pair, fetches the contents of the file at the given path (using sudo if useSudo is true), and returns a map from Instance ID to the contents of that file as a string.
FetchContentsOfFileFromAsgE looks up the EC2 Instances in the given ASG, looks up the public IPs of those EC2 Instances, connects to each Instance via SSH using the given username and Key Pair, fetches the contents of the file at the given path (using sudo if useSudo is true), and returns a map from Instance ID to the contents of that file as a string.
FetchContentsOfFileFromInstance looks up the public IP address of the EC2 Instance with the given ID, connects to the Instance via SSH using the given username and Key Pair, fetches the contents of the file at the given path (using sudo if useSudo is true), and returns the contents of that file as a string.
FetchContentsOfFileFromInstanceE looks up the public IP address of the EC2 Instance with the given ID, connects to the Instance via SSH using the given username and Key Pair, fetches the contents of the file at the given path (using sudo if useSudo is true), and returns the contents of that file as a string.
FetchContentsOfFilesFromAsg looks up the EC2 Instances in the given ASG, looks up the public IPs of those EC2 Instances, connects to each Instance via SSH using the given username and Key Pair, fetches the contents of the files at the given paths (using sudo if useSudo is true), and returns a map from Instance ID to a map of file path to the contents of that file as a string.
FetchContentsOfFilesFromAsgE looks up the EC2 Instances in the given ASG, looks up the public IPs of those EC2 Instances, connects to each Instance via SSH using the given username and Key Pair, fetches the contents of the files at the given paths (using sudo if useSudo is true), and returns a map from Instance ID to a map of file path to the contents of that file as a string.
FetchContentsOfFilesFromInstance looks up the public IP address of the EC2 Instance with the given ID, connects to the Instance via SSH using the given username and Key Pair, fetches the contents of the files at the given paths (using sudo if useSudo is true), and returns a map from file path to the contents of that file as a string.
FetchContentsOfFilesFromInstanceE looks up the public IP address of the EC2 Instance with the given ID, connects to the Instance via SSH using the given username and Key Pair, fetches the contents of the files at the given paths (using sudo if useSudo is true), and returns a map from file path to the contents of that file as a string.
FetchFilesFromAsgs looks up the EC2 Instances in all the ASGs given in the RemoteFileSpecification, looks up the public IPs of those EC2 Instances, connects to each Instance via SSH using the given username and Key Pair, downloads the files matching filenameFilters at the given remoteDirectory (using sudo if useSudo is true), and stores the files locally at localDirectory/<publicip>/<remoteFolderName>.
FetchFilesFromAsgsE looks up the EC2 Instances in all the ASGs given in the RemoteFileSpecification, looks up the public IPs of those EC2 Instances, connects to each Instance via SSH using the given username and Key Pair, downloads the files matching filenameFilters at the given remoteDirectory (using sudo if useSudo is true), and stores the files locally at localDirectory/<publicip>/<remoteFolderName>.
FetchFilesFromInstance looks up the EC2 Instances in the given ASG, looks up the public IPs of those EC2 Instances, connects to each Instance via SSH using the given username and Key Pair, downloads the files matching filenameFilters at the given remoteDirectory (using sudo if useSudo is true), and stores the files locally at localDirectory/<publicip>/<remoteFolderName>.
FetchFilesFromInstanceE looks up the EC2 Instances in the given ASG, looks up the public IPs of those EC2 Instances, connects to each Instance via SSH using the given username and Key Pair, downloads the files matching filenameFilters at the given remoteDirectory (using sudo if useSudo is true), and stores the files locally at localDirectory/<publicip>/<remoteFolderName>.
FindS3BucketWithTag finds the name of the S3 bucket in the given region with the given tag key=value.
FindS3BucketWithTagE finds the name of the S3 bucket in the given region with the given tag key=value.
FindVpcName extracts the VPC name from its tags (if any).
GetAccountId gets the Account ID for the currently logged in IAM User.
GetAccountIdE gets the Account ID for the currently logged in IAM User.
GetAccountsWithLaunchPermissionsForAmi returns list of accounts that the AMI is shared with.
GetAccountsWithLaunchPermissionsForAmiE returns list of accounts that the AMI is shared with.
GetAcmCertificateArn gets the ACM certificate for the given domain name in the given region.
GetAcmCertificateArnE gets the ACM certificate for the given domain name in the given region.
GetAddressOfRdsInstance gets the address of the given RDS Instance in the given region.
GetAddressOfRdsInstanceE gets the address of the given RDS Instance in the given region.
GetAllAwsRegions gets the list of AWS regions available in this account.
GetAllAwsRegionsE gets the list of AWS regions available in this account.
GetAllParametersOfRdsInstance gets all the parameters defined in the parameter group for the RDS instance in the given region.
GetAllParametersOfRdsInstanceE gets all the parameters defined in the parameter group for the RDS instance in the given region.
GetAmazonLinuxAmi returns an Amazon Linux AMI HVM, SSD Volume Type public AMI for the given region.
GetAmazonLinuxAmiE returns an Amazon Linux AMI HVM, SSD Volume Type public AMI for the given region.
GetAmiPubliclyAccessible returns whether the AMI is publicly accessible or not.
GetAmiPubliclyAccessibleE returns whether the AMI is publicly accessible or not.
GetAvailabilityZones gets the Availability Zones for a given AWS region.
GetAvailabilityZonesE gets the Availability Zones for a given AWS region.
GetCapacityInfoForAsg returns the capacity info for the queried asg as a struct, AsgCapacityInfo.
GetCapacityInfoForAsgE returns the capacity info for the queried asg as a struct, AsgCapacityInfo.
GetCentos7Ami returns a CentOS 7 public AMI from the given region.
GetCentos7AmiE returns a CentOS 7 public AMI from the given region.
GetCloudWatchLogEntries returns the CloudWatch log messages in the given region for the given log stream and log group.
GetCloudWatchLogEntriesE returns the CloudWatch log messages in the given region for the given log stream and log group.
GetCmkArn gets the ARN of a KMS Customer Master Key (CMK) in the given region with the given ID.
GetCmkArnE gets the ARN of a KMS Customer Master Key (CMK) in the given region with the given ID.
GetDefaultEcsCluster fetches information about default ECS cluster.
GetDefaultEcsClusterE fetches information about default ECS cluster.
GetDefaultVpc fetches information about the default VPC in the given region.
GetDefaultVpcE fetches information about the default VPC in the given region.
GetEbsSnapshotsForAmi retrieves the EBS snapshots which back the given AMI.
GetEbsSnapshotsForAmi retrieves the EBS snapshots which back the given AMI.
GetEc2InstanceIdsByTag returns all the IDs of EC2 instances in the given region with the given tag.
GetEc2InstanceIdsByTagE returns all the IDs of EC2 instances in the given region with the given tag.
GetEcsCluster fetches information about specified ECS cluster.
GetEcsClusterE fetches information about specified ECS cluster.
GetEcsOptimizedAmazonLinuxAmi returns an Amazon ECS-Optimized Amazon Linux AMI for the given region.
GetEcsOptimizedAmazonLinuxAmiE returns an Amazon ECS-Optimized Amazon Linux AMI for the given region.
GetFirstTwoOctets gets the first two octets from a CIDR block.
GetIamCurrentUserArn gets the ARN for the current IAM user.
GetIamCurrentUserArnE gets the ARN for the current IAM user.
GetIamCurrentUserName gets the username for the current IAM user.
GetIamCurrentUserNameE gets the username for the current IAM user.
GetInstanceIdsForAsg gets the IDs of EC2 Instances in the given ASG.
GetInstanceIdsForAsgE gets the IDs of EC2 Instances in the given ASG.
GetLaunchPermissionsForAmiE returns launchPermissions as configured in AWS.
GetMostRecentAmiId gets the ID of the most recent AMI in the given region that has the given owner and matches the given filters.
GetMostRecentAmiIdE gets the ID of the most recent AMI in the given region that has the given owner and matches the given filters.
GetOptionGroupNameOfRdsInstance gets the name of the option group associated with the RDS instance.
GetOptionGroupNameOfRdsInstanceE gets the name of the option group associated with the RDS instance.
GetOptionSettingForOfRdsInstance gets the value of the option name in the option group specified for the RDS instance in the given region.
GetOptionSettingForOfRdsInstanceE gets the value of the option name in the option group specified for the RDS instance in the given region.
GetOptionsOfOptionGroup gets the options of the option group specified.
GetOptionsOfOptionGroupE gets the options of the option group specified.
GetParameterValueForParameterOfRdsInstance gets the value of the parameter name specified for the RDS instance in the given region.
GetParameterValueForParameterOfRdsInstanceE gets the value of the parameter name specified for the RDS instance in the given region.
GetPortOfRdsInstance gets the address of the given RDS Instance in the given region.
GetPortOfRdsInstanceE gets the address of the given RDS Instance in the given region.
GetPrivateHostnameOfEc2Instance gets the private IP address of the given EC2 Instance in the given region.
GetPrivateHostnameOfEc2InstanceE gets the private IP address of the given EC2 Instance in the given region.
GetPrivateHostnamesOfEc2Instances gets the private IP address of the given EC2 Instance in the given region.
GetPrivateHostnamesOfEc2InstancesE gets the private IP address of the given EC2 Instance in the given region.
GetPrivateIpOfEc2Instance gets the private IP address of the given EC2 Instance in the given region.
GetPrivateIpOfEc2InstanceE gets the private IP address of the given EC2 Instance in the given region.
GetPrivateIpsOfEc2Instances gets the private IP address of the given EC2 Instance in the given region.
GetPrivateIpsOfEc2InstancesE gets the private IP address of the given EC2 Instance in the given region.
GetPublicIpOfEc2Instance gets the public IP address of the given EC2 Instance in the given region.
GetPublicIpOfEc2InstanceE gets the public IP address of the given EC2 Instance in the given region.
GetPublicIpsOfEc2Instances gets the public IP address of the given EC2 Instance in the given region.
GetPublicIpsOfEc2InstancesE gets the public IP address of the given EC2 Instance in the given region.
GetRandomPrivateCidrBlock gets a random CIDR block from the range of acceptable private IP addresses per RFC 1918 (https://tools.ietf.org/html/rfc1918#section-3) The routingPrefix refers to the "/28" in 1.2.3.4/28.
GetRandomRegion gets a randomly chosen AWS region.
GetRandomRegionE gets a randomly chosen AWS region.
GetStableRandomRegion gets a randomly chosen AWS region that is considered stable.
GetRdsInstanceDetailsE gets the details of a single DB instance whose identifier is passed.
GetS3ObjectContents fetches the contents of the object in the given bucket with the given key and return it as a string.
GetS3ObjectContentsE fetches the contents of the object in the given bucket with the given key and return it as a string.
GetSubnetsForVpc gets the subnets in the specified VPC.
GetSubnetsForVpcE gets the subnets in the specified VPC.
(Deprecated) See the FetchContentsOfFileFromInstance method for a more powerful solution.
(Deprecated) See the FetchContentsOfFileFromInstanceE method for a more powerful solution.
(Deprecated) See the FetchContentsOfFilesFromAsg method for a more powerful solution.
(Deprecated) See the FetchContentsOfFilesFromAsgE method for a more powerful solution.
GetTagsForEc2Instance returns all the tags for the given EC2 Instance.
GetTagsForEc2InstanceE returns all the tags for the given EC2 Instance.
GetTimeBasedOneTimePassword gets a One-Time Password from the given mfaDevice.
GetUbuntu1404Ami gets the ID of the most recent Ubuntu 14.04 HVM x86_64 EBS GP2 AMI in the given region.
GetUbuntu1404AmiE gets the ID of the most recent Ubuntu 14.04 HVM x86_64 EBS GP2 AMI in the given region.
GetUbuntu1604Ami gets the ID of the most recent Ubuntu 16.04 HVM x86_64 EBS GP2 AMI in the given region.
GetUbuntu1604AmiE gets the ID of the most recent Ubuntu 16.04 HVM x86_64 EBS GP2 AMI in the given region.
GetWhetherSchemaExistsInRdsMySqlInstance checks whether the specified schema/table name exists in the RDS instance.
GetWhetherSchemaExistsInRdsMySqlInstanceE checks whether the specified schema/table name exists in the RDS instance.
ImportEC2KeyPair creates a Key Pair in EC2 by importing an existing public key.
ImportEC2KeyPairE creates a Key Pair in EC2 by importing an existing public key.
NewAcmClient create a new ACM client.
NewAcmClientE creates a new ACM client.
No description provided by the author
NewAsgClient creates an Auto Scaling Group client.
NewAsgClientE creates an Auto Scaling Group client.
NewAuthenticatedSession gets an AWS Session, checking that the user has credentials properly configured in their environment.
NewAuthenticatedSessionFromRole returns a new AWS Session after assuming the role whose ARN is provided in roleARN.
NewCloudWatchLogsClient creates a new CloudWatch Logs client.
NewCloudWatchLogsClientE creates a new CloudWatch Logs client.
NewEc2Client creates an EC2 client.
NewEc2ClientE creates an EC2 client.
NewEcsClient creates en ECS client.
NewEcsClientE creates an ECS client.
NewIamClient creates a new IAM client.
NewIamClientE creates a new IAM client.
NewKmsClient creates a KMS client.
NewKmsClientE creates a KMS client.
No description provided by the author
NewRdsClient creates an RDS client.
NewRdsClientE creates an RDS client.
NewS3Client creates an S3 client.
NewS3ClientE creates an S3 client.
NewS3Uploader creates an S3 Uploader.
NewS3UploaderE creates an S3 Uploader.
NewSnsClient creates a new SNS client.
NewSnsClientE creates a new SNS client.
NewSqsClient creates a new SQS client.
NewSqsClientE creates a new SQS client.
ReadPasswordPolicyMinPasswordLength returns the minimal password length.
SendMessageToQueue sends the given message to the SQS queue with the given URL.
SendMessageToQueueE sends the given message to the SQS queue with the given URL.
TerminateInstance terminates the EC2 instance with the given ID in the given region.
TerminateInstanceE terminates the EC2 instance with the given ID in the given region.
WaitForCapacity waits for the currently set desired capacity to be reached on the ASG.
WaitForCapacityE waits for the currently set desired capacity to be reached on the ASG.
WaitForQueueMessage waits to receive a message from on the queueURL.
# Constants
These are commonly used AMI account IDs.
These are commonly used AMI account IDs.
These are commonly used AMI account IDs.
# Structs
No description provided by the author
AsgCapacityNotMetError is returned when the ASG capacity is not yet at the desired capacity.
CredentialsError is an error that occurs because AWS credentials can't be found.
Ec2Keypair is an EC2 key pair.
HostnameForEc2InstanceNotFound is an error that occurs when the IP for an EC2 instance is not found.
IpForEc2InstanceNotFound is an error that occurs when the IP for an EC2 instance is not found.
NoImagesFound is an error that occurs if no images were found.
NotFoundError is returned when an expected object is not found.
OptionGroupOptionSettingForDbInstanceNotFound is an error that occurs when the option setting specified is not found in the option group of the DB instance.
ParameterForDbInstanceNotFound is an error that occurs when the parameter group specified is not found for the DB instance.
QueueMessageResponse contains a queue message.
ReceiveMessageTimeout is an error that occurs if receiving a message times out.
No description provided by the author
Subnet is a subnet in an availability zone.
Vpc is an Amazon Virtual Private Cloud.