Connector class

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", {
    as2Config: {
        compression: "DISABLED",
        encryptionAlgorithm: "AWS128_CBC",
        messageSubject: "For Connector",
        localProfileId: local.profileId,
        mdnResponse: "NONE",
        mdnSigningAlgorithm: "NONE",
        partnerProfileId: partner.profileId,
        signingAlgorithm: "NONE",
    },
    accessRole: test.arn,
    url: "http://www.test.com",
});
import pulumi
import pulumi_aws as aws

example = aws.transfer.Connector("example",
    as2_config={
        "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",
    },
    access_role=test["arn"],
    url="http://www.test.com")
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()
    {
        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",
        },
        AccessRole = test.Arn,
        Url = "http://www.test.com",
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/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{
			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"),
			},
			AccessRole: pulumi.Any(test.Arn),
			Url:        pulumi.String("http://www.test.com"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_transfer_connector" "example" {
  as2_config = {
    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"
  }
  access_role = test.arn
  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.ArrayList;
import java.util.Arrays;
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()
            .as2Config(ConnectorAs2ConfigArgs.builder()
                .compression("DISABLED")
                .encryptionAlgorithm("AWS128_CBC")
                .messageSubject("For Connector")
                .localProfileId(local.profileId())
                .mdnResponse("NONE")
                .mdnSigningAlgorithm("NONE")
                .partnerProfileId(partner.profileId())
                .signingAlgorithm("NONE")
                .build())
            .accessRole(test.arn())
            .url("http://www.test.com")
            .build());

    }
}
resources:
  example:
    type: aws:transfer:Connector
    properties:
      as2Config:
        compression: DISABLED
        encryptionAlgorithm: AWS128_CBC
        messageSubject: For Connector
        localProfileId: ${local.profileId}
        mdnResponse: NONE
        mdnSigningAlgorithm: NONE
        partnerProfileId: ${partner.profileId}
        signingAlgorithm: NONE
      accessRole: ${test.arn}
      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", {
    sftpConfig: {
        trustedHostKeys: ["ssh-rsa AAAAB3NYourKeysHere"],
        userSecretId: exampleAwsSecretsmanagerSecret.id,
    },
    accessRole: test.arn,
    url: "sftp://test.com",
});
import pulumi
import pulumi_aws as aws

example = aws.transfer.Connector("example",
    sftp_config={
        "trusted_host_keys": ["ssh-rsa AAAAB3NYourKeysHere"],
        "user_secret_id": example_aws_secretsmanager_secret["id"],
    },
    access_role=test["arn"],
    url="sftp://test.com")
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()
    {
        SftpConfig = new Aws.Transfer.Inputs.ConnectorSftpConfigArgs
        {
            TrustedHostKeys = new[]
            {
                "ssh-rsa AAAAB3NYourKeysHere",
            },
            UserSecretId = exampleAwsSecretsmanagerSecret.Id,
        },
        AccessRole = test.Arn,
        Url = "sftp://test.com",
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/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{
			SftpConfig: &transfer.ConnectorSftpConfigArgs{
				TrustedHostKeys: pulumi.StringArray{
					pulumi.String("ssh-rsa AAAAB3NYourKeysHere"),
				},
				UserSecretId: pulumi.Any(exampleAwsSecretsmanagerSecret.Id),
			},
			AccessRole: pulumi.Any(test.Arn),
			Url:        pulumi.String("sftp://test.com"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_transfer_connector" "example" {
  sftp_config = {
    trusted_host_keys = ["ssh-rsa AAAAB3NYourKeysHere"]
    user_secret_id    = exampleAwsSecretsmanagerSecret.id
  }
  access_role = test.arn
  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.ArrayList;
import java.util.Arrays;
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()
            .sftpConfig(ConnectorSftpConfigArgs.builder()
                .trustedHostKeys("ssh-rsa AAAAB3NYourKeysHere")
                .userSecretId(exampleAwsSecretsmanagerSecret.id())
                .build())
            .accessRole(test.arn())
            .url("sftp://test.com")
            .build());

    }
}
resources:
  example:
    type: aws:transfer:Connector
    properties:
      sftpConfig:
        trustedHostKeys:
          - ssh-rsa AAAAB3NYourKeysHere
        userSecretId: ${exampleAwsSecretsmanagerSecret.id}
      accessRole: ${test.arn}
      url: sftp://test.com

SFTP Connector with VPC Lattice

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.transfer.Connector("example", {
    sftpConfig: {
        trustedHostKeys: ["ssh-rsa AAAAB3NYourKeysHere"],
        userSecretId: exampleAwsSecretsmanagerSecret.id,
    },
    egressConfig: {
        vpcLattice: {
            resourceConfigurationArn: "arn:aws:vpc-lattice:us-east-1:123456789012:resourceconfiguration/rcfg-12345678901234567",
            portNumber: 22,
        },
    },
    accessRole: test.arn,
});
import pulumi
import pulumi_aws as aws

example = aws.transfer.Connector("example",
    sftp_config={
        "trusted_host_keys": ["ssh-rsa AAAAB3NYourKeysHere"],
        "user_secret_id": example_aws_secretsmanager_secret["id"],
    },
    egress_config={
        "vpc_lattice": {
            "resource_configuration_arn": "arn:aws:vpc-lattice:us-east-1:123456789012:resourceconfiguration/rcfg-12345678901234567",
            "port_number": 22,
        },
    },
    access_role=test["arn"])
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()
    {
        SftpConfig = new Aws.Transfer.Inputs.ConnectorSftpConfigArgs
        {
            TrustedHostKeys = new[]
            {
                "ssh-rsa AAAAB3NYourKeysHere",
            },
            UserSecretId = exampleAwsSecretsmanagerSecret.Id,
        },
        EgressConfig = new Aws.Transfer.Inputs.ConnectorEgressConfigArgs
        {
            VpcLattice = new Aws.Transfer.Inputs.ConnectorEgressConfigVpcLatticeArgs
            {
                ResourceConfigurationArn = "arn:aws:vpc-lattice:us-east-1:123456789012:resourceconfiguration/rcfg-12345678901234567",
                PortNumber = 22,
            },
        },
        AccessRole = test.Arn,
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/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{
			SftpConfig: &transfer.ConnectorSftpConfigArgs{
				TrustedHostKeys: pulumi.StringArray{
					pulumi.String("ssh-rsa AAAAB3NYourKeysHere"),
				},
				UserSecretId: pulumi.Any(exampleAwsSecretsmanagerSecret.Id),
			},
			EgressConfig: &transfer.ConnectorEgressConfigArgs{
				VpcLattice: &transfer.ConnectorEgressConfigVpcLatticeArgs{
					ResourceConfigurationArn: pulumi.String("arn:aws:vpc-lattice:us-east-1:123456789012:resourceconfiguration/rcfg-12345678901234567"),
					PortNumber:               pulumi.Int(22),
				},
			},
			AccessRole: pulumi.Any(test.Arn),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_transfer_connector" "example" {
  sftp_config = {
    trusted_host_keys = ["ssh-rsa AAAAB3NYourKeysHere"]
    user_secret_id    = exampleAwsSecretsmanagerSecret.id
  }
  egress_config = {
    vpc_lattice = {
      resource_configuration_arn = "arn:aws:vpc-lattice:us-east-1:123456789012:resourceconfiguration/rcfg-12345678901234567"
      port_number                = 22
    }
  }
  access_role = test.arn
}
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 com.pulumi.aws.transfer.inputs.ConnectorEgressConfigArgs;
import com.pulumi.aws.transfer.inputs.ConnectorEgressConfigVpcLatticeArgs;
import java.util.ArrayList;
import java.util.Arrays;
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()
            .sftpConfig(ConnectorSftpConfigArgs.builder()
                .trustedHostKeys("ssh-rsa AAAAB3NYourKeysHere")
                .userSecretId(exampleAwsSecretsmanagerSecret.id())
                .build())
            .egressConfig(ConnectorEgressConfigArgs.builder()
                .vpcLattice(ConnectorEgressConfigVpcLatticeArgs.builder()
                    .resourceConfigurationArn("arn:aws:vpc-lattice:us-east-1:123456789012:resourceconfiguration/rcfg-12345678901234567")
                    .portNumber(22)
                    .build())
                .build())
            .accessRole(test.arn())
            .build());

    }
}
resources:
  example:
    type: aws:transfer:Connector
    properties:
      sftpConfig:
        trustedHostKeys:
          - ssh-rsa AAAAB3NYourKeysHere
        userSecretId: ${exampleAwsSecretsmanagerSecret.id}
      egressConfig:
        vpcLattice:
          resourceConfigurationArn: arn:aws:vpc-lattice:us-east-1:123456789012:resourceconfiguration/rcfg-12345678901234567
          portNumber: 22
      accessRole: ${test.arn}

Import

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

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

Constructors

Connector(String name, {ConnectorArgs? args, CustomResourceOptions? options})
Creates a new Connector. name The Pulumi resource name. args Arguments used to configure this Connector. The set of arguments for Connector. options Resource options controlling this resource's behavior.
Connector.reference(String urn)
Creates a typed reference to an existing Connector resource.

Properties

accessRole ↔ Output<String>
IAM Role which provides read and write access to the parent directory of the file location mentioned in the StartFileTransfer request.
latefinal
arn ↔ Output<String>
ARN of the connector.
latefinal
as2Config ↔ Output<ConnectorAs2Config?>
Either SFTP or AS2 is configured. Parameters to configure for the connector object. See as2Config Block below.
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
connectorId ↔ Output<String>
Unique identifier for the AS2 profile or SFTP Profile.
latefinal
egressConfig ↔ Output<ConnectorEgressConfig?>
Egress configuration for the connector. When set, enables routing through customer VPCs using VPC Lattice for private connectivity. See egressConfig Block below.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
loggingRole ↔ Output<String?>
IAM Role which is required for allowing the connector to turn on CloudWatch logging for Amazon S3 events.
latefinal
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
securityPolicyName ↔ Output<String>
Name of the security policy for the connector.
latefinal
sftpConfig ↔ Output<ConnectorSftpConfig?>
Either SFTP or AS2 is configured. Parameters to configure for the connector object. See sftpConfig Block below.
latefinal
tags ↔ Output<Map<String, String>?>
Map of tags to assign to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
latefinal
tagsAll ↔ Output<Map<String, String>>
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
url ↔ Output<String?>
URL of the partners AS2 endpoint or SFTP endpoint. Required for AS2 connectors and service-managed SFTP connectors. Must be null when using VPC Lattice egress configuration.
latefinal
urn ↔ Output<String>
latefinalinherited

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {ConnectorState? state, CustomResourceOptions? options}) → Connector
Gets an existing Connector resource's state with the given name and id.