Package software.amazon.awscdk.cfnpropertymixins.services.transfer

Class CfnConnectorMixinProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.cfnpropertymixins.services.transfer.CfnConnectorMixinProps.Jsii$Proxy

All Implemented Interfaces:

CfnConnectorMixinProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnConnectorMixinProps

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

An implementation for CfnConnectorMixinProps

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.cfnpropertymixins.services.transfer.CfnConnectorMixinProps

CfnConnectorMixinProps.Builder, CfnConnectorMixinProps.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CfnConnectorMixinProps.Builder builder)	Constructor that initializes the object based on literal property values passed by the CfnConnectorMixinProps.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 Object	getAs2Config()	A structure that contains the parameters for an AS2 connector object.
final Object	getEgressConfig()	Current egress configuration of the connector, showing how traffic is routed to the SFTP server.
final String	getEgressType()	Type of egress configuration for the connector.
final 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.
final String	getSecurityPolicyName()	The text name of the security policy for the specified connector.
final Object	getSftpConfig()	A structure that contains the parameters for an SFTP connector object.
final List<CfnTag>	getTags()	Key-value pairs that can be used to group and search for connectors.
final String	getUrl()	The URL of the partner's AS2 or SFTP endpoint.
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(CfnConnectorMixinProps.Builder builder)

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

Method Details

getAccessRole

public final String getAccessRole()

Description copied from interface: CfnConnectorMixinProps

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 CfnConnectorMixinProps

See Also:

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

getAs2Config

public final Object getAs2Config()

Description copied from interface: CfnConnectorMixinProps

A structure that contains the parameters for an AS2 connector object.

Specified by:

getAs2Config in interface CfnConnectorMixinProps

See Also:

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

getEgressConfig

public final Object getEgressConfig()

Description copied from interface: CfnConnectorMixinProps

Current egress configuration of the connector, showing how traffic is routed to the SFTP server.

Contains VPC Lattice settings when using VPC_LATTICE egress type.

When using the VPC_LATTICE egress type, AWS Transfer Family uses a managed Service Network to simplify the resource sharing process.

Returns union: either IResolvable or CfnConnectorPropsMixin.ConnectorEgressConfigProperty

Specified by:

getEgressConfig in interface CfnConnectorMixinProps

See Also:

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

getEgressType

public final String getEgressType()

Description copied from interface: CfnConnectorMixinProps

Type of egress configuration for the connector.

SERVICE_MANAGED uses Transfer Family managed NAT gateways, while VPC_LATTICE routes traffic through customer VPCs using VPC Lattice.

Specified by:

getEgressType in interface CfnConnectorMixinProps

See Also:

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

getLoggingRole

public final String getLoggingRole()

Description copied from interface: CfnConnectorMixinProps

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.

Specified by:

getLoggingRole in interface CfnConnectorMixinProps

See Also:

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

getSecurityPolicyName

public final String getSecurityPolicyName()

Description copied from interface: CfnConnectorMixinProps

The text name of the security policy for the specified connector.

Specified by:

getSecurityPolicyName in interface CfnConnectorMixinProps

See Also:

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

getSftpConfig

public final Object getSftpConfig()

Description copied from interface: CfnConnectorMixinProps

A structure that contains the parameters for an SFTP connector object.

Returns union: either IResolvable or CfnConnectorPropsMixin.SftpConfigProperty

Specified by:

getSftpConfig in interface CfnConnectorMixinProps

See Also:

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

getTags

public final List<CfnTag> getTags()

Description copied from interface: CfnConnectorMixinProps

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

Specified by:

getTags in interface CfnConnectorMixinProps

See Also:

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

getUrl

public final String getUrl()

Description copied from interface: CfnConnectorMixinProps

The URL of the partner's AS2 or SFTP endpoint.

When creating AS2 connectors or service-managed SFTP connectors (connectors without egress configuration), you must provide a URL to specify the remote server endpoint. For VPC Lattice type connectors, the URL must be null.

Specified by:

getUrl in interface CfnConnectorMixinProps

See Also:

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

$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