Aws/redshift
@swamp/aws/redshiftv2026.10.25.1
01README
AWS REDSHIFT infrastructure models
02Release Notes
- Updated: cluster
03Behaviors
cluster.tsv2026.10.25.1
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. |
| RevisionTarget? | string | The identifier of the database revision. You can retrieve this value from the response to the DescribeClusterDbRevisions request. |
| AutomatedSnapshotRetentionPeriod? | number | The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Default value is 1 |
| Encrypted? | boolean | If true, the data in the cluster is encrypted at rest. |
| Port? | number | The port number on which the cluster accepts incoming connections. The cluster is accessible only via the JDBC and ODBC connection strings |
| NumberOfNodes? | number | The number of compute nodes in the cluster. This parameter is required when the ClusterType parameter is specified as multi-node. |
| DestinationRegion? | string | The 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? | boolean | Major 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? | record | The namespace resource policy document that will be attached to a Redshift cluster. |
| MaintenanceTrackName? | string | The 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? | boolean | A 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? | array | The list of tags for the cluster parameter group. |
| SnapshotClusterIdentifier? | string | The 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? | array | A 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? | string | The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster. |
| SnapshotCopyManual? | boolean | Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots. |
| ManageMasterPassword? | boolean | A 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? | string | The 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? | array | A list of security groups to be associated with this cluster. |
| ClusterIdentifier? | string | A 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? | string | The 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? | string | The name of a cluster subnet group to be associated with this cluster. |
| LoggingProperties? | object | |
| DeferMaintenance? | boolean | A boolean indicating whether to enable the deferred maintenance window. |
| NodeType | string | The 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 | rg.large | rg.xlarge | rg.4xlarge | rg.12xlarge |
| MasterUsername | string | The 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? | boolean | If true, the cluster can be accessed from a public network. |
| ManualSnapshotRetentionPeriod? | number | The 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? | string | The Redshift operation to be performed. Resource Action supports pause-cluster, resume-cluster, failover-primary-compute APIs |
| HsmClientCertificateIdentifier? | string | Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM |
| ElasticIp? | string | The Elastic IP (EIP) address for the cluster. |
| AvailabilityZoneRelocationStatus? | string | The availability zone relocation status of the cluster |
| AquaConfigurationStatus? | string | The 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? | string | The name of the snapshot from which to create the new cluster. This parameter isn't case sensitive. |
| AvailabilityZoneRelocation? | boolean | The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster modification is complete. |
| SnapshotCopyGrantName? | string | The name of the snapshot copy grant to use when snapshots of an AWS KMS-encrypted cluster are copied to the destination region. |
| EnhancedVpcRouting? | boolean | An 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? | string | The name of the parameter group to be associated with this cluster. |
| DeferMaintenanceEndTime? | string | A timestamp indicating end time for the deferred maintenance window. If you specify an end time, you can't specify a duration. |
| RotateEncryptionKey? | boolean | A boolean indicating if we want to rotate Encryption Keys. |
| VpcSecurityGroupIds? | array | A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster. |
| ClusterVersion? | string | The 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? | string | Specifies 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? | string | The weekly time range (in UTC) during which automated cluster maintenance can occur. |
| DeferMaintenanceStartTime? | string | A timestamp indicating the start time for the deferred maintenance window. |
| ClusterType | string | The 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? | boolean | A 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? | string | The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin user credentials secret. |
| DeferMaintenanceDuration? | number | An 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. |
| DBName | string | The 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? | number | The 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. |
fn create()
Create a Redshift Cluster
fn get(identifier: string)
Get a Redshift Cluster
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Redshift Cluster |
fn update()
Update a Redshift Cluster
fn delete(identifier: string)
Delete a Redshift Cluster
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Redshift Cluster |
fn sync()
Sync Redshift Cluster state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Redshift Cluster 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)— Redshift Cluster resource state
cluster_parameter_group.tsv2026.10.23.1
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. |
| ParameterGroupName? | string | The name of the cluster parameter group. |
| Description | string | A description of the parameter group. |
| ParameterGroupFamily | string | The Amazon Redshift engine version to which the cluster parameter group applies. The cluster engine version determines the set of parameters. |
| Parameters? | array | An array of parameters to be modified. A maximum of 20 parameters can be modified in a single request. |
| Tags? | array | An array of key-value pairs to apply to this resource. |
fn create()
Create a Redshift ClusterParameterGroup
fn get(identifier: string)
Get a Redshift ClusterParameterGroup
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Redshift ClusterParameterGroup |
fn update()
Update a Redshift ClusterParameterGroup
fn delete(identifier: string)
Delete a Redshift ClusterParameterGroup
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Redshift ClusterParameterGroup |
fn sync()
Sync Redshift ClusterParameterGroup state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Redshift ClusterParameterGroup 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)— Redshift ClusterParameterGroup resource state
cluster_subnet_group.tsv2026.10.23.1
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. |
| Description | string | The description of the parameter group. |
| SubnetIds | array | The list of VPC subnet IDs |
| Tags? | array | The list of tags for the cluster parameter group. |
fn create()
Create a Redshift ClusterSubnetGroup
fn get(identifier: string)
Get a Redshift ClusterSubnetGroup
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Redshift ClusterSubnetGroup |
fn update()
Update a Redshift ClusterSubnetGroup
fn delete(identifier: string)
Delete a Redshift ClusterSubnetGroup
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Redshift ClusterSubnetGroup |
fn sync()
Sync Redshift ClusterSubnetGroup state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Redshift ClusterSubnetGroup 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)— Redshift ClusterSubnetGroup resource state
endpoint_access.tsv2026.10.23.1
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. |
| VpcEndpoint? | object | One or more network interfaces of the endpoint. Also known as an interface endpoint. |
| EndpointName | string | The name of the endpoint. |
| VpcSecurityGroupIds | array | A list of vpc security group ids to apply to the created endpoint access. |
| ResourceOwner? | string | The AWS account ID of the owner of the cluster. |
| SubnetGroupName | string | The subnet group name where Amazon Redshift chooses to deploy the endpoint. |
| ClusterIdentifier | string | A 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 |
fn create()
Create a Redshift EndpointAccess
fn get(identifier: string)
Get a Redshift EndpointAccess
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Redshift EndpointAccess |
fn update()
Update a Redshift EndpointAccess
fn delete(identifier: string)
Delete a Redshift EndpointAccess
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Redshift EndpointAccess |
fn sync()
Sync Redshift EndpointAccess state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Redshift EndpointAccess 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)— Redshift EndpointAccess resource state
endpoint_authorization.tsv2026.10.23.1
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. |
| Account | string | The target AWS account ID to grant or revoke access for. |
| Force? | boolean | Indicates whether to force the revoke action. If true, the Redshift-managed VPC endpoints associated with the endpoint authorization are also deleted. |
| VpcIds? | array | The virtual private cloud (VPC) identifiers to grant or revoke access to. |
| ClusterIdentifier | string | The cluster identifier. |
fn create()
Create a Redshift EndpointAuthorization
fn get(identifier: string)
Get a Redshift EndpointAuthorization
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Redshift EndpointAuthorization |
fn update()
Update a Redshift EndpointAuthorization
fn delete(identifier: string)
Delete a Redshift EndpointAuthorization
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Redshift EndpointAuthorization |
fn sync()
Sync Redshift EndpointAuthorization state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Redshift EndpointAuthorization 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)— Redshift EndpointAuthorization resource state
event_subscription.tsv2026.10.23.1
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. |
| SourceType? | enum | The type of source that will be generating the events. |
| EventCategories? | array | Specifies the Amazon Redshift event categories to be published by the event notification subscription. |
| Enabled? | boolean | A boolean value; set to true to activate the subscription, and set to false to create the subscription but not activate it. |
| Severity? | enum | Specifies the Amazon Redshift event severity to be published by the event notification subscription. |
| SubscriptionName | string | The name of the Amazon Redshift event notification subscription |
| SourceIds? | array | A list of one or more identifiers of Amazon Redshift source objects. |
| SnsTopicArn? | string | The Amazon Resource Name (ARN) of the Amazon SNS topic used to transmit the event notifications. |
| Tags? | array | An array of key-value pairs to apply to this resource. |
fn create()
Create a Redshift EventSubscription
fn get(identifier: string)
Get a Redshift EventSubscription
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Redshift EventSubscription |
fn update()
Update a Redshift EventSubscription
fn delete(identifier: string)
Delete a Redshift EventSubscription
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Redshift EventSubscription |
fn sync()
Sync Redshift EventSubscription state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Redshift EventSubscription 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)— Redshift EventSubscription resource state
integration.tsv2026.10.23.1
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. |
| IntegrationName? | string | The name of the integration. |
| SourceArn | string | The Amazon Resource Name (ARN) of the database to use as the source for replication |
| TargetArn | string | The Amazon Resource Name (ARN) of the Redshift data warehouse to use as the target for replication |
| Tags? | array | An array of key-value pairs to apply to this resource. |
| KMSKeyId? | string | An 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? | record | An optional set of non-secret key–value pairs that contains additional contextual information about the data. |
fn create()
Create a Redshift Integration
fn get(identifier: string)
Get a Redshift Integration
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Redshift Integration |
fn update()
Update a Redshift Integration
fn delete(identifier: string)
Delete a Redshift Integration
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Redshift Integration |
fn sync()
Sync Redshift Integration state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Redshift Integration 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)— Redshift Integration resource state
qev2idc_application.tsv2026.10.23.1
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. |
| IdcInstanceArn | string | The Amazon Resource Name (ARN) of the IAM Identity Center instance used to create the Amazon Redshift Query Editor (QEV2) managed application. |
| Qev2IdcApplicationName | string | The name of the Amazon Redshift Query Editor (QEV2) application in IAM Identity Center. |
| IdcDisplayName | string | The display name for the Amazon Redshift Query Editor (QEV2) IAM Identity Center application. It appears in the console. |
| Tags? | array | A list of tags associated with the application. Tags are key-value pairs that you can use to organize and identify your resources. |
fn create()
Create a Redshift QEV2IdcApplication
fn get(identifier: string)
Get a Redshift QEV2IdcApplication
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Redshift QEV2IdcApplication |
fn update()
Update a Redshift QEV2IdcApplication
fn delete(identifier: string)
Delete a Redshift QEV2IdcApplication
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Redshift QEV2IdcApplication |
fn sync()
Sync Redshift QEV2IdcApplication state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Redshift QEV2IdcApplication 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)— Redshift QEV2IdcApplication resource state
redshift_idc_application.tsv2026.10.23.1
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. |
| IdcInstanceArn | string | The Amazon resource name (ARN) of the IAM Identity Center instance where Amazon Redshift creates a new managed application. |
| RedshiftIdcApplicationName | string | The name of the Redshift application in IAM Identity Center. |
| IdentityNamespace? | string | The namespace for the Amazon Redshift IAM Identity Center application instance. It determines which managed application verifies the connection token. |
| IdcDisplayName | string | The display name for the Amazon Redshift IAM Identity Center application instance. It appears in the console. |
| IamRoleArn | string | The IAM role ARN for the Amazon Redshift IAM Identity Center application instance. It has the required permissions to be assumed and invoke the IDC Identity Center API. |
| AuthorizedTokenIssuerList? | array | The token issuer list for the Amazon Redshift IAM Identity Center application instance. |
| ServiceIntegrations? | array | A collection of service integrations for the Redshift IAM Identity Center application. |
| ApplicationType? | enum | The type of application being created. |
| Tags? | array | An array of key-value pairs to apply to this resource. |
| SsoTagKeys? | array | A list of tag keys that Redshift Identity Center applications copy to IAM Identity Center. |
fn create()
Create a Redshift RedshiftIdcApplication
fn get(identifier: string)
Get a Redshift RedshiftIdcApplication
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Redshift RedshiftIdcApplication |
fn update()
Update a Redshift RedshiftIdcApplication
fn delete(identifier: string)
Delete a Redshift RedshiftIdcApplication
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Redshift RedshiftIdcApplication |
fn sync()
Sync Redshift RedshiftIdcApplication state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Redshift RedshiftIdcApplication 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)— Redshift RedshiftIdcApplication resource state
scheduled_action.tsv2026.10.23.1
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. |
| ScheduledActionDescription? | string | The description of the scheduled action. |
| ScheduledActionName | string | The name of the scheduled action. The name must be unique within an account. |
| EndTime? | string | The end time in UTC of the scheduled action. After this time, the scheduled action does not trigger. |
| Schedule? | string | The schedule in `at()` or `cron()` format. |
| IamRole? | string | The IAM role to assume to run the target action. |
| StartTime? | string | The start time in UTC of the scheduled action. Before this time, the scheduled action does not trigger. |
| Enable? | boolean | If true, the schedule is enabled. If false, the scheduled action does not trigger. |
| TargetAction? | record | A JSON format string of the Amazon Redshift API operation with input parameters. |
fn create()
Create a Redshift ScheduledAction
fn get(identifier: string)
Get a Redshift ScheduledAction
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Redshift ScheduledAction |
fn update()
Update a Redshift ScheduledAction
fn delete(identifier: string)
Delete a Redshift ScheduledAction
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Redshift ScheduledAction |
fn sync()
Sync Redshift ScheduledAction state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Redshift ScheduledAction 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)— Redshift ScheduledAction resource state
snapshot.tsv2026.10.23.1
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. |
| SnapshotIdentifier | string | A unique identifier for the snapshot that you are requesting. This identifier must be unique for all snapshots within the Amazon Web Services account. |
| ClusterIdentifier | string | The cluster identifier for which you want a snapshot. |
| ManualSnapshotRetentionPeriod? | number | The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely. The value must be either -1 or an integer between 1 and 3653. |
| Tags? | array | A list of tag instances. |
fn create()
Create a Redshift Snapshot
fn get(identifier: string)
Get a Redshift Snapshot
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Redshift Snapshot |
fn update()
Update a Redshift Snapshot
fn delete(identifier: string)
Delete a Redshift Snapshot
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Redshift Snapshot |
fn sync()
Sync Redshift Snapshot state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Redshift 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)— Redshift Snapshot resource state
snapshot_copy_grant.tsv2026.10.23.1
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. |
| SnapshotCopyGrantName | string | The name of the snapshot copy grant. This name must be unique in the region for the AWS account. |
| KmsKeyId? | string | The unique identifier of the encrypted symmetric key to which to grant Amazon Redshift permission. If no key is specified, the default key is used. Marked writeOnly because Create accepts aliases/key-ids but Describe returns the resolved key ARN, which would fail drift detection. |
| Tags? | array | A list of tag instances. |
fn create()
Create a Redshift SnapshotCopyGrant
fn get(identifier: string)
Get a Redshift SnapshotCopyGrant
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Redshift SnapshotCopyGrant |
fn update()
Update a Redshift SnapshotCopyGrant
fn delete(identifier: string)
Delete a Redshift SnapshotCopyGrant
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Redshift SnapshotCopyGrant |
fn sync()
Sync Redshift SnapshotCopyGrant state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Redshift SnapshotCopyGrant 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)— Redshift SnapshotCopyGrant resource state
snapshot_schedule.tsv2026.10.23.1
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. |
| ScheduleIdentifier | string | A unique identifier for the snapshot schedule. Only alphanumeric characters are allowed. |
| ScheduleDescription? | string | The description of the snapshot schedule. |
| ScheduleDefinitions | array | The definition of the snapshot schedule. The definition is made up of schedule expressions, for example "cron(30 12 *)" or "rate(12 hours)". |
| Tags? | array | An optional set of tags for the snapshot schedule. |
fn create()
Create a Redshift SnapshotSchedule
fn get(identifier: string)
Get a Redshift SnapshotSchedule
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Redshift SnapshotSchedule |
fn update()
Update a Redshift SnapshotSchedule
fn delete(identifier: string)
Delete a Redshift SnapshotSchedule
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Redshift SnapshotSchedule |
fn sync()
Sync Redshift SnapshotSchedule state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Redshift SnapshotSchedule 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)— Redshift SnapshotSchedule resource state
usage_limit.tsv2026.10.23.1
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. |
| ClusterIdentifier | string | The identifier of the cluster that you want to limit usage. |
| FeatureType | enum | The Amazon Redshift feature that you want to limit. |
| LimitType | enum | The type of limit. Depending on the feature type, this can be based on a time duration or data size. If FeatureType is spectrum, then LimitType must be data-scanned. If FeatureType is concurrency-scaling, then LimitType must be time. If FeatureType is cross-region-datasharing, then LimitType must be data-scanned. |
| Amount | number | The limit amount. If time-based, this amount is in minutes. If data-based, this amount is in terabytes (TB). The value must be a positive number. |
| Period? | enum | The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly. |
| BreachAction? | enum | The action that Amazon Redshift takes when the limit is reached. The default is log. |
| Tags? | array | A list of tag instances. |
fn create()
Create a Redshift UsageLimit
fn get(identifier: string)
Get a Redshift UsageLimit
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Redshift UsageLimit |
fn update()
Update a Redshift UsageLimit
fn delete(identifier: string)
Delete a Redshift UsageLimit
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Redshift UsageLimit |
fn sync()
Sync Redshift UsageLimit state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Redshift UsageLimit 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)— Redshift UsageLimit resource state
04Previous Versions
2026.10.24.1AGPL-3.0-or-later
2026.10.23.1AGPL-3.0-or-later(was none)
- Updated: cluster, cluster_parameter_group, cluster_subnet_group, endpoint_access, endpoint_authorization, event_subscription, integration, qev2idc_application, redshift_idc_application, scheduled_action, snapshot, snapshot_copy_grant, snapshot_schedule, usage_limit
2026.10.13.1
- Updated: cluster, cluster_parameter_group, cluster_subnet_group, endpoint_access, endpoint_authorization, event_subscription, integration, qev2idc_application, redshift_idc_application, scheduled_action, snapshot, snapshot_copy_grant, snapshot_schedule, usage_limit
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
- Added: redshift_idc_application
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
116
Archive size
2.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
- 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