software.amazon.awscdk.services.transfer

Class CfnAgreement

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.transfer.CfnAgreement

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:40.257Z")
public class CfnAgreement
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Transfer::Agreement`.

Creates an agreement. An agreement is a bilateral trading partner agreement, or partnership, between an AWS Transfer Family server and an AS2 process. The agreement defines the file and message transfer relationship between the server and the AS2 process. To define an agreement, Transfer Family combines a server, local profile, partner profile, certificate, and other attributes.

The partner is identified with the PartnerProfileId , and the AS2 process is identified with the LocalProfileId .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.transfer.*;
 CfnAgreement cfnAgreement = CfnAgreement.Builder.create(this, "MyCfnAgreement")
         .accessRole("accessRole")
         .baseDirectory("baseDirectory")
         .localProfileId("localProfileId")
         .partnerProfileId("partnerProfileId")
         .serverId("serverId")
         // the properties below are optional
         .description("description")
         .status("status")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnAgreement.Builder A fluent builder for CfnAgreement.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnAgreement(Construct scope, java.lang.String id, CfnAgreementProps props) Create a new `AWS::Transfer::Agreement`.
protected	CfnAgreement(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnAgreement(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAccessRole() With AS2, you can send files by calling `StartFileTransfer` and specifying the file paths in the request parameter, `SendFilePaths` .
java.lang.String	getAttrAgreementId()
java.lang.String	getAttrArn()
java.lang.String	getBaseDirectory() The landing directory (folder) for files that are transferred by using the AS2 protocol.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getDescription() The name or short description that's used to identify the agreement.
java.lang.String	getLocalProfileId() A unique identifier for the AS2 local profile.
java.lang.String	getPartnerProfileId() A unique identifier for the partner profile used in the agreement.
java.lang.String	getServerId() A system-assigned unique identifier for a server instance.
java.lang.String	getStatus() The current status of the agreement, either `ACTIVE` or `INACTIVE` .
TagManager	getTags() Key-value pairs that can be used to group and search for agreements.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setAccessRole(java.lang.String value) With AS2, you can send files by calling `StartFileTransfer` and specifying the file paths in the request parameter, `SendFilePaths` .
void	setBaseDirectory(java.lang.String value) The landing directory (folder) for files that are transferred by using the AS2 protocol.
void	setDescription(java.lang.String value) The name or short description that's used to identify the agreement.
void	setLocalProfileId(java.lang.String value) A unique identifier for the AS2 local profile.
void	setPartnerProfileId(java.lang.String value) A unique identifier for the partner profile used in the agreement.
void	setServerId(java.lang.String value) A system-assigned unique identifier for a server instance.
void	setStatus(java.lang.String value) The current status of the agreement, either `ACTIVE` or `INACTIVE` .

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnAgreement

protected CfnAgreement(software.amazon.jsii.JsiiObjectRef objRef)

CfnAgreement

protected CfnAgreement(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnAgreement

public CfnAgreement(Construct scope,
                    java.lang.String id,
                    CfnAgreementProps props)

Create a new `AWS::Transfer::Agreement`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

public void inspect(TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrAgreementId

public java.lang.String getAttrAgreementId()

getAttrArn

public java.lang.String getAttrArn()

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

public TagManager getTags()

Key-value pairs that can be used to group and search for agreements.

getAccessRole

public java.lang.String getAccessRole()

With AS2, you can send files by calling `StartFileTransfer` and specifying the file paths in the request parameter, `SendFilePaths` .

We use the file’s parent directory (for example, for --send-file-paths /bucket/dir/file.txt , parent directory is /bucket/dir/ ) to temporarily store a processed AS2 message file, store the MDN when we receive them from the partner, and write a final JSON file containing relevant metadata of the transmission. So, the AccessRole needs to provide read and write access to the parent directory of the file location used in the StartFileTransfer request. Additionally, you need to provide read and write access to the parent directory of the files that you intend to send with StartFileTransfer .

setAccessRole

public void setAccessRole(java.lang.String value)

With AS2, you can send files by calling `StartFileTransfer` and specifying the file paths in the request parameter, `SendFilePaths` .

We use the file’s parent directory (for example, for --send-file-paths /bucket/dir/file.txt , parent directory is /bucket/dir/ ) to temporarily store a processed AS2 message file, store the MDN when we receive them from the partner, and write a final JSON file containing relevant metadata of the transmission. So, the AccessRole needs to provide read and write access to the parent directory of the file location used in the StartFileTransfer request. Additionally, you need to provide read and write access to the parent directory of the files that you intend to send with StartFileTransfer .

getBaseDirectory

public java.lang.String getBaseDirectory()

The landing directory (folder) for files that are transferred by using the AS2 protocol.

setBaseDirectory

public void setBaseDirectory(java.lang.String value)

The landing directory (folder) for files that are transferred by using the AS2 protocol.

getLocalProfileId

public java.lang.String getLocalProfileId()

A unique identifier for the AS2 local profile.

setLocalProfileId

public void setLocalProfileId(java.lang.String value)

A unique identifier for the AS2 local profile.

getPartnerProfileId

public java.lang.String getPartnerProfileId()

A unique identifier for the partner profile used in the agreement.

setPartnerProfileId

public void setPartnerProfileId(java.lang.String value)

A unique identifier for the partner profile used in the agreement.

getServerId

public java.lang.String getServerId()

A system-assigned unique identifier for a server instance.

This identifier indicates the specific server that the agreement uses.

setServerId

public void setServerId(java.lang.String value)

A system-assigned unique identifier for a server instance.

This identifier indicates the specific server that the agreement uses.

getDescription

public java.lang.String getDescription()

The name or short description that's used to identify the agreement.

setDescription

public void setDescription(java.lang.String value)

The name or short description that's used to identify the agreement.

getStatus

public java.lang.String getStatus()

The current status of the agreement, either `ACTIVE` or `INACTIVE` .

setStatus

public void setStatus(java.lang.String value)

The current status of the agreement, either `ACTIVE` or `INACTIVE` .