Docs Packages
  1. Packages
  2. AWS Native
  3. API Docs
  4. transfer
  5. Connector

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.79.0 published on Monday, Oct 2, 2023 by Pulumi
pulumi/pulumi-aws-native

aws-native.transfer.Connector

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.79.0 published on Monday, Oct 2, 2023 by Pulumi
pulumi/pulumi-aws-native

    Resource Type definition for AWS::Transfer::Connector

    Create Connector Resource

    new Connector(name: string, args: ConnectorArgs, opts?: CustomResourceOptions);
    @overload
def Connector(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              access_role: Optional[str] = None,
              as2_config: Optional[As2ConfigPropertiesArgs] = None,
              logging_role: Optional[str] = None,
              sftp_config: Optional[SftpConfigPropertiesArgs] = None,
              tags: Optional[Sequence[ConnectorTagArgs]] = None,
              url: Optional[str] = None)
@overload
def Connector(resource_name: str,
              args: ConnectorArgs,
              opts: Optional[ResourceOptions] = None)
    func NewConnector(ctx *Context, name string, args ConnectorArgs, opts ...ResourceOption) (*Connector, error)
    public Connector(string name, ConnectorArgs args, CustomResourceOptions? opts = null)
    public Connector(String name, ConnectorArgs args)
public Connector(String name, ConnectorArgs args, CustomResourceOptions options)

    type: aws-native:transfer:Connector
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ConnectorArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ConnectorArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ConnectorArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ConnectorArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ConnectorArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Connector Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Connector resource accepts the following input properties:

    AccessRole string

    Specifies the access role for the connector.

    Url string

    URL for Connector

    As2Config Pulumi.AwsNative.Transfer.Inputs.As2ConfigProperties

    Configuration for an AS2 connector.

    LoggingRole string

    Specifies the logging role for the connector.

    SftpConfig Pulumi.AwsNative.Transfer.Inputs.SftpConfigProperties

    Configuration for an SFTP connector.

    Tags List<Pulumi.AwsNative.Transfer.Inputs.ConnectorTag>

    Key-value pairs that can be used to group and search for connectors. Tags are metadata attached to connectors for any purpose.

    AccessRole string

    Specifies the access role for the connector.

    Url string

    URL for Connector

    As2Config As2ConfigPropertiesArgs

    Configuration for an AS2 connector.

    LoggingRole string

    Specifies the logging role for the connector.

    SftpConfig SftpConfigPropertiesArgs

    Configuration for an SFTP connector.

    Tags []ConnectorTagArgs

    Key-value pairs that can be used to group and search for connectors. Tags are metadata attached to connectors for any purpose.

    accessRole String

    Specifies the access role for the connector.

    url String

    URL for Connector

    as2Config As2ConfigProperties

    Configuration for an AS2 connector.

    loggingRole String

    Specifies the logging role for the connector.

    sftpConfig SftpConfigProperties

    Configuration for an SFTP connector.

    tags List<ConnectorTag>

    Key-value pairs that can be used to group and search for connectors. Tags are metadata attached to connectors for any purpose.

    accessRole string

    Specifies the access role for the connector.

    url string

    URL for Connector

    as2Config As2ConfigProperties

    Configuration for an AS2 connector.

    loggingRole string

    Specifies the logging role for the connector.

    sftpConfig SftpConfigProperties

    Configuration for an SFTP connector.

    tags ConnectorTag[]

    Key-value pairs that can be used to group and search for connectors. Tags are metadata attached to connectors for any purpose.

    access_role str

    Specifies the access role for the connector.

    url str

    URL for Connector

    as2_config As2ConfigPropertiesArgs

    Configuration for an AS2 connector.

    logging_role str

    Specifies the logging role for the connector.

    sftp_config SftpConfigPropertiesArgs

    Configuration for an SFTP connector.

    tags Sequence[ConnectorTagArgs]

    Key-value pairs that can be used to group and search for connectors. Tags are metadata attached to connectors for any purpose.

    accessRole String

    Specifies the access role for the connector.

    url String

    URL for Connector

    as2Config Property Map

    Configuration for an AS2 connector.

    loggingRole String

    Specifies the logging role for 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.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Connector resource produces the following output properties:

    Arn string

    Specifies the unique Amazon Resource Name (ARN) for the connector.

    ConnectorId string

    A unique identifier for the connector.

    Id string

    The provider-assigned unique ID for this managed resource.

    Arn string

    Specifies the unique Amazon Resource Name (ARN) for the connector.

    ConnectorId string

    A unique identifier for the connector.

    Id string

    The provider-assigned unique ID for this managed resource.

    arn String

    Specifies the unique Amazon Resource Name (ARN) for the connector.

    connectorId String

    A unique identifier for the connector.

    id String

    The provider-assigned unique ID for this managed resource.

    arn string

    Specifies the unique Amazon Resource Name (ARN) for the connector.

    connectorId string

    A unique identifier for the connector.

    id string

    The provider-assigned unique ID for this managed resource.

    arn str

    Specifies the unique Amazon Resource Name (ARN) for the connector.

    connector_id str

    A unique identifier for the connector.

    id str

    The provider-assigned unique ID for this managed resource.

    arn String

    Specifies the unique Amazon Resource Name (ARN) for the connector.

    connectorId String

    A unique identifier for the connector.

    id String

    The provider-assigned unique ID for this managed resource.

    Supporting Types

    As2ConfigProperties, As2ConfigPropertiesArgs

    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.

    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.

    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.

    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.

    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.

    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"

    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.

    signingAlgorithm "SHA256" | "SHA384" | "SHA512" | "SHA1" | "NONE"

    Signing algorithm for this AS2 connector configuration.

    ConnectorAs2ConfigPropertiesCompression, ConnectorAs2ConfigPropertiesCompressionArgs

    Zlib
    ZLIB
    Disabled
    DISABLED
    ConnectorAs2ConfigPropertiesCompressionZlib
    ZLIB
    ConnectorAs2ConfigPropertiesCompressionDisabled
    DISABLED
    Zlib
    ZLIB
    Disabled
    DISABLED
    Zlib
    ZLIB
    Disabled
    DISABLED
    ZLIB
    ZLIB
    DISABLED
    DISABLED
    "ZLIB"
    ZLIB
    "DISABLED"
    DISABLED

    ConnectorAs2ConfigPropertiesEncryptionAlgorithm, ConnectorAs2ConfigPropertiesEncryptionAlgorithmArgs

    Aes128Cbc
    AES128_CBC
    Aes192Cbc
    AES192_CBC
    Aes256Cbc
    AES256_CBC
    None
    NONE
    ConnectorAs2ConfigPropertiesEncryptionAlgorithmAes128Cbc
    AES128_CBC
    ConnectorAs2ConfigPropertiesEncryptionAlgorithmAes192Cbc
    AES192_CBC
    ConnectorAs2ConfigPropertiesEncryptionAlgorithmAes256Cbc
    AES256_CBC
    ConnectorAs2ConfigPropertiesEncryptionAlgorithmNone
    NONE
    Aes128Cbc
    AES128_CBC
    Aes192Cbc
    AES192_CBC
    Aes256Cbc
    AES256_CBC
    None
    NONE
    Aes128Cbc
    AES128_CBC
    Aes192Cbc
    AES192_CBC
    Aes256Cbc
    AES256_CBC
    None
    NONE
    AES128_CBC
    AES128_CBC
    AES192_CBC
    AES192_CBC
    AES256_CBC
    AES256_CBC
    NONE
    NONE
    "AES128_CBC"
    AES128_CBC
    "AES192_CBC"
    AES192_CBC
    "AES256_CBC"
    AES256_CBC
    "NONE"
    NONE

    ConnectorAs2ConfigPropertiesMdnResponse, ConnectorAs2ConfigPropertiesMdnResponseArgs

    Sync
    SYNC
    None
    NONE
    ConnectorAs2ConfigPropertiesMdnResponseSync
    SYNC
    ConnectorAs2ConfigPropertiesMdnResponseNone
    NONE
    Sync
    SYNC
    None
    NONE
    Sync
    SYNC
    None
    NONE
    SYNC
    SYNC
    NONE
    NONE
    "SYNC"
    SYNC
    "NONE"
    NONE

    ConnectorAs2ConfigPropertiesMdnSigningAlgorithm, ConnectorAs2ConfigPropertiesMdnSigningAlgorithmArgs

    Sha256
    SHA256
    Sha384
    SHA384
    Sha512
    SHA512
    Sha1
    SHA1
    None
    NONE
    Default
    DEFAULT
    ConnectorAs2ConfigPropertiesMdnSigningAlgorithmSha256
    SHA256
    ConnectorAs2ConfigPropertiesMdnSigningAlgorithmSha384
    SHA384
    ConnectorAs2ConfigPropertiesMdnSigningAlgorithmSha512
    SHA512
    ConnectorAs2ConfigPropertiesMdnSigningAlgorithmSha1
    SHA1
    ConnectorAs2ConfigPropertiesMdnSigningAlgorithmNone
    NONE
    ConnectorAs2ConfigPropertiesMdnSigningAlgorithmDefault
    DEFAULT
    Sha256
    SHA256
    Sha384
    SHA384
    Sha512
    SHA512
    Sha1
    SHA1
    None
    NONE
    Default
    DEFAULT
    Sha256
    SHA256
    Sha384
    SHA384
    Sha512
    SHA512
    Sha1
    SHA1
    None
    NONE
    Default
    DEFAULT
    SHA256
    SHA256
    SHA384
    SHA384
    SHA512
    SHA512
    SHA1
    SHA1
    NONE
    NONE
    DEFAULT
    DEFAULT
    "SHA256"
    SHA256
    "SHA384"
    SHA384
    "SHA512"
    SHA512
    "SHA1"
    SHA1
    "NONE"
    NONE
    "DEFAULT"
    DEFAULT

    ConnectorAs2ConfigPropertiesSigningAlgorithm, ConnectorAs2ConfigPropertiesSigningAlgorithmArgs

    Sha256
    SHA256
    Sha384
    SHA384
    Sha512
    SHA512
    Sha1
    SHA1
    None
    NONE
    ConnectorAs2ConfigPropertiesSigningAlgorithmSha256
    SHA256
    ConnectorAs2ConfigPropertiesSigningAlgorithmSha384
    SHA384
    ConnectorAs2ConfigPropertiesSigningAlgorithmSha512
    SHA512
    ConnectorAs2ConfigPropertiesSigningAlgorithmSha1
    SHA1
    ConnectorAs2ConfigPropertiesSigningAlgorithmNone
    NONE
    Sha256
    SHA256
    Sha384
    SHA384
    Sha512
    SHA512
    Sha1
    SHA1
    None
    NONE
    Sha256
    SHA256
    Sha384
    SHA384
    Sha512
    SHA512
    Sha1
    SHA1
    None
    NONE
    SHA256
    SHA256
    SHA384
    SHA384
    SHA512
    SHA512
    SHA1
    SHA1
    NONE
    NONE
    "SHA256"
    SHA256
    "SHA384"
    SHA384
    "SHA512"
    SHA512
    "SHA1"
    SHA1
    "NONE"
    NONE

    ConnectorTag, ConnectorTagArgs

    Key string

    The name assigned to the tag that you create.

    Value string

    Contains one or more values that you assigned to the key name you create.

    Key string

    The name assigned to the tag that you create.

    Value string

    Contains one or more values that you assigned to the key name you create.

    key String

    The name assigned to the tag that you create.

    value String

    Contains one or more values that you assigned to the key name you create.

    key string

    The name assigned to the tag that you create.

    value string

    Contains one or more values that you assigned to the key name you create.

    key str

    The name assigned to the tag that you create.

    value str

    Contains one or more values that you assigned to the key name you create.

    key String

    The name assigned to the tag that you create.

    value String

    Contains one or more values that you assigned to the key name you create.

    SftpConfigProperties, SftpConfigPropertiesArgs

    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.

    Package Details

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

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.79.0 published on Monday, Oct 2, 2023 by Pulumi
    pulumi/pulumi-aws-native