software.amazon.awscdk.services.transfer

Interface CfnUserProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnUserProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.47.0 (build 86d2c33)",
           date="2021-12-22T10:27:19.573Z")
 @Stability(value=Stable)
public interface CfnUserProps
extends software.amazon.jsii.JsiiSerializable

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

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.*;
 CfnUserProps cfnUserProps = CfnUserProps.builder()
         .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	Interface and Description
static class	CfnUserProps.Builder A builder for CfnUserProps
static class	CfnUserProps.Jsii$Proxy An implementation for CfnUserProps

Method Summary

Modifier and Type	Method and Description
static CfnUserProps.Builder	builder()
default String	getHomeDirectory() `AWS::Transfer::User.HomeDirectory`.
default Object	getHomeDirectoryMappings() `AWS::Transfer::User.HomeDirectoryMappings`.
default String	getHomeDirectoryType() `AWS::Transfer::User.HomeDirectoryType`.
default String	getPolicy() `AWS::Transfer::User.Policy`.
default Object	getPosixProfile() `AWS::Transfer::User.PosixProfile`.
String	getRole() `AWS::Transfer::User.Role`.
String	getServerId() `AWS::Transfer::User.ServerId`.
default List<String>	getSshPublicKeys() `AWS::Transfer::User.SshPublicKeys`.
default List<CfnTag>	getTags() `AWS::Transfer::User.Tags`.
String	getUserName() `AWS::Transfer::User.UserName`.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getHomeDirectory

@Stability(value=Stable)
 @Nullable
default String getHomeDirectory()

`AWS::Transfer::User.HomeDirectory`.

getHomeDirectoryMappings

@Stability(value=Stable)
 @Nullable
default Object getHomeDirectoryMappings()

`AWS::Transfer::User.HomeDirectoryMappings`.

getHomeDirectoryType

@Stability(value=Stable)
 @Nullable
default String getHomeDirectoryType()

`AWS::Transfer::User.HomeDirectoryType`.

getPolicy

@Stability(value=Stable)
 @Nullable
default String getPolicy()

`AWS::Transfer::User.Policy`.

getPosixProfile

@Stability(value=Stable)
 @Nullable
default Object getPosixProfile()

`AWS::Transfer::User.PosixProfile`.

getRole

@Stability(value=Stable)
 @NotNull
String getRole()

`AWS::Transfer::User.Role`.

getServerId

@Stability(value=Stable)
 @NotNull
String getServerId()

`AWS::Transfer::User.ServerId`.

getSshPublicKeys

@Stability(value=Stable)
 @Nullable
default List<String> getSshPublicKeys()

`AWS::Transfer::User.SshPublicKeys`.

getTags

@Stability(value=Stable)
 @Nullable
default List<CfnTag> getTags()

`AWS::Transfer::User.Tags`.

getUserName

@Stability(value=Stable)
 @NotNull
String getUserName()

`AWS::Transfer::User.UserName`.

builder

@Stability(value=Stable)
static CfnUserProps.Builder builder()

Returns:

a CfnUserProps.Builder of CfnUserProps