Skip to content

Commit 176c27a

Browse files
authored
Update README.md
1 parent 78995f8 commit 176c27a

1 file changed

Lines changed: 68 additions & 0 deletions

File tree

README.md

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,74 @@ Changes to the SDK beginning with version 1.12.1 (June 2021) are tracked in [CHA
2222
Changes in the _retired_ 1.11.x series of the SDK, beginning with version 1.11.82,
2323
are listed in the [CHANGELOG-1.11.x.md](./changelogs/CHANGELOG-1.11.x.md) file.
2424

25+
## Getting Started with AWS
26+
27+
Use [the AWS SDK for Java 2.x to get started][sdk-v2-getting-started].
28+
29+
## Using the AWS SDK for Java 1.x
30+
31+
The AWS SDK for Java 1.x is in [maintenance mode][maintenance-mode-post], so we recommend that you use the
32+
[AWS SDK for Java 2.x][aws-sdk-for-java-2x].
33+
34+
#### Minimum requirements ####
35+
36+
To run the AWS SDK for Java 1.x, you will need **Java 1.8+**. For more information about the requirements and optimum
37+
settings for the SDK, please see the [Installing a Java Development Environment][docs-java-env]
38+
section of the developer guide.
39+
40+
#### Install the 1.x SDK ####
41+
42+
You can use the AWS SDK for Java 1.x in your project by consuming it from Maven. Import
43+
the [aws-java-sdk-bom][] and specify the SDK Maven modules that your project needs in the
44+
dependencies.
45+
46+
##### Importing the 1.x BOM #####
47+
48+
```xml
49+
<dependencyManagement>
50+
<dependencies>
51+
<dependency>
52+
<groupId>com.amazonaws</groupId>
53+
<artifactId>aws-java-sdk-bom</artifactId>
54+
<version>1.12.797</version>
55+
<type>pom</type>
56+
<scope>import</scope>
57+
</dependency>
58+
</dependencies>
59+
</dependencyManagement>
60+
```
61+
62+
##### Using the 1.x SDK Maven modules #####
63+
64+
```xml
65+
<dependencies>
66+
<dependency>
67+
<groupId>com.amazonaws</groupId>
68+
<artifactId>aws-java-sdk-ec2</artifactId>
69+
</dependency>
70+
<dependency>
71+
<groupId>com.amazonaws</groupId>
72+
<artifactId>aws-java-sdk-s3</artifactId>
73+
</dependency>
74+
<dependency>
75+
<groupId>com.amazonaws</groupId>
76+
<artifactId>aws-java-sdk-dynamodb</artifactId>
77+
</dependency>
78+
</dependencies>
79+
```
80+
81+
See the [Set up the AWS SDK for Java 1.x][docs-setup] section of the developer guide for more
82+
information about installing the 1.x SDK through other means.
83+
84+
## Building From Source
85+
86+
Once you check out the code from GitHub, you can build it using Maven. To disable the GPG-signing
87+
in the build, use:
88+
89+
```sh
90+
mvn clean install -Dgpg.skip=true
91+
```
92+
2593
## Maintenance and Support for SDK Major Versions
2694

2795
For information about maintenance and support for SDK major versions and their underlying dependencies, see the following in the AWS SDKs and Tools Reference Guide:

0 commit comments

Comments
 (0)