CfnServerProps (software.amazon.awscdk:monocdk 1.138.0.DEVPREVIEW API)

All Superinterfaces:: software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:: CfnServerProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.50.0 (build d1830a4)",
           date="2022-01-04T15:39:15.976Z")
 @Stability(value=Stable)
public interface CfnServerProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `CfnServer`.

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.*;
 CfnServerProps cfnServerProps = CfnServerProps.builder()
         .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")
         .protocolDetails(ProtocolDetailsProperty.builder()
                 .passiveIp("passiveIp")
                 .build())
         .protocols(List.of("protocols"))
         .securityPolicyName("securityPolicyName")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .workflowDetails(WorkflowDetailsProperty.builder()
                 .onUpload(List.of(WorkflowDetailProperty.builder()
                         .executionRole("executionRole")
                         .workflowId("workflowId")
                         .build()))
                 .build())
         .build();

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`CfnServerProps.Builder` A builder for `CfnServerProps`
`static class`	`CfnServerProps.Jsii$Proxy` An implementation for `CfnServerProps`

Method Summary

All Methods Static Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`static CfnServerProps.Builder`	`builder()`
`default String`	`getCertificate()` The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM) certificate.
`default String`	`getDomain()` Specifies the domain of the storage system that is used for file transfers.
`default Object`	`getEndpointDetails()` The virtual private cloud (VPC) endpoint settings that are configured for your server.
`default String`	`getEndpointType()` The type of VPC endpoint that you want your server to connect to.
`default Object`	`getIdentityProviderDetails()` Required when `IdentityProviderType` is set to `AWS_DIRECTORY_SERVICE` or `API_GATEWAY` .
`default String`	`getIdentityProviderType()` Specifies the mode of authentication for a server.
`default String`	`getLoggingRole()` 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.
`default Object`	`getProtocolDetails()` Protocol settings that are configured for your server.
`default List<String>`	`getProtocols()` Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint.
`default String`	`getSecurityPolicyName()` Specifies the name of the security policy that is attached to the server.
`default List<CfnTag>`	`getTags()` Key-value pairs that can be used to group and search for servers.
`default Object`	`getWorkflowDetails()` Specifies the workflow ID for the workflow to assign and the execution role used for executing the workflow.

Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson

- Method Detail
  - getCertificate
```
@Stability(value=Stable)
 @Nullable
default String getCertificate()
```
    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.
  - getDomain
```
@Stability(value=Stable)
 @Nullable
default String getDomain()
```
    Specifies the domain of the storage system that is used for file transfers.
  - getEndpointDetails
```
@Stability(value=Stable)
 @Nullable
default Object getEndpointDetails()
```
    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 IPs and make it accessible to clients over the internet. You VPC's default security groups are automatically assigned to your endpoint.
  - getEndpointType
```
@Stability(value=Stable)
 @Nullable
default String getEndpointType()
```
    The type of VPC endpoint that you want your server to connect to.
    You can choose to connect to the public internet or a virtual private cloud (VPC) endpoint. With a VPC endpoint, you can restrict access to your server and resources only within your VPC.
    
    It is recommended that you use VPC as the EndpointType . 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 with EndpointType set to VPC_ENDPOINT .
  - getIdentityProviderDetails
```
@Stability(value=Stable)
 @Nullable
default Object getIdentityProviderDetails()
```
    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 .
  - getIdentityProviderType
```
@Stability(value=Stable)
 @Nullable
default String getIdentityProviderType()
```
    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.
  - getLoggingRole
```
@Stability(value=Stable)
 @Nullable
default String getLoggingRole()
```
    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.
  - getProtocolDetails
```
@Stability(value=Stable)
 @Nullable
default Object getProtocolDetails()
```
    Protocol settings that are configured for your server.
    
    Only valid in the UpdateServer API.
  - getProtocols
```
@Stability(value=Stable)
 @Nullable
default List<String> getProtocols()
```
    Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint.
  - getSecurityPolicyName
```
@Stability(value=Stable)
 @Nullable
default String getSecurityPolicyName()
```
    Specifies the name of the security policy that is attached to the server.
  - getTags
```
@Stability(value=Stable)
 @Nullable
default List<CfnTag> getTags()
```
    Key-value pairs that can be used to group and search for servers.
  - getWorkflowDetails
```
@Stability(value=Stable)
 @Nullable
default Object getWorkflowDetails()
```
    Specifies the workflow ID for the workflow to assign and the execution role used for executing the workflow.
  - builder
```
@Stability(value=Stable)
static CfnServerProps.Builder builder()
```
    Returns:
    
    a CfnServerProps.Builder of CfnServerProps

Interface CfnServerProps

Nested Class Summary

Method Summary

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Method Detail

getCertificate

getDomain

getEndpointDetails

getEndpointType

getIdentityProviderDetails

getIdentityProviderType

getLoggingRole

getProtocolDetails

getProtocols

getSecurityPolicyName

getTags

getWorkflowDetails

builder