Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. transfer
  5. getAgreement

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.transfer.getAgreement

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

Resource Type definition for AWS::Transfer::Agreement

Using getAgreement

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getAgreement(args: GetAgreementArgs, opts?: InvokeOptions): Promise<GetAgreementResult>
function getAgreementOutput(args: GetAgreementOutputArgs, opts?: InvokeOptions): Output<GetAgreementResult>
Copy
def get_agreement(agreement_id: Optional[str] = None,
                  server_id: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetAgreementResult
def get_agreement_output(agreement_id: Optional[pulumi.Input[str]] = None,
                  server_id: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetAgreementResult]
Copy
func LookupAgreement(ctx *Context, args *LookupAgreementArgs, opts ...InvokeOption) (*LookupAgreementResult, error)
func LookupAgreementOutput(ctx *Context, args *LookupAgreementOutputArgs, opts ...InvokeOption) LookupAgreementResultOutput
Copy

> Note: This function is named LookupAgreement in the Go SDK.

public static class GetAgreement 
{
    public static Task<GetAgreementResult> InvokeAsync(GetAgreementArgs args, InvokeOptions? opts = null)
    public static Output<GetAgreementResult> Invoke(GetAgreementInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetAgreementResult> getAgreement(GetAgreementArgs args, InvokeOptions options)
public static Output<GetAgreementResult> getAgreement(GetAgreementArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: aws-native:transfer:getAgreement
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

AgreementId This property is required. string
A unique identifier for the agreement.
ServerId This property is required. string
A unique identifier for the server.
AgreementId This property is required. string
A unique identifier for the agreement.
ServerId This property is required. string
A unique identifier for the server.
agreementId This property is required. String
A unique identifier for the agreement.
serverId This property is required. String
A unique identifier for the server.
agreementId This property is required. string
A unique identifier for the agreement.
serverId This property is required. string
A unique identifier for the server.
agreement_id This property is required. str
A unique identifier for the agreement.
server_id This property is required. str
A unique identifier for the server.
agreementId This property is required. String
A unique identifier for the agreement.
serverId This property is required. String
A unique identifier for the server.

getAgreement Result

The following output properties are available:

AccessRole string
Specifies the access role for the agreement.
AgreementId string
A unique identifier for the agreement.
Arn string
Specifies the unique Amazon Resource Name (ARN) for the agreement.
BaseDirectory string
Specifies the base directory for the agreement.
CustomDirectories Pulumi.AwsNative.Transfer.Outputs.CustomDirectoriesProperties
Specifies a separate directory for each type of file to store for an AS2 message.
Description string
A textual description for the agreement.
EnforceMessageSigning Pulumi.AwsNative.Transfer.AgreementEnforceMessageSigning
Specifies whether to enforce an AS2 message is signed for this agreement.
LocalProfileId string
A unique identifier for the local profile.
PartnerProfileId string
A unique identifier for the partner profile.
PreserveFilename Pulumi.AwsNative.Transfer.AgreementPreserveFilename
Specifies whether to preserve the filename received for this agreement.
Status Pulumi.AwsNative.Transfer.AgreementStatus
Specifies the status of the agreement.
Tags List<Pulumi.AwsNative.Outputs.Tag>
Key-value pairs that can be used to group and search for agreements. Tags are metadata attached to agreements for any purpose.
AccessRole string
Specifies the access role for the agreement.
AgreementId string
A unique identifier for the agreement.
Arn string
Specifies the unique Amazon Resource Name (ARN) for the agreement.
BaseDirectory string
Specifies the base directory for the agreement.
CustomDirectories CustomDirectoriesProperties
Specifies a separate directory for each type of file to store for an AS2 message.
Description string
A textual description for the agreement.
EnforceMessageSigning AgreementEnforceMessageSigning
Specifies whether to enforce an AS2 message is signed for this agreement.
LocalProfileId string
A unique identifier for the local profile.
PartnerProfileId string
A unique identifier for the partner profile.
PreserveFilename AgreementPreserveFilename
Specifies whether to preserve the filename received for this agreement.
Status AgreementStatus
Specifies the status of the agreement.
Tags Tag
Key-value pairs that can be used to group and search for agreements. Tags are metadata attached to agreements for any purpose.
accessRole String
Specifies the access role for the agreement.
agreementId String
A unique identifier for the agreement.
arn String
Specifies the unique Amazon Resource Name (ARN) for the agreement.
baseDirectory String
Specifies the base directory for the agreement.
customDirectories CustomDirectoriesProperties
Specifies a separate directory for each type of file to store for an AS2 message.
description String
A textual description for the agreement.
enforceMessageSigning AgreementEnforceMessageSigning
Specifies whether to enforce an AS2 message is signed for this agreement.
localProfileId String
A unique identifier for the local profile.
partnerProfileId String
A unique identifier for the partner profile.
preserveFilename AgreementPreserveFilename
Specifies whether to preserve the filename received for this agreement.
status AgreementStatus
Specifies the status of the agreement.
tags List<Tag>
Key-value pairs that can be used to group and search for agreements. Tags are metadata attached to agreements for any purpose.
accessRole string
Specifies the access role for the agreement.
agreementId string
A unique identifier for the agreement.
arn string
Specifies the unique Amazon Resource Name (ARN) for the agreement.
baseDirectory string
Specifies the base directory for the agreement.
customDirectories CustomDirectoriesProperties
Specifies a separate directory for each type of file to store for an AS2 message.
description string
A textual description for the agreement.
enforceMessageSigning AgreementEnforceMessageSigning
Specifies whether to enforce an AS2 message is signed for this agreement.
localProfileId string
A unique identifier for the local profile.
partnerProfileId string
A unique identifier for the partner profile.
preserveFilename AgreementPreserveFilename
Specifies whether to preserve the filename received for this agreement.
status AgreementStatus
Specifies the status of the agreement.
tags Tag[]
Key-value pairs that can be used to group and search for agreements. Tags are metadata attached to agreements for any purpose.
access_role str
Specifies the access role for the agreement.
agreement_id str
A unique identifier for the agreement.
arn str
Specifies the unique Amazon Resource Name (ARN) for the agreement.
base_directory str
Specifies the base directory for the agreement.
custom_directories CustomDirectoriesProperties
Specifies a separate directory for each type of file to store for an AS2 message.
description str
A textual description for the agreement.
enforce_message_signing AgreementEnforceMessageSigning
Specifies whether to enforce an AS2 message is signed for this agreement.
local_profile_id str
A unique identifier for the local profile.
partner_profile_id str
A unique identifier for the partner profile.
preserve_filename AgreementPreserveFilename
Specifies whether to preserve the filename received for this agreement.
status AgreementStatus
Specifies the status of the agreement.
tags Sequence[root_Tag]
Key-value pairs that can be used to group and search for agreements. Tags are metadata attached to agreements for any purpose.
accessRole String
Specifies the access role for the agreement.
agreementId String
A unique identifier for the agreement.
arn String
Specifies the unique Amazon Resource Name (ARN) for the agreement.
baseDirectory String
Specifies the base directory for the agreement.
customDirectories Property Map
Specifies a separate directory for each type of file to store for an AS2 message.
description String
A textual description for the agreement.
enforceMessageSigning "ENABLED" | "DISABLED"
Specifies whether to enforce an AS2 message is signed for this agreement.
localProfileId String
A unique identifier for the local profile.
partnerProfileId String
A unique identifier for the partner profile.
preserveFilename "ENABLED" | "DISABLED"
Specifies whether to preserve the filename received for this agreement.
status "ACTIVE" | "INACTIVE"
Specifies the status of the agreement.
tags List<Property Map>
Key-value pairs that can be used to group and search for agreements. Tags are metadata attached to agreements for any purpose.

Supporting Types

AgreementEnforceMessageSigning

AgreementPreserveFilename

AgreementStatus

CustomDirectoriesProperties

FailedFilesDirectory This property is required. string
Specifies a location to store the failed files for an AS2 message.
MdnFilesDirectory This property is required. string
Specifies a location to store the MDN file for an AS2 message.
PayloadFilesDirectory This property is required. string
Specifies a location to store the payload file for an AS2 message.
StatusFilesDirectory This property is required. string
Specifies a location to store the status file for an AS2 message.
TemporaryFilesDirectory This property is required. string
Specifies a location to store the temporary processing file for an AS2 message.
FailedFilesDirectory This property is required. string
Specifies a location to store the failed files for an AS2 message.
MdnFilesDirectory This property is required. string
Specifies a location to store the MDN file for an AS2 message.
PayloadFilesDirectory This property is required. string
Specifies a location to store the payload file for an AS2 message.
StatusFilesDirectory This property is required. string
Specifies a location to store the status file for an AS2 message.
TemporaryFilesDirectory This property is required. string
Specifies a location to store the temporary processing file for an AS2 message.
failedFilesDirectory This property is required. String
Specifies a location to store the failed files for an AS2 message.
mdnFilesDirectory This property is required. String
Specifies a location to store the MDN file for an AS2 message.
payloadFilesDirectory This property is required. String
Specifies a location to store the payload file for an AS2 message.
statusFilesDirectory This property is required. String
Specifies a location to store the status file for an AS2 message.
temporaryFilesDirectory This property is required. String
Specifies a location to store the temporary processing file for an AS2 message.
failedFilesDirectory This property is required. string
Specifies a location to store the failed files for an AS2 message.
mdnFilesDirectory This property is required. string
Specifies a location to store the MDN file for an AS2 message.
payloadFilesDirectory This property is required. string
Specifies a location to store the payload file for an AS2 message.
statusFilesDirectory This property is required. string
Specifies a location to store the status file for an AS2 message.
temporaryFilesDirectory This property is required. string
Specifies a location to store the temporary processing file for an AS2 message.
failed_files_directory This property is required. str
Specifies a location to store the failed files for an AS2 message.
mdn_files_directory This property is required. str
Specifies a location to store the MDN file for an AS2 message.
payload_files_directory This property is required. str
Specifies a location to store the payload file for an AS2 message.
status_files_directory This property is required. str
Specifies a location to store the status file for an AS2 message.
temporary_files_directory This property is required. str
Specifies a location to store the temporary processing file for an AS2 message.
failedFilesDirectory This property is required. String
Specifies a location to store the failed files for an AS2 message.
mdnFilesDirectory This property is required. String
Specifies a location to store the MDN file for an AS2 message.
payloadFilesDirectory This property is required. String
Specifies a location to store the payload file for an AS2 message.
statusFilesDirectory This property is required. String
Specifies a location to store the status file for an AS2 message.
temporaryFilesDirectory This property is required. String
Specifies a location to store the temporary processing file for an AS2 message.

Tag

Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag
key This property is required. string
The key name of the tag
value This property is required. string
The value of the tag
key This property is required. str
The key name of the tag
value This property is required. str
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native