Skip to main content
← back to extensions

@swamp/aws/redshift

v2026.04.23.3

AWS REDSHIFT infrastructure models

Repository

https://github.com/systeminit/swamp-extensions

Platforms

linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64

Labels

awsredshiftcloudinfrastructure

Contents

models

Quality score

Verified by Swamp

How well-documented and verifiable this extension is.

100%

Grade A

  • Has README or module doc2/2earned
  • README has a code example1/1earned
  • README is substantive1/1earned
  • Most symbols documented1/1earned
  • No slow types1/1earned
  • Has description1/1earned
  • At least one platform tag (or universal)1/1earned
  • Two or more platform tags (or universal)1/1earned
  • License declared1/1earned
  • Verified public repository2/2earned

Install

$ swamp extension pull @swamp/aws/redshift

event_subscription.tsv2026.04.23.2

Global Arguments

ArgumentTypeDescription
SourceType?enumThe type of source that will be generating the events.
EventCategories?arraySpecifies the Amazon Redshift event categories to be published by the event notification subscription.
Enabled?booleanA boolean value; set to true to activate the subscription, and set to false to create the subscription but not activate it.
Severity?enumSpecifies the Amazon Redshift event severity to be published by the event notification subscription.
SubscriptionNamestringThe name of the Amazon Redshift event notification subscription
SourceIds?arrayA list of one or more identifiers of Amazon Redshift source objects.
SnsTopicArn?stringThe Amazon Resource Name (ARN) of the Amazon SNS topic used to transmit the event notifications.
Tags?arrayAn array of key-value pairs to apply to this resource.
createCreate a Redshift EventSubscription
getGet a Redshift EventSubscription
ArgumentTypeDescription
identifierstringThe primary identifier of the Redshift EventSubscription
updateUpdate a Redshift EventSubscription
deleteDelete a Redshift EventSubscription
ArgumentTypeDescription
identifierstringThe primary identifier of the Redshift EventSubscription
syncSync Redshift EventSubscription state from AWS
endpoint_authorization.tsv2026.04.23.2

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
AccountstringThe target AWS account ID to grant or revoke access for.
Force?booleanIndicates whether to force the revoke action. If true, the Redshift-managed VPC endpoints associated with the endpoint authorization are also deleted.
VpcIds?arrayThe virtual private cloud (VPC) identifiers to grant or revoke access to.
ClusterIdentifierstringThe cluster identifier.
createCreate a Redshift EndpointAuthorization
getGet a Redshift EndpointAuthorization
ArgumentTypeDescription
identifierstringThe primary identifier of the Redshift EndpointAuthorization
updateUpdate a Redshift EndpointAuthorization
deleteDelete a Redshift EndpointAuthorization
ArgumentTypeDescription
identifierstringThe primary identifier of the Redshift EndpointAuthorization
syncSync Redshift EndpointAuthorization state from AWS
endpoint_access.tsv2026.04.23.2

Global Arguments

ArgumentTypeDescription
VpcEndpoint?objectOne or more network interfaces of the endpoint. Also known as an interface endpoint.
EndpointNamestringThe name of the endpoint.
VpcSecurityGroupIdsarrayA list of vpc security group ids to apply to the created endpoint access.
ResourceOwner?stringThe AWS account ID of the owner of the cluster.
SubnetGroupNamestringThe subnet group name where Amazon Redshift chooses to deploy the endpoint.
ClusterIdentifierstringA unique identifier for the cluster. You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. All alphabetical characters must be lower case, no hypens at the end, no two consecutive hyphens. Cluster name should be unique for all clusters within an AWS account
createCreate a Redshift EndpointAccess
getGet a Redshift EndpointAccess
ArgumentTypeDescription
identifierstringThe primary identifier of the Redshift EndpointAccess
updateUpdate a Redshift EndpointAccess
deleteDelete a Redshift EndpointAccess
ArgumentTypeDescription
identifierstringThe primary identifier of the Redshift EndpointAccess
syncSync Redshift EndpointAccess state from AWS
integration.tsv2026.04.23.2

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
IntegrationName?stringThe name of the integration.
SourceArnstringThe Amazon Resource Name (ARN) of the database to use as the source for replication
TargetArnstringThe Amazon Resource Name (ARN) of the Redshift data warehouse to use as the target for replication
Tags?arrayAn array of key-value pairs to apply to this resource.
KMSKeyId?stringAn KMS key identifier for the key to use to encrypt the integration. If you don't specify an encryption key, the default AWS owned KMS key is used.
AdditionalEncryptionContext?recordAn optional set of non-secret key–value pairs that contains additional contextual information about the data.
createCreate a Redshift Integration
getGet a Redshift Integration
ArgumentTypeDescription
identifierstringThe primary identifier of the Redshift Integration
updateUpdate a Redshift Integration
deleteDelete a Redshift Integration
ArgumentTypeDescription
identifierstringThe primary identifier of the Redshift Integration
syncSync Redshift Integration state from AWS
cluster_subnet_group.tsv2026.04.23.2

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
DescriptionstringThe description of the parameter group.
SubnetIdsarrayThe list of VPC subnet IDs
Tags?arrayThe list of tags for the cluster parameter group.
createCreate a Redshift ClusterSubnetGroup
getGet a Redshift ClusterSubnetGroup
ArgumentTypeDescription
identifierstringThe primary identifier of the Redshift ClusterSubnetGroup
updateUpdate a Redshift ClusterSubnetGroup
deleteDelete a Redshift ClusterSubnetGroup
ArgumentTypeDescription
identifierstringThe primary identifier of the Redshift ClusterSubnetGroup
syncSync Redshift ClusterSubnetGroup state from AWS
scheduled_action.tsv2026.04.23.2

Global Arguments

ArgumentTypeDescription
ScheduledActionDescription?stringThe description of the scheduled action.
ScheduledActionNamestringThe name of the scheduled action. The name must be unique within an account.
EndTime?stringThe end time in UTC of the scheduled action. After this time, the scheduled action does not trigger.
Schedule?stringThe schedule in `at()` or `cron()` format.
IamRole?stringThe IAM role to assume to run the target action.
StartTime?stringThe start time in UTC of the scheduled action. Before this time, the scheduled action does not trigger.
Enable?booleanIf true, the schedule is enabled. If false, the scheduled action does not trigger.
TargetAction?stringA JSON format string of the Amazon Redshift API operation with input parameters.
createCreate a Redshift ScheduledAction
getGet a Redshift ScheduledAction
ArgumentTypeDescription
identifierstringThe primary identifier of the Redshift ScheduledAction
updateUpdate a Redshift ScheduledAction
deleteDelete a Redshift ScheduledAction
ArgumentTypeDescription
identifierstringThe primary identifier of the Redshift ScheduledAction
syncSync Redshift ScheduledAction state from AWS
cluster.tsv2026.04.23.2

Global Arguments

ArgumentTypeDescription
RevisionTarget?stringThe identifier of the database revision. You can retrieve this value from the response to the DescribeClusterDbRevisions request.
AutomatedSnapshotRetentionPeriod?numberThe number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Default value is 1
Encrypted?booleanIf true, the data in the cluster is encrypted at rest.
NumberOfNodes?numberThe number of compute nodes in the cluster. This parameter is required when the ClusterType parameter is specified as multi-node.
DestinationRegion?stringThe destination AWS Region that you want to copy snapshots to. Constraints: Must be the name of a valid AWS Region. For more information, see Regions and Endpoints in the Amazon Web Services [https://docs.aws.amazon.com/general/latest/gr/rande.html#redshift_region] General Reference
AllowVersionUpgrade?booleanMajor version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster. Default value is True
NamespaceResourcePolicy?stringThe namespace resource policy document that will be attached to a Redshift cluster.
MaintenanceTrackName?stringThe name for the maintenance track that you want to assign for the cluster. This name change is asynchronous. The new track name stays in the PendingModifiedValues for the cluster until the next maintenance window. When the maintenance track changes, the cluster is switched to the latest cluster release available for the maintenance track. At this point, the maintenance track name is applied.
OwnerAccount?string
MultiAZ?booleanA boolean indicating if the redshift cluster is multi-az or not. If you don't provide this parameter or set the value to false, the redshift cluster will be single-az.
Tags?arrayThe list of tags for the cluster parameter group.
SnapshotClusterIdentifier?stringThe name of the cluster the source snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.
IamRoles?arrayA list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services. You must supply the IAM roles in their Amazon Resource Name (ARN) format. You can supply up to 50 IAM roles in a single request
KmsKeyId?stringThe AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.
SnapshotCopyManual?booleanIndicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots.
ManageMasterPassword?booleanA boolean indicating if the redshift cluster's admin user credentials is managed by Redshift or not. You can't use MasterUserPassword if ManageMasterPassword is true. If ManageMasterPassword is false or not set, Amazon Redshift uses MasterUserPassword for the admin user account's password.
AvailabilityZone?stringThe EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. Default: A random, system-chosen Availability Zone in the region that is specified by the endpoint
ClusterSecurityGroups?arrayA list of security groups to be associated with this cluster.
ClusterIdentifier?stringA unique identifier for the cluster. You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. All alphabetical characters must be lower case, no hypens at the end, no two consecutive hyphens. Cluster name should be unique for all clusters within an AWS account
MasterUserPassword?stringThe password associated with the master user account for the cluster that is being created. You can't use MasterUserPassword if ManageMasterPassword is true. Password must be between 8 and 64 characters in length, should have at least one uppercase letter.Must contain at least one lowercase letter.Must contain one number.Can be any printable ASCII character.
ClusterSubnetGroupName?stringThe name of a cluster subnet group to be associated with this cluster.
LoggingProperties?object
DeferMaintenance?booleanA boolean indicating whether to enable the deferred maintenance window.
NodeTypestringThe node type to be provisioned for the cluster.Valid Values: ds2.xlarge | ds2.8xlarge | dc1.large | dc1.8xlarge | dc2.large | dc2.8xlarge | ra3.large | ra3.4xlarge | ra3.16xlarge
MasterUsernamestringThe user name associated with the master user account for the cluster that is being created. The user name can't be PUBLIC and first character must be a letter.
PubliclyAccessible?booleanIf true, the cluster can be accessed from a public network.
ManualSnapshotRetentionPeriod?numberThe number of days to retain newly copied snapshots in the destination AWS Region after they are copied from the source AWS 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.
ResourceAction?stringThe Redshift operation to be performed. Resource Action supports pause-cluster, resume-cluster, failover-primary-compute APIs
HsmClientCertificateIdentifier?stringSpecifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM
ElasticIp?stringThe Elastic IP (EIP) address for the cluster.
AvailabilityZoneRelocationStatus?stringThe availability zone relocation status of the cluster
AquaConfigurationStatus?stringThe value represents how the cluster is configured to use AQUA (Advanced Query Accelerator) after the cluster is restored. Possible values include the following. enabled - Use AQUA if it is available for the current Region and Amazon Redshift node type. disabled - Don't use AQUA. auto - Amazon Redshift determines whether to use AQUA.
SnapshotIdentifier?stringThe name of the snapshot from which to create the new cluster. This parameter isn't case sensitive.
AvailabilityZoneRelocation?booleanThe option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster modification is complete.
SnapshotCopyGrantName?stringThe name of the snapshot copy grant to use when snapshots of an AWS KMS-encrypted cluster are copied to the destination region.
EnhancedVpcRouting?booleanAn option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide. If this option is true, enhanced VPC routing is enabled. Default: false
ClusterParameterGroupName?stringThe name of the parameter group to be associated with this cluster.
DeferMaintenanceEndTime?stringA timestamp indicating end time for the deferred maintenance window. If you specify an end time, you can't specify a duration.
RotateEncryptionKey?booleanA boolean indicating if we want to rotate Encryption Keys.
VpcSecurityGroupIds?arrayA list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.
ClusterVersion?stringThe version of the Amazon Redshift engine software that you want to deploy on the cluster.The version selected runs on all the nodes in the cluster.
HsmConfigurationIdentifier?stringSpecifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM.
PreferredMaintenanceWindow?stringThe weekly time range (in UTC) during which automated cluster maintenance can occur.
DeferMaintenanceStartTime?stringA timestamp indicating the start time for the deferred maintenance window.
ClusterTypestringThe type of the cluster. When cluster type is specified as single-node, the NumberOfNodes parameter is not required and if multi-node, the NumberOfNodes parameter is required
Classic?booleanA boolean value indicating whether the resize operation is using the classic resize process. If you don't provide this parameter or set the value to false, the resize type is elastic.
MasterPasswordSecretKmsKeyId?stringThe ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin user credentials secret.
DeferMaintenanceDuration?numberAn integer indicating the duration of the maintenance window in days. If you specify a duration, you can't specify an end time. The duration must be 60 days or less.
DBNamestringThe name of the first database to be created when the cluster is created. To create additional databases after the cluster is created, connect to the cluster with a SQL client and use SQL commands to create a database.
SnapshotCopyRetentionPeriod?numberThe number of days to retain automated snapshots in the destination region after they are copied from the source region. Default is 7. Constraints: Must be at least 1 and no more than 35.
createCreate a Redshift Cluster
getGet a Redshift Cluster
ArgumentTypeDescription
identifierstringThe primary identifier of the Redshift Cluster
updateUpdate a Redshift Cluster
deleteDelete a Redshift Cluster
ArgumentTypeDescription
identifierstringThe primary identifier of the Redshift Cluster
syncSync Redshift Cluster state from AWS
cluster_parameter_group.tsv2026.04.23.2

Global Arguments

ArgumentTypeDescription
ParameterGroupName?stringThe name of the cluster parameter group.
DescriptionstringA description of the parameter group.
ParameterGroupFamilystringThe Amazon Redshift engine version to which the cluster parameter group applies. The cluster engine version determines the set of parameters.
Parameters?arrayAn array of parameters to be modified. A maximum of 20 parameters can be modified in a single request.
Tags?arrayAn array of key-value pairs to apply to this resource.
createCreate a Redshift ClusterParameterGroup
getGet a Redshift ClusterParameterGroup
ArgumentTypeDescription
identifierstringThe primary identifier of the Redshift ClusterParameterGroup
updateUpdate a Redshift ClusterParameterGroup
deleteDelete a Redshift ClusterParameterGroup
ArgumentTypeDescription
identifierstringThe primary identifier of the Redshift ClusterParameterGroup
syncSync Redshift ClusterParameterGroup state from AWS