bucket-lifecycle-operations

if [ ${?} -ne 0 ]; then errecho "**** ERROR ****"

errecho "AWS reported a failure to terminate EC2 instance: $EC2_INSTANCE_ID"

errecho "You must terminate the instance using the AWS Management Console"

errecho "or CLI commands. Failure to terminate the instance can result in"

errecho "charges to your AWS account.\n"

else

iecho "request accepted."

iecho -n "Waiting for instance $EC2_INSTANCE_ID to terminate..."

aws ec2 wait instance-terminated \ --instance-id "$EC2_INSTANCE_ID"

iecho "confirmed."

if [[ ${?} -ne 0 ]]; then

errecho "ERROR - AWS reports that Wait command failed."

errecho "You must ensure that the instance terminated successfully yourself using the"

errecho "AWS Management Console or CLI commands. Failure to terminate the instance can"

errecho "result in charges to your AWS account.\n"

return 1 fi

iecho "************END OF TEAR DOWN****************"

iecho ""

echo "Tests completed successfully."

s3

• bucket-lifecycle-operations (p. 13)

bucket-lifecycle-operations

• awsdocs_general.sh (p. 13)

• bucket_operations.sh (p. 16)

• test_bucket_operations.sh (p. 20)

awsdocs_general.sh

#!/usr/bin/env bash

###############################################################################

# This file is licensed under the Apache License, Version 2.0 (the "License").

## You may not use this file except in compliance with the License. A copy of

# the License is located at http://aws.amazon.com/apache2.0/.

## This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR

# CONDITIONS OF ANY KIND, either express or implied. See the License for the

# specific language governing permissions and limitations under the License.

###############################################################################

# This script contains general purpose functions that are used throughout

# the AWS Command Line Interface (AWS CLI) code samples that are maintained

# in the repo at https://github.com/awsdocs/aws-doc-sdk-examples

## They are intended to abstract functionality that is required for the tests

# to work without cluttering up the code. The intent is to ensure the purpose

# of the code is clear.

# Set global defaults:

VERBOSE=false

###############################################################################

# function run_test

## This function is used to perform a command and compare its output to both

# the expected error code and the expected output string. If there isn't a

# match, then the function invokes the test_failed function.

###############################################################################

function run_test {

local DESCRIPTION COMMAND EXPECTED_ERR_CODE EXPECTED_OUTPUT RESPONSE DESCRIPTION="$1"

COMMAND="$2"

EXPECTED_ERR_CODE="$3"

if [[ -z "$4" ]]; then EXPECTED_OUTPUT="$4"; else EXPECTED_OUTPUT=""; fi iecho -n "Running test: $DESCRIPTION..."

RESPONSE="$($COMMAND)"

ERR="${?}"

# Check to see if we got the expected error code.

if [[ "$EXPECTED_ERR_CODE" -ne "$ERR" ]]; then

test_failed "The test \"$DESCRIPTION\" returned an unexpected error code: $ERR"

#now check the error message, if we provided other than "".

if [[ -n "$EXPECTED_OUTPUT" ]]; then

MATCH=$(echo "$RESPONSE" | grep "$EXPECTED_OUTPUT") # If there was no match (it's an empty string), then fail.

if [[ -z "$MATCH" ]]; then

test_failed "The test \"$DESCRIPTION\" returned an unexpected output:

$RESPONSE"

fi fi

iecho "OK"

ipause }

###############################################################################

# function test_failed

# This function is used to terminate a failed test and to warn the customer

# about possible undeleted resources that could incur costs to their account.

###############################################################################

function test_failed { errecho ""

errecho "===TEST FAILED==="

errecho "$@"

errecho ""

errecho " One or more of the tests failed to complete successfully. This means that any"

errecho " tests after the one that failed test didn't run and might have left resources"

errecho " still active in your account."

errecho ""

errecho "IMPORTANT:"

errecho " Resources created by this script can incur charges to your AWS account. If the"

errecho " script did not complete successfully, then you must review and manually delete"

errecho " any resources created by this script that were not automatically removed."

errecho ""

exit 1 }

###############################################################################

# function errecho

## This function outputs everything sent to it to STDERR (standard error output).

###############################################################################

function errecho {

printf "%s\n" "$*" 2>&1 }

###############################################################################

# function iecho

# This function enables the script to display the specified text only if

# the global variable $VERBOSE is set to true.

###############################################################################

function iecho {

if [[ $VERBOSE == true ]]; then echo "$@"

fi }

###############################################################################

# function ipause

# This function enables the script to pause after each command if interactive

# mode is set (by including -i on the script invocation command).

###############################################################################

function ipause {

if [[ $INTERACTIVE == true ]]; then

read -r -p "Press ENTER to continue..."

fi }

# Initialize the shell's RANDOM variable RANDOM=$$

###############################################################################

# function generate_random_name

## This function generates a random file name with using the specified root

# followed by 4 groups that each have 4 digits.

# The default root name is "test"

function generate_random_name { ROOTNAME="test"

if [[ -n $1 ]]; then ROOTNAME=$1 fi

# Initialize the filename variable

FILENAME="$ROOTNAME"

# Configure random number generator to issue numbers between 1000 and 9999, inclusive DIFF=$((9999-1000+1))

for _ in {1..4}

rnd=$(($((RANDOM%DIFF))+X))

# make sure that the number is 4 digits long while [ "${#rnd}" -lt 4 ]; do rnd="0$rnd"; done FILENAME+="-$rnd"

done

echo $FILENAME }

bucket_operations.sh

#!/usr/bin/env bash

###############################################################################

# This file is licensed under the Apache License, Version 2.0 (the "License").

# You may not use this file except in compliance with the License. A copy of

# the License is located at http://aws.amazon.com/apache2.0/.

## This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR

# CONDITIONS OF ANY KIND, either express or implied. See the License for the

# specific language governing permissions and limitations under the License.

###############################################################################

source ./awsdocs_general.sh

###############################################################################

# function bucket_exists

# This function checks to see if the specified bucket already exists.

## Parameters:

# $1 - The name of the bucket to check

# Returns:

# 0 if the bucket already exists

# 1 if the bucket doesn't exist

###############################################################################

function bucket_exists { be_bucketname=$1

# Check whether the bucket already exists.

# We suppress all output - we're interested only in the return code.

aws s3api head-bucket \ --bucket $be_bucketname \ >/dev/null 2>&1

if [[ ${?} -eq 0 ]]; then

return 0 # 0 in Bash script means true.

else

return 1 # 1 in Bash script means false.

fi }

###############################################################################

# function create-bucket

# This function creates the specified bucket in the specified AWS Region, unless

# it already exists.

# Parameters:

# -b bucket_name -- The name of the bucket to create

# -r region_code -- The code for an AWS Region in which to

# create the bucket

# Returns:

# The URL of the bucket that was created.

# And:

# 0 if successful

# 1 if it fails

###############################################################################

function create_bucket {

local BUCKET_NAME REGION_CODE RESPONSE

local OPTION OPTIND OPTARG # Required to use getopts command in a function function usage {

echo "function create_bucket"

echo "Creates an Amazon S3 bucket. You must supply both of the following parameters:"

echo " -b bucket_name The name of the bucket. It must be globally unique."

echo " -r region_code The code for an AWS Region in which the bucket is created."

echo ""

}

# Retrieve the calling parameters while getopts "b:r:" OPTION; do case "${OPTION}"

b) BUCKET_NAME="${OPTARG}";;

r) REGION_CODE="${OPTARG}";;

h) usage; return 0;;

\?) echo "Invalid parameter"; usage; return 1;;

esac done

if [[ -z "$BUCKET_NAME" ]]; then

errecho "ERROR: You must provide a bucket name with the -b parameter."

usage return 1 fi

if [[ -z "$REGION_CODE" ]]; then

errecho "ERROR: You must provide an AWS Region code with the -r parameter."

usage return 1 fi

iecho "Parameters:\n"

iecho " Bucket name: $BUCKET_NAME"

iecho " Region code: $REGION_CODE"

iecho ""

# If the bucket already exists, we don't want to try to create it.

if (bucket_exists $BUCKET_NAME); then

errecho "ERROR: A bucket with that name already exists. Try again."

return 1 fi

# The bucket doesn't exist, so try to create it.

RESPONSE=$(aws s3api create-bucket \ --bucket $BUCKET_NAME \

--create-bucket-configuration LocationConstraint=$REGION_CODE)

if [[ ${?} -ne 0 ]]; then

errecho "ERROR: AWS reports create-bucket operation failed.\n$RESPONSE"

return 1 fi

}

###############################################################################

# function copy_file_to_bucket

## This function creates a file in the specified bucket.

## Parameters:

# -b bucket_name$1 - The name of the bucket to copy the file to

# $2 - The path and file name of the local file to copy to the bucket

# $3 - The key (name) to call the copy of the file in the bucket

# # Returns:

# 0 if successful

# 1 if it fails

###############################################################################

function copy_file_to_bucket { cftb_bucketname=$1

cftb_sourcefile=$2 cftb_destfilename=$3 local RESPONSE

RESPONSE=$(aws s3api put-object \ --bucket $cftb_bucketname \ --body $cftb_sourcefile \ --key $cftb_destfilename) if [[ ${?} -ne 0 ]]; then

errecho "ERROR: AWS reports put-object operation failed.\n$RESPONSE"

return 1 fi

}

###############################################################################

# function copy_item_in_bucket

# This function creates a copy of the specified file in the same bucket.

## Parameters:

# $1 - The name of the bucket to copy the file from and to

# $2 - The key of the source file to copy

# $3 - The key of the destination file

# # Returns:

# 0 if successful

# 1 if it fails

###############################################################################

function copy_item_in_bucket { ciib_bucketname=$1

ciib_sourcefile=$2 ciib_destfile=$3 local RESPONSE

RESPONSE=$(aws s3api copy-object \ --bucket $ciib_bucketname \

--copy-source $ciib_bucketname/$ciib_sourcefile \ --key $ciib_destfile)

if [[ $? -ne 0 ]]; then

errecho "ERROR: AWS reports s3api copy-object operation failed.\n$RESPONSE"

return 1

fi }

###############################################################################

# function list_items_in_bucket

# This function displays a list of the files in the bucket with each file's

# size. The function uses the --query parameter to retrieve only the Key and

# Size fields from the Contents collection.

## Parameters:

# $1 - The name of the bucket

# # Returns:

# The list of files in text format

# And:

# 0 if successful

# 1 if it fails

###############################################################################

function list_items_in_bucket { liib_bucketname=$1

local RESPONSE

RESPONSE=$(aws s3api list-objects \ --bucket $liib_bucketname \ --output text \

--query 'Contents[].{Key: Key, Size: Size}' ) if [[ ${?} -eq 0 ]]; then

echo "$RESPONSE"

else

errecho "ERROR: AWS reports s3api list-objects operation failed.\n$RESPONSE"

return 1 fi

}

###############################################################################

# function delete_item_in_bucket

# This function deletes the specified file from the specified bucket.

# Parameters:

# $1 - The name of the bucket

# $2 - The key (file name) in the bucket to delete

# Returns:

# 0 if successful

# 1 if it fails

###############################################################################

function delete_item_in_bucket { diib_bucketname=$1

diib_key=$2 local RESPONSE

RESPONSE=$(aws s3api delete-object \ --bucket $diib_bucketname \ --key $diib_key)

if [[ $? -ne 0 ]]; then

errecho "ERROR: AWS reports s3api delete-object operation failed.\n$RESPONSE"

return 1 fi

}

###############################################################################

# function delete_bucket

# This function deletes the specified bucket.

## Parameters:

# $1 - The name of the bucket

# Returns:

# 0 if successful

# 1 if it fails

###############################################################################

function delete_bucket { db_bucketname=$1 local RESPONSE

RESPONSE=$(aws s3api delete-bucket \ --bucket $db_bucketname) if [[ $? -ne 0 ]]; then

errecho "ERROR: AWS reports s3api delete-bucket failed.\n$RESPONSE"

return 1 fi

}

test_bucket_operations.sh