software.amazon.awscdk.services.transfer

Class CfnServer

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.transfer.CfnServer

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.46.0 (build cd08c55)",
           date="2021-11-25T20:11:08.193Z")
 @Stability(value=Stable)
public class CfnServer
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Transfer::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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnServer.Builder A fluent builder for CfnServer.
static interface	CfnServer.EndpointDetailsProperty Example:
static interface	CfnServer.IdentityProviderDetailsProperty Example:
static interface	CfnServer.ProtocolDetailsProperty Example:
static interface	CfnServer.WorkflowDetailProperty Example:
static interface	CfnServer.WorkflowDetailsProperty Example:

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnServer(software.constructs.Construct scope, String id) Create a new `AWS::Transfer::Server`.
	CfnServer(software.constructs.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)

Method Summary

Modifier and Type	Method and Description
String	getAttrArn()
String	getAttrServerId()
String	getCertificate() `AWS::Transfer::Server.Certificate`.
protected Map<String,Object>	getCfnProperties()
String	getDomain() `AWS::Transfer::Server.Domain`.
Object	getEndpointDetails() `AWS::Transfer::Server.EndpointDetails`.
String	getEndpointType() `AWS::Transfer::Server.EndpointType`.
Object	getIdentityProviderDetails() `AWS::Transfer::Server.IdentityProviderDetails`.
String	getIdentityProviderType() `AWS::Transfer::Server.IdentityProviderType`.
String	getLoggingRole() `AWS::Transfer::Server.LoggingRole`.
Object	getProtocolDetails() `AWS::Transfer::Server.ProtocolDetails`.
List<String>	getProtocols() `AWS::Transfer::Server.Protocols`.
String	getSecurityPolicyName() `AWS::Transfer::Server.SecurityPolicyName`.
TagManager	getTags() `AWS::Transfer::Server.Tags`.
Object	getWorkflowDetails() `AWS::Transfer::Server.WorkflowDetails`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setCertificate(String value) `AWS::Transfer::Server.Certificate`.
void	setDomain(String value) `AWS::Transfer::Server.Domain`.
void	setEndpointDetails(CfnServer.EndpointDetailsProperty value) `AWS::Transfer::Server.EndpointDetails`.
void	setEndpointDetails(IResolvable value) `AWS::Transfer::Server.EndpointDetails`.
void	setEndpointType(String value) `AWS::Transfer::Server.EndpointType`.
void	setIdentityProviderDetails(CfnServer.IdentityProviderDetailsProperty value) `AWS::Transfer::Server.IdentityProviderDetails`.
void	setIdentityProviderDetails(IResolvable value) `AWS::Transfer::Server.IdentityProviderDetails`.
void	setIdentityProviderType(String value) `AWS::Transfer::Server.IdentityProviderType`.
void	setLoggingRole(String value) `AWS::Transfer::Server.LoggingRole`.
void	setProtocolDetails(CfnServer.ProtocolDetailsProperty value) `AWS::Transfer::Server.ProtocolDetails`.
void	setProtocolDetails(IResolvable value) `AWS::Transfer::Server.ProtocolDetails`.
void	setProtocols(List<String> value) `AWS::Transfer::Server.Protocols`.
void	setSecurityPolicyName(String value) `AWS::Transfer::Server.SecurityPolicyName`.
void	setWorkflowDetails(CfnServer.WorkflowDetailsProperty value) `AWS::Transfer::Server.WorkflowDetails`.
void	setWorkflowDetails(IResolvable value) `AWS::Transfer::Server.WorkflowDetails`.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnServer

protected CfnServer(software.amazon.jsii.JsiiObjectRef objRef)

CfnServer

protected CfnServer(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnServer

@Stability(value=Stable)
public CfnServer(@NotNull
                                          software.constructs.Construct scope,
                                          @NotNull
                                          String id,
                                          @Nullable
                                          CfnServerProps props)

Create a new `AWS::Transfer::Server`.

Parameters:

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.

CfnServer

@Stability(value=Stable)
public CfnServer(@NotNull
                                          software.constructs.Construct scope,
                                          @NotNull
                                          String id)

Create a new `AWS::Transfer::Server`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(value=Stable)
 @NotNull
public String getAttrArn()

getAttrServerId

@Stability(value=Stable)
 @NotNull
public String getAttrServerId()

getCertificate

@Stability(value=Stable)
 @Nullable
public String getCertificate()

`AWS::Transfer::Server.Certificate`.

setCertificate

@Stability(value=Stable)
public void setCertificate(@Nullable
                                                    String value)

`AWS::Transfer::Server.Certificate`.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getDomain

@Stability(value=Stable)
 @Nullable
public String getDomain()

`AWS::Transfer::Server.Domain`.

setDomain

@Stability(value=Stable)
public void setDomain(@Nullable
                                               String value)

`AWS::Transfer::Server.Domain`.

getEndpointDetails

@Stability(value=Stable)
 @Nullable
public Object getEndpointDetails()

`AWS::Transfer::Server.EndpointDetails`.

setEndpointDetails

@Stability(value=Stable)
public void setEndpointDetails(@Nullable
                                                        CfnServer.EndpointDetailsProperty value)

`AWS::Transfer::Server.EndpointDetails`.

setEndpointDetails

@Stability(value=Stable)
public void setEndpointDetails(@Nullable
                                                        IResolvable value)

`AWS::Transfer::Server.EndpointDetails`.

getEndpointType

@Stability(value=Stable)
 @Nullable
public String getEndpointType()

`AWS::Transfer::Server.EndpointType`.

setEndpointType

@Stability(value=Stable)
public void setEndpointType(@Nullable
                                                     String value)

`AWS::Transfer::Server.EndpointType`.

getIdentityProviderDetails

@Stability(value=Stable)
 @Nullable
public Object getIdentityProviderDetails()

`AWS::Transfer::Server.IdentityProviderDetails`.

setIdentityProviderDetails

@Stability(value=Stable)
public void setIdentityProviderDetails(@Nullable
                                                                CfnServer.IdentityProviderDetailsProperty value)

`AWS::Transfer::Server.IdentityProviderDetails`.

setIdentityProviderDetails

@Stability(value=Stable)
public void setIdentityProviderDetails(@Nullable
                                                                IResolvable value)

`AWS::Transfer::Server.IdentityProviderDetails`.

getIdentityProviderType

@Stability(value=Stable)
 @Nullable
public String getIdentityProviderType()

`AWS::Transfer::Server.IdentityProviderType`.

setIdentityProviderType

@Stability(value=Stable)
public void setIdentityProviderType(@Nullable
                                                             String value)

`AWS::Transfer::Server.IdentityProviderType`.

getLoggingRole

@Stability(value=Stable)
 @Nullable
public String getLoggingRole()

`AWS::Transfer::Server.LoggingRole`.

setLoggingRole

@Stability(value=Stable)
public void setLoggingRole(@Nullable
                                                    String value)

`AWS::Transfer::Server.LoggingRole`.

getProtocolDetails

@Stability(value=Stable)
 @Nullable
public Object getProtocolDetails()

`AWS::Transfer::Server.ProtocolDetails`.

setProtocolDetails

@Stability(value=Stable)
public void setProtocolDetails(@Nullable
                                                        CfnServer.ProtocolDetailsProperty value)

`AWS::Transfer::Server.ProtocolDetails`.

setProtocolDetails

@Stability(value=Stable)
public void setProtocolDetails(@Nullable
                                                        IResolvable value)

`AWS::Transfer::Server.ProtocolDetails`.

getProtocols

@Stability(value=Stable)
 @Nullable
public List<String> getProtocols()

`AWS::Transfer::Server.Protocols`.

setProtocols

@Stability(value=Stable)
public void setProtocols(@Nullable
                                                  List<String> value)

`AWS::Transfer::Server.Protocols`.

getSecurityPolicyName

@Stability(value=Stable)
 @Nullable
public String getSecurityPolicyName()

`AWS::Transfer::Server.SecurityPolicyName`.

setSecurityPolicyName

@Stability(value=Stable)
public void setSecurityPolicyName(@Nullable
                                                           String value)

`AWS::Transfer::Server.SecurityPolicyName`.

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

`AWS::Transfer::Server.Tags`.

getWorkflowDetails

@Stability(value=Stable)
 @Nullable
public Object getWorkflowDetails()

`AWS::Transfer::Server.WorkflowDetails`.

setWorkflowDetails

@Stability(value=Stable)
public void setWorkflowDetails(@Nullable
                                                        CfnServer.WorkflowDetailsProperty value)

`AWS::Transfer::Server.WorkflowDetails`.

setWorkflowDetails

@Stability(value=Stable)
public void setWorkflowDetails(@Nullable
                                                        IResolvable value)

`AWS::Transfer::Server.WorkflowDetails`.