Package software.amazon.awssdk.services.transfer.model

Class DescribedConnector

    • Method Detail

      • arn

        public final String arn()

        The unique Amazon Resource Name (ARN) for the connector.

        Returns:
        The unique Amazon Resource Name (ARN) for the connector.

      • 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 or SFTP endpoint.

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

      • as2Config

        public final As2ConnectorConfig as2Config()

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

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

      • accessRole

        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.

        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.

      • 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.

      • hasTags

        public final boolean hasTags()
        For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

      • tags

        public final List<Tag> tags()

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

        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.

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

      • sftpConfig

        public final SftpConnectorConfig sftpConfig()

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

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

      • hasServiceManagedEgressIpAddresses

        public final boolean hasServiceManagedEgressIpAddresses()
        For responses, this returns true if the service returned a value for the ServiceManagedEgressIpAddresses property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

      • serviceManagedEgressIpAddresses

        public final List<String> serviceManagedEgressIpAddresses()

        The list of egress IP addresses of this connector. These IP addresses are assigned automatically when you create the connector.

        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 hasServiceManagedEgressIpAddresses() method.

        Returns:
        The list of egress IP addresses of this connector. These IP addresses are assigned automatically when you create the connector.

      • securityPolicyName

        public final String securityPolicyName()

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

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

      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object

      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object

      • 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)