`transferUser` Submodule

Constructs

TransferUser

Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/transfer_user aws_transfer_user}.

Initializers

import { transferUser } from '@cdktf/aws-cdk'

new transferUser.TransferUser(scope: Construct, id: string, config: TransferUserConfig)

Name	Type	Description
`scope`	`constructs.Construct`	The scope in which to define this construct.
`id`	`string`	The scoped construct ID.
`config`	`TransferUserConfig`	No description.

`scope`^Required

Type: constructs.Construct

The scope in which to define this construct.

`id`^Required

Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

`config`^Required

Type: TransferUserConfig

Methods

Name	Description
`toString`	Returns a string representation of this construct.
`addOverride`	No description.
`overrideLogicalId`	Overrides the auto-generated logical ID with a specific ID.
`resetOverrideLogicalId`	Resets a previously passed logical Id to use the auto-generated logical id again.
`toHclTerraform`	No description.
`toMetadata`	No description.
`toTerraform`	Adds this resource to the terraform JSON output.
`addMoveTarget`	Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
`getAnyMapAttribute`	No description.
`getBooleanAttribute`	No description.
`getBooleanMapAttribute`	No description.
`getListAttribute`	No description.
`getNumberAttribute`	No description.
`getNumberListAttribute`	No description.
`getNumberMapAttribute`	No description.
`getStringAttribute`	No description.
`getStringMapAttribute`	No description.
`hasResourceMove`	No description.
`importFrom`	No description.
`interpolationForAttribute`	No description.
`moveFromId`	Move the resource corresponding to "id" to this resource.
`moveTo`	Moves this resource to the target resource given by moveTarget.
`moveToId`	Moves this resource to the resource corresponding to "id".
`putHomeDirectoryMappings`	No description.
`putPosixProfile`	No description.
`resetHomeDirectory`	No description.
`resetHomeDirectoryMappings`	No description.
`resetHomeDirectoryType`	No description.
`resetId`	No description.
`resetPolicy`	No description.
`resetPosixProfile`	No description.
`resetTags`	No description.
`resetTagsAll`	No description.

`toString`

public toString(): string

Returns a string representation of this construct.

`addOverride`

public addOverride(path: string, value: any): void

`path`^Required

Type: string

`value`^Required

Type: any

`overrideLogicalId`

public overrideLogicalId(newLogicalId: string): void

Overrides the auto-generated logical ID with a specific ID.

`newLogicalId`^Required

Type: string

The new logical ID to use for this stack element.

`resetOverrideLogicalId`

public resetOverrideLogicalId(): void

Resets a previously passed logical Id to use the auto-generated logical id again.

`toHclTerraform`

public toHclTerraform(): any

`toMetadata`

public toMetadata(): any

`toTerraform`

public toTerraform(): any

Adds this resource to the terraform JSON output.

`addMoveTarget`

public addMoveTarget(moveTarget: string): void

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

`moveTarget`^Required

Type: string

The string move target that will correspond to this resource.

`getAnyMapAttribute`

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

`terraformAttribute`^Required

Type: string

`getBooleanAttribute`

public getBooleanAttribute(terraformAttribute: string): IResolvable

`terraformAttribute`^Required

Type: string

`getBooleanMapAttribute`

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

`terraformAttribute`^Required

Type: string

`getListAttribute`

public getListAttribute(terraformAttribute: string): string[]

`terraformAttribute`^Required

Type: string

`getNumberAttribute`

public getNumberAttribute(terraformAttribute: string): number

`terraformAttribute`^Required

Type: string

`getNumberListAttribute`

public getNumberListAttribute(terraformAttribute: string): number[]

`terraformAttribute`^Required

Type: string

`getNumberMapAttribute`

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

`terraformAttribute`^Required

Type: string

`getStringAttribute`

public getStringAttribute(terraformAttribute: string): string

`terraformAttribute`^Required

Type: string

`getStringMapAttribute`

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

`terraformAttribute`^Required

Type: string

`hasResourceMove`

public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById

`importFrom`

public importFrom(id: string, provider?: TerraformProvider): void

`id`^Required

Type: string

`provider`^Optional

Type: cdktf.TerraformProvider

`interpolationForAttribute`

public interpolationForAttribute(terraformAttribute: string): IResolvable

`terraformAttribute`^Required

Type: string

`moveFromId`

public moveFromId(id: string): void

Move the resource corresponding to "id" to this resource.

Note that the resource being moved from must be marked as moved using it's instance function.

`id`^Required

Type: string

Full id of resource being moved from, e.g. "aws_s3_bucket.example".

`moveTo`

public moveTo(moveTarget: string, index?: string | number): void

Moves this resource to the target resource given by moveTarget.

`moveTarget`^Required

Type: string

The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.

`index`^Optional

Type: string | number

Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.

`moveToId`

public moveToId(id: string): void

Moves this resource to the resource corresponding to "id".

`id`^Required

Type: string

Full id of resource to move to, e.g. "aws_s3_bucket.example".

`putHomeDirectoryMappings`

public putHomeDirectoryMappings(value: IResolvable | TransferUserHomeDirectoryMappings[]): void

`value`^Required

Type: cdktf.IResolvable | TransferUserHomeDirectoryMappings[]

`putPosixProfile`

public putPosixProfile(value: TransferUserPosixProfile): void

`value`^Required

Type: TransferUserPosixProfile

`resetHomeDirectory`

public resetHomeDirectory(): void

`resetHomeDirectoryMappings`

public resetHomeDirectoryMappings(): void

`resetHomeDirectoryType`

public resetHomeDirectoryType(): void

`resetId`

public resetId(): void

`resetPolicy`

public resetPolicy(): void

`resetPosixProfile`

public resetPosixProfile(): void

`resetTags`

public resetTags(): void

`resetTagsAll`

public resetTagsAll(): void

Static Functions

Name	Description
`isConstruct`	Checks if `x` is a construct.
`isTerraformElement`	No description.
`isTerraformResource`	No description.
`generateConfigForImport`	Generates CDKTF code for importing a TransferUser resource upon running "cdktf plan ".

`isConstruct`

import { transferUser } from '@cdktf/aws-cdk'

transferUser.TransferUser.isConstruct(x: any)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

`x`^Required

Type: any

Any object.

`isTerraformElement`

import { transferUser } from '@cdktf/aws-cdk'

transferUser.TransferUser.isTerraformElement(x: any)

`x`^Required

Type: any

`isTerraformResource`

import { transferUser } from '@cdktf/aws-cdk'

transferUser.TransferUser.isTerraformResource(x: any)

`x`^Required

Type: any

`generateConfigForImport`

import { transferUser } from '@cdktf/aws-cdk'

transferUser.TransferUser.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

Generates CDKTF code for importing a TransferUser resource upon running "cdktf plan ".

`scope`^Required

Type: constructs.Construct

The scope in which to define this construct.

`importToId`^Required

Type: string

The construct id used in the generated config for the TransferUser to import.

`importFromId`^Required

Type: string

The id of the existing TransferUser that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/transfer_user#import import section} in the documentation of this resource for the id to use

`provider`^Optional

Type: cdktf.TerraformProvider

? Optional instance of the provider where the TransferUser to import is found.

Properties

Name	Type	Description
`node`	`constructs.Node`	The tree node.
`cdktfStack`	`cdktf.TerraformStack`	No description.
`fqn`	`string`	No description.
`friendlyUniqueId`	`string`	No description.
`terraformMetaArguments`	`{[ key: string ]: any}`	No description.
`terraformResourceType`	`string`	No description.
`terraformGeneratorMetadata`	`cdktf.TerraformProviderGeneratorMetadata`	No description.
`connection`	`cdktf.SSHProvisionerConnection \| cdktf.WinrmProvisionerConnection`	No description.
`count`	`number \| cdktf.TerraformCount`	No description.
`dependsOn`	`string[]`	No description.
`forEach`	`cdktf.ITerraformIterator`	No description.
`lifecycle`	`cdktf.TerraformResourceLifecycle`	No description.
`provider`	`cdktf.TerraformProvider`	No description.
`provisioners`	`cdktf.FileProvisioner \| cdktf.LocalExecProvisioner \| cdktf.RemoteExecProvisioner[]`	No description.
`arn`	`string`	No description.
`homeDirectoryMappings`	`TransferUserHomeDirectoryMappingsList`	No description.
`posixProfile`	`TransferUserPosixProfileOutputReference`	No description.
`homeDirectoryInput`	`string`	No description.
`homeDirectoryMappingsInput`	`cdktf.IResolvable \| TransferUserHomeDirectoryMappings[]`	No description.
`homeDirectoryTypeInput`	`string`	No description.
`idInput`	`string`	No description.
`policyInput`	`string`	No description.
`posixProfileInput`	`TransferUserPosixProfile`	No description.
`roleInput`	`string`	No description.
`serverIdInput`	`string`	No description.
`tagsAllInput`	`{[ key: string ]: string}`	No description.
`tagsInput`	`{[ key: string ]: string}`	No description.
`userNameInput`	`string`	No description.
`homeDirectory`	`string`	No description.
`homeDirectoryType`	`string`	No description.
`id`	`string`	No description.
`policy`	`string`	No description.
`role`	`string`	No description.
`serverId`	`string`	No description.
`tags`	`{[ key: string ]: string}`	No description.
`tagsAll`	`{[ key: string ]: string}`	No description.
`userName`	`string`	No description.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`cdktfStack`^Required

public readonly cdktfStack: TerraformStack;

Type: cdktf.TerraformStack

`fqn`^Required

public readonly fqn: string;

Type: string

`friendlyUniqueId`^Required

public readonly friendlyUniqueId: string;

Type: string

`terraformMetaArguments`^Required

public readonly terraformMetaArguments: {[ key: string ]: any};

Type: {[ key: string ]: any}

`terraformResourceType`^Required

public readonly terraformResourceType: string;

Type: string

`terraformGeneratorMetadata`^Optional

public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;

Type: cdktf.TerraformProviderGeneratorMetadata

`connection`^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

`count`^Optional

public readonly count: number | TerraformCount;

Type: number | cdktf.TerraformCount

`dependsOn`^Optional

public readonly dependsOn: string[];

Type: string[]

`forEach`^Optional

public readonly forEach: ITerraformIterator;

Type: cdktf.ITerraformIterator

`lifecycle`^Optional

public readonly lifecycle: TerraformResourceLifecycle;

Type: cdktf.TerraformResourceLifecycle

`provider`^Optional

public readonly provider: TerraformProvider;

Type: cdktf.TerraformProvider

`provisioners`^Optional

public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];

Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

`arn`^Required

public readonly arn: string;

Type: string

`homeDirectoryMappings`^Required

public readonly homeDirectoryMappings: TransferUserHomeDirectoryMappingsList;

Type: TransferUserHomeDirectoryMappingsList

`posixProfile`^Required

public readonly posixProfile: TransferUserPosixProfileOutputReference;

Type: TransferUserPosixProfileOutputReference

`homeDirectoryInput`^Optional

public readonly homeDirectoryInput: string;

Type: string

`homeDirectoryMappingsInput`^Optional

public readonly homeDirectoryMappingsInput: IResolvable | TransferUserHomeDirectoryMappings[];

Type: cdktf.IResolvable | TransferUserHomeDirectoryMappings[]

`homeDirectoryTypeInput`^Optional

public readonly homeDirectoryTypeInput: string;

Type: string

`idInput`^Optional

public readonly idInput: string;

Type: string

`policyInput`^Optional

public readonly policyInput: string;

Type: string

`posixProfileInput`^Optional

public readonly posixProfileInput: TransferUserPosixProfile;

Type: TransferUserPosixProfile

`roleInput`^Optional

public readonly roleInput: string;

Type: string

`serverIdInput`^Optional

public readonly serverIdInput: string;

Type: string

`tagsAllInput`^Optional

public readonly tagsAllInput: {[ key: string ]: string};

Type: {[ key: string ]: string}

`tagsInput`^Optional

public readonly tagsInput: {[ key: string ]: string};

Type: {[ key: string ]: string}

`userNameInput`^Optional

public readonly userNameInput: string;

Type: string

`homeDirectory`^Required

public readonly homeDirectory: string;

Type: string

`homeDirectoryType`^Required

public readonly homeDirectoryType: string;

Type: string

`id`^Required

public readonly id: string;

Type: string

`policy`^Required

public readonly policy: string;

Type: string

`role`^Required

public readonly role: string;

Type: string

`serverId`^Required

public readonly serverId: string;

Type: string

`tags`^Required

public readonly tags: {[ key: string ]: string};

Type: {[ key: string ]: string}

`tagsAll`^Required

public readonly tagsAll: {[ key: string ]: string};

Type: {[ key: string ]: string}

`userName`^Required

public readonly userName: string;

Type: string

Constants

Name	Type	Description
`tfResourceType`	`string`	No description.

`tfResourceType`^Required

public readonly tfResourceType: string;

Type: string

Structs

TransferUserConfig

Initializer

import { transferUser } from '@cdktf/aws-cdk'

const transferUserConfig: transferUser.TransferUserConfig = { ... }

Properties

Name	Type	Description
`connection`	`cdktf.SSHProvisionerConnection \| cdktf.WinrmProvisionerConnection`	No description.
`count`	`number \| cdktf.TerraformCount`	No description.
`dependsOn`	`cdktf.ITerraformDependable[]`	No description.
`forEach`	`cdktf.ITerraformIterator`	No description.
`lifecycle`	`cdktf.TerraformResourceLifecycle`	No description.
`provider`	`cdktf.TerraformProvider`	No description.
`provisioners`	`cdktf.FileProvisioner \| cdktf.LocalExecProvisioner \| cdktf.RemoteExecProvisioner[]`	No description.
`role`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/transfer_user#role TransferUser#role}.
`serverId`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/transfer_user#server_id TransferUser#server_id}.
`userName`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/transfer_user#user_name TransferUser#user_name}.
`homeDirectory`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/transfer_user#home_directory TransferUser#home_directory}.
`homeDirectoryMappings`	`cdktf.IResolvable \| TransferUserHomeDirectoryMappings[]`	home_directory_mappings block.
`homeDirectoryType`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/transfer_user#home_directory_type TransferUser#home_directory_type}.
`id`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/transfer_user#id TransferUser#id}.
`policy`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/transfer_user#policy TransferUser#policy}.
`posixProfile`	`TransferUserPosixProfile`	posix_profile block.
`tags`	`{[ key: string ]: string}`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/transfer_user#tags TransferUser#tags}.
`tagsAll`	`{[ key: string ]: string}`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/transfer_user#tags_all TransferUser#tags_all}.

`connection`^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

`count`^Optional

public readonly count: number | TerraformCount;

Type: number | cdktf.TerraformCount

`dependsOn`^Optional

public readonly dependsOn: ITerraformDependable[];

Type: cdktf.ITerraformDependable[]

`forEach`^Optional

public readonly forEach: ITerraformIterator;

Type: cdktf.ITerraformIterator

`lifecycle`^Optional

public readonly lifecycle: TerraformResourceLifecycle;

Type: cdktf.TerraformResourceLifecycle

`provider`^Optional

public readonly provider: TerraformProvider;

Type: cdktf.TerraformProvider

`provisioners`^Optional

public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];

Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

`role`^Required

public readonly role: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/transfer_user#role TransferUser#role}.

`serverId`^Required

public readonly serverId: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/transfer_user#server_id TransferUser#server_id}.

`userName`^Required

public readonly userName: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/transfer_user#user_name TransferUser#user_name}.

`homeDirectory`^Optional

public readonly homeDirectory: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/transfer_user#home_directory TransferUser#home_directory}.

`homeDirectoryMappings`^Optional

public readonly homeDirectoryMappings: IResolvable | TransferUserHomeDirectoryMappings[];

Type: cdktf.IResolvable | TransferUserHomeDirectoryMappings[]

home_directory_mappings block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/transfer_user#home_directory_mappings TransferUser#home_directory_mappings}

`homeDirectoryType`^Optional

public readonly homeDirectoryType: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/transfer_user#home_directory_type TransferUser#home_directory_type}.

`id`^Optional

public readonly id: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/transfer_user#id TransferUser#id}.

Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

`policy`^Optional

public readonly policy: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/transfer_user#policy TransferUser#policy}.

`posixProfile`^Optional

public readonly posixProfile: TransferUserPosixProfile;

Type: TransferUserPosixProfile

posix_profile block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/transfer_user#posix_profile TransferUser#posix_profile}

`tags`^Optional

public readonly tags: {[ key: string ]: string};

Type: {[ key: string ]: string}

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/transfer_user#tags TransferUser#tags}.

`tagsAll`^Optional

public readonly tagsAll: {[ key: string ]: string};

Type: {[ key: string ]: string}

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/transfer_user#tags_all TransferUser#tags_all}.

TransferUserHomeDirectoryMappings

Initializer

import { transferUser } from '@cdktf/aws-cdk'

const transferUserHomeDirectoryMappings: transferUser.TransferUserHomeDirectoryMappings = { ... }

Properties

Name	Type	Description
`entry`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/transfer_user#entry TransferUser#entry}.
`target`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/transfer_user#target TransferUser#target}.

`entry`^Required

public readonly entry: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/transfer_user#entry TransferUser#entry}.

`target`^Required

public readonly target: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/transfer_user#target TransferUser#target}.

TransferUserPosixProfile

Initializer

import { transferUser } from '@cdktf/aws-cdk'

const transferUserPosixProfile: transferUser.TransferUserPosixProfile = { ... }

Properties

Name	Type	Description
`gid`	`number`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/transfer_user#gid TransferUser#gid}.
`uid`	`number`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/transfer_user#uid TransferUser#uid}.
`secondaryGids`	`number[]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/transfer_user#secondary_gids TransferUser#secondary_gids}.

`gid`^Required

public readonly gid: number;

Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/transfer_user#gid TransferUser#gid}.

`uid`^Required

public readonly uid: number;

Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/transfer_user#uid TransferUser#uid}.

`secondaryGids`^Optional

public readonly secondaryGids: number[];

Type: number[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/transfer_user#secondary_gids TransferUser#secondary_gids}.

Classes

TransferUserHomeDirectoryMappingsList

Initializers

import { transferUser } from '@cdktf/aws-cdk'

new transferUser.TransferUserHomeDirectoryMappingsList(terraformResource: IInterpolatingParent, terraformAttribute: string, wrapsSet: boolean)

Name	Type	Description
`terraformResource`	`cdktf.IInterpolatingParent`	The parent resource.
`terraformAttribute`	`string`	The attribute on the parent resource this class is referencing.
`wrapsSet`	`boolean`	whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

`terraformResource`^Required

Type: cdktf.IInterpolatingParent

The parent resource.

`terraformAttribute`^Required

Type: string

The attribute on the parent resource this class is referencing.

`wrapsSet`^Required

Type: boolean

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

Methods

Name	Description
`allWithMapKey`	Creating an iterator for this complex list.
`computeFqn`	No description.
`resolve`	Produce the Token's value at resolution time.
`toString`	Return a string representation of this resolvable object.
`get`	No description.

`allWithMapKey`

public allWithMapKey(mapKeyAttributeName: string): DynamicListTerraformIterator

Creating an iterator for this complex list.

The list will be converted into a map with the mapKeyAttributeName as the key.

`mapKeyAttributeName`^Required

Type: string

`computeFqn`

public computeFqn(): string

`resolve`

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

`_context`^Required

Type: cdktf.IResolveContext

`toString`

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

`get`

public get(index: number): TransferUserHomeDirectoryMappingsOutputReference

`index`^Required

Type: number

the index of the item to return.

Properties

Name	Type	Description
`creationStack`	`string[]`	The creation stack of this resolvable which will be appended to errors thrown during resolution.
`fqn`	`string`	No description.
`internalValue`	`cdktf.IResolvable \| TransferUserHomeDirectoryMappings[]`	No description.

`creationStack`^Required

public readonly creationStack: string[];

Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

`fqn`^Required

public readonly fqn: string;

Type: string

`internalValue`^Optional

public readonly internalValue: IResolvable | TransferUserHomeDirectoryMappings[];

Type: cdktf.IResolvable | TransferUserHomeDirectoryMappings[]

TransferUserHomeDirectoryMappingsOutputReference

Initializers

import { transferUser } from '@cdktf/aws-cdk'

new transferUser.TransferUserHomeDirectoryMappingsOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string, complexObjectIndex: number, complexObjectIsFromSet: boolean)

Name	Type	Description
`terraformResource`	`cdktf.IInterpolatingParent`	The parent resource.
`terraformAttribute`	`string`	The attribute on the parent resource this class is referencing.
`complexObjectIndex`	`number`	the index of this item in the list.
`complexObjectIsFromSet`	`boolean`	whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

`terraformResource`^Required

Type: cdktf.IInterpolatingParent

The parent resource.

`terraformAttribute`^Required

Type: string

The attribute on the parent resource this class is referencing.

`complexObjectIndex`^Required

Type: number

the index of this item in the list.

`complexObjectIsFromSet`^Required

Type: boolean

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

Methods

Name	Description
`computeFqn`	No description.
`getAnyMapAttribute`	No description.
`getBooleanAttribute`	No description.
`getBooleanMapAttribute`	No description.
`getListAttribute`	No description.
`getNumberAttribute`	No description.
`getNumberListAttribute`	No description.
`getNumberMapAttribute`	No description.
`getStringAttribute`	No description.
`getStringMapAttribute`	No description.
`interpolationForAttribute`	No description.
`resolve`	Produce the Token's value at resolution time.
`toString`	Return a string representation of this resolvable object.

`computeFqn`

public computeFqn(): string

`getAnyMapAttribute`

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

`terraformAttribute`^Required

Type: string

`getBooleanAttribute`

public getBooleanAttribute(terraformAttribute: string): IResolvable

`terraformAttribute`^Required

Type: string

`getBooleanMapAttribute`

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

`terraformAttribute`^Required

Type: string

`getListAttribute`

public getListAttribute(terraformAttribute: string): string[]

`terraformAttribute`^Required

Type: string

`getNumberAttribute`

public getNumberAttribute(terraformAttribute: string): number

`terraformAttribute`^Required

Type: string

`getNumberListAttribute`

public getNumberListAttribute(terraformAttribute: string): number[]

`terraformAttribute`^Required

Type: string

`getNumberMapAttribute`

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

`terraformAttribute`^Required

Type: string

`getStringAttribute`

public getStringAttribute(terraformAttribute: string): string

`terraformAttribute`^Required

Type: string

`getStringMapAttribute`

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

`terraformAttribute`^Required

Type: string

`interpolationForAttribute`

public interpolationForAttribute(property: string): IResolvable

`property`^Required

Type: string

`resolve`

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

`_context`^Required

Type: cdktf.IResolveContext

`toString`

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

Properties

Name	Type	Description
`creationStack`	`string[]`	The creation stack of this resolvable which will be appended to errors thrown during resolution.
`fqn`	`string`	No description.
`entryInput`	`string`	No description.
`targetInput`	`string`	No description.
`entry`	`string`	No description.
`target`	`string`	No description.
`internalValue`	`cdktf.IResolvable \| TransferUserHomeDirectoryMappings`	No description.

`creationStack`^Required

public readonly creationStack: string[];

Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

`fqn`^Required

public readonly fqn: string;

Type: string

`entryInput`^Optional

public readonly entryInput: string;

Type: string

`targetInput`^Optional

public readonly targetInput: string;

Type: string

`entry`^Required

public readonly entry: string;

Type: string

`target`^Required

public readonly target: string;

Type: string

`internalValue`^Optional

public readonly internalValue: IResolvable | TransferUserHomeDirectoryMappings;

Type: cdktf.IResolvable | TransferUserHomeDirectoryMappings

TransferUserPosixProfileOutputReference

Initializers

import { transferUser } from '@cdktf/aws-cdk'

new transferUser.TransferUserPosixProfileOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)

Name	Type	Description
`terraformResource`	`cdktf.IInterpolatingParent`	The parent resource.
`terraformAttribute`	`string`	The attribute on the parent resource this class is referencing.

`terraformResource`^Required

Type: cdktf.IInterpolatingParent

The parent resource.

`terraformAttribute`^Required

Type: string

The attribute on the parent resource this class is referencing.

Methods

Name	Description
`computeFqn`	No description.
`getAnyMapAttribute`	No description.
`getBooleanAttribute`	No description.
`getBooleanMapAttribute`	No description.
`getListAttribute`	No description.
`getNumberAttribute`	No description.
`getNumberListAttribute`	No description.
`getNumberMapAttribute`	No description.
`getStringAttribute`	No description.
`getStringMapAttribute`	No description.
`interpolationForAttribute`	No description.
`resolve`	Produce the Token's value at resolution time.
`toString`	Return a string representation of this resolvable object.
`resetSecondaryGids`	No description.

`computeFqn`

public computeFqn(): string

`getAnyMapAttribute`

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

`terraformAttribute`^Required

Type: string

`getBooleanAttribute`

public getBooleanAttribute(terraformAttribute: string): IResolvable

`terraformAttribute`^Required

Type: string

`getBooleanMapAttribute`

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

`terraformAttribute`^Required

Type: string

`getListAttribute`

public getListAttribute(terraformAttribute: string): string[]

`terraformAttribute`^Required

Type: string

`getNumberAttribute`

public getNumberAttribute(terraformAttribute: string): number

`terraformAttribute`^Required

Type: string

`getNumberListAttribute`

public getNumberListAttribute(terraformAttribute: string): number[]

`terraformAttribute`^Required

Type: string

`getNumberMapAttribute`

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

`terraformAttribute`^Required

Type: string

`getStringAttribute`

public getStringAttribute(terraformAttribute: string): string

`terraformAttribute`^Required

Type: string

`getStringMapAttribute`

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

`terraformAttribute`^Required

Type: string

`interpolationForAttribute`

public interpolationForAttribute(property: string): IResolvable

`property`^Required

Type: string

`resolve`

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

`_context`^Required

Type: cdktf.IResolveContext

`toString`

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

`resetSecondaryGids`

public resetSecondaryGids(): void

Properties

Name	Type	Description
`creationStack`	`string[]`	The creation stack of this resolvable which will be appended to errors thrown during resolution.
`fqn`	`string`	No description.
`gidInput`	`number`	No description.
`secondaryGidsInput`	`number[]`	No description.
`uidInput`	`number`	No description.
`gid`	`number`	No description.
`secondaryGids`	`number[]`	No description.
`uid`	`number`	No description.
`internalValue`	`TransferUserPosixProfile`	No description.

`creationStack`^Required

public readonly creationStack: string[];

Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

`fqn`^Required

public readonly fqn: string;

Type: string

`gidInput`^Optional

public readonly gidInput: number;

Type: number

`secondaryGidsInput`^Optional

public readonly secondaryGidsInput: number[];

Type: number[]

`uidInput`^Optional

public readonly uidInput: number;

Type: number

`gid`^Required

public readonly gid: number;

Type: number

`secondaryGids`^Required

public readonly secondaryGids: number[];

Type: number[]

`uid`^Required

public readonly uid: number;

Type: number

`internalValue`^Optional

public readonly internalValue: TransferUserPosixProfile;

Type: TransferUserPosixProfile

Uh oh!

FilesExpand file tree

transferUser.md

Latest commit

History

transferUser.md

File metadata and controls

transferUser Submodule

Constructs

TransferUser

Initializers

scopeRequired

idRequired

configRequired

Methods

toString

addOverride

pathRequired

valueRequired

overrideLogicalId

newLogicalIdRequired

resetOverrideLogicalId

toHclTerraform

toMetadata

toTerraform

addMoveTarget

moveTargetRequired

getAnyMapAttribute

terraformAttributeRequired

getBooleanAttribute

terraformAttributeRequired

getBooleanMapAttribute

terraformAttributeRequired

getListAttribute

terraformAttributeRequired

getNumberAttribute

terraformAttributeRequired

getNumberListAttribute

terraformAttributeRequired

getNumberMapAttribute

terraformAttributeRequired

getStringAttribute

terraformAttributeRequired

getStringMapAttribute

terraformAttributeRequired

hasResourceMove

importFrom

idRequired

providerOptional

interpolationForAttribute

terraformAttributeRequired

moveFromId

idRequired

moveTo

moveTargetRequired

indexOptional

moveToId

idRequired

putHomeDirectoryMappings

valueRequired

putPosixProfile

valueRequired

resetHomeDirectory

resetHomeDirectoryMappings

resetHomeDirectoryType

resetId

resetPolicy

resetPosixProfile

resetTags

resetTagsAll

Static Functions

isConstruct

xRequired

isTerraformElement

xRequired

isTerraformResource

xRequired

generateConfigForImport

scopeRequired

importToIdRequired

`transferUser` Submodule

`scope`^Required

`id`^Required

`config`^Required

`toString`

`addOverride`

`path`^Required

`value`^Required

`overrideLogicalId`

`newLogicalId`^Required

`resetOverrideLogicalId`

`toHclTerraform`

`toMetadata`

`toTerraform`

`addMoveTarget`

`moveTarget`^Required

`getAnyMapAttribute`

`terraformAttribute`^Required

`getBooleanAttribute`

`terraformAttribute`^Required

`getBooleanMapAttribute`

`terraformAttribute`^Required

`getListAttribute`

`terraformAttribute`^Required

`getNumberAttribute`

`terraformAttribute`^Required

`getNumberListAttribute`

`terraformAttribute`^Required

`getNumberMapAttribute`

`terraformAttribute`^Required

`getStringAttribute`

`terraformAttribute`^Required

`getStringMapAttribute`

`terraformAttribute`^Required

`hasResourceMove`

`importFrom`

`id`^Required

`provider`^Optional

`interpolationForAttribute`

`terraformAttribute`^Required

`moveFromId`

`id`^Required

`moveTo`

`moveTarget`^Required

`index`^Optional

`moveToId`

`id`^Required

`putHomeDirectoryMappings`

`value`^Required

`putPosixProfile`

`value`^Required

`resetHomeDirectory`

`resetHomeDirectoryMappings`

`resetHomeDirectoryType`

`resetId`

`resetPolicy`

`resetPosixProfile`

`resetTags`

`resetTagsAll`

`isConstruct`

`x`^Required

`isTerraformElement`

`x`^Required

`isTerraformResource`

`x`^Required

`generateConfigForImport`

`scope`^Required

`importToId`^Required

`importFromId`^Required

`provider`^Optional

`node`^Required

`cdktfStack`^Required

`fqn`^Required

`friendlyUniqueId`^Required

`terraformMetaArguments`^Required

`terraformResourceType`^Required

`terraformGeneratorMetadata`^Optional

`connection`^Optional

`count`^Optional

`dependsOn`^Optional