Skip to main content

Aws/redshiftserverless

@swamp/aws/redshiftserverlessv2026.07.31.1· 1d agoMODELS
01README

AWS REDSHIFTSERVERLESS infrastructure models

02Models3
@swamp/aws/redshiftserverless/namespacev2026.06.15.1namespace.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?stringAWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?stringAWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?stringAWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?stringAWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
AdminPasswordSecretKmsKeyId?stringThe 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?stringThe 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.
ManageAdminPassword?booleanIf 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?objectDefinition of Namespace resource.
Tags?arrayThe list of tags for the namespace.
FinalSnapshotName?stringThe name of the namespace the source snapshot was created from. Please specify the name if needed before deleting namespace
FinalSnapshotRetentionPeriod?numberThe 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?recordThe resource policy document that will be attached to the namespace.
RedshiftIdcApplicationArn?stringThe ARN for the Redshift application that integrates with IAM Identity Center.
SnapshotCopyConfigurations?arrayThe snapshot copy configurations for the namespace.
fn create()
Create a RedshiftServerless Namespace
fn get(identifier: string)
Get a RedshiftServerless Namespace
ArgumentTypeDescription
identifierstringThe primary identifier of the RedshiftServerless Namespace
fn update()
Update a RedshiftServerless Namespace
fn delete(identifier: string)
Delete a RedshiftServerless Namespace
ArgumentTypeDescription
identifierstringThe primary identifier of the RedshiftServerless Namespace
fn sync()
Sync RedshiftServerless Namespace state from AWS

Resources

state(infinite)— RedshiftServerless Namespace resource state
@swamp/aws/redshiftserverless/snapshotv2026.06.15.1snapshot.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?stringAWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?stringAWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?stringAWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?stringAWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
Tags?arrayAn array of key-value pairs to apply to this resource.
fn create()
Create a RedshiftServerless Snapshot
fn get(identifier: string)
Get a RedshiftServerless Snapshot
ArgumentTypeDescription
identifierstringThe primary identifier of the RedshiftServerless Snapshot
fn update()
Update a RedshiftServerless Snapshot
fn delete(identifier: string)
Delete a RedshiftServerless Snapshot
ArgumentTypeDescription
identifierstringThe primary identifier of the RedshiftServerless Snapshot
fn sync()
Sync RedshiftServerless Snapshot state from AWS

Resources

state(infinite)— RedshiftServerless Snapshot resource state
@swamp/aws/redshiftserverless/workgroupv2026.07.02.1workgroup.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?stringAWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?stringAWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?stringAWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?stringAWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
PricePerformanceTarget?objectA property that represents the price performance target settings for the workgroup.
SnapshotArn?stringThe 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?stringThe 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?stringThe 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?stringThe 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?arrayThe map of the key-value pairs used to tag the workgroup.
Workgroup?objectDefinition for workgroup resource
fn create()
Create a RedshiftServerless Workgroup
fn get(identifier: string)
Get a RedshiftServerless Workgroup
ArgumentTypeDescription
identifierstringThe primary identifier of the RedshiftServerless Workgroup
fn update()
Update a RedshiftServerless Workgroup
fn delete(identifier: string)
Delete a RedshiftServerless Workgroup
ArgumentTypeDescription
identifierstringThe primary identifier of the RedshiftServerless Workgroup
fn sync()
Sync RedshiftServerless Workgroup state from AWS

Resources

state(infinite)— RedshiftServerless Workgroup resource state
03Previous Versions19
2026.07.30.1
2026.07.29.1
2026.07.28.1
2026.07.27.1
2026.07.26.1
2026.07.25.1
2026.07.24.1
  • Added: recovery_point

Added 1 models

2026.07.20.1
2026.07.18.3
2026.07.18.2
2026.07.02.1
  • Updated: workgroup

Added 3, removed 1 models

2026.06.15.1
  • Updated: namespace, snapshot, workgroup
2026.06.08.2
  • Updated: namespace, snapshot, workgroup
2026.06.06.1
  • Updated: namespace, snapshot, workgroup
2026.05.27.1
  • Updated: namespace
2026.04.23.3
2026.04.23.2
  • Updated: namespace, snapshot, workgroup
2026.04.03.2
  • Updated: namespace, snapshot, workgroup
2026.03.19.1
  • Updated: namespace, snapshot, workgroup
04Stats
A
100 / 100
Downloads
0
Archive size
689.6 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