class CfnConnectorPropsMixin

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

Implements IMixin

Extends Mixin

Creates the connector, which captures the parameters for a connection for the AS2 or SFTP protocol.

For AS2, the connector is required for sending files to an externally hosted AS2 server. For SFTP, the connector is required when sending files to an SFTP server or receiving files from an SFTP server. For more details about connectors, see Configure AS2 connectors and Create SFTP connectors .

You must specify exactly one configuration object: either for AS2 ( As2Config ) or SFTP ( SftpConfig ).

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-connector.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';

declare const as2Config: any;
const cfnConnectorPropsMixin = new transfer_mixins.CfnConnectorPropsMixin({
  accessRole: 'accessRole',
  as2Config: as2Config,
  egressConfig: {
    vpcLattice: {
      portNumber: 123,
      resourceConfigurationArn: 'resourceConfigurationArn',
    },
  },
  egressType: 'egressType',
  loggingRole: 'loggingRole',
  securityPolicyName: 'securityPolicyName',
  sftpConfig: {
    maxConcurrentConnections: 123,
    trustedHostKeys: ['trustedHostKeys'],
    userSecretId: 'userSecretId',
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
  url: 'url',
}, /* all optional props */ {
  strategy: mixins.PropertyMergeStrategy.OVERRIDE,
});

Initializer

new CfnConnectorPropsMixin(props: CfnConnectorMixinProps, options?: CfnPropertyMixinOptions)

Parameters

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

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

Properties

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

---

props

Type: CfnConnectorMixinProps

---

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): IConstruct

Parameters

• construct IConstruct

Returns

• 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.