Class CfnConnector
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.CfnConnector
- All Implemented Interfaces:
IInspectable
,ITaggable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)",
date="2024-07-12T19:34:10.735Z")
@Stability(Stable)
public class CfnConnector
extends CfnResource
implements IInspectable, ITaggable
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
).
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.*; Object as2Config; CfnConnector cfnConnector = CfnConnector.Builder.create(this, "MyCfnConnector") .accessRole("accessRole") .url("url") // the properties below are optional .as2Config(as2Config) .loggingRole("loggingRole") .securityPolicyName("securityPolicyName") .sftpConfig(SftpConfigProperty.builder() .trustedHostKeys(List.of("trustedHostKeys")) .userSecretId("userSecretId") .build()) .tags(List.of(CfnTag.builder() .key("key") .value("value") .build())) .build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic interface
A structure that contains the parameters for an AS2 connector object.static final class
A fluent builder forCfnConnector
.static interface
A structure that contains the parameters for an SFTP connector object.Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggable
ITaggable.Jsii$Default, ITaggable.Jsii$Proxy
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
CfnConnector
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnConnector
(software.amazon.jsii.JsiiObjectRef objRef) CfnConnector
(software.constructs.Construct scope, String id, CfnConnectorProps props) -
Method Summary
Modifier and TypeMethodDescriptionConnectors are used to send files using either the AS2 or SFTP protocol.A structure that contains the parameters for an AS2 connector object.Specifies the unique Amazon Resource Name (ARN) for the connector.The service-assigned ID of the connector that is created.The list of egress IP addresses of this connector.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.The text name of the security policy for the specified connector.A structure that contains the parameters for an SFTP connector object.getTags()
Tag Manager which manages the tags for this resource.Key-value pairs that can be used to group and search for connectors.getUrl()
The URL of the partner's AS2 or SFTP endpoint.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
setAccessRole
(String value) Connectors are used to send files using either the AS2 or SFTP protocol.void
setAs2Config
(Object value) A structure that contains the parameters for an AS2 connector object.void
setLoggingRole
(String value) 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.void
setSecurityPolicyName
(String value) The text name of the security policy for the specified connector.void
setSftpConfig
(IResolvable value) A structure that contains the parameters for an SFTP connector object.void
A structure that contains the parameters for an SFTP connector object.void
setTagsRaw
(List<CfnTag> value) Key-value pairs that can be used to group and search for connectors.void
The URL of the partner's AS2 or SFTP endpoint.Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, 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 Details
-
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
-
-
Constructor Details
-
CfnConnector
protected CfnConnector(software.amazon.jsii.JsiiObjectRef objRef) -
CfnConnector
protected CfnConnector(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnConnector
@Stability(Stable) public CfnConnector(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnConnectorProps props) - Parameters:
scope
- Scope in which this resource is defined. This parameter is required.id
- Construct identifier for this resource (unique in its scope). This parameter is required.props
- Resource properties. This parameter is required.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- Parameters:
inspector
- tree inspector to collect and process attributes. This parameter is required.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderProperties
in classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrArn
Specifies the unique Amazon Resource Name (ARN) for the connector. -
getAttrConnectorId
The service-assigned ID of the connector that is created. -
getAttrServiceManagedEgressIpAddresses
The list of egress IP addresses of this connector.These IP addresses are assigned automatically when you create the connector.
-
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getTags
Tag Manager which manages the tags for this resource. -
getAccessRole
Connectors are used to send files using either the AS2 or SFTP protocol. -
setAccessRole
Connectors are used to send files using either the AS2 or SFTP protocol. -
getUrl
The URL of the partner's AS2 or SFTP endpoint. -
setUrl
The URL of the partner's AS2 or SFTP endpoint. -
getAs2Config
A structure that contains the parameters for an AS2 connector object. -
setAs2Config
A structure that contains the parameters for an AS2 connector object. -
getLoggingRole
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. -
setLoggingRole
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. -
getSecurityPolicyName
The text name of the security policy for the specified connector. -
setSecurityPolicyName
The text name of the security policy for the specified connector. -
getSftpConfig
A structure that contains the parameters for an SFTP connector object. -
setSftpConfig
A structure that contains the parameters for an SFTP connector object. -
setSftpConfig
A structure that contains the parameters for an SFTP connector object. -
getTagsRaw
Key-value pairs that can be used to group and search for connectors. -
setTagsRaw
Key-value pairs that can be used to group and search for connectors.
-