1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. transfer
  5. getConnector

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.38.0 published on Wednesday, Nov 5, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.transfer.getConnector

Start a Neo task
Explain and create an aws-native.transfer.getConnector resource
aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.38.0 published on Wednesday, Nov 5, 2025 by Pulumi
pulumi/pulumi-aws-native

    Resource Type definition for AWS::Transfer::Connector

    Using getConnector

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getConnector(args: GetConnectorArgs, opts?: InvokeOptions): Promise<GetConnectorResult>
function getConnectorOutput(args: GetConnectorOutputArgs, opts?: InvokeOptions): Output<GetConnectorResult>
    def get_connector(connector_id: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetConnectorResult
def get_connector_output(connector_id: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetConnectorResult]
    func LookupConnector(ctx *Context, args *LookupConnectorArgs, opts ...InvokeOption) (*LookupConnectorResult, error)
func LookupConnectorOutput(ctx *Context, args *LookupConnectorOutputArgs, opts ...InvokeOption) LookupConnectorResultOutput

    > Note: This function is named LookupConnector in the Go SDK.

    public static class GetConnector 
{
    public static Task<GetConnectorResult> InvokeAsync(GetConnectorArgs args, InvokeOptions? opts = null)
    public static Output<GetConnectorResult> Invoke(GetConnectorInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetConnectorResult> getConnector(GetConnectorArgs args, InvokeOptions options)
public static Output<GetConnectorResult> getConnector(GetConnectorArgs args, InvokeOptions options)

    fn::invoke:
  function: aws-native:transfer:getConnector
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ConnectorId string
    A unique identifier for the connector.
    ConnectorId string
    A unique identifier for the connector.
    connectorId String
    A unique identifier for the connector.
    connectorId string
    A unique identifier for the connector.
    connector_id str
    A unique identifier for the connector.
    connectorId String
    A unique identifier for the connector.

    getConnector Result

    The following output properties are available:

    AccessRole string
    Specifies the access role for the connector.
    Arn string
    Specifies the unique Amazon Resource Name (ARN) for the connector.
    As2Config Pulumi.AwsNative.Transfer.Outputs.As2ConfigProperties
    Configuration for an AS2 connector.
    ConnectorId string
    A unique identifier for the connector.
    EgressConfig Pulumi.AwsNative.Transfer.Outputs.ConnectorEgressConfig
    Egress configuration for the connector.
    EgressType Pulumi.AwsNative.Transfer.ConnectorEgressType
    Specifies the egress type for the connector.
    LoggingRole string
    Specifies the logging role for the connector.
    SecurityPolicyName string
    Security policy for SFTP Connector
    ServiceManagedEgressIpAddresses List<string>
    The list of egress IP addresses of this connector. These IP addresses are assigned automatically when you create the connector.
    SftpConfig Pulumi.AwsNative.Transfer.Outputs.SftpConfigProperties
    Configuration for an SFTP connector.
    Status Pulumi.AwsNative.Transfer.ConnectorStatus
    Current status of the connector. PENDING indicates creation/update in progress, ACTIVE means ready for operations, and ERRORED indicates a failure requiring attention.
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    Key-value pairs that can be used to group and search for connectors. Tags are metadata attached to connectors for any purpose.
    Url string
    URL for Connector
    AccessRole string
    Specifies the access role for the connector.
    Arn string
    Specifies the unique Amazon Resource Name (ARN) for the connector.
    As2Config As2ConfigProperties
    Configuration for an AS2 connector.
    ConnectorId string
    A unique identifier for the connector.
    EgressConfig ConnectorEgressConfig
    Egress configuration for the connector.
    EgressType ConnectorEgressType
    Specifies the egress type for the connector.
    LoggingRole string
    Specifies the logging role for the connector.
    SecurityPolicyName string
    Security policy for SFTP Connector
    ServiceManagedEgressIpAddresses []string
    The list of egress IP addresses of this connector. These IP addresses are assigned automatically when you create the connector.
    SftpConfig SftpConfigProperties
    Configuration for an SFTP connector.
    Status ConnectorStatus
    Current status of the connector. PENDING indicates creation/update in progress, ACTIVE means ready for operations, and ERRORED indicates a failure requiring attention.
    Tags Tag
    Key-value pairs that can be used to group and search for connectors. Tags are metadata attached to connectors for any purpose.
    Url string
    URL for Connector
    accessRole String
    Specifies the access role for the connector.
    arn String
    Specifies the unique Amazon Resource Name (ARN) for the connector.
    as2Config As2ConfigProperties
    Configuration for an AS2 connector.
    connectorId String
    A unique identifier for the connector.
    egressConfig ConnectorEgressConfig
    Egress configuration for the connector.
    egressType ConnectorEgressType
    Specifies the egress type for the connector.
    loggingRole String
    Specifies the logging role for the connector.
    securityPolicyName String
    Security policy for SFTP Connector
    serviceManagedEgressIpAddresses List<String>
    The list of egress IP addresses of this connector. These IP addresses are assigned automatically when you create the connector.
    sftpConfig SftpConfigProperties
    Configuration for an SFTP connector.
    status ConnectorStatus
    Current status of the connector. PENDING indicates creation/update in progress, ACTIVE means ready for operations, and ERRORED indicates a failure requiring attention.
    tags List<Tag>
    Key-value pairs that can be used to group and search for connectors. Tags are metadata attached to connectors for any purpose.
    url String
    URL for Connector
    accessRole string
    Specifies the access role for the connector.
    arn string
    Specifies the unique Amazon Resource Name (ARN) for the connector.
    as2Config As2ConfigProperties
    Configuration for an AS2 connector.
    connectorId string
    A unique identifier for the connector.
    egressConfig ConnectorEgressConfig
    Egress configuration for the connector.
    egressType ConnectorEgressType
    Specifies the egress type for the connector.
    loggingRole string
    Specifies the logging role for the connector.
    securityPolicyName string
    Security policy for SFTP Connector
    serviceManagedEgressIpAddresses string[]
    The list of egress IP addresses of this connector. These IP addresses are assigned automatically when you create the connector.
    sftpConfig SftpConfigProperties
    Configuration for an SFTP connector.
    status ConnectorStatus
    Current status of the connector. PENDING indicates creation/update in progress, ACTIVE means ready for operations, and ERRORED indicates a failure requiring attention.
    tags Tag[]
    Key-value pairs that can be used to group and search for connectors. Tags are metadata attached to connectors for any purpose.
    url string
    URL for Connector
    access_role str
    Specifies the access role for the connector.
    arn str
    Specifies the unique Amazon Resource Name (ARN) for the connector.
    as2_config As2ConfigProperties
    Configuration for an AS2 connector.
    connector_id str
    A unique identifier for the connector.
    egress_config ConnectorEgressConfig
    Egress configuration for the connector.
    egress_type ConnectorEgressType
    Specifies the egress type for the connector.
    logging_role str
    Specifies the logging role for the connector.
    security_policy_name str
    Security policy for SFTP Connector
    service_managed_egress_ip_addresses Sequence[str]
    The list of egress IP addresses of this connector. These IP addresses are assigned automatically when you create the connector.
    sftp_config SftpConfigProperties
    Configuration for an SFTP connector.
    status ConnectorStatus
    Current status of the connector. PENDING indicates creation/update in progress, ACTIVE means ready for operations, and ERRORED indicates a failure requiring attention.
    tags Sequence[root_Tag]
    Key-value pairs that can be used to group and search for connectors. Tags are metadata attached to connectors for any purpose.
    url str
    URL for Connector
    accessRole String
    Specifies the access role for the connector.
    arn String
    Specifies the unique Amazon Resource Name (ARN) for the connector.
    as2Config Property Map
    Configuration for an AS2 connector.
    connectorId String
    A unique identifier for the connector.
    egressConfig Property Map
    Egress configuration for the connector.
    egressType "SERVICE_MANAGED" | "VPC_LATTICE"
    Specifies the egress type for the connector.
    loggingRole String
    Specifies the logging role for the connector.
    securityPolicyName String
    Security policy for SFTP Connector
    serviceManagedEgressIpAddresses List<String>
    The list of egress IP addresses of this connector. These IP addresses are assigned automatically when you create the connector.
    sftpConfig Property Map
    Configuration for an SFTP connector.
    status "ACTIVE" | "PENDING" | "ERRORED"
    Current status of the connector. PENDING indicates creation/update in progress, ACTIVE means ready for operations, and ERRORED indicates a failure requiring attention.
    tags List<Property Map>
    Key-value pairs that can be used to group and search for connectors. Tags are metadata attached to connectors for any purpose.
    url String
    URL for Connector

    Supporting Types

    As2ConfigProperties

    BasicAuthSecretId string
    ARN or name of the secret in AWS Secrets Manager which contains the credentials for Basic authentication. If empty, Basic authentication is disabled for the AS2 connector
    Compression Pulumi.AwsNative.Transfer.ConnectorAs2ConfigPropertiesCompression
    Compression setting for this AS2 connector configuration.
    EncryptionAlgorithm Pulumi.AwsNative.Transfer.ConnectorAs2ConfigPropertiesEncryptionAlgorithm
    Encryption algorithm for this AS2 connector configuration.
    LocalProfileId string
    A unique identifier for the local profile.
    MdnResponse Pulumi.AwsNative.Transfer.ConnectorAs2ConfigPropertiesMdnResponse
    MDN Response setting for this AS2 connector configuration.
    MdnSigningAlgorithm Pulumi.AwsNative.Transfer.ConnectorAs2ConfigPropertiesMdnSigningAlgorithm
    MDN Signing algorithm for this AS2 connector configuration.
    MessageSubject string
    The message subject for this AS2 connector configuration.
    PartnerProfileId string
    A unique identifier for the partner profile.
    PreserveContentType Pulumi.AwsNative.Transfer.ConnectorAs2ConfigPropertiesPreserveContentType
    Specifies whether to use the AWS S3 object content-type as the content-type for the AS2 message.
    SigningAlgorithm Pulumi.AwsNative.Transfer.ConnectorAs2ConfigPropertiesSigningAlgorithm
    Signing algorithm for this AS2 connector configuration.
    BasicAuthSecretId string
    ARN or name of the secret in AWS Secrets Manager which contains the credentials for Basic authentication. If empty, Basic authentication is disabled for the AS2 connector
    Compression ConnectorAs2ConfigPropertiesCompression
    Compression setting for this AS2 connector configuration.
    EncryptionAlgorithm ConnectorAs2ConfigPropertiesEncryptionAlgorithm
    Encryption algorithm for this AS2 connector configuration.
    LocalProfileId string
    A unique identifier for the local profile.
    MdnResponse ConnectorAs2ConfigPropertiesMdnResponse
    MDN Response setting for this AS2 connector configuration.
    MdnSigningAlgorithm ConnectorAs2ConfigPropertiesMdnSigningAlgorithm
    MDN Signing algorithm for this AS2 connector configuration.
    MessageSubject string
    The message subject for this AS2 connector configuration.
    PartnerProfileId string
    A unique identifier for the partner profile.
    PreserveContentType ConnectorAs2ConfigPropertiesPreserveContentType
    Specifies whether to use the AWS S3 object content-type as the content-type for the AS2 message.
    SigningAlgorithm ConnectorAs2ConfigPropertiesSigningAlgorithm
    Signing algorithm for this AS2 connector configuration.
    basicAuthSecretId String
    ARN or name of the secret in AWS Secrets Manager which contains the credentials for Basic authentication. If empty, Basic authentication is disabled for the AS2 connector
    compression ConnectorAs2ConfigPropertiesCompression
    Compression setting for this AS2 connector configuration.
    encryptionAlgorithm ConnectorAs2ConfigPropertiesEncryptionAlgorithm
    Encryption algorithm for this AS2 connector configuration.
    localProfileId String
    A unique identifier for the local profile.
    mdnResponse ConnectorAs2ConfigPropertiesMdnResponse
    MDN Response setting for this AS2 connector configuration.
    mdnSigningAlgorithm ConnectorAs2ConfigPropertiesMdnSigningAlgorithm
    MDN Signing algorithm for this AS2 connector configuration.
    messageSubject String
    The message subject for this AS2 connector configuration.
    partnerProfileId String
    A unique identifier for the partner profile.
    preserveContentType ConnectorAs2ConfigPropertiesPreserveContentType
    Specifies whether to use the AWS S3 object content-type as the content-type for the AS2 message.
    signingAlgorithm ConnectorAs2ConfigPropertiesSigningAlgorithm
    Signing algorithm for this AS2 connector configuration.
    basicAuthSecretId string
    ARN or name of the secret in AWS Secrets Manager which contains the credentials for Basic authentication. If empty, Basic authentication is disabled for the AS2 connector
    compression ConnectorAs2ConfigPropertiesCompression
    Compression setting for this AS2 connector configuration.
    encryptionAlgorithm ConnectorAs2ConfigPropertiesEncryptionAlgorithm
    Encryption algorithm for this AS2 connector configuration.
    localProfileId string
    A unique identifier for the local profile.
    mdnResponse ConnectorAs2ConfigPropertiesMdnResponse
    MDN Response setting for this AS2 connector configuration.
    mdnSigningAlgorithm ConnectorAs2ConfigPropertiesMdnSigningAlgorithm
    MDN Signing algorithm for this AS2 connector configuration.
    messageSubject string
    The message subject for this AS2 connector configuration.
    partnerProfileId string
    A unique identifier for the partner profile.
    preserveContentType ConnectorAs2ConfigPropertiesPreserveContentType
    Specifies whether to use the AWS S3 object content-type as the content-type for the AS2 message.
    signingAlgorithm ConnectorAs2ConfigPropertiesSigningAlgorithm
    Signing algorithm for this AS2 connector configuration.
    basic_auth_secret_id str
    ARN or name of the secret in AWS Secrets Manager which contains the credentials for Basic authentication. If empty, Basic authentication is disabled for the AS2 connector
    compression ConnectorAs2ConfigPropertiesCompression
    Compression setting for this AS2 connector configuration.
    encryption_algorithm ConnectorAs2ConfigPropertiesEncryptionAlgorithm
    Encryption algorithm for this AS2 connector configuration.
    local_profile_id str
    A unique identifier for the local profile.
    mdn_response ConnectorAs2ConfigPropertiesMdnResponse
    MDN Response setting for this AS2 connector configuration.
    mdn_signing_algorithm ConnectorAs2ConfigPropertiesMdnSigningAlgorithm
    MDN Signing algorithm for this AS2 connector configuration.
    message_subject str
    The message subject for this AS2 connector configuration.
    partner_profile_id str
    A unique identifier for the partner profile.
    preserve_content_type ConnectorAs2ConfigPropertiesPreserveContentType
    Specifies whether to use the AWS S3 object content-type as the content-type for the AS2 message.
    signing_algorithm ConnectorAs2ConfigPropertiesSigningAlgorithm
    Signing algorithm for this AS2 connector configuration.
    basicAuthSecretId String
    ARN or name of the secret in AWS Secrets Manager which contains the credentials for Basic authentication. If empty, Basic authentication is disabled for the AS2 connector
    compression "ZLIB" | "DISABLED"
    Compression setting for this AS2 connector configuration.
    encryptionAlgorithm "AES128_CBC" | "AES192_CBC" | "AES256_CBC" | "NONE" | "DES_EDE3_CBC"
    Encryption algorithm for this AS2 connector configuration.
    localProfileId String
    A unique identifier for the local profile.
    mdnResponse "SYNC" | "NONE"
    MDN Response setting for this AS2 connector configuration.
    mdnSigningAlgorithm "SHA256" | "SHA384" | "SHA512" | "SHA1" | "NONE" | "DEFAULT"
    MDN Signing algorithm for this AS2 connector configuration.
    messageSubject String
    The message subject for this AS2 connector configuration.
    partnerProfileId String
    A unique identifier for the partner profile.
    preserveContentType "ENABLED" | "DISABLED"
    Specifies whether to use the AWS S3 object content-type as the content-type for the AS2 message.
    signingAlgorithm "SHA256" | "SHA384" | "SHA512" | "SHA1" | "NONE"
    Signing algorithm for this AS2 connector configuration.

    ConnectorAs2ConfigPropertiesCompression

    ConnectorAs2ConfigPropertiesEncryptionAlgorithm

    ConnectorAs2ConfigPropertiesMdnResponse

    ConnectorAs2ConfigPropertiesMdnSigningAlgorithm

    ConnectorAs2ConfigPropertiesPreserveContentType

    ConnectorAs2ConfigPropertiesSigningAlgorithm

    ConnectorEgressConfig

    VpcLattice Pulumi.AwsNative.Transfer.Inputs.ConnectorVpcLatticeEgressConfig
    VPC_LATTICE configuration for routing connector traffic through customer VPCs. Enables private connectivity to SFTP servers without requiring public internet access or complex network configurations.
    VpcLattice ConnectorVpcLatticeEgressConfig
    VPC_LATTICE configuration for routing connector traffic through customer VPCs. Enables private connectivity to SFTP servers without requiring public internet access or complex network configurations.
    vpcLattice ConnectorVpcLatticeEgressConfig
    VPC_LATTICE configuration for routing connector traffic through customer VPCs. Enables private connectivity to SFTP servers without requiring public internet access or complex network configurations.
    vpcLattice ConnectorVpcLatticeEgressConfig
    VPC_LATTICE configuration for routing connector traffic through customer VPCs. Enables private connectivity to SFTP servers without requiring public internet access or complex network configurations.
    vpc_lattice ConnectorVpcLatticeEgressConfig
    VPC_LATTICE configuration for routing connector traffic through customer VPCs. Enables private connectivity to SFTP servers without requiring public internet access or complex network configurations.
    vpcLattice Property Map
    VPC_LATTICE configuration for routing connector traffic through customer VPCs. Enables private connectivity to SFTP servers without requiring public internet access or complex network configurations.

    ConnectorEgressType

    ConnectorStatus

    ConnectorVpcLatticeEgressConfig

    ResourceConfigurationArn string
    ARN of the VPC Lattice resource configuration
    PortNumber int
    Port to connect to on the target VPC Lattice resource
    ResourceConfigurationArn string
    ARN of the VPC Lattice resource configuration
    PortNumber int
    Port to connect to on the target VPC Lattice resource
    resourceConfigurationArn String
    ARN of the VPC Lattice resource configuration
    portNumber Integer
    Port to connect to on the target VPC Lattice resource
    resourceConfigurationArn string
    ARN of the VPC Lattice resource configuration
    portNumber number
    Port to connect to on the target VPC Lattice resource
    resource_configuration_arn str
    ARN of the VPC Lattice resource configuration
    port_number int
    Port to connect to on the target VPC Lattice resource
    resourceConfigurationArn String
    ARN of the VPC Lattice resource configuration
    portNumber Number
    Port to connect to on the target VPC Lattice resource

    SftpConfigProperties

    MaxConcurrentConnections int
    Specifies the number of active connections that your connector can establish with the remote server at the same time.
    TrustedHostKeys List<string>
    List of public host keys, for the external server to which you are connecting.
    UserSecretId string
    ARN or name of the secret in AWS Secrets Manager which contains the SFTP user's private keys or passwords.
    MaxConcurrentConnections int
    Specifies the number of active connections that your connector can establish with the remote server at the same time.
    TrustedHostKeys []string
    List of public host keys, for the external server to which you are connecting.
    UserSecretId string
    ARN or name of the secret in AWS Secrets Manager which contains the SFTP user's private keys or passwords.
    maxConcurrentConnections Integer
    Specifies the number of active connections that your connector can establish with the remote server at the same time.
    trustedHostKeys List<String>
    List of public host keys, for the external server to which you are connecting.
    userSecretId String
    ARN or name of the secret in AWS Secrets Manager which contains the SFTP user's private keys or passwords.
    maxConcurrentConnections number
    Specifies the number of active connections that your connector can establish with the remote server at the same time.
    trustedHostKeys string[]
    List of public host keys, for the external server to which you are connecting.
    userSecretId string
    ARN or name of the secret in AWS Secrets Manager which contains the SFTP user's private keys or passwords.
    max_concurrent_connections int
    Specifies the number of active connections that your connector can establish with the remote server at the same time.
    trusted_host_keys Sequence[str]
    List of public host keys, for the external server to which you are connecting.
    user_secret_id str
    ARN or name of the secret in AWS Secrets Manager which contains the SFTP user's private keys or passwords.
    maxConcurrentConnections Number
    Specifies the number of active connections that your connector can establish with the remote server at the same time.
    trustedHostKeys List<String>
    List of public host keys, for the external server to which you are connecting.
    userSecretId String
    ARN or name of the secret in AWS Secrets Manager which contains the SFTP user's private keys or passwords.

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.38.0 published on Wednesday, Nov 5, 2025 by Pulumi
    pulumi/pulumi-aws-native
      Meet Neo: Your AI Platform Teammate