AgreementArgs

data class AgreementArgs(val accessRole: Output<String>? = null, val baseDirectory: Output<String>? = null, val description: Output<String>? = null, val localProfileId: Output<String>? = null, val partnerProfileId: Output<String>? = null, val serverId: Output<String>? = null, val tags: Output<Map<String, String>>? = null) : ConvertibleToJava<AgreementArgs>

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.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 Agreement("example", AgreementArgs.builder()
.accessRole(aws_iam_role.test().arn())
.baseDirectory("/DOC-EXAMPLE-BUCKET/home/mydirectory")
.description("example")
.localProfileId(aws_transfer_profile.local().profile_id())
.partnerProfileId(aws_transfer_profile.partner().profile_id())
.serverId(aws_transfer_server.test().id())
.build());
}
}

Import

Using pulumi import, import Transfer AS2 Agreement using the server_id/agreement_id. For example:

$ pulumi import aws:transfer/agreement:Agreement example s-4221a88afd5f4362a/a-4221a88afd5f4362a

Constructors

Link copied to clipboard
fun AgreementArgs(accessRole: Output<String>? = null, baseDirectory: Output<String>? = null, description: Output<String>? = null, localProfileId: Output<String>? = null, partnerProfileId: Output<String>? = null, serverId: Output<String>? = null, tags: Output<Map<String, String>>? = null)

Functions

Link copied to clipboard
open override fun toJava(): AgreementArgs

Properties

Link copied to clipboard
val accessRole: Output<String>? = null

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 baseDirectory: Output<String>? = null

The landing directory for the files transferred by using the AS2 protocol.

Link copied to clipboard
val description: Output<String>? = null

The Optional description of the transdfer.

Link copied to clipboard
val localProfileId: Output<String>? = null

The unique identifier for the AS2 local profile.

Link copied to clipboard
val partnerProfileId: Output<String>? = null

The unique identifier for the AS2 partner profile.

Link copied to clipboard
val serverId: Output<String>? = null

The unique server identifier for the server instance. This is the specific server the agreement uses.

Link copied to clipboard
val tags: Output<Map<String, String>>? = null

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.