CfnUserProps

class aws_cdk.aws_transfer.CfnUserProps(*, role, server_id, user_name, home_directory=None, home_directory_mappings=None, home_directory_type=None, policy=None, posix_profile=None, ssh_public_keys=None, tags=None)

Bases: object

Properties for defining a AWS::Transfer::User.

Parameters
  • role (str) – AWS::Transfer::User.Role.

  • server_id (str) – AWS::Transfer::User.ServerId.

  • user_name (str) – AWS::Transfer::User.UserName.

  • home_directory (Optional[str]) – AWS::Transfer::User.HomeDirectory.

  • home_directory_mappings (Union[IResolvable, Sequence[Union[IResolvable, HomeDirectoryMapEntryProperty]], None]) – AWS::Transfer::User.HomeDirectoryMappings.

  • home_directory_type (Optional[str]) – AWS::Transfer::User.HomeDirectoryType.

  • policy (Optional[str]) – AWS::Transfer::User.Policy.

  • posix_profile (Union[IResolvable, PosixProfileProperty, None]) – AWS::Transfer::User.PosixProfile.

  • ssh_public_keys (Optional[Sequence[str]]) – AWS::Transfer::User.SshPublicKeys.

  • tags (Optional[Sequence[CfnTag]]) – AWS::Transfer::User.Tags.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-user.html

Attributes

home_directory

AWS::Transfer::User.HomeDirectory.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-user.html#cfn-transfer-user-homedirectory

Return type

Optional[str]

home_directory_mappings

AWS::Transfer::User.HomeDirectoryMappings.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-user.html#cfn-transfer-user-homedirectorymappings

Return type

Union[IResolvable, List[Union[IResolvable, HomeDirectoryMapEntryProperty]], None]

home_directory_type

AWS::Transfer::User.HomeDirectoryType.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-user.html#cfn-transfer-user-homedirectorytype

Return type

Optional[str]

policy

AWS::Transfer::User.Policy.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-user.html#cfn-transfer-user-policy

Return type

Optional[str]

posix_profile

AWS::Transfer::User.PosixProfile.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-user.html#cfn-transfer-user-posixprofile

Return type

Union[IResolvable, PosixProfileProperty, None]

role

AWS::Transfer::User.Role.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-user.html#cfn-transfer-user-role

Return type

str

server_id

AWS::Transfer::User.ServerId.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-user.html#cfn-transfer-user-serverid

Return type

str

ssh_public_keys

AWS::Transfer::User.SshPublicKeys.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-user.html#cfn-transfer-user-sshpublickeys

Return type

Optional[List[str]]

tags

AWS::Transfer::User.Tags.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-user.html#cfn-transfer-user-tags

Return type

Optional[List[CfnTag]]

user_name

AWS::Transfer::User.UserName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-user.html#cfn-transfer-user-username

Return type

str