Module aws_lambda_powertools.utilities.data_classes.transfer_family_event

Classes

class TransferFamilyAuthorizer (data: dict[str, Any], json_deserializer: Callable | None = None)

Expand source code

class TransferFamilyAuthorizer(DictWrapper):
    @property
    def username(self) -> str:
        """The username used for authentication"""
        return self["username"]

    @property
    def password(self) -> str | None:
        """
        The password used for authentication.
        None in case customer authenticating with certificates
        """
        return self["password"]

    @property
    def protocol(self) -> str:
        """The protocol can be SFTP, FTP or FTPS"""
        return self["protocol"]

    @property
    def server_id(self) -> str:
        """The AWS Transfer Family ServerID"""
        return self["serverId"]

    @property
    def source_ip(self) -> str:
        """The customer IP used for connection"""
        return self["sourceIp"]

Provides a single read only access to a wrapper dict

Parameters

data : dict[str, Any]

Lambda Event Source Event payload

json_deserializer : Callable, optional

function to deserialize str, bytes, bytearray containing a JSON document to a Python obj, by default json.loads

Ancestors

• DictWrapper
• collections.abc.Mapping
• collections.abc.Collection
• collections.abc.Sized
• collections.abc.Iterable
• collections.abc.Container
• typing.Generic

Instance variables

prop password : str | None

Expand source code

@property
def password(self) -> str | None:
    """
    The password used for authentication.
    None in case customer authenticating with certificates
    """
    return self["password"]

The password used for authentication. None in case customer authenticating with certificates

prop protocol : str

Expand source code

@property
def protocol(self) -> str:
    """The protocol can be SFTP, FTP or FTPS"""
    return self["protocol"]

The protocol can be SFTP, FTP or FTPS

prop server_id : str

Expand source code

@property
def server_id(self) -> str:
    """The AWS Transfer Family ServerID"""
    return self["serverId"]

The AWS Transfer Family ServerID

prop source_ip : str

Expand source code

@property
def source_ip(self) -> str:
    """The customer IP used for connection"""
    return self["sourceIp"]

The customer IP used for connection

prop username : str

Expand source code

@property
def username(self) -> str:
    """The username used for authentication"""
    return self["username"]

The username used for authentication

Inherited members

• DictWrapper:
  • get
  • raw_event

class TransferFamilyAuthorizerResponse

Expand source code

class TransferFamilyAuthorizerResponse:

    def _build_authentication_response(
        self,
        role_arn: str,
        policy: str | None = None,
        home_directory: str | None = None,
        home_directory_details: dict | None = None,
        home_directory_type: Literal["LOGICAL", "PATH"] = "PATH",
        user_gid: int | None = None,
        user_uid: int | None = None,
        public_keys: str | None = None,
    ) -> dict[str, Any]:

        response: dict[str, Any] = {}

        if home_directory_type == "PATH":
            if not home_directory:
                raise ValueError("home_directory must be set when home_directory_type is PATH")

            response["HomeDirectory"] = home_directory
        elif home_directory_type == "LOGICAL":
            if not home_directory_details:
                raise ValueError("home_directory_details must be set when home_directory_type is LOGICAL")

            response["HomeDirectoryDetails"] = [home_directory_details]

        else:
            raise ValueError(f"Invalid home_directory_type: {home_directory_type}")

        if user_uid is not None:
            response["PosixProfile"] = {"Gid": user_gid, "Uid": user_gid}

        if policy:
            response["Policy"] = policy

        if public_keys:
            response["PublicKeys"] = public_keys

        response["Role"] = role_arn
        response["HomeDirectoryType"] = home_directory_type

        return response

    def build_authentication_response_efs(
        self,
        role_arn: str,
        user_gid: int,
        user_uid: int,
        policy: str | None = None,
        home_directory: str | None = None,
        home_directory_details: dict | None = None,
        home_directory_type: Literal["LOGICAL", "PATH"] = "PATH",
        public_keys: str | None = None,
    ) -> dict[str, Any]:
        """
        Build an authentication response for AWS Transfer Family using EFS (Elastic File System).

        Parameters:
        -----------
        role_arn : str
            The Amazon Resource Name (ARN) of the IAM role.
        user_gid : int
            The group ID of the user.
        user_uid : int
            The user ID.
        policy : str | None, optional
            The IAM policy document. Defaults to None.
        home_directory : str | None, optional
            The home directory path. Required if home_directory_type is "PATH". Defaults to None.
        home_directory_details : dict | None, optional
            Details of the home directory. Required if home_directory_type is "LOGICAL". Defaults to None.
        home_directory_type : Literal["LOGICAL", "PATH"], optional
            The type of home directory. Must be either "LOGICAL" or "PATH". Defaults to "PATH".
        public_keys : str | None, optional
            The public keys associated with the user. Defaults to None.

        Returns:
        --------
        dict[str, Any]
            A dictionary containing the authentication response with various details such as
            role ARN, policy, home directory information, and user details.

        Raises:
        -------
        ValueError
            If an invalid home_directory_type is provided or if required parameters are missing
            for the specified home_directory_type.
        """

        return self._build_authentication_response(
            role_arn=role_arn,
            policy=policy,
            home_directory=home_directory,
            home_directory_details=home_directory_details,
            home_directory_type=home_directory_type,
            public_keys=public_keys,
            user_gid=user_gid,
            user_uid=user_uid,
        )

    def build_authentication_response_s3(
        self,
        role_arn: str,
        policy: str | None = None,
        home_directory: str | None = None,
        home_directory_details: dict | None = None,
        home_directory_type: Literal["LOGICAL", "PATH"] = "PATH",
        public_keys: str | None = None,
    ) -> dict[str, Any]:
        """
        Build an authentication response for Amazon S3.

        This method constructs an authentication response tailored for S3 access,
        likely by calling an internal method with the provided parameters.

        Parameters:
        -----------
        role_arn : str
            The Amazon Resource Name (ARN) of the IAM role for S3 access.
        policy : str | None, optional
            The IAM policy document for S3 access. Defaults to None.
        home_directory : str | None, optional
            The home directory path in S3. Required if home_directory_type is "PATH". Defaults to None.
        home_directory_details : dict | None, optional
            Details of the home directory in S3. Required if home_directory_type is "LOGICAL". Defaults to None.
        home_directory_type : Literal["LOGICAL", "PATH"], optional
            The type of home directory in S3. Must be either "LOGICAL" or "PATH". Defaults to "PATH".
        public_keys : str | None, optional
            The public keys associated with the user for S3 access. Defaults to None.

        Returns:
        --------
        dict[str, Any]
            A dictionary containing the authentication response with various details such as
            role ARN, policy, home directory information, and potentially other S3-specific attributes.

        Raises:
        -------
        ValueError
            If an invalid home_directory_type is provided or if required parameters are missing
            for the specified home_directory_type.
        """
        return self._build_authentication_response(
            role_arn=role_arn,
            policy=policy,
            home_directory=home_directory,
            home_directory_details=home_directory_details,
            home_directory_type=home_directory_type,
            public_keys=public_keys,
        )

Methods

def build_authentication_response_efs(self,
role_arn: str,
user_gid: int,
user_uid: int,
policy: str | None = None,
home_directory: str | None = None,
home_directory_details: dict | None = None,
home_directory_type: "Literal['LOGICAL', 'PATH']" = 'PATH',
public_keys: str | None = None) ‑> dict[str, typing.Any]

Expand source code

def build_authentication_response_efs(
    self,
    role_arn: str,
    user_gid: int,
    user_uid: int,
    policy: str | None = None,
    home_directory: str | None = None,
    home_directory_details: dict | None = None,
    home_directory_type: Literal["LOGICAL", "PATH"] = "PATH",
    public_keys: str | None = None,
) -> dict[str, Any]:
    """
    Build an authentication response for AWS Transfer Family using EFS (Elastic File System).

    Parameters:
    -----------
    role_arn : str
        The Amazon Resource Name (ARN) of the IAM role.
    user_gid : int
        The group ID of the user.
    user_uid : int
        The user ID.
    policy : str | None, optional
        The IAM policy document. Defaults to None.
    home_directory : str | None, optional
        The home directory path. Required if home_directory_type is "PATH". Defaults to None.
    home_directory_details : dict | None, optional
        Details of the home directory. Required if home_directory_type is "LOGICAL". Defaults to None.
    home_directory_type : Literal["LOGICAL", "PATH"], optional
        The type of home directory. Must be either "LOGICAL" or "PATH". Defaults to "PATH".
    public_keys : str | None, optional
        The public keys associated with the user. Defaults to None.

    Returns:
    --------
    dict[str, Any]
        A dictionary containing the authentication response with various details such as
        role ARN, policy, home directory information, and user details.

    Raises:
    -------
    ValueError
        If an invalid home_directory_type is provided or if required parameters are missing
        for the specified home_directory_type.
    """

    return self._build_authentication_response(
        role_arn=role_arn,
        policy=policy,
        home_directory=home_directory,
        home_directory_details=home_directory_details,
        home_directory_type=home_directory_type,
        public_keys=public_keys,
        user_gid=user_gid,
        user_uid=user_uid,
    )

Build an authentication response for AWS Transfer Family using EFS (Elastic File System).

Parameters:

role_arn : str The Amazon Resource Name (ARN) of the IAM role. user_gid : int The group ID of the user. user_uid : int The user ID. policy : str | None, optional The IAM policy document. Defaults to None. home_directory : str | None, optional The home directory path. Required if home_directory_type is "PATH". Defaults to None. home_directory_details : dict | None, optional Details of the home directory. Required if home_directory_type is "LOGICAL". Defaults to None. home_directory_type : Literal["LOGICAL", "PATH"], optional The type of home directory. Must be either "LOGICAL" or "PATH". Defaults to "PATH". public_keys : str | None, optional The public keys associated with the user. Defaults to None.

Returns:

dict[str, Any] A dictionary containing the authentication response with various details such as role ARN, policy, home directory information, and user details.

Raises:

ValueError If an invalid home_directory_type is provided or if required parameters are missing for the specified home_directory_type.

def build_authentication_response_s3(self,
role_arn: str,
policy: str | None = None,
home_directory: str | None = None,
home_directory_details: dict | None = None,
home_directory_type: "Literal['LOGICAL', 'PATH']" = 'PATH',
public_keys: str | None = None) ‑> dict[str, typing.Any]

Expand source code

def build_authentication_response_s3(
    self,
    role_arn: str,
    policy: str | None = None,
    home_directory: str | None = None,
    home_directory_details: dict | None = None,
    home_directory_type: Literal["LOGICAL", "PATH"] = "PATH",
    public_keys: str | None = None,
) -> dict[str, Any]:
    """
    Build an authentication response for Amazon S3.

    This method constructs an authentication response tailored for S3 access,
    likely by calling an internal method with the provided parameters.

    Parameters:
    -----------
    role_arn : str
        The Amazon Resource Name (ARN) of the IAM role for S3 access.
    policy : str | None, optional
        The IAM policy document for S3 access. Defaults to None.
    home_directory : str | None, optional
        The home directory path in S3. Required if home_directory_type is "PATH". Defaults to None.
    home_directory_details : dict | None, optional
        Details of the home directory in S3. Required if home_directory_type is "LOGICAL". Defaults to None.
    home_directory_type : Literal["LOGICAL", "PATH"], optional
        The type of home directory in S3. Must be either "LOGICAL" or "PATH". Defaults to "PATH".
    public_keys : str | None, optional
        The public keys associated with the user for S3 access. Defaults to None.

    Returns:
    --------
    dict[str, Any]
        A dictionary containing the authentication response with various details such as
        role ARN, policy, home directory information, and potentially other S3-specific attributes.

    Raises:
    -------
    ValueError
        If an invalid home_directory_type is provided or if required parameters are missing
        for the specified home_directory_type.
    """
    return self._build_authentication_response(
        role_arn=role_arn,
        policy=policy,
        home_directory=home_directory,
        home_directory_details=home_directory_details,
        home_directory_type=home_directory_type,
        public_keys=public_keys,
    )

Build an authentication response for Amazon S3.

This method constructs an authentication response tailored for S3 access, likely by calling an internal method with the provided parameters.

Parameters:

role_arn : str The Amazon Resource Name (ARN) of the IAM role for S3 access. policy : str | None, optional The IAM policy document for S3 access. Defaults to None. home_directory : str | None, optional The home directory path in S3. Required if home_directory_type is "PATH". Defaults to None. home_directory_details : dict | None, optional Details of the home directory in S3. Required if home_directory_type is "LOGICAL". Defaults to None. home_directory_type : Literal["LOGICAL", "PATH"], optional The type of home directory in S3. Must be either "LOGICAL" or "PATH". Defaults to "PATH". public_keys : str | None, optional The public keys associated with the user for S3 access. Defaults to None.

Returns:

dict[str, Any] A dictionary containing the authentication response with various details such as role ARN, policy, home directory information, and potentially other S3-specific attributes.

Raises:

ValueError If an invalid home_directory_type is provided or if required parameters are missing for the specified home_directory_type.