@Generated(value="software.amazon.awssdk:codegen") public final class CreateConnectorRequest extends TransferRequest implements ToCopyableBuilder<CreateConnectorRequest.Builder,CreateConnectorRequest>
| Modifier and Type | Class and Description |
|---|---|
static interface |
CreateConnectorRequest.Builder |
| Modifier and Type | Method and Description |
|---|---|
String |
accessRole()
Connectors are used to send files using either the AS2 or SFTP protocol.
|
As2ConnectorConfig |
as2Config()
A structure that contains the parameters for an AS2 connector object.
|
static CreateConnectorRequest.Builder |
builder() |
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
boolean |
hasTags()
For responses, this returns true if the service returned a value for the Tags property.
|
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 CreateConnectorRequest.Builder> |
serializableBuilderClass() |
SftpConnectorConfig |
sftpConfig()
A structure that contains the parameters for an SFTP connector object.
|
List<Tag> |
tags()
Key-value pairs that can be used to group and search for connectors.
|
CreateConnectorRequest.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
String |
url()
The URL of the partner's AS2 or SFTP endpoint.
|
overrideConfigurationclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final String url()
The URL of the partner's AS2 or SFTP endpoint.
public final As2ConnectorConfig as2Config()
A structure that contains the parameters for an AS2 connector object.
public final String accessRole()
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 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 Amazon Web Services 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 Secrets Manager.
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 Amazon Web Services 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 Secrets Manager.
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.
public final boolean hasTags()
isEmpty() method on the property). This is useful
because the SDK will never return a null collection or map, but you may need to differentiate between the service
returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true
if a value for the property was specified in the request builder, and false if a value was not specified.public final List<Tag> tags()
Key-value pairs that can be used to group and search for connectors. Tags are metadata attached to connectors for any purpose.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasTags() method.
public final SftpConnectorConfig sftpConfig()
A structure that contains the parameters for an SFTP connector object.
public CreateConnectorRequest.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<CreateConnectorRequest.Builder,CreateConnectorRequest>toBuilder in class TransferRequestpublic static CreateConnectorRequest.Builder builder()
public static Class<? extends CreateConnectorRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField in class SdkRequestCopyright © 2023. All rights reserved.