class CfnServerPropsMixin

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.Transfer.Mixins.CfnServerPropsMixin
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awstransfer/mixins#CfnServerPropsMixin
Java	software.amazon.awscdk.mixins.preview.services.transfer.mixins.CfnServerPropsMixin
Python	aws_cdk.mixins_preview.aws_transfer.mixins.CfnServerPropsMixin
TypeScript	@aws-cdk/mixins-preview » aws_transfer » mixins » CfnServerPropsMixin

Implements IMixin

Extends Mixin

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-server.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins } from '@aws-cdk/mixins-preview';
import { mixins as transfer_mixins } from '@aws-cdk/mixins-preview/aws-transfer';
const cfnServerPropsMixin = new transfer_mixins.CfnServerPropsMixin({
  certificate: 'certificate',
  domain: 'domain',
  endpointDetails: {
    addressAllocationIds: ['addressAllocationIds'],
    securityGroupIds: ['securityGroupIds'],
    subnetIds: ['subnetIds'],
    vpcEndpointId: 'vpcEndpointId',
    vpcId: 'vpcId',
  },
  endpointType: 'endpointType',
  identityProviderDetails: {
    directoryId: 'directoryId',
    function: 'function',
    invocationRole: 'invocationRole',
    sftpAuthenticationMethods: 'sftpAuthenticationMethods',
    url: 'url',
  },
  identityProviderType: 'identityProviderType',
  ipAddressType: 'ipAddressType',
  loggingRole: 'loggingRole',
  postAuthenticationLoginBanner: 'postAuthenticationLoginBanner',
  preAuthenticationLoginBanner: 'preAuthenticationLoginBanner',
  protocolDetails: {
    as2Transports: ['as2Transports'],
    passiveIp: 'passiveIp',
    setStatOption: 'setStatOption',
    tlsSessionResumptionMode: 'tlsSessionResumptionMode',
  },
  protocols: ['protocols'],
  s3StorageOptions: {
    directoryListingOptimization: 'directoryListingOptimization',
  },
  securityPolicyName: 'securityPolicyName',
  structuredLogDestinations: ['structuredLogDestinations'],
  tags: [{
    key: 'key',
    value: 'value',
  }],
  workflowDetails: {
    onPartialUpload: [{
      executionRole: 'executionRole',
      workflowId: 'workflowId',
    }],
    onUpload: [{
      executionRole: 'executionRole',
      workflowId: 'workflowId',
    }],
  },
}, /* all optional props */ {
  strategy: mixins.PropertyMergeStrategy.OVERRIDE,
});

Initializer

new CfnServerPropsMixin(props: CfnServerMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnServerMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

Create a mixin to apply properties to AWS::Transfer::Server.

Properties

Name	Type	Description
props	CfnServerMixinProps
strategy	PropertyMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnServerMixinProps

---

strategy

Type: PropertyMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	Apply the mixin properties to the construct.
supports(construct)	Check if this mixin supports the given construct.

---

applyTo(construct)

public applyTo(construct: IConstruct): void

Parameters

• construct IConstruct

Apply the mixin properties to the construct.

---

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

• construct IConstruct

Returns

• boolean

Check if this mixin supports the given construct.