Package com.pulumi.aws.transfer

Class Agreement

  • public class Agreement
extends com.pulumi.resources.CustomResource
    Provides a AWS Transfer AS2 Agreement 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.Agreement;
 import com.pulumi.aws.transfer.AgreementArgs;
 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 Agreement("example", AgreementArgs.builder()
             .accessRole(test.arn())
             .baseDirectory("/DOC-EXAMPLE-BUCKET/home/mydirectory")
             .description("example")
             .localProfileId(local.profileId())
             .partnerProfileId(partner.profileId())
             .serverId(testAwsTransferServer.id())
             .build());
 
     }
 }
    ## Import Using `pulumi import`, import Transfer AS2 Agreement using the `server_id/agreement_id`. For example: ```sh $ pulumi import aws:transfer/agreement:Agreement example s-4221a88afd5f4362a/a-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
      Agreement​(java.lang.String name)  
      Agreement​(java.lang.String name, AgreementArgs args)  
      Agreement​(java.lang.String name, AgreementArgs 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> agreementId()  
      com.pulumi.core.Output<java.lang.String> arn()  
      com.pulumi.core.Output<java.lang.String> baseDirectory()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()  
      static Agreement get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, AgreementState 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.lang.String> localProfileId()  
      com.pulumi.core.Output<java.lang.String> partnerProfileId()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.lang.String> serverId()  
      com.pulumi.core.Output<java.lang.String> status()  
      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()  

      • 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

      • Agreement

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

      • Agreement

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

      • Agreement

        public Agreement​(java.lang.String name,
                 AgreementArgs 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.

      • agreementId

        public com.pulumi.core.Output<java.lang.String> agreementId()
        Returns:
        Unique identifier for the AS2 agreement.

      • arn

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

      • baseDirectory

        public com.pulumi.core.Output<java.lang.String> baseDirectory()
        Returns:
        Landing directory for the files transferred by using the AS2 protocol.

      • description

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()
        Returns:
        Optional description of the transdfer.

      • localProfileId

        public com.pulumi.core.Output<java.lang.String> localProfileId()
        Returns:
        Unique identifier for the AS2 local profile.

      • partnerProfileId

        public com.pulumi.core.Output<java.lang.String> partnerProfileId()
        Returns:
        Unique identifier for the AS2 partner profile.

      • 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.

      • serverId

        public com.pulumi.core.Output<java.lang.String> serverId()
        Returns:
        Unique server identifier for the server instance. This is the specific server the agreement uses.

      • status

        public com.pulumi.core.Output<java.lang.String> status()
        Returns:
        Status of the agreement which is either ACTIVE or INACTIVE.

      • 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()

      • get

        public static Agreement get​(java.lang.String name,
                            com.pulumi.core.Output<java.lang.String> id,
                            @Nullable
                            AgreementState 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.