@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class CreateConnectorRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
CreateConnectorRequest() |
Modifier and Type | Method and Description |
---|---|
CreateConnectorRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
String |
getAccessRole()
Connectors are used to send files using either the AS2 or SFTP protocol.
|
As2ConnectorConfig |
getAs2Config()
A structure that contains the parameters for an AS2 connector object.
|
String |
getLoggingRole()
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.
|
String |
getSecurityPolicyName()
Specifies the name of the security policy for the connector.
|
SftpConnectorConfig |
getSftpConfig()
A structure that contains the parameters for an SFTP connector object.
|
List<Tag> |
getTags()
Key-value pairs that can be used to group and search for connectors.
|
String |
getUrl()
The URL of the partner's AS2 or SFTP endpoint.
|
int |
hashCode() |
void |
setAccessRole(String accessRole)
Connectors are used to send files using either the AS2 or SFTP protocol.
|
void |
setAs2Config(As2ConnectorConfig as2Config)
A structure that contains the parameters for an AS2 connector object.
|
void |
setLoggingRole(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.
|
void |
setSecurityPolicyName(String securityPolicyName)
Specifies the name of the security policy for the connector.
|
void |
setSftpConfig(SftpConnectorConfig sftpConfig)
A structure that contains the parameters for an SFTP connector object.
|
void |
setTags(Collection<Tag> tags)
Key-value pairs that can be used to group and search for connectors.
|
void |
setUrl(String url)
The URL of the partner's AS2 or SFTP endpoint.
|
String |
toString()
Returns a string representation of this object.
|
CreateConnectorRequest |
withAccessRole(String accessRole)
Connectors are used to send files using either the AS2 or SFTP protocol.
|
CreateConnectorRequest |
withAs2Config(As2ConnectorConfig as2Config)
A structure that contains the parameters for an AS2 connector object.
|
CreateConnectorRequest |
withLoggingRole(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.
|
CreateConnectorRequest |
withSecurityPolicyName(String securityPolicyName)
Specifies the name of the security policy for the connector.
|
CreateConnectorRequest |
withSftpConfig(SftpConnectorConfig sftpConfig)
A structure that contains the parameters for an SFTP connector object.
|
CreateConnectorRequest |
withTags(Collection<Tag> tags)
Key-value pairs that can be used to group and search for connectors.
|
CreateConnectorRequest |
withTags(Tag... tags)
Key-value pairs that can be used to group and search for connectors.
|
CreateConnectorRequest |
withUrl(String url)
The URL of the partner's AS2 or SFTP endpoint.
|
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public void setUrl(String url)
The URL of the partner's AS2 or SFTP endpoint.
url
- The URL of the partner's AS2 or SFTP endpoint.public String getUrl()
The URL of the partner's AS2 or SFTP endpoint.
public CreateConnectorRequest withUrl(String url)
The URL of the partner's AS2 or SFTP endpoint.
url
- The URL of the partner's AS2 or SFTP endpoint.public void setAs2Config(As2ConnectorConfig as2Config)
A structure that contains the parameters for an AS2 connector object.
as2Config
- A structure that contains the parameters for an AS2 connector object.public As2ConnectorConfig getAs2Config()
A structure that contains the parameters for an AS2 connector object.
public CreateConnectorRequest withAs2Config(As2ConnectorConfig as2Config)
A structure that contains the parameters for an AS2 connector object.
as2Config
- A structure that contains the parameters for an AS2 connector object.public void setAccessRole(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.
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.
public String getAccessRole()
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 CreateConnectorRequest withAccessRole(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.
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.
public void setLoggingRole(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.
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 String getLoggingRole()
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 CreateConnectorRequest withLoggingRole(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.
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 List<Tag> getTags()
Key-value pairs that can be used to group and search for connectors. Tags are metadata attached to connectors for any purpose.
public void setTags(Collection<Tag> tags)
Key-value pairs that can be used to group and search for connectors. Tags are metadata attached to connectors for any purpose.
tags
- Key-value pairs that can be used to group and search for connectors. Tags are metadata attached to
connectors for any purpose.public CreateConnectorRequest withTags(Tag... tags)
Key-value pairs that can be used to group and search for connectors. Tags are metadata attached to connectors for any purpose.
NOTE: This method appends the values to the existing list (if any). Use
setTags(java.util.Collection)
or withTags(java.util.Collection)
if you want to override the
existing values.
tags
- Key-value pairs that can be used to group and search for connectors. Tags are metadata attached to
connectors for any purpose.public CreateConnectorRequest withTags(Collection<Tag> tags)
Key-value pairs that can be used to group and search for connectors. Tags are metadata attached to connectors for any purpose.
tags
- Key-value pairs that can be used to group and search for connectors. Tags are metadata attached to
connectors for any purpose.public void setSftpConfig(SftpConnectorConfig sftpConfig)
A structure that contains the parameters for an SFTP connector object.
sftpConfig
- A structure that contains the parameters for an SFTP connector object.public SftpConnectorConfig getSftpConfig()
A structure that contains the parameters for an SFTP connector object.
public CreateConnectorRequest withSftpConfig(SftpConnectorConfig sftpConfig)
A structure that contains the parameters for an SFTP connector object.
sftpConfig
- A structure that contains the parameters for an SFTP connector object.public void setSecurityPolicyName(String securityPolicyName)
Specifies the name of the security policy for the connector.
securityPolicyName
- Specifies the name of the security policy for the connector.public String getSecurityPolicyName()
Specifies the name of the security policy for the connector.
public CreateConnectorRequest withSecurityPolicyName(String securityPolicyName)
Specifies the name of the security policy for the connector.
securityPolicyName
- Specifies the name of the security policy for the connector.public String toString()
toString
in class Object
Object.toString()
public CreateConnectorRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()