Skip to content

Commit 28b5215

Browse files
author
awstools
committed
feat(client-oam): This release introduces support for Source Accounts to define which Metrics and Logs to share with the Monitoring Account
1 parent e30cf9a commit 28b5215

16 files changed

+449
-106
lines changed

Diff for: ‎clients/client-oam/src/OAM.ts

+9-9
Original file line numberDiff line numberDiff line change
@@ -240,16 +240,16 @@ export interface OAM {
240240

241241
/**
242242
* <p>Use Amazon CloudWatch Observability Access Manager to create and manage links between source accounts and
243-
* monitoring accounts by using <i>CloudWatch cross-account observability</i>. With
244-
* CloudWatch cross-account observability, you can monitor and troubleshoot applications that span
245-
* multiple accounts within a Region. Seamlessly search, visualize, and analyze your metrics,
246-
* logs, traces, and Application Insights applications in any of the linked accounts without account boundaries.</p>
243+
* monitoring accounts by using <i>CloudWatch cross-account observability</i>. With
244+
* CloudWatch cross-account observability, you can monitor and troubleshoot applications that span
245+
* multiple accounts within a Region. Seamlessly search, visualize, and analyze your metrics,
246+
* logs, traces, and Application Insights applications in any of the linked accounts without account boundaries.</p>
247247
* <p>Set up one or more Amazon Web Services accounts as <i>monitoring
248-
* accounts</i> and link them with multiple <i>source accounts</i>. A
249-
* monitoring account is a central Amazon Web Services account that can view and interact with
250-
* observability data generated from source accounts. A source account is an individual Amazon Web Services account that generates observability data for the resources that reside in it.
251-
* Source accounts share their observability data with the monitoring account. The shared
252-
* observability data can include metrics in Amazon CloudWatch, logs in Amazon CloudWatch Logs, traces in X-Ray, and applications in Amazon CloudWatch Application Insights.</p>
248+
* accounts</i> and link them with multiple <i>source accounts</i>. A
249+
* monitoring account is a central Amazon Web Services account that can view and interact with
250+
* observability data generated from source accounts. A source account is an individual Amazon Web Services account that generates observability data for the resources that reside in it.
251+
* Source accounts share their observability data with the monitoring account. The shared
252+
* observability data can include metrics in Amazon CloudWatch, logs in Amazon CloudWatch Logs, traces in X-Ray, and applications in Amazon CloudWatch Application Insights.</p>
253253
* @public
254254
*/
255255
export class OAM extends OAMClient implements OAM {}

Diff for: ‎clients/client-oam/src/OAMClient.ts

+9-9
Original file line numberDiff line numberDiff line change
@@ -295,16 +295,16 @@ export interface OAMClientResolvedConfig extends OAMClientResolvedConfigType {}
295295

296296
/**
297297
* <p>Use Amazon CloudWatch Observability Access Manager to create and manage links between source accounts and
298-
* monitoring accounts by using <i>CloudWatch cross-account observability</i>. With
299-
* CloudWatch cross-account observability, you can monitor and troubleshoot applications that span
300-
* multiple accounts within a Region. Seamlessly search, visualize, and analyze your metrics,
301-
* logs, traces, and Application Insights applications in any of the linked accounts without account boundaries.</p>
298+
* monitoring accounts by using <i>CloudWatch cross-account observability</i>. With
299+
* CloudWatch cross-account observability, you can monitor and troubleshoot applications that span
300+
* multiple accounts within a Region. Seamlessly search, visualize, and analyze your metrics,
301+
* logs, traces, and Application Insights applications in any of the linked accounts without account boundaries.</p>
302302
* <p>Set up one or more Amazon Web Services accounts as <i>monitoring
303-
* accounts</i> and link them with multiple <i>source accounts</i>. A
304-
* monitoring account is a central Amazon Web Services account that can view and interact with
305-
* observability data generated from source accounts. A source account is an individual Amazon Web Services account that generates observability data for the resources that reside in it.
306-
* Source accounts share their observability data with the monitoring account. The shared
307-
* observability data can include metrics in Amazon CloudWatch, logs in Amazon CloudWatch Logs, traces in X-Ray, and applications in Amazon CloudWatch Application Insights.</p>
303+
* accounts</i> and link them with multiple <i>source accounts</i>. A
304+
* monitoring account is a central Amazon Web Services account that can view and interact with
305+
* observability data generated from source accounts. A source account is an individual Amazon Web Services account that generates observability data for the resources that reside in it.
306+
* Source accounts share their observability data with the monitoring account. The shared
307+
* observability data can include metrics in Amazon CloudWatch, logs in Amazon CloudWatch Logs, traces in X-Ray, and applications in Amazon CloudWatch Application Insights.</p>
308308
* @public
309309
*/
310310
export class OAMClient extends __Client<

Diff for: ‎clients/client-oam/src/commands/CreateLinkCommand.ts

+24-6
Original file line numberDiff line numberDiff line change
@@ -27,14 +27,16 @@ export interface CreateLinkCommandInput extends CreateLinkInput {}
2727
export interface CreateLinkCommandOutput extends CreateLinkOutput, __MetadataBearer {}
2828

2929
/**
30-
* <p>Creates a link between a source account and a sink that you have created in a monitoring account.</p>
30+
* <p>Creates a link between a source account and a sink that you have created in a monitoring account. After the link is created,
31+
* data is sent from the source account to the monitoring account. When you create a link, you can optionally specify filters
32+
* that specify which metric namespaces and which log groups are shared from the source account to the monitoring account.</p>
3133
* <p>Before you create a link, you must create a sink in the monitoring account and create a
32-
* sink policy in that account. The sink policy must permit the source account to link to it. You
33-
* can grant permission to source accounts by granting permission to an entire organization or to
34-
* individual accounts.</p>
34+
* sink policy in that account. The sink policy must permit the source account to link to it. You
35+
* can grant permission to source accounts by granting permission to an entire organization or to
36+
* individual accounts.</p>
3537
* <p>For more information, see
36-
* <a href="https://docs.aws.amazon.com/OAM/latest/APIReference/API_CreateSink.html">CreateSink</a> and
37-
* <a href="https://docs.aws.amazon.com/OAM/latest/APIReference/API_PutSinkPolicy.html">PutSinkPolicy</a>.</p>
38+
* <a href="https://docs.aws.amazon.com/OAM/latest/APIReference/API_CreateSink.html">CreateSink</a> and
39+
* <a href="https://docs.aws.amazon.com/OAM/latest/APIReference/API_PutSinkPolicy.html">PutSinkPolicy</a>.</p>
3840
* <p>Each monitoring account can be linked to as many as 100,000 source accounts.</p>
3941
* <p>Each source account can be linked to as many as five monitoring accounts.</p>
4042
* @example
@@ -52,6 +54,14 @@ export interface CreateLinkCommandOutput extends CreateLinkOutput, __MetadataBea
5254
* Tags: { // TagMapInput
5355
* "<keys>": "STRING_VALUE",
5456
* },
57+
* LinkConfiguration: { // LinkConfiguration
58+
* LogGroupConfiguration: { // LogGroupConfiguration
59+
* Filter: "STRING_VALUE", // required
60+
* },
61+
* MetricConfiguration: { // MetricConfiguration
62+
* Filter: "STRING_VALUE", // required
63+
* },
64+
* },
5565
* };
5666
* const command = new CreateLinkCommand(input);
5767
* const response = await client.send(command);
@@ -67,6 +77,14 @@ export interface CreateLinkCommandOutput extends CreateLinkOutput, __MetadataBea
6777
* // Tags: { // TagMapOutput
6878
* // "<keys>": "STRING_VALUE",
6979
* // },
80+
* // LinkConfiguration: { // LinkConfiguration
81+
* // LogGroupConfiguration: { // LogGroupConfiguration
82+
* // Filter: "STRING_VALUE", // required
83+
* // },
84+
* // MetricConfiguration: { // MetricConfiguration
85+
* // Filter: "STRING_VALUE", // required
86+
* // },
87+
* // },
7088
* // };
7189
*
7290
* ```

Diff for: ‎clients/client-oam/src/commands/CreateSinkCommand.ts

+5-5
Original file line numberDiff line numberDiff line change
@@ -28,12 +28,12 @@ export interface CreateSinkCommandOutput extends CreateSinkOutput, __MetadataBea
2828

2929
/**
3030
* <p>Use this to create a <i>sink</i> in the current account, so that it can be
31-
* used as a monitoring account in CloudWatch cross-account observability. A sink is a resource that
32-
* represents an attachment point in a monitoring account. Source accounts can link to the sink
33-
* to send observability data.</p>
31+
* used as a monitoring account in CloudWatch cross-account observability. A sink is a resource that
32+
* represents an attachment point in a monitoring account. Source accounts can link to the sink
33+
* to send observability data.</p>
3434
* <p>After you create a sink, you must create a sink policy that allows source accounts to attach to it.
35-
* For more information, see <a href="https://docs.aws.amazon.com/OAM/latest/APIReference/API_PutSinkPolicy.html">PutSinkPolicy</a>.</p>
36-
* <p>Each account can contain one sink. If you delete a sink, you can then create a new one in that account.</p>
35+
* For more information, see <a href="https://docs.aws.amazon.com/OAM/latest/APIReference/API_PutSinkPolicy.html">PutSinkPolicy</a>.</p>
36+
* <p>Each account can contain one sink per Region. If you delete a sink, you can then create a new one in that Region.</p>
3737
* @example
3838
* Use a bare-bones client and the command you need to make an API call.
3939
* ```javascript

Diff for: ‎clients/client-oam/src/commands/DeleteLinkCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ export interface DeleteLinkCommandOutput extends DeleteLinkOutput, __MetadataBea
2828

2929
/**
3030
* <p>Deletes a link between a monitoring account sink and a source account. You must run this operation
31-
* in the source account.</p>
31+
* in the source account.</p>
3232
* @example
3333
* Use a bare-bones client and the command you need to make an API call.
3434
* ```javascript

Diff for: ‎clients/client-oam/src/commands/GetLinkCommand.ts

+8
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,14 @@ export interface GetLinkCommandOutput extends GetLinkOutput, __MetadataBearer {}
5252
* // Tags: { // TagMapOutput
5353
* // "<keys>": "STRING_VALUE",
5454
* // },
55+
* // LinkConfiguration: { // LinkConfiguration
56+
* // LogGroupConfiguration: { // LogGroupConfiguration
57+
* // Filter: "STRING_VALUE", // required
58+
* // },
59+
* // MetricConfiguration: { // MetricConfiguration
60+
* // Filter: "STRING_VALUE", // required
61+
* // },
62+
* // },
5563
* // };
5664
*
5765
* ```

Diff for: ‎clients/client-oam/src/commands/GetSinkPolicyCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ export interface GetSinkPolicyCommandOutput extends GetSinkPolicyOutput, __Metad
2828

2929
/**
3030
* <p>Returns the current sink policy attached to this sink. The sink policy specifies what
31-
* accounts can attach to this sink as source accounts, and what types of data they can share.</p>
31+
* accounts can attach to this sink as source accounts, and what types of data they can share.</p>
3232
* @example
3333
* Use a bare-bones client and the command you need to make an API call.
3434
* ```javascript

Diff for: ‎clients/client-oam/src/commands/ListLinksCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ export interface ListLinksCommandOutput extends ListLinksOutput, __MetadataBeare
2828

2929
/**
3030
* <p>Use this operation in a source account to return a list of links to monitoring account sinks that
31-
* this source account has.</p>
31+
* this source account has.</p>
3232
* <p>To find a list of links for one monitoring account sink, use <a href="https://docs.aws.amazon.com/OAM/latest/APIReference/API_ListAttachedLinks.html">ListAttachedLinks</a> from within the monitoring account.</p>
3333
* @example
3434
* Use a bare-bones client and the command you need to make an API call.

Diff for: ‎clients/client-oam/src/commands/PutSinkPolicyCommand.ts

+4-4
Original file line numberDiff line numberDiff line change
@@ -28,15 +28,15 @@ export interface PutSinkPolicyCommandOutput extends PutSinkPolicyOutput, __Metad
2828

2929
/**
3030
* <p>Creates or updates the resource policy that grants permissions to source
31-
* accounts to link to the monitoring account sink. When you create a sink policy, you can grant
32-
* permissions to all accounts in an organization or to individual accounts.</p>
31+
* accounts to link to the monitoring account sink. When you create a sink policy, you can grant
32+
* permissions to all accounts in an organization or to individual accounts.</p>
3333
* <p>You can also use a sink policy to limit the types of data that is shared. The three types that
34-
* you can allow or deny are:</p>
34+
* you can allow or deny are:</p>
3535
* <ul>
3636
* <li>
3737
* <p>
3838
* <b>Metrics</b> - Specify with
39-
* <code>AWS::CloudWatch::Metric</code>
39+
* <code>AWS::CloudWatch::Metric</code>
4040
* </p>
4141
* </li>
4242
* <li>

Diff for: ‎clients/client-oam/src/commands/TagResourceCommand.ts

+9-9
Original file line numberDiff line numberDiff line change
@@ -28,21 +28,21 @@ export interface TagResourceCommandOutput extends TagResourceOutput, __MetadataB
2828

2929
/**
3030
* <p>Assigns one or more tags (key-value pairs) to the specified resource.
31-
* Both sinks and links can be tagged. </p>
31+
* Both sinks and links can be tagged. </p>
3232
* <p>Tags can help you organize and categorize your resources. You can also use them to scope user
33-
* permissions by granting a user
34-
* permission to access or change only resources with certain tag values.</p>
33+
* permissions by granting a user
34+
* permission to access or change only resources with certain tag values.</p>
3535
* <p>Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.</p>
3636
* <p>You can use the <code>TagResource</code> action with a resource that already has tags. If you specify a new tag key for the alarm,
37-
* this tag is appended to the list of tags associated
38-
* with the alarm. If you specify a tag key that is already associated with the alarm, the new tag value that you specify replaces
39-
* the previous value for that tag.</p>
37+
* this tag is appended to the list of tags associated
38+
* with the alarm. If you specify a tag key that is already associated with the alarm, the new tag value that you specify replaces
39+
* the previous value for that tag.</p>
4040
* <p>You can associate as many as 50 tags with a resource.</p>
4141
* <important>
4242
* <p>Unlike tagging permissions in other Amazon Web Services services, to tag or untag links and
43-
* sinks you must have the <code>oam:ResourceTag</code> permission. The
44-
* <code>iam:ResourceTag</code> permission does not allow you to tag and untag links and
45-
* sinks.</p>
43+
* sinks you must have the <code>oam:ResourceTag</code> permission. The
44+
* <code>iam:ResourceTag</code> permission does not allow you to tag and untag links and
45+
* sinks.</p>
4646
* </important>
4747
* @example
4848
* Use a bare-bones client and the command you need to make an API call.

Diff for: ‎clients/client-oam/src/commands/UntagResourceCommand.ts

+3-3
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,9 @@ export interface UntagResourceCommandOutput extends UntagResourceOutput, __Metad
3030
* <p>Removes one or more tags from the specified resource.</p>
3131
* <important>
3232
* <p>Unlike tagging permissions in other Amazon Web Services services, to tag or untag links and
33-
* sinks you must have the <code>oam:ResourceTag</code> permission. The
34-
* <code>iam:TagResource</code> permission does not allow you to tag and untag links and
35-
* sinks.</p>
33+
* sinks you must have the <code>oam:ResourceTag</code> permission. The
34+
* <code>iam:TagResource</code> permission does not allow you to tag and untag links and
35+
* sinks.</p>
3636
* </important>
3737
* @example
3838
* Use a bare-bones client and the command you need to make an API call.

Diff for: ‎clients/client-oam/src/commands/UpdateLinkCommand.ts

+20-2
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,11 @@ export interface UpdateLinkCommandOutput extends UpdateLinkOutput, __MetadataBea
2828

2929
/**
3030
* <p>Use this operation to change what types of data are shared from a source account to its linked
31-
* monitoring account sink. You can't change the sink or change the monitoring account with this operation.</p>
31+
* monitoring account sink. You can't change the sink or change the monitoring account with this operation.</p>
32+
* <p>When you update a link, you can optionally specify filters
33+
* that specify which metric namespaces and which log groups are shared from the source account to the monitoring account.</p>
3234
* <p>To update the list of tags associated with the sink, use
33-
* <a href="https://docs.aws.amazon.com/OAM/latest/APIReference/API_TagResource.html">TagResource</a>.</p>
35+
* <a href="https://docs.aws.amazon.com/OAM/latest/APIReference/API_TagResource.html">TagResource</a>.</p>
3436
* @example
3537
* Use a bare-bones client and the command you need to make an API call.
3638
* ```javascript
@@ -42,6 +44,14 @@ export interface UpdateLinkCommandOutput extends UpdateLinkOutput, __MetadataBea
4244
* ResourceTypes: [ // ResourceTypesInput // required
4345
* "AWS::CloudWatch::Metric" || "AWS::Logs::LogGroup" || "AWS::XRay::Trace" || "AWS::ApplicationInsights::Application" || "AWS::InternetMonitor::Monitor",
4446
* ],
47+
* LinkConfiguration: { // LinkConfiguration
48+
* LogGroupConfiguration: { // LogGroupConfiguration
49+
* Filter: "STRING_VALUE", // required
50+
* },
51+
* MetricConfiguration: { // MetricConfiguration
52+
* Filter: "STRING_VALUE", // required
53+
* },
54+
* },
4555
* };
4656
* const command = new UpdateLinkCommand(input);
4757
* const response = await client.send(command);
@@ -57,6 +67,14 @@ export interface UpdateLinkCommandOutput extends UpdateLinkOutput, __MetadataBea
5767
* // Tags: { // TagMapOutput
5868
* // "<keys>": "STRING_VALUE",
5969
* // },
70+
* // LinkConfiguration: { // LinkConfiguration
71+
* // LogGroupConfiguration: { // LogGroupConfiguration
72+
* // Filter: "STRING_VALUE", // required
73+
* // },
74+
* // MetricConfiguration: { // MetricConfiguration
75+
* // Filter: "STRING_VALUE", // required
76+
* // },
77+
* // },
6078
* // };
6179
*
6280
* ```

0 commit comments

Comments
 (0)