@Generated(value="jsii-pacmak/1.50.0 (build d1830a4)", date="2022-01-04T15:39:15.968Z") @Stability(value=Stable) 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")
.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();
| 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 used for executing the workflow.
|
static interface |
CfnServer.WorkflowDetailsProperty
Container for the `WorkflowDetail` data type.
|
software.amazon.jsii.JsiiObject.InitializationModeIInspectable.Jsii$Default, IInspectable.Jsii$ProxyIConstruct.Jsii$Default| Modifier and Type | Field and Description |
|---|---|
static String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
| Modifier | Constructor and Description |
|---|---|
|
CfnServer(Construct scope,
String id)
Create a new `AWS::Transfer::Server`.
|
|
CfnServer(Construct scope,
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 |
|---|---|
String |
getAttrArn()
The Amazon Resource Name associated with the server, in the form `arn:aws:transfer:region: *account-id* :server/ *server-id* /` .
|
String |
getAttrServerId()
The service-assigned ID of the server that is created.
|
String |
getCertificate()
The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM) certificate.
|
protected Map<String,Object> |
getCfnProperties() |
String |
getDomain()
Specifies the domain of the storage system that is used for file transfers.
|
Object |
getEndpointDetails()
The virtual private cloud (VPC) endpoint settings that are configured for your server.
|
String |
getEndpointType()
The type of VPC endpoint that you want your server to connect to.
|
Object |
getIdentityProviderDetails()
Required when `IdentityProviderType` is set to `AWS_DIRECTORY_SERVICE` or `API_GATEWAY` .
|
String |
getIdentityProviderType()
Specifies the mode of authentication for a server.
|
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.
|
Object |
getProtocolDetails()
Protocol settings that are configured for your server.
|
List<String> |
getProtocols()
Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint.
|
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.
|
Object |
getWorkflowDetails()
Specifies the workflow ID for the workflow to assign and the execution role used for executing the workflow.
|
void |
inspect(TreeInspector inspector)
Examines the CloudFormation resource and discloses attributes.
|
protected Map<String,Object> |
renderProperties(Map<String,Object> props) |
void |
setCertificate(String value)
The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM) certificate.
|
void |
setDomain(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(String value)
The type of VPC endpoint that you want your server to connect to.
|
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(String value)
Specifies the mode of authentication for a server.
|
void |
setLoggingRole(String value)
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.
|
void |
setProtocolDetails(CfnServer.ProtocolDetailsProperty value)
Protocol settings that are configured for your server.
|
void |
setProtocolDetails(IResolvable value)
Protocol settings that are configured for your server.
|
void |
setProtocols(List<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(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 used for executing the workflow.
|
void |
setWorkflowDetails(IResolvable value)
Specifies the workflow ID for the workflow to assign and the execution role used for executing the workflow.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validatePropertiesgetRefgetCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalIdgetNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validatejsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet@Stability(value=Stable) public static final String CFN_RESOURCE_TYPE_NAME
protected CfnServer(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnServer(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
@Stability(value=Stable)
public CfnServer(@NotNull
Construct scope,
@NotNull
String id,
@Nullable
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.@Stability(value=Stable)
public void inspect(@NotNull
TreeInspector inspector)
inspect in interface IInspectableinspector - - tree inspector to collect and process attributes. This parameter is required.@Stability(value=Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
renderProperties in class CfnResourceprops - This parameter is required.@Stability(value=Stable) @NotNull public String getAttrArn()
An example of a server ARN is: arn:aws:transfer:us-east-1:123456789012:server/s-01234567890abcdef .
@Stability(value=Stable) @NotNull public String getAttrServerId()
An example ServerId is s-01234567890abcdef .
@Stability(value=Stable) @NotNull protected Map<String,Object> getCfnProperties()
getCfnProperties in class CfnResource@Stability(value=Stable) @NotNull public TagManager getTags()
@Stability(value=Stable) @Nullable public 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.
@Stability(value=Stable)
public void setCertificate(@Nullable
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.
@Stability(value=Stable) @Nullable public String getDomain()
@Stability(value=Stable)
public void setDomain(@Nullable
String value)
@Stability(value=Stable) @Nullable public Object getEndpointDetails()
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.
@Stability(value=Stable)
public void setEndpointDetails(@Nullable
CfnServer.EndpointDetailsProperty value)
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.
@Stability(value=Stable)
public void setEndpointDetails(@Nullable
IResolvable value)
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.
@Stability(value=Stable) @Nullable public String getEndpointType()
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
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.
@Stability(value=Stable)
public void setEndpointType(@Nullable
String value)
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
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.
@Stability(value=Stable) @Nullable public 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 .
@Stability(value=Stable)
public void setIdentityProviderDetails(@Nullable
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 .
@Stability(value=Stable)
public void setIdentityProviderDetails(@Nullable
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 .
@Stability(value=Stable) @Nullable public 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 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.
@Stability(value=Stable)
public void setIdentityProviderType(@Nullable
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 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.
@Stability(value=Stable) @Nullable public String getLoggingRole()
When set, user activity can be viewed in your CloudWatch logs.
@Stability(value=Stable)
public void setLoggingRole(@Nullable
String value)
When set, user activity can be viewed in your CloudWatch logs.
@Stability(value=Stable) @Nullable public Object getProtocolDetails()
Only valid in the
UpdateServerAPI.
@Stability(value=Stable)
public void setProtocolDetails(@Nullable
CfnServer.ProtocolDetailsProperty value)
Only valid in the
UpdateServerAPI.
@Stability(value=Stable)
public void setProtocolDetails(@Nullable
IResolvable value)
Only valid in the
UpdateServerAPI.
@Stability(value=Stable) @Nullable public List<String> getProtocols()
@Stability(value=Stable)
public void setProtocols(@Nullable
List<String> value)
@Stability(value=Stable) @Nullable public String getSecurityPolicyName()
@Stability(value=Stable)
public void setSecurityPolicyName(@Nullable
String value)
@Stability(value=Stable) @Nullable public Object getWorkflowDetails()
@Stability(value=Stable)
public void setWorkflowDetails(@Nullable
CfnServer.WorkflowDetailsProperty value)
@Stability(value=Stable)
public void setWorkflowDetails(@Nullable
IResolvable value)
Copyright © 2022. All rights reserved.