Class: AWSCDK::Transfer::CfnServerProps
- Inherits:
-
Jsii::Struct
- Object
- Jsii::Struct
- AWSCDK::Transfer::CfnServerProps
- Defined in:
- transfer/cfn_server_props.rb
Overview
Properties for defining a CfnServer.
Instance Attribute Summary collapse
-
#certificate ⇒ String?
readonly
The Amazon Resource Name (ARN) of the Certificate Manager (ACM) certificate.
-
#domain ⇒ String?
readonly
Specifies the domain of the storage system that is used for file transfers.
-
#endpoint_details ⇒ AWSCDK::IResolvable, ...
readonly
The virtual private cloud (VPC) endpoint settings that are configured for your server.
-
#endpoint_type ⇒ String?
readonly
The type of endpoint that you want your server to use.
-
#identity_provider_details ⇒ AWSCDK::IResolvable, ...
readonly
Required when
IdentityProviderTypeis set toAWS_DIRECTORY_SERVICE,AWS _LAMBDAorAPI_GATEWAY. -
#identity_provider_type ⇒ String?
readonly
The mode of authentication for a server.
-
#ip_address_type ⇒ String?
readonly
Specifies whether to use IPv4 only, or to use dual-stack (IPv4 and IPv6) for your AWS Transfer Family endpoint.
-
#logging_role ⇒ String?
readonly
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.
-
#post_authentication_login_banner ⇒ String?
readonly
Specifies a string to display when users connect to a server.
-
#pre_authentication_login_banner ⇒ String?
readonly
Specifies a string to display when users connect to a server.
-
#protocol_details ⇒ AWSCDK::IResolvable, ...
readonly
The protocol settings that are configured for your server.
-
#protocols ⇒ Array<String>?
readonly
Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint.
-
#s3_storage_options ⇒ AWSCDK::IResolvable, ...
readonly
Specifies whether or not performance for your Amazon S3 directories is optimized.
-
#security_policy_name ⇒ String?
readonly
Specifies the name of the security policy for the server.
-
#structured_log_destinations ⇒ Array<String>?
readonly
Specifies the log groups to which your server logs are sent.
-
#tags ⇒ Array<AWSCDK::CfnTag>?
readonly
Key-value pairs that can be used to group and search for servers.
-
#workflow_details ⇒ AWSCDK::IResolvable, ...
readonly
Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow.
Class Method Summary collapse
Instance Method Summary collapse
-
#initialize(certificate: nil, domain: nil, endpoint_details: nil, endpoint_type: nil, identity_provider_details: nil, identity_provider_type: nil, ip_address_type: nil, logging_role: nil, post_authentication_login_banner: nil, pre_authentication_login_banner: nil, protocol_details: nil, protocols: nil, s3_storage_options: nil, security_policy_name: nil, structured_log_destinations: nil, tags: nil, workflow_details: nil) ⇒ CfnServerProps
constructor
A new instance of CfnServerProps.
- #to_jsii ⇒ Object
Constructor Details
#initialize(certificate: nil, domain: nil, endpoint_details: nil, endpoint_type: nil, identity_provider_details: nil, identity_provider_type: nil, ip_address_type: nil, logging_role: nil, post_authentication_login_banner: nil, pre_authentication_login_banner: nil, protocol_details: nil, protocols: nil, s3_storage_options: nil, security_policy_name: nil, structured_log_destinations: nil, tags: nil, workflow_details: nil) ⇒ CfnServerProps
Returns a new instance of CfnServerProps.
26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 |
# File 'transfer/cfn_server_props.rb', line 26 def initialize(certificate: nil, domain: nil, endpoint_details: nil, endpoint_type: nil, identity_provider_details: nil, identity_provider_type: nil, ip_address_type: nil, logging_role: nil, post_authentication_login_banner: nil, pre_authentication_login_banner: nil, protocol_details: nil, protocols: nil, s3_storage_options: nil, security_policy_name: nil, structured_log_destinations: nil, tags: nil, workflow_details: nil) @certificate = certificate Jsii::Type.check_type(@certificate, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "certificate") unless @certificate.nil? @domain = domain Jsii::Type.check_type(@domain, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "domain") unless @domain.nil? @endpoint_details = endpoint_details.is_a?(Hash) ? ::AWSCDK::Transfer::CfnServer::EndpointDetailsProperty.new(**endpoint_details.transform_keys(&:to_sym)) : endpoint_details Jsii::Type.check_type(@endpoint_details, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c190cmFuc2Zlci5DZm5TZXJ2ZXIuRW5kcG9pbnREZXRhaWxzUHJvcGVydHkifV19fQ==")), "endpointDetails") unless @endpoint_details.nil? @endpoint_type = endpoint_type Jsii::Type.check_type(@endpoint_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "endpointType") unless @endpoint_type.nil? @identity_provider_details = identity_provider_details.is_a?(Hash) ? ::AWSCDK::Transfer::CfnServer::IdentityProviderDetailsProperty.new(**identity_provider_details.transform_keys(&:to_sym)) : identity_provider_details Jsii::Type.check_type(@identity_provider_details, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c190cmFuc2Zlci5DZm5TZXJ2ZXIuSWRlbnRpdHlQcm92aWRlckRldGFpbHNQcm9wZXJ0eSJ9XX19")), "identityProviderDetails") unless @identity_provider_details.nil? @identity_provider_type = identity_provider_type Jsii::Type.check_type(@identity_provider_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "identityProviderType") unless @identity_provider_type.nil? @ip_address_type = ip_address_type Jsii::Type.check_type(@ip_address_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "ipAddressType") unless @ip_address_type.nil? @logging_role = logging_role Jsii::Type.check_type(@logging_role, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "loggingRole") unless @logging_role.nil? @post_authentication_login_banner = Jsii::Type.check_type(@post_authentication_login_banner, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "postAuthenticationLoginBanner") unless @post_authentication_login_banner.nil? @pre_authentication_login_banner = Jsii::Type.check_type(@pre_authentication_login_banner, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "preAuthenticationLoginBanner") unless @pre_authentication_login_banner.nil? @protocol_details = protocol_details.is_a?(Hash) ? ::AWSCDK::Transfer::CfnServer::ProtocolDetailsProperty.new(**protocol_details.transform_keys(&:to_sym)) : protocol_details Jsii::Type.check_type(@protocol_details, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c190cmFuc2Zlci5DZm5TZXJ2ZXIuUHJvdG9jb2xEZXRhaWxzUHJvcGVydHkifV19fQ==")), "protocolDetails") unless @protocol_details.nil? @protocols = protocols Jsii::Type.check_type(@protocols, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "protocols") unless @protocols.nil? @s3_storage_options = .is_a?(Hash) ? ::AWSCDK::Transfer::CfnServer::S3StorageOptionsProperty.new(**.transform_keys(&:to_sym)) : Jsii::Type.check_type(@s3_storage_options, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c190cmFuc2Zlci5DZm5TZXJ2ZXIuUzNTdG9yYWdlT3B0aW9uc1Byb3BlcnR5In1dfX0=")), "s3StorageOptions") unless @s3_storage_options.nil? @security_policy_name = security_policy_name Jsii::Type.check_type(@security_policy_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "securityPolicyName") unless @security_policy_name.nil? @structured_log_destinations = structured_log_destinations Jsii::Type.check_type(@structured_log_destinations, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "structuredLogDestinations") unless @structured_log_destinations.nil? @tags = .is_a?(Array) ? .map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless @tags.nil? @workflow_details = workflow_details.is_a?(Hash) ? ::AWSCDK::Transfer::CfnServer::WorkflowDetailsProperty.new(**workflow_details.transform_keys(&:to_sym)) : workflow_details Jsii::Type.check_type(@workflow_details, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c190cmFuc2Zlci5DZm5TZXJ2ZXIuV29ya2Zsb3dEZXRhaWxzUHJvcGVydHkifV19fQ==")), "workflowDetails") unless @workflow_details.nil? end |
Instance Attribute Details
#certificate ⇒ String? (readonly)
The Amazon Resource Name (ARN) of the Certificate Manager (ACM) certificate. Required when Protocols is set to FTPS .
To request a new public certificate, see Request a public certificate in the Certificate Manager User Guide .
To import an existing certificate into ACM, see Importing certificates into ACM in the Certificate Manager User Guide .
To request a private certificate to use FTPS through private IP addresses, see Request a private certificate in the 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.
83 84 85 |
# File 'transfer/cfn_server_props.rb', line 83 def certificate @certificate end |
#domain ⇒ String? (readonly)
Specifies the domain of the storage system that is used for file transfers.
There are two domains available: Amazon Simple Storage Service (Amazon S3) and Amazon Elastic File System (Amazon EFS). The default value is S3.
90 91 92 |
# File 'transfer/cfn_server_props.rb', line 90 def domain @domain end |
#endpoint_details ⇒ AWSCDK::IResolvable, ... (readonly)
The virtual private cloud (VPC) endpoint settings that are configured for your server.
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.
97 98 99 |
# File 'transfer/cfn_server_props.rb', line 97 def endpoint_details @endpoint_details end |
#endpoint_type ⇒ String? (readonly)
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.
After May 19, 2021, you won't be able to create a server using
EndpointType=VPC_ENDPOINTin your AWS account if your account hasn't already done so before May 19, 2021. If you have already created servers withEndpointType=VPC_ENDPOINTin your AWS account on or before May 19, 2021, you will not be affected. After this date, useEndpointType=VPC.For more information, see Discontinuing the use of VPC_ENDPOINT .
It is recommended that you use
VPCas theEndpointType. 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 withEndpointTypeset toVPC_ENDPOINT.
110 111 112 |
# File 'transfer/cfn_server_props.rb', line 110 def endpoint_type @endpoint_type end |
#identity_provider_details ⇒ AWSCDK::IResolvable, ... (readonly)
Required when IdentityProviderType is set to AWS_DIRECTORY_SERVICE , AWS _LAMBDA 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. Cannot be specified when IdentityProviderType is set to SERVICE_MANAGED .
117 118 119 |
# File 'transfer/cfn_server_props.rb', line 117 def identity_provider_details @identity_provider_details end |
#identity_provider_type ⇒ String? (readonly)
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 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.
130 131 132 |
# File 'transfer/cfn_server_props.rb', line 130 def identity_provider_type @identity_provider_type end |
#ip_address_type ⇒ String? (readonly)
Specifies whether to use IPv4 only, or to use dual-stack (IPv4 and IPv6) for your AWS Transfer Family endpoint.
The default value is IPV4 .
The
IpAddressTypeparameter has the following limitations:
- It cannot be changed while the server is online. You must stop the server before modifying this parameter.
- It cannot be updated to
DUALSTACKif the server hasAddressAllocationIdsspecified. > When usingDUALSTACKas theIpAddressType, you cannot set theAddressAllocationIdsparameter for the EndpointDetails for the server.
142 143 144 |
# File 'transfer/cfn_server_props.rb', line 142 def ip_address_type @ip_address_type end |
#logging_role ⇒ String? (readonly)
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, you can view user activity in your CloudWatch logs.
149 150 151 |
# File 'transfer/cfn_server_props.rb', line 149 def logging_role @logging_role end |
#post_authentication_login_banner ⇒ String? (readonly)
Specifies 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.
156 157 158 |
# File 'transfer/cfn_server_props.rb', line 156 def @post_authentication_login_banner end |
#pre_authentication_login_banner ⇒ String? (readonly)
Specifies 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.
165 166 167 |
# File 'transfer/cfn_server_props.rb', line 165 def @pre_authentication_login_banner end |
#protocol_details ⇒ AWSCDK::IResolvable, ... (readonly)
The protocol settings that are configured for your server.
- To indicate passive mode (for FTP and FTPS protocols), use the
PassiveIpparameter. Enter a single dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer. - To ignore the error that is generated when the client attempts to use the
SETSTATcommand on a file that you are uploading to an Amazon S3 bucket, use theSetStatOptionparameter. To have the AWS Transfer Family server ignore theSETSTATcommand and upload files without needing to make any changes to your SFTP client, set the value toENABLE_NO_OP. If you set theSetStatOptionparameter toENABLE_NO_OP, Transfer Family generates a log entry to Amazon CloudWatch Logs, so that you can determine when the client is making aSETSTATcall. - To determine whether your AWS Transfer Family server resumes recent, negotiated sessions through a unique session ID, use the
TlsSessionResumptionModeparameter. As2Transportsindicates the transport method for the AS2 messages. Currently, only HTTP is supported.
The Protocols parameter is an array of strings.
Allowed values : One or more of SFTP , FTPS , FTP , AS2
179 180 181 |
# File 'transfer/cfn_server_props.rb', line 179 def protocol_details @protocol_details end |
#protocols ⇒ Array<String>? (readonly)
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 SSHFTPS(File Transfer Protocol Secure): File transfer with TLS encryptionFTP(File Transfer Protocol): Unencrypted file transferAS2(Applicability Statement 2): used for transporting structured business-to-business data
- If you select
FTPS, you must choose a certificate stored in Certificate Manager (ACM) which is used to identify your server when clients connect to it over FTPS.- If
Protocolincludes eitherFTPorFTPS, then theEndpointTypemust beVPCand theIdentityProviderTypemust be eitherAWS_DIRECTORY_SERVICE,AWS_LAMBDA, orAPI_GATEWAY.- If
ProtocolincludesFTP, thenAddressAllocationIdscannot be associated.- If
Protocolis set only toSFTP, theEndpointTypecan be set toPUBLICand theIdentityProviderTypecan be set any of the supported identity types:SERVICE_MANAGED,AWS_DIRECTORY_SERVICE,AWS_LAMBDA, orAPI_GATEWAY.- If
ProtocolincludesAS2, then theEndpointTypemust beVPC, and domain must be Amazon S3.
The Protocols parameter is an array of strings.
Allowed values : One or more of SFTP , FTPS , FTP , AS2
201 202 203 |
# File 'transfer/cfn_server_props.rb', line 201 def protocols @protocols end |
#s3_storage_options ⇒ AWSCDK::IResolvable, ... (readonly)
Specifies whether or not performance for your Amazon S3 directories is optimized.
- If using the console, this is enabled by default.
- If using the API or CLI, this is disabled by default.
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.
211 212 213 |
# File 'transfer/cfn_server_props.rb', line 211 def @s3_storage_options end |
#security_policy_name ⇒ String? (readonly)
Specifies the name of the security policy for the server.
216 217 218 |
# File 'transfer/cfn_server_props.rb', line 216 def security_policy_name @security_policy_name end |
#structured_log_destinations ⇒ Array<String>? (readonly)
Specifies the log groups to which your server logs are sent.
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
231 232 233 |
# File 'transfer/cfn_server_props.rb', line 231 def structured_log_destinations @structured_log_destinations end |
#tags ⇒ Array<AWSCDK::CfnTag>? (readonly)
Key-value pairs that can be used to group and search for servers.
236 237 238 |
# File 'transfer/cfn_server_props.rb', line 236 def @tags end |
#workflow_details ⇒ AWSCDK::IResolvable, ... (readonly)
Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow.
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.
243 244 245 |
# File 'transfer/cfn_server_props.rb', line 243 def workflow_details @workflow_details end |
Class Method Details
.jsii_properties ⇒ Object
245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 |
# File 'transfer/cfn_server_props.rb', line 245 def self.jsii_properties { :certificate => "certificate", :domain => "domain", :endpoint_details => "endpointDetails", :endpoint_type => "endpointType", :identity_provider_details => "identityProviderDetails", :identity_provider_type => "identityProviderType", :ip_address_type => "ipAddressType", :logging_role => "loggingRole", :post_authentication_login_banner => "postAuthenticationLoginBanner", :pre_authentication_login_banner => "preAuthenticationLoginBanner", :protocol_details => "protocolDetails", :protocols => "protocols", :s3_storage_options => "s3StorageOptions", :security_policy_name => "securityPolicyName", :structured_log_destinations => "structuredLogDestinations", :tags => "tags", :workflow_details => "workflowDetails", } end |
Instance Method Details
#to_jsii ⇒ Object
267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 |
# File 'transfer/cfn_server_props.rb', line 267 def to_jsii result = {} result.merge!({ "certificate" => @certificate, "domain" => @domain, "endpointDetails" => @endpoint_details, "endpointType" => @endpoint_type, "identityProviderDetails" => @identity_provider_details, "identityProviderType" => @identity_provider_type, "ipAddressType" => @ip_address_type, "loggingRole" => @logging_role, "postAuthenticationLoginBanner" => @post_authentication_login_banner, "preAuthenticationLoginBanner" => @pre_authentication_login_banner, "protocolDetails" => @protocol_details, "protocols" => @protocols, "s3StorageOptions" => @s3_storage_options, "securityPolicyName" => @security_policy_name, "structuredLogDestinations" => @structured_log_destinations, "tags" => @tags, "workflowDetails" => @workflow_details, }) result.compact end |