Class CfnServer
A CloudFormation AWS::Transfer::Server
.
Inherited Members
Namespace: Amazon.CDK.AWS.Transfer
Assembly: Amazon.CDK.AWS.Transfer.dll
Syntax (csharp)
public class CfnServer : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnServer
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
Instantiates an auto-scaling virtual server based on the selected file transfer protocol in AWS . When you make updates to your file transfer protocol-enabled server or when you work with users, use the service-generated ServerId
property that is assigned to the newly created server.
CloudformationResource: AWS::Transfer::Server
Link: 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 cfnServer = new CfnServer(this, "MyCfnServer", 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" },
SecurityPolicyName = "securityPolicyName",
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
CfnServer(Construct, String, ICfnServerProps) | Create a new |
CfnServer(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnServer(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AttrArn | The Amazon Resource Name associated with the server, in the form |
AttrServerId | The service-assigned ID of the server that is created. |
Certificate | The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM) certificate. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
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. |
SecurityPolicyName | Specifies the name of the security policy that is attached to the server. |
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. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnServer(Construct, String, ICfnServerProps)
Create a new AWS::Transfer::Server
.
public CfnServer(Construct scope, string id, ICfnServerProps props = null)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnServerProps
- resource properties.
CfnServer(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnServer(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnServer(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnServer(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AttrArn
The Amazon Resource Name associated with the server, in the form arn:aws:transfer:region: *account-id* :server/ *server-id* /
.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
An example of a server ARN is: arn:aws:transfer:us-east-1:123456789012:server/s-01234567890abcdef
.
CloudformationAttribute: Arn
AttrServerId
The service-assigned ID of the server that is created.
public virtual string AttrServerId { get; }
Property Value
System.String
Remarks
An example ServerId
is s-01234567890abcdef
.
CloudformationAttribute: ServerId
Certificate
The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM) certificate.
public virtual 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.
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
Domain
Specifies the domain of the storage system that is used for file transfers.
public virtual string Domain { get; set; }
Property Value
System.String
Remarks
EndpointDetails
The virtual private cloud (VPC) endpoint settings that are configured for your server.
public virtual 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 virtual 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.
IdentityProviderDetails
Required when IdentityProviderType
is set to AWS_DIRECTORY_SERVICE
, AWS _LAMBDA
or API_GATEWAY
.
public virtual 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 virtual 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 virtual 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 virtual 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 virtual 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 virtual object ProtocolDetails { get; set; }
Property Value
System.Object
Remarks
Protocols
Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint.
public virtual string[] Protocols { get; set; }
Property Value
System.String[]
Remarks
The available protocols are:
SecurityPolicyName
Specifies the name of the security policy that is attached to the server.
public virtual string SecurityPolicyName { get; set; }
Property Value
System.String
Remarks
Tags
Key-value pairs that can be used to group and search for servers.
public virtual TagManager Tags { get; }
Property Value
Remarks
WorkflowDetails
Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow.
public virtual 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.
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>