com.pulumi.azure.datafactory.kotlin.LinkedServiceSftp.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-azure-kotlin Show documentation
Show all versions of pulumi-azure-kotlin Show documentation
Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.azure.datafactory.kotlin
import com.pulumi.core.Output
import com.pulumi.kotlin.KotlinCustomResource
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.ResourceMapper
import com.pulumi.kotlin.options.CustomResourceOptions
import com.pulumi.kotlin.options.CustomResourceOptionsBuilder
import com.pulumi.resources.Resource
import kotlin.Boolean
import kotlin.Int
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.collections.List
import kotlin.collections.Map
/**
* Builder for [LinkedServiceSftp].
*/
@PulumiTagMarker
public class LinkedServiceSftpResourceBuilder internal constructor() {
public var name: String? = null
public var args: LinkedServiceSftpArgs = LinkedServiceSftpArgs()
public var opts: CustomResourceOptions = CustomResourceOptions()
/**
* @param name The _unique_ name of the resulting resource.
*/
public fun name(`value`: String) {
this.name = value
}
/**
* @param block The arguments to use to populate this resource's properties.
*/
public suspend fun args(block: suspend LinkedServiceSftpArgsBuilder.() -> Unit) {
val builder = LinkedServiceSftpArgsBuilder()
block(builder)
this.args = builder.build()
}
/**
* @param block A bag of options that control this resource's behavior.
*/
public suspend fun opts(block: suspend CustomResourceOptionsBuilder.() -> Unit) {
this.opts = com.pulumi.kotlin.options.CustomResourceOptions.opts(block)
}
internal fun build(): LinkedServiceSftp {
val builtJavaResource = com.pulumi.azure.datafactory.LinkedServiceSftp(
this.name,
this.args.toJava(),
this.opts.toJava(),
)
return LinkedServiceSftp(builtJavaResource)
}
}
/**
* Manages a Linked Service (connection) between a SFTP Server and Azure Data Factory.
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as azure from "@pulumi/azure";
* const example = new azure.core.ResourceGroup("example", {
* name: "example-resources",
* location: "West Europe",
* });
* const exampleFactory = new azure.datafactory.Factory("example", {
* name: "example",
* location: example.location,
* resourceGroupName: example.name,
* });
* const exampleLinkedServiceSftp = new azure.datafactory.LinkedServiceSftp("example", {
* name: "example",
* dataFactoryId: exampleFactory.id,
* authenticationType: "Basic",
* host: "http://www.bing.com",
* port: 22,
* username: "foo",
* password: "bar",
* });
* ```
* ```python
* import pulumi
* import pulumi_azure as azure
* example = azure.core.ResourceGroup("example",
* name="example-resources",
* location="West Europe")
* example_factory = azure.datafactory.Factory("example",
* name="example",
* location=example.location,
* resource_group_name=example.name)
* example_linked_service_sftp = azure.datafactory.LinkedServiceSftp("example",
* name="example",
* data_factory_id=example_factory.id,
* authentication_type="Basic",
* host="http://www.bing.com",
* port=22,
* username="foo",
* password="bar")
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using Azure = Pulumi.Azure;
* return await Deployment.RunAsync(() =>
* {
* var example = new Azure.Core.ResourceGroup("example", new()
* {
* Name = "example-resources",
* Location = "West Europe",
* });
* var exampleFactory = new Azure.DataFactory.Factory("example", new()
* {
* Name = "example",
* Location = example.Location,
* ResourceGroupName = example.Name,
* });
* var exampleLinkedServiceSftp = new Azure.DataFactory.LinkedServiceSftp("example", new()
* {
* Name = "example",
* DataFactoryId = exampleFactory.Id,
* AuthenticationType = "Basic",
* Host = "http://www.bing.com",
* Port = 22,
* Username = "foo",
* Password = "bar",
* });
* });
* ```
* ```go
* package main
* import (
* "github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
* "github.com/pulumi/pulumi-azure/sdk/v5/go/azure/datafactory"
* "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
* )
* func main() {
* pulumi.Run(func(ctx *pulumi.Context) error {
* example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
* Name: pulumi.String("example-resources"),
* Location: pulumi.String("West Europe"),
* })
* if err != nil {
* return err
* }
* exampleFactory, err := datafactory.NewFactory(ctx, "example", &datafactory.FactoryArgs{
* Name: pulumi.String("example"),
* Location: example.Location,
* ResourceGroupName: example.Name,
* })
* if err != nil {
* return err
* }
* _, err = datafactory.NewLinkedServiceSftp(ctx, "example", &datafactory.LinkedServiceSftpArgs{
* Name: pulumi.String("example"),
* DataFactoryId: exampleFactory.ID(),
* AuthenticationType: pulumi.String("Basic"),
* Host: pulumi.String("http://www.bing.com"),
* Port: pulumi.Int(22),
* Username: pulumi.String("foo"),
* Password: pulumi.String("bar"),
* })
* if err != nil {
* return err
* }
* return nil
* })
* }
* ```
* ```java
* package generated_program;
* import com.pulumi.Context;
* import com.pulumi.Pulumi;
* import com.pulumi.core.Output;
* import com.pulumi.azure.core.ResourceGroup;
* import com.pulumi.azure.core.ResourceGroupArgs;
* import com.pulumi.azure.datafactory.Factory;
* import com.pulumi.azure.datafactory.FactoryArgs;
* import com.pulumi.azure.datafactory.LinkedServiceSftp;
* import com.pulumi.azure.datafactory.LinkedServiceSftpArgs;
* import java.util.List;
* import java.util.ArrayList;
* import java.util.Map;
* import java.io.File;
* import java.nio.file.Files;
* import java.nio.file.Paths;
* public class App {
* public static void main(String[] args) {
* Pulumi.run(App::stack);
* }
* public static void stack(Context ctx) {
* var example = new ResourceGroup("example", ResourceGroupArgs.builder()
* .name("example-resources")
* .location("West Europe")
* .build());
* var exampleFactory = new Factory("exampleFactory", FactoryArgs.builder()
* .name("example")
* .location(example.location())
* .resourceGroupName(example.name())
* .build());
* var exampleLinkedServiceSftp = new LinkedServiceSftp("exampleLinkedServiceSftp", LinkedServiceSftpArgs.builder()
* .name("example")
* .dataFactoryId(exampleFactory.id())
* .authenticationType("Basic")
* .host("http://www.bing.com")
* .port(22)
* .username("foo")
* .password("bar")
* .build());
* }
* }
* ```
* ```yaml
* resources:
* example:
* type: azure:core:ResourceGroup
* properties:
* name: example-resources
* location: West Europe
* exampleFactory:
* type: azure:datafactory:Factory
* name: example
* properties:
* name: example
* location: ${example.location}
* resourceGroupName: ${example.name}
* exampleLinkedServiceSftp:
* type: azure:datafactory:LinkedServiceSftp
* name: example
* properties:
* name: example
* dataFactoryId: ${exampleFactory.id}
* authenticationType: Basic
* host: http://www.bing.com
* port: 22
* username: foo
* password: bar
* ```
*
* ## Import
* Data Factory Linked Service's can be imported using the `resource id`, e.g.
* ```sh
* $ pulumi import azure:datafactory/linkedServiceSftp:LinkedServiceSftp example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/example/providers/Microsoft.DataFactory/factories/example/linkedservices/example
* ```
*/
public class LinkedServiceSftp internal constructor(
override val javaResource: com.pulumi.azure.datafactory.LinkedServiceSftp,
) : KotlinCustomResource(javaResource, LinkedServiceSftpMapper) {
/**
* A map of additional properties to associate with the Data Factory Linked Service.
* The following supported arguments are specific to SFTP Linked Service:
*/
public val additionalProperties: Output>?
get() = javaResource.additionalProperties().applyValue({ args0 ->
args0.map({ args0 ->
args0.map({ args0 -> args0.key.to(args0.value) }).toMap()
}).orElse(null)
})
/**
* List of tags that can be used for describing the Data Factory Linked Service.
*/
public val annotations: Output>?
get() = javaResource.annotations().applyValue({ args0 ->
args0.map({ args0 ->
args0.map({ args0 ->
args0
})
}).orElse(null)
})
/**
* The type of authentication used to connect to the web table source. Valid options are `Anonymous`, `Basic` and `ClientCertificate`.
*/
public val authenticationType: Output
get() = javaResource.authenticationType().applyValue({ args0 -> args0 })
/**
* The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
*/
public val dataFactoryId: Output
get() = javaResource.dataFactoryId().applyValue({ args0 -> args0 })
/**
* The description for the Data Factory Linked Service.
*/
public val description: Output?
get() = javaResource.description().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* The SFTP server hostname.
*/
public val host: Output
get() = javaResource.host().applyValue({ args0 -> args0 })
/**
* The host key fingerprint of the SFTP server.
*/
public val hostKeyFingerprint: Output?
get() = javaResource.hostKeyFingerprint().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* The integration runtime reference to associate with the Data Factory Linked Service.
*/
public val integrationRuntimeName: Output?
get() = javaResource.integrationRuntimeName().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* Specifies the name of the Data Factory Linked Service. Changing this forces a new resource to be created. Must be unique within a data factory. See the [Microsoft documentation](https://docs.microsoft.com/azure/data-factory/naming-rules) for all restrictions.
*/
public val name: Output
get() = javaResource.name().applyValue({ args0 -> args0 })
/**
* A map of parameters to associate with the Data Factory Linked Service.
*/
public val parameters: Output>?
get() = javaResource.parameters().applyValue({ args0 ->
args0.map({ args0 ->
args0.map({ args0 ->
args0.key.to(args0.value)
}).toMap()
}).orElse(null)
})
/**
* Password to logon to the SFTP Server for Basic Authentication.
*/
public val password: Output
get() = javaResource.password().applyValue({ args0 -> args0 })
/**
* The TCP port number that the SFTP server uses to listen for client connection. Default value is 22.
*/
public val port: Output
get() = javaResource.port().applyValue({ args0 -> args0 })
/**
* Whether to validate host key fingerprint while connecting. If set to `false`, `host_key_fingerprint` must also be set.
*/
public val skipHostKeyValidation: Output?
get() = javaResource.skipHostKeyValidation().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* The username used to log on to the SFTP server.
*/
public val username: Output
get() = javaResource.username().applyValue({ args0 -> args0 })
}
public object LinkedServiceSftpMapper : ResourceMapper {
override fun supportsMappingOfType(javaResource: Resource): Boolean =
com.pulumi.azure.datafactory.LinkedServiceSftp::class == javaResource::class
override fun map(javaResource: Resource): LinkedServiceSftp = LinkedServiceSftp(
javaResource as
com.pulumi.azure.datafactory.LinkedServiceSftp,
)
}
/**
* @see [LinkedServiceSftp].
* @param name The _unique_ name of the resulting resource.
* @param block Builder for [LinkedServiceSftp].
*/
public suspend fun linkedServiceSftp(
name: String,
block: suspend LinkedServiceSftpResourceBuilder.() -> Unit,
): LinkedServiceSftp {
val builder = LinkedServiceSftpResourceBuilder()
builder.name(name)
block(builder)
return builder.build()
}
/**
* @see [LinkedServiceSftp].
* @param name The _unique_ name of the resulting resource.
*/
public fun linkedServiceSftp(name: String): LinkedServiceSftp {
val builder = LinkedServiceSftpResourceBuilder()
builder.name(name)
return builder.build()
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy