software.amazon.awssdk.services.transfer.model

Class UpdateConnectorRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.transfer.model.TransferRequest

software.amazon.awssdk.services.transfer.model.UpdateConnectorRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateConnectorRequest.Builder,UpdateConnectorRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class UpdateConnectorRequest
extends TransferRequest
implements ToCopyableBuilder<UpdateConnectorRequest.Builder,UpdateConnectorRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UpdateConnectorRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	accessRole() With AS2, you can send files by calling StartFileTransfer and specifying the file paths in the request parameter, SendFilePaths.
As2ConnectorConfig	as2Config() A structure that contains the parameters for a connector object.
static UpdateConnectorRequest.Builder	builder()
String	connectorId() The unique identifier for the connector.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	loggingRole() The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a connector to turn on CloudWatch logging for Amazon S3 events.
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateConnectorRequest.Builder>	serializableBuilderClass()
UpdateConnectorRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	url() The URL of the partner's AS2 endpoint.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

connectorId

public final String connectorId()

The unique identifier for the connector.

Returns:

The unique identifier for the connector.

url

public final String url()

The URL of the partner's AS2 endpoint.

Returns:

The URL of the partner's AS2 endpoint.

as2Config

public final As2ConnectorConfig as2Config()

A structure that contains the parameters for a connector object.

Returns:

A structure that contains the parameters for a connector object.

accessRole

public final String accessRole()

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.

Returns:

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.

loggingRole

public final String loggingRole()

The Amazon Resource Name (ARN) of the 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.

Returns:

The Amazon Resource Name (ARN) of the 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.

toBuilder

public UpdateConnectorRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateConnectorRequest.Builder,UpdateConnectorRequest>

Specified by:

toBuilder in class TransferRequest

builder

public static UpdateConnectorRequest.Builder builder()

serializableBuilderClass

public static Class<? extends UpdateConnectorRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo