Skip to content
This repository was archived by the owner on Dec 10, 2025. It is now read-only.

transferServer.md

Latest commit

 

History

History
2002 lines (1252 loc) · 83.1 KB

transferServer.md

File metadata and controls

2002 lines (1252 loc) · 83.1 KB
Raw

transferServer Submodule

Constructs

TransferServer

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

Initializers 

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

new transferServer.TransferServer(scope: Construct, id: string, config?: TransferServerConfig)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id string The scoped construct ID.
config TransferServerConfig No description.
scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

idRequired
  • Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

configOptional

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".
putEndpointDetails No description.
resetCertificate No description.
resetDirectoryId No description.
resetDomain No description.
resetEndpointDetails No description.
resetEndpointType No description.
resetForceDestroy No description.
resetFunction No description.
resetHostKey No description.
resetId No description.
resetIdentityProviderType No description.
resetInvocationRole No description.
resetLoggingRole No description.
resetProtocols No description.
resetSecurityPolicyName No description.
resetTags No description.
resetTagsAll No description.
resetUrl No description.
toString 
public toString(): string

Returns a string representation of this construct.

addOverride 
public addOverride(path: string, value: any): void
pathRequired
  • Type: string
valueRequired
  • Type: any
overrideLogicalId 
public overrideLogicalId(newLogicalId: string): void

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

newLogicalIdRequired
  • 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.

moveTargetRequired
  • Type: string

The string move target that will correspond to this resource.

getAnyMapAttribute 
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string
getBooleanAttribute 
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string
getBooleanMapAttribute 
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
terraformAttributeRequired
  • Type: string
getListAttribute 
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string
getNumberAttribute 
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string
getNumberListAttribute 
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string
getNumberMapAttribute 
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
terraformAttributeRequired
  • Type: string
getStringAttribute 
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string
getStringMapAttribute 
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
terraformAttributeRequired
  • Type: string
hasResourceMove 
public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById
importFrom 
public importFrom(id: string, provider?: TerraformProvider): void
idRequired
  • Type: string
providerOptional
  • Type: cdktf.TerraformProvider
interpolationForAttribute 
public interpolationForAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • 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.

idRequired
  • 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.

moveTargetRequired
  • Type: string

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

indexOptional
  • 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".

idRequired
  • Type: string

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

putEndpointDetails 
public putEndpointDetails(value: TransferServerEndpointDetails): void
valueRequired
resetCertificate 
public resetCertificate(): void
resetDirectoryId 
public resetDirectoryId(): void
resetDomain 
public resetDomain(): void
resetEndpointDetails 
public resetEndpointDetails(): void
resetEndpointType 
public resetEndpointType(): void
resetForceDestroy 
public resetForceDestroy(): void
resetFunction 
public resetFunction(): void
resetHostKey 
public resetHostKey(): void
resetId 
public resetId(): void
resetIdentityProviderType 
public resetIdentityProviderType(): void
resetInvocationRole 
public resetInvocationRole(): void
resetLoggingRole 
public resetLoggingRole(): void
resetProtocols 
public resetProtocols(): void
resetSecurityPolicyName 
public resetSecurityPolicyName(): void
resetTags 
public resetTags(): void
resetTagsAll 
public resetTagsAll(): void
resetUrl 
public resetUrl(): 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 TransferServer resource upon running "cdktf plan ".
isConstruct 
import { transferServer } from '@cdktf/aws-cdk'

transferServer.TransferServer.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.

xRequired
  • Type: any

Any object.

isTerraformElement 
import { transferServer } from '@cdktf/aws-cdk'

transferServer.TransferServer.isTerraformElement(x: any)
xRequired
  • Type: any
isTerraformResource 
import { transferServer } from '@cdktf/aws-cdk'

transferServer.TransferServer.isTerraformResource(x: any)
xRequired
  • Type: any
generateConfigForImport 
import { transferServer } from '@cdktf/aws-cdk'

transferServer.TransferServer.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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

scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

importToIdRequired
  • Type: string

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

importFromIdRequired
  • Type: string

The id of the existing TransferServer that should be imported.

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

providerOptional
  • Type: cdktf.TerraformProvider

? Optional instance of the provider where the TransferServer 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.
endpoint string No description.
endpointDetails TransferServerEndpointDetailsOutputReference No description.
hostKeyFingerprint string No description.
certificateInput string No description.
directoryIdInput string No description.
domainInput string No description.
endpointDetailsInput TransferServerEndpointDetails No description.
endpointTypeInput string No description.
forceDestroyInput boolean | cdktf.IResolvable No description.
functionInput string No description.
hostKeyInput string No description.
identityProviderTypeInput string No description.
idInput string No description.
invocationRoleInput string No description.
loggingRoleInput string No description.
protocolsInput string[] No description.
securityPolicyNameInput string No description.
tagsAllInput {[ key: string ]: string} No description.
tagsInput {[ key: string ]: string} No description.
urlInput string No description.
certificate string No description.
directoryId string No description.
domain string No description.
endpointType string No description.
forceDestroy boolean | cdktf.IResolvable No description.
function string No description.
hostKey string No description.
id string No description.
identityProviderType string No description.
invocationRole string No description.
loggingRole string No description.
protocols string[] No description.
securityPolicyName string No description.
tags {[ key: string ]: string} No description.
tagsAll {[ key: string ]: string} No description.
url string No description.
nodeRequired 
public readonly node: Node;
  • Type: constructs.Node

The tree node.

cdktfStackRequired 
public readonly cdktfStack: TerraformStack;
  • Type: cdktf.TerraformStack
fqnRequired 
public readonly fqn: string;
  • Type: string
friendlyUniqueIdRequired 
public readonly friendlyUniqueId: string;
  • Type: string
terraformMetaArgumentsRequired 
public readonly terraformMetaArguments: {[ key: string ]: any};
  • Type: {[ key: string ]: any}
terraformResourceTypeRequired 
public readonly terraformResourceType: string;
  • Type: string
terraformGeneratorMetadataOptional 
public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;
  • Type: cdktf.TerraformProviderGeneratorMetadata
connectionOptional 
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
  • Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection
countOptional 
public readonly count: number | TerraformCount;
  • Type: number | cdktf.TerraformCount
dependsOnOptional 
public readonly dependsOn: string[];
  • Type: string[]
forEachOptional 
public readonly forEach: ITerraformIterator;
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
public readonly provider: TerraformProvider;
  • Type: cdktf.TerraformProvider
provisionersOptional 
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
  • Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]
arnRequired 
public readonly arn: string;
  • Type: string
endpointRequired 
public readonly endpoint: string;
  • Type: string
endpointDetailsRequired 
public readonly endpointDetails: TransferServerEndpointDetailsOutputReference;
hostKeyFingerprintRequired 
public readonly hostKeyFingerprint: string;
  • Type: string
certificateInputOptional 
public readonly certificateInput: string;
  • Type: string
directoryIdInputOptional 
public readonly directoryIdInput: string;
  • Type: string
domainInputOptional 
public readonly domainInput: string;
  • Type: string
endpointDetailsInputOptional 
public readonly endpointDetailsInput: TransferServerEndpointDetails;
endpointTypeInputOptional 
public readonly endpointTypeInput: string;
  • Type: string
forceDestroyInputOptional 
public readonly forceDestroyInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
functionInputOptional 
public readonly functionInput: string;
  • Type: string
hostKeyInputOptional 
public readonly hostKeyInput: string;
  • Type: string
identityProviderTypeInputOptional 
public readonly identityProviderTypeInput: string;
  • Type: string
idInputOptional 
public readonly idInput: string;
  • Type: string
invocationRoleInputOptional 
public readonly invocationRoleInput: string;
  • Type: string
loggingRoleInputOptional 
public readonly loggingRoleInput: string;
  • Type: string
protocolsInputOptional 
public readonly protocolsInput: string[];
  • Type: string[]
securityPolicyNameInputOptional 
public readonly securityPolicyNameInput: string;
  • Type: string
tagsAllInputOptional 
public readonly tagsAllInput: {[ key: string ]: string};
  • Type: {[ key: string ]: string}
tagsInputOptional 
public readonly tagsInput: {[ key: string ]: string};
  • Type: {[ key: string ]: string}
urlInputOptional 
public readonly urlInput: string;
  • Type: string
certificateRequired 
public readonly certificate: string;
  • Type: string
directoryIdRequired 
public readonly directoryId: string;
  • Type: string
domainRequired 
public readonly domain: string;
  • Type: string
endpointTypeRequired 
public readonly endpointType: string;
  • Type: string
forceDestroyRequired 
public readonly forceDestroy: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
functionRequired 
public readonly function: string;
  • Type: string
hostKeyRequired 
public readonly hostKey: string;
  • Type: string
idRequired 
public readonly id: string;
  • Type: string
identityProviderTypeRequired 
public readonly identityProviderType: string;
  • Type: string
invocationRoleRequired 
public readonly invocationRole: string;
  • Type: string
loggingRoleRequired 
public readonly loggingRole: string;
  • Type: string
protocolsRequired 
public readonly protocols: string[];
  • Type: string[]
securityPolicyNameRequired 
public readonly securityPolicyName: string;
  • Type: string
tagsRequired 
public readonly tags: {[ key: string ]: string};
  • Type: {[ key: string ]: string}
tagsAllRequired 
public readonly tagsAll: {[ key: string ]: string};
  • Type: {[ key: string ]: string}
urlRequired 
public readonly url: string;
  • Type: string

Constants

Name Type Description
tfResourceType string No description.
tfResourceTypeRequired 
public readonly tfResourceType: string;
  • Type: string

Structs

TransferServerConfig

Initializer 

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

const transferServerConfig: transferServer.TransferServerConfig = { ... }

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.
certificate string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/transfer_server#certificate TransferServer#certificate}.
directoryId string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/transfer_server#directory_id TransferServer#directory_id}.
domain string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/transfer_server#domain TransferServer#domain}.
endpointDetails TransferServerEndpointDetails endpoint_details block.
endpointType string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/transfer_server#endpoint_type TransferServer#endpoint_type}.
forceDestroy boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/transfer_server#force_destroy TransferServer#force_destroy}.
function string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/transfer_server#function TransferServer#function}.
hostKey string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/transfer_server#host_key TransferServer#host_key}.
id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/transfer_server#id TransferServer#id}.
identityProviderType string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/transfer_server#identity_provider_type TransferServer#identity_provider_type}.
invocationRole string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/transfer_server#invocation_role TransferServer#invocation_role}.
loggingRole string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/transfer_server#logging_role TransferServer#logging_role}.
protocols string[] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/transfer_server#protocols TransferServer#protocols}.
securityPolicyName string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/transfer_server#security_policy_name TransferServer#security_policy_name}.
tags {[ key: string ]: string} Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/transfer_server#tags TransferServer#tags}.
tagsAll {[ key: string ]: string} Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/transfer_server#tags_all TransferServer#tags_all}.
url string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/transfer_server#url TransferServer#url}.
connectionOptional 
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
  • Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection
countOptional 
public readonly count: number | TerraformCount;
  • Type: number | cdktf.TerraformCount
dependsOnOptional 
public readonly dependsOn: ITerraformDependable[];
  • Type: cdktf.ITerraformDependable[]
forEachOptional 
public readonly forEach: ITerraformIterator;
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
public readonly provider: TerraformProvider;
  • Type: cdktf.TerraformProvider
provisionersOptional 
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
  • Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]
certificateOptional 
public readonly certificate: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/transfer_server#certificate TransferServer#certificate}.

directoryIdOptional 
public readonly directoryId: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/transfer_server#directory_id TransferServer#directory_id}.

domainOptional 
public readonly domain: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/transfer_server#domain TransferServer#domain}.

endpointDetailsOptional 
public readonly endpointDetails: TransferServerEndpointDetails;

endpoint_details block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/transfer_server#endpoint_details TransferServer#endpoint_details}

endpointTypeOptional 
public readonly endpointType: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/transfer_server#endpoint_type TransferServer#endpoint_type}.

forceDestroyOptional 
public readonly forceDestroy: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/transfer_server#force_destroy TransferServer#force_destroy}.

functionOptional 
public readonly function: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/transfer_server#function TransferServer#function}.

hostKeyOptional 
public readonly hostKey: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/transfer_server#host_key TransferServer#host_key}.

idOptional 
public readonly id: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/transfer_server#id TransferServer#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.

identityProviderTypeOptional 
public readonly identityProviderType: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/transfer_server#identity_provider_type TransferServer#identity_provider_type}.

invocationRoleOptional 
public readonly invocationRole: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/transfer_server#invocation_role TransferServer#invocation_role}.

loggingRoleOptional 
public readonly loggingRole: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/transfer_server#logging_role TransferServer#logging_role}.

protocolsOptional 
public readonly protocols: string[];
  • Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/transfer_server#protocols TransferServer#protocols}.

securityPolicyNameOptional 
public readonly securityPolicyName: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/transfer_server#security_policy_name TransferServer#security_policy_name}.

tagsOptional 
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_server#tags TransferServer#tags}.

tagsAllOptional 
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_server#tags_all TransferServer#tags_all}.

urlOptional 
public readonly url: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/transfer_server#url TransferServer#url}.

TransferServerEndpointDetails

Initializer 

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

const transferServerEndpointDetails: transferServer.TransferServerEndpointDetails = { ... }

Properties

Name Type Description
addressAllocationIds string[] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/transfer_server#address_allocation_ids TransferServer#address_allocation_ids}.
securityGroupIds string[] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/transfer_server#security_group_ids TransferServer#security_group_ids}.
subnetIds string[] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/transfer_server#subnet_ids TransferServer#subnet_ids}.
vpcEndpointId string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/transfer_server#vpc_endpoint_id TransferServer#vpc_endpoint_id}.
vpcId string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/transfer_server#vpc_id TransferServer#vpc_id}.
addressAllocationIdsOptional 
public readonly addressAllocationIds: string[];
  • Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/transfer_server#address_allocation_ids TransferServer#address_allocation_ids}.

securityGroupIdsOptional 
public readonly securityGroupIds: string[];
  • Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/transfer_server#security_group_ids TransferServer#security_group_ids}.

subnetIdsOptional 
public readonly subnetIds: string[];
  • Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/transfer_server#subnet_ids TransferServer#subnet_ids}.

vpcEndpointIdOptional 
public readonly vpcEndpointId: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/transfer_server#vpc_endpoint_id TransferServer#vpc_endpoint_id}.

vpcIdOptional 
public readonly vpcId: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/transfer_server#vpc_id TransferServer#vpc_id}.

Classes

TransferServerEndpointDetailsOutputReference

Initializers 

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

new transferServer.TransferServerEndpointDetailsOutputReference(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.
terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • 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.
resetAddressAllocationIds No description.
resetSecurityGroupIds No description.
resetSubnetIds No description.
resetVpcEndpointId No description.
resetVpcId No description.
computeFqn 
public computeFqn(): string
getAnyMapAttribute 
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string
getBooleanAttribute 
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string
getBooleanMapAttribute 
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
terraformAttributeRequired
  • Type: string
getListAttribute 
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string
getNumberAttribute 
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string
getNumberListAttribute 
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string
getNumberMapAttribute 
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
terraformAttributeRequired
  • Type: string
getStringAttribute 
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string
getStringMapAttribute 
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
terraformAttributeRequired
  • Type: string
interpolationForAttribute 
public interpolationForAttribute(property: string): IResolvable
propertyRequired
  • Type: string
resolve 
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext
toString 
public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

resetAddressAllocationIds 
public resetAddressAllocationIds(): void
resetSecurityGroupIds 
public resetSecurityGroupIds(): void
resetSubnetIds 
public resetSubnetIds(): void
resetVpcEndpointId 
public resetVpcEndpointId(): void
resetVpcId 
public resetVpcId(): 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.
addressAllocationIdsInput string[] No description.
securityGroupIdsInput string[] No description.
subnetIdsInput string[] No description.
vpcEndpointIdInput string No description.
vpcIdInput string No description.
addressAllocationIds string[] No description.
securityGroupIds string[] No description.
subnetIds string[] No description.
vpcEndpointId string No description.
vpcId string No description.
internalValue TransferServerEndpointDetails No description.
creationStackRequired 
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.

fqnRequired 
public readonly fqn: string;
  • Type: string
addressAllocationIdsInputOptional 
public readonly addressAllocationIdsInput: string[];
  • Type: string[]
securityGroupIdsInputOptional 
public readonly securityGroupIdsInput: string[];
  • Type: string[]
subnetIdsInputOptional 
public readonly subnetIdsInput: string[];
  • Type: string[]
vpcEndpointIdInputOptional 
public readonly vpcEndpointIdInput: string;
  • Type: string
vpcIdInputOptional 
public readonly vpcIdInput: string;
  • Type: string
addressAllocationIdsRequired 
public readonly addressAllocationIds: string[];
  • Type: string[]
securityGroupIdsRequired 
public readonly securityGroupIds: string[];
  • Type: string[]
subnetIdsRequired 
public readonly subnetIds: string[];
  • Type: string[]
vpcEndpointIdRequired 
public readonly vpcEndpointId: string;
  • Type: string
vpcIdRequired 
public readonly vpcId: string;
  • Type: string
internalValueOptional 
public readonly internalValue: TransferServerEndpointDetails;