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

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.32.0 published on Friday, Apr 19, 2024 by Pulumi

aws.transfer.Connector

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.32.0 published on Friday, Apr 19, 2024 by Pulumi

    Provides a AWS Transfer AS2 Connector resource.

    Example Usage

    Basic

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const example = new aws.transfer.Connector("example", {
        accessRole: test.arn,
        as2Config: {
            compression: "DISABLED",
            encryptionAlgorithm: "AWS128_CBC",
            messageSubject: "For Connector",
            localProfileId: local.profileId,
            mdnResponse: "NONE",
            mdnSigningAlgorithm: "NONE",
            partnerProfileId: partner.profileId,
            signingAlgorithm: "NONE",
        },
        url: "http://www.test.com",
    });
    
    import pulumi
    import pulumi_aws as aws
    
    example = aws.transfer.Connector("example",
        access_role=test["arn"],
        as2_config=aws.transfer.ConnectorAs2ConfigArgs(
            compression="DISABLED",
            encryption_algorithm="AWS128_CBC",
            message_subject="For Connector",
            local_profile_id=local["profileId"],
            mdn_response="NONE",
            mdn_signing_algorithm="NONE",
            partner_profile_id=partner["profileId"],
            signing_algorithm="NONE",
        ),
        url="http://www.test.com")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/transfer"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := transfer.NewConnector(ctx, "example", &transfer.ConnectorArgs{
    			AccessRole: pulumi.Any(test.Arn),
    			As2Config: &transfer.ConnectorAs2ConfigArgs{
    				Compression:         pulumi.String("DISABLED"),
    				EncryptionAlgorithm: pulumi.String("AWS128_CBC"),
    				MessageSubject:      pulumi.String("For Connector"),
    				LocalProfileId:      pulumi.Any(local.ProfileId),
    				MdnResponse:         pulumi.String("NONE"),
    				MdnSigningAlgorithm: pulumi.String("NONE"),
    				PartnerProfileId:    pulumi.Any(partner.ProfileId),
    				SigningAlgorithm:    pulumi.String("NONE"),
    			},
    			Url: pulumi.String("http://www.test.com"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aws = Pulumi.Aws;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Aws.Transfer.Connector("example", new()
        {
            AccessRole = test.Arn,
            As2Config = new Aws.Transfer.Inputs.ConnectorAs2ConfigArgs
            {
                Compression = "DISABLED",
                EncryptionAlgorithm = "AWS128_CBC",
                MessageSubject = "For Connector",
                LocalProfileId = local.ProfileId,
                MdnResponse = "NONE",
                MdnSigningAlgorithm = "NONE",
                PartnerProfileId = partner.ProfileId,
                SigningAlgorithm = "NONE",
            },
            Url = "http://www.test.com",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.transfer.Connector;
    import com.pulumi.aws.transfer.ConnectorArgs;
    import com.pulumi.aws.transfer.inputs.ConnectorAs2ConfigArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var example = new Connector("example", ConnectorArgs.builder()        
                .accessRole(test.arn())
                .as2Config(ConnectorAs2ConfigArgs.builder()
                    .compression("DISABLED")
                    .encryptionAlgorithm("AWS128_CBC")
                    .messageSubject("For Connector")
                    .localProfileId(local.profileId())
                    .mdnResponse("NONE")
                    .mdnSigningAlgorithm("NONE")
                    .partnerProfileId(partner.profileId())
                    .signingAlgorithm("NONE")
                    .build())
                .url("http://www.test.com")
                .build());
    
        }
    }
    
    resources:
      example:
        type: aws:transfer:Connector
        properties:
          accessRole: ${test.arn}
          as2Config:
            compression: DISABLED
            encryptionAlgorithm: AWS128_CBC
            messageSubject: For Connector
            localProfileId: ${local.profileId}
            mdnResponse: NONE
            mdnSigningAlgorithm: NONE
            partnerProfileId: ${partner.profileId}
            signingAlgorithm: NONE
          url: http://www.test.com
    

    SFTP Connector

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const example = new aws.transfer.Connector("example", {
        accessRole: test.arn,
        sftpConfig: {
            trustedHostKeys: ["ssh-rsa AAAAB3NYourKeysHere"],
            userSecretId: exampleAwsSecretsmanagerSecret.id,
        },
        url: "sftp://test.com",
    });
    
    import pulumi
    import pulumi_aws as aws
    
    example = aws.transfer.Connector("example",
        access_role=test["arn"],
        sftp_config=aws.transfer.ConnectorSftpConfigArgs(
            trusted_host_keys=["ssh-rsa AAAAB3NYourKeysHere"],
            user_secret_id=example_aws_secretsmanager_secret["id"],
        ),
        url="sftp://test.com")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/transfer"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := transfer.NewConnector(ctx, "example", &transfer.ConnectorArgs{
    			AccessRole: pulumi.Any(test.Arn),
    			SftpConfig: &transfer.ConnectorSftpConfigArgs{
    				TrustedHostKeys: pulumi.StringArray{
    					pulumi.String("ssh-rsa AAAAB3NYourKeysHere"),
    				},
    				UserSecretId: pulumi.Any(exampleAwsSecretsmanagerSecret.Id),
    			},
    			Url: pulumi.String("sftp://test.com"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aws = Pulumi.Aws;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Aws.Transfer.Connector("example", new()
        {
            AccessRole = test.Arn,
            SftpConfig = new Aws.Transfer.Inputs.ConnectorSftpConfigArgs
            {
                TrustedHostKeys = new[]
                {
                    "ssh-rsa AAAAB3NYourKeysHere",
                },
                UserSecretId = exampleAwsSecretsmanagerSecret.Id,
            },
            Url = "sftp://test.com",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.transfer.Connector;
    import com.pulumi.aws.transfer.ConnectorArgs;
    import com.pulumi.aws.transfer.inputs.ConnectorSftpConfigArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var example = new Connector("example", ConnectorArgs.builder()        
                .accessRole(test.arn())
                .sftpConfig(ConnectorSftpConfigArgs.builder()
                    .trustedHostKeys("ssh-rsa AAAAB3NYourKeysHere")
                    .userSecretId(exampleAwsSecretsmanagerSecret.id())
                    .build())
                .url("sftp://test.com")
                .build());
    
        }
    }
    
    resources:
      example:
        type: aws:transfer:Connector
        properties:
          accessRole: ${test.arn}
          sftpConfig:
            trustedHostKeys:
              - ssh-rsa AAAAB3NYourKeysHere
            userSecretId: ${exampleAwsSecretsmanagerSecret.id}
          url: sftp://test.com
    

    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[ConnectorAs2ConfigArgs] = None,
                  logging_role: Optional[str] = None,
                  security_policy_name: Optional[str] = None,
                  sftp_config: Optional[ConnectorSftpConfigArgs] = None,
                  tags: Optional[Mapping[str, str]] = 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: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.

    var awsConnectorResource = new Aws.Transfer.Connector("awsConnectorResource", new()
    {
        AccessRole = "string",
        Url = "string",
        As2Config = new Aws.Transfer.Inputs.ConnectorAs2ConfigArgs
        {
            Compression = "string",
            EncryptionAlgorithm = "string",
            LocalProfileId = "string",
            MdnResponse = "string",
            PartnerProfileId = "string",
            SigningAlgorithm = "string",
            MdnSigningAlgorithm = "string",
            MessageSubject = "string",
        },
        LoggingRole = "string",
        SecurityPolicyName = "string",
        SftpConfig = new Aws.Transfer.Inputs.ConnectorSftpConfigArgs
        {
            TrustedHostKeys = new[]
            {
                "string",
            },
            UserSecretId = "string",
        },
        Tags = 
        {
            { "string", "string" },
        },
    });
    
    example, err := transfer.NewConnector(ctx, "awsConnectorResource", &transfer.ConnectorArgs{
    	AccessRole: pulumi.String("string"),
    	Url:        pulumi.String("string"),
    	As2Config: &transfer.ConnectorAs2ConfigArgs{
    		Compression:         pulumi.String("string"),
    		EncryptionAlgorithm: pulumi.String("string"),
    		LocalProfileId:      pulumi.String("string"),
    		MdnResponse:         pulumi.String("string"),
    		PartnerProfileId:    pulumi.String("string"),
    		SigningAlgorithm:    pulumi.String("string"),
    		MdnSigningAlgorithm: pulumi.String("string"),
    		MessageSubject:      pulumi.String("string"),
    	},
    	LoggingRole:        pulumi.String("string"),
    	SecurityPolicyName: pulumi.String("string"),
    	SftpConfig: &transfer.ConnectorSftpConfigArgs{
    		TrustedHostKeys: pulumi.StringArray{
    			pulumi.String("string"),
    		},
    		UserSecretId: pulumi.String("string"),
    	},
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    })
    
    var awsConnectorResource = new Connector("awsConnectorResource", ConnectorArgs.builder()        
        .accessRole("string")
        .url("string")
        .as2Config(ConnectorAs2ConfigArgs.builder()
            .compression("string")
            .encryptionAlgorithm("string")
            .localProfileId("string")
            .mdnResponse("string")
            .partnerProfileId("string")
            .signingAlgorithm("string")
            .mdnSigningAlgorithm("string")
            .messageSubject("string")
            .build())
        .loggingRole("string")
        .securityPolicyName("string")
        .sftpConfig(ConnectorSftpConfigArgs.builder()
            .trustedHostKeys("string")
            .userSecretId("string")
            .build())
        .tags(Map.of("string", "string"))
        .build());
    
    aws_connector_resource = aws.transfer.Connector("awsConnectorResource",
        access_role="string",
        url="string",
        as2_config=aws.transfer.ConnectorAs2ConfigArgs(
            compression="string",
            encryption_algorithm="string",
            local_profile_id="string",
            mdn_response="string",
            partner_profile_id="string",
            signing_algorithm="string",
            mdn_signing_algorithm="string",
            message_subject="string",
        ),
        logging_role="string",
        security_policy_name="string",
        sftp_config=aws.transfer.ConnectorSftpConfigArgs(
            trusted_host_keys=["string"],
            user_secret_id="string",
        ),
        tags={
            "string": "string",
        })
    
    const awsConnectorResource = new aws.transfer.Connector("awsConnectorResource", {
        accessRole: "string",
        url: "string",
        as2Config: {
            compression: "string",
            encryptionAlgorithm: "string",
            localProfileId: "string",
            mdnResponse: "string",
            partnerProfileId: "string",
            signingAlgorithm: "string",
            mdnSigningAlgorithm: "string",
            messageSubject: "string",
        },
        loggingRole: "string",
        securityPolicyName: "string",
        sftpConfig: {
            trustedHostKeys: ["string"],
            userSecretId: "string",
        },
        tags: {
            string: "string",
        },
    });
    
    type: aws:transfer:Connector
    properties:
        accessRole: string
        as2Config:
            compression: string
            encryptionAlgorithm: string
            localProfileId: string
            mdnResponse: string
            mdnSigningAlgorithm: string
            messageSubject: string
            partnerProfileId: string
            signingAlgorithm: string
        loggingRole: string
        securityPolicyName: string
        sftpConfig:
            trustedHostKeys:
                - string
            userSecretId: string
        tags:
            string: string
        url: string
    

    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
    The IAM Role which provides read and write access to the parent directory of the file location mentioned in the StartFileTransfer request.
    Url string
    The URL of the partners AS2 endpoint or SFTP endpoint.
    As2Config ConnectorAs2Config
    Either SFTP or AS2 is configured.The parameters to configure for the connector object. Fields documented below.
    LoggingRole string
    The IAM Role which is required for allowing the connector to turn on CloudWatch logging for Amazon S3 events.
    SecurityPolicyName string
    Name of the security policy for the connector.
    SftpConfig ConnectorSftpConfig
    Either SFTP or AS2 is configured.The parameters to configure for the connector object. Fields documented below.
    Tags Dictionary<string, string>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    AccessRole string
    The IAM Role which provides read and write access to the parent directory of the file location mentioned in the StartFileTransfer request.
    Url string
    The URL of the partners AS2 endpoint or SFTP endpoint.
    As2Config ConnectorAs2ConfigArgs
    Either SFTP or AS2 is configured.The parameters to configure for the connector object. Fields documented below.
    LoggingRole string
    The IAM Role which is required for allowing the connector to turn on CloudWatch logging for Amazon S3 events.
    SecurityPolicyName string
    Name of the security policy for the connector.
    SftpConfig ConnectorSftpConfigArgs
    Either SFTP or AS2 is configured.The parameters to configure for the connector object. Fields documented below.
    Tags map[string]string
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    accessRole String
    The IAM Role which provides read and write access to the parent directory of the file location mentioned in the StartFileTransfer request.
    url String
    The URL of the partners AS2 endpoint or SFTP endpoint.
    as2Config ConnectorAs2Config
    Either SFTP or AS2 is configured.The parameters to configure for the connector object. Fields documented below.
    loggingRole String
    The IAM Role which is required for allowing the connector to turn on CloudWatch logging for Amazon S3 events.
    securityPolicyName String
    Name of the security policy for the connector.
    sftpConfig ConnectorSftpConfig
    Either SFTP or AS2 is configured.The parameters to configure for the connector object. Fields documented below.
    tags Map<String,String>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    accessRole string
    The IAM Role which provides read and write access to the parent directory of the file location mentioned in the StartFileTransfer request.
    url string
    The URL of the partners AS2 endpoint or SFTP endpoint.
    as2Config ConnectorAs2Config
    Either SFTP or AS2 is configured.The parameters to configure for the connector object. Fields documented below.
    loggingRole string
    The IAM Role which is required for allowing the connector to turn on CloudWatch logging for Amazon S3 events.
    securityPolicyName string
    Name of the security policy for the connector.
    sftpConfig ConnectorSftpConfig
    Either SFTP or AS2 is configured.The parameters to configure for the connector object. Fields documented below.
    tags {[key: string]: string}
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    access_role str
    The IAM Role which provides read and write access to the parent directory of the file location mentioned in the StartFileTransfer request.
    url str
    The URL of the partners AS2 endpoint or SFTP endpoint.
    as2_config ConnectorAs2ConfigArgs
    Either SFTP or AS2 is configured.The parameters to configure for the connector object. Fields documented below.
    logging_role str
    The IAM Role which is required for allowing the connector to turn on CloudWatch logging for Amazon S3 events.
    security_policy_name str
    Name of the security policy for the connector.
    sftp_config ConnectorSftpConfigArgs
    Either SFTP or AS2 is configured.The parameters to configure for the connector object. Fields documented below.
    tags Mapping[str, str]
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    accessRole String
    The IAM Role which provides read and write access to the parent directory of the file location mentioned in the StartFileTransfer request.
    url String
    The URL of the partners AS2 endpoint or SFTP endpoint.
    as2Config Property Map
    Either SFTP or AS2 is configured.The parameters to configure for the connector object. Fields documented below.
    loggingRole String
    The IAM Role which is required for allowing the connector to turn on CloudWatch logging for Amazon S3 events.
    securityPolicyName String
    Name of the security policy for the connector.
    sftpConfig Property Map
    Either SFTP or AS2 is configured.The parameters to configure for the connector object. Fields documented below.
    tags Map<String>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    Outputs

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

    Arn string
    The ARN of the connector.
    ConnectorId string
    The unique identifier for the AS2 profile or SFTP Profile.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll Dictionary<string, string>

    Deprecated: Please use tags instead.

    Arn string
    The ARN of the connector.
    ConnectorId string
    The unique identifier for the AS2 profile or SFTP Profile.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll map[string]string

    Deprecated: Please use tags instead.

    arn String
    The ARN of the connector.
    connectorId String
    The unique identifier for the AS2 profile or SFTP Profile.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String,String>

    Deprecated: Please use tags instead.

    arn string
    The ARN of the connector.
    connectorId string
    The unique identifier for the AS2 profile or SFTP Profile.
    id string
    The provider-assigned unique ID for this managed resource.
    tagsAll {[key: string]: string}

    Deprecated: Please use tags instead.

    arn str
    The ARN of the connector.
    connector_id str
    The unique identifier for the AS2 profile or SFTP Profile.
    id str
    The provider-assigned unique ID for this managed resource.
    tags_all Mapping[str, str]

    Deprecated: Please use tags instead.

    arn String
    The ARN of the connector.
    connectorId String
    The unique identifier for the AS2 profile or SFTP Profile.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String>

    Deprecated: Please use tags instead.

    Look up Existing Connector Resource

    Get an existing Connector resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ConnectorState, opts?: CustomResourceOptions): Connector
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            access_role: Optional[str] = None,
            arn: Optional[str] = None,
            as2_config: Optional[ConnectorAs2ConfigArgs] = None,
            connector_id: Optional[str] = None,
            logging_role: Optional[str] = None,
            security_policy_name: Optional[str] = None,
            sftp_config: Optional[ConnectorSftpConfigArgs] = None,
            tags: Optional[Mapping[str, str]] = None,
            tags_all: Optional[Mapping[str, str]] = None,
            url: Optional[str] = None) -> Connector
    func GetConnector(ctx *Context, name string, id IDInput, state *ConnectorState, opts ...ResourceOption) (*Connector, error)
    public static Connector Get(string name, Input<string> id, ConnectorState? state, CustomResourceOptions? opts = null)
    public static Connector get(String name, Output<String> id, ConnectorState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AccessRole string
    The IAM Role which provides read and write access to the parent directory of the file location mentioned in the StartFileTransfer request.
    Arn string
    The ARN of the connector.
    As2Config ConnectorAs2Config
    Either SFTP or AS2 is configured.The parameters to configure for the connector object. Fields documented below.
    ConnectorId string
    The unique identifier for the AS2 profile or SFTP Profile.
    LoggingRole string
    The IAM Role which is required for allowing the connector to turn on CloudWatch logging for Amazon S3 events.
    SecurityPolicyName string
    Name of the security policy for the connector.
    SftpConfig ConnectorSftpConfig
    Either SFTP or AS2 is configured.The parameters to configure for the connector object. Fields documented below.
    Tags Dictionary<string, string>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>

    Deprecated: Please use tags instead.

    Url string
    The URL of the partners AS2 endpoint or SFTP endpoint.
    AccessRole string
    The IAM Role which provides read and write access to the parent directory of the file location mentioned in the StartFileTransfer request.
    Arn string
    The ARN of the connector.
    As2Config ConnectorAs2ConfigArgs
    Either SFTP or AS2 is configured.The parameters to configure for the connector object. Fields documented below.
    ConnectorId string
    The unique identifier for the AS2 profile or SFTP Profile.
    LoggingRole string
    The IAM Role which is required for allowing the connector to turn on CloudWatch logging for Amazon S3 events.
    SecurityPolicyName string
    Name of the security policy for the connector.
    SftpConfig ConnectorSftpConfigArgs
    Either SFTP or AS2 is configured.The parameters to configure for the connector object. Fields documented below.
    Tags map[string]string
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string

    Deprecated: Please use tags instead.

    Url string
    The URL of the partners AS2 endpoint or SFTP endpoint.
    accessRole String
    The IAM Role which provides read and write access to the parent directory of the file location mentioned in the StartFileTransfer request.
    arn String
    The ARN of the connector.
    as2Config ConnectorAs2Config
    Either SFTP or AS2 is configured.The parameters to configure for the connector object. Fields documented below.
    connectorId String
    The unique identifier for the AS2 profile or SFTP Profile.
    loggingRole String
    The IAM Role which is required for allowing the connector to turn on CloudWatch logging for Amazon S3 events.
    securityPolicyName String
    Name of the security policy for the connector.
    sftpConfig ConnectorSftpConfig
    Either SFTP or AS2 is configured.The parameters to configure for the connector object. Fields documented below.
    tags Map<String,String>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>

    Deprecated: Please use tags instead.

    url String
    The URL of the partners AS2 endpoint or SFTP endpoint.
    accessRole string
    The IAM Role which provides read and write access to the parent directory of the file location mentioned in the StartFileTransfer request.
    arn string
    The ARN of the connector.
    as2Config ConnectorAs2Config
    Either SFTP or AS2 is configured.The parameters to configure for the connector object. Fields documented below.
    connectorId string
    The unique identifier for the AS2 profile or SFTP Profile.
    loggingRole string
    The IAM Role which is required for allowing the connector to turn on CloudWatch logging for Amazon S3 events.
    securityPolicyName string
    Name of the security policy for the connector.
    sftpConfig ConnectorSftpConfig
    Either SFTP or AS2 is configured.The parameters to configure for the connector object. Fields documented below.
    tags {[key: string]: string}
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}

    Deprecated: Please use tags instead.

    url string
    The URL of the partners AS2 endpoint or SFTP endpoint.
    access_role str
    The IAM Role which provides read and write access to the parent directory of the file location mentioned in the StartFileTransfer request.
    arn str
    The ARN of the connector.
    as2_config ConnectorAs2ConfigArgs
    Either SFTP or AS2 is configured.The parameters to configure for the connector object. Fields documented below.
    connector_id str
    The unique identifier for the AS2 profile or SFTP Profile.
    logging_role str
    The IAM Role which is required for allowing the connector to turn on CloudWatch logging for Amazon S3 events.
    security_policy_name str
    Name of the security policy for the connector.
    sftp_config ConnectorSftpConfigArgs
    Either SFTP or AS2 is configured.The parameters to configure for the connector object. Fields documented below.
    tags Mapping[str, str]
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]

    Deprecated: Please use tags instead.

    url str
    The URL of the partners AS2 endpoint or SFTP endpoint.
    accessRole String
    The IAM Role which provides read and write access to the parent directory of the file location mentioned in the StartFileTransfer request.
    arn String
    The ARN of the connector.
    as2Config Property Map
    Either SFTP or AS2 is configured.The parameters to configure for the connector object. Fields documented below.
    connectorId String
    The unique identifier for the AS2 profile or SFTP Profile.
    loggingRole String
    The IAM Role which is required for allowing the connector to turn on CloudWatch logging for Amazon S3 events.
    securityPolicyName String
    Name of the security policy for the connector.
    sftpConfig Property Map
    Either SFTP or AS2 is configured.The parameters to configure for the connector object. Fields documented below.
    tags Map<String>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>

    Deprecated: Please use tags instead.

    url String
    The URL of the partners AS2 endpoint or SFTP endpoint.

    Supporting Types

    ConnectorAs2Config, ConnectorAs2ConfigArgs

    Compression string
    Specifies weather AS2 file is compressed. The valud values are ZLIB and DISABLED.
    EncryptionAlgorithm string
    The algorithm that is used to encrypt the file. The valid values are AES128_CBC | AES192_CBC | AES256_CBC | NONE.
    LocalProfileId string
    The unique identifier for the AS2 local profile.
    MdnResponse string
    Used for outbound requests to determine if a partner response for transfers is synchronous or asynchronous. The valid values are SYNC and NONE.
    PartnerProfileId string
    The unique identifier for the AS2 partner profile.
    SigningAlgorithm string
    The algorithm that is used to sign AS2 messages sent with the connector. The valid values are SHA256 | SHA384 | SHA512 | SHA1 | NONE .
    MdnSigningAlgorithm string
    The signing algorithm for the Mdn response. The valid values are SHA256 | SHA384 | SHA512 | SHA1 | NONE | DEFAULT.
    MessageSubject string
    Used as the subject HTTP header attribute in AS2 messages that are being sent with the connector.
    Compression string
    Specifies weather AS2 file is compressed. The valud values are ZLIB and DISABLED.
    EncryptionAlgorithm string
    The algorithm that is used to encrypt the file. The valid values are AES128_CBC | AES192_CBC | AES256_CBC | NONE.
    LocalProfileId string
    The unique identifier for the AS2 local profile.
    MdnResponse string
    Used for outbound requests to determine if a partner response for transfers is synchronous or asynchronous. The valid values are SYNC and NONE.
    PartnerProfileId string
    The unique identifier for the AS2 partner profile.
    SigningAlgorithm string
    The algorithm that is used to sign AS2 messages sent with the connector. The valid values are SHA256 | SHA384 | SHA512 | SHA1 | NONE .
    MdnSigningAlgorithm string
    The signing algorithm for the Mdn response. The valid values are SHA256 | SHA384 | SHA512 | SHA1 | NONE | DEFAULT.
    MessageSubject string
    Used as the subject HTTP header attribute in AS2 messages that are being sent with the connector.
    compression String
    Specifies weather AS2 file is compressed. The valud values are ZLIB and DISABLED.
    encryptionAlgorithm String
    The algorithm that is used to encrypt the file. The valid values are AES128_CBC | AES192_CBC | AES256_CBC | NONE.
    localProfileId String
    The unique identifier for the AS2 local profile.
    mdnResponse String
    Used for outbound requests to determine if a partner response for transfers is synchronous or asynchronous. The valid values are SYNC and NONE.
    partnerProfileId String
    The unique identifier for the AS2 partner profile.
    signingAlgorithm String
    The algorithm that is used to sign AS2 messages sent with the connector. The valid values are SHA256 | SHA384 | SHA512 | SHA1 | NONE .
    mdnSigningAlgorithm String
    The signing algorithm for the Mdn response. The valid values are SHA256 | SHA384 | SHA512 | SHA1 | NONE | DEFAULT.
    messageSubject String
    Used as the subject HTTP header attribute in AS2 messages that are being sent with the connector.
    compression string
    Specifies weather AS2 file is compressed. The valud values are ZLIB and DISABLED.
    encryptionAlgorithm string
    The algorithm that is used to encrypt the file. The valid values are AES128_CBC | AES192_CBC | AES256_CBC | NONE.
    localProfileId string
    The unique identifier for the AS2 local profile.
    mdnResponse string
    Used for outbound requests to determine if a partner response for transfers is synchronous or asynchronous. The valid values are SYNC and NONE.
    partnerProfileId string
    The unique identifier for the AS2 partner profile.
    signingAlgorithm string
    The algorithm that is used to sign AS2 messages sent with the connector. The valid values are SHA256 | SHA384 | SHA512 | SHA1 | NONE .
    mdnSigningAlgorithm string
    The signing algorithm for the Mdn response. The valid values are SHA256 | SHA384 | SHA512 | SHA1 | NONE | DEFAULT.
    messageSubject string
    Used as the subject HTTP header attribute in AS2 messages that are being sent with the connector.
    compression str
    Specifies weather AS2 file is compressed. The valud values are ZLIB and DISABLED.
    encryption_algorithm str
    The algorithm that is used to encrypt the file. The valid values are AES128_CBC | AES192_CBC | AES256_CBC | NONE.
    local_profile_id str
    The unique identifier for the AS2 local profile.
    mdn_response str
    Used for outbound requests to determine if a partner response for transfers is synchronous or asynchronous. The valid values are SYNC and NONE.
    partner_profile_id str
    The unique identifier for the AS2 partner profile.
    signing_algorithm str
    The algorithm that is used to sign AS2 messages sent with the connector. The valid values are SHA256 | SHA384 | SHA512 | SHA1 | NONE .
    mdn_signing_algorithm str
    The signing algorithm for the Mdn response. The valid values are SHA256 | SHA384 | SHA512 | SHA1 | NONE | DEFAULT.
    message_subject str
    Used as the subject HTTP header attribute in AS2 messages that are being sent with the connector.
    compression String
    Specifies weather AS2 file is compressed. The valud values are ZLIB and DISABLED.
    encryptionAlgorithm String
    The algorithm that is used to encrypt the file. The valid values are AES128_CBC | AES192_CBC | AES256_CBC | NONE.
    localProfileId String
    The unique identifier for the AS2 local profile.
    mdnResponse String
    Used for outbound requests to determine if a partner response for transfers is synchronous or asynchronous. The valid values are SYNC and NONE.
    partnerProfileId String
    The unique identifier for the AS2 partner profile.
    signingAlgorithm String
    The algorithm that is used to sign AS2 messages sent with the connector. The valid values are SHA256 | SHA384 | SHA512 | SHA1 | NONE .
    mdnSigningAlgorithm String
    The signing algorithm for the Mdn response. The valid values are SHA256 | SHA384 | SHA512 | SHA1 | NONE | DEFAULT.
    messageSubject String
    Used as the subject HTTP header attribute in AS2 messages that are being sent with the connector.

    ConnectorSftpConfig, ConnectorSftpConfigArgs

    TrustedHostKeys List<string>
    A list of public portion of the host key, or keys, that are used to authenticate the user to the external server to which you are connecting.(https://docs.aws.amazon.com/transfer/latest/userguide/API_SftpConnectorConfig.html)
    UserSecretId string
    The identifier for the secret (in AWS Secrets Manager) that contains the SFTP user's private key, password, or both. The identifier can be either the Amazon Resource Name (ARN) or the name of the secret.
    TrustedHostKeys []string
    A list of public portion of the host key, or keys, that are used to authenticate the user to the external server to which you are connecting.(https://docs.aws.amazon.com/transfer/latest/userguide/API_SftpConnectorConfig.html)
    UserSecretId string
    The identifier for the secret (in AWS Secrets Manager) that contains the SFTP user's private key, password, or both. The identifier can be either the Amazon Resource Name (ARN) or the name of the secret.
    trustedHostKeys List<String>
    A list of public portion of the host key, or keys, that are used to authenticate the user to the external server to which you are connecting.(https://docs.aws.amazon.com/transfer/latest/userguide/API_SftpConnectorConfig.html)
    userSecretId String
    The identifier for the secret (in AWS Secrets Manager) that contains the SFTP user's private key, password, or both. The identifier can be either the Amazon Resource Name (ARN) or the name of the secret.
    trustedHostKeys string[]
    A list of public portion of the host key, or keys, that are used to authenticate the user to the external server to which you are connecting.(https://docs.aws.amazon.com/transfer/latest/userguide/API_SftpConnectorConfig.html)
    userSecretId string
    The identifier for the secret (in AWS Secrets Manager) that contains the SFTP user's private key, password, or both. The identifier can be either the Amazon Resource Name (ARN) or the name of the secret.
    trusted_host_keys Sequence[str]
    A list of public portion of the host key, or keys, that are used to authenticate the user to the external server to which you are connecting.(https://docs.aws.amazon.com/transfer/latest/userguide/API_SftpConnectorConfig.html)
    user_secret_id str
    The identifier for the secret (in AWS Secrets Manager) that contains the SFTP user's private key, password, or both. The identifier can be either the Amazon Resource Name (ARN) or the name of the secret.
    trustedHostKeys List<String>
    A list of public portion of the host key, or keys, that are used to authenticate the user to the external server to which you are connecting.(https://docs.aws.amazon.com/transfer/latest/userguide/API_SftpConnectorConfig.html)
    userSecretId String
    The identifier for the secret (in AWS Secrets Manager) that contains the SFTP user's private key, password, or both. The identifier can be either the Amazon Resource Name (ARN) or the name of the secret.

    Import

    Using pulumi import, import Transfer AS2 Connector using the connector_id. For example:

    $ pulumi import aws:transfer/connector:Connector example c-4221a88afd5f4362a
    

    To learn more about importing existing cloud resources, see Importing resources.

    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

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.32.0 published on Friday, Apr 19, 2024 by Pulumi