Package com.pulumi.aws.transfer.inputs

Class ServerState

  • public final class ServerState
extends com.pulumi.resources.ResourceArgs

    • Method Detail

      • arn

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> arn()
        Returns:
        Amazon Resource Name (ARN) of Transfer Server

      • certificate

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> certificate()
        Returns:
        The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM) certificate. This is required when `protocols` is set to `FTPS`

      • directoryId

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> directoryId()
        Returns:
        The directory service ID of the directory service you want to connect to with an `identity_provider_type` of `AWS_DIRECTORY_SERVICE`.

      • domain

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> domain()
        Returns:
        The domain of the storage system that is used for file transfers. Valid values are: `S3` and `EFS`. The default value is `S3`.

      • endpoint

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> endpoint()
        Returns:
        The endpoint of the Transfer Server (e.g., `s-12345678.server.transfer.REGION.amazonaws.com`)

      • endpointDetails

        public java.util.Optional<com.pulumi.core.Output<ServerEndpointDetailsArgs>> endpointDetails()
        Returns:
        The virtual private cloud (VPC) endpoint settings that you want to configure for your SFTP server. See `endpoint_details` block below for details.

      • endpointType

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> endpointType()
        Returns:
        The type of endpoint that you want your SFTP server connect to. If you connect to a `VPC` (or `VPC_ENDPOINT`), your SFTP server isn't accessible over the public internet. If you want to connect your SFTP server via public internet, set `PUBLIC`. Defaults to `PUBLIC`.

      • forceDestroy

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> forceDestroy()
        Returns:
        A boolean that indicates all users associated with the server should be deleted so that the Server can be destroyed without error. The default value is `false`. This option only applies to servers configured with a `SERVICE_MANAGED` `identity_provider_type`.

      • function

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> function()
        Returns:
        The ARN for a lambda function to use for the Identity provider.

      • hostKey

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> hostKey()
        Returns:
        RSA, ECDSA, or ED25519 private key (e.g., as generated by the `ssh-keygen -t rsa -b 2048 -N "" -m PEM -f my-new-server-key`, `ssh-keygen -t ecdsa -b 256 -N "" -m PEM -f my-new-server-key` or `ssh-keygen -t ed25519 -N "" -f my-new-server-key` commands).

      • hostKeyFingerprint

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> hostKeyFingerprint()
        Returns:
        This value contains the message-digest algorithm (MD5) hash of the server's host key. This value is equivalent to the output of the `ssh-keygen -l -E md5 -f my-new-server-key` command.

      • identityProviderType

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> identityProviderType()
        Returns:
        The mode of authentication enabled for this service. The default value is `SERVICE_MANAGED`, which allows you to store and access SFTP user credentials within the service. `API_GATEWAY` indicates that user authentication requires a call to an API Gateway endpoint URL provided by you to integrate an identity provider of your choice. Using `AWS_DIRECTORY_SERVICE` will allow for authentication against AWS Managed Active Directory or Microsoft Active Directory in your on-premises environment, or in AWS using AD Connectors. Use the `AWS_LAMBDA` value to directly use a Lambda function as your identity provider. If you choose this value, you must specify the ARN for the lambda function in the `function` argument.

      • invocationRole

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> invocationRole()
        Returns:
        Amazon Resource Name (ARN) of the IAM role used to authenticate the user account with an `identity_provider_type` of `API_GATEWAY`.

      • loggingRole

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> loggingRole()
        Returns:
        Amazon Resource Name (ARN) of an IAM role that allows the service to write your SFTP users’ activity to your Amazon CloudWatch logs for monitoring and auditing purposes.

      • postAuthenticationLoginBanner

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> postAuthenticationLoginBanner()
        Returns:
        Specify a string to display when users connect to a server. This string is displayed after the user authenticates. The SFTP protocol does not support post-authentication display banners.

      • preAuthenticationLoginBanner

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> preAuthenticationLoginBanner()
        Returns:
        Specify a string to display when users connect to a server. This string is displayed before the user authenticates.

      • protocolDetails

        public java.util.Optional<com.pulumi.core.Output<ServerProtocolDetailsArgs>> protocolDetails()
        Returns:
        The protocol settings that are configured for your server. See `protocol_details` block below for details.

      • protocols

        public java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>> protocols()
        Returns:
        Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint. This defaults to `SFTP` . The available protocols are:

      • s3StorageOptions

        public java.util.Optional<com.pulumi.core.Output<ServerS3StorageOptionsArgs>> s3StorageOptions()
        Returns:
        Specifies whether or not performance for your Amazon S3 directories is optimized. This is disabled by default. See `s3_storage_options` block below for details.

      • securityPolicyName

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> securityPolicyName()
        Returns:
        Specifies the name of the security policy that is attached to the server. Default value is: `TransferSecurityPolicy-2018-11`. The available values are: * `TransferSecurityPolicy-2024-01` * `TransferSecurityPolicy-2023-05` * `TransferSecurityPolicy-2022-03` * `TransferSecurityPolicy-2020-06` * `TransferSecurityPolicy-2018-11` * `TransferSecurityPolicy-FIPS-2024-01` * `TransferSecurityPolicy-FIPS-2023-05` * `TransferSecurityPolicy-FIPS-2020-06` * `TransferSecurityPolicy-PQ-SSH-Experimental-2023-04` * `TransferSecurityPolicy-PQ-SSH-FIPS-Experimental-2023-04`

      • sftpAuthenticationMethods

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> sftpAuthenticationMethods()
        Returns:
        For SFTP-enabled servers, and for custom identity providers only. Valid values are `PASSWORD`, `PUBLIC_KEY`, `PUBLIC_KEY_OR_PASSWORD` and `PUBLIC_KEY_AND_PASSWORD`. Default value is: `PUBLIC_KEY_OR_PASSWORD`.

      • structuredLogDestinations

        public java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>> structuredLogDestinations()
        Returns:
        A set of ARNs of destinations that will receive structured logs from the transfer server such as CloudWatch Log Group ARNs. If provided this enables the transfer server to emit structured logs to the specified locations.

      • tags

        public java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        A map of tags to assign to the resource. If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.

      • tagsAll

        @Deprecated
public java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> tagsAll()
        Deprecated.
        Please use `tags` instead.
        Returns:
        A map of tags assigned to the resource, including those inherited from the provider `default_tags` configuration block.

      • url

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> url()
        Returns:
        URL of the service endpoint used to authenticate users with an `identity_provider_type` of `API_GATEWAY`.

      • workflowDetails

        public java.util.Optional<com.pulumi.core.Output<ServerWorkflowDetailsArgs>> workflowDetails()
        Returns:
        Specifies the workflow details. See `workflow_details` block below for details.