Package software.amazon.awscdk.services.transfer

Class CfnAgreementProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.transfer.CfnAgreementProps.Jsii$Proxy

All Implemented Interfaces:

CfnAgreementProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnAgreementProps

@Stability(Stable)
@Internal
public static final class CfnAgreementProps.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements CfnAgreementProps

An implementation for CfnAgreementProps

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.transfer.CfnAgreementProps

CfnAgreementProps.Builder, CfnAgreementProps.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CfnAgreementProps.Builder builder)	Constructor that initializes the object based on literal property values passed by the CfnAgreementProps.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final String	getAccessRole()	Connectors are used to send files using either the AS2 or SFTP protocol.
final String	getBaseDirectory()	The landing directory (folder) for files that are transferred by using the AS2 protocol.
final Object	getCustomDirectories()	A CustomDirectoriesType structure.
final String	getDescription()	The name or short description that's used to identify the agreement.
final String	getEnforceMessageSigning()	Determines whether or not unsigned messages from your trading partners will be accepted.
final String	getLocalProfileId()	A unique identifier for the AS2 local profile.
final String	getPartnerProfileId()	A unique identifier for the partner profile used in the agreement.
final String	getPreserveFilename()	Determines whether or not Transfer Family appends a unique string of characters to the end of the AS2 message payload filename when saving it.
final String	getServerId()	A system-assigned unique identifier for a server instance.
final String	getStatus()	The current status of the agreement, either ACTIVE or INACTIVE .
final List<CfnTag>	getTags()	Key-value pairs that can be used to group and search for agreements.
final int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(CfnAgreementProps.Builder builder)

Constructor that initializes the object based on literal property values passed by the CfnAgreementProps.Builder.

Method Details

getAccessRole

public final String getAccessRole()

Description copied from interface: CfnAgreementProps

Connectors are used to send files using either the AS2 or SFTP protocol.

For the access role, provide the Amazon Resource Name (ARN) of the AWS Identity and Access Management role to use.

For AS2 connectors

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 .

If you are using Basic authentication for your AS2 connector, the access role requires the secretsmanager:GetSecretValue permission for the secret. If the secret is encrypted using a customer-managed key instead of the AWS managed key in Secrets Manager, then the role also needs the kms:Decrypt permission for that key.

For SFTP connectors

Make sure that the access role provides read and write access to the parent directory of the file location that's used in the StartFileTransfer request. Additionally, make sure that the role provides secretsmanager:GetSecretValue permission to AWS Secrets Manager .

Specified by:

getAccessRole in interface CfnAgreementProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-agreement.html#cfn-transfer-agreement-accessrole

getLocalProfileId

public final String getLocalProfileId()

Description copied from interface: CfnAgreementProps

A unique identifier for the AS2 local profile.

Specified by:

getLocalProfileId in interface CfnAgreementProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-agreement.html#cfn-transfer-agreement-localprofileid

getPartnerProfileId

public final String getPartnerProfileId()

Description copied from interface: CfnAgreementProps

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

Specified by:

getPartnerProfileId in interface CfnAgreementProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-agreement.html#cfn-transfer-agreement-partnerprofileid

getServerId

public final String getServerId()

Description copied from interface: CfnAgreementProps

A system-assigned unique identifier for a server instance.

This identifier indicates the specific server that the agreement uses.

Specified by:

getServerId in interface CfnAgreementProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-agreement.html#cfn-transfer-agreement-serverid

getBaseDirectory

public final String getBaseDirectory()

Description copied from interface: CfnAgreementProps

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

Specified by:

getBaseDirectory in interface CfnAgreementProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-agreement.html#cfn-transfer-agreement-basedirectory

getCustomDirectories

public final Object getCustomDirectories()

Description copied from interface: CfnAgreementProps

A CustomDirectoriesType structure.

This structure specifies custom directories for storing various AS2 message files. You can specify directories for the following types of files.

• Failed files
• MDN files
• Payload files
• Status files
• Temporary files

Returns union: either IResolvable or CfnAgreement.CustomDirectoriesProperty

Specified by:

getCustomDirectories in interface CfnAgreementProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-agreement.html#cfn-transfer-agreement-customdirectories

getDescription

public final String getDescription()

Description copied from interface: CfnAgreementProps

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

Specified by:

getDescription in interface CfnAgreementProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-agreement.html#cfn-transfer-agreement-description

getEnforceMessageSigning

public final String getEnforceMessageSigning()

Description copied from interface: CfnAgreementProps

Determines whether or not unsigned messages from your trading partners will be accepted.

• ENABLED : Transfer Family rejects unsigned messages from your trading partner.
• DISABLED (default value): Transfer Family accepts unsigned messages from your trading partner.

Specified by:

getEnforceMessageSigning in interface CfnAgreementProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-agreement.html#cfn-transfer-agreement-enforcemessagesigning

getPreserveFilename

public final String getPreserveFilename()

Description copied from interface: CfnAgreementProps

Determines whether or not Transfer Family appends a unique string of characters to the end of the AS2 message payload filename when saving it.

• ENABLED : the filename provided by your trading parter is preserved when the file is saved.
• DISABLED (default value): when Transfer Family saves the file, the filename is adjusted, as described in File names and locations .

Specified by:

getPreserveFilename in interface CfnAgreementProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-agreement.html#cfn-transfer-agreement-preservefilename

getStatus

public final String getStatus()

Description copied from interface: CfnAgreementProps

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

Specified by:

getStatus in interface CfnAgreementProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-agreement.html#cfn-transfer-agreement-status

getTags

public final List<CfnTag> getTags()

Description copied from interface: CfnAgreementProps

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

Specified by:

getTags in interface CfnAgreementProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-agreement.html#cfn-transfer-agreement-tags

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object