Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  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.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.transfer.getConnector

Explore with Pulumi AI

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

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 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>
Copy
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]
Copy
func LookupConnector(ctx *Context, args *LookupConnectorArgs, opts ...InvokeOption) (*LookupConnectorResult, error)
func LookupConnectorOutput(ctx *Context, args *LookupConnectorOutputArgs, opts ...InvokeOption) LookupConnectorResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetConnectorResult> getConnector(GetConnectorArgs args, InvokeOptions options)
public static Output<GetConnectorResult> getConnector(GetConnectorArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: aws-native:transfer:getConnector
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ConnectorId This property is required. string
A unique identifier for the connector.
ConnectorId This property is required. string
A unique identifier for the connector.
connectorId This property is required. String
A unique identifier for the connector.
connectorId This property is required. string
A unique identifier for the connector.
connector_id This property is required. str
A unique identifier for the connector.
connectorId This property is required. 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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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

SftpConfigProperties

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.
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.
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.
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.
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.
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 This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag
key This property is required. string
The key name of the tag
value This property is required. string
The value of the tag
key This property is required. str
The key name of the tag
value This property is required. str
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag

Package Details

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

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

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native