Server is the Schema for the Servers API. Provides a AWS Transfer Server resource.
Type
CRD
Group
transfer.aws.upbound.io
Version
v1beta1
apiVersion: transfer.aws.upbound.io/v1beta1
kind: Server
ServerSpec defines the desired state of Server
No description provided.
Reference to a Certificate in acm to populate certificate.
Policies for referencing.
Selector for a Certificate in acm to populate certificate.
Policies for selection.
Reference to a Directory in ds to populate directoryId.
Policies for referencing.
Selector for a Directory in ds to populate directoryId.
Policies for selection.
The virtual private cloud (VPC) endpoint settings that you want to configure for your SFTP server. Fields documented below.
A list of address allocation IDs that are required to attach an Elastic IP address to your SFTP server's endpoint. This property can only be used when endpoint_type is set to VPC.
A list of security groups IDs that are available to attach to your server's endpoint. If no security groups are specified, the VPC's default security groups are automatically assigned to your endpoint. This property can only be used when endpoint_type is set to VPC.
A list of subnet IDs that are required to host your SFTP server endpoint in your VPC. This property can only be used when endpoint_type is set to VPC.
Reference to a VPC in ec2 to populate vpcId.
Policies for referencing.
Selector for a VPC in ec2 to populate vpcId.
Policies for selection.
RSA, ECDSA, or ED25519 private key (e.g., as generated by the ssh-keygen -t rsa -b 2048 -N "" -m PEM -f my-new-server-key, ssh-keygen -t ecdsa -b 256 -N "" -m PEM -f my-new-server-key or ssh-keygen -t ed25519 -N "" -f my-new-server-key commands).
Reference to a Role in iam to populate loggingRole.
Policies for referencing.
Selector for a Role in iam to populate loggingRole.
Policies for selection.
The protocol settings that are configured for your server.
Indicates the transport method for the AS2 messages. Currently, only HTTP is supported.
Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint. This defaults to SFTP . The available protocols are:
A set of ARNs of destinations that will receive structured logs from the transfer server such as CloudWatch Log Group ARNs. If provided this enables the transfer server to emit structured logs to the specified locations. This is a set of arns of destinations that will receive structured logs from the transfer server
Specifies the workflow details. See Workflow Details below.
A trigger that starts a workflow if a file is only partially uploaded. See Workflow Detail below.
A trigger that starts a workflow: the workflow begins to execute after a file is uploaded. See Workflow Detail below.
THIS IS A BETA FIELD. It will be honored unless the Management Policies feature flag is disabled. InitProvider holds the same fields as ForProvider, with the exception of Identifier and other resource reference fields. The fields that are in InitProvider are merged into ForProvider when the resource is created. The same fields are also added to the terraform ignore_changes hook, to avoid updating them after creation. This is useful for fields that are required on creation, but we do not desire to update them after creation, for example because of an external controller is managing them, like an autoscaler.
Reference to a Certificate in acm to populate certificate.
Policies for referencing.
Selector for a Certificate in acm to populate certificate.
Policies for selection.
Reference to a Directory in ds to populate directoryId.
Policies for referencing.
Selector for a Directory in ds to populate directoryId.
Policies for selection.
The virtual private cloud (VPC) endpoint settings that you want to configure for your SFTP server. Fields documented below.
A list of address allocation IDs that are required to attach an Elastic IP address to your SFTP server's endpoint. This property can only be used when endpoint_type is set to VPC.
A list of security groups IDs that are available to attach to your server's endpoint. If no security groups are specified, the VPC's default security groups are automatically assigned to your endpoint. This property can only be used when endpoint_type is set to VPC.
A list of subnet IDs that are required to host your SFTP server endpoint in your VPC. This property can only be used when endpoint_type is set to VPC.
Reference to a VPC in ec2 to populate vpcId.
Policies for referencing.
Selector for a VPC in ec2 to populate vpcId.
Policies for selection.
Reference to a Role in iam to populate loggingRole.
Policies for referencing.
Selector for a Role in iam to populate loggingRole.
Policies for selection.
The protocol settings that are configured for your server.
Indicates the transport method for the AS2 messages. Currently, only HTTP is supported.
Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint. This defaults to SFTP . The available protocols are:
A set of ARNs of destinations that will receive structured logs from the transfer server such as CloudWatch Log Group ARNs. If provided this enables the transfer server to emit structured logs to the specified locations. This is a set of arns of destinations that will receive structured logs from the transfer server
Specifies the workflow details. See Workflow Details below.
A trigger that starts a workflow if a file is only partially uploaded. See Workflow Detail below.
A trigger that starts a workflow: the workflow begins to execute after a file is uploaded. See Workflow Detail below.
THIS IS A BETA FIELD. It is on by default but can be opted out through a Crossplane feature flag. ManagementPolicies specify the array of actions Crossplane is allowed to take on the managed and external resources. This field is planned to replace the DeletionPolicy field in a future release. Currently, both could be set independently and non-default values would be honored if the feature flag is enabled. If both are custom, the DeletionPolicy field will be ignored. See the design doc for more information: https://github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223 and this one: https://github.com/crossplane/crossplane/blob/444267e84783136daa93568b364a5f01228cacbe/design/one-pager-ignore-changes.md
ProviderConfigReference specifies how the provider that will be used to create, observe, update, and delete this managed resource should be configured.
Policies for referencing.
PublishConnectionDetailsTo specifies the connection secret config which contains a name, metadata and a reference to secret store config to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource.
WriteConnectionSecretToReference specifies the namespace and name of a Secret to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource. This field is planned to be replaced in a future release in favor of PublishConnectionDetailsTo. Currently, both could be set independently and connection details would be published to both without affecting each other.
ServerStatus defines the observed state of Server.
No description provided.
The virtual private cloud (VPC) endpoint settings that you want to configure for your SFTP server. Fields documented below.
A list of address allocation IDs that are required to attach an Elastic IP address to your SFTP server's endpoint. This property can only be used when endpoint_type is set to VPC.
A list of security groups IDs that are available to attach to your server's endpoint. If no security groups are specified, the VPC's default security groups are automatically assigned to your endpoint. This property can only be used when endpoint_type is set to VPC.
A list of subnet IDs that are required to host your SFTP server endpoint in your VPC. This property can only be used when endpoint_type is set to VPC.
The protocol settings that are configured for your server.
Indicates the transport method for the AS2 messages. Currently, only HTTP is supported.
Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint. This defaults to SFTP . The available protocols are:
A set of ARNs of destinations that will receive structured logs from the transfer server such as CloudWatch Log Group ARNs. If provided this enables the transfer server to emit structured logs to the specified locations. This is a set of arns of destinations that will receive structured logs from the transfer server
Specifies the workflow details. See Workflow Details below.
A trigger that starts a workflow if a file is only partially uploaded. See Workflow Detail below.
A trigger that starts a workflow: the workflow begins to execute after a file is uploaded. See Workflow Detail below.
Conditions of the resource.
example
apiVersion: transfer.aws.upbound.io/v1beta1
kind: Server
metadata:
name: example
spec:
forProvider:
region: us-west-1
tags:
Name: Example
example
apiVersion: transfer.aws.upbound.io/v1beta1
kind: Server
metadata:
annotations:
meta.upbound.io/example-id: transfer/v1beta1/sshkey
labels:
testing.upbound.io/example-name: example
name: example
spec:
forProvider:
identityProviderType: SERVICE_MANAGED
region: us-west-1
tags:
NAME: tf-acc-test-transfer-server
© 2022 Upbound, Inc.
Discover the building blocksfor your internal cloud platform.