pulumi-aws-kotlin/com.pulumi.aws.transfer.kotlin/Connector

Connector

class Connector : KotlinCustomResource

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",
});
Content copied to clipboard
import pulumi
import pulumi_aws as aws
example = aws.transfer.Connector("example",
    access_role=test["arn"],
    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",
    },
    url="http://www.test.com")
Content copied to clipboard
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",
    });
});
Content copied to clipboard
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
	})
}
Content copied to clipboard
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());
    }
}
Content copied to clipboard
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
Content copied to clipboard

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",
});
Content copied to clipboard
import pulumi
import pulumi_aws as aws
example = aws.transfer.Connector("example",
    access_role=test["arn"],
    sftp_config={
        "trusted_host_keys": ["ssh-rsa AAAAB3NYourKeysHere"],
        "user_secret_id": example_aws_secretsmanager_secret["id"],
    },
    url="sftp://test.com")
Content copied to clipboard
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",
    });
});
Content copied to clipboard
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
	})
}
Content copied to clipboard
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());
    }
}
Content copied to clipboard
resources:
  example:
    type: aws:transfer:Connector
    properties:
      accessRole: ${test.arn}
      sftpConfig:
        trustedHostKeys:
          - ssh-rsa AAAAB3NYourKeysHere
        userSecretId: ${exampleAwsSecretsmanagerSecret.id}
      url: sftp://test.com
Content copied to clipboard

Import

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

$ pulumi import aws:transfer/connector:Connector example c-4221a88afd5f4362a
Content copied to clipboard

Properties

Link copied to clipboard
val accessRole: Output<String>

The IAM Role which provides read and write access to the parent directory of the file location mentioned in the StartFileTransfer request.

Link copied to clipboard
val arn: Output<String>

The ARN of the connector.

Link copied to clipboard
val as2Config: Output<ConnectorAs2Config>?

Either SFTP or AS2 is configured.The parameters to configure for the connector object. Fields documented below.

Link copied to clipboard
val connectorId: Output<String>

The unique identifier for the AS2 profile or SFTP Profile.

Link copied to clipboard
val id: Output<String>
Link copied to clipboard
val loggingRole: Output<String>?

The IAM Role which is required for allowing the connector to turn on CloudWatch logging for Amazon S3 events.

Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val securityPolicyName: Output<String>

Name of the security policy for the connector.

Link copied to clipboard
val sftpConfig: Output<ConnectorSftpConfig>?

Either SFTP or AS2 is configured.The parameters to configure for the connector object. Fields documented below.

Link copied to clipboard
val tags: Output<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.

Link copied to clipboard
val tagsAll: Output<Map<String, String>>
Link copied to clipboard
val url: Output<String>

The URL of the partners AS2 endpoint or SFTP endpoint.

Link copied to clipboard
val urn: Output<String>