Class CfnAgreement
- All Implemented Interfaces:
IConstruct
,IDependable
,IInspectable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
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 ClassesNested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ConstructorsModifierConstructorDescriptionCfnAgreement
(Construct scope, String id, CfnAgreementProps props) Create a newAWS::Transfer::Agreement
.protected
CfnAgreement
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnAgreement
(software.amazon.jsii.JsiiObjectRef objRef) -
Method Summary
Modifier and TypeMethodDescriptionWith AS2, you can send files by callingStartFileTransfer
and specifying the file paths in the request parameter,SendFilePaths
.The unique identifier for the AS2 agreement, returned after the API call succeeds.The landing directory (folder) for files that are transferred by using the AS2 protocol.The name or short description that's used to identify the agreement.A unique identifier for the AS2 local profile.A unique identifier for the partner profile used in the agreement.A system-assigned unique identifier for a server instance.The current status of the agreement, eitherACTIVE
orINACTIVE
.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.renderProperties
(Map<String, Object> props) void
setAccessRole
(String value) With AS2, you can send files by callingStartFileTransfer
and specifying the file paths in the request parameter,SendFilePaths
.void
setBaseDirectory
(String value) The landing directory (folder) for files that are transferred by using the AS2 protocol.void
setDescription
(String value) The name or short description that's used to identify the agreement.void
setLocalProfileId
(String value) A unique identifier for the AS2 local profile.void
setPartnerProfileId
(String value) A unique identifier for the partner profile used in the agreement.void
setServerId
(String value) A system-assigned unique identifier for a server instance.void
The current status of the agreement, eitherACTIVE
orINACTIVE
.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 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, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
-
-
Constructor Details
-
CfnAgreement
protected CfnAgreement(software.amazon.jsii.JsiiObjectRef objRef) -
CfnAgreement
protected CfnAgreement(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnAgreement
@Stability(Stable) public CfnAgreement(@NotNull Construct scope, @NotNull String id, @NotNull CfnAgreementProps props) Create a newAWS::Transfer::Agreement
.- Parameters:
scope
-- scope in which this resource is defined.
id
-- scoped id of the resource.
props
-- resource properties.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- Parameters:
inspector
-- tree inspector to collect and process attributes.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderProperties
in classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrAgreementId
The unique identifier for the AS2 agreement, returned after the API call succeeds. -
getAttrArn
-
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getTags
Key-value pairs that can be used to group and search for agreements. -
getAccessRole
With AS2, you can send files by callingStartFileTransfer
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, theAccessRole
needs to provide read and write access to the parent directory of the file location used in theStartFileTransfer
request. Additionally, you need to provide read and write access to the parent directory of the files that you intend to send withStartFileTransfer
. -
setAccessRole
With AS2, you can send files by callingStartFileTransfer
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, theAccessRole
needs to provide read and write access to the parent directory of the file location used in theStartFileTransfer
request. Additionally, you need to provide read and write access to the parent directory of the files that you intend to send withStartFileTransfer
. -
getBaseDirectory
The landing directory (folder) for files that are transferred by using the AS2 protocol. -
setBaseDirectory
The landing directory (folder) for files that are transferred by using the AS2 protocol. -
getLocalProfileId
A unique identifier for the AS2 local profile. -
setLocalProfileId
A unique identifier for the AS2 local profile. -
getPartnerProfileId
A unique identifier for the partner profile used in the agreement. -
setPartnerProfileId
A unique identifier for the partner profile used in the agreement. -
getServerId
A system-assigned unique identifier for a server instance.This identifier indicates the specific server that the agreement uses.
-
setServerId
A system-assigned unique identifier for a server instance.This identifier indicates the specific server that the agreement uses.
-
getDescription
The name or short description that's used to identify the agreement. -
setDescription
The name or short description that's used to identify the agreement. -
getStatus
The current status of the agreement, eitherACTIVE
orINACTIVE
. -
setStatus
The current status of the agreement, eitherACTIVE
orINACTIVE
.
-