CfnUser (software.amazon.awscdk:aws-cdk-lib 2.42.1 API)

java.lang.Object
- software.amazon.jsii.JsiiObject
- - software.constructs.Construct
  - - software.amazon.awscdk.CfnElement
    - - software.amazon.awscdk.CfnRefElement
      - software.amazon.awscdk.CfnResource
        
        software.amazon.awscdk.services.transfer.CfnUser

All Implemented Interfaces:: IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:42.610Z")
 @Stability(value=Stable)
public class CfnUser
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Transfer::User`.

The AWS::Transfer::User resource creates a user and associates them with an existing server. You can only create and associate users with servers that have the IdentityProviderType set to SERVICE_MANAGED . Using parameters for CreateUser , you can specify the user name, set the home directory, store the user's public key, and assign the user's AWS Identity and Access Management (IAM) role. You can also optionally add a session policy, and assign metadata with tags that can be used to group and search for users.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.transfer.*;
 CfnUser cfnUser = CfnUser.Builder.create(this, "MyCfnUser")
         .role("role")
         .serverId("serverId")
         .userName("userName")
         // the properties below are optional
         .homeDirectory("homeDirectory")
         .homeDirectoryMappings(List.of(HomeDirectoryMapEntryProperty.builder()
                 .entry("entry")
                 .target("target")
                 .build()))
         .homeDirectoryType("homeDirectoryType")
         .policy("policy")
         .posixProfile(PosixProfileProperty.builder()
                 .gid(123)
                 .uid(123)
                 // the properties below are optional
                 .secondaryGids(List.of(123))
                 .build())
         .sshPublicKeys(List.of("sshPublicKeys"))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`CfnUser.Builder` A fluent builder for `CfnUser`.
`static interface`	`CfnUser.HomeDirectoryMapEntryProperty` Represents an object that contains entries and targets for `HomeDirectoryMappings` .
`static interface`	`CfnUser.PosixProfileProperty` 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 EFS file systems.

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

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default

Field Summary

Fields
Modifier and Type Field and Description

static String CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.

Fields
Modifier and Type	Field and Description
`static String`	`CFN_RESOURCE_TYPE_NAME` The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors
Modifier	Constructor and Description
	`CfnUser(software.constructs.Construct scope, String id, CfnUserProps props)` Create a new `AWS::Transfer::User`.
`protected`	`CfnUser(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)`
`protected`	`CfnUser(software.amazon.jsii.JsiiObjectRef objRef)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getAttrArn()` The Amazon Resource Name associated with the user, in the form `arn:aws:transfer:region: account-id :user/ server-id / username` .
`String`	`getAttrServerId()` The ID of the server to which the user is attached.
`String`	`getAttrUserName()` A unique string that identifies a user account associated with a server.
`protected Map<String,Object>`	`getCfnProperties()`
`String`	`getHomeDirectory()` The landing directory (folder) for a user when they log in to the server using the client.
`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.
`String`	`getHomeDirectoryType()` The type of landing directory (folder) you want your users' home directory to be when they log into the server.
`String`	`getPolicy()` A session policy for your user so you can use the same IAM role across multiple users.
`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.
`String`	`getRole()` Specifies the Amazon Resource Name (ARN) of the IAM role that controls your users' access to your Amazon S3 bucket or EFS file system.
`String`	`getServerId()` A system-assigned unique identifier for a server instance.
`List<String>`	`getSshPublicKeys()` Specifies the public key portion of the Secure Shell (SSH) keys stored for the described user.
`TagManager`	`getTags()` Key-value pairs that can be used to group and search for users.
`String`	`getUserName()` A unique string that identifies a user and is associated with a `ServerId` .
`void`	`inspect(TreeInspector inspector)` Examines the CloudFormation resource and discloses attributes.
`protected Map<String,Object>`	`renderProperties(Map<String,Object> props)`
`void`	`setHomeDirectory(String value)` The landing directory (folder) for a user when they log in to the server using the client.
`void`	`setHomeDirectoryMappings(IResolvable value)` 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.
`void`	`setHomeDirectoryMappings(List<Object> value)` 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.
`void`	`setHomeDirectoryType(String value)` The type of landing directory (folder) you want your users' home directory to be when they log into the server.
`void`	`setPolicy(String value)` A session policy for your user so you can use the same IAM role across multiple users.
`void`	`setPosixProfile(CfnUser.PosixProfileProperty value)` 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.
`void`	`setPosixProfile(IResolvable value)` 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.
`void`	`setRole(String value)` Specifies the Amazon Resource Name (ARN) of the IAM role that controls your users' access to your Amazon S3 bucket or EFS file system.
`void`	`setServerId(String value)` A system-assigned unique identifier for a server instance.
`void`	`setSshPublicKeys(List<String> value)` Specifies the public key portion of the Secure Shell (SSH) keys stored for the described user.
`void`	`setUserName(String value)` A unique string that identifies a user and is associated with a `ServerId` .

Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement
getRef

Methods inherited from class software.amazon.awscdk.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct
getNode, isConstruct

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, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson

- Field Detail
  - CFN_RESOURCE_TYPE_NAME
```
@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME
```
    The CloudFormation resource type name for this resource class.
- Constructor Detail
  - CfnUser
```
protected CfnUser(software.amazon.jsii.JsiiObjectRef objRef)
```
  - CfnUser
```
protected CfnUser(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
```
  - CfnUser
```
@Stability(value=Stable)
public CfnUser(@NotNull
                                        software.constructs.Construct scope,
                                        @NotNull
                                        String id,
                                        @NotNull
                                        CfnUserProps props)
```
    Create a new `AWS::Transfer::User`.
    
    Parameters:
    
    scope - - scope in which this resource is defined. This parameter is required.
    
    id - - scoped id of the resource. This parameter is required.
    
    props - - resource properties. This parameter is required.
- Method Detail
  - inspect
```
@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)
```
    Examines the CloudFormation resource and discloses attributes.
    
    Specified by:
    
    inspect in interface IInspectable
    
    Parameters:
    
    inspector - - tree inspector to collect and process attributes. This parameter is required.
  - renderProperties
```
@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)
```
    Overrides:
    
    renderProperties in class CfnResource
    
    Parameters:
    
    props - This parameter is required.
  - getAttrArn
```
@Stability(value=Stable)
 @NotNull
public String getAttrArn()
```
    The Amazon Resource Name associated with the user, in the form `arn:aws:transfer:region: *account-id* :user/ *server-id* / *username*` .
    An example of a user ARN is: arn:aws:transfer:us-east-1:123456789012:user/user1 .
  - getAttrServerId
```
@Stability(value=Stable)
 @NotNull
public String getAttrServerId()
```
    The ID of the server to which the user is attached.
    An example ServerId is s-01234567890abcdef .
  - getAttrUserName
```
@Stability(value=Stable)
 @NotNull
public String getAttrUserName()
```
    A unique string that identifies a user account associated with a server.
    An example UserName is transfer-user-1 .
  - getCfnProperties
```
@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()
```
    Overrides:
    
    getCfnProperties in class CfnResource
  - getTags
```
@Stability(value=Stable)
 @NotNull
public TagManager getTags()
```
    Key-value pairs that can be used to group and search for users.
    Tags are metadata attached to users for any purpose.
  - getRole
```
@Stability(value=Stable)
 @NotNull
public String getRole()
```
    Specifies the Amazon Resource Name (ARN) of the IAM role that controls your users' access to your Amazon S3 bucket or 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 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.
  - setRole
```
@Stability(value=Stable)
public void setRole(@NotNull
                                             String value)
```
    Specifies the Amazon Resource Name (ARN) of the IAM role that controls your users' access to your Amazon S3 bucket or 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 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.
  - getServerId
```
@Stability(value=Stable)
 @NotNull
public String getServerId()
```
    A system-assigned unique identifier for a server instance.
    This is the specific server that you added your user to.
  - setServerId
```
@Stability(value=Stable)
public void setServerId(@NotNull
                                                 String value)
```
    A system-assigned unique identifier for a server instance.
    This is the specific server that you added your user to.
  - getUserName
```
@Stability(value=Stable)
 @NotNull
public String getUserName()
```
    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.
  - setUserName
```
@Stability(value=Stable)
public void setUserName(@NotNull
                                                 String value)
```
    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.
  - getHomeDirectory
```
@Stability(value=Stable)
 @Nullable
public String getHomeDirectory()
```
    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 .
  - setHomeDirectory
```
@Stability(value=Stable)
public void setHomeDirectory(@Nullable
                                                      String value)
```
    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 .
  - getHomeDirectoryMappings
```
@Stability(value=Stable)
 @Nullable
public 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.
    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.
  - setHomeDirectoryMappings
```
@Stability(value=Stable)
public void setHomeDirectoryMappings(@Nullable
                                                              IResolvable value)
```
    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.
  - setHomeDirectoryMappings
```
@Stability(value=Stable)
public void setHomeDirectoryMappings(@Nullable
                                                              List<Object> value)
```
    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.
  - getHomeDirectoryType
```
@Stability(value=Stable)
 @Nullable
public String getHomeDirectoryType()
```
    The type of landing directory (folder) you want your users' home directory to be when they log into 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 EFS paths visible to your users.
  - setHomeDirectoryType
```
@Stability(value=Stable)
public void setHomeDirectoryType(@Nullable
                                                          String value)
```
    The type of landing directory (folder) you want your users' home directory to be when they log into 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 EFS paths visible to your users.
  - getPolicy
```
@Stability(value=Stable)
 @Nullable
public String getPolicy()
```
    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 .
  - setPolicy
```
@Stability(value=Stable)
public void setPolicy(@Nullable
                                               String value)
```
    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 .
  - getPosixProfile
```
@Stability(value=Stable)
 @Nullable
public 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.
    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.
  - setPosixProfile
```
@Stability(value=Stable)
public void setPosixProfile(@Nullable
                                                     CfnUser.PosixProfileProperty value)
```
    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.
  - setPosixProfile
```
@Stability(value=Stable)
public void setPosixProfile(@Nullable
                                                     IResolvable value)
```
    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.
  - getSshPublicKeys
```
@Stability(value=Stable)
 @Nullable
public List<String> getSshPublicKeys()
```
    Specifies the public key portion of the Secure Shell (SSH) keys stored for the described user.
  - setSshPublicKeys
```
@Stability(value=Stable)
public void setSshPublicKeys(@Nullable
                                                      List<String> value)
```
    Specifies the public key portion of the Secure Shell (SSH) keys stored for the described user.

Class CfnUser

Nested Class Summary

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

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

Nested classes/interfaces inherited from interface software.constructs.IConstruct

Field Summary

Constructor Summary

Method Summary

Methods inherited from class software.amazon.awscdk.CfnResource

Methods inherited from class software.amazon.awscdk.CfnRefElement

Methods inherited from class software.amazon.awscdk.CfnElement

Methods inherited from class software.constructs.Construct

Methods inherited from class software.amazon.jsii.JsiiObject

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Field Detail

CFN_RESOURCE_TYPE_NAME

Constructor Detail

CfnUser

CfnUser

CfnUser

Method Detail

inspect

renderProperties

getAttrArn

getAttrServerId

getAttrUserName

getCfnProperties

getTags

getRole

setRole

getServerId

setServerId

getUserName

setUserName

getHomeDirectory

setHomeDirectory

getHomeDirectoryMappings

setHomeDirectoryMappings

setHomeDirectoryMappings

getHomeDirectoryType

setHomeDirectoryType

getPolicy

setPolicy

getPosixProfile

setPosixProfile

setPosixProfile

getSshPublicKeys

setSshPublicKeys