Class CfnConnector
Creates the connector, which captures the parameters for a connection for the AS2 or SFTP protocol.
Inherited Members
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 ( As2Config
) or SFTP ( SftpConfig
).
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 {
TrustedHostKeys = new [] { "trustedHostKeys" },
UserSecretId = "userSecretId"
},
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnConnector(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnConnector(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnConnector(Construct, String, ICfnConnectorProps) |
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 | |
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>) |
Constructors
CfnConnector(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnConnector(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnConnector(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnConnector(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnConnector(Construct, String, ICfnConnectorProps)
public CfnConnector(Construct scope, string id, ICfnConnectorProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnConnectorProps
Resource properties.
Properties
AccessRole
Connectors are used to send files using either the AS2 or SFTP protocol.
public virtual string AccessRole { get; set; }
Property Value
System.String
As2Config
A structure that contains the parameters for an AS2 connector object.
public virtual object As2Config { get; set; }
Property Value
System.Object
AttrArn
Specifies the unique Amazon Resource Name (ARN) for the connector.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Arn
AttrConnectorId
The service-assigned ID of the connector that is created.
public virtual string AttrConnectorId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: ConnectorId
AttrServiceManagedEgressIpAddresses
The list of egress IP addresses of this connector.
public virtual string[] AttrServiceManagedEgressIpAddresses { get; }
Property Value
System.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
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
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
System.String
SecurityPolicyName
The text name of the security policy for the specified connector.
public virtual string SecurityPolicyName { get; set; }
Property Value
System.String
SftpConfig
A structure that contains the parameters for an SFTP connector object.
public virtual object SftpConfig { get; set; }
Property Value
System.Object
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
TagsRaw
Key-value pairs that can be used to group and search for connectors.
public virtual ICfnTag[] TagsRaw { get; set; }
Property Value
ICfnTag[]
Url
The URL of the partner's AS2 or SFTP endpoint.
public virtual string Url { get; set; }
Property Value
System.String
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.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>