DescribedConnector (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.transfer.model.DescribedConnector

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DescribedConnector
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Describes the parameters for the connector, as identified by the ConnectorId.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

DescribedConnector()

Constructors
Constructor and Description
`DescribedConnector()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DescribedConnector`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getAccessRole()` Connectors are used to send files using either the AS2 or SFTP protocol.
`String`	`getArn()` The unique Amazon Resource Name (ARN) for the connector.
`As2ConnectorConfig`	`getAs2Config()` A structure that contains the parameters for an AS2 connector object.
`String`	`getConnectorId()` The unique identifier for the connector.
`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()` The text name of the security policy for the specified connector.
`List<String>`	`getServiceManagedEgressIpAddresses()` The list of egress IP addresses of this 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`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAccessRole(String accessRole)` Connectors are used to send files using either the AS2 or SFTP protocol.
`void`	`setArn(String arn)` The unique Amazon Resource Name (ARN) for the connector.
`void`	`setAs2Config(As2ConnectorConfig as2Config)` A structure that contains the parameters for an AS2 connector object.
`void`	`setConnectorId(String connectorId)` The unique identifier for the connector.
`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)` The text name of the security policy for the specified connector.
`void`	`setServiceManagedEgressIpAddresses(Collection<String> serviceManagedEgressIpAddresses)` The list of egress IP addresses of this 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.
`DescribedConnector`	`withAccessRole(String accessRole)` Connectors are used to send files using either the AS2 or SFTP protocol.
`DescribedConnector`	`withArn(String arn)` The unique Amazon Resource Name (ARN) for the connector.
`DescribedConnector`	`withAs2Config(As2ConnectorConfig as2Config)` A structure that contains the parameters for an AS2 connector object.
`DescribedConnector`	`withConnectorId(String connectorId)` The unique identifier for the connector.
`DescribedConnector`	`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.
`DescribedConnector`	`withSecurityPolicyName(String securityPolicyName)` The text name of the security policy for the specified connector.
`DescribedConnector`	`withServiceManagedEgressIpAddresses(Collection<String> serviceManagedEgressIpAddresses)` The list of egress IP addresses of this connector.
`DescribedConnector`	`withServiceManagedEgressIpAddresses(String... serviceManagedEgressIpAddresses)` The list of egress IP addresses of this connector.
`DescribedConnector`	`withSftpConfig(SftpConnectorConfig sftpConfig)` A structure that contains the parameters for an SFTP connector object.
`DescribedConnector`	`withTags(Collection<Tag> tags)` Key-value pairs that can be used to group and search for connectors.
`DescribedConnector`	`withTags(Tag... tags)` Key-value pairs that can be used to group and search for connectors.
`DescribedConnector`	`withUrl(String url)` The URL of the partner's AS2 or SFTP endpoint.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - DescribedConnector
```
public DescribedConnector()
```
- Method Detail
  - setArn
```
public void setArn(String arn)
```
    The unique Amazon Resource Name (ARN) for the connector.
    
    Parameters:
    
    arn - The unique Amazon Resource Name (ARN) for the connector.
  - getArn
```
public String getArn()
```
    The unique Amazon Resource Name (ARN) for the connector.
    
    Returns:
    
    The unique Amazon Resource Name (ARN) for the connector.
  - withArn
```
public DescribedConnector withArn(String arn)
```
    The unique Amazon Resource Name (ARN) for the connector.
    
    Parameters:
    
    arn - The unique Amazon Resource Name (ARN) for the connector.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setConnectorId
```
public void setConnectorId(String connectorId)
```
    The unique identifier for the connector.
    
    Parameters:
    
    connectorId - The unique identifier for the connector.
  - getConnectorId
```
public String getConnectorId()
```
    The unique identifier for the connector.
    
    Returns:
    
    The unique identifier for the connector.
  - withConnectorId
```
public DescribedConnector withConnectorId(String connectorId)
```
    The unique identifier for the connector.
    
    Parameters:
    
    connectorId - The unique identifier for the connector.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setUrl
```
public void setUrl(String url)
```
    The URL of the partner's AS2 or SFTP endpoint.
    
    Parameters:
    
    url - The URL of the partner's AS2 or SFTP endpoint.
  - getUrl
```
public String getUrl()
```
    The URL of the partner's AS2 or SFTP endpoint.
    
    Returns:
    
    The URL of the partner's AS2 or SFTP endpoint.
  - withUrl
```
public DescribedConnector withUrl(String url)
```
    The URL of the partner's AS2 or SFTP endpoint.
    
    Parameters:
    
    url - The URL of the partner's AS2 or SFTP endpoint.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAs2Config
```
public void setAs2Config(As2ConnectorConfig as2Config)
```
    A structure that contains the parameters for an AS2 connector object.
    
    Parameters:
    
    as2Config - A structure that contains the parameters for an AS2 connector object.
  - getAs2Config
```
public As2ConnectorConfig getAs2Config()
```
    A structure that contains the parameters for an AS2 connector object.
    
    Returns:
    
    A structure that contains the parameters for an AS2 connector object.
  - withAs2Config
```
public DescribedConnector withAs2Config(As2ConnectorConfig as2Config)
```
    A structure that contains the parameters for an AS2 connector object.
    
    Parameters:
    
    as2Config - A structure that contains the parameters for an AS2 connector object.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAccessRole
```
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.
    
    Parameters:
    
    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.
  - getAccessRole
```
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.
    
    Returns:
    
    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.
  - withAccessRole
```
public DescribedConnector 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLoggingRole
```
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.
    
    Parameters:
    
    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.
  - getLoggingRole
```
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.
    
    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.
  - withLoggingRole
```
public DescribedConnector 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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTags
```
public List<Tag> getTags()
```
    Key-value pairs that can be used to group and search for connectors.
    
    Returns:
    
    Key-value pairs that can be used to group and search for connectors.
  - setTags
```
public void setTags(Collection<Tag> tags)
```
    Key-value pairs that can be used to group and search for connectors.
    
    Parameters:
    
    tags - Key-value pairs that can be used to group and search for connectors.
  - withTags
```
public DescribedConnector withTags(Tag... tags)
```
    Key-value pairs that can be used to group and search for connectors.
    
    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.
    
    Parameters:
    
    tags - Key-value pairs that can be used to group and search for connectors.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTags
```
public DescribedConnector withTags(Collection<Tag> tags)
```
    Key-value pairs that can be used to group and search for connectors.
    
    Parameters:
    
    tags - Key-value pairs that can be used to group and search for connectors.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSftpConfig
```
public void setSftpConfig(SftpConnectorConfig sftpConfig)
```
    A structure that contains the parameters for an SFTP connector object.
    
    Parameters:
    
    sftpConfig - A structure that contains the parameters for an SFTP connector object.
  - getSftpConfig
```
public SftpConnectorConfig getSftpConfig()
```
    A structure that contains the parameters for an SFTP connector object.
    
    Returns:
    
    A structure that contains the parameters for an SFTP connector object.
  - withSftpConfig
```
public DescribedConnector withSftpConfig(SftpConnectorConfig sftpConfig)
```
    A structure that contains the parameters for an SFTP connector object.
    
    Parameters:
    
    sftpConfig - A structure that contains the parameters for an SFTP connector object.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getServiceManagedEgressIpAddresses
```
public List<String> getServiceManagedEgressIpAddresses()
```
    The list of egress IP addresses of this connector. These IP addresses are assigned automatically when you create the connector.
    
    Returns:
    
    The list of egress IP addresses of this connector. These IP addresses are assigned automatically when you create the connector.
  - setServiceManagedEgressIpAddresses
```
public void setServiceManagedEgressIpAddresses(Collection<String> serviceManagedEgressIpAddresses)
```
    The list of egress IP addresses of this connector. These IP addresses are assigned automatically when you create the connector.
    
    Parameters:
    
    serviceManagedEgressIpAddresses - The list of egress IP addresses of this connector. These IP addresses are assigned automatically when you create the connector.
  - withServiceManagedEgressIpAddresses
```
public DescribedConnector withServiceManagedEgressIpAddresses(String... serviceManagedEgressIpAddresses)
```
    The list of egress IP addresses of this connector. These IP addresses are assigned automatically when you create the connector.
    
    NOTE: This method appends the values to the existing list (if any). Use setServiceManagedEgressIpAddresses(java.util.Collection) or withServiceManagedEgressIpAddresses(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    serviceManagedEgressIpAddresses - The list of egress IP addresses of this connector. These IP addresses are assigned automatically when you create the connector.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withServiceManagedEgressIpAddresses
```
public DescribedConnector withServiceManagedEgressIpAddresses(Collection<String> serviceManagedEgressIpAddresses)
```
    The list of egress IP addresses of this connector. These IP addresses are assigned automatically when you create the connector.
    
    Parameters:
    
    serviceManagedEgressIpAddresses - The list of egress IP addresses of this connector. These IP addresses are assigned automatically when you create the connector.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSecurityPolicyName
```
public void setSecurityPolicyName(String securityPolicyName)
```
    The text name of the security policy for the specified connector.
    
    Parameters:
    
    securityPolicyName - The text name of the security policy for the specified connector.
  - getSecurityPolicyName
```
public String getSecurityPolicyName()
```
    The text name of the security policy for the specified connector.
    
    Returns:
    
    The text name of the security policy for the specified connector.
  - withSecurityPolicyName
```
public DescribedConnector withSecurityPolicyName(String securityPolicyName)
```
    The text name of the security policy for the specified connector.
    
    Parameters:
    
    securityPolicyName - The text name of the security policy for the specified connector.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public DescribedConnector clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.780

Class DescribedConnector

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DescribedConnector

Method Detail

setArn

getArn

withArn

setConnectorId

getConnectorId

withConnectorId

setUrl

getUrl

withUrl

setAs2Config

getAs2Config

withAs2Config

setAccessRole

getAccessRole

withAccessRole

setLoggingRole

getLoggingRole

withLoggingRole

getTags

setTags

withTags

withTags

setSftpConfig

getSftpConfig

withSftpConfig

getServiceManagedEgressIpAddresses

setServiceManagedEgressIpAddresses

withServiceManagedEgressIpAddresses

withServiceManagedEgressIpAddresses

setSecurityPolicyName

getSecurityPolicyName

withSecurityPolicyName

toString

equals

hashCode

clone

marshall