Class Connector


  • public class Connector
    extends com.pulumi.resources.CustomResource
    Provides a AWS Transfer AS2 Connector resource. ## Example Usage ### Basic
     
     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());
     
         }
     }
     
     
    ### SFTP Connector
     
     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());
     
         }
     }
     
     
    ### SFTP Connector with VPC Lattice
     
     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());
     
         }
     }
     
     
    ## Import Using `pulumi import`, import Transfer AS2 Connector using the `connectorId`. For example: ```sh $ pulumi import aws:transfer/connector:Connector example c-4221a88afd5f4362a ```
    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal
      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal
    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote
    • Constructor Summary

      Constructors 
      Constructor Description
      Connector​(java.lang.String name)  
      Connector​(java.lang.String name, ConnectorArgs args)  
      Connector​(java.lang.String name, ConnectorArgs args, com.pulumi.resources.CustomResourceOptions options)  
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.lang.String> accessRole()  
      com.pulumi.core.Output<java.lang.String> arn()  
      com.pulumi.core.Output<java.util.Optional<ConnectorAs2Config>> as2Config()  
      com.pulumi.core.Output<java.lang.String> connectorId()  
      com.pulumi.core.Output<java.util.Optional<ConnectorEgressConfig>> egressConfig()  
      static Connector get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, ConnectorState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> loggingRole()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.lang.String> securityPolicyName()  
      com.pulumi.core.Output<java.util.Optional<ConnectorSftpConfig>> sftpConfig()  
      com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()  
      com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> url()  
      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture
      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • Connector

        public Connector​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.
      • Connector

        public Connector​(java.lang.String name,
                         ConnectorArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
      • Connector

        public Connector​(java.lang.String name,
                         ConnectorArgs args,
                         @Nullable
                         com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.
    • Method Detail

      • accessRole

        public com.pulumi.core.Output<java.lang.String> accessRole()
        Returns:
        IAM Role which provides read and write access to the parent directory of the file location mentioned in the StartFileTransfer request.
      • arn

        public com.pulumi.core.Output<java.lang.String> arn()
        Returns:
        ARN of the connector.
      • as2Config

        public com.pulumi.core.Output<java.util.Optional<ConnectorAs2Config>> as2Config()
        Returns:
        Either SFTP or AS2 is configured. Parameters to configure for the connector object. See `as2Config` Block below.
      • connectorId

        public com.pulumi.core.Output<java.lang.String> connectorId()
        Returns:
        Unique identifier for the AS2 profile or SFTP Profile.
      • egressConfig

        public com.pulumi.core.Output<java.util.Optional<ConnectorEgressConfig>> egressConfig()
        Returns:
        Egress configuration for the connector. When set, enables routing through customer VPCs using VPC Lattice for private connectivity. See `egressConfig` Block below.
      • loggingRole

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> loggingRole()
        Returns:
        IAM Role which is required for allowing the connector to turn on CloudWatch logging for Amazon S3 events.
      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
      • securityPolicyName

        public com.pulumi.core.Output<java.lang.String> securityPolicyName()
        Returns:
        Name of the security policy for the connector.
      • sftpConfig

        public com.pulumi.core.Output<java.util.Optional<ConnectorSftpConfig>> sftpConfig()
        Returns:
        Either SFTP or AS2 is configured. Parameters to configure for the connector object. See `sftpConfig` Block below.
      • tags

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        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.
      • tagsAll

        public com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()
      • url

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> url()
        Returns:
        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.
      • get

        public static Connector get​(java.lang.String name,
                                    com.pulumi.core.Output<java.lang.String> id,
                                    @Nullable
                                    ConnectorState state,
                                    @Nullable
                                    com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.