Agreement class
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/v7/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
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "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 = testAwsTransferServer.id
}
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());
}
}
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
- Agreement(String name, {AgreementArgs? args, CustomResourceOptions? options})
-
Creates a new Agreement.
nameThe Pulumi resource name.argsArguments used to configure this Agreement. The set of arguments for Agreement.optionsResource options controlling this resource's behavior. - Agreement.reference(String urn)
- Creates a typed reference to an existing Agreement resource.
Properties
-
accessRole
↔ Output<
String> -
IAM Role which provides read and write access to the parent directory of the file location mentioned in the StartFileTransfer request.
latefinal
-
agreementId
↔ Output<
String> -
Unique identifier for the AS2 agreement.
latefinal
-
arn
↔ Output<
String> -
ARN of the agreement.
latefinal
-
baseDirectory
↔ Output<
String> -
Landing directory for the files transferred by using the AS2 protocol.
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
description
↔ Output<
String?> -
Optional description of the transdfer.
latefinal
- hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
localProfileId
↔ Output<
String> -
Unique identifier for the AS2 local profile.
latefinal
-
partnerProfileId
↔ Output<
String> -
Unique identifier for the AS2 partner profile.
latefinal
-
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
serverId
↔ Output<
String> -
Unique server identifier for the server instance. This is the specific server the agreement uses.
latefinal
-
status
↔ Output<
String> -
Status of the agreement which is either ACTIVE or INACTIVE.
latefinal
-
Map of tags to assign to the resource. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.latefinal -
latefinal
-
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited