Aws/redshiftserverless
@swamp/aws/redshiftserverlessv2026.10.25.1
01README
AWS REDSHIFTSERVERLESS infrastructure models
02Release Notes
- Updated: namespace, snapshot, workgroup
03Behaviors
@swamp/aws/redshiftserverless/namespacev2026.10.25.1namespace.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. |
| AdminPasswordSecretKmsKeyId? | string | The ID of the AWS Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret. You can only use this parameter if manageAdminPassword is true. |
| AdminUserPassword? | string | The password associated with the admin user for the namespace that is being created. Password must be at least 8 characters in length, should be any printable ASCII character. Must contain at least one lowercase letter, one uppercase letter and one decimal digit. You can't use adminUserPassword if manageAdminPassword is true. |
| AdminUsername? | string | The user name associated with the admin user for the namespace that is being created. Only alphanumeric characters and underscores are allowed. It should start with an alphabet. |
| DbName? | string | The database name associated for the namespace that is being created. Only alphanumeric characters and underscores are allowed. It should start with an alphabet. |
| DefaultIamRoleArn? | string | The default IAM role ARN for the namespace that is being created. |
| IamRoles? | array | A list of AWS Identity and Access Management (IAM) roles that can be used by the namespace to access other AWS services. You must supply the IAM roles in their Amazon Resource Name (ARN) format. The Default role limit for each request is 10. |
| KmsKeyId? | string | The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the namespace. |
| LogExports? | array | The collection of log types to be exported provided by the customer. Should only be one of the three supported log types: userlog, useractivitylog and connectionlog |
| ManageAdminPassword? | boolean | If true, Amazon Redshift uses AWS Secrets Manager to manage the namespace's admin credentials. You can't use adminUserPassword if manageAdminPassword is true. If manageAdminPassword is false or not set, Amazon Redshift uses adminUserPassword for the admin user account's password. |
| Namespace? | object | Definition of Namespace resource. |
| NamespaceName | string | A unique identifier for the namespace. You use this identifier to refer to the namespace for any subsequent namespace operations such as deleting or modifying. All alphabetical characters must be lower case. Namespace name should be unique for all namespaces within an AWS account. |
| Tags? | array | The list of tags for the namespace. |
| FinalSnapshotName? | string | The name of the namespace the source snapshot was created from. Please specify the name if needed before deleting namespace |
| FinalSnapshotRetentionPeriod? | number | The number of days to retain automated snapshot in the destination region after they are copied from the source region. If the value is -1, the manual snapshot is retained indefinitely. The value must be either -1 or an integer between 1 and 3,653. |
| NamespaceResourcePolicy? | record | The resource policy document that will be attached to the namespace. |
| RedshiftIdcApplicationArn? | string | The ARN for the Redshift application that integrates with IAM Identity Center. |
| SnapshotCopyConfigurations? | array | The snapshot copy configurations for the namespace. |
fn create()
Create a RedshiftServerless Namespace
fn get(identifier: string)
Get a RedshiftServerless Namespace
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the RedshiftServerless Namespace |
fn update()
Update a RedshiftServerless Namespace
fn delete(identifier: string)
Delete a RedshiftServerless Namespace
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the RedshiftServerless Namespace |
fn sync()
Sync RedshiftServerless Namespace state from AWS
fn list(maxPages?: number, resourceModel?: string)
List RedshiftServerless Namespace 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)— RedshiftServerless Namespace resource state
@swamp/aws/redshiftserverless/snapshotv2026.10.25.1snapshot.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. |
| SnapshotName | string | The name of the snapshot. |
| NamespaceName? | string | The namespace the snapshot is associated with. |
| RetentionPeriod? | number | The retention period of the snapshot. |
| Tags? | array | An array of key-value pairs to apply to this resource. |
fn create()
Create a RedshiftServerless Snapshot
fn get(identifier: string)
Get a RedshiftServerless Snapshot
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the RedshiftServerless Snapshot |
fn update()
Update a RedshiftServerless Snapshot
fn delete(identifier: string)
Delete a RedshiftServerless Snapshot
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the RedshiftServerless Snapshot |
fn sync()
Sync RedshiftServerless Snapshot state from AWS
fn list(maxPages?: number, resourceModel?: string)
List RedshiftServerless Snapshot 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)— RedshiftServerless Snapshot resource state
@swamp/aws/redshiftserverless/workgroupv2026.10.25.1workgroup.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. |
| WorkgroupName | string | The name of the workgroup. |
| NamespaceName? | string | The namespace the workgroup is associated with. |
| BaseCapacity? | number | The base compute capacity of the workgroup in Redshift Processing Units (RPUs). |
| MaxCapacity? | number | The max compute capacity of the workgroup in Redshift Processing Units (RPUs). |
| EnhancedVpcRouting? | boolean | The value that specifies whether to enable enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC. |
| ConfigParameters? | array | A list of parameters to set for finer control over a database. Available options are datestyle, enable_user_activity_logging, query_group, search_path, max_query_execution_time, and require_ssl. |
| SecurityGroupIds? | array | A list of security group IDs to associate with the workgroup. |
| SubnetIds? | array | A list of subnet IDs the workgroup is associated with. |
| PubliclyAccessible? | boolean | A value that specifies whether the workgroup can be accessible from a public network. |
| Port? | number | The custom port to use when connecting to a workgroup. Valid port ranges are 5431-5455 and 8191-8215. The default is 5439. |
| PricePerformanceTarget? | object | A property that represents the price performance target settings for the workgroup. |
| SnapshotArn? | string | The Amazon Resource Name (ARN) of the snapshot to restore the namespace from. Specify either SnapshotArn or SnapshotName, but not both. When this resource is first created, the namespace is restored from this snapshot. On subsequent updates, a restore occurs only when SnapshotArn changes from its previous value. If the value is unchanged or removed, no restore takes place and existing data is preserved. |
| SnapshotName? | string | The name of the snapshot to restore the namespace from. Because snapshot names are unique only within an account, also specify SnapshotOwnerAccount when restoring from a snapshot owned by a different account. Specify either SnapshotName or SnapshotArn, but not both. When this resource is first created, the namespace is restored from this snapshot. On subsequent updates, a restore occurs only when SnapshotName or SnapshotOwnerAccount changes from its previous value. If both values are unchanged o |
| SnapshotOwnerAccount? | string | The AWS account ID that owns the snapshot. Required when restoring from a snapshot shared by another account. Used in combination with SnapshotName. On updates, changing this value while SnapshotName is set triggers a restore from the newly referenced snapshot. If the value is unchanged, no restore takes place and existing data is preserved. |
| RecoveryPointId? | string | The identifier of the recovery point to restore the namespace from. When this resource is first created, the namespace is restored from this recovery point. On subsequent updates, a restore occurs only when RecoveryPointId changes from its previous value. If the value is unchanged or removed, no restore takes place and existing data is preserved. |
| Tags? | array | The map of the key-value pairs used to tag the workgroup. |
| TrackName? | string | |
| Workgroup? | object | Definition for workgroup resource |
fn create()
Create a RedshiftServerless Workgroup
fn get(identifier: string)
Get a RedshiftServerless Workgroup
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the RedshiftServerless Workgroup |
fn update()
Update a RedshiftServerless Workgroup
fn delete(identifier: string)
Delete a RedshiftServerless Workgroup
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the RedshiftServerless Workgroup |
fn sync()
Sync RedshiftServerless Workgroup state from AWS
fn list(maxPages?: number, resourceModel?: string)
List RedshiftServerless Workgroup 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)— RedshiftServerless Workgroup resource state
04Previous Versions
2026.10.24.1AGPL-3.0-or-later
2026.10.23.1AGPL-3.0-or-later(was none)
- Updated: namespace, snapshot, workgroup
2026.10.13.1
- Updated: namespace, snapshot, workgroup
2026.10.08.1
2026.10.06.1
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
2026.09.22.1
2026.09.21.1
05Stats
A
100 / 100
Downloads
117
Archive size
626.0 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
- Docs keep secrets in a vault1/1earned
- Has description1/1earned
- Platform support declared (or universal)2/2earned
- License2/2earned
- Verified public repository2/2earned
06Platforms
07Labels