Class CfnConnector

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

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnConnector

Implements

IInspectable

ITaggable

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.Transfer

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnConnector : CfnResource, IInspectable, ITaggable

Syntax (vb)

Public Class CfnConnector Inherits CfnResource Implements IInspectable, ITaggable

Remarks

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 ( <code>As2Config</code> ) or SFTP ( <code>SftpConfig</code> ).

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

CloudformationResource: AWS::Transfer::Connector

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Transfer;

             var as2Config;

             var cfnConnector = new CfnConnector(this, "MyCfnConnector", new CfnConnectorProps {
                 AccessRole = "accessRole",
                 Url = "url",

                 // the properties below are optional
                 As2Config = as2Config,
                 LoggingRole = "loggingRole",
                 SecurityPolicyName = "securityPolicyName",
                 SftpConfig = new SftpConfigProperty {
                     MaxConcurrentConnections = 123,
                     TrustedHostKeys = new [] { "trustedHostKeys" },
                     UserSecretId = "userSecretId"
                 },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             });

Synopsis

Constructors

CfnConnector(Construct, string, ICfnConnectorProps)

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

Properties

AccessRole	Connectors are used to send files using either the AS2 or SFTP protocol.
As2Config	A structure that contains the parameters for an AS2 connector object.
AttrArn	Specifies the unique Amazon Resource Name (ARN) for the connector.
AttrConnectorId	The service-assigned ID of the connector that is created.
AttrServiceManagedEgressIpAddresses	The list of egress IP addresses of this connector.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CfnProperties	Creates the connector, which captures the parameters for a connection for the AS2 or SFTP protocol.
LoggingRole	The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that allows a connector to turn on CloudWatch logging for Amazon S3 events.
SecurityPolicyName	The text name of the security policy for the specified connector.
SftpConfig	A structure that contains the parameters for an SFTP connector object.
Tags	Tag Manager which manages the tags for this resource.
TagsRaw	Key-value pairs that can be used to group and search for connectors.
Url	The URL of the partner's AS2 or SFTP endpoint.

Methods

Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<string, object>)	Creates the connector, which captures the parameters for a connection for the AS2 or SFTP protocol.

Constructors

CfnConnector(Construct, string, ICfnConnectorProps)

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

public CfnConnector(Construct scope, string id, ICfnConnectorProps props)

Parameters

scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnConnectorProps

Resource properties.

Remarks

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 ( <code>As2Config</code> ) or SFTP ( <code>SftpConfig</code> ).

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

CloudformationResource: AWS::Transfer::Connector

ExampleMetadata: fixture=_generated

Properties

AccessRole

Connectors are used to send files using either the AS2 or SFTP protocol.

public virtual string AccessRole { get; set; }

Property Value

string

Remarks

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 ( <code>As2Config</code> ) or SFTP ( <code>SftpConfig</code> ).

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

CloudformationResource: AWS::Transfer::Connector

ExampleMetadata: fixture=_generated

As2Config

A structure that contains the parameters for an AS2 connector object.

public virtual object? As2Config { get; set; }

Property Value

object

Remarks

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 ( <code>As2Config</code> ) or SFTP ( <code>SftpConfig</code> ).

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

CloudformationResource: AWS::Transfer::Connector

ExampleMetadata: fixture=_generated

AttrArn

Specifies the unique Amazon Resource Name (ARN) for the connector.

public virtual string AttrArn { get; }

Property Value

string

Remarks

CloudformationAttribute: Arn

AttrConnectorId

The service-assigned ID of the connector that is created.

public virtual string AttrConnectorId { get; }

Property Value

string

Remarks

CloudformationAttribute: ConnectorId

AttrServiceManagedEgressIpAddresses

The list of egress IP addresses of this connector.

public virtual string[] AttrServiceManagedEgressIpAddresses { get; }

Property Value

string[]

Remarks

These IP addresses are assigned automatically when you create the connector.

CloudformationAttribute: ServiceManagedEgressIpAddresses

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

Remarks

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 ( <code>As2Config</code> ) or SFTP ( <code>SftpConfig</code> ).

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

CloudformationResource: AWS::Transfer::Connector

ExampleMetadata: fixture=_generated

CfnProperties

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

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

Remarks

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 ( <code>As2Config</code> ) or SFTP ( <code>SftpConfig</code> ).

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

CloudformationResource: AWS::Transfer::Connector

ExampleMetadata: fixture=_generated

LoggingRole

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that allows a connector to turn on CloudWatch logging for Amazon S3 events.

public virtual string? LoggingRole { get; set; }

Property Value

string

Remarks

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 ( <code>As2Config</code> ) or SFTP ( <code>SftpConfig</code> ).

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

CloudformationResource: AWS::Transfer::Connector

ExampleMetadata: fixture=_generated

SecurityPolicyName

The text name of the security policy for the specified connector.

public virtual string? SecurityPolicyName { get; set; }

Property Value

string

Remarks

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 ( <code>As2Config</code> ) or SFTP ( <code>SftpConfig</code> ).

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

CloudformationResource: AWS::Transfer::Connector

ExampleMetadata: fixture=_generated

SftpConfig

A structure that contains the parameters for an SFTP connector object.

public virtual object? SftpConfig { get; set; }

Property Value

object

Remarks

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 ( <code>As2Config</code> ) or SFTP ( <code>SftpConfig</code> ).

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

CloudformationResource: AWS::Transfer::Connector

ExampleMetadata: fixture=_generated

Tags

Tag Manager which manages the tags for this resource.

public virtual TagManager Tags { get; }

Property Value

TagManager

Remarks

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 ( <code>As2Config</code> ) or SFTP ( <code>SftpConfig</code> ).

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

CloudformationResource: AWS::Transfer::Connector

ExampleMetadata: fixture=_generated

TagsRaw

Key-value pairs that can be used to group and search for connectors.

public virtual ICfnTag[]? TagsRaw { get; set; }

Property Value

ICfnTag[]

Remarks

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 ( <code>As2Config</code> ) or SFTP ( <code>SftpConfig</code> ).

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

CloudformationResource: AWS::Transfer::Connector

ExampleMetadata: fixture=_generated

Url

The URL of the partner's AS2 or SFTP endpoint.

public virtual string Url { get; set; }

Property Value

string

Remarks

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 ( <code>As2Config</code> ) or SFTP ( <code>SftpConfig</code> ).

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

CloudformationResource: AWS::Transfer::Connector

ExampleMetadata: fixture=_generated

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)

Parameters

inspector TreeInspector

tree inspector to collect and process attributes.

Remarks

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 ( <code>As2Config</code> ) or SFTP ( <code>SftpConfig</code> ).

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

CloudformationResource: AWS::Transfer::Connector

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

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

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

Remarks

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 ( <code>As2Config</code> ) or SFTP ( <code>SftpConfig</code> ).

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

CloudformationResource: AWS::Transfer::Connector

ExampleMetadata: fixture=_generated

Implements

IInspectable

ITaggable