@swamp/gcp/datastream
v2026.04.23.1
Google Cloud datastream infrastructure models
Repository
https://github.com/systeminit/swamp-extensions
Labels
gcpgoogle-clouddatastreamcloudinfrastructure
Contents
Quality score
Verified by SwampHow well-documented and verifiable this extension is.
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/gcp/datastream@swamp/gcp/datastream/connectionprofilesv2026.04.23.1connectionprofiles.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| bigqueryProfile? | object | Profile for connecting to a BigQuery destination. |
| displayName? | string | Required. Display name. |
| forwardSshConnectivity? | object | Forward SSH Tunnel connectivity. |
| gcsProfile? | object | Profile for connecting to a Cloud Storage destination. |
| labels? | record | Labels. |
| mongodbProfile? | object | Profile for connecting to a MongoDB source. |
| mysqlProfile? | object | Profile for connecting to a MySQL source. |
| oracleProfile? | object | Profile for connecting to an Oracle source. |
| postgresqlProfile? | object | Profile for connecting to a PostgreSQL source. |
| privateConnectivity? | object | Private Connectivity |
| salesforceProfile? | object | Profile for connecting to a Salesforce source. |
| spannerProfile? | object | Profile for connecting to a Spanner source. |
| sqlServerProfile? | object | Profile for connecting to a SQLServer source. |
| staticServiceIpConnectivity? | object | Static IP address connectivity. Used when the source database is configured to allow incoming connections from the Datastream public IP addresses for the region specified in the connection profile. |
| connectionProfileId? | string | Required. The connection profile identifier. |
| force? | string | Optional. Create the connection profile without validating it. |
| requestId? | string | Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was receive |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
createCreate a connectionProfiles
getGet a connectionProfiles
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the connectionProfiles |
updateUpdate connectionProfiles attributes
deleteDelete the connectionProfiles
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the connectionProfiles |
syncSync connectionProfiles state from GCP
discoverdiscover
| Argument | Type | Description |
|---|---|---|
| connectionProfile? | any | |
| connectionProfileName? | any | |
| fullHierarchy? | any | |
| hierarchyDepth? | any | |
| mongodbCluster? | any | |
| mysqlRdbms? | any | |
| oracleRdbms? | any | |
| postgresqlRdbms? | any | |
| salesforceOrg? | any | |
| spannerDatabase? | any | |
| sqlServerRdbms? | any |
Resources
state(infinite)— A set of reusable connection configurations to be used as a source or destina...
@swamp/gcp/datastream/locationsv2026.04.23.1locations.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
getGet a locations
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the locations |
syncSync locations state from GCP
fetch_static_ipsfetch static ips
Resources
state(infinite)— A resource that represents a Google Cloud location.
@swamp/gcp/datastream/privateconnectionsv2026.04.23.1privateconnections.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| displayName? | string | Required. Display name. |
| error? | object | Represent a user-facing Error. |
| labels? | record | Labels. |
| pscInterfaceConfig? | object | The PSC Interface configuration is used to create PSC Interface between Datastream and the consumer's PSC. |
| vpcPeeringConfig? | object | The VPC Peering configuration is used to create VPC peering between Datastream and the consumer's VPC. |
| force? | string | Optional. If set to true, will skip validations. |
| privateConnectionId? | string | Required. The private connectivity identifier. |
| requestId? | string | Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was receive |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
createCreate a privateConnections
getGet a privateConnections
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the privateConnections |
deleteDelete the privateConnections
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the privateConnections |
syncSync privateConnections state from GCP
Resources
state(infinite)— The PrivateConnection resource is used to establish private connectivity betw...
@swamp/gcp/datastream/privateconnections-routesv2026.04.23.1privateconnections_routes.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| destinationAddress? | string | Required. Destination address for connection |
| destinationPort? | number | Destination port for connection |
| displayName? | string | Required. Display name. |
| labels? | record | Labels. |
| requestId? | string | Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was receive |
| routeId? | string | Required. The Route identifier. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
createCreate a routes
getGet a routes
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the routes |
deleteDelete the routes
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the routes |
syncSync routes state from GCP
Resources
state(infinite)— The route resource is the child of the private connection resource, used for ...
@swamp/gcp/datastream/streamsv2026.04.23.1streams.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| backfillAll? | object | Backfill strategy to automatically backfill the Stream's objects. Specific objects can be excluded. |
| backfillNone? | object | Backfill strategy to disable automatic backfill for the Stream's objects. |
| customerManagedEncryptionKey? | string | Immutable. A reference to a KMS encryption key. If provided, it will be used to encrypt the data. If left blank, data will be encrypted using an internal Stream-specific encryption key provisioned through KMS. |
| destinationConfig? | object | The configuration of the stream destination. |
| displayName? | string | Required. Display name. |
| labels? | record | Labels. |
| ruleSets? | array | Optional. Rule sets to apply to the stream. |
| sourceConfig? | object | The configuration of the stream source. |
| state? | enum | The state of the stream. |
| force? | string | Optional. Create the stream without validating it. |
| requestId? | string | Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was receive |
| streamId? | string | Required. The stream identifier. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
createCreate a streams
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after creation (default: true) |
getGet a streams
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the streams |
updateUpdate streams attributes
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after update (default: true) |
deleteDelete the streams
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the streams |
syncSync streams state from GCP
runrun
| Argument | Type | Description |
|---|---|---|
| cdcStrategy? | any | |
| force? | any |
Resources
state(infinite)— A resource representing streaming data from a source to a destination.
@swamp/gcp/datastream/streams-objectsv2026.04.23.1streams_objects.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
getGet a objects
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the objects |
syncSync objects state from GCP
lookuplookup
| Argument | Type | Description |
|---|---|---|
| sourceObjectIdentifier? | any |
start_backfill_jobstart backfill job
| Argument | Type | Description |
|---|---|---|
| eventFilter? | any |
stop_backfill_jobstop backfill job
Resources
state(infinite)— A specific stream object (e.g a specific DB table).
2026.04.04.151.1 KBApr 4, 2026
Google Cloud datastream infrastructure models
Release Notes
- Updated: streams
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
gcpgoogle-clouddatastreamcloudinfrastructure
2026.04.03.358.9 KBApr 3, 2026
Google Cloud datastream infrastructure models
Release Notes
- Updated: locations, connectionprofiles, privateconnections, privateconnections_routes, streams, streams_objects
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
gcpgoogle-clouddatastreamcloudinfrastructure
2026.04.03.158.5 KBApr 3, 2026
Google Cloud datastream infrastructure models
Release Notes
- Updated: locations, connectionprofiles, privateconnections, privateconnections_routes, streams, streams_objects
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
gcpgoogle-clouddatastreamcloudinfrastructure
2026.04.02.258.4 KBApr 2, 2026
Google Cloud datastream infrastructure models
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
gcpgoogle-clouddatastreamcloudinfrastructure
2026.03.27.158.4 KBMar 27, 2026
Google Cloud datastream infrastructure models
Release Notes
- Added: locations, connectionprofiles, privateconnections, privateconnections_routes, streams, streams_objects
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
gcpgoogle-clouddatastreamcloudinfrastructure