Skip to content

Commit ba52b42

Browse files
committed
Updated README.md
1 parent 118c080 commit ba52b42

File tree

16 files changed

+262
-230
lines changed

16 files changed

+262
-230
lines changed

Diff for: awsec2instances/README.md

+13-11
Original file line numberDiff line numberDiff line change
@@ -22,41 +22,43 @@ This folder contains a Java application example that handles EC2 instances on AW
2222

2323
Setting your credentials for use by the AWS SDK for Java can be done in a number of ways, but here are the recommended approaches:
2424

25-
* The default credential profiles file
25+
* The default credential profiles file.
2626

2727
Set credentials in the AWS credentials profile file on your local system, located at:
2828

29-
`~/.aws/credentials` on Linux, macOS, or Unix
29+
* `~/.aws/credentials` on Linux, macOS, or Unix.
3030

31-
`C:\Users\USERNAME\.aws\credentials` on Windows
31+
* `C:\Users\USERNAME\.aws\credentials` on Windows.
3232

3333
This file should contain lines in the following format:
3434

3535
```bash
3636
[default]
37-
aws_access_key_id = <your_access_key_id>
38-
aws_secret_access_key = <your_secret_access_key>
37+
aws_access_key_id = <YOUR_ACCESS_KEY_ID>
38+
aws_secret_access_key = <YOUR_SECRET_ACCESS_KEY>
3939
```
40-
Substitute your own AWS credentials values for the values `<your_access_key_id>` and `<your_secret_access_key>`.
40+
Replace the values of `<YOUR_ACCESS_KEY_ID>` and `<YOUR_SECRET_ACCESS_KEY>` by your AWS credentials.
4141

42-
* Environment variables `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY`
42+
* Environment variables `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY`.
4343

4444
Set the `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` environment variables.
4545

4646
To set these variables on Linux, macOS, or Unix, use `export`:
4747

4848
```bash
49-
export AWS_ACCESS_KEY_ID=<your_access_key_id>
50-
export AWS_SECRET_ACCESS_KEY=<your_secret_access_key>
49+
export AWS_ACCESS_KEY_ID=<YOUR_ACCESS_KEY_ID>
50+
export AWS_SECRET_ACCESS_KEY=<YOUR_SECRET_ACCESS_KEY>
5151
```
5252

5353
To set these variables on Windows, use `set`:
5454

5555
```bash
56-
set AWS_ACCESS_KEY_ID=<your_access_key_id>
57-
set AWS_SECRET_ACCESS_KEY=<your_secret_access_key>
56+
set AWS_ACCESS_KEY_ID=<YOUR_ACCESS_KEY_ID>
57+
set AWS_SECRET_ACCESS_KEY=<YOUR_SECRET_ACCESS_KEY>
5858
```
5959

60+
Replace the values of `<YOUR_ACCESS_KEY_ID>` and `<YOUR_SECRET_ACCESS_KEY>` by your AWS credentials.
61+
6062
* You can select the AWS region changing the value of `REGION` variable in the code.
6163

6264
* Run the code.

Diff for: awslambdacreate/README.md

+19-17
Original file line numberDiff line numberDiff line change
@@ -24,41 +24,43 @@ Create an AWS Lambda function.
2424

2525
Setting your credentials for use by the AWS SDK for Java can be done in a number of ways, but here are the recommended approaches:
2626

27-
* The default credential profiles file
27+
* The default credential profiles file.
2828

2929
Set credentials in the AWS credentials profile file on your local system, located at:
3030

31-
`~/.aws/credentials` on Linux, macOS, or Unix
31+
* `~/.aws/credentials` on Linux, macOS, or Unix.
3232

33-
`C:\Users\USERNAME\.aws\credentials` on Windows
33+
* `C:\Users\USERNAME\.aws\credentials` on Windows.
3434

3535
This file should contain lines in the following format:
3636

3737
```bash
3838
[default]
39-
aws_access_key_id = <your_access_key_id>
40-
aws_secret_access_key = <your_secret_access_key>
39+
aws_access_key_id = <YOUR_ACCESS_KEY_ID>
40+
aws_secret_access_key = <YOUR_SECRET_ACCESS_KEY>
4141
```
42-
Substitute your own AWS credentials values for the values `<your_access_key_id>` and `<your_secret_access_key>`.
42+
Replace the values of `<YOUR_ACCESS_KEY_ID>` and `<YOUR_SECRET_ACCESS_KEY>` by your AWS credentials.
4343

44-
* Environment variables `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY`
44+
* Environment variables `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY`.
4545

4646
Set the `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` environment variables.
4747

4848
To set these variables on Linux, macOS, or Unix, use `export`:
4949

5050
```bash
51-
export AWS_ACCESS_KEY_ID=<your_access_key_id>
52-
export AWS_SECRET_ACCESS_KEY=<your_secret_access_key>
51+
export AWS_ACCESS_KEY_ID=<YOUR_ACCESS_KEY_ID>
52+
export AWS_SECRET_ACCESS_KEY=<YOUR_SECRET_ACCESS_KEY>
5353
```
5454

5555
To set these variables on Windows, use `set`:
5656

5757
```bash
58-
set AWS_ACCESS_KEY_ID=<your_access_key_id>
59-
set AWS_SECRET_ACCESS_KEY=<your_secret_access_key>
58+
set AWS_ACCESS_KEY_ID=<YOUR_ACCESS_KEY_ID>
59+
set AWS_SECRET_ACCESS_KEY=<YOUR_SECRET_ACCESS_KEY>
6060
```
6161

62+
Replace the values of `<YOUR_ACCESS_KEY_ID>` and `<YOUR_SECRET_ACCESS_KEY>` by your AWS credentials.
63+
6264
* You need a `JAR` or `ZIP` file where the code of the Lambda function is located.
6365

6466
You can use the code obtained from the AWS Lambda Function Hello World JSON Java example: [awslambdahellojson](/awslambdahellojson).
@@ -69,17 +71,17 @@ Create an AWS Lambda function.
6971

7072
* Run the code.
7173

72-
You must provide 4 parameter:
74+
You must provide 4 parameter, replace the values of:
7375

74-
* `<FUNCTION_NAME>` = Lambda function name
75-
* `<FUNCTION_FILE>` = The path to the JAR or ZIP file where the code of the Lambda function is located
76-
* `<FUNCTION_ROLE>` = The role ARN that has Lambda permissions
77-
* `<FUNCTION_HANDLER>` = The fully qualifed method name (Ex: example.Handler::handleRequest)
76+
* `<FUNCTION_NAME>` by Lambda function name.
77+
* `<FUNCTION_FILE>` by path to the JAR or ZIP file where the code of the Lambda function is located.
78+
* `<FUNCTION_ROLE>` by role ARN that has Lambda permissions.
79+
* `<FUNCTION_HANDLER>` by fully qualifed method name (Ex: example.Handler::handleRequest).
7880

7981
Run application:
8082

8183
```bash
82-
java -jar awslambdacreate.jar lambda-name lambda-file lambda-role lambda-handler
84+
java -jar awslambdacreate.jar <FUNCTION_NAME> <FUNCTION_FILE> <FUNCTION_ROLE> <FUNCTION_HANDLER>
8385
```
8486

8587
You must use as a function role the ARN.

Diff for: awslambdadelete/README.md

+16-14
Original file line numberDiff line numberDiff line change
@@ -24,41 +24,43 @@ Delete an AWS Lambda function.
2424

2525
Setting your credentials for use by the AWS SDK for Java can be done in a number of ways, but here are the recommended approaches:
2626

27-
* The default credential profiles file
27+
* The default credential profiles file.
2828

2929
Set credentials in the AWS credentials profile file on your local system, located at:
3030

31-
`~/.aws/credentials` on Linux, macOS, or Unix
31+
* `~/.aws/credentials` on Linux, macOS, or Unix.
3232

33-
`C:\Users\USERNAME\.aws\credentials` on Windows
33+
* `C:\Users\USERNAME\.aws\credentials` on Windows.
3434

3535
This file should contain lines in the following format:
3636

3737
```bash
3838
[default]
39-
aws_access_key_id = <your_access_key_id>
40-
aws_secret_access_key = <your_secret_access_key>
39+
aws_access_key_id = <YOUR_ACCESS_KEY_ID>
40+
aws_secret_access_key = <YOUR_SECRET_ACCESS_KEY>
4141
```
42-
Substitute your own AWS credentials values for the values `<your_access_key_id>` and `<your_secret_access_key>`.
42+
Replace the values of `<YOUR_ACCESS_KEY_ID>` and `<YOUR_SECRET_ACCESS_KEY>` by your AWS credentials.
4343

44-
* Environment variables `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY`
44+
* Environment variables `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY`.
4545

4646
Set the `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` environment variables.
4747

4848
To set these variables on Linux, macOS, or Unix, use `export`:
4949

5050
```bash
51-
export AWS_ACCESS_KEY_ID=<your_access_key_id>
52-
export AWS_SECRET_ACCESS_KEY=<your_secret_access_key>
51+
export AWS_ACCESS_KEY_ID=<YOUR_ACCESS_KEY_ID>
52+
export AWS_SECRET_ACCESS_KEY=<YOUR_SECRET_ACCESS_KEY>
5353
```
5454

5555
To set these variables on Windows, use `set`:
5656

5757
```bash
58-
set AWS_ACCESS_KEY_ID=<your_access_key_id>
59-
set AWS_SECRET_ACCESS_KEY=<your_secret_access_key>
58+
set AWS_ACCESS_KEY_ID=<YOUR_ACCESS_KEY_ID>
59+
set AWS_SECRET_ACCESS_KEY=<YOUR_SECRET_ACCESS_KEY>
6060
```
6161

62+
Replace the values of `<YOUR_ACCESS_KEY_ID>` and `<YOUR_SECRET_ACCESS_KEY>` by your AWS credentials.
63+
6264
* You can create a Lambda function on AWS.
6365

6466
You can use the AWS Lambda Function Hello World JSON Java example: [awslambdahellojson](/awslambdahellojson).
@@ -67,14 +69,14 @@ Delete an AWS Lambda function.
6769

6870
* Run the code.
6971

70-
You must provide 1 parameter:
72+
You must provide 1 parameter, replace the value of:
7173

72-
* `<FUNCTION_NAME>` = Lambda function name
74+
* `<FUNCTION_NAME>` by Lambda function name.
7375

7476
Run application:
7577

7678
```bash
77-
java -jar awslambdadelete.jar lambda-function
79+
java -jar awslambdadelete.jar <FUNCTION_NAME>
7880
```
7981

8082
You can use as name of the Lambda function 2 name formats:

Diff for: awslambdainvoke/README.md

+16-14
Original file line numberDiff line numberDiff line change
@@ -24,41 +24,43 @@ Invoke an AWS Lambda function.
2424

2525
Setting your credentials for use by the AWS SDK for Java can be done in a number of ways, but here are the recommended approaches:
2626

27-
* The default credential profiles file
27+
* The default credential profiles file.
2828

2929
Set credentials in the AWS credentials profile file on your local system, located at:
3030

31-
`~/.aws/credentials` on Linux, macOS, or Unix
31+
* `~/.aws/credentials` on Linux, macOS, or Unix.
3232

33-
`C:\Users\USERNAME\.aws\credentials` on Windows
33+
* `C:\Users\USERNAME\.aws\credentials` on Windows.
3434

3535
This file should contain lines in the following format:
3636

3737
```bash
3838
[default]
39-
aws_access_key_id = <your_access_key_id>
40-
aws_secret_access_key = <your_secret_access_key>
39+
aws_access_key_id = <YOUR_ACCESS_KEY_ID>
40+
aws_secret_access_key = <YOUR_SECRET_ACCESS_KEY>
4141
```
42-
Substitute your own AWS credentials values for the values `<your_access_key_id>` and `<your_secret_access_key>`.
42+
Replace the values of `<YOUR_ACCESS_KEY_ID>` and `<YOUR_SECRET_ACCESS_KEY>` by your AWS credentials.
4343

44-
* Environment variables `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY`
44+
* Environment variables `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY`.
4545

4646
Set the `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` environment variables.
4747

4848
To set these variables on Linux, macOS, or Unix, use `export`:
4949

5050
```bash
51-
export AWS_ACCESS_KEY_ID=<your_access_key_id>
52-
export AWS_SECRET_ACCESS_KEY=<your_secret_access_key>
51+
export AWS_ACCESS_KEY_ID=<YOUR_ACCESS_KEY_ID>
52+
export AWS_SECRET_ACCESS_KEY=<YOUR_SECRET_ACCESS_KEY>
5353
```
5454

5555
To set these variables on Windows, use `set`:
5656

5757
```bash
58-
set AWS_ACCESS_KEY_ID=<your_access_key_id>
59-
set AWS_SECRET_ACCESS_KEY=<your_secret_access_key>
58+
set AWS_ACCESS_KEY_ID=<YOUR_ACCESS_KEY_ID>
59+
set AWS_SECRET_ACCESS_KEY=<YOUR_SECRET_ACCESS_KEY>
6060
```
6161

62+
Replace the values of `<YOUR_ACCESS_KEY_ID>` and `<YOUR_SECRET_ACCESS_KEY>` by your AWS credentials.
63+
6264
* You can create a Lambda function on AWS.
6365

6466
You can use the AWS Lambda Function Hello World JSON Java example: [awslambdahellojson](/awslambdahellojson).
@@ -76,14 +78,14 @@ Invoke an AWS Lambda function.
7678

7779
* Run the code.
7880

79-
You must provide 1 parameter:
81+
You must provide 1 parameter, replace the value of:
8082

81-
* `<FUNCTION_NAME>` = Lambda function name
83+
* `<FUNCTION_NAME>` by Lambda function name.
8284

8385
Run application:
8486

8587
```bash
86-
java -jar awslambdainvoke.jar lambda-function
88+
java -jar awslambdainvoke.jar <FUNCTION_NAME>
8789
```
8890

8991
You can use as name of the Lambda function 2 name formats:

Diff for: awslambdalist/README.md

+16-14
Original file line numberDiff line numberDiff line change
@@ -24,41 +24,43 @@ List information of an AWS Lambda function.
2424

2525
Setting your credentials for use by the AWS SDK for Java can be done in a number of ways, but here are the recommended approaches:
2626

27-
* The default credential profiles file
27+
* The default credential profiles file.
2828

2929
Set credentials in the AWS credentials profile file on your local system, located at:
3030

31-
`~/.aws/credentials` on Linux, macOS, or Unix
31+
* `~/.aws/credentials` on Linux, macOS, or Unix.
3232

33-
`C:\Users\USERNAME\.aws\credentials` on Windows
33+
* `C:\Users\USERNAME\.aws\credentials` on Windows.
3434

3535
This file should contain lines in the following format:
3636

3737
```bash
3838
[default]
39-
aws_access_key_id = <your_access_key_id>
40-
aws_secret_access_key = <your_secret_access_key>
39+
aws_access_key_id = <YOUR_ACCESS_KEY_ID>
40+
aws_secret_access_key = <YOUR_SECRET_ACCESS_KEY>
4141
```
42-
Substitute your own AWS credentials values for the values `<your_access_key_id>` and `<your_secret_access_key>`.
42+
Replace the values of `<YOUR_ACCESS_KEY_ID>` and `<YOUR_SECRET_ACCESS_KEY>` by your AWS credentials.
4343

44-
* Environment variables `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY`
44+
* Environment variables `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY`.
4545

4646
Set the `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` environment variables.
4747

4848
To set these variables on Linux, macOS, or Unix, use `export`:
4949

5050
```bash
51-
export AWS_ACCESS_KEY_ID=<your_access_key_id>
52-
export AWS_SECRET_ACCESS_KEY=<your_secret_access_key>
51+
export AWS_ACCESS_KEY_ID=<YOUR_ACCESS_KEY_ID>
52+
export AWS_SECRET_ACCESS_KEY=<YOUR_SECRET_ACCESS_KEY>
5353
```
5454

5555
To set these variables on Windows, use `set`:
5656

5757
```bash
58-
set AWS_ACCESS_KEY_ID=<your_access_key_id>
59-
set AWS_SECRET_ACCESS_KEY=<your_secret_access_key>
58+
set AWS_ACCESS_KEY_ID=<YOUR_ACCESS_KEY_ID>
59+
set AWS_SECRET_ACCESS_KEY=<YOUR_SECRET_ACCESS_KEY>
6060
```
6161

62+
Replace the values of `<YOUR_ACCESS_KEY_ID>` and `<YOUR_SECRET_ACCESS_KEY>` by your AWS credentials.
63+
6264
* You can create a Lambda function on AWS.
6365

6466
You can use the AWS Lambda Function Hello World JSON Java example: [awslambdahellojson](/awslambdahellojson).
@@ -67,14 +69,14 @@ List information of an AWS Lambda function.
6769

6870
* Run the code.
6971

70-
You must provide 1 parameter:
72+
You must provide 1 parameter, replace the value of:
7173

72-
* `<FUNCTION_NAME>` = Lambda function name
74+
* `<FUNCTION_NAME>` by Lambda function name.
7375

7476
Run application:
7577

7678
```bash
77-
java -jar awslambdalist.jar lambda-function
79+
java -jar awslambdalist.jar <FUNCTION_NAME>
7880
```
7981

8082
You can use as Lambda function name 2 options:

0 commit comments

Comments
 (0)