Skip to content

Commit ec5fb0b

Browse files
authored
Java V2 Add examples for Control Tower (#7668)
1 parent 6b5cea3 commit ec5fb0b

7 files changed

Lines changed: 1954 additions & 0 deletions

File tree

.doc_gen/metadata/controltower_metadata.yaml

Lines changed: 118 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,15 @@ controltower_Hello:
44
synopsis: get started using &CTower;.
55
category: Hello
66
languages:
7+
Java:
8+
versions:
9+
- sdk_version: 2
10+
github: javav2/example_code/controltower
11+
sdkguide:
12+
excerpts:
13+
- description:
14+
snippet_tags:
15+
- controltower.java2.hello.main
716
Python:
817
versions:
918
- sdk_version: 3
@@ -25,6 +34,15 @@ controltower_Hello:
2534

2635
controltower_ListBaselines:
2736
languages:
37+
Java:
38+
versions:
39+
- sdk_version: 2
40+
github: javav2/example_code/controltower
41+
sdkguide:
42+
excerpts:
43+
- description:
44+
snippet_tags:
45+
- controltower.java2.list_baselines.main
2846
Python:
2947
versions:
3048
- sdk_version: 3
@@ -47,6 +65,15 @@ controltower_ListBaselines:
4765

4866
controltower_ListEnabledBaselines:
4967
languages:
68+
Java:
69+
versions:
70+
- sdk_version: 2
71+
github: javav2/example_code/controltower
72+
sdkguide:
73+
excerpts:
74+
- description:
75+
snippet_tags:
76+
- controltower.java2.list_enabled_baselines.main
5077
Python:
5178
versions:
5279
- sdk_version: 3
@@ -69,6 +96,15 @@ controltower_ListEnabledBaselines:
6996

7097
controltower_EnableBaseline:
7198
languages:
99+
Java:
100+
versions:
101+
- sdk_version: 2
102+
github: javav2/example_code/controltower
103+
sdkguide:
104+
excerpts:
105+
- description:
106+
snippet_tags:
107+
- controltower.java2.enable_baseline.main
72108
Python:
73109
versions:
74110
- sdk_version: 3
@@ -91,6 +127,15 @@ controltower_EnableBaseline:
91127

92128
controltower_ResetEnabledBaseline:
93129
languages:
130+
Java:
131+
versions:
132+
- sdk_version: 2
133+
github: javav2/example_code/controltower
134+
sdkguide:
135+
excerpts:
136+
- description:
137+
snippet_tags:
138+
- controltower.java2.reset_enabled_baseline.main
94139
Python:
95140
versions:
96141
- sdk_version: 3
@@ -113,6 +158,15 @@ controltower_ResetEnabledBaseline:
113158

114159
controltower_DisableBaseline:
115160
languages:
161+
Java:
162+
versions:
163+
- sdk_version: 2
164+
github: javav2/example_code/controltower
165+
sdkguide:
166+
excerpts:
167+
- description:
168+
snippet_tags:
169+
- controltower.java2.disable_baseline.main
116170
Python:
117171
versions:
118172
- sdk_version: 3
@@ -135,6 +189,15 @@ controltower_DisableBaseline:
135189

136190
controltower_ListEnabledControls:
137191
languages:
192+
Java:
193+
versions:
194+
- sdk_version: 2
195+
github: javav2/example_code/controltower
196+
sdkguide:
197+
excerpts:
198+
- description:
199+
snippet_tags:
200+
- controltower.java2.list_enabled_controls.main
138201
Python:
139202
versions:
140203
- sdk_version: 3
@@ -157,6 +220,15 @@ controltower_ListEnabledControls:
157220

158221
controltower_EnableControl:
159222
languages:
223+
Java:
224+
versions:
225+
- sdk_version: 2
226+
github: javav2/example_code/controltower
227+
sdkguide:
228+
excerpts:
229+
- description:
230+
snippet_tags:
231+
- controltower.java2.enable_control.main
160232
Python:
161233
versions:
162234
- sdk_version: 3
@@ -179,6 +251,15 @@ controltower_EnableControl:
179251

180252
controltower_GetControlOperation:
181253
languages:
254+
Java:
255+
versions:
256+
- sdk_version: 2
257+
github: javav2/example_code/controltower
258+
sdkguide:
259+
excerpts:
260+
- description:
261+
snippet_tags:
262+
- controltower.java2.get_control_operation.main
182263
Python:
183264
versions:
184265
- sdk_version: 3
@@ -201,6 +282,15 @@ controltower_GetControlOperation:
201282

202283
controltower_DisableControl:
203284
languages:
285+
Java:
286+
versions:
287+
- sdk_version: 2
288+
github: javav2/example_code/controltower
289+
sdkguide:
290+
excerpts:
291+
- description:
292+
snippet_tags:
293+
- controltower.java2.disable_control.main
204294
Python:
205295
versions:
206296
- sdk_version: 3
@@ -223,6 +313,15 @@ controltower_DisableControl:
223313

224314
controltower_ListLandingZones:
225315
languages:
316+
Java:
317+
versions:
318+
- sdk_version: 2
319+
github: javav2/example_code/controltower
320+
sdkguide:
321+
excerpts:
322+
- description:
323+
snippet_tags:
324+
- controltower.java2.list_landing_zones.main
226325
Python:
227326
versions:
228327
- sdk_version: 3
@@ -245,6 +344,15 @@ controltower_ListLandingZones:
245344

246345
controltower_GetBaselineOperation:
247346
languages:
347+
Java:
348+
versions:
349+
- sdk_version: 2
350+
github: javav2/example_code/controltower
351+
sdkguide:
352+
excerpts:
353+
- description:
354+
snippet_tags:
355+
- controltower.java2.get_baseline_operation.main
248356
Python:
249357
versions:
250358
- sdk_version: 3
@@ -272,6 +380,16 @@ controltower_Scenario:
272380
- List, enable, get, and disable controls.
273381
category: Basics
274382
languages:
383+
Java:
384+
versions:
385+
- sdk_version: 2
386+
github: javav2/example_code/controltower
387+
sdkguide:
388+
excerpts:
389+
- description: Run an interactive scenario demonstrating &CTowerlong; features.
390+
snippet_tags:
391+
- controltower.java2.controltower_scenario.main
392+
- controltower.java2.controltower_actions.main
275393
Python:
276394
versions:
277395
- sdk_version: 3
Lines changed: 119 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,119 @@
1+
# AWS Control Tower 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 AWS Control Tower.
6+
7+
<!--custom.overview.start-->
8+
<!--custom.overview.end-->
9+
10+
_AWS Control Tower enables you to enforce and manage governance rules for security, operations, and compliance at scale across all your organizations and accounts._
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 AWS Control Tower](src/main/java/com/example/controltower/HelloControlTower.java#L27) (`ListBaselines`)
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/controltower/scenario/ControlTowerActions.java)
42+
43+
44+
### Single actions
45+
46+
Code excerpts that show you how to call individual service functions.
47+
48+
- [DisableBaseline](src/main/java/com/example/controltower/scenario/ControlTowerActions.java#L493)
49+
- [DisableControl](src/main/java/com/example/controltower/scenario/ControlTowerActions.java#L803)
50+
- [EnableBaseline](src/main/java/com/example/controltower/scenario/ControlTowerActions.java#L387)
51+
- [EnableControl](src/main/java/com/example/controltower/scenario/ControlTowerActions.java#L706)
52+
- [GetBaselineOperation](src/main/java/com/example/controltower/scenario/ControlTowerActions.java#L574)
53+
- [GetControlOperation](src/main/java/com/example/controltower/scenario/ControlTowerActions.java#L886)
54+
- [ListBaselines](src/main/java/com/example/controltower/scenario/ControlTowerActions.java#L257)
55+
- [ListEnabledBaselines](src/main/java/com/example/controltower/scenario/ControlTowerActions.java#L317)
56+
- [ListEnabledControls](src/main/java/com/example/controltower/scenario/ControlTowerActions.java#L638)
57+
- [ListLandingZones](src/main/java/com/example/controltower/scenario/ControlTowerActions.java#L204)
58+
- [ResetEnabledBaseline](src/main/java/com/example/controltower/scenario/ControlTowerActions.java#L986)
59+
60+
61+
<!--custom.examples.start-->
62+
<!--custom.examples.end-->
63+
64+
## Run the examples
65+
66+
### Instructions
67+
68+
69+
<!--custom.instructions.start-->
70+
<!--custom.instructions.end-->
71+
72+
#### Hello AWS Control Tower
73+
74+
This example shows you how to get started using AWS Control Tower.
75+
76+
77+
#### Learn the basics
78+
79+
This example shows you how to do the following:
80+
81+
- List landing zones.
82+
- List, enable, get, reset, and disable baselines.
83+
- List, enable, get, and disable controls.
84+
85+
<!--custom.basic_prereqs.controltower_Scenario.start-->
86+
<!--custom.basic_prereqs.controltower_Scenario.end-->
87+
88+
89+
<!--custom.basics.controltower_Scenario.start-->
90+
<!--custom.basics.controltower_Scenario.end-->
91+
92+
93+
### Tests
94+
95+
⚠ Running tests might result in charges to your AWS account.
96+
97+
98+
To find instructions for running these tests, see the [README](../../README.md#Tests)
99+
in the `javav2` folder.
100+
101+
102+
103+
<!--custom.tests.start-->
104+
<!--custom.tests.end-->
105+
106+
## Additional resources
107+
108+
- [AWS Control Tower User Guide](https://docs.aws.amazon.com/controltower/latest/userguide/what-is-control-tower.html)
109+
- [AWS Control Tower API Reference](https://docs.aws.amazon.com/controltower/latest/APIReference/Welcome.html)
110+
- [SDK for Java 2.x AWS Control Tower reference](https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/controltower/package-summary.html)
111+
112+
<!--custom.resources.start-->
113+
<!--custom.resources.end-->
114+
115+
---
116+
117+
Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
118+
119+
SPDX-License-Identifier: Apache-2.0

0 commit comments

Comments
 (0)