Skip to content

Latest commit

 

History

History
2276 lines (1423 loc) · 107 KB

transferConnector.java.md

File metadata and controls

2276 lines (1423 loc) · 107 KB
Raw

transferConnector Submodule

Constructs

TransferConnector

Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/transfer_connector aws_transfer_connector}.

Initializers 

import com.hashicorp.cdktf.providers.aws.transfer_connector.TransferConnector;

TransferConnector.Builder.create(Construct scope, java.lang.String id)
//  .connection(SSHProvisionerConnection)
//  .connection(WinrmProvisionerConnection)
//  .count(java.lang.Number)
//  .count(TerraformCount)
//  .dependsOn(java.util.List<ITerraformDependable>)
//  .forEach(ITerraformIterator)
//  .lifecycle(TerraformResourceLifecycle)
//  .provider(TerraformProvider)
//  .provisioners(java.util.List<FileProvisioner)
//  .provisioners(LocalExecProvisioner)
//  .provisioners(RemoteExecProvisioner>)
    .accessRole(java.lang.String)
    .url(java.lang.String)
//  .as2Config(TransferConnectorAs2Config)
//  .id(java.lang.String)
//  .loggingRole(java.lang.String)
//  .securityPolicyName(java.lang.String)
//  .sftpConfig(TransferConnectorSftpConfig)
//  .tags(java.util.Map<java.lang.String, java.lang.String>)
//  .tagsAll(java.util.Map<java.lang.String, java.lang.String>)
    .build();
Name Type Description
scope software.constructs.Construct The scope in which to define this construct.
id java.lang.String The scoped construct ID.
connection com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number OR com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<com.hashicorp.cdktf.ITerraformDependable> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
provisioners java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> No description.
accessRole java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/transfer_connector#access_role TransferConnector#access_role}.
url java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/transfer_connector#url TransferConnector#url}.
as2Config TransferConnectorAs2Config as2_config block.
id java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/transfer_connector#id TransferConnector#id}.
loggingRole java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/transfer_connector#logging_role TransferConnector#logging_role}.
securityPolicyName java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/transfer_connector#security_policy_name TransferConnector#security_policy_name}.
sftpConfig TransferConnectorSftpConfig sftp_config block.
tags java.util.Map<java.lang.String, java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/transfer_connector#tags TransferConnector#tags}.
tagsAll java.util.Map<java.lang.String, java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/transfer_connector#tags_all TransferConnector#tags_all}.
scopeRequired
  • Type: software.constructs.Construct

The scope in which to define this construct.

idRequired
  • Type: java.lang.String

The scoped construct ID.

Must be unique amongst siblings in the same scope

connectionOptional
  • Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection
countOptional
  • Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount
dependsOnOptional
  • Type: java.util.List<com.hashicorp.cdktf.ITerraformDependable>
forEachOptional
  • Type: com.hashicorp.cdktf.ITerraformIterator
lifecycleOptional
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle
providerOptional
  • Type: com.hashicorp.cdktf.TerraformProvider
provisionersOptional
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>
accessRoleRequired
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/transfer_connector#access_role TransferConnector#access_role}.

urlRequired
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/transfer_connector#url TransferConnector#url}.

as2ConfigOptional

as2_config block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/transfer_connector#as2_config TransferConnector#as2_config}

idOptional
  • Type: java.lang.String

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

loggingRoleOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/transfer_connector#logging_role TransferConnector#logging_role}.

securityPolicyNameOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/transfer_connector#security_policy_name TransferConnector#security_policy_name}.

sftpConfigOptional

sftp_config block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/transfer_connector#sftp_config TransferConnector#sftp_config}

tagsOptional
  • Type: java.util.Map<java.lang.String, java.lang.String>

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/transfer_connector#tags TransferConnector#tags}.

tagsAllOptional
  • Type: java.util.Map<java.lang.String, java.lang.String>

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/transfer_connector#tags_all TransferConnector#tags_all}.

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".
putAs2Config No description.
putSftpConfig No description.
resetAs2Config No description.
resetId No description.
resetLoggingRole No description.
resetSecurityPolicyName No description.
resetSftpConfig No description.
resetTags No description.
resetTagsAll No description.
toString 
public java.lang.String toString()

Returns a string representation of this construct.

addOverride 
public void addOverride(java.lang.String path, java.lang.Object value)
pathRequired
  • Type: java.lang.String
valueRequired
  • Type: java.lang.Object
overrideLogicalId 
public void overrideLogicalId(java.lang.String newLogicalId)

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

newLogicalIdRequired
  • Type: java.lang.String

The new logical ID to use for this stack element.

resetOverrideLogicalId 
public void resetOverrideLogicalId()

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

toHclTerraform 
public java.lang.Object toHclTerraform()
toMetadata 
public java.lang.Object toMetadata()
toTerraform 
public java.lang.Object toTerraform()

Adds this resource to the terraform JSON output.

addMoveTarget 
public void addMoveTarget(java.lang.String moveTarget)

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: java.lang.String

The string move target that will correspond to this resource.

getAnyMapAttribute 
public java.util.Map<java.lang.String, java.lang.Object> getAnyMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanAttribute 
public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanMapAttribute 
public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getListAttribute 
public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberAttribute 
public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberListAttribute 
public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberMapAttribute 
public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringAttribute 
public java.lang.String getStringAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringMapAttribute 
public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
hasResourceMove 
public TerraformResourceMoveByTarget OR TerraformResourceMoveById hasResourceMove()
importFrom 
public void importFrom(java.lang.String id)
public void importFrom(java.lang.String id, TerraformProvider provider)
idRequired
  • Type: java.lang.String
providerOptional
  • Type: com.hashicorp.cdktf.TerraformProvider
interpolationForAttribute 
public IResolvable interpolationForAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
moveFromId 
public void moveFromId(java.lang.String id)

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: java.lang.String

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

moveTo 
public void moveTo(java.lang.String moveTarget)
public void moveTo(java.lang.String moveTarget, java.lang.String OR java.lang.Number index)

Moves this resource to the target resource given by moveTarget.

moveTargetRequired
  • Type: java.lang.String

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

indexOptional
  • Type: java.lang.String OR java.lang.Number

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

moveToId 
public void moveToId(java.lang.String id)

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

idRequired
  • Type: java.lang.String

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

putAs2Config 
public void putAs2Config(TransferConnectorAs2Config value)
valueRequired
putSftpConfig 
public void putSftpConfig(TransferConnectorSftpConfig value)
valueRequired
resetAs2Config 
public void resetAs2Config()
resetId 
public void resetId()
resetLoggingRole 
public void resetLoggingRole()
resetSecurityPolicyName 
public void resetSecurityPolicyName()
resetSftpConfig 
public void resetSftpConfig()
resetTags 
public void resetTags()
resetTagsAll 
public void resetTagsAll()

Static Functions

Name Description
isConstruct Checks if x is a construct.
isTerraformElement No description.
isTerraformResource No description.
generateConfigForImport Generates CDKTF code for importing a TransferConnector resource upon running "cdktf plan ".
isConstruct 
import com.hashicorp.cdktf.providers.aws.transfer_connector.TransferConnector;

TransferConnector.isConstruct(java.lang.Object x)

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: java.lang.Object

Any object.

isTerraformElement 
import com.hashicorp.cdktf.providers.aws.transfer_connector.TransferConnector;

TransferConnector.isTerraformElement(java.lang.Object x)
xRequired
  • Type: java.lang.Object
isTerraformResource 
import com.hashicorp.cdktf.providers.aws.transfer_connector.TransferConnector;

TransferConnector.isTerraformResource(java.lang.Object x)
xRequired
  • Type: java.lang.Object
generateConfigForImport 
import com.hashicorp.cdktf.providers.aws.transfer_connector.TransferConnector;

TransferConnector.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),TransferConnector.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider)

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

scopeRequired
  • Type: software.constructs.Construct

The scope in which to define this construct.

importToIdRequired
  • Type: java.lang.String

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

importFromIdRequired
  • Type: java.lang.String

The id of the existing TransferConnector that should be imported.

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

providerOptional
  • Type: com.hashicorp.cdktf.TerraformProvider

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

Properties

Name Type Description
node software.constructs.Node The tree node.
cdktfStack com.hashicorp.cdktf.TerraformStack No description.
fqn java.lang.String No description.
friendlyUniqueId java.lang.String No description.
terraformMetaArguments java.util.Map<java.lang.String, java.lang.Object> No description.
terraformResourceType java.lang.String No description.
terraformGeneratorMetadata com.hashicorp.cdktf.TerraformProviderGeneratorMetadata No description.
connection com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number OR com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<java.lang.String> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
provisioners java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> No description.
arn java.lang.String No description.
as2Config TransferConnectorAs2ConfigOutputReference No description.
connectorId java.lang.String No description.
sftpConfig TransferConnectorSftpConfigOutputReference No description.
accessRoleInput java.lang.String No description.
as2ConfigInput TransferConnectorAs2Config No description.
idInput java.lang.String No description.
loggingRoleInput java.lang.String No description.
securityPolicyNameInput java.lang.String No description.
sftpConfigInput TransferConnectorSftpConfig No description.
tagsAllInput java.util.Map<java.lang.String, java.lang.String> No description.
tagsInput java.util.Map<java.lang.String, java.lang.String> No description.
urlInput java.lang.String No description.
accessRole java.lang.String No description.
id java.lang.String No description.
loggingRole java.lang.String No description.
securityPolicyName java.lang.String No description.
tags java.util.Map<java.lang.String, java.lang.String> No description.
tagsAll java.util.Map<java.lang.String, java.lang.String> No description.
url java.lang.String No description.
nodeRequired 
public Node getNode();
  • Type: software.constructs.Node

The tree node.

cdktfStackRequired 
public TerraformStack getCdktfStack();
  • Type: com.hashicorp.cdktf.TerraformStack
fqnRequired 
public java.lang.String getFqn();
  • Type: java.lang.String
friendlyUniqueIdRequired 
public java.lang.String getFriendlyUniqueId();
  • Type: java.lang.String
terraformMetaArgumentsRequired 
public java.util.Map<java.lang.String, java.lang.Object> getTerraformMetaArguments();
  • Type: java.util.Map<java.lang.String, java.lang.Object>
terraformResourceTypeRequired 
public java.lang.String getTerraformResourceType();
  • Type: java.lang.String
terraformGeneratorMetadataOptional 
public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata();
  • Type: com.hashicorp.cdktf.TerraformProviderGeneratorMetadata
connectionOptional 
public java.lang.Object getConnection();
  • Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection
countOptional 
public java.lang.Object getCount();
  • Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount
dependsOnOptional 
public java.util.List<java.lang.String> getDependsOn();
  • Type: java.util.List<java.lang.String>
forEachOptional 
public ITerraformIterator getForEach();
  • Type: com.hashicorp.cdktf.ITerraformIterator
lifecycleOptional 
public TerraformResourceLifecycle getLifecycle();
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle
providerOptional 
public TerraformProvider getProvider();
  • Type: com.hashicorp.cdktf.TerraformProvider
provisionersOptional 
public java.lang.Object getProvisioners();
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>
arnRequired 
public java.lang.String getArn();
  • Type: java.lang.String
as2ConfigRequired 
public TransferConnectorAs2ConfigOutputReference getAs2Config();
connectorIdRequired 
public java.lang.String getConnectorId();
  • Type: java.lang.String
sftpConfigRequired 
public TransferConnectorSftpConfigOutputReference getSftpConfig();
accessRoleInputOptional 
public java.lang.String getAccessRoleInput();
  • Type: java.lang.String
as2ConfigInputOptional 
public TransferConnectorAs2Config getAs2ConfigInput();
idInputOptional 
public java.lang.String getIdInput();
  • Type: java.lang.String
loggingRoleInputOptional 
public java.lang.String getLoggingRoleInput();
  • Type: java.lang.String
securityPolicyNameInputOptional 
public java.lang.String getSecurityPolicyNameInput();
  • Type: java.lang.String
sftpConfigInputOptional 
public TransferConnectorSftpConfig getSftpConfigInput();
tagsAllInputOptional 
public java.util.Map<java.lang.String, java.lang.String> getTagsAllInput();
  • Type: java.util.Map<java.lang.String, java.lang.String>
tagsInputOptional 
public java.util.Map<java.lang.String, java.lang.String> getTagsInput();
  • Type: java.util.Map<java.lang.String, java.lang.String>
urlInputOptional 
public java.lang.String getUrlInput();
  • Type: java.lang.String
accessRoleRequired 
public java.lang.String getAccessRole();
  • Type: java.lang.String
idRequired 
public java.lang.String getId();
  • Type: java.lang.String
loggingRoleRequired 
public java.lang.String getLoggingRole();
  • Type: java.lang.String
securityPolicyNameRequired 
public java.lang.String getSecurityPolicyName();
  • Type: java.lang.String
tagsRequired 
public java.util.Map<java.lang.String, java.lang.String> getTags();
  • Type: java.util.Map<java.lang.String, java.lang.String>
tagsAllRequired 
public java.util.Map<java.lang.String, java.lang.String> getTagsAll();
  • Type: java.util.Map<java.lang.String, java.lang.String>
urlRequired 
public java.lang.String getUrl();
  • Type: java.lang.String

Constants

Name Type Description
tfResourceType java.lang.String No description.
tfResourceTypeRequired 
public java.lang.String getTfResourceType();
  • Type: java.lang.String

Structs

TransferConnectorAs2Config

Initializer 

import com.hashicorp.cdktf.providers.aws.transfer_connector.TransferConnectorAs2Config;

TransferConnectorAs2Config.builder()
    .compression(java.lang.String)
    .encryptionAlgorithm(java.lang.String)
    .localProfileId(java.lang.String)
    .mdnResponse(java.lang.String)
    .partnerProfileId(java.lang.String)
    .signingAlgorithm(java.lang.String)
//  .mdnSigningAlgorithm(java.lang.String)
//  .messageSubject(java.lang.String)
    .build();

Properties

Name Type Description
compression java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/transfer_connector#compression TransferConnector#compression}.
encryptionAlgorithm java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/transfer_connector#encryption_algorithm TransferConnector#encryption_algorithm}.
localProfileId java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/transfer_connector#local_profile_id TransferConnector#local_profile_id}.
mdnResponse java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/transfer_connector#mdn_response TransferConnector#mdn_response}.
partnerProfileId java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/transfer_connector#partner_profile_id TransferConnector#partner_profile_id}.
signingAlgorithm java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/transfer_connector#signing_algorithm TransferConnector#signing_algorithm}.
mdnSigningAlgorithm java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/transfer_connector#mdn_signing_algorithm TransferConnector#mdn_signing_algorithm}.
messageSubject java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/transfer_connector#message_subject TransferConnector#message_subject}.
compressionRequired 
public java.lang.String getCompression();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/transfer_connector#compression TransferConnector#compression}.

encryptionAlgorithmRequired 
public java.lang.String getEncryptionAlgorithm();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/transfer_connector#encryption_algorithm TransferConnector#encryption_algorithm}.

localProfileIdRequired 
public java.lang.String getLocalProfileId();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/transfer_connector#local_profile_id TransferConnector#local_profile_id}.

mdnResponseRequired 
public java.lang.String getMdnResponse();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/transfer_connector#mdn_response TransferConnector#mdn_response}.

partnerProfileIdRequired 
public java.lang.String getPartnerProfileId();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/transfer_connector#partner_profile_id TransferConnector#partner_profile_id}.

signingAlgorithmRequired 
public java.lang.String getSigningAlgorithm();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/transfer_connector#signing_algorithm TransferConnector#signing_algorithm}.

mdnSigningAlgorithmOptional 
public java.lang.String getMdnSigningAlgorithm();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/transfer_connector#mdn_signing_algorithm TransferConnector#mdn_signing_algorithm}.

messageSubjectOptional 
public java.lang.String getMessageSubject();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/transfer_connector#message_subject TransferConnector#message_subject}.

TransferConnectorConfig

Initializer 

import com.hashicorp.cdktf.providers.aws.transfer_connector.TransferConnectorConfig;

TransferConnectorConfig.builder()
//  .connection(SSHProvisionerConnection)
//  .connection(WinrmProvisionerConnection)
//  .count(java.lang.Number)
//  .count(TerraformCount)
//  .dependsOn(java.util.List<ITerraformDependable>)
//  .forEach(ITerraformIterator)
//  .lifecycle(TerraformResourceLifecycle)
//  .provider(TerraformProvider)
//  .provisioners(java.util.List<FileProvisioner)
//  .provisioners(LocalExecProvisioner)
//  .provisioners(RemoteExecProvisioner>)
    .accessRole(java.lang.String)
    .url(java.lang.String)
//  .as2Config(TransferConnectorAs2Config)
//  .id(java.lang.String)
//  .loggingRole(java.lang.String)
//  .securityPolicyName(java.lang.String)
//  .sftpConfig(TransferConnectorSftpConfig)
//  .tags(java.util.Map<java.lang.String, java.lang.String>)
//  .tagsAll(java.util.Map<java.lang.String, java.lang.String>)
    .build();

Properties

Name Type Description
connection com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number OR com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<com.hashicorp.cdktf.ITerraformDependable> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
provisioners java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> No description.
accessRole java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/transfer_connector#access_role TransferConnector#access_role}.
url java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/transfer_connector#url TransferConnector#url}.
as2Config TransferConnectorAs2Config as2_config block.
id java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/transfer_connector#id TransferConnector#id}.
loggingRole java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/transfer_connector#logging_role TransferConnector#logging_role}.
securityPolicyName java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/transfer_connector#security_policy_name TransferConnector#security_policy_name}.
sftpConfig TransferConnectorSftpConfig sftp_config block.
tags java.util.Map<java.lang.String, java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/transfer_connector#tags TransferConnector#tags}.
tagsAll java.util.Map<java.lang.String, java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/transfer_connector#tags_all TransferConnector#tags_all}.
connectionOptional 
public java.lang.Object getConnection();
  • Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection
countOptional 
public java.lang.Object getCount();
  • Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount
dependsOnOptional 
public java.util.List<ITerraformDependable> getDependsOn();
  • Type: java.util.List<com.hashicorp.cdktf.ITerraformDependable>
forEachOptional 
public ITerraformIterator getForEach();
  • Type: com.hashicorp.cdktf.ITerraformIterator
lifecycleOptional 
public TerraformResourceLifecycle getLifecycle();
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle
providerOptional 
public TerraformProvider getProvider();
  • Type: com.hashicorp.cdktf.TerraformProvider
provisionersOptional 
public java.lang.Object getProvisioners();
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>
accessRoleRequired 
public java.lang.String getAccessRole();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/transfer_connector#access_role TransferConnector#access_role}.

urlRequired 
public java.lang.String getUrl();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/transfer_connector#url TransferConnector#url}.

as2ConfigOptional 
public TransferConnectorAs2Config getAs2Config();

as2_config block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/transfer_connector#as2_config TransferConnector#as2_config}

idOptional 
public java.lang.String getId();
  • Type: java.lang.String

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

loggingRoleOptional 
public java.lang.String getLoggingRole();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/transfer_connector#logging_role TransferConnector#logging_role}.

securityPolicyNameOptional 
public java.lang.String getSecurityPolicyName();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/transfer_connector#security_policy_name TransferConnector#security_policy_name}.

sftpConfigOptional 
public TransferConnectorSftpConfig getSftpConfig();

sftp_config block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/transfer_connector#sftp_config TransferConnector#sftp_config}

tagsOptional 
public java.util.Map<java.lang.String, java.lang.String> getTags();
  • Type: java.util.Map<java.lang.String, java.lang.String>

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/transfer_connector#tags TransferConnector#tags}.

tagsAllOptional 
public java.util.Map<java.lang.String, java.lang.String> getTagsAll();
  • Type: java.util.Map<java.lang.String, java.lang.String>

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/transfer_connector#tags_all TransferConnector#tags_all}.

TransferConnectorSftpConfig

Initializer 

import com.hashicorp.cdktf.providers.aws.transfer_connector.TransferConnectorSftpConfig;

TransferConnectorSftpConfig.builder()
//  .trustedHostKeys(java.util.List<java.lang.String>)
//  .userSecretId(java.lang.String)
    .build();

Properties

Name Type Description
trustedHostKeys java.util.List<java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/transfer_connector#trusted_host_keys TransferConnector#trusted_host_keys}.
userSecretId java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/transfer_connector#user_secret_id TransferConnector#user_secret_id}.
trustedHostKeysOptional 
public java.util.List<java.lang.String> getTrustedHostKeys();
  • Type: java.util.List<java.lang.String>

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/transfer_connector#trusted_host_keys TransferConnector#trusted_host_keys}.

userSecretIdOptional 
public java.lang.String getUserSecretId();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.80.0/docs/resources/transfer_connector#user_secret_id TransferConnector#user_secret_id}.

Classes

TransferConnectorAs2ConfigOutputReference

Initializers 

import com.hashicorp.cdktf.providers.aws.transfer_connector.TransferConnectorAs2ConfigOutputReference;

new TransferConnectorAs2ConfigOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute);
Name Type Description
terraformResource com.hashicorp.cdktf.IInterpolatingParent The parent resource.
terraformAttribute java.lang.String The attribute on the parent resource this class is referencing.
terraformResourceRequired
  • Type: com.hashicorp.cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: java.lang.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.
resetMdnSigningAlgorithm No description.
resetMessageSubject No description.
computeFqn 
public java.lang.String computeFqn()
getAnyMapAttribute 
public java.util.Map<java.lang.String, java.lang.Object> getAnyMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanAttribute 
public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanMapAttribute 
public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getListAttribute 
public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberAttribute 
public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberListAttribute 
public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberMapAttribute 
public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringAttribute 
public java.lang.String getStringAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringMapAttribute 
public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
interpolationForAttribute 
public IResolvable interpolationForAttribute(java.lang.String property)
propertyRequired
  • Type: java.lang.String
resolve 
public java.lang.Object resolve(IResolveContext _context)

Produce the Token's value at resolution time.

_contextRequired
  • Type: com.hashicorp.cdktf.IResolveContext
toString 
public java.lang.String toString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

resetMdnSigningAlgorithm 
public void resetMdnSigningAlgorithm()
resetMessageSubject 
public void resetMessageSubject()

Properties

Name Type Description
creationStack java.util.List<java.lang.String> The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn java.lang.String No description.
compressionInput java.lang.String No description.
encryptionAlgorithmInput java.lang.String No description.
localProfileIdInput java.lang.String No description.
mdnResponseInput java.lang.String No description.
mdnSigningAlgorithmInput java.lang.String No description.
messageSubjectInput java.lang.String No description.
partnerProfileIdInput java.lang.String No description.
signingAlgorithmInput java.lang.String No description.
compression java.lang.String No description.
encryptionAlgorithm java.lang.String No description.
localProfileId java.lang.String No description.
mdnResponse java.lang.String No description.
mdnSigningAlgorithm java.lang.String No description.
messageSubject java.lang.String No description.
partnerProfileId java.lang.String No description.
signingAlgorithm java.lang.String No description.
internalValue TransferConnectorAs2Config No description.
creationStackRequired 
public java.util.List<java.lang.String> getCreationStack();
  • Type: java.util.List<java.lang.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 java.lang.String getFqn();
  • Type: java.lang.String
compressionInputOptional 
public java.lang.String getCompressionInput();
  • Type: java.lang.String
encryptionAlgorithmInputOptional 
public java.lang.String getEncryptionAlgorithmInput();
  • Type: java.lang.String
localProfileIdInputOptional 
public java.lang.String getLocalProfileIdInput();
  • Type: java.lang.String
mdnResponseInputOptional 
public java.lang.String getMdnResponseInput();
  • Type: java.lang.String
mdnSigningAlgorithmInputOptional 
public java.lang.String getMdnSigningAlgorithmInput();
  • Type: java.lang.String
messageSubjectInputOptional 
public java.lang.String getMessageSubjectInput();
  • Type: java.lang.String
partnerProfileIdInputOptional 
public java.lang.String getPartnerProfileIdInput();
  • Type: java.lang.String
signingAlgorithmInputOptional 
public java.lang.String getSigningAlgorithmInput();
  • Type: java.lang.String
compressionRequired 
public java.lang.String getCompression();
  • Type: java.lang.String
encryptionAlgorithmRequired 
public java.lang.String getEncryptionAlgorithm();
  • Type: java.lang.String
localProfileIdRequired 
public java.lang.String getLocalProfileId();
  • Type: java.lang.String
mdnResponseRequired 
public java.lang.String getMdnResponse();
  • Type: java.lang.String
mdnSigningAlgorithmRequired 
public java.lang.String getMdnSigningAlgorithm();
  • Type: java.lang.String
messageSubjectRequired 
public java.lang.String getMessageSubject();
  • Type: java.lang.String
partnerProfileIdRequired 
public java.lang.String getPartnerProfileId();
  • Type: java.lang.String
signingAlgorithmRequired 
public java.lang.String getSigningAlgorithm();
  • Type: java.lang.String
internalValueOptional 
public TransferConnectorAs2Config getInternalValue();

TransferConnectorSftpConfigOutputReference

Initializers 

import com.hashicorp.cdktf.providers.aws.transfer_connector.TransferConnectorSftpConfigOutputReference;

new TransferConnectorSftpConfigOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute);
Name Type Description
terraformResource com.hashicorp.cdktf.IInterpolatingParent The parent resource.
terraformAttribute java.lang.String The attribute on the parent resource this class is referencing.
terraformResourceRequired
  • Type: com.hashicorp.cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: java.lang.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.
resetTrustedHostKeys No description.
resetUserSecretId No description.
computeFqn 
public java.lang.String computeFqn()
getAnyMapAttribute 
public java.util.Map<java.lang.String, java.lang.Object> getAnyMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanAttribute 
public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanMapAttribute 
public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getListAttribute 
public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberAttribute 
public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberListAttribute 
public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberMapAttribute 
public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringAttribute 
public java.lang.String getStringAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringMapAttribute 
public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
interpolationForAttribute 
public IResolvable interpolationForAttribute(java.lang.String property)
propertyRequired
  • Type: java.lang.String
resolve 
public java.lang.Object resolve(IResolveContext _context)

Produce the Token's value at resolution time.

_contextRequired
  • Type: com.hashicorp.cdktf.IResolveContext
toString 
public java.lang.String toString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

resetTrustedHostKeys 
public void resetTrustedHostKeys()
resetUserSecretId 
public void resetUserSecretId()

Properties

Name Type Description
creationStack java.util.List<java.lang.String> The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn java.lang.String No description.
trustedHostKeysInput java.util.List<java.lang.String> No description.
userSecretIdInput java.lang.String No description.
trustedHostKeys java.util.List<java.lang.String> No description.
userSecretId java.lang.String No description.
internalValue TransferConnectorSftpConfig No description.
creationStackRequired 
public java.util.List<java.lang.String> getCreationStack();
  • Type: java.util.List<java.lang.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 java.lang.String getFqn();
  • Type: java.lang.String
trustedHostKeysInputOptional 
public java.util.List<java.lang.String> getTrustedHostKeysInput();
  • Type: java.util.List<java.lang.String>
userSecretIdInputOptional 
public java.lang.String getUserSecretIdInput();
  • Type: java.lang.String
trustedHostKeysRequired 
public java.util.List<java.lang.String> getTrustedHostKeys();
  • Type: java.util.List<java.lang.String>
userSecretIdRequired 
public java.lang.String getUserSecretId();
  • Type: java.lang.String
internalValueOptional 
public TransferConnectorSftpConfig getInternalValue();