All Downloads are FREE. Search and download functionalities are using the official Maven repository.
  • Log In
  • Register

    • com.pulumi.azurenative.datafactory.inputs.SftpServerLinkedServiceArgs Maven / Gradle / Ivy

    The newest version!
    // *** WARNING: this file was generated by pulumi-java-gen. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***

package com.pulumi.azurenative.datafactory.inputs;

import com.pulumi.azurenative.datafactory.enums.SftpAuthenticationType;
import com.pulumi.azurenative.datafactory.inputs.AzureKeyVaultSecretReferenceArgs;
import com.pulumi.azurenative.datafactory.inputs.IntegrationRuntimeReferenceArgs;
import com.pulumi.azurenative.datafactory.inputs.ParameterSpecificationArgs;
import com.pulumi.azurenative.datafactory.inputs.SecureStringArgs;
import com.pulumi.core.Either;
import com.pulumi.core.Output;
import com.pulumi.core.annotations.Import;
import com.pulumi.core.internal.Codegen;
import com.pulumi.exceptions.MissingRequiredPropertyException;
import java.lang.Object;
import java.lang.String;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import javax.annotation.Nullable;


/**
 * A linked service for an SSH File Transfer Protocol (SFTP) server.
 * 
 */
public final class SftpServerLinkedServiceArgs extends com.pulumi.resources.ResourceArgs {

    public static final SftpServerLinkedServiceArgs Empty = new SftpServerLinkedServiceArgs();

    /**
     * List of tags that can be used for describing the linked service.
     * 
     */
    @Import(name="annotations")
    private @Nullable Output> annotations;

    /**
     * @return List of tags that can be used for describing the linked service.
     * 
     */
    public Optional>> annotations() {
        return Optional.ofNullable(this.annotations);
    }

    /**
     * The authentication type to be used to connect to the FTP server.
     * 
     */
    @Import(name="authenticationType")
    private @Nullable Output> authenticationType;

    /**
     * @return The authentication type to be used to connect to the FTP server.
     * 
     */
    public Optional>> authenticationType() {
        return Optional.ofNullable(this.authenticationType);
    }

    /**
     * The integration runtime reference.
     * 
     */
    @Import(name="connectVia")
    private @Nullable Output connectVia;

    /**
     * @return The integration runtime reference.
     * 
     */
    public Optional> connectVia() {
        return Optional.ofNullable(this.connectVia);
    }

    /**
     * Linked service description.
     * 
     */
    @Import(name="description")
    private @Nullable Output description;

    /**
     * @return Linked service description.
     * 
     */
    public Optional> description() {
        return Optional.ofNullable(this.description);
    }

    /**
     * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
     * 
     */
    @Import(name="encryptedCredential")
    private @Nullable Output encryptedCredential;

    /**
     * @return The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
     * 
     */
    public Optional> encryptedCredential() {
        return Optional.ofNullable(this.encryptedCredential);
    }

    /**
     * The SFTP server host name. Type: string (or Expression with resultType string).
     * 
     */
    @Import(name="host", required=true)
    private Output host;

    /**
     * @return The SFTP server host name. Type: string (or Expression with resultType string).
     * 
     */
    public Output host() {
        return this.host;
    }

    /**
     * The host key finger-print of the SFTP server. When SkipHostKeyValidation is false, HostKeyFingerprint should be specified. Type: string (or Expression with resultType string).
     * 
     */
    @Import(name="hostKeyFingerprint")
    private @Nullable Output hostKeyFingerprint;

    /**
     * @return The host key finger-print of the SFTP server. When SkipHostKeyValidation is false, HostKeyFingerprint should be specified. Type: string (or Expression with resultType string).
     * 
     */
    public Optional> hostKeyFingerprint() {
        return Optional.ofNullable(this.hostKeyFingerprint);
    }

    /**
     * Parameters for linked service.
     * 
     */
    @Import(name="parameters")
    private @Nullable Output> parameters;

    /**
     * @return Parameters for linked service.
     * 
     */
    public Optional>> parameters() {
        return Optional.ofNullable(this.parameters);
    }

    /**
     * The password to decrypt the SSH private key if the SSH private key is encrypted.
     * 
     */
    @Import(name="passPhrase")
    private @Nullable Output> passPhrase;

    /**
     * @return The password to decrypt the SSH private key if the SSH private key is encrypted.
     * 
     */
    public Optional>> passPhrase() {
        return Optional.ofNullable(this.passPhrase);
    }

    /**
     * Password to logon the SFTP server for Basic authentication.
     * 
     */
    @Import(name="password")
    private @Nullable Output> password;

    /**
     * @return Password to logon the SFTP server for Basic authentication.
     * 
     */
    public Optional>> password() {
        return Optional.ofNullable(this.password);
    }

    /**
     * The TCP port number that the SFTP server uses to listen for client connections. Default value is 22. Type: integer (or Expression with resultType integer), minimum: 0.
     * 
     */
    @Import(name="port")
    private @Nullable Output port;

    /**
     * @return The TCP port number that the SFTP server uses to listen for client connections. Default value is 22. Type: integer (or Expression with resultType integer), minimum: 0.
     * 
     */
    public Optional> port() {
        return Optional.ofNullable(this.port);
    }

    /**
     * Base64 encoded SSH private key content for SshPublicKey authentication. For on-premises copy with SshPublicKey authentication, either PrivateKeyPath or PrivateKeyContent should be specified. SSH private key should be OpenSSH format.
     * 
     */
    @Import(name="privateKeyContent")
    private @Nullable Output> privateKeyContent;

    /**
     * @return Base64 encoded SSH private key content for SshPublicKey authentication. For on-premises copy with SshPublicKey authentication, either PrivateKeyPath or PrivateKeyContent should be specified. SSH private key should be OpenSSH format.
     * 
     */
    public Optional>> privateKeyContent() {
        return Optional.ofNullable(this.privateKeyContent);
    }

    /**
     * The SSH private key file path for SshPublicKey authentication. Only valid for on-premises copy. For on-premises copy with SshPublicKey authentication, either PrivateKeyPath or PrivateKeyContent should be specified. SSH private key should be OpenSSH format. Type: string (or Expression with resultType string).
     * 
     */
    @Import(name="privateKeyPath")
    private @Nullable Output privateKeyPath;

    /**
     * @return The SSH private key file path for SshPublicKey authentication. Only valid for on-premises copy. For on-premises copy with SshPublicKey authentication, either PrivateKeyPath or PrivateKeyContent should be specified. SSH private key should be OpenSSH format. Type: string (or Expression with resultType string).
     * 
     */
    public Optional> privateKeyPath() {
        return Optional.ofNullable(this.privateKeyPath);
    }

    /**
     * If true, skip the SSH host key validation. Default value is false. Type: boolean (or Expression with resultType boolean).
     * 
     */
    @Import(name="skipHostKeyValidation")
    private @Nullable Output skipHostKeyValidation;

    /**
     * @return If true, skip the SSH host key validation. Default value is false. Type: boolean (or Expression with resultType boolean).
     * 
     */
    public Optional> skipHostKeyValidation() {
        return Optional.ofNullable(this.skipHostKeyValidation);
    }

    /**
     * Type of linked service.
     * Expected value is 'Sftp'.
     * 
     */
    @Import(name="type", required=true)
    private Output type;

    /**
     * @return Type of linked service.
     * Expected value is 'Sftp'.
     * 
     */
    public Output type() {
        return this.type;
    }

    /**
     * The username used to log on to the SFTP server. Type: string (or Expression with resultType string).
     * 
     */
    @Import(name="userName")
    private @Nullable Output userName;

    /**
     * @return The username used to log on to the SFTP server. Type: string (or Expression with resultType string).
     * 
     */
    public Optional> userName() {
        return Optional.ofNullable(this.userName);
    }

    /**
     * Version of the linked service.
     * 
     */
    @Import(name="version")
    private @Nullable Output version;

    /**
     * @return Version of the linked service.
     * 
     */
    public Optional> version() {
        return Optional.ofNullable(this.version);
    }

    private SftpServerLinkedServiceArgs() {}

    private SftpServerLinkedServiceArgs(SftpServerLinkedServiceArgs $) {
        this.annotations = $.annotations;
        this.authenticationType = $.authenticationType;
        this.connectVia = $.connectVia;
        this.description = $.description;
        this.encryptedCredential = $.encryptedCredential;
        this.host = $.host;
        this.hostKeyFingerprint = $.hostKeyFingerprint;
        this.parameters = $.parameters;
        this.passPhrase = $.passPhrase;
        this.password = $.password;
        this.port = $.port;
        this.privateKeyContent = $.privateKeyContent;
        this.privateKeyPath = $.privateKeyPath;
        this.skipHostKeyValidation = $.skipHostKeyValidation;
        this.type = $.type;
        this.userName = $.userName;
        this.version = $.version;
    }

    public static Builder builder() {
        return new Builder();
    }
    public static Builder builder(SftpServerLinkedServiceArgs defaults) {
        return new Builder(defaults);
    }

    public static final class Builder {
        private SftpServerLinkedServiceArgs $;

        public Builder() {
            $ = new SftpServerLinkedServiceArgs();
        }

        public Builder(SftpServerLinkedServiceArgs defaults) {
            $ = new SftpServerLinkedServiceArgs(Objects.requireNonNull(defaults));
        }

        /**
         * @param annotations List of tags that can be used for describing the linked service.
         * 
         * @return builder
         * 
         */
        public Builder annotations(@Nullable Output> annotations) {
            $.annotations = annotations;
            return this;
        }

        /**
         * @param annotations List of tags that can be used for describing the linked service.
         * 
         * @return builder
         * 
         */
        public Builder annotations(List annotations) {
            return annotations(Output.of(annotations));
        }

        /**
         * @param annotations List of tags that can be used for describing the linked service.
         * 
         * @return builder
         * 
         */
        public Builder annotations(Object... annotations) {
            return annotations(List.of(annotations));
        }

        /**
         * @param authenticationType The authentication type to be used to connect to the FTP server.
         * 
         * @return builder
         * 
         */
        public Builder authenticationType(@Nullable Output> authenticationType) {
            $.authenticationType = authenticationType;
            return this;
        }

        /**
         * @param authenticationType The authentication type to be used to connect to the FTP server.
         * 
         * @return builder
         * 
         */
        public Builder authenticationType(Either authenticationType) {
            return authenticationType(Output.of(authenticationType));
        }

        /**
         * @param authenticationType The authentication type to be used to connect to the FTP server.
         * 
         * @return builder
         * 
         */
        public Builder authenticationType(String authenticationType) {
            return authenticationType(Either.ofLeft(authenticationType));
        }

        /**
         * @param authenticationType The authentication type to be used to connect to the FTP server.
         * 
         * @return builder
         * 
         */
        public Builder authenticationType(SftpAuthenticationType authenticationType) {
            return authenticationType(Either.ofRight(authenticationType));
        }

        /**
         * @param connectVia The integration runtime reference.
         * 
         * @return builder
         * 
         */
        public Builder connectVia(@Nullable Output connectVia) {
            $.connectVia = connectVia;
            return this;
        }

        /**
         * @param connectVia The integration runtime reference.
         * 
         * @return builder
         * 
         */
        public Builder connectVia(IntegrationRuntimeReferenceArgs connectVia) {
            return connectVia(Output.of(connectVia));
        }

        /**
         * @param description Linked service description.
         * 
         * @return builder
         * 
         */
        public Builder description(@Nullable Output description) {
            $.description = description;
            return this;
        }

        /**
         * @param description Linked service description.
         * 
         * @return builder
         * 
         */
        public Builder description(String description) {
            return description(Output.of(description));
        }

        /**
         * @param encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
         * 
         * @return builder
         * 
         */
        public Builder encryptedCredential(@Nullable Output encryptedCredential) {
            $.encryptedCredential = encryptedCredential;
            return this;
        }

        /**
         * @param encryptedCredential The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
         * 
         * @return builder
         * 
         */
        public Builder encryptedCredential(String encryptedCredential) {
            return encryptedCredential(Output.of(encryptedCredential));
        }

        /**
         * @param host The SFTP server host name. Type: string (or Expression with resultType string).
         * 
         * @return builder
         * 
         */
        public Builder host(Output host) {
            $.host = host;
            return this;
        }

        /**
         * @param host The SFTP server host name. Type: string (or Expression with resultType string).
         * 
         * @return builder
         * 
         */
        public Builder host(Object host) {
            return host(Output.of(host));
        }

        /**
         * @param hostKeyFingerprint The host key finger-print of the SFTP server. When SkipHostKeyValidation is false, HostKeyFingerprint should be specified. Type: string (or Expression with resultType string).
         * 
         * @return builder
         * 
         */
        public Builder hostKeyFingerprint(@Nullable Output hostKeyFingerprint) {
            $.hostKeyFingerprint = hostKeyFingerprint;
            return this;
        }

        /**
         * @param hostKeyFingerprint The host key finger-print of the SFTP server. When SkipHostKeyValidation is false, HostKeyFingerprint should be specified. Type: string (or Expression with resultType string).
         * 
         * @return builder
         * 
         */
        public Builder hostKeyFingerprint(Object hostKeyFingerprint) {
            return hostKeyFingerprint(Output.of(hostKeyFingerprint));
        }

        /**
         * @param parameters Parameters for linked service.
         * 
         * @return builder
         * 
         */
        public Builder parameters(@Nullable Output> parameters) {
            $.parameters = parameters;
            return this;
        }

        /**
         * @param parameters Parameters for linked service.
         * 
         * @return builder
         * 
         */
        public Builder parameters(Map parameters) {
            return parameters(Output.of(parameters));
        }

        /**
         * @param passPhrase The password to decrypt the SSH private key if the SSH private key is encrypted.
         * 
         * @return builder
         * 
         */
        public Builder passPhrase(@Nullable Output> passPhrase) {
            $.passPhrase = passPhrase;
            return this;
        }

        /**
         * @param passPhrase The password to decrypt the SSH private key if the SSH private key is encrypted.
         * 
         * @return builder
         * 
         */
        public Builder passPhrase(Either passPhrase) {
            return passPhrase(Output.of(passPhrase));
        }

        /**
         * @param passPhrase The password to decrypt the SSH private key if the SSH private key is encrypted.
         * 
         * @return builder
         * 
         */
        public Builder passPhrase(AzureKeyVaultSecretReferenceArgs passPhrase) {
            return passPhrase(Either.ofLeft(passPhrase));
        }

        /**
         * @param passPhrase The password to decrypt the SSH private key if the SSH private key is encrypted.
         * 
         * @return builder
         * 
         */
        public Builder passPhrase(SecureStringArgs passPhrase) {
            return passPhrase(Either.ofRight(passPhrase));
        }

        /**
         * @param password Password to logon the SFTP server for Basic authentication.
         * 
         * @return builder
         * 
         */
        public Builder password(@Nullable Output> password) {
            $.password = password;
            return this;
        }

        /**
         * @param password Password to logon the SFTP server for Basic authentication.
         * 
         * @return builder
         * 
         */
        public Builder password(Either password) {
            return password(Output.of(password));
        }

        /**
         * @param password Password to logon the SFTP server for Basic authentication.
         * 
         * @return builder
         * 
         */
        public Builder password(AzureKeyVaultSecretReferenceArgs password) {
            return password(Either.ofLeft(password));
        }

        /**
         * @param password Password to logon the SFTP server for Basic authentication.
         * 
         * @return builder
         * 
         */
        public Builder password(SecureStringArgs password) {
            return password(Either.ofRight(password));
        }

        /**
         * @param port The TCP port number that the SFTP server uses to listen for client connections. Default value is 22. Type: integer (or Expression with resultType integer), minimum: 0.
         * 
         * @return builder
         * 
         */
        public Builder port(@Nullable Output port) {
            $.port = port;
            return this;
        }

        /**
         * @param port The TCP port number that the SFTP server uses to listen for client connections. Default value is 22. Type: integer (or Expression with resultType integer), minimum: 0.
         * 
         * @return builder
         * 
         */
        public Builder port(Object port) {
            return port(Output.of(port));
        }

        /**
         * @param privateKeyContent Base64 encoded SSH private key content for SshPublicKey authentication. For on-premises copy with SshPublicKey authentication, either PrivateKeyPath or PrivateKeyContent should be specified. SSH private key should be OpenSSH format.
         * 
         * @return builder
         * 
         */
        public Builder privateKeyContent(@Nullable Output> privateKeyContent) {
            $.privateKeyContent = privateKeyContent;
            return this;
        }

        /**
         * @param privateKeyContent Base64 encoded SSH private key content for SshPublicKey authentication. For on-premises copy with SshPublicKey authentication, either PrivateKeyPath or PrivateKeyContent should be specified. SSH private key should be OpenSSH format.
         * 
         * @return builder
         * 
         */
        public Builder privateKeyContent(Either privateKeyContent) {
            return privateKeyContent(Output.of(privateKeyContent));
        }

        /**
         * @param privateKeyContent Base64 encoded SSH private key content for SshPublicKey authentication. For on-premises copy with SshPublicKey authentication, either PrivateKeyPath or PrivateKeyContent should be specified. SSH private key should be OpenSSH format.
         * 
         * @return builder
         * 
         */
        public Builder privateKeyContent(AzureKeyVaultSecretReferenceArgs privateKeyContent) {
            return privateKeyContent(Either.ofLeft(privateKeyContent));
        }

        /**
         * @param privateKeyContent Base64 encoded SSH private key content for SshPublicKey authentication. For on-premises copy with SshPublicKey authentication, either PrivateKeyPath or PrivateKeyContent should be specified. SSH private key should be OpenSSH format.
         * 
         * @return builder
         * 
         */
        public Builder privateKeyContent(SecureStringArgs privateKeyContent) {
            return privateKeyContent(Either.ofRight(privateKeyContent));
        }

        /**
         * @param privateKeyPath The SSH private key file path for SshPublicKey authentication. Only valid for on-premises copy. For on-premises copy with SshPublicKey authentication, either PrivateKeyPath or PrivateKeyContent should be specified. SSH private key should be OpenSSH format. Type: string (or Expression with resultType string).
         * 
         * @return builder
         * 
         */
        public Builder privateKeyPath(@Nullable Output privateKeyPath) {
            $.privateKeyPath = privateKeyPath;
            return this;
        }

        /**
         * @param privateKeyPath The SSH private key file path for SshPublicKey authentication. Only valid for on-premises copy. For on-premises copy with SshPublicKey authentication, either PrivateKeyPath or PrivateKeyContent should be specified. SSH private key should be OpenSSH format. Type: string (or Expression with resultType string).
         * 
         * @return builder
         * 
         */
        public Builder privateKeyPath(Object privateKeyPath) {
            return privateKeyPath(Output.of(privateKeyPath));
        }

        /**
         * @param skipHostKeyValidation If true, skip the SSH host key validation. Default value is false. Type: boolean (or Expression with resultType boolean).
         * 
         * @return builder
         * 
         */
        public Builder skipHostKeyValidation(@Nullable Output skipHostKeyValidation) {
            $.skipHostKeyValidation = skipHostKeyValidation;
            return this;
        }

        /**
         * @param skipHostKeyValidation If true, skip the SSH host key validation. Default value is false. Type: boolean (or Expression with resultType boolean).
         * 
         * @return builder
         * 
         */
        public Builder skipHostKeyValidation(Object skipHostKeyValidation) {
            return skipHostKeyValidation(Output.of(skipHostKeyValidation));
        }

        /**
         * @param type Type of linked service.
         * Expected value is 'Sftp'.
         * 
         * @return builder
         * 
         */
        public Builder type(Output type) {
            $.type = type;
            return this;
        }

        /**
         * @param type Type of linked service.
         * Expected value is 'Sftp'.
         * 
         * @return builder
         * 
         */
        public Builder type(String type) {
            return type(Output.of(type));
        }

        /**
         * @param userName The username used to log on to the SFTP server. Type: string (or Expression with resultType string).
         * 
         * @return builder
         * 
         */
        public Builder userName(@Nullable Output userName) {
            $.userName = userName;
            return this;
        }

        /**
         * @param userName The username used to log on to the SFTP server. Type: string (or Expression with resultType string).
         * 
         * @return builder
         * 
         */
        public Builder userName(Object userName) {
            return userName(Output.of(userName));
        }

        /**
         * @param version Version of the linked service.
         * 
         * @return builder
         * 
         */
        public Builder version(@Nullable Output version) {
            $.version = version;
            return this;
        }

        /**
         * @param version Version of the linked service.
         * 
         * @return builder
         * 
         */
        public Builder version(String version) {
            return version(Output.of(version));
        }

        public SftpServerLinkedServiceArgs build() {
            if ($.host == null) {
                throw new MissingRequiredPropertyException("SftpServerLinkedServiceArgs", "host");
            }
            $.type = Codegen.stringProp("type").output().arg($.type).require();
            return $;
        }
    }

}
    
    
    
    

    




    
    
    © 2015 - 2024 Weber Informatics LLC | Privacy Policy