Aws/pi
@swamp/aws/piv2026.10.06.1
01README
AWS PI infrastructure models
02Models
@swamp/aws/pi/perf-reportsv2026.09.23.1perf_reports.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. |
| ServiceType | enum | The AWS service for which Performance Insights returns metrics. Valid values are RDS and DOCDB. |
| Identifier | string | An immutable, AWS Region-unique identifier for a data source. Performance Insights gathers metrics from this data source. To use an Amazon RDS instance as a data source, specify its DbiResourceId value. |
| StartTime | string | The start time defined for the analysis report in ISO 8601 format. |
| EndTime | string | The end time defined for the analysis report in ISO 8601 format. |
| Tags? | array | An array of key-value pairs to apply to this resource. |
fn create()
Create a PI PerfReports
fn get(identifier: string)
Get a PI PerfReports
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the PI PerfReports |
fn delete(identifier: string)
Delete a PI PerfReports
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the PI PerfReports |
fn sync()
Sync PI PerfReports state from AWS
fn list(maxPages?: number, resourceModel?: string)
List PI PerfReports 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)— PI PerfReports resource state
03Previous Versions
2026.10.04.1
2026.10.03.1
2026.10.02.1
2026.10.01.1
2026.09.30.1
2026.09.29.1
2026.09.28.1
2026.09.27.1
2026.09.26.1
2026.09.25.1
2026.09.24.1
2026.09.23.1
- Added: perf_reports
04Stats
A
100 / 100
Downloads
14
Archive size
208.9 KB
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