Aws/config
@swamp/aws/configv2026.08.21.1
01README
AWS CONFIG infrastructure models
02Models
@swamp/aws/config/aggregation-authorizationv2026.08.17.2aggregation_authorization.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| AuthorizedAccountId | string | The 12-digit account ID of the account authorized to aggregate data. |
| AuthorizedAwsRegion | string | The region authorized to collect aggregated data. |
| Tags? | array | The tags for the AggregationAuthorization. |
fn create()
Create a Config AggregationAuthorization
fn get(identifier: string)
Get a Config AggregationAuthorization
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Config AggregationAuthorization |
fn update()
Update a Config AggregationAuthorization
fn delete(identifier: string)
Delete a Config AggregationAuthorization
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Config AggregationAuthorization |
fn sync()
Sync Config AggregationAuthorization state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Config AggregationAuthorization resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— Config AggregationAuthorization resource state
@swamp/aws/config/config-rulev2026.08.20.1config_rule.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| Description? | string | The description that you provide for the CC rule. |
| Scope? | object | Defines which resources can trigger an evaluation for the rule. The scope can include one or more resource types, a combination of one resource type and one resource ID, or a combination of a tag key and value. Specify a scope to constrain the resources that can trigger an evaluation for the rule. If you do not specify a scope, evaluations are triggered when any resource in the recording group changes. |
| ConfigRuleName? | string | A name for the CC rule. If you don't specify a name, CFN generates a unique physical ID and uses that ID for the rule name. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html). |
| MaximumExecutionFrequency? | string | The maximum frequency with which CC runs evaluations for a rule. You can specify a value for MaximumExecutionFrequency when: You are using an AWS managed rule that is triggered at a periodic frequency. Your custom rule is triggered when CC delivers the configuration snapshot. For more information, see [ConfigSnapshotDeliveryProperties](https://docs.aws.amazon.com/config/latest/APIReference/API_ConfigSnapshotDeliveryProperties.html). By default, rules with a periodic trigger are evaluated every 2 |
| Source | object | Provides the rule owner (`` for managed rules, CUSTOM_POLICY for Custom Policy rules, and CUSTOM_LAMBDA`` for Custom Lambda rules), the rule identifier, and the notifications that cause the function to evaluate your AWS resources. |
| InputParameters? | record | A string, in JSON format, that is passed to the CC rule Lambda function. |
| EvaluationModes? | array | The modes the CC rule can be evaluated in. The valid values are distinct objects. By default, the value is Detective evaluation mode only. |
fn create()
Create a Config ConfigRule
fn get(identifier: string)
Get a Config ConfigRule
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Config ConfigRule |
fn update()
Update a Config ConfigRule
fn delete(identifier: string)
Delete a Config ConfigRule
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Config ConfigRule |
fn sync()
Sync Config ConfigRule state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Config ConfigRule resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— Config ConfigRule resource state
@swamp/aws/config/configuration-aggregatorv2026.08.17.2configuration_aggregator.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| AccountAggregationSources? | array | |
| ConfigurationAggregatorName? | string | The name of the aggregator. |
| OrganizationAggregationSource? | object | |
| Tags? | array | The tags for the configuration aggregator. |
fn create()
Create a Config ConfigurationAggregator
fn get(identifier: string)
Get a Config ConfigurationAggregator
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Config ConfigurationAggregator |
fn update()
Update a Config ConfigurationAggregator
fn delete(identifier: string)
Delete a Config ConfigurationAggregator
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Config ConfigurationAggregator |
fn sync()
Sync Config ConfigurationAggregator state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Config ConfigurationAggregator resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— Config ConfigurationAggregator resource state
@swamp/aws/config/conformance-packv2026.08.17.2conformance_pack.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| ConformancePackName | string | Name of the conformance pack which will be assigned as the unique identifier. |
| DeliveryS3Bucket? | string | AWS Config stores intermediate files while processing conformance pack template. |
| DeliveryS3KeyPrefix? | string | The prefix for delivery S3 bucket. |
| TemplateBody? | string | A string containing full conformance pack template body. You can only specify one of the template body or template S3Uri fields. |
| TemplateS3Uri? | string | Location of file containing the template body which points to the conformance pack template that is located in an Amazon S3 bucket. You can only specify one of the template body or template S3Uri fields. |
| TemplateSSMDocumentDetails? | object | The TemplateSSMDocumentDetails object contains the name of the SSM document and the version of the SSM document. |
| ConformancePackInputParameters? | array | A list of ConformancePackInputParameter objects. |
| Tags? | array | The tags for the conformance pack. |
fn create()
Create a Config ConformancePack
fn get(identifier: string)
Get a Config ConformancePack
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Config ConformancePack |
fn update()
Update a Config ConformancePack
fn delete(identifier: string)
Delete a Config ConformancePack
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Config ConformancePack |
fn sync()
Sync Config ConformancePack state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Config ConformancePack resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— Config ConformancePack resource state
@swamp/aws/config/connectorv2026.08.17.2connector.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| ConnectorConfiguration | object | The configuration for the connector that specifies the third-party cloud provider connection details. |
| Tags? | array | The tags for the connector. |
fn create()
Create a Config Connector
fn get(identifier: string)
Get a Config Connector
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Config Connector |
fn update()
Update a Config Connector
fn delete(identifier: string)
Delete a Config Connector
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Config Connector |
fn sync()
Sync Config Connector state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Config Connector resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— Config Connector resource state
@swamp/aws/config/organization-conformance-packv2026.08.17.2organization_conformance_pack.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| OrganizationConformancePackName | string | The name of the organization conformance pack. |
| TemplateS3Uri? | string | Location of file containing the template body. |
| TemplateBody? | string | A string containing full conformance pack template body. |
| DeliveryS3Bucket? | string | AWS Config stores intermediate files while processing conformance pack template. |
| DeliveryS3KeyPrefix? | string | The prefix for the delivery S3 bucket. |
| ConformancePackInputParameters? | array | A list of ConformancePackInputParameter objects. |
| ExcludedAccounts? | array | A list of AWS accounts to be excluded from an organization conformance pack while deploying a conformance pack. |
| Tags? | array | The tags for the organization conformance pack. |
fn create()
Create a Config OrganizationConformancePack
fn get(identifier: string)
Get a Config OrganizationConformancePack
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Config OrganizationConformancePack |
fn update()
Update a Config OrganizationConformancePack
fn delete(identifier: string)
Delete a Config OrganizationConformancePack
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Config OrganizationConformancePack |
fn sync()
Sync Config OrganizationConformancePack state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Config OrganizationConformancePack resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— Config OrganizationConformancePack resource state
@swamp/aws/config/remediation-configurationv2026.08.17.2remediation_configuration.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| TargetVersion? | string | |
| ExecutionControls? | object | |
| Parameters? | record | |
| TargetType | string | |
| ConfigRuleName | string | |
| ResourceType? | string | |
| RetryAttemptSeconds? | number | |
| MaximumAutomaticAttempts? | number | |
| TargetId | string | |
| Automatic? | boolean |
fn create()
Create a Config RemediationConfiguration
fn get(identifier: string)
Get a Config RemediationConfiguration
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Config RemediationConfiguration |
fn update()
Update a Config RemediationConfiguration
fn delete(identifier: string)
Delete a Config RemediationConfiguration
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Config RemediationConfiguration |
fn sync()
Sync Config RemediationConfiguration state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Config RemediationConfiguration resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— Config RemediationConfiguration resource state
@swamp/aws/config/stored-queryv2026.08.17.2stored_query.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| QueryName | string | |
| QueryDescription? | string | |
| QueryExpression | string | |
| Tags? | array | The tags for the stored query. |
fn create()
Create a Config StoredQuery
fn get(identifier: string)
Get a Config StoredQuery
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Config StoredQuery |
fn update()
Update a Config StoredQuery
fn delete(identifier: string)
Delete a Config StoredQuery
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Config StoredQuery |
fn sync()
Sync Config StoredQuery state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Config StoredQuery resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— Config StoredQuery resource state
03Previous Versions
2026.08.20.1
- Updated: config_rule
2026.08.19.1
2026.08.18.1
2026.08.17.5
2026.08.17.4
Modified 8 models
2026.08.16.1
2026.08.15.1
2026.08.14.1
2026.08.13.1
2026.08.11.1
2026.08.07.1
2026.08.06.1
2026.08.05.1
2026.08.04.1
2026.08.03.1
2026.08.02.1
2026.08.01.1
2026.07.31.1
2026.07.30.1
04Stats
A
100 / 100
Downloads
0
Archive size
1.8 MB
Verified by Swamp
- Has README or module doc2/2earned
- README has a code example1/1earned
- README is substantive1/1earned
- Most symbols documented1/1earned
- No slow types (deprecated)1/1earned
- Dependencies pass trust audit2/2earned
- Has description1/1earned
- Platform support declared (or universal)2/2earned
- License declared1/1earned
- Verified public repository2/2earned
05Platforms
06Labels