Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. transfer
  5. getConnector
AWS v6.73.0 published on Wednesday, Mar 19, 2025 by Pulumi
pulumi/pulumi-aws

aws.transfer.getConnector

Explore with Pulumi AI

aws logo
AWS v6.73.0 published on Wednesday, Mar 19, 2025 by Pulumi
pulumi/pulumi-aws

    Data source for managing an AWS Transfer Family 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(id: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetConnectorResult
def get_connector_output(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:transfer/getConnector:getConnector
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Id string
    Unique identifier for connector
    Id string
    Unique identifier for connector
    id String
    Unique identifier for connector
    id string
    Unique identifier for connector
    id str
    Unique identifier for connector
    id String
    Unique identifier for connector

    getConnector Result

    The following output properties are available:

    AccessRole string
    ARN of the AWS Identity and Access Management role.
    Arn string
    ARN of the Connector.
    As2Configs List<GetConnectorAs2Config>
    Structure containing the parameters for an AS2 connector object. Contains the following attributes:
    Id string
    LoggingRole string
    ARN of the IAM role that allows a connector to turn on CLoudwatch logging for Amazon S3 events.
    SecurityPolicyName string
    Name of security policy.
    ServiceManagedEgressIpAddresses List<string>
    List of egress Ip addresses.
    SftpConfigs List<GetConnectorSftpConfig>
    Object containing the following attributes:
    Tags Dictionary<string, string>
    Object containing the following attributes:
    Url string
    URL of the partner's AS2 or SFTP endpoint.
    AccessRole string
    ARN of the AWS Identity and Access Management role.
    Arn string
    ARN of the Connector.
    As2Configs []GetConnectorAs2Config
    Structure containing the parameters for an AS2 connector object. Contains the following attributes:
    Id string
    LoggingRole string
    ARN of the IAM role that allows a connector to turn on CLoudwatch logging for Amazon S3 events.
    SecurityPolicyName string
    Name of security policy.
    ServiceManagedEgressIpAddresses []string
    List of egress Ip addresses.
    SftpConfigs []GetConnectorSftpConfig
    Object containing the following attributes:
    Tags map[string]string
    Object containing the following attributes:
    Url string
    URL of the partner's AS2 or SFTP endpoint.
    accessRole String
    ARN of the AWS Identity and Access Management role.
    arn String
    ARN of the Connector.
    as2Configs List<GetConnectorAs2Config>
    Structure containing the parameters for an AS2 connector object. Contains the following attributes:
    id String
    loggingRole String
    ARN of the IAM role that allows a connector to turn on CLoudwatch logging for Amazon S3 events.
    securityPolicyName String
    Name of security policy.
    serviceManagedEgressIpAddresses List<String>
    List of egress Ip addresses.
    sftpConfigs List<GetConnectorSftpConfig>
    Object containing the following attributes:
    tags Map<String,String>
    Object containing the following attributes:
    url String
    URL of the partner's AS2 or SFTP endpoint.
    accessRole string
    ARN of the AWS Identity and Access Management role.
    arn string
    ARN of the Connector.
    as2Configs GetConnectorAs2Config[]
    Structure containing the parameters for an AS2 connector object. Contains the following attributes:
    id string
    loggingRole string
    ARN of the IAM role that allows a connector to turn on CLoudwatch logging for Amazon S3 events.
    securityPolicyName string
    Name of security policy.
    serviceManagedEgressIpAddresses string[]
    List of egress Ip addresses.
    sftpConfigs GetConnectorSftpConfig[]
    Object containing the following attributes:
    tags {[key: string]: string}
    Object containing the following attributes:
    url string
    URL of the partner's AS2 or SFTP endpoint.
    access_role str
    ARN of the AWS Identity and Access Management role.
    arn str
    ARN of the Connector.
    as2_configs Sequence[GetConnectorAs2Config]
    Structure containing the parameters for an AS2 connector object. Contains the following attributes:
    id str
    logging_role str
    ARN of the IAM role that allows a connector to turn on CLoudwatch logging for Amazon S3 events.
    security_policy_name str
    Name of security policy.
    service_managed_egress_ip_addresses Sequence[str]
    List of egress Ip addresses.
    sftp_configs Sequence[GetConnectorSftpConfig]
    Object containing the following attributes:
    tags Mapping[str, str]
    Object containing the following attributes:
    url str
    URL of the partner's AS2 or SFTP endpoint.
    accessRole String
    ARN of the AWS Identity and Access Management role.
    arn String
    ARN of the Connector.
    as2Configs List<Property Map>
    Structure containing the parameters for an AS2 connector object. Contains the following attributes:
    id String
    loggingRole String
    ARN of the IAM role that allows a connector to turn on CLoudwatch logging for Amazon S3 events.
    securityPolicyName String
    Name of security policy.
    serviceManagedEgressIpAddresses List<String>
    List of egress Ip addresses.
    sftpConfigs List<Property Map>
    Object containing the following attributes:
    tags Map<String>
    Object containing the following attributes:
    url String
    URL of the partner's AS2 or SFTP endpoint.

    Supporting Types

    GetConnectorAs2Config

    BasicAuthSecretId string
    Basic authentication for AS2 connector API. Returns a null value if not set.
    Compression string
    Specifies whether AS2 file is compressed. Will be ZLIB or DISABLED
    EncryptionAlgorithm string
    Algorithm used to encrypt file. Will be AES128_CBC or AES192_CBC or AES256_CBC or DES_EDE3_CBC or NONE.
    LocalProfileId string
    Unique identifier for AS2 local profile.
    MdnResponse string
    Used for outbound requests to tell if response is asynchronous or not. Will be either SYNC or NONE.
    MdnSigningAlgorithm string
    Signing algorithm for MDN response. Will be SHA256 or SHA384 or SHA512 or SHA1 or NONE or DEFAULT.
    MessageSubject string
    Subject HTTP header attribute in outbound AS2 messages to the connector.
    PartnerProfileId string
    Unique identifier used by connector for partner profile.
    SingingAlgorithm string
    BasicAuthSecretId string
    Basic authentication for AS2 connector API. Returns a null value if not set.
    Compression string
    Specifies whether AS2 file is compressed. Will be ZLIB or DISABLED
    EncryptionAlgorithm string
    Algorithm used to encrypt file. Will be AES128_CBC or AES192_CBC or AES256_CBC or DES_EDE3_CBC or NONE.
    LocalProfileId string
    Unique identifier for AS2 local profile.
    MdnResponse string
    Used for outbound requests to tell if response is asynchronous or not. Will be either SYNC or NONE.
    MdnSigningAlgorithm string
    Signing algorithm for MDN response. Will be SHA256 or SHA384 or SHA512 or SHA1 or NONE or DEFAULT.
    MessageSubject string
    Subject HTTP header attribute in outbound AS2 messages to the connector.
    PartnerProfileId string
    Unique identifier used by connector for partner profile.
    SingingAlgorithm string
    basicAuthSecretId String
    Basic authentication for AS2 connector API. Returns a null value if not set.
    compression String
    Specifies whether AS2 file is compressed. Will be ZLIB or DISABLED
    encryptionAlgorithm String
    Algorithm used to encrypt file. Will be AES128_CBC or AES192_CBC or AES256_CBC or DES_EDE3_CBC or NONE.
    localProfileId String
    Unique identifier for AS2 local profile.
    mdnResponse String
    Used for outbound requests to tell if response is asynchronous or not. Will be either SYNC or NONE.
    mdnSigningAlgorithm String
    Signing algorithm for MDN response. Will be SHA256 or SHA384 or SHA512 or SHA1 or NONE or DEFAULT.
    messageSubject String
    Subject HTTP header attribute in outbound AS2 messages to the connector.
    partnerProfileId String
    Unique identifier used by connector for partner profile.
    singingAlgorithm String
    basicAuthSecretId string
    Basic authentication for AS2 connector API. Returns a null value if not set.
    compression string
    Specifies whether AS2 file is compressed. Will be ZLIB or DISABLED
    encryptionAlgorithm string
    Algorithm used to encrypt file. Will be AES128_CBC or AES192_CBC or AES256_CBC or DES_EDE3_CBC or NONE.
    localProfileId string
    Unique identifier for AS2 local profile.
    mdnResponse string
    Used for outbound requests to tell if response is asynchronous or not. Will be either SYNC or NONE.
    mdnSigningAlgorithm string
    Signing algorithm for MDN response. Will be SHA256 or SHA384 or SHA512 or SHA1 or NONE or DEFAULT.
    messageSubject string
    Subject HTTP header attribute in outbound AS2 messages to the connector.
    partnerProfileId string
    Unique identifier used by connector for partner profile.
    singingAlgorithm string
    basic_auth_secret_id str
    Basic authentication for AS2 connector API. Returns a null value if not set.
    compression str
    Specifies whether AS2 file is compressed. Will be ZLIB or DISABLED
    encryption_algorithm str
    Algorithm used to encrypt file. Will be AES128_CBC or AES192_CBC or AES256_CBC or DES_EDE3_CBC or NONE.
    local_profile_id str
    Unique identifier for AS2 local profile.
    mdn_response str
    Used for outbound requests to tell if response is asynchronous or not. Will be either SYNC or NONE.
    mdn_signing_algorithm str
    Signing algorithm for MDN response. Will be SHA256 or SHA384 or SHA512 or SHA1 or NONE or DEFAULT.
    message_subject str
    Subject HTTP header attribute in outbound AS2 messages to the connector.
    partner_profile_id str
    Unique identifier used by connector for partner profile.
    singing_algorithm str
    basicAuthSecretId String
    Basic authentication for AS2 connector API. Returns a null value if not set.
    compression String
    Specifies whether AS2 file is compressed. Will be ZLIB or DISABLED
    encryptionAlgorithm String
    Algorithm used to encrypt file. Will be AES128_CBC or AES192_CBC or AES256_CBC or DES_EDE3_CBC or NONE.
    localProfileId String
    Unique identifier for AS2 local profile.
    mdnResponse String
    Used for outbound requests to tell if response is asynchronous or not. Will be either SYNC or NONE.
    mdnSigningAlgorithm String
    Signing algorithm for MDN response. Will be SHA256 or SHA384 or SHA512 or SHA1 or NONE or DEFAULT.
    messageSubject String
    Subject HTTP header attribute in outbound AS2 messages to the connector.
    partnerProfileId String
    Unique identifier used by connector for partner profile.
    singingAlgorithm String

    GetConnectorSftpConfig

    TrustedHostKeys List<string>
    List of the public portions of the host keys that are used to identify the servers the connector is connected to.
    UserSecretId string
    Identifier for the secret in AWS Secrets Manager that contains the SFTP user's private key, and/or password.
    TrustedHostKeys []string
    List of the public portions of the host keys that are used to identify the servers the connector is connected to.
    UserSecretId string
    Identifier for the secret in AWS Secrets Manager that contains the SFTP user's private key, and/or password.
    trustedHostKeys List<String>
    List of the public portions of the host keys that are used to identify the servers the connector is connected to.
    userSecretId String
    Identifier for the secret in AWS Secrets Manager that contains the SFTP user's private key, and/or password.
    trustedHostKeys string[]
    List of the public portions of the host keys that are used to identify the servers the connector is connected to.
    userSecretId string
    Identifier for the secret in AWS Secrets Manager that contains the SFTP user's private key, and/or password.
    trusted_host_keys Sequence[str]
    List of the public portions of the host keys that are used to identify the servers the connector is connected to.
    user_secret_id str
    Identifier for the secret in AWS Secrets Manager that contains the SFTP user's private key, and/or password.
    trustedHostKeys List<String>
    List of the public portions of the host keys that are used to identify the servers the connector is connected to.
    userSecretId String
    Identifier for the secret in AWS Secrets Manager that contains the SFTP user's private key, and/or password.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    AWS v6.73.0 published on Wednesday, Mar 19, 2025 by Pulumi
    pulumi/pulumi-aws