Skip to main content

Connection

Resource Connection in pulumi-logtail.
3 min read

Resource Connection in pulumi-logtail.

Pulumi type: logtail:index/connection:Connection.

name is the Pulumi resource name. Nested object fields are documented under that object. They are not arguments of this resource.

Example#

Only required arguments are set. A string in angle brackets stands in for that argument. Any other value is an option or example written in the SDK description.

Arguments#

PropertyTypeRequiredDescription
clientTypestringyesType of client connection. Currently only clickhouse is supported.
dataRegionstringnoData region or private cluster name. Permitted values for most plans are: usWest, germany, singapore.
ipAllowlistsstring[]noArray of IP addresses or CIDR ranges that are allowed to use this connection.
notestringnoA descriptive note for the connection.
teamIdsnumber[]noArray of team IDs to associate with the connection. Only one of teamNames or teamIds should be provided.
teamNamesstring[]noArray of team names to associate with the connection. Only one of teamNames or teamIds should be provided.
validUntilstringnoISO 8601 timestamp when the connection expires.

Outputs#

Computed outputs are produced by the provider. They are not constructor arguments.

PropertyTypeComputedDescription
clientTypestringnoType of client connection. Currently only clickhouse is supported.
createdAtstringyesThe time when this connection was created.
createdBy{ [key: string]: string }yesInformation about the user who created this connection.
dataRegionstringnoData region or private cluster name. Permitted values for most plans are: usWest, germany, singapore.
dataSourcesConnectionDataSource (output)[]yesList of available data sources for this connection.
hoststringyesThe connection hostname.
ipAllowlistsstring[]noArray of IP addresses or CIDR ranges that are allowed to use this connection.
notestringnoA descriptive note for the connection.
passwordstringyesThe connection password. Only available immediately after creation.
portnumberyesThe connection port.
sampleQuerystringyesA sample query showing how to use this connection.
teamIdsnumber[]noArray of team IDs to associate with the connection. Only one of teamNames or teamIds should be provided.
teamNamesstring[]noArray of team names to associate with the connection. Only one of teamNames or teamIds should be provided.
usernamestringyesThe connection username.
validUntilstringnoISO 8601 timestamp when the connection expires.

ConnectionDataSource (output)#

Output object ConnectionDataSource. Fields below belong to this object.

PropertyTypeAlways presentDescription
dataSourcesstring[]no
sourceIdnumberno
sourceNamestringno
teamNamestringno