CfnServerProps

class aws_cdk.aws_transfer.CfnServerProps(*, certificate=None, domain=None, endpoint_details=None, endpoint_type=None, identity_provider_details=None, identity_provider_type=None, logging_role=None, post_authentication_login_banner=None, pre_authentication_login_banner=None, protocol_details=None, protocols=None, security_policy_name=None, tags=None, workflow_details=None)

Bases: object

Properties for defining a CfnServer.

Parameters
  • certificate (Optional[str]) – The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM) certificate. 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: - 2048-bit RSA (RSA_2048) - 4096-bit RSA (RSA_4096) - Elliptic Prime Curve 256 bit (EC_prime256v1) - Elliptic Prime Curve 384 bit (EC_secp384r1) - Elliptic Prime Curve 521 bit (EC_secp521r1) .. epigraph:: 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 (Optional[str]) – Specifies the domain of the storage system that is used for file transfers.

  • endpoint_details (Union[IResolvable, EndpointDetailsProperty, Dict[str, Any], None]) – The virtual private cloud (VPC) endpoint settings that are configured for your server. When you host your endpoint within your VPC, you can make it accessible only to resources within your VPC, or you can attach Elastic IP addresses and make it accessible to clients over the internet. Your VPC’s default security groups are automatically assigned to your endpoint.

  • endpoint_type (Optional[str]) – The type of endpoint that you want your server to use. 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.

  • identity_provider_details (Union[IResolvable, IdentityProviderDetailsProperty, Dict[str, Any], None]) – Required when IdentityProviderType is set to AWS_DIRECTORY_SERVICE or API_GATEWAY . 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 .

  • identity_provider_type (Optional[str]) – Specifies the mode of authentication for a server. 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 Managed Active Directory or Microsoft Active Directory in your on-premises environment or in AWS using AD Connectors. This option also requires you to provide a Directory ID 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 API Gateway endpoint URL to call for authentication using the IdentityProviderDetails parameter. Use the AWS_LAMBDA value to directly use a 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.

  • logging_role (Optional[str]) – Specifies 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 EFS events. When set, user activity can be viewed in your CloudWatch logs.

  • post_authentication_login_banner (Optional[str]) – Specify a string to display when users connect to a server. This string is displayed after the user authenticates. .. epigraph:: The SFTP protocol does not support post-authentication display banners.

  • pre_authentication_login_banner (Optional[str]) – Specify a string to display when users connect to a server. 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.

  • protocol_details (Union[IResolvable, ProtocolDetailsProperty, Dict[str, Any], None]) – The protocol settings that are configured for your server. - Use the PassiveIp parameter to indicate passive mode (for FTP and FTPS protocols). Enter a single dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer. - Use the SetStatOption to ignore the error that is generated when the client attempts to use SETSTAT on a file you are uploading to an S3 bucket. Set the value to ENABLE_NO_OP to have the Transfer Family server ignore the SETSTAT command, and upload files without needing to make any changes to your SFTP client. Note that with SetStatOption set to ENABLE_NO_OP , Transfer generates a log entry to CloudWatch Logs, so you can determine when the client is making a SETSTAT call. - Use the TlsSessionResumptionMode parameter to determine whether or not your Transfer server resumes recent, negotiated sessions through a unique session ID.

  • protocols (Optional[Sequence[str]]) – Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server’s endpoint. The available protocols are: - SFTP (Secure Shell (SSH) File Transfer Protocol): File transfer over SSH - FTPS (File Transfer Protocol Secure): File transfer with TLS encryption - FTP (File Transfer Protocol): Unencrypted file transfer .. epigraph:: If you select FTPS , you must choose a certificate stored in AWS Certificate Manager (ACM) which is used to identify your server when clients connect to it over FTPS. If Protocol includes either FTP or FTPS , then the EndpointType must be VPC and the IdentityProviderType must be AWS_DIRECTORY_SERVICE or API_GATEWAY . If Protocol includes FTP , then AddressAllocationIds cannot be associated. If Protocol is set only to SFTP , the EndpointType can be set to PUBLIC and the IdentityProviderType can be set to SERVICE_MANAGED .

  • security_policy_name (Optional[str]) – Specifies the name of the security policy that is attached to the server.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – Key-value pairs that can be used to group and search for servers.

  • workflow_details (Union[IResolvable, WorkflowDetailsProperty, Dict[str, Any], None]) – Specifies the workflow ID for the workflow to assign and the execution role used for executing the workflow.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-server.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_transfer as transfer

cfn_server_props = transfer.CfnServerProps(
    certificate="certificate",
    domain="domain",
    endpoint_details=transfer.CfnServer.EndpointDetailsProperty(
        address_allocation_ids=["addressAllocationIds"],
        security_group_ids=["securityGroupIds"],
        subnet_ids=["subnetIds"],
        vpc_endpoint_id="vpcEndpointId",
        vpc_id="vpcId"
    ),
    endpoint_type="endpointType",
    identity_provider_details=transfer.CfnServer.IdentityProviderDetailsProperty(
        directory_id="directoryId",
        function="function",
        invocation_role="invocationRole",
        url="url"
    ),
    identity_provider_type="identityProviderType",
    logging_role="loggingRole",
    post_authentication_login_banner="postAuthenticationLoginBanner",
    pre_authentication_login_banner="preAuthenticationLoginBanner",
    protocol_details=transfer.CfnServer.ProtocolDetailsProperty(
        as2_transports=["as2Transports"],
        passive_ip="passiveIp",
        set_stat_option="setStatOption",
        tls_session_resumption_mode="tlsSessionResumptionMode"
    ),
    protocols=["protocols"],
    security_policy_name="securityPolicyName",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    workflow_details=transfer.CfnServer.WorkflowDetailsProperty(
        on_partial_upload=[transfer.CfnServer.WorkflowDetailProperty(
            execution_role="executionRole",
            workflow_id="workflowId"
        )],
        on_upload=[transfer.CfnServer.WorkflowDetailProperty(
            execution_role="executionRole",
            workflow_id="workflowId"
        )]
    )
)

Attributes

certificate

The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM) certificate.

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:

  • 2048-bit RSA (RSA_2048)

  • 4096-bit RSA (RSA_4096)

  • Elliptic Prime Curve 256 bit (EC_prime256v1)

  • Elliptic Prime Curve 384 bit (EC_secp384r1)

  • Elliptic Prime Curve 521 bit (EC_secp521r1)

The certificate must be a valid SSL/TLS X.509 version 3 certificate with FQDN or IP address specified and information about the issuer.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-server.html#cfn-transfer-server-certificate

Return type

Optional[str]

domain

Specifies the domain of the storage system that is used for file transfers.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-server.html#cfn-transfer-server-domain

Return type

Optional[str]

endpoint_details

The virtual private cloud (VPC) endpoint settings that are configured for your server.

When you host your endpoint within your VPC, you can make it accessible only to resources within your VPC, or you can attach Elastic IP addresses and make it accessible to clients over the internet. Your VPC’s default security groups are automatically assigned to your endpoint.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-server.html#cfn-transfer-server-endpointdetails

Return type

Union[IResolvable, EndpointDetailsProperty, None]

endpoint_type

The type of endpoint that you want your server to use.

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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-server.html#cfn-transfer-server-endpointtype

Return type

Optional[str]

identity_provider_details

Required when IdentityProviderType is set to AWS_DIRECTORY_SERVICE or API_GATEWAY .

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 .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-server.html#cfn-transfer-server-identityproviderdetails

Return type

Union[IResolvable, IdentityProviderDetailsProperty, None]

identity_provider_type

Specifies the mode of authentication for a server.

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 Managed Active Directory or Microsoft Active Directory in your on-premises environment or in AWS using AD Connectors. This option also requires you to provide a Directory ID 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 API Gateway endpoint URL to call for authentication using the IdentityProviderDetails parameter.

Use the AWS_LAMBDA value to directly use a 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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-server.html#cfn-transfer-server-identityprovidertype

Return type

Optional[str]

logging_role

Specifies 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 EFS events.

When set, user activity can be viewed in your CloudWatch logs.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-server.html#cfn-transfer-server-loggingrole

Return type

Optional[str]

post_authentication_login_banner

Specify a string to display when users connect to a server. This string is displayed after the user authenticates.

The SFTP protocol does not support post-authentication display banners.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-server.html#cfn-transfer-server-postauthenticationloginbanner

Return type

Optional[str]

pre_authentication_login_banner

Specify a string to display when users connect to a server.

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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-server.html#cfn-transfer-server-preauthenticationloginbanner

Return type

Optional[str]

protocol_details

The protocol settings that are configured for your server.

  • Use the PassiveIp parameter to indicate passive mode (for FTP and FTPS protocols). Enter a single dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer.

  • Use the SetStatOption to ignore the error that is generated when the client attempts to use SETSTAT on a file you are uploading to an S3 bucket. Set the value to ENABLE_NO_OP to have the Transfer Family server ignore the SETSTAT command, and upload files without needing to make any changes to your SFTP client. Note that with SetStatOption set to ENABLE_NO_OP , Transfer generates a log entry to CloudWatch Logs, so you can determine when the client is making a SETSTAT call.

  • Use the TlsSessionResumptionMode parameter to determine whether or not your Transfer server resumes recent, negotiated sessions through a unique session ID.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-server.html#cfn-transfer-server-protocoldetails

Return type

Union[IResolvable, ProtocolDetailsProperty, None]

protocols

Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server’s endpoint.

The available protocols are:

  • SFTP (Secure Shell (SSH) File Transfer Protocol): File transfer over SSH

  • FTPS (File Transfer Protocol Secure): File transfer with TLS encryption

  • FTP (File Transfer Protocol): Unencrypted file transfer

If you select FTPS , you must choose a certificate stored in AWS Certificate Manager (ACM) which is used to identify your server when clients connect to it over FTPS.

If Protocol includes either FTP or FTPS , then the EndpointType must be VPC and the IdentityProviderType must be AWS_DIRECTORY_SERVICE or API_GATEWAY .

If Protocol includes FTP , then AddressAllocationIds cannot be associated.

If Protocol is set only to SFTP , the EndpointType can be set to PUBLIC and the IdentityProviderType can be set to SERVICE_MANAGED .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-server.html#cfn-transfer-server-protocols

Return type

Optional[List[str]]

security_policy_name

Specifies the name of the security policy that is attached to the server.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-server.html#cfn-transfer-server-securitypolicyname

Return type

Optional[str]

tags

Key-value pairs that can be used to group and search for servers.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-server.html#cfn-transfer-server-tags

Return type

Optional[List[CfnTag]]

workflow_details

Specifies the workflow ID for the workflow to assign and the execution role used for executing the workflow.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-server.html#cfn-transfer-server-workflowdetails

Return type

Union[IResolvable, WorkflowDetailsProperty, None]