Class: AWSCDK::Transfer::CfnConnector

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggable, Interfaces::AWSTransfer::IConnectorRef
Defined in:
transfer/cfn_connector.rb

Overview

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:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnConnector

Create a new AWS::Transfer::Connector.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

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

  • props (AWSCDK::Transfer::CfnConnectorProps) —

    Resource properties.



22
23
24
25
26
27
28
 
# File 'transfer/cfn_connector.rb', line 22

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::Transfer::CfnConnectorProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfdHJhbnNmZXIuQ2ZuQ29ubmVjdG9yUHJvcHMifQ==")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.arn_for_connector(resource) ⇒ String

Parameters:

Returns:

  • (String) 


89
90
91
92
 
# File 'transfer/cfn_connector.rb', line 89

def self.arn_for_connector(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c190cmFuc2Zlci5JQ29ubmVjdG9yUmVmIn0=")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_transfer.CfnConnector", "arnForConnector", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


222
223
224
 
# File 'transfer/cfn_connector.rb', line 222

def self.CFN_RESOURCE_TYPE_NAME()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_transfer.CfnConnector", "CFN_RESOURCE_TYPE_NAME")
end

.from_connector_arn(scope, id, arn) ⇒ AWSCDK::Interfaces::AWSTransfer::IConnectorRef

Creates a new IConnectorRef from an ARN.

Parameters:

  • scope (Constructs::Construct)
  • id (String)
  • arn (String)

Returns:



100
101
102
103
104
105
 
# File 'transfer/cfn_connector.rb', line 100

def self.from_connector_arn(scope, id, arn)
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "arn")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_transfer.CfnConnector", "fromConnectorArn", [scope, id, arn])
end

.from_connector_id(scope, id, connector_id) ⇒ AWSCDK::Interfaces::AWSTransfer::IConnectorRef

Creates a new IConnectorRef from a connectorId.

Parameters:

  • scope (Constructs::Construct)
  • id (String)
  • connector_id (String)

Returns:



113
114
115
116
117
118
 
# File 'transfer/cfn_connector.rb', line 113

def self.from_connector_id(scope, id, connector_id)
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(connector_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "connectorId")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_transfer.CfnConnector", "fromConnectorId", [scope, id, connector_id])
end

.is_cfn_connector(x) ⇒ Boolean

Checks whether the given object is a CfnConnector.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


124
125
126
127
 
# File 'transfer/cfn_connector.rb', line 124

def self.is_cfn_connector(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_transfer.CfnConnector", "isCfnConnector", [x])
end

.jsii_overridable_methods ⇒ Object 



30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'transfer/cfn_connector.rb', line 30

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :creation_stack => { kind: :property, name: "creationStack", is_optional: false },
    :logical_id => { kind: :property, name: "logicalId", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :ref => { kind: :property, name: "ref", is_optional: false },
    :cfn_options => { kind: :property, name: "cfnOptions", is_optional: false },
    :cfn_properties => { kind: :property, name: "cfnProperties", is_optional: false },
    :cfn_property_names => { kind: :property, name: "cfnPropertyNames", is_optional: false },
    :cfn_resource_type => { kind: :property, name: "cfnResourceType", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :updated_properites => { kind: :property, name: "updatedProperites", is_optional: false },
    :updated_properties => { kind: :property, name: "updatedProperties", is_optional: false },
    :attr_arn => { kind: :property, name: "attrArn", is_optional: false },
    :attr_connector_id => { kind: :property, name: "attrConnectorId", is_optional: false },
    :attr_error_message => { kind: :property, name: "attrErrorMessage", is_optional: false },
    :attr_service_managed_egress_ip_addresses => { kind: :property, name: "attrServiceManagedEgressIpAddresses", is_optional: false },
    :attr_status => { kind: :property, name: "attrStatus", is_optional: false },
    :connector_ref => { kind: :property, name: "connectorRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :access_role => { kind: :property, name: "accessRole", is_optional: false },
    :as2_config => { kind: :property, name: "as2Config", is_optional: false },
    :egress_config => { kind: :property, name: "egressConfig", is_optional: true },
    :egress_type => { kind: :property, name: "egressType", is_optional: true },
    :ip_address_type => { kind: :property, name: "ipAddressType", is_optional: true },
    :logging_role => { kind: :property, name: "loggingRole", is_optional: true },
    :security_policy_name => { kind: :property, name: "securityPolicyName", is_optional: true },
    :sftp_config => { kind: :property, name: "sftpConfig", is_optional: true },
    :tags_raw => { kind: :property, name: "tagsRaw", is_optional: true },
    :url => { kind: :property, name: "url", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :override_logical_id => { kind: :method, name: "overrideLogicalId", is_optional: false },
    :add_deletion_override => { kind: :method, name: "addDeletionOverride", is_optional: false },
    :add_dependency => { kind: :method, name: "addDependency", is_optional: false },
    :add_depends_on => { kind: :method, name: "addDependsOn", is_optional: false },
    :add_metadata => { kind: :method, name: "addMetadata", is_optional: false },
    :add_override => { kind: :method, name: "addOverride", is_optional: false },
    :add_property_deletion_override => { kind: :method, name: "addPropertyDeletionOverride", is_optional: false },
    :add_property_override => { kind: :method, name: "addPropertyOverride", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :cfn_property_name => { kind: :method, name: "cfnPropertyName", is_optional: false },
    :get_att => { kind: :method, name: "getAtt", is_optional: false },
    :get_metadata => { kind: :method, name: "getMetadata", is_optional: false },
    :obtain_dependencies => { kind: :method, name: "obtainDependencies", is_optional: false },
    :obtain_resource_dependencies => { kind: :method, name: "obtainResourceDependencies", is_optional: false },
    :remove_dependency => { kind: :method, name: "removeDependency", is_optional: false },
    :render_properties => { kind: :method, name: "renderProperties", is_optional: false },
    :replace_dependency => { kind: :method, name: "replaceDependency", is_optional: false },
    :should_synthesize => { kind: :method, name: "shouldSynthesize", is_optional: false },
    :validate_properties => { kind: :method, name: "validateProperties", is_optional: false },
    :inspect => { kind: :method, name: "inspect", is_optional: false },
  }
end

Instance Method Details

#access_role ⇒ String

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

Returns:

  • (String) 


284
285
286
 
# File 'transfer/cfn_connector.rb', line 284

def access_role()
  jsii_get_property("accessRole")
end

#access_role=(value) ⇒ Object 



288
289
290
291
 
# File 'transfer/cfn_connector.rb', line 288

def access_role=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "accessRole")
  jsii_set_property("accessRole", value)
end

#add_deletion_override(path) ⇒ void

This method returns an undefined value.

Syntactic sugar for addOverride(path, undefined).

Parameters:

  • path (String) —

    The path of the value to delete.



440
441
442
443
 
# File 'transfer/cfn_connector.rb', line 440

def add_deletion_override(path)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  jsii_call_method("addDeletionOverride", [path])
end

#add_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:



452
453
454
455
 
# File 'transfer/cfn_connector.rb', line 452

def add_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependency", [target])
end

#add_depends_on(target) ⇒ void

Deprecated.

use addDependency

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:



462
463
464
465
 
# File 'transfer/cfn_connector.rb', line 462

def add_depends_on(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependsOn", [target])
end

#add_metadata(key, value) ⇒ void

This method returns an undefined value.

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (String)
  • value (Object)

See Also:



473
474
475
476
477
 
# File 'transfer/cfn_connector.rb', line 473

def add_metadata(key, value)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addMetadata", [key, value])
end

#add_override(path, value) ⇒ void

This method returns an undefined value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use add_property_override or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

# Example automatically generated from non-compiling source. May contain errors.
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to add_override will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (String) —
    • The path of the property, you can use dot notation to override values in complex types.
  • value (Object) —
    • The value.


530
531
532
533
534
 
# File 'transfer/cfn_connector.rb', line 530

def add_override(path, value)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addOverride", [path, value])
end

#add_property_deletion_override(property_path) ⇒ void

This method returns an undefined value.

Adds an override that deletes the value of a property from the resource definition.

Parameters:

  • property_path (String) —

    The path to the property.



540
541
542
543
 
# File 'transfer/cfn_connector.rb', line 540

def add_property_deletion_override(property_path)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  jsii_call_method("addPropertyDeletionOverride", [property_path])
end

#add_property_override(property_path, value) ⇒ void

This method returns an undefined value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (String) —

    The path of the property.

  • value (Object) —

    The value.



552
553
554
555
556
 
# File 'transfer/cfn_connector.rb', line 552

def add_property_override(property_path, value)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addPropertyOverride", [property_path, value])
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.

Parameters:



565
566
567
568
 
# File 'transfer/cfn_connector.rb', line 565

def apply_cross_stack_reference_strength(strength)
  Jsii::Type.check_type(strength, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZWZlcmVuY2VTdHJlbmd0aCJ9")), "strength")
  jsii_call_method("applyCrossStackReferenceStrength", [strength])
end

#apply_removal_policy(policy = nil, options = nil) ⇒ void

This method returns an undefined value.

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

See Also:



587
588
589
590
591
592
 
# File 'transfer/cfn_connector.rb', line 587

def apply_removal_policy(policy = nil, options = nil)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy") unless policy.nil?
  options = options.is_a?(Hash) ? ::AWSCDK::RemovalPolicyOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5T3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("applyRemovalPolicy", [policy, options])
end

#as2_config ⇒ Object

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

Returns:

  • (Object) 


296
297
298
 
# File 'transfer/cfn_connector.rb', line 296

def as2_config()
  jsii_get_property("as2Config")
end

#as2_config=(value) ⇒ Object 



300
301
302
303
 
# File 'transfer/cfn_connector.rb', line 300

def as2_config=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "as2Config")
  jsii_set_property("as2Config", value)
end

#attr_arn ⇒ String

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

Returns:

  • (String) 


229
230
231
 
# File 'transfer/cfn_connector.rb', line 229

def attr_arn()
  jsii_get_property("attrArn")
end

#attr_connector_id ⇒ String

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

Returns:

  • (String) 


236
237
238
 
# File 'transfer/cfn_connector.rb', line 236

def attr_connector_id()
  jsii_get_property("attrConnectorId")
end

#attr_error_message ⇒ String

Error message providing details when the connector is in ERRORED status.

Contains information to help troubleshoot connector creation or operation failures.

Returns:

  • (String) 


245
246
247
 
# File 'transfer/cfn_connector.rb', line 245

def attr_error_message()
  jsii_get_property("attrErrorMessage")
end

#attr_service_managed_egress_ip_addresses ⇒ Array<String>

The list of egress IP addresses of this connector.

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

Returns:

  • (Array<String>) 


254
255
256
 
# File 'transfer/cfn_connector.rb', line 254

def attr_service_managed_egress_ip_addresses()
  jsii_get_property("attrServiceManagedEgressIpAddresses")
end

#attr_status ⇒ String

Current status of the connector.

PENDING indicates creation/update in progress, ACTIVE means ready for operations, and ERRORED indicates a failure requiring attention.

Returns:

  • (String) 


263
264
265
 
# File 'transfer/cfn_connector.rb', line 263

def attr_status()
  jsii_get_property("attrStatus")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

Returns:



175
176
177
 
# File 'transfer/cfn_connector.rb', line 175

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


180
181
182
 
# File 'transfer/cfn_connector.rb', line 180

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


596
597
598
599
 
# File 'transfer/cfn_connector.rb', line 596

def cfn_property_name(cdk_property_name)
  Jsii::Type.check_type(cdk_property_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cdkPropertyName")
  jsii_call_method("cfnPropertyName", [cdk_property_name])
end

#cfn_property_names ⇒ Hash{String => String}

Returns:

  • (Hash{String => String}) 


185
186
187
 
# File 'transfer/cfn_connector.rb', line 185

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


192
193
194
 
# File 'transfer/cfn_connector.rb', line 192

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#connector_ref ⇒ AWSCDK::Interfaces::AWSTransfer::ConnectorReference

A reference to a Connector resource.

Returns:



270
271
272
 
# File 'transfer/cfn_connector.rb', line 270

def connector_ref()
  jsii_get_property("connectorRef")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


137
138
139
 
# File 'transfer/cfn_connector.rb', line 137

def creation_stack()
  jsii_get_property("creationStack")
end

#egress_config ⇒ AWSCDK::IResolvable, ...

Current egress configuration of the connector, showing how traffic is routed to the SFTP server.

Returns:



308
309
310
 
# File 'transfer/cfn_connector.rb', line 308

def egress_config()
  jsii_get_property("egressConfig")
end

#egress_config=(value) ⇒ Object 



312
313
314
315
316
 
# File 'transfer/cfn_connector.rb', line 312

def egress_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Transfer::CfnConnector::ConnectorEgressConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c190cmFuc2Zlci5DZm5Db25uZWN0b3IuQ29ubmVjdG9yRWdyZXNzQ29uZmlnUHJvcGVydHkifV19fQ==")), "egressConfig") unless value.nil?
  jsii_set_property("egressConfig", value)
end

#egress_type ⇒ String?

Type of egress configuration for the connector.

Returns:

  • (String, nil) 


321
322
323
 
# File 'transfer/cfn_connector.rb', line 321

def egress_type()
  jsii_get_property("egressType")
end

#egress_type=(value) ⇒ Object 



325
326
327
328
 
# File 'transfer/cfn_connector.rb', line 325

def egress_type=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "egressType") unless value.nil?
  jsii_set_property("egressType", value)
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



197
198
199
 
# File 'transfer/cfn_connector.rb', line 197

def env()
  jsii_get_property("env")
end

#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

Returns:



609
610
611
612
613
 
# File 'transfer/cfn_connector.rb', line 609

def get_att(attribute_name, type_hint = nil)
  Jsii::Type.check_type(attribute_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "attributeName")
  Jsii::Type.check_type(type_hint, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZXNvbHV0aW9uVHlwZUhpbnQifQ==")), "typeHint") unless type_hint.nil?
  jsii_call_method("getAtt", [attribute_name, type_hint])
end

#get_metadata(key) ⇒ Object

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

  • key (String)

Returns:

  • (Object)

See Also:



620
621
622
623
 
# File 'transfer/cfn_connector.rb', line 620

def get_metadata(key)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  jsii_call_method("getMetadata", [key])
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



690
691
692
693
 
# File 'transfer/cfn_connector.rb', line 690

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
end

#ip_address_type ⇒ String?

IP address type for Connector.

Returns:

  • (String, nil) 


333
334
335
 
# File 'transfer/cfn_connector.rb', line 333

def ip_address_type()
  jsii_get_property("ipAddressType")
end

#ip_address_type=(value) ⇒ Object 



337
338
339
340
 
# File 'transfer/cfn_connector.rb', line 337

def ip_address_type=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "ipAddressType") unless value.nil?
  jsii_set_property("ipAddressType", value)
end

#logging_role ⇒ String?

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.

Returns:

  • (String, nil) 


345
346
347
 
# File 'transfer/cfn_connector.rb', line 345

def logging_role()
  jsii_get_property("loggingRole")
end

#logging_role=(value) ⇒ Object 



349
350
351
352
 
# File 'transfer/cfn_connector.rb', line 349

def logging_role=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "loggingRole") unless value.nil?
  jsii_set_property("loggingRole", value)
end

#logical_id ⇒ String

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use override_logical_id(new_logical_id).

Returns:

  • (String) 


149
150
151
 
# File 'transfer/cfn_connector.rb', line 149

def logical_id()
  jsii_get_property("logicalId")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


132
133
134
 
# File 'transfer/cfn_connector.rb', line 132

def node()
  jsii_get_property("node")
end

#obtain_dependencies ⇒ Array<AWSCDK::CfnResource, AWSCDK::Stack>

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Returns:



631
632
633
 
# File 'transfer/cfn_connector.rb', line 631

def obtain_dependencies()
  jsii_call_method("obtainDependencies", [])
end

#obtain_resource_dependencies ⇒ Array<AWSCDK::CfnResource>

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Returns:



638
639
640
 
# File 'transfer/cfn_connector.rb', line 638

def obtain_resource_dependencies()
  jsii_call_method("obtainResourceDependencies", [])
end

#override_logical_id(new_logical_id) ⇒ void

This method returns an undefined value.

Overrides the auto-generated logical ID with a specific ID.

Parameters:

  • new_logical_id (String) —

    The new logical ID to use for this stack element.



431
432
433
434
 
# File 'transfer/cfn_connector.rb', line 431

def override_logical_id(new_logical_id)
  Jsii::Type.check_type(new_logical_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "newLogicalId")
  jsii_call_method("overrideLogicalId", [new_logical_id])
end

#ref ⇒ String

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Returns:

  • (String) 


168
169
170
 
# File 'transfer/cfn_connector.rb', line 168

def ref()
  jsii_get_property("ref")
end

#remove_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:



649
650
651
652
 
# File 'transfer/cfn_connector.rb', line 649

def remove_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("removeDependency", [target])
end

#render_properties(props) ⇒ Hash{String => Object}

Parameters:

  • props (Hash{String => Object})

Returns:

  • (Hash{String => Object}) 


656
657
658
659
 
# File 'transfer/cfn_connector.rb', line 656

def render_properties(props)
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "props")
  jsii_call_method("renderProperties", [props])
end

#replace_dependency(target, new_target) ⇒ void

This method returns an undefined value.

Replaces one dependency with another.

Parameters:



666
667
668
669
670
 
# File 'transfer/cfn_connector.rb', line 666

def replace_dependency(target, new_target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  Jsii::Type.check_type(new_target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "newTarget")
  jsii_call_method("replaceDependency", [target, new_target])
end

#security_policy_name ⇒ String?

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

Returns:

  • (String, nil) 


357
358
359
 
# File 'transfer/cfn_connector.rb', line 357

def security_policy_name()
  jsii_get_property("securityPolicyName")
end

#security_policy_name=(value) ⇒ Object 



361
362
363
364
 
# File 'transfer/cfn_connector.rb', line 361

def security_policy_name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "securityPolicyName") unless value.nil?
  jsii_set_property("securityPolicyName", value)
end

#sftp_config ⇒ AWSCDK::IResolvable, ...

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

Returns:



369
370
371
 
# File 'transfer/cfn_connector.rb', line 369

def sftp_config()
  jsii_get_property("sftpConfig")
end

#sftp_config=(value) ⇒ Object 



373
374
375
376
377
 
# File 'transfer/cfn_connector.rb', line 373

def sftp_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Transfer::CfnConnector::SftpConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c190cmFuc2Zlci5DZm5Db25uZWN0b3IuU2Z0cENvbmZpZ1Byb3BlcnR5In1dfX0=")), "sftpConfig") unless value.nil?
  jsii_set_property("sftpConfig", value)
end

#should_synthesize ⇒ Boolean

Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.

Returns:

  • (Boolean) —

    true if the resource should be included or false is the resource should be omitted.



675
676
677
 
# File 'transfer/cfn_connector.rb', line 675

def should_synthesize()
  jsii_call_method("shouldSynthesize", [])
end

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Returns:



158
159
160
 
# File 'transfer/cfn_connector.rb', line 158

def stack()
  jsii_get_property("stack")
end

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



277
278
279
 
# File 'transfer/cfn_connector.rb', line 277

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Array<AWSCDK::CfnTag>?

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

Returns:



382
383
384
 
# File 'transfer/cfn_connector.rb', line 382

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



386
387
388
389
390
 
# File 'transfer/cfn_connector.rb', line 386

def tags_raw=(value)
  value = value.is_a?(Array) ? value.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tagsRaw") unless value.nil?
  jsii_set_property("tagsRaw", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



407
408
409
 
# File 'transfer/cfn_connector.rb', line 407

def to_string()
  jsii_call_method("toString", [])
end

#updated_properites ⇒ Hash{String => Object}

Deprecated.

use updatedProperties Return properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Deprecated.

Returns:

  • (Hash{String => Object}) 


205
206
207
 
# File 'transfer/cfn_connector.rb', line 205

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_properties ⇒ Hash{String => Object}

Return properties modified after initiation.

Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Returns:

  • (Hash{String => Object}) 


215
216
217
 
# File 'transfer/cfn_connector.rb', line 215

def updated_properties()
  jsii_get_property("updatedProperties")
end

#url ⇒ String?

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

Returns:

  • (String, nil) 


395
396
397
 
# File 'transfer/cfn_connector.rb', line 395

def url()
  jsii_get_property("url")
end

#url=(value) ⇒ Object 



399
400
401
402
 
# File 'transfer/cfn_connector.rb', line 399

def url=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "url") unless value.nil?
  jsii_set_property("url", value)
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


681
682
683
684
 
# File 'transfer/cfn_connector.rb', line 681

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
end

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct) 


420
421
422
423
424
425
 
# File 'transfer/cfn_connector.rb', line 420

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end