Class CfnServerProps
Properties for defining a CfnServer
.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.Transfer
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnServerProps : Object, ICfnServerProps
Syntax (vb)
Public Class CfnServerProps
Inherits Object
Implements ICfnServerProps
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-server.html
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Transfer;
var cfnServerProps = new CfnServerProps {
Certificate = "certificate",
Domain = "domain",
EndpointDetails = new EndpointDetailsProperty {
AddressAllocationIds = new [] { "addressAllocationIds" },
SecurityGroupIds = new [] { "securityGroupIds" },
SubnetIds = new [] { "subnetIds" },
VpcEndpointId = "vpcEndpointId",
VpcId = "vpcId"
},
EndpointType = "endpointType",
IdentityProviderDetails = new IdentityProviderDetailsProperty {
DirectoryId = "directoryId",
Function = "function",
InvocationRole = "invocationRole",
SftpAuthenticationMethods = "sftpAuthenticationMethods",
Url = "url"
},
IdentityProviderType = "identityProviderType",
LoggingRole = "loggingRole",
PostAuthenticationLoginBanner = "postAuthenticationLoginBanner",
PreAuthenticationLoginBanner = "preAuthenticationLoginBanner",
ProtocolDetails = new ProtocolDetailsProperty {
As2Transports = new [] { "as2Transports" },
PassiveIp = "passiveIp",
SetStatOption = "setStatOption",
TlsSessionResumptionMode = "tlsSessionResumptionMode"
},
Protocols = new [] { "protocols" },
S3StorageOptions = new S3StorageOptionsProperty {
DirectoryListingOptimization = "directoryListingOptimization"
},
SecurityPolicyName = "securityPolicyName",
StructuredLogDestinations = new [] { "structuredLogDestinations" },
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
WorkflowDetails = new WorkflowDetailsProperty {
OnPartialUpload = new [] { new WorkflowDetailProperty {
ExecutionRole = "executionRole",
WorkflowId = "workflowId"
} },
OnUpload = new [] { new WorkflowDetailProperty {
ExecutionRole = "executionRole",
WorkflowId = "workflowId"
} }
}
};
Synopsis
Constructors
CfnServerProps() |
Properties
Certificate | The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM) certificate. |
Domain | Specifies the domain of the storage system that is used for file transfers. |
EndpointDetails | The virtual private cloud (VPC) endpoint settings that are configured for your server. |
EndpointType | The type of endpoint that you want your server to use. |
IdentityProviderDetails | Required when |
IdentityProviderType | The mode of authentication for a server. |
LoggingRole | The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFSevents. |
PostAuthenticationLoginBanner | Specifies a string to display when users connect to a server. This string is displayed after the user authenticates. |
PreAuthenticationLoginBanner | Specifies a string to display when users connect to a server. |
ProtocolDetails | The protocol settings that are configured for your server. |
Protocols | Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint. |
S3StorageOptions | Specifies whether or not performance for your Amazon S3 directories is optimized. This is disabled by default. |
SecurityPolicyName | Specifies the name of the security policy that is attached to the server. |
StructuredLogDestinations | Specifies the log groups to which your server logs are sent. |
Tags | Key-value pairs that can be used to group and search for servers. |
WorkflowDetails | Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow. |
Constructors
CfnServerProps()
public CfnServerProps()
Properties
Certificate
The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM) certificate.
public string Certificate { get; set; }
Property Value
System.String
Remarks
Required when Protocols
is set to FTPS
.
To request a new public certificate, see Request a public certificate in the AWS Certificate Manager User Guide .
To import an existing certificate into ACM, see Importing certificates into ACM in the AWS Certificate Manager User Guide .
To request a private certificate to use FTPS through private IP addresses, see Request a private certificate in the AWS Certificate Manager User Guide .
Certificates with the following cryptographic algorithms and key sizes are supported:
The certificate must be a valid SSL/TLS X.509 version 3 certificate with FQDN or IP address specified and information about the issuer.
Domain
Specifies the domain of the storage system that is used for file transfers.
public string Domain { get; set; }
Property Value
System.String
Remarks
EndpointDetails
The virtual private cloud (VPC) endpoint settings that are configured for your server.
public object EndpointDetails { get; set; }
Property Value
System.Object
Remarks
When you host your endpoint within your VPC, you can make your endpoint accessible only to resources within your VPC, or you can attach Elastic IP addresses and make your endpoint accessible to clients over the internet. Your VPC's default security groups are automatically assigned to your endpoint.
EndpointType
The type of endpoint that you want your server to use.
public string EndpointType { get; set; }
Property Value
System.String
Remarks
You can choose to make your server's endpoint publicly accessible (PUBLIC) or host it inside your VPC. With an endpoint that is hosted in a VPC, you can restrict access to your server and resources only within your VPC or choose to make it internet facing by attaching Elastic IP addresses directly to it.
After May 19, 2021, you won't be able to create a server using EndpointType=VPC_ENDPOINT
in your AWS account if your account hasn't already done so before May 19, 2021. If you have already created servers with EndpointType=VPC_ENDPOINT
in your AWS account on or before May 19, 2021, you will not be affected. After this date, use EndpointType
= VPC
.
For more information, see Discontinuing the use of VPC_ENDPOINT .
It is recommended that you use VPC
as the EndpointType
. With this endpoint type, you have the option to directly associate up to three Elastic IPv4 addresses (BYO IP included) with your server's endpoint and use VPC security groups to restrict traffic by the client's public IP address. This is not possible with EndpointType
set to VPC_ENDPOINT
.
IdentityProviderDetails
Required when IdentityProviderType
is set to AWS_DIRECTORY_SERVICE
, AWS _LAMBDA
or API_GATEWAY
.
public object IdentityProviderDetails { get; set; }
Property Value
System.Object
Remarks
Accepts an array containing all of the information required to use a directory in AWS_DIRECTORY_SERVICE
or invoke a customer-supplied authentication API, including the API Gateway URL. Not required when IdentityProviderType
is set to SERVICE_MANAGED
.
IdentityProviderType
The mode of authentication for a server.
public string IdentityProviderType { get; set; }
Property Value
System.String
Remarks
The default value is SERVICE_MANAGED
, which allows you to store and access user credentials within the AWS Transfer Family service.
Use AWS_DIRECTORY_SERVICE
to provide access to Active Directory groups in AWS Directory Service for Microsoft Active Directory or Microsoft Active Directory in your on-premises environment or in AWS using AD Connector. This option also requires you to provide a Directory ID by using the IdentityProviderDetails
parameter.
Use the API_GATEWAY
value to integrate with an identity provider of your choosing. The API_GATEWAY
setting requires you to provide an Amazon API Gateway endpoint URL to call for authentication by using the IdentityProviderDetails
parameter.
Use the AWS_LAMBDA
value to directly use an AWS Lambda function as your identity provider. If you choose this value, you must specify the ARN for the Lambda function in the Function
parameter for the IdentityProviderDetails
data type.
LoggingRole
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFSevents.
public string LoggingRole { get; set; }
Property Value
System.String
Remarks
When set, you can view user activity in your CloudWatch logs.
PostAuthenticationLoginBanner
Specifies a string to display when users connect to a server. This string is displayed after the user authenticates.
public string PostAuthenticationLoginBanner { get; set; }
Property Value
System.String
Remarks
The SFTP protocol does not support post-authentication display banners.
PreAuthenticationLoginBanner
Specifies a string to display when users connect to a server.
public string PreAuthenticationLoginBanner { get; set; }
Property Value
System.String
Remarks
This string is displayed before the user authenticates. For example, the following banner displays details about using the system:
This system is for the use of authorized users only. Individuals using this computer system without authority, or in excess of their authority, are subject to having all of their activities on this system monitored and recorded by system personnel.
ProtocolDetails
The protocol settings that are configured for your server.
public object ProtocolDetails { get; set; }
Property Value
System.Object
Remarks
The Protocols
parameter is an array of strings.
Allowed values : One or more of SFTP
, FTPS
, FTP
, AS2
Protocols
Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint.
public string[] Protocols { get; set; }
Property Value
System.String[]
Remarks
The available protocols are:
The Protocols
parameter is an array of strings.
Allowed values : One or more of SFTP
, FTPS
, FTP
, AS2
S3StorageOptions
Specifies whether or not performance for your Amazon S3 directories is optimized. This is disabled by default.
public object S3StorageOptions { get; set; }
Property Value
System.Object
Remarks
By default, home directory mappings have a TYPE
of DIRECTORY
. If you enable this option, you would then need to explicitly set the HomeDirectoryMapEntry
Type
to FILE
if you want a mapping to have a file target.
SecurityPolicyName
Specifies the name of the security policy that is attached to the server.
public string SecurityPolicyName { get; set; }
Property Value
System.String
Remarks
StructuredLogDestinations
Specifies the log groups to which your server logs are sent.
public string[] StructuredLogDestinations { get; set; }
Property Value
System.String[]
Remarks
To specify a log group, you must provide the ARN for an existing log group. In this case, the format of the log group is as follows:
arn:aws:logs:region-name:amazon-account-id:log-group:log-group-name:*
For example, arn:aws:logs:us-east-1:111122223333:log-group:mytestgroup:*
If you have previously specified a log group for a server, you can clear it, and in effect turn off structured logging, by providing an empty value for this parameter in an update-server
call. For example:
update-server --server-id s-1234567890abcdef0 --structured-log-destinations
Tags
Key-value pairs that can be used to group and search for servers.
public ICfnTag[] Tags { get; set; }
Property Value
ICfnTag[]
Remarks
WorkflowDetails
Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow.
public object WorkflowDetails { get; set; }
Property Value
System.Object
Remarks
In addition to a workflow to execute when a file is uploaded completely, WorkflowDetails
can also contain a workflow ID (and execution role) for a workflow to execute on partial upload. A partial upload occurs when a file is open when the session disconnects.