Class CfnServer
Instantiates an auto-scaling virtual server based on the selected file transfer protocol in AWS .
Inherited Members
Namespace: Amazon.CDK.AWS.Transfer
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnServer : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnServer
Inherits CfnResource
Implements IInspectable, ITaggable
Remarks
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.
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-server.html
CloudformationResource: AWS::Transfer::Server
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" },
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
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 |
CfnServer(Construct, String, ICfnServerProps) |
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. |
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. |
SecurityPolicyName | Specifies the name of the security policy for the server. |
StructuredLogDestinations | Specifies the log groups to which your server logs are sent. |
Tags | Tag Manager which manages the tags for this resource. |
TagsRaw | 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(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
CfnServer(Construct, String, ICfnServerProps)
public CfnServer(Construct scope, string id, ICfnServerProps props = null)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnServerProps
Resource properties.
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
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
EndpointDetails
The virtual private cloud (VPC) endpoint settings that are configured for your server.
public virtual object EndpointDetails { get; set; }
Property Value
System.Object
EndpointType
The type of endpoint that you want your server to use.
public virtual string EndpointType { get; set; }
Property Value
System.String
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
IdentityProviderType
The mode of authentication for a server.
public virtual string IdentityProviderType { get; set; }
Property Value
System.String
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
PostAuthenticationLoginBanner
Specifies a string to display when users connect to a server.
public virtual string PostAuthenticationLoginBanner { get; set; }
Property Value
System.String
Remarks
This string is displayed after the user authenticates.
PreAuthenticationLoginBanner
Specifies a string to display when users connect to a server.
public virtual string PreAuthenticationLoginBanner { get; set; }
Property Value
System.String
ProtocolDetails
The protocol settings that are configured for your server.
public virtual object ProtocolDetails { get; set; }
Property Value
System.Object
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[]
S3StorageOptions
Specifies whether or not performance for your Amazon S3 directories is optimized.
public virtual object S3StorageOptions { get; set; }
Property Value
System.Object
Remarks
This is disabled by default.
SecurityPolicyName
Specifies the name of the security policy for the server.
public virtual string SecurityPolicyName { get; set; }
Property Value
System.String
StructuredLogDestinations
Specifies the log groups to which your server logs are sent.
public virtual string[] StructuredLogDestinations { get; set; }
Property Value
System.String[]
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
TagsRaw
Key-value pairs that can be used to group and search for servers.
public virtual ICfnTag[] TagsRaw { get; set; }
Property Value
ICfnTag[]
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
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>