Transfer Family

9 resource kinds. Generated from the operator's CRD schemas.

API Group: aws.konfig.io/v1alpha1

TransferAgreement # CLOUD CONTROL · AWS::Transfer::Agreement

TransferAgreement manages AWS::Transfer::Agreement through the AWS Cloud Control API.

kubectl get transferagreements · example on GitHub

Example

# TransferAgreement — Transfer Family
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/transfer.html#transferagreement
apiVersion: aws.konfig.io/v1alpha1
kind: TransferAgreement
metadata:
  name: example-transferagreement
  namespace: default
spec:
  accessRole: example-xxxxxxxxxxxx
  baseDirectory: example
  customDirectories:
    failedFilesDirectory: example
    mdnFilesDirectory: example
    payloadFilesDirectory: example
    statusFilesDirectory: example
    temporaryFilesDirectory: example
  description: Managed by konfig-konector
  enforceMessageSigning: ENABLED
  localProfileId: example-id-xxxxxxxx
  partnerProfileId: example-id-xxxxxxxx
  preserveFilename: ENABLED
  providerRef:
    name: example-transferagreement
    region: us-east-1
  serverId: example-id-xxxxxxxx
  status: ACTIVE
  tags:
  - key: example
    value: example

Spec

FieldTypeRequiredDescription
accessRolestringyesSpecifies the access role for the agreement.
baseDirectorystring—Specifies the base directory for the agreement.
customDirectoriesobject—Specifies a separate directory for each type of file to store for an AS2 message.
customDirectories.failedFilesDirectorystringyesSpecifies a location to store the failed files for an AS2 message.
customDirectories.mdnFilesDirectorystringyesSpecifies a location to store the MDN file for an AS2 message.
customDirectories.payloadFilesDirectorystringyesSpecifies a location to store the payload file for an AS2 message.
customDirectories.statusFilesDirectorystringyesSpecifies a location to store the status file for an AS2 message.
customDirectories.temporaryFilesDirectorystringyesSpecifies a location to store the temporary processing file for an AS2 message.
descriptionstring—A textual description for the agreement.
enforceMessageSigningenum—Specifies whether to enforce an AS2 message is signed for this agreement. Allowed: ENABLED, DISABLED
localProfileIdstringyesA unique identifier for the local profile.
partnerProfileIdstringyesA unique identifier for the partner profile.
preserveFilenameenum—Specifies whether to preserve the filename received for this agreement. Allowed: ENABLED, DISABLED
providerRefobject—ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
providerRef.namestringyesName of a cluster-scoped AWSProvider.
providerRef.regionstring—Region overrides the provider's region for this resource only.
serverIdstringyesA unique identifier for the server.
statusenum—Specifies the status of the agreement. Allowed: ACTIVE, INACTIVE
tagsarray<object>—Key-value pairs that can be used to group and search for agreements.
tags[].keystringyes
tags[].valuestringyes

Status

FieldTypeRequiredDescription
agreementIdstring—A unique identifier for the agreement.
arnstring—Specifies the unique Amazon Resource Name (ARN) for the agreement.
attemptinteger—Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
awsProviderobject—AWSProvider confirms the account and region this resource was reconciled against.
awsProvider.accountIdstring—AccountID the resource lives in.
awsProvider.namestring—Name of the AWSProvider used; empty when the operator's own credentials were used.
awsProvider.regionstring—Region the resource lives in (empty for global services).
conditionsarray<object>—Conditions describe the current state of the resource.
conditions[].lastTransitionTimestringyeslastTransitionTime is the last time the condition transitioned from one status to another.
conditions[].messagestringyesmessage is a human readable message indicating details about the transition.
conditions[].observedGenerationinteger—observedGeneration represents the .metadata.generation that the condition was set based upon.
conditions[].reasonstringyesreason contains a programmatic identifier indicating the reason for the condition's last transition.
conditions[].statusenumyesstatus of the condition, one of True, False, Unknown. Allowed: True, False, Unknown
conditions[].typestringyestype of condition in CamelCase or in foo.example.com/CamelCase.
identifierstring—Identifier is the Cloud Control primary identifier of the resource.
lastSyncTimestring—
observedGenerationinteger—
operationstring—Operation is the in-flight operation (CREATE, UPDATE, DELETE).
operationStatusstring—OperationStatus is the last reported operation status.
requestTokenstring—RequestToken tracks an in-flight asynchronous operation.

TransferCertificate # CLOUD CONTROL · AWS::Transfer::Certificate

TransferCertificate manages AWS::Transfer::Certificate through the AWS Cloud Control API.

kubectl get transfercertificates · example on GitHub

Example

# TransferCertificate — Transfer Family
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/transfer.html#transfercertificate
apiVersion: aws.konfig.io/v1alpha1
kind: TransferCertificate
metadata:
  name: example-transfercertificate
  namespace: default
spec:
  activeDate: example
  certificate: example
  certificateChain: example
  description: Managed by konfig-konector
  inactiveDate: example
  privateKey: example
  providerRef:
    name: example-transfercertificate
    region: us-east-1
  tags:
  - key: example
    value: example
  usage: SIGNING

Spec

FieldTypeRequiredDescription
activeDatestring—Specifies the active date for the certificate.
certificatestringyesSpecifies the certificate body to be imported.
certificateChainstring—Specifies the certificate chain to be imported.
descriptionstring—A textual description for the certificate.
inactiveDatestring—Specifies the inactive date for the certificate.
privateKeystring—Specifies the private key for the certificate.
providerRefobject—ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
providerRef.namestringyesName of a cluster-scoped AWSProvider.
providerRef.regionstring—Region overrides the provider's region for this resource only.
tagsarray<object>—Key-value pairs that can be used to group and search for certificates.
tags[].keystringyes
tags[].valuestringyes
usageenumyesSpecifies the usage type for the certificate. Allowed: SIGNING, ENCRYPTION, TLS

Status

FieldTypeRequiredDescription
arnstring—Specifies the unique Amazon Resource Name (ARN) for the agreement.
attemptinteger—Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
awsProviderobject—AWSProvider confirms the account and region this resource was reconciled against.
awsProvider.accountIdstring—AccountID the resource lives in.
awsProvider.namestring—Name of the AWSProvider used; empty when the operator's own credentials were used.
awsProvider.regionstring—Region the resource lives in (empty for global services).
certificateIdstring—A unique identifier for the certificate.
conditionsarray<object>—Conditions describe the current state of the resource.
conditions[].lastTransitionTimestringyeslastTransitionTime is the last time the condition transitioned from one status to another.
conditions[].messagestringyesmessage is a human readable message indicating details about the transition.
conditions[].observedGenerationinteger—observedGeneration represents the .metadata.generation that the condition was set based upon.
conditions[].reasonstringyesreason contains a programmatic identifier indicating the reason for the condition's last transition.
conditions[].statusenumyesstatus of the condition, one of True, False, Unknown. Allowed: True, False, Unknown
conditions[].typestringyestype of condition in CamelCase or in foo.example.com/CamelCase.
identifierstring—Identifier is the Cloud Control primary identifier of the resource.
lastSyncTimestring—
notAfterDatestring—Specifies the not after date for the certificate.
notBeforeDatestring—Specifies the not before date for the certificate.
observedGenerationinteger—
operationstring—Operation is the in-flight operation (CREATE, UPDATE, DELETE).
operationStatusstring—OperationStatus is the last reported operation status.
requestTokenstring—RequestToken tracks an in-flight asynchronous operation.
serialstring—Specifies Certificate's serial.
statusenum—A status description for the certificate. Allowed: ACTIVE, PENDING, INACTIVE
typeenum—Describing the type of certificate. Allowed: CERTIFICATE, CERTIFICATE_WITH_PRIVATE_KEY

TransferConnector # CLOUD CONTROL · AWS::Transfer::Connector

TransferConnector manages AWS::Transfer::Connector through the AWS Cloud Control API.

kubectl get transferconnectors · example on GitHub

Example

# TransferConnector — Transfer Family
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/transfer.html#transferconnector
apiVersion: aws.konfig.io/v1alpha1
kind: TransferConnector
metadata:
  name: example-transferconnector
  namespace: default
spec:
  accessRole: example-xxxxxxxxxxxx
  as2Config:
    asyncMdnConfig:
      serverIds:
      - example
      url: example
    compression: ZLIB
    encryptionAlgorithm: AES128_CBC
    mdnResponse: SYNC
    mdnSigningAlgorithm: SHA256
    messageSubject: example
    preserveContentType: ENABLED
    signingAlgorithm: SHA256
  egressConfig:
    vpcLattice:
      portNumber: 1
      resourceConfigurationArn: arn:aws:iam::123456789012:role/example-role
  egressType: SERVICE_MANAGED
  ipAddressType: IPV4
  loggingRole: example
  providerRef:
    name: example-transferconnector
    region: us-east-1
  securityPolicyName: example-transferconnector
  sftpConfig:
    maxConcurrentConnections: 1
    trustedHostKeys:
    - example
  tags:
  - key: example
    value: example
  url: example

Spec

FieldTypeRequiredDescription
accessRolestringyesSpecifies the access role for the connector.
as2Configobject—Configuration for an AS2 connector.
as2Config.asyncMdnConfigobject—Configuration for an AS2 connector with ASYNC MDN Response
as2Config.asyncMdnConfig.serverIdsarray<string>yes
as2Config.asyncMdnConfig.urlstringyesURL of the server to receive the MDN response on
as2Config.basicAuthSecretIdstring—ARN or name of the secret in AWS Secrets Manager which contains the credentials for Basic authentication.
as2Config.compressionenum—Compression setting for this AS2 connector configuration. Allowed: ZLIB, DISABLED
as2Config.encryptionAlgorithmenum—Encryption algorithm for this AS2 connector configuration. Allowed: AES128_CBC, AES192_CBC, AES256_CBC, NONE, DES_EDE3_CBC
as2Config.localProfileIdstring—A unique identifier for the local profile.
as2Config.mdnResponseenum—MDN Response setting for this AS2 connector configuration. Allowed: SYNC, ASYNC, NONE
as2Config.mdnSigningAlgorithmenum—MDN Signing algorithm for this AS2 connector configuration. Allowed: SHA256, SHA384, SHA512, SHA1, NONE, DEFAULT
as2Config.messageSubjectstring—The message subject for this AS2 connector configuration.
as2Config.partnerProfileIdstring—A unique identifier for the partner profile.
as2Config.preserveContentTypeenum—Specifies whether to use the AWS S3 object content-type as the content-type for the AS2 message. Allowed: ENABLED, DISABLED
as2Config.signingAlgorithmenum—Signing algorithm for this AS2 connector configuration. Allowed: SHA256, SHA384, SHA512, SHA1, NONE
egressConfigobject—Egress configuration for the connector.
egressConfig.vpcLatticeobjectyesTransferConnectorConnectorVpcLatticeEgressConfig is a nested property type of AWS::Transfer::Connector.
egressConfig.vpcLattice.portNumberinteger—Port to connect to on the target VPC Lattice resource
egressConfig.vpcLattice.resourceConfigurationArnstringyesARN of the VPC Lattice resource configuration
egressTypeenum—Specifies the egress type for the connector. Allowed: SERVICE_MANAGED, VPC_LATTICE
ipAddressTypeenum—Allowed: IPV4, DUALSTACK
loggingRolestring—Specifies the logging role for the connector.
providerRefobject—ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
providerRef.namestringyesName of a cluster-scoped AWSProvider.
providerRef.regionstring—Region overrides the provider's region for this resource only.
securityPolicyNamestring—Security policy for SFTP Connector
sftpConfigobject—Configuration for an SFTP connector.
sftpConfig.maxConcurrentConnectionsinteger—Specifies the number of active connections that your connector can establish with the remote server at the same time.
sftpConfig.trustedHostKeysarray<string>—List of public host keys, for the external server to which you are connecting.
sftpConfig.userSecretIdstring—ARN or name of the secret in AWS Secrets Manager which contains the SFTP user's private keys or passwords.
tagsarray<object>—Key-value pairs that can be used to group and search for connectors.
tags[].keystringyes
tags[].valuestringyes
urlstring—URL for Connector

Status

FieldTypeRequiredDescription
arnstring—Specifies the unique Amazon Resource Name (ARN) for the connector.
attemptinteger—Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
awsProviderobject—AWSProvider confirms the account and region this resource was reconciled against.
awsProvider.accountIdstring—AccountID the resource lives in.
awsProvider.namestring—Name of the AWSProvider used; empty when the operator's own credentials were used.
awsProvider.regionstring—Region the resource lives in (empty for global services).
conditionsarray<object>—Conditions describe the current state of the resource.
conditions[].lastTransitionTimestringyeslastTransitionTime is the last time the condition transitioned from one status to another.
conditions[].messagestringyesmessage is a human readable message indicating details about the transition.
conditions[].observedGenerationinteger—observedGeneration represents the .metadata.generation that the condition was set based upon.
conditions[].reasonstringyesreason contains a programmatic identifier indicating the reason for the condition's last transition.
conditions[].statusenumyesstatus of the condition, one of True, False, Unknown. Allowed: True, False, Unknown
conditions[].typestringyestype of condition in CamelCase or in foo.example.com/CamelCase.
connectorIdstring—A unique identifier for the connector.
errorMessagestring—Detailed error message when Connector in ERRORED status Read-only: reported by AWS after creation.
identifierstring—Identifier is the Cloud Control primary identifier of the resource.
lastSyncTimestring—
observedGenerationinteger—
operationstring—Operation is the in-flight operation (CREATE, UPDATE, DELETE).
operationStatusstring—OperationStatus is the last reported operation status.
requestTokenstring—RequestToken tracks an in-flight asynchronous operation.
serviceManagedEgressIpAddressesarray<string>—The list of egress IP addresses of this connector.
statusenum—Read-only: reported by AWS after creation. Allowed: ACTIVE, PENDING, ERRORED

TransferHostKey # CLOUD CONTROL · AWS::Transfer::HostKey ⚠ DESTRUCTIVE SCOPE

Caution, destructive scope: spec must contain the SSH host private key in plain text. Provided for completeness; do not use from application namespaces. Restrict with AWSProvider.allowedNamespaces and RBAC. TransferHostKey manages AWS::Transfer::HostKey through the AWS Cloud Control API.

kubectl get transferhostkeys · example on GitHub

Example

# TransferHostKey — Transfer Family
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/transfer.html#transferhostkey
apiVersion: aws.konfig.io/v1alpha1
kind: TransferHostKey
metadata:
  name: example-transferhostkey
  namespace: default
spec:
  description: Managed by konfig-konector
  hostKeyBody: example
  providerRef:
    name: example-transferhostkey
    region: us-east-1
  serverId: example-id-xxxxxxxx
  tags:
  - key: example
    value: example

Spec

FieldTypeRequiredDescription
descriptionstring—The text description for this host key.
hostKeyBodystring—The private key portion of an SSH key pair.
providerRefobject—ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
providerRef.namestringyesName of a cluster-scoped AWSProvider.
providerRef.regionstring—Region overrides the provider's region for this resource only.
serverIdstringyesThe identifier of the server that contains the host key.
tagsarray<object>—Key-value pairs that can be used to group and search for host keys.
tags[].keystringyes
tags[].valuestringyes

Status

FieldTypeRequiredDescription
arnstring—The unique Amazon Resource Name (ARN) for the host key.
attemptinteger—Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
awsProviderobject—AWSProvider confirms the account and region this resource was reconciled against.
awsProvider.accountIdstring—AccountID the resource lives in.
awsProvider.namestring—Name of the AWSProvider used; empty when the operator's own credentials were used.
awsProvider.regionstring—Region the resource lives in (empty for global services).
conditionsarray<object>—Conditions describe the current state of the resource.
conditions[].lastTransitionTimestringyeslastTransitionTime is the last time the condition transitioned from one status to another.
conditions[].messagestringyesmessage is a human readable message indicating details about the transition.
conditions[].observedGenerationinteger—observedGeneration represents the .metadata.generation that the condition was set based upon.
conditions[].reasonstringyesreason contains a programmatic identifier indicating the reason for the condition's last transition.
conditions[].statusenumyesstatus of the condition, one of True, False, Unknown. Allowed: True, False, Unknown
conditions[].typestringyestype of condition in CamelCase or in foo.example.com/CamelCase.
dateImportedstring—The date on which the host key was added to the server.
hostKeyFingerprintstring—The public key fingerprint, which is a short sequence of bytes used to identify the longer public key.
hostKeyIdstring—A unique identifier for the host key.
identifierstring—Identifier is the Cloud Control primary identifier of the resource.
lastSyncTimestring—
observedGenerationinteger—
operationstring—Operation is the in-flight operation (CREATE, UPDATE, DELETE).
operationStatusstring—OperationStatus is the last reported operation status.
requestTokenstring—RequestToken tracks an in-flight asynchronous operation.
typestring—The encryption algorithm that is used for the host key.

TransferProfile # CLOUD CONTROL · AWS::Transfer::Profile

TransferProfile manages AWS::Transfer::Profile through the AWS Cloud Control API.

kubectl get transferprofiles · example on GitHub

Example

# TransferProfile — Transfer Family
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/transfer.html#transferprofile
apiVersion: aws.konfig.io/v1alpha1
kind: TransferProfile
metadata:
  name: example-transferprofile
  namespace: default
spec:
  as2Id: example-id
  certificateIds:
  - example
  profileType: LOCAL
  providerRef:
    name: example-transferprofile
    region: us-east-1
  tags:
  - key: example
    value: example

Spec

FieldTypeRequiredDescription
as2IdstringyesAS2 identifier agreed with a trading partner.
certificateIdsarray<string>—List of the certificate IDs associated with this profile to be used for encryption and signing of AS2 messages.
profileTypeenumyesEnum specifying whether the profile is local or associated with a trading partner. Allowed: LOCAL, PARTNER
providerRefobject—ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
providerRef.namestringyesName of a cluster-scoped AWSProvider.
providerRef.regionstring—Region overrides the provider's region for this resource only.
tagsarray<object>—An array of key-value pairs to apply to this resource.
tags[].keystringyes
tags[].valuestringyes

Status

FieldTypeRequiredDescription
arnstring—Specifies the unique Amazon Resource Name (ARN) for the profile.
attemptinteger—Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
awsProviderobject—AWSProvider confirms the account and region this resource was reconciled against.
awsProvider.accountIdstring—AccountID the resource lives in.
awsProvider.namestring—Name of the AWSProvider used; empty when the operator's own credentials were used.
awsProvider.regionstring—Region the resource lives in (empty for global services).
conditionsarray<object>—Conditions describe the current state of the resource.
conditions[].lastTransitionTimestringyeslastTransitionTime is the last time the condition transitioned from one status to another.
conditions[].messagestringyesmessage is a human readable message indicating details about the transition.
conditions[].observedGenerationinteger—observedGeneration represents the .metadata.generation that the condition was set based upon.
conditions[].reasonstringyesreason contains a programmatic identifier indicating the reason for the condition's last transition.
conditions[].statusenumyesstatus of the condition, one of True, False, Unknown. Allowed: True, False, Unknown
conditions[].typestringyestype of condition in CamelCase or in foo.example.com/CamelCase.
identifierstring—Identifier is the Cloud Control primary identifier of the resource.
lastSyncTimestring—
observedGenerationinteger—
operationstring—Operation is the in-flight operation (CREATE, UPDATE, DELETE).
operationStatusstring—OperationStatus is the last reported operation status.
profileIdstring—A unique identifier for the profile Read-only: reported by AWS after creation.
requestTokenstring—RequestToken tracks an in-flight asynchronous operation.

TransferServer # CLOUD CONTROL · AWS::Transfer::Server

TransferServer manages AWS::Transfer::Server through the AWS Cloud Control API.

kubectl get transferservers · example on GitHub

Example

# TransferServer — Transfer Family
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/transfer.html#transferserver
apiVersion: aws.konfig.io/v1alpha1
kind: TransferServer
metadata:
  name: example-transferserver
  namespace: default
spec:
  certificate: example
  domain: S3
  endpointDetails:
    addressAllocationIds:
    - example
    securityGroupIds:
    - example
    subnetIds:
    - example
  endpointType: PUBLIC
  identityProviderDetails:
    function: example
    invocationRole: example
    sftpAuthenticationMethods: PASSWORD
    url: example
  identityProviderType: SERVICE_MANAGED
  ipAddressType: IPV4
  loggingRole: example
  postAuthenticationLoginBanner: example
  preAuthenticationLoginBanner: example
  protocolDetails:
    as2Transports:
    - example
    passiveIp: example
    setStatOption: DEFAULT
    tlsSessionResumptionMode: DISABLED
  protocols:
  - example
  providerRef:
    name: example-transferserver
    region: us-east-1
  s3StorageOptions:
    directoryListingOptimization: ENABLED
  securityPolicyName: example-transferserver
  structuredLogDestinations:
  - example
  tags:
  - key: example
    value: example
  workflowDetails:
    onPartialUpload:
    - executionRole: example-xxxxxxxxxxxx
      workflowId: example-id-xxxxxxxx
    onUpload:
    - executionRole: example-xxxxxxxxxxxx
      workflowId: example-id-xxxxxxxx

Spec

FieldTypeRequiredDescription
certificatestring—
domainenum—Create-only in AWS: changing it requires replacing the resource. Allowed: S3, EFS
endpointDetailsobject—TransferServerEndpointDetails is a nested property type of AWS::Transfer::Server.
endpointDetails.addressAllocationIdsarray<string>—
endpointDetails.securityGroupIdsarray<string>—
endpointDetails.subnetIdsarray<string>—
endpointDetails.vpcEndpointIdstring—
endpointDetails.vpcIdstring—
endpointTypeenum—Allowed: PUBLIC, VPC, VPC_ENDPOINT
identityProviderDetailsobject—TransferServerIdentityProviderDetails is a nested property type of AWS::Transfer::Server.
identityProviderDetails.directoryIdstring—
identityProviderDetails.functionstring—
identityProviderDetails.invocationRolestring—
identityProviderDetails.sftpAuthenticationMethodsenum—Allowed: PASSWORD, PUBLIC_KEY, PUBLIC_KEY_OR_PASSWORD, PUBLIC_KEY_AND_PASSWORD
identityProviderDetails.urlstring—
identityProviderTypeenum—Allowed: SERVICE_MANAGED, API_GATEWAY, AWS_DIRECTORY_SERVICE, AWS_LAMBDA
ipAddressTypeenum—Allowed: IPV4, DUALSTACK
loggingRolestring—
postAuthenticationLoginBannerstring—
preAuthenticationLoginBannerstring—
protocolDetailsobject—TransferServerProtocolDetails is a nested property type of AWS::Transfer::Server.
protocolDetails.as2Transportsarray<string>—
protocolDetails.passiveIpstring—
protocolDetails.setStatOptionenum—Allowed: DEFAULT, ENABLE_NO_OP
protocolDetails.tlsSessionResumptionModeenum—Allowed: DISABLED, ENABLED, ENFORCED
protocolsarray<string>—
providerRefobject—ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
providerRef.namestringyesName of a cluster-scoped AWSProvider.
providerRef.regionstring—Region overrides the provider's region for this resource only.
s3StorageOptionsobject—TransferServerS3StorageOptions is a nested property type of AWS::Transfer::Server.
s3StorageOptions.directoryListingOptimizationenum—Allowed: ENABLED, DISABLED
securityPolicyNamestring—
structuredLogDestinationsarray<string>—
tagsarray<object>—
tags[].keystringyes
tags[].valuestringyes
workflowDetailsobject—TransferServerWorkflowDetails is a nested property type of AWS::Transfer::Server.
workflowDetails.onPartialUploadarray<object>—
workflowDetails.onPartialUpload[].executionRolestringyes
workflowDetails.onPartialUpload[].workflowIdstringyes
workflowDetails.onUploadarray<object>—
workflowDetails.onUpload[].executionRolestringyes
workflowDetails.onUpload[].workflowIdstringyes

Status

FieldTypeRequiredDescription
arnstring—Read-only: reported by AWS after creation.
as2ServiceManagedEgressIpAddressesarray<string>—The list of egress IP addresses of this server.
attemptinteger—Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
awsProviderobject—AWSProvider confirms the account and region this resource was reconciled against.
awsProvider.accountIdstring—AccountID the resource lives in.
awsProvider.namestring—Name of the AWSProvider used; empty when the operator's own credentials were used.
awsProvider.regionstring—Region the resource lives in (empty for global services).
conditionsarray<object>—Conditions describe the current state of the resource.
conditions[].lastTransitionTimestringyeslastTransitionTime is the last time the condition transitioned from one status to another.
conditions[].messagestringyesmessage is a human readable message indicating details about the transition.
conditions[].observedGenerationinteger—observedGeneration represents the .metadata.generation that the condition was set based upon.
conditions[].reasonstringyesreason contains a programmatic identifier indicating the reason for the condition's last transition.
conditions[].statusenumyesstatus of the condition, one of True, False, Unknown. Allowed: True, False, Unknown
conditions[].typestringyestype of condition in CamelCase or in foo.example.com/CamelCase.
identifierstring—Identifier is the Cloud Control primary identifier of the resource.
lastSyncTimestring—
observedGenerationinteger—
operationstring—Operation is the in-flight operation (CREATE, UPDATE, DELETE).
operationStatusstring—OperationStatus is the last reported operation status.
requestTokenstring—RequestToken tracks an in-flight asynchronous operation.
serverIdstring—Read-only: reported by AWS after creation.
stateenum—Read-only: reported by AWS after creation. Allowed: OFFLINE, ONLINE, STARTING, STOPPING, START_FAILED, STOP_FAILED

TransferUser # CLOUD CONTROL · AWS::Transfer::User

TransferUser manages AWS::Transfer::User through the AWS Cloud Control API.

kubectl get transferusers · example on GitHub

Example

# TransferUser — Transfer Family
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/transfer.html#transferuser
apiVersion: aws.konfig.io/v1alpha1
kind: TransferUser
metadata:
  name: example-transferuser
  namespace: default
spec:
  homeDirectory: example
  homeDirectoryMappings:
  - entry: example
    target: example
    type: FILE
  homeDirectoryType: PATH
  policy: '{"Version": "2012-10-17", "Statement": [{"Effect": "Allow", "Action": ["s3:GetObject"], "Resource":
    "*"}]}'
  posixProfile:
    gid: 1
    secondaryGids:
    - 1
    uid: 1
  providerRef:
    name: example-transferuser
    region: us-east-1
  role: example-xxxxxxxxxxxx
  serverId: example-id-xxxxxxxx
  sshPublicKeys:
  - example
  tags:
  - key: example
    value: example
  userName: example-transferuser

Spec

FieldTypeRequiredDescription
homeDirectorystring—
homeDirectoryMappingsarray<object>—
homeDirectoryMappings[].entrystringyes
homeDirectoryMappings[].targetstringyes
homeDirectoryMappings[].typeenum—Allowed: FILE, DIRECTORY
homeDirectoryTypeenum—Allowed: PATH, LOGICAL
policystring—
posixProfileobject—TransferUserPosixProfile is a nested property type of AWS::Transfer::User.
posixProfile.gidnumberyes
posixProfile.secondaryGidsarray<number>—
posixProfile.uidnumberyes
providerRefobject—ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
providerRef.namestringyesName of a cluster-scoped AWSProvider.
providerRef.regionstring—Region overrides the provider's region for this resource only.
rolestringyes
serverIdstringyesCreate-only in AWS: changing it requires replacing the resource.
sshPublicKeysarray<string>—This represents the SSH User Public Keys for CloudFormation resource
tagsarray<object>—
tags[].keystringyes
tags[].valuestringyes
userNamestringyesCreate-only in AWS: changing it requires replacing the resource.

Status

FieldTypeRequiredDescription
arnstring—Read-only: reported by AWS after creation.
attemptinteger—Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
awsProviderobject—AWSProvider confirms the account and region this resource was reconciled against.
awsProvider.accountIdstring—AccountID the resource lives in.
awsProvider.namestring—Name of the AWSProvider used; empty when the operator's own credentials were used.
awsProvider.regionstring—Region the resource lives in (empty for global services).
conditionsarray<object>—Conditions describe the current state of the resource.
conditions[].lastTransitionTimestringyeslastTransitionTime is the last time the condition transitioned from one status to another.
conditions[].messagestringyesmessage is a human readable message indicating details about the transition.
conditions[].observedGenerationinteger—observedGeneration represents the .metadata.generation that the condition was set based upon.
conditions[].reasonstringyesreason contains a programmatic identifier indicating the reason for the condition's last transition.
conditions[].statusenumyesstatus of the condition, one of True, False, Unknown. Allowed: True, False, Unknown
conditions[].typestringyestype of condition in CamelCase or in foo.example.com/CamelCase.
identifierstring—Identifier is the Cloud Control primary identifier of the resource.
lastSyncTimestring—
observedGenerationinteger—
operationstring—Operation is the in-flight operation (CREATE, UPDATE, DELETE).
operationStatusstring—OperationStatus is the last reported operation status.
requestTokenstring—RequestToken tracks an in-flight asynchronous operation.

TransferWebApp # CLOUD CONTROL · AWS::Transfer::WebApp

TransferWebApp manages AWS::Transfer::WebApp through the AWS Cloud Control API.

kubectl get transferwebapps · example on GitHub

Example

# TransferWebApp — Transfer Family
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/transfer.html#transferwebapp
apiVersion: aws.konfig.io/v1alpha1
kind: TransferWebApp
metadata:
  name: example-transferwebapp
  namespace: default
spec:
  accessEndpoint: example
  endpointDetails:
    vpc:
      ipAddressType: IPV4
      securityGroupIds:
      - example
      subnetIds:
      - example
  identityProviderDetails:
    applicationArn: arn:aws:iam::123456789012:role/example-role
    instanceArn: arn:aws:iam::123456789012:role/example-role
    role: example
  providerRef:
    name: example-transferwebapp
    region: us-east-1
  tags:
  - key: example
    value: example
  webAppCustomization:
    faviconFile: example
    logoFile: example
    title: example
  webAppEndpointPolicy: STANDARD

Spec

FieldTypeRequiredDescription
accessEndpointstring—The AccessEndpoint is the URL that you provide to your users for them to interact with the Transfer Family web app.
endpointDetailsobject—TransferWebAppEndpointDetails is a nested property type of AWS::Transfer::WebApp.
endpointDetails.vpcobject—TransferWebAppVpc is a nested property type of AWS::Transfer::WebApp.
endpointDetails.vpc.ipAddressTypeenum—The IP address type for the VPC endpoint used by the web app. Allowed: IPV4, DUALSTACK
endpointDetails.vpc.securityGroupIdsarray<string>—
endpointDetails.vpc.subnetIdsarray<string>—
endpointDetails.vpc.vpcIdstring—
identityProviderDetailsobjectyesTransferWebAppIdentityProviderDetails is a nested property type of AWS::Transfer::WebApp.
identityProviderDetails.applicationArnstring—
identityProviderDetails.instanceArnstring—The Amazon Resource Name (ARN) for the IAM Identity Center used for the web app.
identityProviderDetails.rolestring—The IAM role in IAM Identity Center used for the web app.
providerRefobject—ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
providerRef.namestringyesName of a cluster-scoped AWSProvider.
providerRef.regionstring—Region overrides the provider's region for this resource only.
tagsarray<object>—Key-value pairs that can be used to group and search for web apps.
tags[].keystringyes
tags[].valuestringyes
webAppCustomizationobject—TransferWebAppWebAppCustomization is a nested property type of AWS::Transfer::WebApp.
webAppCustomization.faviconFilestring—Specifies a favicon to display in the browser tab.
webAppCustomization.logoFilestring—Specifies a logo to display on the web app.
webAppCustomization.titlestring—Specifies a title to display on the web app.
webAppEndpointPolicyenum—Create-only in AWS: changing it requires replacing the resource. Allowed: STANDARD, FIPS
webAppUnitsobject—

Status

FieldTypeRequiredDescription
arnstring—Specifies the unique Amazon Resource Name (ARN) for the web app.
attemptinteger—Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
awsProviderobject—AWSProvider confirms the account and region this resource was reconciled against.
awsProvider.accountIdstring—AccountID the resource lives in.
awsProvider.namestring—Name of the AWSProvider used; empty when the operator's own credentials were used.
awsProvider.regionstring—Region the resource lives in (empty for global services).
conditionsarray<object>—Conditions describe the current state of the resource.
conditions[].lastTransitionTimestringyeslastTransitionTime is the last time the condition transitioned from one status to another.
conditions[].messagestringyesmessage is a human readable message indicating details about the transition.
conditions[].observedGenerationinteger—observedGeneration represents the .metadata.generation that the condition was set based upon.
conditions[].reasonstringyesreason contains a programmatic identifier indicating the reason for the condition's last transition.
conditions[].statusenumyesstatus of the condition, one of True, False, Unknown. Allowed: True, False, Unknown
conditions[].typestringyestype of condition in CamelCase or in foo.example.com/CamelCase.
identifierstring—Identifier is the Cloud Control primary identifier of the resource.
lastSyncTimestring—
observedGenerationinteger—
operationstring—Operation is the in-flight operation (CREATE, UPDATE, DELETE).
operationStatusstring—OperationStatus is the last reported operation status.
requestTokenstring—RequestToken tracks an in-flight asynchronous operation.
vpcEndpointIdstring—Read-only: reported by AWS after creation.
webAppIdstring—A unique identifier for the web app.

TransferWorkflow # CLOUD CONTROL · AWS::Transfer::Workflow

TransferWorkflow manages AWS::Transfer::Workflow through the AWS Cloud Control API.

kubectl get transferworkflows · example on GitHub

Example

# TransferWorkflow — Transfer Family
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/transfer.html#transferworkflow
apiVersion: aws.konfig.io/v1alpha1
kind: TransferWorkflow
metadata:
  name: example-transferworkflow
  namespace: default
spec:
  description: Managed by konfig-konector
  onExceptionSteps:
  - copyStepDetails:
      name: example-transferworkflow
      overwriteExisting: 'TRUE'
      sourceFileLocation: example
    customStepDetails:
      name: example-transferworkflow
      sourceFileLocation: example
      target: example
      timeoutSeconds: 1
    decryptStepDetails:
      name: example-transferworkflow
      overwriteExisting: 'TRUE'
      sourceFileLocation: example
      type: PGP
    deleteStepDetails:
      name: example-transferworkflow
      sourceFileLocation: example
    tagStepDetails:
      name: example-transferworkflow
      sourceFileLocation: example
      tags:
      - key: example
        value: example
    type: COPY
  providerRef:
    name: example-transferworkflow
    region: us-east-1
  steps:
  - copyStepDetails:
      name: example-transferworkflow
      overwriteExisting: 'TRUE'
      sourceFileLocation: example
    customStepDetails:
      name: example-transferworkflow
      sourceFileLocation: example
      target: example
      timeoutSeconds: 1
    decryptStepDetails:
      name: example-transferworkflow
      overwriteExisting: 'TRUE'
      sourceFileLocation: example
      type: PGP
    deleteStepDetails:
      name: example-transferworkflow
      sourceFileLocation: example
    tagStepDetails:
      name: example-transferworkflow
      sourceFileLocation: example
      tags:
      - key: example
        value: example
    type: COPY
  tags:
  - key: example
    value: example

Spec

FieldTypeRequiredDescription
descriptionstring—A textual description for the workflow.
onExceptionStepsarray<object>—Specifies the steps (actions) to take if any errors are encountered during execution of the workflow.
onExceptionSteps[].copyStepDetailsobject—Details for a step that performs a file copy.
onExceptionSteps[].copyStepDetails.destinationFileLocationobject—TransferWorkflowS3FileLocation is a nested property type of AWS::Transfer::Workflow.
onExceptionSteps[].copyStepDetails.destinationFileLocation.s3FileLocationobject—TransferWorkflowS3InputFileLocation is a nested property type of AWS::Transfer::Workflow.
onExceptionSteps[].copyStepDetails.destinationFileLocation.s3FileLocation.bucketstring—Specifies the S3 bucket that contains the file.
onExceptionSteps[].copyStepDetails.destinationFileLocation.s3FileLocation.keystring—The name assigned to the file when it was created in S3.
onExceptionSteps[].copyStepDetails.namestring—The name of the step, used as an identifier.
onExceptionSteps[].copyStepDetails.overwriteExistingenum—A flag that indicates whether or not to overwrite an existing file of the same name. Allowed: TRUE, FALSE
onExceptionSteps[].copyStepDetails.sourceFileLocationstring—Specifies which file to use as input to the workflow step.
onExceptionSteps[].customStepDetailsobject—Details for a step that invokes a lambda function.
onExceptionSteps[].customStepDetails.namestring—The name of the step, used as an identifier.
onExceptionSteps[].customStepDetails.sourceFileLocationstring—Specifies which file to use as input to the workflow step.
onExceptionSteps[].customStepDetails.targetstring—The ARN for the lambda function that is being called.
onExceptionSteps[].customStepDetails.timeoutSecondsinteger—Timeout, in seconds, for the step.
onExceptionSteps[].decryptStepDetailsobject—Details for a step that performs a file decryption.
onExceptionSteps[].decryptStepDetails.destinationFileLocationobjectyesTransferWorkflowInputFileLocation is a nested property type of AWS::Transfer::Workflow.
onExceptionSteps[].decryptStepDetails.destinationFileLocation.efsFileLocationobject—TransferWorkflowEfsInputFileLocation is a nested property type of AWS::Transfer::Workflow.
onExceptionSteps[].decryptStepDetails.destinationFileLocation.efsFileLocation.fileSystemIdstring—Specifies the EFS filesystem that contains the file.
onExceptionSteps[].decryptStepDetails.destinationFileLocation.efsFileLocation.pathstring—The name assigned to the file when it was created in EFS.
onExceptionSteps[].decryptStepDetails.destinationFileLocation.s3FileLocationobject—TransferWorkflowS3InputFileLocation is a nested property type of AWS::Transfer::Workflow.
onExceptionSteps[].decryptStepDetails.destinationFileLocation.s3FileLocation.bucketstring—Specifies the S3 bucket that contains the file.
onExceptionSteps[].decryptStepDetails.destinationFileLocation.s3FileLocation.keystring—The name assigned to the file when it was created in S3.
onExceptionSteps[].decryptStepDetails.namestring—The name of the step, used as an identifier.
onExceptionSteps[].decryptStepDetails.overwriteExistingenum—A flag that indicates whether or not to overwrite an existing file of the same name. Allowed: TRUE, FALSE
onExceptionSteps[].decryptStepDetails.sourceFileLocationstring—Specifies which file to use as input to the workflow step.
onExceptionSteps[].decryptStepDetails.typeenumyesSpecifies which encryption method to use. Allowed: PGP
onExceptionSteps[].deleteStepDetailsobject—Details for a step that deletes the file.
onExceptionSteps[].deleteStepDetails.namestring—The name of the step, used as an identifier.
onExceptionSteps[].deleteStepDetails.sourceFileLocationstring—Specifies which file to use as input to the workflow step.
onExceptionSteps[].tagStepDetailsobject—Details for a step that creates one or more tags.
onExceptionSteps[].tagStepDetails.namestring—The name of the step, used as an identifier.
onExceptionSteps[].tagStepDetails.sourceFileLocationstring—Specifies which file to use as input to the workflow step.
onExceptionSteps[].tagStepDetails.tagsarray<object>—Array that contains from 1 to 10 key/value pairs.
onExceptionSteps[].tagStepDetails.tags[].keystringyes
onExceptionSteps[].tagStepDetails.tags[].valuestringyes
onExceptionSteps[].typeenum—Allowed: COPY, CUSTOM, DECRYPT, DELETE, TAG
providerRefobject—ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
providerRef.namestringyesName of a cluster-scoped AWSProvider.
providerRef.regionstring—Region overrides the provider's region for this resource only.
stepsarray<object>yesSpecifies the details for the steps that are in the specified workflow.
steps[].copyStepDetailsobject—Details for a step that performs a file copy.
steps[].copyStepDetails.destinationFileLocationobject—TransferWorkflowS3FileLocation is a nested property type of AWS::Transfer::Workflow.
steps[].copyStepDetails.destinationFileLocation.s3FileLocationobject—TransferWorkflowS3InputFileLocation is a nested property type of AWS::Transfer::Workflow.
steps[].copyStepDetails.destinationFileLocation.s3FileLocation.bucketstring—Specifies the S3 bucket that contains the file.
steps[].copyStepDetails.destinationFileLocation.s3FileLocation.keystring—The name assigned to the file when it was created in S3.
steps[].copyStepDetails.namestring—The name of the step, used as an identifier.
steps[].copyStepDetails.overwriteExistingenum—A flag that indicates whether or not to overwrite an existing file of the same name. Allowed: TRUE, FALSE
steps[].copyStepDetails.sourceFileLocationstring—Specifies which file to use as input to the workflow step.
steps[].customStepDetailsobject—Details for a step that invokes a lambda function.
steps[].customStepDetails.namestring—The name of the step, used as an identifier.
steps[].customStepDetails.sourceFileLocationstring—Specifies which file to use as input to the workflow step.
steps[].customStepDetails.targetstring—The ARN for the lambda function that is being called.
steps[].customStepDetails.timeoutSecondsinteger—Timeout, in seconds, for the step.
steps[].decryptStepDetailsobject—Details for a step that performs a file decryption.
steps[].decryptStepDetails.destinationFileLocationobjectyesTransferWorkflowInputFileLocation is a nested property type of AWS::Transfer::Workflow.
steps[].decryptStepDetails.destinationFileLocation.efsFileLocationobject—TransferWorkflowEfsInputFileLocation is a nested property type of AWS::Transfer::Workflow.
steps[].decryptStepDetails.destinationFileLocation.efsFileLocation.fileSystemIdstring—Specifies the EFS filesystem that contains the file.
steps[].decryptStepDetails.destinationFileLocation.efsFileLocation.pathstring—The name assigned to the file when it was created in EFS.
steps[].decryptStepDetails.destinationFileLocation.s3FileLocationobject—TransferWorkflowS3InputFileLocation is a nested property type of AWS::Transfer::Workflow.
steps[].decryptStepDetails.destinationFileLocation.s3FileLocation.bucketstring—Specifies the S3 bucket that contains the file.
steps[].decryptStepDetails.destinationFileLocation.s3FileLocation.keystring—The name assigned to the file when it was created in S3.
steps[].decryptStepDetails.namestring—The name of the step, used as an identifier.
steps[].decryptStepDetails.overwriteExistingenum—A flag that indicates whether or not to overwrite an existing file of the same name. Allowed: TRUE, FALSE
steps[].decryptStepDetails.sourceFileLocationstring—Specifies which file to use as input to the workflow step.
steps[].decryptStepDetails.typeenumyesSpecifies which encryption method to use. Allowed: PGP
steps[].deleteStepDetailsobject—Details for a step that deletes the file.
steps[].deleteStepDetails.namestring—The name of the step, used as an identifier.
steps[].deleteStepDetails.sourceFileLocationstring—Specifies which file to use as input to the workflow step.
steps[].tagStepDetailsobject—Details for a step that creates one or more tags.
steps[].tagStepDetails.namestring—The name of the step, used as an identifier.
steps[].tagStepDetails.sourceFileLocationstring—Specifies which file to use as input to the workflow step.
steps[].tagStepDetails.tagsarray<object>—Array that contains from 1 to 10 key/value pairs.
steps[].tagStepDetails.tags[].keystringyes
steps[].tagStepDetails.tags[].valuestringyes
steps[].typeenum—Allowed: COPY, CUSTOM, DECRYPT, DELETE, TAG
tagsarray<object>—Key-value pairs that can be used to group and search for workflows.
tags[].keystringyes
tags[].valuestringyes

Status

FieldTypeRequiredDescription
arnstring—Specifies the unique Amazon Resource Name (ARN) for the workflow.
attemptinteger—Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
awsProviderobject—AWSProvider confirms the account and region this resource was reconciled against.
awsProvider.accountIdstring—AccountID the resource lives in.
awsProvider.namestring—Name of the AWSProvider used; empty when the operator's own credentials were used.
awsProvider.regionstring—Region the resource lives in (empty for global services).
conditionsarray<object>—Conditions describe the current state of the resource.
conditions[].lastTransitionTimestringyeslastTransitionTime is the last time the condition transitioned from one status to another.
conditions[].messagestringyesmessage is a human readable message indicating details about the transition.
conditions[].observedGenerationinteger—observedGeneration represents the .metadata.generation that the condition was set based upon.
conditions[].reasonstringyesreason contains a programmatic identifier indicating the reason for the condition's last transition.
conditions[].statusenumyesstatus of the condition, one of True, False, Unknown. Allowed: True, False, Unknown
conditions[].typestringyestype of condition in CamelCase or in foo.example.com/CamelCase.
identifierstring—Identifier is the Cloud Control primary identifier of the resource.
lastSyncTimestring—
observedGenerationinteger—
operationstring—Operation is the in-flight operation (CREATE, UPDATE, DELETE).
operationStatusstring—OperationStatus is the last reported operation status.
requestTokenstring—RequestToken tracks an in-flight asynchronous operation.
workflowIdstring—A unique identifier for the workflow.