DataConnectorArgs class

The set of arguments for DataConnector. The set of arguments for DataConnector.

Constructors

DataConnectorArgs({Input<DataConnectorActionConfig?>? actionConfig, Input<bool?>? autoRunDisabled, Input<DataConnectorBapConfig?>? bapConfig, required Input<String> collectionDisplayName, required Input<String> collectionId, Input<List<String>?>? connectorModes, required Input<String> dataSource, Input<int?>? dataSourceVersion, Input<String?>? deletionPolicy, Input<List<DataConnectorDestinationConfig>?>? destinationConfigs, Input<List<DataConnectorEntity>?>? entities, Input<String?>? incrementalRefreshInterval, Input<bool?>? incrementalSyncDisabled, Input<String?>? jsonParams, Input<String?>? kmsKeyName, required Input<String> location, Input<Map<String, String>?>? params, Input<String?>? project, required Input<String> refreshInterval, Input<bool?>? staticIpEnabled, Input<String?>? syncMode})
Creates a new DataConnectorArgs. actionConfig Action configuration for the data connector. Configures action autoRunDisabled Indicates whether full syncs are paused for this connector bapConfig BAP (Business Application Platform) configuration for the data collectionDisplayName The display name of the Collection. collectionId The ID to use for the Collection, which will become the final component connectorModes The modes enabled for this connector. The possible value can be: dataSource The identifier for the data source. dataSourceVersion The version of the data source. For example, 3 for Jira v3. deletionPolicy Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. destinationConfigs Destination connector configurations for the data connector, entities List of entities from the connected data source to ingest. incrementalRefreshInterval The refresh interval specifically for incremental data syncs. If unset, incrementalSyncDisabled Indicates whether incremental syncs are paused for this connector. jsonParams Params needed to access the source in the format of json string. kmsKeyName The KMS key to be used to protect the DataStores managed by this connector. location The geographic location where the data store should reside. The value can params Params needed to access the source in the format of String-to-String (Key, Value) pairs. project The ID of the project in which the resource belongs. refreshInterval The refresh interval for data sync. If duration is set to 0, the data will staticIpEnabled Whether customer has enabled static IP addresses for this connector. syncMode The data synchronization mode supported by the data connector. The possible value can be:
const
DataConnectorArgs.fromMap(Map<String, dynamic> map)
factory

Properties

actionConfig → Input<DataConnectorActionConfig?>?
Action configuration for the data connector. Configures action capabilities for connectors that support the ACTIONS connector mode. Structure is documented below.
final
autoRunDisabled → Input<bool?>?
Indicates whether full syncs are paused for this connector
final
bapConfig → Input<DataConnectorBapConfig?>?
BAP (Business Application Platform) configuration for the data connector. Controls which actions are enabled for connectors using the ACTIONS connector mode. Structure is documented below.
final
collectionDisplayName → Input<String>
The display name of the Collection. Should be human readable, used to display collections in the Console Dashboard. UTF-8 encoded string with limit of 1024 characters.
final
collectionId → Input<String>
The ID to use for the Collection, which will become the final component of the Collection's resource name. A new Collection is created as part of the DataConnector setup. DataConnector is a singleton resource under Collection, managing all DataStores of the Collection. This field must conform to RFC-1034 standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.
final
connectorModes → Input<List<String>?>?
The modes enabled for this connector. The possible value can be: 'DATA_INGESTION', 'ACTIONS', 'FEDERATED' 'EUA', 'FEDERATED_AND_EUA'.
final
dataSource → Input<String>
The identifier for the data source. This is a partial list of supported connectors. Please refer to the documentation for the full list of connectors. Supported first-party connectors include:
final
dataSourceVersion → Input<int?>?
The version of the data source. For example, 3 for Jira v3.
final
deletionPolicy → Input<String?>?
Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
final
destinationConfigs → Input<List<DataConnectorDestinationConfig>?>?
Destination connector configurations for the data connector, used to configure where data is served. Structure is documented below.
final
entities → Input<List<DataConnectorEntity>?>?
List of entities from the connected data source to ingest. Structure is documented below.
final
hashCode → int
The hash code for this object.
no setterinherited
incrementalRefreshInterval → Input<String?>?
The refresh interval specifically for incremental data syncs. If unset, incremental syncs will use the default from env, set to 3hrs. The minimum is 30 minutes and maximum is 7 days. Applicable to only 3P connectors. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled.
final
incrementalSyncDisabled → Input<bool?>?
Indicates whether incremental syncs are paused for this connector.
final
jsonParams → Input<String?>?
Params needed to access the source in the format of json string.
final
kmsKeyName → Input<String?>?
The KMS key to be used to protect the DataStores managed by this connector. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStores created by this connector will be protected by the KMS key.
final
location → Input<String>
The geographic location where the data store should reside. The value can only be one of "global", "us" and "eu".
final
params → Input<Map<String, String>?>?
Params needed to access the source in the format of String-to-String (Key, Value) pairs.
final
project → Input<String?>?
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
final
refreshInterval → Input<String>
The refresh interval for data sync. If duration is set to 0, the data will be synced in real time. The streaming feature is not supported yet. The minimum is 30 minutes and maximum is 7 days. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
staticIpEnabled → Input<bool?>?
Whether customer has enabled static IP addresses for this connector.
final
syncMode → Input<String?>?
The data synchronization mode supported by the data connector. The possible value can be: 'PERIODIC', 'STREAMING'.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited