@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-22T19:35:40.271Z") public class CfnServer extends CfnResource implements IInspectable
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.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.transfer.*; CfnServer cfnServer = CfnServer.Builder.create(this, "MyCfnServer") .certificate("certificate") .domain("domain") .endpointDetails(EndpointDetailsProperty.builder() .addressAllocationIds(List.of("addressAllocationIds")) .securityGroupIds(List.of("securityGroupIds")) .subnetIds(List.of("subnetIds")) .vpcEndpointId("vpcEndpointId") .vpcId("vpcId") .build()) .endpointType("endpointType") .identityProviderDetails(IdentityProviderDetailsProperty.builder() .directoryId("directoryId") .function("function") .invocationRole("invocationRole") .url("url") .build()) .identityProviderType("identityProviderType") .loggingRole("loggingRole") .postAuthenticationLoginBanner("postAuthenticationLoginBanner") .preAuthenticationLoginBanner("preAuthenticationLoginBanner") .protocolDetails(ProtocolDetailsProperty.builder() .as2Transports(List.of("as2Transports")) .passiveIp("passiveIp") .setStatOption("setStatOption") .tlsSessionResumptionMode("tlsSessionResumptionMode") .build()) .protocols(List.of("protocols")) .securityPolicyName("securityPolicyName") .tags(List.of(CfnTag.builder() .key("key") .value("value") .build())) .workflowDetails(WorkflowDetailsProperty.builder() .onPartialUpload(List.of(WorkflowDetailProperty.builder() .executionRole("executionRole") .workflowId("workflowId") .build())) .onUpload(List.of(WorkflowDetailProperty.builder() .executionRole("executionRole") .workflowId("workflowId") .build())) .build()) .build();
Modifier and Type | Class and Description |
---|---|
static class |
CfnServer.Builder
A fluent builder for
CfnServer . |
static interface |
CfnServer.EndpointDetailsProperty
The virtual private cloud (VPC) endpoint settings that are configured for your server.
|
static interface |
CfnServer.IdentityProviderDetailsProperty
Required when `IdentityProviderType` is set to `AWS_DIRECTORY_SERVICE` or `API_GATEWAY` .
|
static interface |
CfnServer.ProtocolDetailsProperty
Protocol settings that are configured for your server.
|
static interface |
CfnServer.WorkflowDetailProperty
Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow.
|
static interface |
CfnServer.WorkflowDetailsProperty
Container for the `WorkflowDetail` data type.
|
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
Modifier | Constructor and Description |
---|---|
|
CfnServer(Construct scope,
java.lang.String id)
Create a new `AWS::Transfer::Server`.
|
|
CfnServer(Construct scope,
java.lang.String id,
CfnServerProps props)
Create a new `AWS::Transfer::Server`.
|
protected |
CfnServer(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
CfnServer(software.amazon.jsii.JsiiObjectRef objRef) |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getAttrArn()
The Amazon Resource Name associated with the server, in the form `arn:aws:transfer:region: *account-id* :server/ *server-id* /` .
|
java.lang.String |
getAttrServerId()
The service-assigned ID of the server that is created.
|
java.lang.String |
getCertificate()
The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM) certificate.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.lang.String |
getDomain()
Specifies the domain of the storage system that is used for file transfers.
|
java.lang.Object |
getEndpointDetails()
The virtual private cloud (VPC) endpoint settings that are configured for your server.
|
java.lang.String |
getEndpointType()
The type of endpoint that you want your server to use.
|
java.lang.Object |
getIdentityProviderDetails()
Required when `IdentityProviderType` is set to `AWS_DIRECTORY_SERVICE` or `API_GATEWAY` .
|
java.lang.String |
getIdentityProviderType()
The mode of authentication for a server.
|
java.lang.String |
getLoggingRole()
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.
|
java.lang.String |
getPostAuthenticationLoginBanner()
Specifies a string to display when users connect to a server.
|
java.lang.String |
getPreAuthenticationLoginBanner()
Specifies a string to display when users connect to a server.
|
java.lang.Object |
getProtocolDetails()
The protocol settings that are configured for your server.
|
java.util.List<java.lang.String> |
getProtocols()
Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint.
|
java.lang.String |
getSecurityPolicyName()
Specifies the name of the security policy that is attached to the server.
|
TagManager |
getTags()
Key-value pairs that can be used to group and search for servers.
|
java.lang.Object |
getWorkflowDetails()
Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow.
|
void |
inspect(TreeInspector inspector)
Examines the CloudFormation resource and discloses attributes.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
renderProperties(java.util.Map<java.lang.String,java.lang.Object> props) |
void |
setCertificate(java.lang.String value)
The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM) certificate.
|
void |
setDomain(java.lang.String value)
Specifies the domain of the storage system that is used for file transfers.
|
void |
setEndpointDetails(CfnServer.EndpointDetailsProperty value)
The virtual private cloud (VPC) endpoint settings that are configured for your server.
|
void |
setEndpointDetails(IResolvable value)
The virtual private cloud (VPC) endpoint settings that are configured for your server.
|
void |
setEndpointType(java.lang.String value)
The type of endpoint that you want your server to use.
|
void |
setIdentityProviderDetails(CfnServer.IdentityProviderDetailsProperty value)
Required when `IdentityProviderType` is set to `AWS_DIRECTORY_SERVICE` or `API_GATEWAY` .
|
void |
setIdentityProviderDetails(IResolvable value)
Required when `IdentityProviderType` is set to `AWS_DIRECTORY_SERVICE` or `API_GATEWAY` .
|
void |
setIdentityProviderType(java.lang.String value)
The mode of authentication for a server.
|
void |
setLoggingRole(java.lang.String value)
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.
|
void |
setPostAuthenticationLoginBanner(java.lang.String value)
Specifies a string to display when users connect to a server.
|
void |
setPreAuthenticationLoginBanner(java.lang.String value)
Specifies a string to display when users connect to a server.
|
void |
setProtocolDetails(CfnServer.ProtocolDetailsProperty value)
The protocol settings that are configured for your server.
|
void |
setProtocolDetails(IResolvable value)
The protocol settings that are configured for your server.
|
void |
setProtocols(java.util.List<java.lang.String> value)
Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint.
|
void |
setSecurityPolicyName(java.lang.String value)
Specifies the name of the security policy that is attached to the server.
|
void |
setWorkflowDetails(CfnServer.WorkflowDetailsProperty value)
Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow.
|
void |
setWorkflowDetails(IResolvable value)
Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnServer(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnServer(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnServer(Construct scope, java.lang.String id, CfnServerProps props)
scope
- - scope in which this resource is defined. This parameter is required.id
- - scoped id of the resource. This parameter is required.props
- - resource properties.public CfnServer(Construct scope, java.lang.String id)
scope
- - scope in which this resource is defined. This parameter is required.id
- - scoped id of the resource. This parameter is required.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.public java.lang.String getAttrArn()
An example of a server ARN is: arn:aws:transfer:us-east-1:123456789012:server/s-01234567890abcdef
.
public java.lang.String getAttrServerId()
An example ServerId
is s-01234567890abcdef
.
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public TagManager getTags()
public java.lang.String getCertificate()
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.
public void setCertificate(java.lang.String value)
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.
public java.lang.String getDomain()
public void setDomain(java.lang.String value)
public java.lang.Object getEndpointDetails()
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.
public void setEndpointDetails(IResolvable value)
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.
public void setEndpointDetails(CfnServer.EndpointDetailsProperty value)
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.
public java.lang.String getEndpointType()
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.
public void setEndpointType(java.lang.String value)
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.
public java.lang.Object getIdentityProviderDetails()
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
.
public void setIdentityProviderDetails(IResolvable value)
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
.
public void setIdentityProviderDetails(CfnServer.IdentityProviderDetailsProperty value)
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
.
public java.lang.String getIdentityProviderType()
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 or the IdentityProviderDetails
data type.
public void setIdentityProviderType(java.lang.String value)
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 or the IdentityProviderDetails
data type.
public java.lang.String getLoggingRole()
When set, you can view user activity in your CloudWatch logs.
public void setLoggingRole(java.lang.String value)
When set, you can view user activity in your CloudWatch logs.
public java.lang.String getPostAuthenticationLoginBanner()
The SFTP protocol does not support post-authentication display banners.
public void setPostAuthenticationLoginBanner(java.lang.String value)
The SFTP protocol does not support post-authentication display banners.
public java.lang.String getPreAuthenticationLoginBanner()
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.
public void setPreAuthenticationLoginBanner(java.lang.String value)
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.
public java.lang.Object getProtocolDetails()
PassiveIp
parameter. Enter a single dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer.SETSTAT
command on a file that you are uploading to an Amazon S3 bucket, use the SetStatOption
parameter. To have the AWS Transfer Family server ignore the SETSTAT
command and upload files without needing to make any changes to your SFTP client, set the value to ENABLE_NO_OP
. If you set the SetStatOption
parameter to ENABLE_NO_OP
, Transfer Family generates a log entry to Amazon CloudWatch Logs, so that you can determine when the client is making a SETSTAT
call.TlsSessionResumptionMode
parameter.As2Transports
indicates the transport method for the AS2 messages. Currently, only HTTP is supported.public void setProtocolDetails(IResolvable value)
PassiveIp
parameter. Enter a single dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer.SETSTAT
command on a file that you are uploading to an Amazon S3 bucket, use the SetStatOption
parameter. To have the AWS Transfer Family server ignore the SETSTAT
command and upload files without needing to make any changes to your SFTP client, set the value to ENABLE_NO_OP
. If you set the SetStatOption
parameter to ENABLE_NO_OP
, Transfer Family generates a log entry to Amazon CloudWatch Logs, so that you can determine when the client is making a SETSTAT
call.TlsSessionResumptionMode
parameter.As2Transports
indicates the transport method for the AS2 messages. Currently, only HTTP is supported.public void setProtocolDetails(CfnServer.ProtocolDetailsProperty value)
PassiveIp
parameter. Enter a single dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer.SETSTAT
command on a file that you are uploading to an Amazon S3 bucket, use the SetStatOption
parameter. To have the AWS Transfer Family server ignore the SETSTAT
command and upload files without needing to make any changes to your SFTP client, set the value to ENABLE_NO_OP
. If you set the SetStatOption
parameter to ENABLE_NO_OP
, Transfer Family generates a log entry to Amazon CloudWatch Logs, so that you can determine when the client is making a SETSTAT
call.TlsSessionResumptionMode
parameter.As2Transports
indicates the transport method for the AS2 messages. Currently, only HTTP is supported.public java.util.List<java.lang.String> getProtocols()
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 AWS Certificate Manager (ACM) which is used to identify your server when clients connect to it over FTPS.- If
Protocol
includes eitherFTP
orFTPS
, then theEndpointType
must beVPC
and theIdentityProviderType
must be eitherAWS_DIRECTORY_SERVICE
,AWS_LAMBDA
, orAPI_GATEWAY
.- If
Protocol
includesFTP
, thenAddressAllocationIds
cannot be associated.- If
Protocol
is set only toSFTP
, theEndpointType
can be set toPUBLIC
and theIdentityProviderType
can be set any of the supported identity types:SERVICE_MANAGED
,AWS_DIRECTORY_SERVICE
,AWS_LAMBDA
, orAPI_GATEWAY
.- If
Protocol
includesAS2
, then theEndpointType
must beVPC
, and domain must be Amazon S3.
public void setProtocols(java.util.List<java.lang.String> value)
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 AWS Certificate Manager (ACM) which is used to identify your server when clients connect to it over FTPS.- If
Protocol
includes eitherFTP
orFTPS
, then theEndpointType
must beVPC
and theIdentityProviderType
must be eitherAWS_DIRECTORY_SERVICE
,AWS_LAMBDA
, orAPI_GATEWAY
.- If
Protocol
includesFTP
, thenAddressAllocationIds
cannot be associated.- If
Protocol
is set only toSFTP
, theEndpointType
can be set toPUBLIC
and theIdentityProviderType
can be set any of the supported identity types:SERVICE_MANAGED
,AWS_DIRECTORY_SERVICE
,AWS_LAMBDA
, orAPI_GATEWAY
.- If
Protocol
includesAS2
, then theEndpointType
must beVPC
, and domain must be Amazon S3.
public java.lang.String getSecurityPolicyName()
public void setSecurityPolicyName(java.lang.String value)
public java.lang.Object getWorkflowDetails()
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.
public void setWorkflowDetails(IResolvable value)
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.
public void setWorkflowDetails(CfnServer.WorkflowDetailsProperty value)
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.