class CfnUserPropsMixin

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.Transfer.Mixins.CfnUserPropsMixin
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awstransfer/mixins#CfnUserPropsMixin
Java	software.amazon.awscdk.mixins.preview.services.transfer.mixins.CfnUserPropsMixin
Python	aws_cdk.mixins_preview.aws_transfer.mixins.CfnUserPropsMixin
TypeScript	@aws-cdk/mixins-preview » aws_transfer » mixins » CfnUserPropsMixin

Implements IMixin

Extends Mixin

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.

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins } from '@aws-cdk/mixins-preview';
import { mixins as transfer_mixins } from '@aws-cdk/mixins-preview/aws-transfer';
const cfnUserPropsMixin = new transfer_mixins.CfnUserPropsMixin({
  homeDirectory: 'homeDirectory',
  homeDirectoryMappings: [{
    entry: 'entry',
    target: 'target',
    type: 'type',
  }],
  homeDirectoryType: 'homeDirectoryType',
  policy: 'policy',
  posixProfile: {
    gid: 123,
    secondaryGids: [123],
    uid: 123,
  },
  role: 'role',
  serverId: 'serverId',
  sshPublicKeys: ['sshPublicKeys'],
  tags: [{
    key: 'key',
    value: 'value',
  }],
  userName: 'userName',
}, /* all optional props */ {
  strategy: mixins.PropertyMergeStrategy.OVERRIDE,
});

Initializer

new CfnUserPropsMixin(props: CfnUserMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnUserMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

Create a mixin to apply properties to AWS::Transfer::User.

Properties

Name	Type	Description
props	CfnUserMixinProps
strategy	PropertyMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnUserMixinProps

---

strategy

Type: PropertyMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	Apply the mixin properties to the construct.
supports(construct)	Check if this mixin supports the given construct.

---

applyTo(construct)

public applyTo(construct: IConstruct): IConstruct

Parameters

• construct IConstruct

Returns

• IConstruct

Apply the mixin properties to the construct.

---

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

• construct IConstruct

Returns

• boolean

Check if this mixin supports the given construct.