Skip to content

Commit 8109123

Browse files
committed
updated v1 RS Readme
1 parent d096e69 commit 8109123

File tree

1 file changed

+114
-0
lines changed

1 file changed

+114
-0
lines changed
Lines changed: 114 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,114 @@
1+
# Amazon Redshift code examples for the SDK for Java 2.x
2+
3+
## Overview
4+
5+
Shows how to use the AWS SDK for Java 2.x to work with Amazon Redshift.
6+
7+
<!--custom.overview.start-->
8+
<!--custom.overview.end-->
9+
10+
_Amazon Redshift is a fast, fully managed, petabyte-scale data warehouse service that makes it simple and cost-effective to efficiently analyze all your data using your existing business intelligence tools._
11+
12+
## ⚠ Important
13+
14+
* Running this code might result in charges to your AWS account. For more details, see [AWS Pricing](https://aws.amazon.com/pricing/) and [Free Tier](https://aws.amazon.com/free/).
15+
* Running the tests might result in charges to your AWS account.
16+
* We recommend that you grant your code least privilege. At most, grant only the minimum permissions required to perform the task. For more information, see [Grant least privilege](https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#grant-least-privilege).
17+
* This code is not tested in every AWS Region. For more information, see [AWS Regional Services](https://aws.amazon.com/about-aws/global-infrastructure/regional-product-services).
18+
19+
<!--custom.important.start-->
20+
<!--custom.important.end-->
21+
22+
## Code examples
23+
24+
### Prerequisites
25+
26+
For prerequisites, see the [README](../../README.md#Prerequisites) in the `javav2` folder.
27+
28+
29+
<!--custom.prerequisites.start-->
30+
<!--custom.prerequisites.end-->
31+
32+
### Get started
33+
34+
- [Hello Amazon Redshift](src/main/java/com/example/redshift/HelloRedshift.java#L6) (`describeClusters`)
35+
36+
37+
### Basics
38+
39+
Code examples that show you how to perform the essential operations within a service.
40+
41+
- [Learn the basics](src/main/java/com/example/scenario/RedshiftScenario.java)
42+
43+
44+
### Single actions
45+
46+
Code excerpts that show you how to call individual service functions.
47+
48+
- [CreateCluster](src/main/java/com/example/scenario/RedshiftScenario.java#L498)
49+
- [CreateTable](src/main/java/com/example/scenario/RedshiftScenario.java#L475)
50+
- [DeleteCluster](src/main/java/com/example/scenario/RedshiftScenario.java#L247)
51+
- [DescribeClusters](src/main/java/com/example/scenario/RedshiftScenario.java#L430)
52+
- [DescribeStatement](src/main/java/com/example/scenario/RedshiftScenario.java#L324)
53+
- [GetStatementResult](src/main/java/com/example/scenario/RedshiftScenario.java#L408)
54+
- [Insert](src/main/java/com/example/scenario/RedshiftScenario.java#L265)
55+
- [ModifyCluster](src/main/java/com/example/scenario/RedshiftScenario.java#L356)
56+
- [Query](src/main/java/com/example/scenario/RedshiftScenario.java#L375)
57+
58+
59+
<!--custom.examples.start-->
60+
<!--custom.examples.end-->
61+
62+
## Run the examples
63+
64+
### Instructions
65+
66+
67+
<!--custom.instructions.start-->
68+
<!--custom.instructions.end-->
69+
70+
#### Hello Amazon Redshift
71+
72+
This example shows you how to get started using Amazon Redshift.
73+
74+
75+
#### Learn the basics
76+
77+
This example shows you how to work with Amazon Redshift tables, items, and queries.
78+
79+
80+
<!--custom.basic_prereqs.redshift_Scenario.start-->
81+
<!--custom.basic_prereqs.redshift_Scenario.end-->
82+
83+
84+
<!--custom.basics.redshift_Scenario.start-->
85+
<!--custom.basics.redshift_Scenario.end-->
86+
87+
88+
### Tests
89+
90+
⚠ Running tests might result in charges to your AWS account.
91+
92+
93+
To find instructions for running these tests, see the [README](../../README.md#Tests)
94+
in the `javav2` folder.
95+
96+
97+
98+
<!--custom.tests.start-->
99+
<!--custom.tests.end-->
100+
101+
## Additional resources
102+
103+
- [Amazon Redshift Management Guide](https://docs.aws.amazon.com/redshift/latest/mgmt/welcome.html)
104+
- [Amazon Redshift API Reference](https://docs.aws.amazon.com/redshift/latest/APIReference/Welcome.html)
105+
- [SDK for Java 2.x Amazon Redshift reference](https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/redshift/package-summary.html)
106+
107+
<!--custom.resources.start-->
108+
<!--custom.resources.end-->
109+
110+
---
111+
112+
Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
113+
114+
SPDX-License-Identifier: Apache-2.0

0 commit comments

Comments
 (0)