@aws-sdk/client-config-service 3.342.0 → 3.344.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/dist-cjs/models/models_0.js +7 -41
- package/dist-cjs/models/models_1.js +40 -1
- package/dist-cjs/protocols/Aws_json1_1.js +3 -3
- package/dist-es/models/models_0.js +5 -36
- package/dist-es/models/models_1.js +36 -0
- package/dist-es/protocols/Aws_json1_1.js +2 -2
- package/dist-types/commands/DescribeConfigurationRecorderStatusCommand.d.ts +2 -2
- package/dist-types/commands/DescribeConfigurationRecordersCommand.d.ts +9 -2
- package/dist-types/commands/PutConfigurationAggregatorCommand.d.ts +1 -1
- package/dist-types/commands/PutConfigurationRecorderCommand.d.ts +44 -14
- package/dist-types/commands/PutConformancePackCommand.d.ts +2 -2
- package/dist-types/commands/PutOrganizationConfigRuleCommand.d.ts +1 -1
- package/dist-types/commands/PutOrganizationConformancePackCommand.d.ts +2 -2
- package/dist-types/commands/PutRemediationExceptionsCommand.d.ts +1 -1
- package/dist-types/commands/PutStoredQueryCommand.d.ts +1 -1
- package/dist-types/commands/SelectAggregateResourceConfigCommand.d.ts +1 -1
- package/dist-types/commands/TagResourceCommand.d.ts +1 -1
- package/dist-types/models/models_0.d.ts +234 -114
- package/dist-types/models/models_1.d.ts +45 -5
- package/dist-types/ts3.4/models/models_0.d.ts +15 -30
- package/dist-types/ts3.4/models/models_1.d.ts +30 -0
- package/package.json +6 -6
|
@@ -1964,103 +1964,241 @@ export interface ConfigurationItem {
|
|
|
1964
1964
|
}
|
|
1965
1965
|
/**
|
|
1966
1966
|
* @public
|
|
1967
|
-
* <p>Specifies
|
|
1968
|
-
*
|
|
1969
|
-
|
|
1970
|
-
|
|
1971
|
-
|
|
1972
|
-
|
|
1973
|
-
|
|
1967
|
+
* <p>Specifies whether the configuration recorder excludes resource types from being recorded.
|
|
1968
|
+
* Use the <code>resourceTypes</code> field to enter a comma-separated list of resource types to exclude as exemptions.</p>
|
|
1969
|
+
*/
|
|
1970
|
+
export interface ExclusionByResourceTypes {
|
|
1971
|
+
/**
|
|
1972
|
+
* <p>A comma-separated list of resource types to exclude from recording by the configuration
|
|
1973
|
+
* recorder.</p>
|
|
1974
|
+
*/
|
|
1975
|
+
resourceTypes?: (ResourceType | string)[];
|
|
1976
|
+
}
|
|
1977
|
+
/**
|
|
1978
|
+
* @public
|
|
1979
|
+
* @enum
|
|
1980
|
+
*/
|
|
1981
|
+
export declare const RecordingStrategyType: {
|
|
1982
|
+
readonly ALL_SUPPORTED_RESOURCE_TYPES: "ALL_SUPPORTED_RESOURCE_TYPES";
|
|
1983
|
+
readonly EXCLUSION_BY_RESOURCE_TYPES: "EXCLUSION_BY_RESOURCE_TYPES";
|
|
1984
|
+
readonly INCLUSION_BY_RESOURCE_TYPES: "INCLUSION_BY_RESOURCE_TYPES";
|
|
1985
|
+
};
|
|
1986
|
+
/**
|
|
1987
|
+
* @public
|
|
1988
|
+
*/
|
|
1989
|
+
export type RecordingStrategyType = (typeof RecordingStrategyType)[keyof typeof RecordingStrategyType];
|
|
1990
|
+
/**
|
|
1991
|
+
* @public
|
|
1992
|
+
* <p>Specifies the recording strategy of the configuration recorder.</p>
|
|
1993
|
+
*/
|
|
1994
|
+
export interface RecordingStrategy {
|
|
1995
|
+
/**
|
|
1996
|
+
* <p>The recording strategy for the configuration recorder.</p>
|
|
1997
|
+
* <ul>
|
|
1998
|
+
* <li>
|
|
1999
|
+
* <p>If you set this option to <code>ALL_SUPPORTED_RESOURCE_TYPES</code>, Config records configuration changes for all supported regional 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>.</p>
|
|
2000
|
+
* <p>When Config adds support for a new type of regional resource, Config automatically starts recording resources of that type. For a list of supported resource types,
|
|
2001
|
+
* 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>
|
|
2002
|
+
* </li>
|
|
2003
|
+
* <li>
|
|
2004
|
+
* <p>If you set this option to <code>INCLUSION_BY_RESOURCE_TYPES</code>, Config records
|
|
2005
|
+
* configuration changes for only the resource types that you specify in the
|
|
2006
|
+
* <code>resourceTypes</code> field of <a href="https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingGroup.html">RecordingGroup</a>.</p>
|
|
2007
|
+
* </li>
|
|
2008
|
+
* <li>
|
|
2009
|
+
* <p>If you set this option to <code>EXCLUSION_BY_RESOURCE_TYPES</code>, Config records
|
|
2010
|
+
* configuration changes for all supported resource types, except the resource
|
|
2011
|
+
* types that you specify as exemptions to exclude from being recorded in the
|
|
2012
|
+
* <code>resourceTypes</code> field of <a href="https://docs.aws.amazon.com/config/latest/APIReference/API_ExclusionByResourceTypes.html">ExclusionByResourceTypes</a>.</p>
|
|
2013
|
+
* </li>
|
|
2014
|
+
* </ul>
|
|
2015
|
+
* <note>
|
|
2016
|
+
* <p>The <code>recordingStrategy</code> field is optional when you set the
|
|
2017
|
+
* <code>allSupported</code> field of <a href="https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingGroup.html">RecordingGroup</a> to <code>true</code>.</p>
|
|
2018
|
+
* <p>The <code>recordingStrategy</code> field is optional when you list resource types in the
|
|
2019
|
+
* <code>resourceTypes</code> field of <a href="https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingGroup.html">RecordingGroup</a>.</p>
|
|
2020
|
+
* <p>The <code>recordingStrategy</code> field is required if you list resource types to exclude from recording in the <code>resourceTypes</code> field of <a href="https://docs.aws.amazon.com/config/latest/APIReference/API_ExclusionByResourceTypes.html">ExclusionByResourceTypes</a>.</p>
|
|
2021
|
+
* </note>
|
|
2022
|
+
* <note>
|
|
2023
|
+
* <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>
|
|
2024
|
+
* <p>For example, even if you set <code>includeGlobalResourceTypes</code> to false, global resource types will still be automatically
|
|
2025
|
+
* recorded in this option unless those resource types are specifically listed as exemptions in the <code>resourceTypes</code> field of <code>exclusionByResourceTypes</code>.</p>
|
|
2026
|
+
* <p>By default, if you choose the <code>EXCLUSION_BY_RESOURCE_TYPES</code> recording strategy,
|
|
2027
|
+
* when Config adds support for a new resource type in the Region where you set up the configuration recorder, including global resource types,
|
|
2028
|
+
* Config starts recording resources of that type automatically.</p>
|
|
2029
|
+
* </note>
|
|
2030
|
+
*/
|
|
2031
|
+
useOnly?: RecordingStrategyType | string;
|
|
2032
|
+
}
|
|
2033
|
+
/**
|
|
2034
|
+
* @public
|
|
2035
|
+
* <p>Specifies which resource types Config
|
|
2036
|
+
* records for configuration changes.
|
|
2037
|
+
* In the recording group, you specify whether you want to record all supported resource types or to include or exclude specific types of resources.</p>
|
|
2038
|
+
* <p>By default, Config records configuration changes for all supported types of
|
|
2039
|
+
* <i>Regional resources</i> that Config discovers in the
|
|
2040
|
+
* Amazon Web Services Region in which it is running. Regional resources are tied to a
|
|
2041
|
+
* Region and can be used only in that Region. Examples of Regional resources are Amazon EC2 instances and Amazon EBS volumes.</p>
|
|
1974
2042
|
* <p>You can also have Config record supported types of <i>global resources</i>.
|
|
1975
|
-
* Global resources are not tied to a specific
|
|
2043
|
+
* Global resources are not tied to a specific Region and can be used in all Regions. The global
|
|
1976
2044
|
* resource types that Config supports include IAM users, groups, roles, and customer managed
|
|
1977
2045
|
* policies.</p>
|
|
1978
2046
|
* <important>
|
|
1979
|
-
* <p>Global resource types onboarded to Config recording after February 2022 will
|
|
1980
|
-
* recorded in the service's home
|
|
1981
|
-
* Amazon Web Services GovCloud (US)
|
|
1982
|
-
* these new global resource types only in their home
|
|
1983
|
-
*
|
|
1984
|
-
* <code>AWS::IAM::Group</code>, <code>AWS::IAM::Policy</code>, <code>AWS::IAM::Role</code>,
|
|
1985
|
-
* <code>AWS::IAM::User</code> remain unchanged, and they will continue to deliver
|
|
1986
|
-
* Configuration Items in all supported regions in Config. The change will only affect new global
|
|
1987
|
-
* resource types onboarded after February 2022.</p>
|
|
1988
|
-
* <p>To record global resource types onboarded after February 2022,
|
|
1989
|
-
* enable All Supported Resource Types in the home region of the global resource type you want to record.</p>
|
|
2047
|
+
* <p>Global resource types onboarded to Config recording after February 2022 will
|
|
2048
|
+
* be recorded only in the service's home Region for the commercial partition and
|
|
2049
|
+
* Amazon Web Services GovCloud (US-West) for the Amazon Web Services GovCloud (US) partition. You can view the
|
|
2050
|
+
* Configuration Items for these new global resource types only in their home Region
|
|
2051
|
+
* and Amazon Web Services GovCloud (US-West).</p>
|
|
1990
2052
|
* </important>
|
|
1991
|
-
* <p>If you don't want Config to record all resources, you can
|
|
1992
|
-
*
|
|
1993
|
-
*
|
|
1994
|
-
* <p>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>.</p>
|
|
1995
|
-
* <p>For more information and a table of the Home Regions for Global Resource Types Onboarded after February 2022, see <a href="https://docs.aws.amazon.com/config/latest/developerguide/select-resources.html">Selecting Which Resources Config Records</a>.</p>
|
|
2053
|
+
* <p>If you don't want Config to record all resources, you can specify which types of resources Config records with the <code>resourceTypes</code> parameter.</p>
|
|
2054
|
+
* <p>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>
|
|
2055
|
+
* <p>For more information and a table of the Home Regions for Global Resource Types Onboarded after February 2022, see <a href="https://docs.aws.amazon.com/config/latest/developerguide/select-resources.html">Selecting Which Resources Config Records</a> in the <i>Config developer guide</i>.</p>
|
|
1996
2056
|
*/
|
|
1997
2057
|
export interface RecordingGroup {
|
|
1998
2058
|
/**
|
|
1999
|
-
* <p>Specifies whether Config records configuration changes for
|
|
2000
|
-
*
|
|
2001
|
-
*
|
|
2002
|
-
*
|
|
2003
|
-
*
|
|
2004
|
-
* <p>If you set this option to <code>true</code>, you cannot
|
|
2005
|
-
* enumerate a list of <code>resourceTypes</code>.</p>
|
|
2059
|
+
* <p>Specifies whether Config records configuration changes for all supported regional resource types.</p>
|
|
2060
|
+
* <p>If you set this field to <code>true</code>, when Config
|
|
2061
|
+
* adds support for a new type of regional resource, Config starts recording resources of that type automatically.</p>
|
|
2062
|
+
* <p>If you set this field to <code>true</code>,
|
|
2063
|
+
* 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>
|
|
2006
2064
|
*/
|
|
2007
2065
|
allSupported?: boolean;
|
|
2008
2066
|
/**
|
|
2009
|
-
* <p>Specifies whether Config
|
|
2010
|
-
*
|
|
2011
|
-
*
|
|
2012
|
-
*
|
|
2013
|
-
*
|
|
2014
|
-
*
|
|
2015
|
-
* <p>If you set this option to <code>true</code>, when Config
|
|
2016
|
-
* adds support for a new type of global resource, it starts recording
|
|
2067
|
+
* <p>Specifies whether Config records configuration changes for all supported global resources.</p>
|
|
2068
|
+
* <p>Before you set this field to <code>true</code>,
|
|
2069
|
+
* set the <code>allSupported</code> field of <a href="https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingGroup.html">RecordingGroup</a> to
|
|
2070
|
+
* <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>
|
|
2071
|
+
* <p>If you set this field to <code>true</code>, when Config
|
|
2072
|
+
* adds support for a new type of global resource in the Region where you set up the configuration recorder, Config starts recording
|
|
2017
2073
|
* resources of that type automatically.</p>
|
|
2018
|
-
* <
|
|
2019
|
-
*
|
|
2020
|
-
*
|
|
2021
|
-
*
|
|
2074
|
+
* <note>
|
|
2075
|
+
* <p>If you set this field to <code>false</code> but list global resource types in the <code>resourceTypes</code> field of <a href="https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingGroup.html">RecordingGroup</a>,
|
|
2076
|
+
* 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>
|
|
2077
|
+
* <p>If you do not want to record configuration changes to global resource types, make sure to not list them in the <code>resourceTypes</code> field
|
|
2078
|
+
* in addition to setting the <code>includeGlobalResourceTypes</code> field to false.</p>
|
|
2079
|
+
* </note>
|
|
2022
2080
|
*/
|
|
2023
2081
|
includeGlobalResourceTypes?: boolean;
|
|
2024
2082
|
/**
|
|
2025
|
-
* <p>A comma-separated list that specifies
|
|
2026
|
-
*
|
|
2027
|
-
*
|
|
2028
|
-
*
|
|
2029
|
-
*
|
|
2030
|
-
*
|
|
2031
|
-
*
|
|
2032
|
-
*
|
|
2033
|
-
* when Config adds support for a new type of resource,
|
|
2034
|
-
* it will not record resources of that type unless you manually add that type to your recording group.</p>
|
|
2083
|
+
* <p>A comma-separated list that specifies which resource types Config
|
|
2084
|
+
* records.</p>
|
|
2085
|
+
* <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>
|
|
2086
|
+
* <p>To record all configuration changes,
|
|
2087
|
+
* set the <code>allSupported</code> field of <a href="https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingGroup.html">RecordingGroup</a> to
|
|
2088
|
+
* <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>,
|
|
2089
|
+
* when Config adds support for a new type of resource,
|
|
2090
|
+
* it will not record resources of that type unless you manually add that type to your recording group.</p>
|
|
2035
2091
|
* <p>For a list of valid <code>resourceTypes</code> values, see the
|
|
2036
|
-
* <b>
|
|
2037
|
-
* <a href="https://docs.aws.amazon.com/config/latest/developerguide/resource-config-reference.html#supported-resources">Supported Amazon Web Services resource Types</a>.</p>
|
|
2092
|
+
* <b>Resource Type Value</b> column in
|
|
2093
|
+
* <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>
|
|
2094
|
+
* <note>
|
|
2095
|
+
* <p>
|
|
2096
|
+
* <b>Region Availability</b>
|
|
2097
|
+
* </p>
|
|
2098
|
+
* <p>Before specifying a resource type for Config to track,
|
|
2099
|
+
* check <a href="https://docs.aws.amazon.com/config/latest/developerguide/what-is-resource-config-coverage.html">Resource Coverage by Region Availability</a>
|
|
2100
|
+
* to see if the resource type is supported in the Amazon Web Services Region where you set up Config.
|
|
2101
|
+
* If a resource type is supported by Config in at least one Region,
|
|
2102
|
+
* you can enable the recording of that resource type in all Regions supported by Config,
|
|
2103
|
+
* even if the specified resource type is not supported in the Amazon Web Services Region where you set up Config.</p>
|
|
2104
|
+
* </note>
|
|
2038
2105
|
*/
|
|
2039
2106
|
resourceTypes?: (ResourceType | string)[];
|
|
2107
|
+
/**
|
|
2108
|
+
* <p>An object that specifies how Config excludes resource types from being recorded by the configuration recorder.</p>
|
|
2109
|
+
* <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>
|
|
2110
|
+
*/
|
|
2111
|
+
exclusionByResourceTypes?: ExclusionByResourceTypes;
|
|
2112
|
+
/**
|
|
2113
|
+
* <p>An object that specifies the recording strategy for the configuration recorder.</p>
|
|
2114
|
+
* <ul>
|
|
2115
|
+
* <li>
|
|
2116
|
+
* <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 regional 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 type of regional resource, Config automatically starts recording resources of that type.</p>
|
|
2117
|
+
* </li>
|
|
2118
|
+
* <li>
|
|
2119
|
+
* <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>
|
|
2120
|
+
* </li>
|
|
2121
|
+
* <li>
|
|
2122
|
+
* <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>EXCLUSION_BY_RESOURCE_TYPES</code>, Config records configuration changes for all supported resource types
|
|
2123
|
+
* except the resource types that you specify as exemptions to exclude from being recorded in the <code>resourceTypes</code> field of <a href="https://docs.aws.amazon.com/config/latest/APIReference/API_ExclusionByResourceTypes.html">ExclusionByResourceTypes</a>.</p>
|
|
2124
|
+
* </li>
|
|
2125
|
+
* </ul>
|
|
2126
|
+
* <note>
|
|
2127
|
+
* <p>The <code>recordingStrategy</code> field is optional when you set the
|
|
2128
|
+
* <code>allSupported</code> field of <a href="https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingGroup.html">RecordingGroup</a> to <code>true</code>.</p>
|
|
2129
|
+
* <p>The <code>recordingStrategy</code> field is optional when you list resource types in the
|
|
2130
|
+
* <code>resourceTypes</code> field of <a href="https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingGroup.html">RecordingGroup</a>.</p>
|
|
2131
|
+
* <p>The <code>recordingStrategy</code> field is required if you list resource types to exclude from recording in the <code>resourceTypes</code> field of <a href="https://docs.aws.amazon.com/config/latest/APIReference/API_ExclusionByResourceTypes.html">ExclusionByResourceTypes</a>.</p>
|
|
2132
|
+
* </note>
|
|
2133
|
+
* <note>
|
|
2134
|
+
* <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>
|
|
2135
|
+
* <p>For example, even if you set <code>includeGlobalResourceTypes</code> to false, global resource types will still be automatically
|
|
2136
|
+
* recorded in this option unless those resource types are specifically listed as exemptions in the <code>resourceTypes</code> field of <code>exclusionByResourceTypes</code>.</p>
|
|
2137
|
+
* <p>By default, if you choose the <code>EXCLUSION_BY_RESOURCE_TYPES</code> recording strategy,
|
|
2138
|
+
* when Config adds support for a new resource type in the Region where you set up the configuration recorder, including global resource types,
|
|
2139
|
+
* Config starts recording resources of that type automatically.</p>
|
|
2140
|
+
* </note>
|
|
2141
|
+
*/
|
|
2142
|
+
recordingStrategy?: RecordingStrategy;
|
|
2040
2143
|
}
|
|
2041
2144
|
/**
|
|
2042
2145
|
* @public
|
|
2043
|
-
* <p>
|
|
2044
|
-
*
|
|
2146
|
+
* <p>Records configuration changes to specified resource types.
|
|
2147
|
+
* For more information about the configuration recorder,
|
|
2148
|
+
* see <a href="https://docs.aws.amazon.com/config/latest/developerguide/stop-start-recorder.html">
|
|
2149
|
+
* <b>Managing the Configuration Recorder</b>
|
|
2150
|
+
* </a> in the <i>Config Developer Guide</i>.</p>
|
|
2045
2151
|
*/
|
|
2046
2152
|
export interface ConfigurationRecorder {
|
|
2047
2153
|
/**
|
|
2048
|
-
* <p>The name of the recorder.
|
|
2049
|
-
*
|
|
2050
|
-
* You cannot change the assigned name.</p>
|
|
2154
|
+
* <p>The name of the configuration recorder. Config automatically assigns the name of "default" when creating the configuration recorder.</p>
|
|
2155
|
+
* <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>
|
|
2051
2156
|
*/
|
|
2052
2157
|
name?: string;
|
|
2053
2158
|
/**
|
|
2054
|
-
* <p>Amazon Resource Name (ARN) of the IAM role used
|
|
2055
|
-
* Amazon Web Services resources associated with the account.</p>
|
|
2159
|
+
* <p>Amazon Resource Name (ARN) of the IAM role assumed by Config and used by the configuration recorder.</p>
|
|
2056
2160
|
* <note>
|
|
2057
|
-
* <p>While the API model does not require this field, the server will reject a request without a defined roleARN for the configuration recorder.</p>
|
|
2161
|
+
* <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>
|
|
2162
|
+
* </note>
|
|
2163
|
+
* <note>
|
|
2164
|
+
* <p>
|
|
2165
|
+
* <b>Pre-existing Config role</b>
|
|
2166
|
+
* </p>
|
|
2167
|
+
* <p>If you have used an Amazon Web Services service that uses Config, such as Security Hub or
|
|
2168
|
+
* Control Tower, and an Config role has already been created, make sure that the
|
|
2169
|
+
* IAM role that you use when setting up Config keeps the same minimum
|
|
2170
|
+
* permissions as the already created Config role. You must do this so that the
|
|
2171
|
+
* other Amazon Web Services service continues to run as expected. </p>
|
|
2172
|
+
* <p>For example, if Control Tower has an IAM role that allows Config to read
|
|
2173
|
+
* Amazon Simple Storage Service (Amazon S3) objects, make sure that the same permissions are granted
|
|
2174
|
+
* within the IAM role you use when setting up Config. Otherwise, it may
|
|
2175
|
+
* interfere with how Control Tower operates. For more information about IAM
|
|
2176
|
+
* roles for Config,
|
|
2177
|
+
* see <a href="https://docs.aws.amazon.com/config/latest/developerguide/security-iam.html">
|
|
2178
|
+
* <b>Identity and Access Management for Config</b>
|
|
2179
|
+
* </a> in the <i>Config Developer Guide</i>.
|
|
2180
|
+
* </p>
|
|
2058
2181
|
* </note>
|
|
2059
2182
|
*/
|
|
2060
2183
|
roleARN?: string;
|
|
2061
2184
|
/**
|
|
2062
|
-
* <p>Specifies
|
|
2063
|
-
* records configuration changes.</p>
|
|
2185
|
+
* <p>Specifies which resource types Config
|
|
2186
|
+
* records for configuration changes.</p>
|
|
2187
|
+
* <note>
|
|
2188
|
+
* <p>
|
|
2189
|
+
* <b> High Number of Config Evaluations</b>
|
|
2190
|
+
* </p>
|
|
2191
|
+
* <p>You may notice increased activity in your account during your initial month recording with Config when compared to subsequent months. During the
|
|
2192
|
+
* initial bootstrapping process, Config runs evaluations on all the resources in your account that you have selected
|
|
2193
|
+
* for Config to record.</p>
|
|
2194
|
+
* <p>If you are running ephemeral workloads, you may see increased activity from Config as it records configuration changes associated with creating and deleting these
|
|
2195
|
+
* temporary resources. An <i>ephemeral workload</i> is a temporary use of computing resources that are loaded
|
|
2196
|
+
* and run when needed. Examples include Amazon Elastic Compute Cloud (Amazon EC2)
|
|
2197
|
+
* Spot Instances, Amazon EMR jobs, and Auto Scaling. If you want
|
|
2198
|
+
* to avoid the increased activity from running ephemeral workloads, you can run these
|
|
2199
|
+
* types of workloads in a separate account with Config turned off to avoid
|
|
2200
|
+
* increased configuration recording and rule evaluations.</p>
|
|
2201
|
+
* </note>
|
|
2064
2202
|
*/
|
|
2065
2203
|
recordingGroup?: RecordingGroup;
|
|
2066
2204
|
}
|
|
@@ -3279,7 +3417,7 @@ export interface DescribeConfigRuleEvaluationStatusResponse {
|
|
|
3279
3417
|
* <p>Returns a filtered list of Detective or Proactive Config rules. By default, if the filter is not defined, this API returns an unfiltered list. For more information on Detective or Proactive Config rules,
|
|
3280
3418
|
* see <a href="https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config-rules.html">
|
|
3281
3419
|
* <b>Evaluation Mode</b>
|
|
3282
|
-
* </a> in the Config Developer Guide
|
|
3420
|
+
* </a> in the <i>Config Developer Guide</i>.</p>
|
|
3283
3421
|
*/
|
|
3284
3422
|
export interface DescribeConfigRulesFilters {
|
|
3285
3423
|
/**
|
|
@@ -3308,7 +3446,7 @@ export interface DescribeConfigRulesRequest {
|
|
|
3308
3446
|
* <p>Returns a list of Detective or Proactive Config rules. By default, this API returns an unfiltered list. For more information on Detective or Proactive Config rules,
|
|
3309
3447
|
* see <a href="https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config-rules.html">
|
|
3310
3448
|
* <b>Evaluation Mode</b>
|
|
3311
|
-
* </a> in the Config Developer Guide
|
|
3449
|
+
* </a> in the <i>Config Developer Guide</i>.</p>
|
|
3312
3450
|
*/
|
|
3313
3451
|
Filters?: DescribeConfigRulesFilters;
|
|
3314
3452
|
}
|
|
@@ -3646,7 +3784,7 @@ export declare const OrganizationConfigRuleTriggerTypeNoSN: {
|
|
|
3646
3784
|
export type OrganizationConfigRuleTriggerTypeNoSN = (typeof OrganizationConfigRuleTriggerTypeNoSN)[keyof typeof OrganizationConfigRuleTriggerTypeNoSN];
|
|
3647
3785
|
/**
|
|
3648
3786
|
* @public
|
|
3649
|
-
* <p>
|
|
3787
|
+
* <p> metadata for your organization Config Custom Policy rule including the runtime system in use, which accounts have debug logging enabled, and
|
|
3650
3788
|
* other custom rule metadata such as resource type, resource ID of Amazon Web Services
|
|
3651
3789
|
* resource, and organization trigger types that trigger Config to evaluate
|
|
3652
3790
|
* Amazon Web Services resources against a rule.</p>
|
|
@@ -3724,7 +3862,7 @@ export declare const OrganizationConfigRuleTriggerType: {
|
|
|
3724
3862
|
export type OrganizationConfigRuleTriggerType = (typeof OrganizationConfigRuleTriggerType)[keyof typeof OrganizationConfigRuleTriggerType];
|
|
3725
3863
|
/**
|
|
3726
3864
|
* @public
|
|
3727
|
-
* <p>
|
|
3865
|
+
* <p> organization custom rule metadata such as resource type, resource ID of Amazon Web Services resource, Lambda function ARN,
|
|
3728
3866
|
* and organization trigger types that trigger Config to evaluate your Amazon Web Services resources against a rule.
|
|
3729
3867
|
* It also provides the frequency with which you want Config to run evaluations for the rule if the trigger type is periodic.</p>
|
|
3730
3868
|
*/
|
|
@@ -3790,7 +3928,7 @@ export interface OrganizationCustomRuleMetadata {
|
|
|
3790
3928
|
}
|
|
3791
3929
|
/**
|
|
3792
3930
|
* @public
|
|
3793
|
-
* <p>
|
|
3931
|
+
* <p> organization managed rule metadata such as resource type and ID of Amazon Web Services resource along with the rule identifier.
|
|
3794
3932
|
* It also provides the frequency with which you want Config to run evaluations for the rule if the trigger type is periodic.</p>
|
|
3795
3933
|
*/
|
|
3796
3934
|
export interface OrganizationManagedRuleMetadata {
|
|
@@ -6051,7 +6189,7 @@ export declare class InsufficientDeliveryPolicyException extends __BaseException
|
|
|
6051
6189
|
}
|
|
6052
6190
|
/**
|
|
6053
6191
|
* @public
|
|
6054
|
-
* <p>You have provided a configuration recorder
|
|
6192
|
+
* <p>You have provided a name for the configuration recorder that is not
|
|
6055
6193
|
* valid.</p>
|
|
6056
6194
|
*/
|
|
6057
6195
|
export declare class InvalidConfigurationRecorderNameException extends __BaseException {
|
|
@@ -6088,7 +6226,30 @@ export declare class InvalidExpressionException extends __BaseException {
|
|
|
6088
6226
|
}
|
|
6089
6227
|
/**
|
|
6090
6228
|
* @public
|
|
6091
|
-
* <p>
|
|
6229
|
+
* <p>Indicates one of the following errors:</p>
|
|
6230
|
+
* <ul>
|
|
6231
|
+
* <li>
|
|
6232
|
+
* <p>You have provided a combination of parameter values that is not valid. For example:</p>
|
|
6233
|
+
* <ul>
|
|
6234
|
+
* <li>
|
|
6235
|
+
* <p>Setting 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>,
|
|
6236
|
+
* but providing a non-empty list for the <code>resourceTypes</code>field of <a href="https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingGroup.html">RecordingGroup</a>.</p>
|
|
6237
|
+
* </li>
|
|
6238
|
+
* <li>
|
|
6239
|
+
* <p>Setting 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>, but also setting 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>
|
|
6240
|
+
* </li>
|
|
6241
|
+
* </ul>
|
|
6242
|
+
* </li>
|
|
6243
|
+
* <li>
|
|
6244
|
+
* <p>Every parameter is either null, false, or empty.</p>
|
|
6245
|
+
* </li>
|
|
6246
|
+
* <li>
|
|
6247
|
+
* <p>You have reached the limit of the number of resource types you can provide for the recording group.</p>
|
|
6248
|
+
* </li>
|
|
6249
|
+
* <li>
|
|
6250
|
+
* <p>You have provided resource types or a recording strategy that are not valid.</p>
|
|
6251
|
+
* </li>
|
|
6252
|
+
* </ul>
|
|
6092
6253
|
*/
|
|
6093
6254
|
export declare class InvalidRecordingGroupException extends __BaseException {
|
|
6094
6255
|
readonly name: "InvalidRecordingGroupException";
|
|
@@ -6112,7 +6273,7 @@ export declare class InvalidResultTokenException extends __BaseException {
|
|
|
6112
6273
|
}
|
|
6113
6274
|
/**
|
|
6114
6275
|
* @public
|
|
6115
|
-
* <p>You have provided a null or empty role
|
|
6276
|
+
* <p>You have provided a null or empty Amazon Resource Name (ARN) for the IAM role assumed by Config and used by the configuration recorder.</p>
|
|
6116
6277
|
*/
|
|
6117
6278
|
export declare class InvalidRoleException extends __BaseException {
|
|
6118
6279
|
readonly name: "InvalidRoleException";
|
|
@@ -6571,44 +6732,3 @@ export declare class MaxActiveResourcesExceededException extends __BaseException
|
|
|
6571
6732
|
*/
|
|
6572
6733
|
constructor(opts: __ExceptionOptionType<MaxActiveResourcesExceededException, __BaseException>);
|
|
6573
6734
|
}
|
|
6574
|
-
/**
|
|
6575
|
-
* @public
|
|
6576
|
-
* <p>Failed to add the Config rule because the account already
|
|
6577
|
-
* contains the maximum number of 150 rules. Consider deleting any
|
|
6578
|
-
* deactivated rules before you add new rules.</p>
|
|
6579
|
-
*/
|
|
6580
|
-
export declare class MaxNumberOfConfigRulesExceededException extends __BaseException {
|
|
6581
|
-
readonly name: "MaxNumberOfConfigRulesExceededException";
|
|
6582
|
-
readonly $fault: "client";
|
|
6583
|
-
/**
|
|
6584
|
-
* @internal
|
|
6585
|
-
*/
|
|
6586
|
-
constructor(opts: __ExceptionOptionType<MaxNumberOfConfigRulesExceededException, __BaseException>);
|
|
6587
|
-
}
|
|
6588
|
-
/**
|
|
6589
|
-
* @public
|
|
6590
|
-
* <p>You have reached the limit of the number of recorders you can
|
|
6591
|
-
* create.</p>
|
|
6592
|
-
*/
|
|
6593
|
-
export declare class MaxNumberOfConfigurationRecordersExceededException extends __BaseException {
|
|
6594
|
-
readonly name: "MaxNumberOfConfigurationRecordersExceededException";
|
|
6595
|
-
readonly $fault: "client";
|
|
6596
|
-
/**
|
|
6597
|
-
* @internal
|
|
6598
|
-
*/
|
|
6599
|
-
constructor(opts: __ExceptionOptionType<MaxNumberOfConfigurationRecordersExceededException, __BaseException>);
|
|
6600
|
-
}
|
|
6601
|
-
/**
|
|
6602
|
-
* @public
|
|
6603
|
-
* <p>You have reached the limit of the number of conformance packs you can create in an account. For more information, see <a href="https://docs.aws.amazon.com/config/latest/developerguide/configlimits.html">
|
|
6604
|
-
* <b>Service Limits</b>
|
|
6605
|
-
* </a> in the Config Developer Guide.</p>
|
|
6606
|
-
*/
|
|
6607
|
-
export declare class MaxNumberOfConformancePacksExceededException extends __BaseException {
|
|
6608
|
-
readonly name: "MaxNumberOfConformancePacksExceededException";
|
|
6609
|
-
readonly $fault: "client";
|
|
6610
|
-
/**
|
|
6611
|
-
* @internal
|
|
6612
|
-
*/
|
|
6613
|
-
constructor(opts: __ExceptionOptionType<MaxNumberOfConformancePacksExceededException, __BaseException>);
|
|
6614
|
-
}
|
|
@@ -1,6 +1,47 @@
|
|
|
1
1
|
import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
|
|
2
2
|
import { ConfigServiceServiceException as __BaseException } from "./ConfigServiceServiceException";
|
|
3
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, Tag, TemplateSSMDocumentDetails } from "./models_0";
|
|
4
|
+
/**
|
|
5
|
+
* @public
|
|
6
|
+
* <p>Failed to add the Config rule because the account already
|
|
7
|
+
* contains the maximum number of 150 rules. Consider deleting any
|
|
8
|
+
* deactivated rules before you add new rules.</p>
|
|
9
|
+
*/
|
|
10
|
+
export declare class MaxNumberOfConfigRulesExceededException extends __BaseException {
|
|
11
|
+
readonly name: "MaxNumberOfConfigRulesExceededException";
|
|
12
|
+
readonly $fault: "client";
|
|
13
|
+
/**
|
|
14
|
+
* @internal
|
|
15
|
+
*/
|
|
16
|
+
constructor(opts: __ExceptionOptionType<MaxNumberOfConfigRulesExceededException, __BaseException>);
|
|
17
|
+
}
|
|
18
|
+
/**
|
|
19
|
+
* @public
|
|
20
|
+
* <p>You have reached the limit of the number of configuration recorders you can
|
|
21
|
+
* create.</p>
|
|
22
|
+
*/
|
|
23
|
+
export declare class MaxNumberOfConfigurationRecordersExceededException extends __BaseException {
|
|
24
|
+
readonly name: "MaxNumberOfConfigurationRecordersExceededException";
|
|
25
|
+
readonly $fault: "client";
|
|
26
|
+
/**
|
|
27
|
+
* @internal
|
|
28
|
+
*/
|
|
29
|
+
constructor(opts: __ExceptionOptionType<MaxNumberOfConfigurationRecordersExceededException, __BaseException>);
|
|
30
|
+
}
|
|
31
|
+
/**
|
|
32
|
+
* @public
|
|
33
|
+
* <p>You have reached the limit of the number of conformance packs you can create in an account. For more information, see <a href="https://docs.aws.amazon.com/config/latest/developerguide/configlimits.html">
|
|
34
|
+
* <b>Service Limits</b>
|
|
35
|
+
* </a> in the <i>Config Developer Guide</i>.</p>
|
|
36
|
+
*/
|
|
37
|
+
export declare class MaxNumberOfConformancePacksExceededException extends __BaseException {
|
|
38
|
+
readonly name: "MaxNumberOfConformancePacksExceededException";
|
|
39
|
+
readonly $fault: "client";
|
|
40
|
+
/**
|
|
41
|
+
* @internal
|
|
42
|
+
*/
|
|
43
|
+
constructor(opts: __ExceptionOptionType<MaxNumberOfConformancePacksExceededException, __BaseException>);
|
|
44
|
+
}
|
|
4
45
|
/**
|
|
5
46
|
* @public
|
|
6
47
|
* <p>You have reached the limit of the number of delivery channels
|
|
@@ -18,7 +59,7 @@ export declare class MaxNumberOfDeliveryChannelsExceededException extends __Base
|
|
|
18
59
|
* @public
|
|
19
60
|
* <p>You have reached the limit of the number of organization Config rules you can create. For more information, see see <a href="https://docs.aws.amazon.com/config/latest/developerguide/configlimits.html">
|
|
20
61
|
* <b>Service Limits</b>
|
|
21
|
-
* </a> in the Config Developer Guide
|
|
62
|
+
* </a> in the <i>Config Developer Guide</i>.</p>
|
|
22
63
|
*/
|
|
23
64
|
export declare class MaxNumberOfOrganizationConfigRulesExceededException extends __BaseException {
|
|
24
65
|
readonly name: "MaxNumberOfOrganizationConfigRulesExceededException";
|
|
@@ -32,7 +73,7 @@ export declare class MaxNumberOfOrganizationConfigRulesExceededException extends
|
|
|
32
73
|
* @public
|
|
33
74
|
* <p>You have reached the limit of the number of organization conformance packs you can create in an account. For more information, see <a href="https://docs.aws.amazon.com/config/latest/developerguide/configlimits.html">
|
|
34
75
|
* <b>Service Limits</b>
|
|
35
|
-
* </a> in the Config Developer Guide
|
|
76
|
+
* </a> in the <i>Config Developer Guide</i>.</p>
|
|
36
77
|
*/
|
|
37
78
|
export declare class MaxNumberOfOrganizationConformancePacksExceededException extends __BaseException {
|
|
38
79
|
readonly name: "MaxNumberOfOrganizationConformancePacksExceededException";
|
|
@@ -265,8 +306,7 @@ export interface PutConfigurationAggregatorResponse {
|
|
|
265
306
|
*/
|
|
266
307
|
export interface PutConfigurationRecorderRequest {
|
|
267
308
|
/**
|
|
268
|
-
* <p>
|
|
269
|
-
* configuration change made to the resources.</p>
|
|
309
|
+
* <p>An object for the configuration recorder to record configuration changes for specified resource types.</p>
|
|
270
310
|
*/
|
|
271
311
|
ConfigurationRecorder: ConfigurationRecorder | undefined;
|
|
272
312
|
}
|
|
@@ -645,7 +685,7 @@ export declare class ResourceConcurrentModificationException extends __BaseExcep
|
|
|
645
685
|
* <p>You have reached the limit of the number of tags you can use.
|
|
646
686
|
* For more information, see <a href="https://docs.aws.amazon.com/config/latest/developerguide/configlimits.html">
|
|
647
687
|
* <b>Service Limits</b>
|
|
648
|
-
* </a> in the Config Developer Guide
|
|
688
|
+
* </a> in the <i>Config Developer Guide</i>.</p>
|
|
649
689
|
*/
|
|
650
690
|
export declare class TooManyTagsException extends __BaseException {
|
|
651
691
|
readonly name: "TooManyTagsException";
|
|
@@ -699,10 +699,25 @@ export interface ConfigurationItem {
|
|
|
699
699
|
configuration?: string;
|
|
700
700
|
supplementaryConfiguration?: Record<string, string>;
|
|
701
701
|
}
|
|
702
|
+
export interface ExclusionByResourceTypes {
|
|
703
|
+
resourceTypes?: (ResourceType | string)[];
|
|
704
|
+
}
|
|
705
|
+
export declare const RecordingStrategyType: {
|
|
706
|
+
readonly ALL_SUPPORTED_RESOURCE_TYPES: "ALL_SUPPORTED_RESOURCE_TYPES";
|
|
707
|
+
readonly EXCLUSION_BY_RESOURCE_TYPES: "EXCLUSION_BY_RESOURCE_TYPES";
|
|
708
|
+
readonly INCLUSION_BY_RESOURCE_TYPES: "INCLUSION_BY_RESOURCE_TYPES";
|
|
709
|
+
};
|
|
710
|
+
export type RecordingStrategyType =
|
|
711
|
+
(typeof RecordingStrategyType)[keyof typeof RecordingStrategyType];
|
|
712
|
+
export interface RecordingStrategy {
|
|
713
|
+
useOnly?: RecordingStrategyType | string;
|
|
714
|
+
}
|
|
702
715
|
export interface RecordingGroup {
|
|
703
716
|
allSupported?: boolean;
|
|
704
717
|
includeGlobalResourceTypes?: boolean;
|
|
705
718
|
resourceTypes?: (ResourceType | string)[];
|
|
719
|
+
exclusionByResourceTypes?: ExclusionByResourceTypes;
|
|
720
|
+
recordingStrategy?: RecordingStrategy;
|
|
706
721
|
}
|
|
707
722
|
export interface ConfigurationRecorder {
|
|
708
723
|
name?: string;
|
|
@@ -2030,33 +2045,3 @@ export declare class MaxActiveResourcesExceededException extends __BaseException
|
|
|
2030
2045
|
>
|
|
2031
2046
|
);
|
|
2032
2047
|
}
|
|
2033
|
-
export declare class MaxNumberOfConfigRulesExceededException extends __BaseException {
|
|
2034
|
-
readonly name: "MaxNumberOfConfigRulesExceededException";
|
|
2035
|
-
readonly $fault: "client";
|
|
2036
|
-
constructor(
|
|
2037
|
-
opts: __ExceptionOptionType<
|
|
2038
|
-
MaxNumberOfConfigRulesExceededException,
|
|
2039
|
-
__BaseException
|
|
2040
|
-
>
|
|
2041
|
-
);
|
|
2042
|
-
}
|
|
2043
|
-
export declare class MaxNumberOfConfigurationRecordersExceededException extends __BaseException {
|
|
2044
|
-
readonly name: "MaxNumberOfConfigurationRecordersExceededException";
|
|
2045
|
-
readonly $fault: "client";
|
|
2046
|
-
constructor(
|
|
2047
|
-
opts: __ExceptionOptionType<
|
|
2048
|
-
MaxNumberOfConfigurationRecordersExceededException,
|
|
2049
|
-
__BaseException
|
|
2050
|
-
>
|
|
2051
|
-
);
|
|
2052
|
-
}
|
|
2053
|
-
export declare class MaxNumberOfConformancePacksExceededException extends __BaseException {
|
|
2054
|
-
readonly name: "MaxNumberOfConformancePacksExceededException";
|
|
2055
|
-
readonly $fault: "client";
|
|
2056
|
-
constructor(
|
|
2057
|
-
opts: __ExceptionOptionType<
|
|
2058
|
-
MaxNumberOfConformancePacksExceededException,
|
|
2059
|
-
__BaseException
|
|
2060
|
-
>
|
|
2061
|
-
);
|
|
2062
|
-
}
|