software.amazon.awscdk.services.transfer

Class CfnConnector

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.CfnConnector

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

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

A CloudFormation `AWS::Transfer::Connector`.

Creates the connector, which captures the parameters for an outbound connection for the AS2 protocol. The connector is required for sending files to an externally hosted AS2 server. For more details about connectors, see Create AS2 connectors .

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.*;
 Object as2Config;
 CfnConnector cfnConnector = CfnConnector.Builder.create(this, "MyCfnConnector")
         .accessRole("accessRole")
         .as2Config(as2Config)
         .url("url")
         // the properties below are optional
         .loggingRole("loggingRole")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CfnConnector.As2ConfigProperty Example:
static class	CfnConnector.Builder A fluent builder for CfnConnector.

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
	CfnConnector(Construct scope, java.lang.String id, CfnConnectorProps props) Create a new `AWS::Transfer::Connector`.
protected	CfnConnector(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnConnector(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.Object	getAs2Config() A structure that contains the parameters for a connector object.
java.lang.String	getAttrArn()
java.lang.String	getAttrConnectorId()
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getLoggingRole() The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that allows a connector to turn on CloudWatch logging for Amazon S3 events.
TagManager	getTags() Key-value pairs that can be used to group and search for connectors.
java.lang.String	getUrl() The URL of the partner's AS2 endpoint.
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	setAs2Config(java.lang.Object value) A structure that contains the parameters for a connector object.
void	setLoggingRole(java.lang.String value) The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that allows a connector to turn on CloudWatch logging for Amazon S3 events.
void	setUrl(java.lang.String value) The URL of the partner's AS2 endpoint.

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

CfnConnector

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

CfnConnector

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

CfnConnector

public CfnConnector(Construct scope,
                    java.lang.String id,
                    CfnConnectorProps props)

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

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.

getAttrArn

public java.lang.String getAttrArn()

getAttrConnectorId

public java.lang.String getAttrConnectorId()

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 connectors.

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 .

getAs2Config

public java.lang.Object getAs2Config()

A structure that contains the parameters for a connector object.

setAs2Config

public void setAs2Config(java.lang.Object value)

A structure that contains the parameters for a connector object.

getUrl

public java.lang.String getUrl()

The URL of the partner's AS2 endpoint.

setUrl

public void setUrl(java.lang.String value)

The URL of the partner's AS2 endpoint.

getLoggingRole

public java.lang.String getLoggingRole()

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that allows a connector to turn on CloudWatch logging for Amazon S3 events.

When set, you can view connector activity in your CloudWatch logs.

setLoggingRole

public void setLoggingRole(java.lang.String value)

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that allows a connector to turn on CloudWatch logging for Amazon S3 events.

When set, you can view connector activity in your CloudWatch logs.