Package software.amazon.awscdk.services.transfer

Class CfnUserProps.Jsii$Proxy

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.transfer.CfnUserProps.Jsii$Proxy
All Implemented Interfaces:
CfnUserProps, software.amazon.jsii.JsiiSerializable
Enclosing interface:
CfnUserProps
@Stability(Stable) @Internal public static final class CfnUserProps.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements CfnUserProps
An implementation for CfnUserProps

  • Nested Class Summary

    Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

    software.amazon.jsii.JsiiObject.InitializationMode

    Nested classes/interfaces inherited from interface software.amazon.awscdk.services.transfer.CfnUserProps

    CfnUserProps.Builder, CfnUserProps.Jsii$Proxy

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    Jsii$Proxy(CfnUserProps.Builder builder)
    Constructor that initializes the object based on literal property values passed by the CfnUserProps.Builder.
    protected
    Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
    Constructor that initializes the object based on values retrieved from the JsiiObject.

  • Method Summary

    Modifier and Type
    Method
    Description
    com.fasterxml.jackson.databind.JsonNode
    $jsii$toJson()
     
    final boolean
    equals(Object o)
     
    final String
    getHomeDirectory()
    The landing directory (folder) for a user when they log in to the server using the client.
    final Object
    getHomeDirectoryMappings()
    Logical directory mappings that specify what Amazon S3 paths and keys should be visible to your user and how you want to make them visible.
    final String
    getHomeDirectoryType()
    The type of landing directory (folder) that you want your users' home directory to be when they log in to the server.
    final String
    getPolicy()
    A session policy for your user so you can use the same IAM role across multiple users.
    final Object
    getPosixProfile()
    Specifies the full POSIX identity, including user ID ( Uid ), group ID ( Gid ), and any secondary groups IDs ( SecondaryGids ), that controls your users' access to your Amazon Elastic File System (Amazon EFS) file systems.
    final String
    getRole()
    The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that controls your users' access to your Amazon S3 bucket or Amazon EFS file system.
    final String
    getServerId()
    A system-assigned unique identifier for a server instance.
    final List<String>
    getSshPublicKeys()
    Specifies the public key portion of the Secure Shell (SSH) keys stored for the described user.
    final List<CfnTag>
    getTags()
    Key-value pairs that can be used to group and search for users.
    final String
    getUserName()
    A unique string that identifies a user and is associated with a ServerId .
    final int
    hashCode()
     

    Methods inherited from class software.amazon.jsii.JsiiObject

    jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • Jsii$Proxy

      protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
      Constructor that initializes the object based on values retrieved from the JsiiObject.
      Parameters:
      objRef - Reference to the JSII managed object.

    • Jsii$Proxy

      protected Jsii$Proxy(CfnUserProps.Builder builder)
      Constructor that initializes the object based on literal property values passed by the CfnUserProps.Builder.

  • Method Details

    • getRole

      public final String getRole()
      Description copied from interface: CfnUserProps
      The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that controls your users' access to your Amazon S3 bucket or Amazon EFS file system.

      The policies attached to this role determine the level of access that you want to provide your users when transferring files into and out of your Amazon S3 bucket or Amazon EFS file system. The IAM role should also contain a trust relationship that allows the server to access your resources when servicing your users' transfer requests.

      Specified by:
      getRole in interface CfnUserProps

    • getServerId

      public final String getServerId()
      Description copied from interface: CfnUserProps
      A system-assigned unique identifier for a server instance.

      This is the specific server that you added your user to.

      Specified by:
      getServerId in interface CfnUserProps

    • getUserName

      public final String getUserName()
      Description copied from interface: CfnUserProps
      A unique string that identifies a user and is associated with a ServerId .

      This user name must be a minimum of 3 and a maximum of 100 characters long. The following are valid characters: a-z, A-Z, 0-9, underscore '_', hyphen '-', period '.', and at sign '@'. The user name can't start with a hyphen, period, or at sign.

      Specified by:
      getUserName in interface CfnUserProps

    • getHomeDirectory

      public final String getHomeDirectory()
      Description copied from interface: CfnUserProps
      The landing directory (folder) for a user when they log in to the server using the client.

      A HomeDirectory example is /bucket_name/home/mydirectory .

      Specified by:
      getHomeDirectory in interface CfnUserProps

    • getHomeDirectoryMappings

      public final Object getHomeDirectoryMappings()
      Description copied from interface: CfnUserProps
      Logical directory mappings that specify what Amazon S3 paths and keys should be visible to your user and how you want to make them visible.

      You will need to specify the " Entry " and " Target " pair, where Entry shows how the path is made visible and Target is the actual Amazon S3 path. If you only specify a target, it will be displayed as is. You will need to also make sure that your IAM role provides access to paths in Target . The following is an example.

      '[ { "Entry": "/", "Target": "/bucket3/customized-reports/" } ]'

      In most cases, you can use this value instead of the session policy to lock your user down to the designated home directory ("chroot"). To do this, you can set Entry to '/' and set Target to the HomeDirectory parameter value.

      If the target of a logical directory entry does not exist in Amazon S3, the entry will be ignored. As a workaround, you can use the Amazon S3 API to create 0 byte objects as place holders for your directory. If using the CLI, use the s3api call instead of s3 so you can use the put-object operation. For example, you use the following: AWS s3api put-object --bucket bucketname --key path/to/folder/ . Make sure that the end of the key name ends in a '/' for it to be considered a folder.

      Specified by:
      getHomeDirectoryMappings in interface CfnUserProps

    • getHomeDirectoryType

      public final String getHomeDirectoryType()
      Description copied from interface: CfnUserProps
      The type of landing directory (folder) that you want your users' home directory to be when they log in to the server.

      If you set it to PATH , the user will see the absolute Amazon S3 bucket or EFS paths as is in their file transfer protocol clients. If you set it LOGICAL , you need to provide mappings in the HomeDirectoryMappings for how you want to make Amazon S3 or Amazon EFS paths visible to your users.

      Specified by:
      getHomeDirectoryType in interface CfnUserProps

    • getPolicy

      public final String getPolicy()
      Description copied from interface: CfnUserProps
      A session policy for your user so you can use the same IAM role across multiple users.

      This policy restricts user access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName} , ${Transfer:HomeDirectory} , and ${Transfer:HomeBucket} .

      For session policies, AWS Transfer Family stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the Policy argument.

      For an example of a session policy, see Example session policy .

      For more information, see AssumeRole in the AWS Security Token Service API Reference .

      Specified by:
      getPolicy in interface CfnUserProps

    • getPosixProfile

      public final Object getPosixProfile()
      Description copied from interface: CfnUserProps
      Specifies the full POSIX identity, including user ID ( Uid ), group ID ( Gid ), and any secondary groups IDs ( SecondaryGids ), that controls your users' access to your Amazon Elastic File System (Amazon EFS) file systems.

      The POSIX permissions that are set on files and directories in your file system determine the level of access your users get when transferring files into and out of your Amazon EFS file systems.

      Specified by:
      getPosixProfile in interface CfnUserProps

    • getSshPublicKeys

      public final List<String> getSshPublicKeys()
      Description copied from interface: CfnUserProps
      Specifies the public key portion of the Secure Shell (SSH) keys stored for the described user.
      Specified by:
      getSshPublicKeys in interface CfnUserProps

    • getTags

      public final List<CfnTag> getTags()
      Description copied from interface: CfnUserProps
      Key-value pairs that can be used to group and search for users.

      Tags are metadata attached to users for any purpose.

      Specified by:
      getTags in interface CfnUserProps

    • $jsii$toJson

      @Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
      Specified by:
      $jsii$toJson in interface software.amazon.jsii.JsiiSerializable

    • equals

      public final boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

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