Arkade_S3_Shell_Config::usageHelp PHP Method

usageHelp() public method

Retrieve Usage Help Message
public usageHelp ( )
    public function usageHelp()
    {
        return <<<USAGE
DESCRIPTION
    Allows the developer to configure which S3 bucket they want to use with
    their Magento installation.

SYNOPSIS
    php s3_config.php [--list]
                      [--access-key-id <access-key-id>]
                      [--secret-key <secret-key>]
                      [--bucket <bucket>]
                      [--region <region>]
                      [-h] [--help]

OPTIONS
    --list
        Lists whatever credentials for S3 you have provided for Magento.

        NOTE: Using this option will cause the script to ignore the other options.

    --access-key-id <access-key-id>
        You must provide a valid AWS access key ID. You can generate access keys
        using the AWS IAM (https://console.aws.amazon.com/iam/home).

    --secret-key <secret-key>
        You must also provide the secret access key that corresponds to the
        access key ID that you have just generated.

    --bucket <bucket>
        You must provide a valid S3 bucket name that you want media files to be
        uploaded to.

    --region <region>
        You must provide a valid S3 region. As 2016-03-17, S3 has the following
        regions:

        us-east-1
        us-west-1
        us-west-2
        eu-west-1
        eu-central-1
        ap-southeast-1
        ap-southeast-2
        ap-northeast-1
        ap-northeast-2
        sa-east-1

        You can review all valid S3 regions via the AWS documentation
        (http://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region).


USAGE;
    }
Arkade_S3_Shell_Config