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.108.4 published on Tuesday, Jun 18, 2024 by Pulumi

aws-native.transfer.Connector

Explore with Pulumi AI

aws-native logo

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

AWS Native v0.108.4 published on Tuesday, Jun 18, 2024 by Pulumi

    Resource Type definition for AWS::Transfer::Connector

    Create Connector Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Connector(name: string, args: ConnectorArgs, opts?: CustomResourceOptions);
    @overload
    def Connector(resource_name: str,
                  args: ConnectorArgs,
                  opts: Optional[ResourceOptions] = None)
    
    @overload
    def Connector(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  access_role: Optional[str] = None,
                  url: Optional[str] = None,
                  as2_config: Optional[As2ConfigPropertiesArgs] = None,
                  logging_role: Optional[str] = None,
                  security_policy_name: Optional[str] = None,
                  sftp_config: Optional[SftpConfigPropertiesArgs] = None,
                  tags: Optional[Sequence[_root_inputs.TagArgs]] = 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.
    
    

    Parameters

    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.

    Example

    The following reference example uses placeholder values for all input properties.

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    const exampleconnectorResourceResourceFromTransfer = new aws_native.transfer.Connector("exampleconnectorResourceResourceFromTransfer", {
        accessRole: "string",
        url: "string",
        as2Config: {
            basicAuthSecretId: "string",
            compression: aws_native.transfer.ConnectorAs2ConfigPropertiesCompression.Zlib,
            encryptionAlgorithm: aws_native.transfer.ConnectorAs2ConfigPropertiesEncryptionAlgorithm.Aes128Cbc,
            localProfileId: "string",
            mdnResponse: aws_native.transfer.ConnectorAs2ConfigPropertiesMdnResponse.Sync,
            mdnSigningAlgorithm: aws_native.transfer.ConnectorAs2ConfigPropertiesMdnSigningAlgorithm.Sha256,
            messageSubject: "string",
            partnerProfileId: "string",
            signingAlgorithm: aws_native.transfer.ConnectorAs2ConfigPropertiesSigningAlgorithm.Sha256,
        },
        loggingRole: "string",
        securityPolicyName: "string",
        sftpConfig: {
            trustedHostKeys: ["string"],
            userSecretId: "string",
        },
        tags: [{
            key: "string",
            value: "string",
        }],
    });
    
    Coming soon!
    

    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.
    SecurityPolicyName string
    Security policy for SFTP Connector
    SftpConfig Pulumi.AwsNative.Transfer.Inputs.SftpConfigProperties
    Configuration for an SFTP connector.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    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.
    SecurityPolicyName string
    Security policy for SFTP Connector
    SftpConfig SftpConfigPropertiesArgs
    Configuration for an SFTP connector.
    Tags TagArgs
    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.
    securityPolicyName String
    Security policy for SFTP 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.
    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.
    securityPolicyName string
    Security policy for SFTP 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.
    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.
    security_policy_name str
    Security policy for SFTP Connector
    sftp_config SftpConfigPropertiesArgs
    Configuration for an SFTP connector.
    tags Sequence[TagArgs]
    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.
    securityPolicyName String
    Security policy for SFTP 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.
    ServiceManagedEgressIpAddresses List<string>
    The list of egress IP addresses of this connector. These IP addresses are assigned automatically when you create the connector.
    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.
    ServiceManagedEgressIpAddresses []string
    The list of egress IP addresses of this connector. These IP addresses are assigned automatically when you create the connector.
    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.
    serviceManagedEgressIpAddresses List<String>
    The list of egress IP addresses of this connector. These IP addresses are assigned automatically when you create the connector.
    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.
    serviceManagedEgressIpAddresses string[]
    The list of egress IP addresses of this connector. These IP addresses are assigned automatically when you create the connector.
    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.
    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.
    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.
    serviceManagedEgressIpAddresses List<String>
    The list of egress IP addresses of this connector. These IP addresses are assigned automatically when you create the connector.

    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" | "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.
    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
    DesEde3Cbc
    DES_EDE3_CBC
    ConnectorAs2ConfigPropertiesEncryptionAlgorithmAes128Cbc
    AES128_CBC
    ConnectorAs2ConfigPropertiesEncryptionAlgorithmAes192Cbc
    AES192_CBC
    ConnectorAs2ConfigPropertiesEncryptionAlgorithmAes256Cbc
    AES256_CBC
    ConnectorAs2ConfigPropertiesEncryptionAlgorithmNone
    NONE
    ConnectorAs2ConfigPropertiesEncryptionAlgorithmDesEde3Cbc
    DES_EDE3_CBC
    Aes128Cbc
    AES128_CBC
    Aes192Cbc
    AES192_CBC
    Aes256Cbc
    AES256_CBC
    None
    NONE
    DesEde3Cbc
    DES_EDE3_CBC
    Aes128Cbc
    AES128_CBC
    Aes192Cbc
    AES192_CBC
    Aes256Cbc
    AES256_CBC
    None
    NONE
    DesEde3Cbc
    DES_EDE3_CBC
    AES128_CBC
    AES128_CBC
    AES192_CBC
    AES192_CBC
    AES256_CBC
    AES256_CBC
    NONE
    NONE
    DES_EDE3_CBC
    DES_EDE3_CBC
    "AES128_CBC"
    AES128_CBC
    "AES192_CBC"
    AES192_CBC
    "AES256_CBC"
    AES256_CBC
    "NONE"
    NONE
    "DES_EDE3_CBC"
    DES_EDE3_CBC

    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

    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.

    Tag, TagArgs

    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

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

    AWS Native v0.108.4 published on Tuesday, Jun 18, 2024 by Pulumi