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

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.transfer.Agreement("example", {
accessRole: test.arn,
baseDirectory: "/DOC-EXAMPLE-BUCKET/home/mydirectory",
description: "example",
localProfileId: local.profileId,
partnerProfileId: partner.profileId,
serverId: testAwsTransferServer.id,
});
import pulumi
import pulumi_aws as aws
example = aws.transfer.Agreement("example",
access_role=test["arn"],
base_directory="/DOC-EXAMPLE-BUCKET/home/mydirectory",
description="example",
local_profile_id=local["profileId"],
partner_profile_id=partner["profileId"],
server_id=test_aws_transfer_server["id"])
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Transfer.Agreement("example", new()
{
AccessRole = test.Arn,
BaseDirectory = "/DOC-EXAMPLE-BUCKET/home/mydirectory",
Description = "example",
LocalProfileId = local.ProfileId,
PartnerProfileId = partner.ProfileId,
ServerId = testAwsTransferServer.Id,
});
});
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.NewAgreement(ctx, "example", &transfer.AgreementArgs{
AccessRole: pulumi.Any(test.Arn),
BaseDirectory: pulumi.String("/DOC-EXAMPLE-BUCKET/home/mydirectory"),
Description: pulumi.String("example"),
LocalProfileId: pulumi.Any(local.ProfileId),
PartnerProfileId: pulumi.Any(partner.ProfileId),
ServerId: pulumi.Any(testAwsTransferServer.Id),
})
if err != nil {
return err
}
return nil
})
}
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(test.arn())
.baseDirectory("/DOC-EXAMPLE-BUCKET/home/mydirectory")
.description("example")
.localProfileId(local.profileId())
.partnerProfileId(partner.profileId())
.serverId(testAwsTransferServer.id())
.build());
}
}
resources:
example:
type: aws:transfer:Agreement
properties:
accessRole: ${test.arn}
baseDirectory: /DOC-EXAMPLE-BUCKET/home/mydirectory
description: example
localProfileId: ${local.profileId}
partnerProfileId: ${partner.profileId}
serverId: ${testAwsTransferServer.id}

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

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.

Functions

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