@aws-sdk/client-config-service 3.454.0 → 3.458.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +92 -92
- package/dist-cjs/models/models_0.js +6 -15
- package/dist-cjs/models/models_1.js +14 -1
- package/dist-cjs/protocols/Aws_json1_1.js +8 -1
- package/dist-es/models/models_0.js +4 -12
- package/dist-es/models/models_1.js +12 -0
- package/dist-es/protocols/Aws_json1_1.js +9 -2
- package/dist-types/commands/BatchGetAggregateResourceConfigCommand.d.ts +2 -0
- package/dist-types/commands/BatchGetResourceConfigCommand.d.ts +2 -0
- package/dist-types/commands/DescribeConfigurationRecordersCommand.d.ts +12 -0
- package/dist-types/commands/GetAggregateResourceConfigCommand.d.ts +2 -0
- package/dist-types/commands/GetResourceConfigHistoryCommand.d.ts +2 -0
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -1
- package/dist-types/commands/PutConfigurationRecorderCommand.d.ts +17 -0
- package/dist-types/models/models_0.d.ts +230 -105
- package/dist-types/models/models_1.d.ts +48 -1
- package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +2 -4
- package/dist-types/ts3.4/models/models_0.d.ts +20 -18
- package/dist-types/ts3.4/models/models_1.d.ts +18 -1
- package/package.json +3 -3
|
@@ -1003,7 +1003,19 @@ export declare const ConfigurationItemStatus: {
|
|
|
1003
1003
|
export type ConfigurationItemStatus = (typeof ConfigurationItemStatus)[keyof typeof ConfigurationItemStatus];
|
|
1004
1004
|
/**
|
|
1005
1005
|
* @public
|
|
1006
|
-
*
|
|
1006
|
+
* @enum
|
|
1007
|
+
*/
|
|
1008
|
+
export declare const RecordingFrequency: {
|
|
1009
|
+
readonly CONTINUOUS: "CONTINUOUS";
|
|
1010
|
+
readonly DAILY: "DAILY";
|
|
1011
|
+
};
|
|
1012
|
+
/**
|
|
1013
|
+
* @public
|
|
1014
|
+
*/
|
|
1015
|
+
export type RecordingFrequency = (typeof RecordingFrequency)[keyof typeof RecordingFrequency];
|
|
1016
|
+
/**
|
|
1017
|
+
* @public
|
|
1018
|
+
* <p>The detailed configurations of a specified resource.</p>
|
|
1007
1019
|
*/
|
|
1008
1020
|
export interface BaseConfigurationItem {
|
|
1009
1021
|
/**
|
|
@@ -1018,27 +1030,27 @@ export interface BaseConfigurationItem {
|
|
|
1018
1030
|
accountId?: string;
|
|
1019
1031
|
/**
|
|
1020
1032
|
* @public
|
|
1021
|
-
* <p>The time when the configuration
|
|
1033
|
+
* <p>The time when the recording of configuration changes was initiated for the resource.</p>
|
|
1022
1034
|
*/
|
|
1023
1035
|
configurationItemCaptureTime?: Date;
|
|
1024
1036
|
/**
|
|
1025
1037
|
* @public
|
|
1026
|
-
* <p>The configuration item status.
|
|
1038
|
+
* <p>The configuration item status. Valid values include:</p>
|
|
1027
1039
|
* <ul>
|
|
1028
1040
|
* <li>
|
|
1029
|
-
* <p>OK – The resource configuration has been updated
|
|
1041
|
+
* <p>OK – The resource configuration has been updated.</p>
|
|
1030
1042
|
* </li>
|
|
1031
1043
|
* <li>
|
|
1032
|
-
* <p>ResourceDiscovered – The resource was newly discovered
|
|
1044
|
+
* <p>ResourceDiscovered – The resource was newly discovered.</p>
|
|
1033
1045
|
* </li>
|
|
1034
1046
|
* <li>
|
|
1035
|
-
* <p>ResourceNotRecorded – The resource was discovered but its configuration was not recorded since the recorder
|
|
1047
|
+
* <p>ResourceNotRecorded – The resource was discovered, but its configuration was not recorded since the recorder doesn't record resources of this type.</p>
|
|
1036
1048
|
* </li>
|
|
1037
1049
|
* <li>
|
|
1038
1050
|
* <p>ResourceDeleted – The resource was deleted</p>
|
|
1039
1051
|
* </li>
|
|
1040
1052
|
* <li>
|
|
1041
|
-
* <p>ResourceDeletedNotRecorded – The resource was deleted but its configuration was not recorded since the recorder
|
|
1053
|
+
* <p>ResourceDeletedNotRecorded – The resource was deleted, but its configuration was not recorded since the recorder doesn't record resources of this type.</p>
|
|
1042
1054
|
* </li>
|
|
1043
1055
|
* </ul>
|
|
1044
1056
|
*/
|
|
@@ -1096,6 +1108,16 @@ export interface BaseConfigurationItem {
|
|
|
1096
1108
|
* configuration parameter.</p>
|
|
1097
1109
|
*/
|
|
1098
1110
|
supplementaryConfiguration?: Record<string, string>;
|
|
1111
|
+
/**
|
|
1112
|
+
* @public
|
|
1113
|
+
* <p>The recording frequency that Config uses to record configuration changes for the resource.</p>
|
|
1114
|
+
*/
|
|
1115
|
+
recordingFrequency?: RecordingFrequency;
|
|
1116
|
+
/**
|
|
1117
|
+
* @public
|
|
1118
|
+
* <p>The time when configuration changes for the resource were delivered.</p>
|
|
1119
|
+
*/
|
|
1120
|
+
configurationItemDeliveryTime?: Date;
|
|
1099
1121
|
}
|
|
1100
1122
|
/**
|
|
1101
1123
|
* @public
|
|
@@ -2120,13 +2142,13 @@ export interface ConfigurationItem {
|
|
|
2120
2142
|
accountId?: string;
|
|
2121
2143
|
/**
|
|
2122
2144
|
* @public
|
|
2123
|
-
* <p>The time when the configuration
|
|
2124
|
-
* initiated.</p>
|
|
2145
|
+
* <p>The time when the recording of configuration changes was
|
|
2146
|
+
* initiated for the resource.</p>
|
|
2125
2147
|
*/
|
|
2126
2148
|
configurationItemCaptureTime?: Date;
|
|
2127
2149
|
/**
|
|
2128
2150
|
* @public
|
|
2129
|
-
* <p>The configuration item status.
|
|
2151
|
+
* <p>The configuration item status. Valid values include:</p>
|
|
2130
2152
|
* <ul>
|
|
2131
2153
|
* <li>
|
|
2132
2154
|
* <p>OK – The resource configuration has been updated</p>
|
|
@@ -2135,13 +2157,13 @@ export interface ConfigurationItem {
|
|
|
2135
2157
|
* <p>ResourceDiscovered – The resource was newly discovered</p>
|
|
2136
2158
|
* </li>
|
|
2137
2159
|
* <li>
|
|
2138
|
-
* <p>ResourceNotRecorded – The resource was discovered but its configuration was not recorded since the recorder
|
|
2160
|
+
* <p>ResourceNotRecorded – The resource was discovered but its configuration was not recorded since the recorder doesn't record resources of this type</p>
|
|
2139
2161
|
* </li>
|
|
2140
2162
|
* <li>
|
|
2141
2163
|
* <p>ResourceDeleted – The resource was deleted</p>
|
|
2142
2164
|
* </li>
|
|
2143
2165
|
* <li>
|
|
2144
|
-
* <p>ResourceDeletedNotRecorded – The resource was deleted but its configuration was not recorded since the recorder
|
|
2166
|
+
* <p>ResourceDeletedNotRecorded – The resource was deleted but its configuration was not recorded since the recorder doesn't record resources of this type</p>
|
|
2145
2167
|
* </li>
|
|
2146
2168
|
* </ul>
|
|
2147
2169
|
*/
|
|
@@ -2231,6 +2253,16 @@ export interface ConfigurationItem {
|
|
|
2231
2253
|
* <code>configuration</code> parameter.</p>
|
|
2232
2254
|
*/
|
|
2233
2255
|
supplementaryConfiguration?: Record<string, string>;
|
|
2256
|
+
/**
|
|
2257
|
+
* @public
|
|
2258
|
+
* <p>The recording frequency that Config uses to record configuration changes for the resource.</p>
|
|
2259
|
+
*/
|
|
2260
|
+
recordingFrequency?: RecordingFrequency;
|
|
2261
|
+
/**
|
|
2262
|
+
* @public
|
|
2263
|
+
* <p>The time when configuration changes for the resource were delivered.</p>
|
|
2264
|
+
*/
|
|
2265
|
+
configurationItemDeliveryTime?: Date;
|
|
2234
2266
|
}
|
|
2235
2267
|
/**
|
|
2236
2268
|
* @public
|
|
@@ -2240,19 +2272,19 @@ export interface ConfigurationItem {
|
|
|
2240
2272
|
* including global resource types, Config starts recording resources of that type automatically.</p>
|
|
2241
2273
|
* <note>
|
|
2242
2274
|
* <p>
|
|
2243
|
-
* <b>How to use</b>
|
|
2275
|
+
* <b>How to use the exclusion recording strategy </b>
|
|
2244
2276
|
* </p>
|
|
2245
2277
|
* <p>To use this option, you must set the <code>useOnly</code>
|
|
2246
2278
|
* field of <a href="https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingStrategy.html">RecordingStrategy</a>
|
|
2247
2279
|
* to <code>EXCLUSION_BY_RESOURCE_TYPES</code>.</p>
|
|
2248
2280
|
* <p>Config will then record configuration changes for all supported resource types, except the resource types that you specify to exclude from being recorded.</p>
|
|
2249
2281
|
* <p>
|
|
2250
|
-
* <b>
|
|
2282
|
+
* <b>Global resource types and the exclusion recording strategy </b>
|
|
2251
2283
|
* </p>
|
|
2252
2284
|
* <p>Unless specifically listed as exclusions,
|
|
2253
|
-
* <code>AWS::RDS::GlobalCluster</code> will be recorded automatically in all supported Config Regions were the configuration recorder is enabled
|
|
2254
|
-
*
|
|
2255
|
-
* This list
|
|
2285
|
+
* <code>AWS::RDS::GlobalCluster</code> will be recorded automatically in all supported Config Regions were the configuration recorder is enabled.</p>
|
|
2286
|
+
* <p>IAM users, groups, roles, and customer managed policies will be recorded in the Region where you set up the configuration recorder if that is a Region where Config was available before February 2022.
|
|
2287
|
+
* You cannot be record the global IAM resouce types in Regions supported by Config after February 2022. This list where you cannot record the global IAM resource types includes the following Regions:</p>
|
|
2256
2288
|
* <ul>
|
|
2257
2289
|
* <li>
|
|
2258
2290
|
* <p>Asia Pacific (Hyderabad)</p>
|
|
@@ -2306,9 +2338,9 @@ export interface RecordingStrategy {
|
|
|
2306
2338
|
* <p>The recording strategy for the configuration recorder.</p>
|
|
2307
2339
|
* <ul>
|
|
2308
2340
|
* <li>
|
|
2309
|
-
* <p>If you set this option to <code>ALL_SUPPORTED_RESOURCE_TYPES</code>, Config records configuration changes for all supported
|
|
2341
|
+
* <p>If you set this option to <code>ALL_SUPPORTED_RESOURCE_TYPES</code>, Config records configuration changes for all supported resource types, excluding the global IAM resource types.
|
|
2310
2342
|
* You also must set the <code>allSupported</code> field of <a href="https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingGroup.html">RecordingGroup</a> to <code>true</code>.
|
|
2311
|
-
* When Config adds support for a new
|
|
2343
|
+
* When Config adds support for a new resource type, Config automatically starts recording resources of that type. For a list of supported resource types,
|
|
2312
2344
|
* see <a href="https://docs.aws.amazon.com/config/latest/developerguide/resource-config-reference.html#supported-resources">Supported Resource Types</a> in the <i>Config developer guide</i>.</p>
|
|
2313
2345
|
* </li>
|
|
2314
2346
|
* <li>
|
|
@@ -2338,7 +2370,7 @@ export interface RecordingStrategy {
|
|
|
2338
2370
|
* <b>Overriding fields</b>
|
|
2339
2371
|
* </p>
|
|
2340
2372
|
* <p>If you choose <code>EXCLUSION_BY_RESOURCE_TYPES</code> for the recording strategy, the <code>exclusionByResourceTypes</code> field will override other properties in the request.</p>
|
|
2341
|
-
* <p>For example, even if you set <code>includeGlobalResourceTypes</code> to false,
|
|
2373
|
+
* <p>For example, even if you set <code>includeGlobalResourceTypes</code> to false, global IAM resource types will still be automatically
|
|
2342
2374
|
* recorded in this option unless those resource types are specifically listed as exclusions in the <code>resourceTypes</code> field of <code>exclusionByResourceTypes</code>.</p>
|
|
2343
2375
|
* </note>
|
|
2344
2376
|
* <note>
|
|
@@ -2348,10 +2380,10 @@ export interface RecordingStrategy {
|
|
|
2348
2380
|
* <p>By default, if you choose the <code>EXCLUSION_BY_RESOURCE_TYPES</code> recording strategy,
|
|
2349
2381
|
* when Config adds support for a new resource type in the Region where you set up the configuration recorder, including global resource types,
|
|
2350
2382
|
* Config starts recording resources of that type automatically.</p>
|
|
2351
|
-
* <p>
|
|
2352
|
-
* <code>AWS::RDS::GlobalCluster</code> will be recorded automatically in all supported
|
|
2353
|
-
*
|
|
2354
|
-
* This list
|
|
2383
|
+
* <p>Unless specifically listed as exclusions,
|
|
2384
|
+
* <code>AWS::RDS::GlobalCluster</code> will be recorded automatically in all supported Config Regions were the configuration recorder is enabled.</p>
|
|
2385
|
+
* <p>IAM users, groups, roles, and customer managed policies will be recorded in the Region where you set up the configuration recorder if that is a Region where Config was available before February 2022.
|
|
2386
|
+
* You cannot be record the global IAM resouce types in Regions supported by Config after February 2022. This list where you cannot record the global IAM resource types includes the following Regions:</p>
|
|
2355
2387
|
* <ul>
|
|
2356
2388
|
* <li>
|
|
2357
2389
|
* <p>Asia Pacific (Hyderabad)</p>
|
|
@@ -2379,11 +2411,11 @@ export interface RecordingStrategy {
|
|
|
2379
2411
|
/**
|
|
2380
2412
|
* @public
|
|
2381
2413
|
* <p>Specifies which resource types Config
|
|
2382
|
-
* records for configuration changes. By default, Config records configuration changes for all current and future supported resource types in the Amazon Web Services Region where you have enabled Config
|
|
2383
|
-
*
|
|
2414
|
+
* records for configuration changes. By default, Config records configuration changes for all current and future supported resource types in the Amazon Web Services Region where you have enabled Config,
|
|
2415
|
+
* excluding the global IAM resource types: IAM users, groups, roles, and customer managed policies.</p>
|
|
2384
2416
|
* <p>In the recording group, you specify whether you want to record all supported current and future supported resource types or to include or exclude specific resources types.
|
|
2385
2417
|
* For a list of supported resource types, see <a href="https://docs.aws.amazon.com/config/latest/developerguide/resource-config-reference.html#supported-resources">Supported Resource Types</a> in the <i>Config developer guide</i>.</p>
|
|
2386
|
-
* <p>If you don't want Config to record all
|
|
2418
|
+
* <p>If you don't want Config to record all current and future supported resource types (excluding the global IAM resource types), use one of the following recording strategies:</p>
|
|
2387
2419
|
* <ol>
|
|
2388
2420
|
* <li>
|
|
2389
2421
|
* <p>
|
|
@@ -2394,9 +2426,11 @@ export interface RecordingStrategy {
|
|
|
2394
2426
|
* <b>Record specific resource types</b> (<code>INCLUSION_BY_RESOURCE_TYPES</code>).</p>
|
|
2395
2427
|
* </li>
|
|
2396
2428
|
* </ol>
|
|
2429
|
+
* <p>If you use the recording strategy to <b>Record all current and future resource types</b> (<code>ALL_SUPPORTED_RESOURCE_TYPES</code>),
|
|
2430
|
+
* you can use the flag <code>includeGlobalResourceTypes</code> to include the global IAM resource types in your recording.</p>
|
|
2397
2431
|
* <important>
|
|
2398
2432
|
* <p>
|
|
2399
|
-
* <b>Aurora global clusters are
|
|
2433
|
+
* <b>Aurora global clusters are recorded in all enabled Regions</b>
|
|
2400
2434
|
* </p>
|
|
2401
2435
|
* <p>The <code>AWS::RDS::GlobalCluster</code> resource type
|
|
2402
2436
|
* will be recorded in all supported Config Regions where the configuration recorder is enabled.</p>
|
|
@@ -2406,14 +2440,14 @@ export interface RecordingStrategy {
|
|
|
2406
2440
|
export interface RecordingGroup {
|
|
2407
2441
|
/**
|
|
2408
2442
|
* @public
|
|
2409
|
-
* <p>Specifies whether Config records configuration changes for all supported
|
|
2443
|
+
* <p>Specifies whether Config records configuration changes for all supported resource types, excluding the global IAM resource types.</p>
|
|
2410
2444
|
* <p>If you set this field to <code>true</code>, when Config
|
|
2411
|
-
* adds support for a new
|
|
2445
|
+
* adds support for a new resource type, Config starts recording resources of that type automatically.</p>
|
|
2412
2446
|
* <p>If you set this field to <code>true</code>,
|
|
2413
2447
|
* you cannot enumerate specific resource types to record in the <code>resourceTypes</code> field of <a href="https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingGroup.html">RecordingGroup</a>, or to exclude in the <code>resourceTypes</code> field of <a href="https://docs.aws.amazon.com/config/latest/APIReference/API_ExclusionByResourceTypes.html">ExclusionByResourceTypes</a>.</p>
|
|
2414
2448
|
* <note>
|
|
2415
2449
|
* <p>
|
|
2416
|
-
* <b>Region
|
|
2450
|
+
* <b>Region availability</b>
|
|
2417
2451
|
* </p>
|
|
2418
2452
|
* <p>Check <a href="https://docs.aws.amazon.com/config/latest/developerguide/what-is-resource-config-coverage.html">Resource Coverage by Region Availability</a>
|
|
2419
2453
|
* to see if a resource type is supported in the Amazon Web Services Region where you set up Config.</p>
|
|
@@ -2422,9 +2456,11 @@ export interface RecordingGroup {
|
|
|
2422
2456
|
allSupported?: boolean;
|
|
2423
2457
|
/**
|
|
2424
2458
|
* @public
|
|
2425
|
-
* <p>
|
|
2426
|
-
*
|
|
2427
|
-
*
|
|
2459
|
+
* <p>This option is a bundle which only applies to the global IAM resource types:
|
|
2460
|
+
* IAM users, groups, roles, and customer managed policies. These global IAM resource types can only be recorded
|
|
2461
|
+
* by Config in Regions where Config was available before February 2022.
|
|
2462
|
+
* You cannot be record the global IAM resouce types in Regions supported by Config after February 2022.
|
|
2463
|
+
* This list where you cannot record the global IAM resource types includes the following Regions:</p>
|
|
2428
2464
|
* <ul>
|
|
2429
2465
|
* <li>
|
|
2430
2466
|
* <p>Asia Pacific (Hyderabad)</p>
|
|
@@ -2447,10 +2483,10 @@ export interface RecordingGroup {
|
|
|
2447
2483
|
* </ul>
|
|
2448
2484
|
* <important>
|
|
2449
2485
|
* <p>
|
|
2450
|
-
* <b>Aurora global clusters are
|
|
2486
|
+
* <b>Aurora global clusters are recorded in all enabled Regions</b>
|
|
2451
2487
|
* </p>
|
|
2452
2488
|
* <p>The <code>AWS::RDS::GlobalCluster</code> resource type will be recorded in all supported Config Regions where the configuration recorder is enabled, even if <code>includeGlobalResourceTypes</code> is not set to <code>true</code>.
|
|
2453
|
-
* <code>includeGlobalResourceTypes</code> is a
|
|
2489
|
+
* The <code>includeGlobalResourceTypes</code> option is a bundle which only applies to IAM users, groups, roles, and customer managed policies.
|
|
2454
2490
|
* </p>
|
|
2455
2491
|
* <p>If you do not want to record <code>AWS::RDS::GlobalCluster</code> in all enabled Regions, use one of the following recording strategies:</p>
|
|
2456
2492
|
* <ol>
|
|
@@ -2466,9 +2502,6 @@ export interface RecordingGroup {
|
|
|
2466
2502
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/config/latest/developerguide/select-resources.html#select-resources-all">Selecting Which Resources are Recorded</a> in the <i>Config developer guide</i>.</p>
|
|
2467
2503
|
* </important>
|
|
2468
2504
|
* <note>
|
|
2469
|
-
* <p>
|
|
2470
|
-
* <b>Required and optional fields</b>
|
|
2471
|
-
* </p>
|
|
2472
2505
|
* <p>Before you set this field to <code>true</code>,
|
|
2473
2506
|
* set the <code>allSupported</code> field of <a href="https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingGroup.html">RecordingGroup</a> to
|
|
2474
2507
|
* <code>true</code>. Optionally, you can set the <code>useOnly</code> field of <a href="https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingStrategy.html">RecordingStrategy</a> to <code>ALL_SUPPORTED_RESOURCE_TYPES</code>.</p>
|
|
@@ -2477,9 +2510,9 @@ export interface RecordingGroup {
|
|
|
2477
2510
|
* <p>
|
|
2478
2511
|
* <b>Overriding fields</b>
|
|
2479
2512
|
* </p>
|
|
2480
|
-
* <p>If you set this field to <code>false</code> but list
|
|
2513
|
+
* <p>If you set this field to <code>false</code> but list global IAM resource types in the <code>resourceTypes</code> field of <a href="https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingGroup.html">RecordingGroup</a>,
|
|
2481
2514
|
* Config will still record configuration changes for those specified resource types <i>regardless</i> of if you set the <code>includeGlobalResourceTypes</code> field to false.</p>
|
|
2482
|
-
* <p>If you do not want to record configuration changes to the
|
|
2515
|
+
* <p>If you do not want to record configuration changes to the global IAM resource types (IAM users, groups, roles, and customer managed policies), make sure to not list them in the <code>resourceTypes</code> field
|
|
2483
2516
|
* in addition to setting the <code>includeGlobalResourceTypes</code> field to false.</p>
|
|
2484
2517
|
* </note>
|
|
2485
2518
|
*/
|
|
@@ -2488,18 +2521,23 @@ export interface RecordingGroup {
|
|
|
2488
2521
|
* @public
|
|
2489
2522
|
* <p>A comma-separated list that specifies which resource types Config
|
|
2490
2523
|
* records.</p>
|
|
2491
|
-
* <p>Optionally, you can set the <code>useOnly</code> field of <a href="https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingStrategy.html">RecordingStrategy</a> to <code>INCLUSION_BY_RESOURCE_TYPES</code>.</p>
|
|
2492
|
-
* <p>To record all configuration changes,
|
|
2493
|
-
* set the <code>allSupported</code> field of <a href="https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingGroup.html">RecordingGroup</a> to
|
|
2494
|
-
* <code>true</code>, and either omit this field or don't specify any resource types in this field. If you set the <code>allSupported</code> field to <code>false</code> and specify values for <code>resourceTypes</code>,
|
|
2495
|
-
* when Config adds support for a new type of resource,
|
|
2496
|
-
* it will not record resources of that type unless you manually add that type to your recording group.</p>
|
|
2497
2524
|
* <p>For a list of valid <code>resourceTypes</code> values, see the
|
|
2498
2525
|
* <b>Resource Type Value</b> column in
|
|
2499
2526
|
* <a href="https://docs.aws.amazon.com/config/latest/developerguide/resource-config-reference.html#supported-resources">Supported Amazon Web Services resource Types</a> in the <i>Config developer guide</i>.</p>
|
|
2500
2527
|
* <note>
|
|
2501
2528
|
* <p>
|
|
2502
|
-
* <b>
|
|
2529
|
+
* <b>Required and optional fields</b>
|
|
2530
|
+
* </p>
|
|
2531
|
+
* <p>Optionally, you can set the <code>useOnly</code> field of <a href="https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingStrategy.html">RecordingStrategy</a> to <code>INCLUSION_BY_RESOURCE_TYPES</code>.</p>
|
|
2532
|
+
* <p>To record all configuration changes,
|
|
2533
|
+
* set the <code>allSupported</code> field of <a href="https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingGroup.html">RecordingGroup</a> to
|
|
2534
|
+
* <code>true</code>, and either omit this field or don't specify any resource types in this field. If you set the <code>allSupported</code> field to <code>false</code> and specify values for <code>resourceTypes</code>,
|
|
2535
|
+
* when Config adds support for a new type of resource,
|
|
2536
|
+
* it will not record resources of that type unless you manually add that type to your recording group.</p>
|
|
2537
|
+
* </note>
|
|
2538
|
+
* <note>
|
|
2539
|
+
* <p>
|
|
2540
|
+
* <b>Region availability</b>
|
|
2503
2541
|
* </p>
|
|
2504
2542
|
* <p>Before specifying a resource type for Config to track,
|
|
2505
2543
|
* check <a href="https://docs.aws.amazon.com/config/latest/developerguide/what-is-resource-config-coverage.html">Resource Coverage by Region Availability</a>
|
|
@@ -2513,7 +2551,12 @@ export interface RecordingGroup {
|
|
|
2513
2551
|
/**
|
|
2514
2552
|
* @public
|
|
2515
2553
|
* <p>An object that specifies how Config excludes resource types from being recorded by the configuration recorder.</p>
|
|
2516
|
-
* <
|
|
2554
|
+
* <note>
|
|
2555
|
+
* <p>
|
|
2556
|
+
* <b>Required fields</b>
|
|
2557
|
+
* </p>
|
|
2558
|
+
* <p>To use this option, you must set the <code>useOnly</code> field of <a href="https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingStrategy.html">RecordingStrategy</a> to <code>EXCLUSION_BY_RESOURCE_TYPES</code>.</p>
|
|
2559
|
+
* </note>
|
|
2517
2560
|
*/
|
|
2518
2561
|
exclusionByResourceTypes?: ExclusionByResourceTypes;
|
|
2519
2562
|
/**
|
|
@@ -2521,7 +2564,7 @@ export interface RecordingGroup {
|
|
|
2521
2564
|
* <p>An object that specifies the recording strategy for the configuration recorder.</p>
|
|
2522
2565
|
* <ul>
|
|
2523
2566
|
* <li>
|
|
2524
|
-
* <p>If you set the <code>useOnly</code> field of <a href="https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingStrategy.html">RecordingStrategy</a> to <code>ALL_SUPPORTED_RESOURCE_TYPES</code>, Config records configuration changes for all supported
|
|
2567
|
+
* <p>If you set the <code>useOnly</code> field of <a href="https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingStrategy.html">RecordingStrategy</a> to <code>ALL_SUPPORTED_RESOURCE_TYPES</code>, Config records configuration changes for all supported resource types, excluding the global IAM resource types. You also must set the <code>allSupported</code> field of <a href="https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingGroup.html">RecordingGroup</a> to <code>true</code>. When Config adds support for a new resource type, Config automatically starts recording resources of that type.</p>
|
|
2525
2568
|
* </li>
|
|
2526
2569
|
* <li>
|
|
2527
2570
|
* <p>If you set the <code>useOnly</code> field of <a href="https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingStrategy.html">RecordingStrategy</a> to <code>INCLUSION_BY_RESOURCE_TYPES</code>, Config records configuration changes for only the resource types you specify in the <code>resourceTypes</code> field of <a href="https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingGroup.html">RecordingGroup</a>.</p>
|
|
@@ -2546,7 +2589,7 @@ export interface RecordingGroup {
|
|
|
2546
2589
|
* <b>Overriding fields</b>
|
|
2547
2590
|
* </p>
|
|
2548
2591
|
* <p>If you choose <code>EXCLUSION_BY_RESOURCE_TYPES</code> for the recording strategy, the <code>exclusionByResourceTypes</code> field will override other properties in the request.</p>
|
|
2549
|
-
* <p>For example, even if you set <code>includeGlobalResourceTypes</code> to false,
|
|
2592
|
+
* <p>For example, even if you set <code>includeGlobalResourceTypes</code> to false, global IAM resource types will still be automatically
|
|
2550
2593
|
* recorded in this option unless those resource types are specifically listed as exclusions in the <code>resourceTypes</code> field of <code>exclusionByResourceTypes</code>.</p>
|
|
2551
2594
|
* </note>
|
|
2552
2595
|
* <note>
|
|
@@ -2556,10 +2599,10 @@ export interface RecordingGroup {
|
|
|
2556
2599
|
* <p>By default, if you choose the <code>EXCLUSION_BY_RESOURCE_TYPES</code> recording strategy,
|
|
2557
2600
|
* when Config adds support for a new resource type in the Region where you set up the configuration recorder, including global resource types,
|
|
2558
2601
|
* Config starts recording resources of that type automatically.</p>
|
|
2559
|
-
* <p>
|
|
2560
|
-
* <code>AWS::RDS::GlobalCluster</code> will be recorded automatically in all supported
|
|
2561
|
-
*
|
|
2562
|
-
* This list
|
|
2602
|
+
* <p>Unless specifically listed as exclusions,
|
|
2603
|
+
* <code>AWS::RDS::GlobalCluster</code> will be recorded automatically in all supported Config Regions were the configuration recorder is enabled.</p>
|
|
2604
|
+
* <p>IAM users, groups, roles, and customer managed policies will be recorded in the Region where you set up the configuration recorder if that is a Region where Config was available before February 2022.
|
|
2605
|
+
* You cannot be record the global IAM resouce types in Regions supported by Config after February 2022. This list where you cannot record the global IAM resource types includes the following Regions:</p>
|
|
2563
2606
|
* <ul>
|
|
2564
2607
|
* <li>
|
|
2565
2608
|
* <p>Asia Pacific (Hyderabad)</p>
|
|
@@ -2586,7 +2629,114 @@ export interface RecordingGroup {
|
|
|
2586
2629
|
}
|
|
2587
2630
|
/**
|
|
2588
2631
|
* @public
|
|
2589
|
-
* <p>
|
|
2632
|
+
* <p>An object for you to specify your overrides for the recording mode.</p>
|
|
2633
|
+
*/
|
|
2634
|
+
export interface RecordingModeOverride {
|
|
2635
|
+
/**
|
|
2636
|
+
* @public
|
|
2637
|
+
* <p>A description that you provide for the override.</p>
|
|
2638
|
+
*/
|
|
2639
|
+
description?: string;
|
|
2640
|
+
/**
|
|
2641
|
+
* @public
|
|
2642
|
+
* <p>A comma-separated list that specifies which resource types Config
|
|
2643
|
+
* includes in the override.</p>
|
|
2644
|
+
* <important>
|
|
2645
|
+
* <p>Daily recording is not supported for the following resource types:</p>
|
|
2646
|
+
* <ul>
|
|
2647
|
+
* <li>
|
|
2648
|
+
* <p>
|
|
2649
|
+
* <code>AWS::Config::ResourceCompliance</code>
|
|
2650
|
+
* </p>
|
|
2651
|
+
* </li>
|
|
2652
|
+
* <li>
|
|
2653
|
+
* <p>
|
|
2654
|
+
* <code>AWS::Config::ConformancePackCompliance</code>
|
|
2655
|
+
* </p>
|
|
2656
|
+
* </li>
|
|
2657
|
+
* <li>
|
|
2658
|
+
* <p>
|
|
2659
|
+
* <code>AWS::Config::ConfigurationRecorder</code>
|
|
2660
|
+
* </p>
|
|
2661
|
+
* </li>
|
|
2662
|
+
* </ul>
|
|
2663
|
+
* </important>
|
|
2664
|
+
*/
|
|
2665
|
+
resourceTypes: ResourceType[] | undefined;
|
|
2666
|
+
/**
|
|
2667
|
+
* @public
|
|
2668
|
+
* <p>The recording frequency that will be applied to all the resource types specified in the override.</p>
|
|
2669
|
+
* <ul>
|
|
2670
|
+
* <li>
|
|
2671
|
+
* <p>Continuous recording allows you to record configuration changes continuously whenever a change occurs.</p>
|
|
2672
|
+
* </li>
|
|
2673
|
+
* <li>
|
|
2674
|
+
* <p>Daily recording allows you record configuration data once every 24 hours, only if a change has occurred.</p>
|
|
2675
|
+
* </li>
|
|
2676
|
+
* </ul>
|
|
2677
|
+
* <note>
|
|
2678
|
+
* <p>Firewall Manager depends on continuous recording to monitor your resources. If you are using Firewall Manager,
|
|
2679
|
+
* it is recommended that you set the recording frequency to Continuous.</p>
|
|
2680
|
+
* </note>
|
|
2681
|
+
*/
|
|
2682
|
+
recordingFrequency: RecordingFrequency | undefined;
|
|
2683
|
+
}
|
|
2684
|
+
/**
|
|
2685
|
+
* @public
|
|
2686
|
+
* <p>Specifies the default recording frequency that Config uses to record configuration changes.
|
|
2687
|
+
*
|
|
2688
|
+
* Config supports <i>Continuous recording</i> and <i>Daily recording</i>.</p>
|
|
2689
|
+
* <ul>
|
|
2690
|
+
* <li>
|
|
2691
|
+
* <p>Continuous recording allows you to record configuration changes continuously whenever a change occurs.</p>
|
|
2692
|
+
* </li>
|
|
2693
|
+
* <li>
|
|
2694
|
+
* <p>Daily recording allows you record configuration data once every 24 hours, only if a change has occurred.</p>
|
|
2695
|
+
* </li>
|
|
2696
|
+
* </ul>
|
|
2697
|
+
* <note>
|
|
2698
|
+
* <p>Firewall Manager depends on continuous recording to monitor your resources. If you are using Firewall Manager,
|
|
2699
|
+
* it is recommended that you set the recording frequency to Continuous.</p>
|
|
2700
|
+
* </note>
|
|
2701
|
+
* <p>You can also override the recording frequency for specific resource types.</p>
|
|
2702
|
+
*/
|
|
2703
|
+
export interface RecordingMode {
|
|
2704
|
+
/**
|
|
2705
|
+
* @public
|
|
2706
|
+
* <p>The default recording frequency that Config uses to record configuration changes.</p>
|
|
2707
|
+
* <important>
|
|
2708
|
+
* <p>Daily recording is not supported for the following resource types:</p>
|
|
2709
|
+
* <ul>
|
|
2710
|
+
* <li>
|
|
2711
|
+
* <p>
|
|
2712
|
+
* <code>AWS::Config::ResourceCompliance</code>
|
|
2713
|
+
* </p>
|
|
2714
|
+
* </li>
|
|
2715
|
+
* <li>
|
|
2716
|
+
* <p>
|
|
2717
|
+
* <code>AWS::Config::ConformancePackCompliance</code>
|
|
2718
|
+
* </p>
|
|
2719
|
+
* </li>
|
|
2720
|
+
* <li>
|
|
2721
|
+
* <p>
|
|
2722
|
+
* <code>AWS::Config::ConfigurationRecorder</code>
|
|
2723
|
+
* </p>
|
|
2724
|
+
* </li>
|
|
2725
|
+
* </ul>
|
|
2726
|
+
* <p>For the <b>allSupported</b> (<code>ALL_SUPPORTED_RESOURCE_TYPES</code>) recording strategy, these resource types will be set to Continuous recording.</p>
|
|
2727
|
+
* </important>
|
|
2728
|
+
*/
|
|
2729
|
+
recordingFrequency: RecordingFrequency | undefined;
|
|
2730
|
+
/**
|
|
2731
|
+
* @public
|
|
2732
|
+
* <p>An array of <code>recordingModeOverride</code> objects for you to specify your overrides for the recording mode.
|
|
2733
|
+
* The <code>recordingModeOverride</code> object in the <code>recordingModeOverrides</code> array consists of three fields: a <code>description</code>, the new <code>recordingFrequency</code>, and an array of <code>resourceTypes</code> to override.</p>
|
|
2734
|
+
*/
|
|
2735
|
+
recordingModeOverrides?: RecordingModeOverride[];
|
|
2736
|
+
}
|
|
2737
|
+
/**
|
|
2738
|
+
* @public
|
|
2739
|
+
* <p>Records configuration changes to your specified resource types.
|
|
2590
2740
|
* For more information about the configuration recorder,
|
|
2591
2741
|
* see <a href="https://docs.aws.amazon.com/config/latest/developerguide/stop-start-recorder.html">
|
|
2592
2742
|
* <b>Managing the Configuration Recorder</b>
|
|
@@ -2596,12 +2746,14 @@ export interface ConfigurationRecorder {
|
|
|
2596
2746
|
/**
|
|
2597
2747
|
* @public
|
|
2598
2748
|
* <p>The name of the configuration recorder. Config automatically assigns the name of "default" when creating the configuration recorder.</p>
|
|
2599
|
-
* <
|
|
2749
|
+
* <note>
|
|
2750
|
+
* <p>You cannot change the name of the configuration recorder after it has been created. To change the configuration recorder name, you must delete it and create a new configuration recorder with a new name. </p>
|
|
2751
|
+
* </note>
|
|
2600
2752
|
*/
|
|
2601
2753
|
name?: string;
|
|
2602
2754
|
/**
|
|
2603
2755
|
* @public
|
|
2604
|
-
* <p>Amazon Resource Name (ARN) of the IAM role assumed by
|
|
2756
|
+
* <p>Amazon Resource Name (ARN) of the IAM role assumed by Config and used by the configuration recorder.</p>
|
|
2605
2757
|
* <note>
|
|
2606
2758
|
* <p>While the API model does not require this field, the server will reject a request without a defined <code>roleARN</code> for the configuration recorder.</p>
|
|
2607
2759
|
* </note>
|
|
@@ -2647,6 +2799,26 @@ export interface ConfigurationRecorder {
|
|
|
2647
2799
|
* </note>
|
|
2648
2800
|
*/
|
|
2649
2801
|
recordingGroup?: RecordingGroup;
|
|
2802
|
+
/**
|
|
2803
|
+
* @public
|
|
2804
|
+
* <p>Specifies the default recording frequency that Config uses to record configuration changes.
|
|
2805
|
+
*
|
|
2806
|
+
* Config supports <i>Continuous recording</i> and <i>Daily recording</i>.</p>
|
|
2807
|
+
* <ul>
|
|
2808
|
+
* <li>
|
|
2809
|
+
* <p>Continuous recording allows you to record configuration changes continuously whenever a change occurs.</p>
|
|
2810
|
+
* </li>
|
|
2811
|
+
* <li>
|
|
2812
|
+
* <p>Daily recording allows you record configuration data once every 24 hours, only if a change has occurred.</p>
|
|
2813
|
+
* </li>
|
|
2814
|
+
* </ul>
|
|
2815
|
+
* <note>
|
|
2816
|
+
* <p>Firewall Manager depends on continuous recording to monitor your resources. If you are using Firewall Manager,
|
|
2817
|
+
* it is recommended that you set the recording frequency to Continuous.</p>
|
|
2818
|
+
* </note>
|
|
2819
|
+
* <p>You can also override the recording frequency for specific resource types.</p>
|
|
2820
|
+
*/
|
|
2821
|
+
recordingMode?: RecordingMode;
|
|
2650
2822
|
}
|
|
2651
2823
|
/**
|
|
2652
2824
|
* @public
|
|
@@ -7643,50 +7815,3 @@ export interface ListTagsForResourceRequest {
|
|
|
7643
7815
|
*/
|
|
7644
7816
|
NextToken?: string;
|
|
7645
7817
|
}
|
|
7646
|
-
/**
|
|
7647
|
-
* @public
|
|
7648
|
-
* <p>The tags for the resource. The metadata that you apply to a resource to help you categorize and organize them.
|
|
7649
|
-
* Each tag consists of a key and an optional value, both of which you define.
|
|
7650
|
-
* Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.</p>
|
|
7651
|
-
*/
|
|
7652
|
-
export interface Tag {
|
|
7653
|
-
/**
|
|
7654
|
-
* @public
|
|
7655
|
-
* <p>One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.</p>
|
|
7656
|
-
*/
|
|
7657
|
-
Key?: string;
|
|
7658
|
-
/**
|
|
7659
|
-
* @public
|
|
7660
|
-
* <p>The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).</p>
|
|
7661
|
-
*/
|
|
7662
|
-
Value?: string;
|
|
7663
|
-
}
|
|
7664
|
-
/**
|
|
7665
|
-
* @public
|
|
7666
|
-
*/
|
|
7667
|
-
export interface ListTagsForResourceResponse {
|
|
7668
|
-
/**
|
|
7669
|
-
* @public
|
|
7670
|
-
* <p>The tags for the resource.</p>
|
|
7671
|
-
*/
|
|
7672
|
-
Tags?: Tag[];
|
|
7673
|
-
/**
|
|
7674
|
-
* @public
|
|
7675
|
-
* <p>The <code>nextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response. </p>
|
|
7676
|
-
*/
|
|
7677
|
-
NextToken?: string;
|
|
7678
|
-
}
|
|
7679
|
-
/**
|
|
7680
|
-
* @public
|
|
7681
|
-
* <p>You have reached the limit of active custom resource types in your account. There is a limit of 100,000.
|
|
7682
|
-
* Delete unused resources using <a href="https://docs.aws.amazon.com/config/latest/APIReference/API_DeleteResourceConfig.html">DeleteResourceConfig</a>
|
|
7683
|
-
* <code></code>.</p>
|
|
7684
|
-
*/
|
|
7685
|
-
export declare class MaxActiveResourcesExceededException extends __BaseException {
|
|
7686
|
-
readonly name: "MaxActiveResourcesExceededException";
|
|
7687
|
-
readonly $fault: "client";
|
|
7688
|
-
/**
|
|
7689
|
-
* @internal
|
|
7690
|
-
*/
|
|
7691
|
-
constructor(opts: __ExceptionOptionType<MaxActiveResourcesExceededException, __BaseException>);
|
|
7692
|
-
}
|
|
@@ -1,6 +1,53 @@
|
|
|
1
1
|
import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
|
|
2
2
|
import { ConfigServiceServiceException as __BaseException } from "./ConfigServiceServiceException";
|
|
3
|
-
import { AccountAggregationSource, AggregationAuthorization, ConfigRule, ConfigurationAggregator, ConfigurationRecorder, ConformancePackInputParameter, DeliveryChannel, Evaluation, EvaluationContext, EvaluationMode, ExternalEvaluation, FailedRemediationBatch, FailedRemediationExceptionBatch, FieldInfo, MaximumExecutionFrequency, OrganizationAggregationSource, OrganizationConfigRuleTriggerTypeNoSN, OrganizationCustomRuleMetadata, OrganizationManagedRuleMetadata, RemediationConfiguration, RemediationExceptionResourceKey, ResourceDetails, ResourceKey, RetentionConfiguration, StoredQuery,
|
|
3
|
+
import { AccountAggregationSource, AggregationAuthorization, ConfigRule, ConfigurationAggregator, ConfigurationRecorder, ConformancePackInputParameter, DeliveryChannel, Evaluation, EvaluationContext, EvaluationMode, ExternalEvaluation, FailedRemediationBatch, FailedRemediationExceptionBatch, FieldInfo, MaximumExecutionFrequency, OrganizationAggregationSource, OrganizationConfigRuleTriggerTypeNoSN, OrganizationCustomRuleMetadata, OrganizationManagedRuleMetadata, RemediationConfiguration, RemediationExceptionResourceKey, ResourceDetails, ResourceKey, RetentionConfiguration, StoredQuery, TemplateSSMDocumentDetails } from "./models_0";
|
|
4
|
+
/**
|
|
5
|
+
* @public
|
|
6
|
+
* <p>The tags for the resource. The metadata that you apply to a resource to help you categorize and organize them.
|
|
7
|
+
* Each tag consists of a key and an optional value, both of which you define.
|
|
8
|
+
* Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.</p>
|
|
9
|
+
*/
|
|
10
|
+
export interface Tag {
|
|
11
|
+
/**
|
|
12
|
+
* @public
|
|
13
|
+
* <p>One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.</p>
|
|
14
|
+
*/
|
|
15
|
+
Key?: string;
|
|
16
|
+
/**
|
|
17
|
+
* @public
|
|
18
|
+
* <p>The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).</p>
|
|
19
|
+
*/
|
|
20
|
+
Value?: string;
|
|
21
|
+
}
|
|
22
|
+
/**
|
|
23
|
+
* @public
|
|
24
|
+
*/
|
|
25
|
+
export interface ListTagsForResourceResponse {
|
|
26
|
+
/**
|
|
27
|
+
* @public
|
|
28
|
+
* <p>The tags for the resource.</p>
|
|
29
|
+
*/
|
|
30
|
+
Tags?: Tag[];
|
|
31
|
+
/**
|
|
32
|
+
* @public
|
|
33
|
+
* <p>The <code>nextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response. </p>
|
|
34
|
+
*/
|
|
35
|
+
NextToken?: string;
|
|
36
|
+
}
|
|
37
|
+
/**
|
|
38
|
+
* @public
|
|
39
|
+
* <p>You have reached the limit of active custom resource types in your account. There is a limit of 100,000.
|
|
40
|
+
* Delete unused resources using <a href="https://docs.aws.amazon.com/config/latest/APIReference/API_DeleteResourceConfig.html">DeleteResourceConfig</a>
|
|
41
|
+
* <code></code>.</p>
|
|
42
|
+
*/
|
|
43
|
+
export declare class MaxActiveResourcesExceededException extends __BaseException {
|
|
44
|
+
readonly name: "MaxActiveResourcesExceededException";
|
|
45
|
+
readonly $fault: "client";
|
|
46
|
+
/**
|
|
47
|
+
* @internal
|
|
48
|
+
*/
|
|
49
|
+
constructor(opts: __ExceptionOptionType<MaxActiveResourcesExceededException, __BaseException>);
|
|
50
|
+
}
|
|
4
51
|
/**
|
|
5
52
|
* @public
|
|
6
53
|
* <p>Failed to add the Config rule because the account already
|