Class: AWSCDK::Transfer::CfnServer

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

Overview

Instantiates an auto-scaling virtual server based on the selected file transfer protocol in AWS .

When you make updates to your file transfer protocol-enabled server or when you work with users, use the service-generated ServerId property that is assigned to the newly created server.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props = nil) ⇒ CfnServer

Create a new AWS::Transfer::Server.

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::CfnServerProps, nil) (defaults to: nil) —

    Resource properties.



20
21
22
23
24
25
26
 
# File 'transfer/cfn_server.rb', line 20

def initialize(scope, id, props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::Transfer::CfnServerProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfdHJhbnNmZXIuQ2ZuU2VydmVyUHJvcHMifQ==")), "props") unless props.nil?
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.arn_for_server(resource) ⇒ String

Parameters:

Returns:

  • (String) 


93
94
95
96
 
# File 'transfer/cfn_server.rb', line 93

def self.arn_for_server(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c190cmFuc2Zlci5JU2VydmVyUmVmIn0=")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_transfer.CfnServer", "arnForServer", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


200
201
202
 
# File 'transfer/cfn_server.rb', line 200

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

.is_cfn_server(x) ⇒ Boolean

Checks whether the given object is a CfnServer.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


102
103
104
105
 
# File 'transfer/cfn_server.rb', line 102

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

.jsii_overridable_methods ⇒ Object 



28
29
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
86
87
88
89
 
# File 'transfer/cfn_server.rb', line 28

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_as2_service_managed_egress_ip_addresses => { kind: :property, name: "attrAs2ServiceManagedEgressIpAddresses", is_optional: false },
    :attr_server_id => { kind: :property, name: "attrServerId", is_optional: false },
    :attr_state => { kind: :property, name: "attrState", is_optional: false },
    :server_ref => { kind: :property, name: "serverRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :certificate => { kind: :property, name: "certificate", is_optional: true },
    :domain => { kind: :property, name: "domain", is_optional: true },
    :endpoint_details => { kind: :property, name: "endpointDetails", is_optional: true },
    :endpoint_type => { kind: :property, name: "endpointType", is_optional: true },
    :identity_provider_details => { kind: :property, name: "identityProviderDetails", is_optional: true },
    :identity_provider_type => { kind: :property, name: "identityProviderType", is_optional: true },
    :ip_address_type => { kind: :property, name: "ipAddressType", is_optional: true },
    :logging_role => { kind: :property, name: "loggingRole", is_optional: true },
    :post_authentication_login_banner => { kind: :property, name: "postAuthenticationLoginBanner", is_optional: true },
    :pre_authentication_login_banner => { kind: :property, name: "preAuthenticationLoginBanner", is_optional: true },
    :protocol_details => { kind: :property, name: "protocolDetails", is_optional: true },
    :protocols => { kind: :property, name: "protocols", is_optional: true },
    :s3_storage_options => { kind: :property, name: "s3StorageOptions", is_optional: true },
    :security_policy_name => { kind: :property, name: "securityPolicyName", is_optional: true },
    :structured_log_destinations => { kind: :property, name: "structuredLogDestinations", is_optional: true },
    :tags_raw => { kind: :property, name: "tagsRaw", is_optional: true },
    :workflow_details => { kind: :property, name: "workflowDetails", 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

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



504
505
506
507
 
# File 'transfer/cfn_server.rb', line 504

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:



516
517
518
519
 
# File 'transfer/cfn_server.rb', line 516

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:



526
527
528
529
 
# File 'transfer/cfn_server.rb', line 526

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:



537
538
539
540
541
 
# File 'transfer/cfn_server.rb', line 537

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.


594
595
596
597
598
 
# File 'transfer/cfn_server.rb', line 594

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.



604
605
606
607
 
# File 'transfer/cfn_server.rb', line 604

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.



616
617
618
619
620
 
# File 'transfer/cfn_server.rb', line 616

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:



629
630
631
632
 
# File 'transfer/cfn_server.rb', line 629

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:



651
652
653
654
655
656
 
# File 'transfer/cfn_server.rb', line 651

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

#attr_arn ⇒ String

Specifies the unique Amazon Resource Name (ARN) of the server.

Returns:

  • (String) 


207
208
209
 
# File 'transfer/cfn_server.rb', line 207

def attr_arn()
  jsii_get_property("attrArn")
end

#attr_as2_service_managed_egress_ip_addresses ⇒ Array<String>

The list of egress IP addresses of this server.

These IP addresses are only relevant for servers that use the AS2 protocol. They are used for sending asynchronous MDNs.

These IP addresses are assigned automatically when you create an AS2 server. Additionally, if you update an existing server and add the AS2 protocol, static IP addresses are assigned as well.

Returns:

  • (Array<String>) 


218
219
220
 
# File 'transfer/cfn_server.rb', line 218

def attr_as2_service_managed_egress_ip_addresses()
  jsii_get_property("attrAs2ServiceManagedEgressIpAddresses")
end

#attr_server_id ⇒ String

Specifies the unique system-assigned identifier for a server that you instantiate.

Returns:

  • (String) 


225
226
227
 
# File 'transfer/cfn_server.rb', line 225

def attr_server_id()
  jsii_get_property("attrServerId")
end

#attr_state ⇒ String

The condition of the server that was described.

A value of ONLINE indicates that the server can accept jobs and transfer files. A State value of OFFLINE means that the server cannot perform file transfer operations.

The states of STARTING and STOPPING indicate that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of START_FAILED or STOP_FAILED can indicate an error condition.

Returns:

  • (String) 


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

def attr_state()
  jsii_get_property("attrState")
end

#certificate ⇒ String?

The Amazon Resource Name (ARN) of the Certificate Manager (ACM) certificate.

Required when Protocols is set to FTPS .

Returns:

  • (String, nil) 


259
260
261
 
# File 'transfer/cfn_server.rb', line 259

def certificate()
  jsii_get_property("certificate")
end

#certificate=(value) ⇒ Object 



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

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

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



153
154
155
 
# File 'transfer/cfn_server.rb', line 153

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


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

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


660
661
662
663
 
# File 'transfer/cfn_server.rb', line 660

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}) 


163
164
165
 
# File 'transfer/cfn_server.rb', line 163

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


170
171
172
 
# File 'transfer/cfn_server.rb', line 170

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


115
116
117
 
# File 'transfer/cfn_server.rb', line 115

def creation_stack()
  jsii_get_property("creationStack")
end

#domain ⇒ String?

Specifies the domain of the storage system that is used for file transfers.

Returns:

  • (String, nil) 


271
272
273
 
# File 'transfer/cfn_server.rb', line 271

def domain()
  jsii_get_property("domain")
end

#domain=(value) ⇒ Object 



275
276
277
278
 
# File 'transfer/cfn_server.rb', line 275

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

#endpoint_details ⇒ AWSCDK::IResolvable, ...

The virtual private cloud (VPC) endpoint settings that are configured for your server.

Returns:



283
284
285
 
# File 'transfer/cfn_server.rb', line 283

def endpoint_details()
  jsii_get_property("endpointDetails")
end

#endpoint_details=(value) ⇒ Object 



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

def endpoint_details=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Transfer::CfnServer::EndpointDetailsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c190cmFuc2Zlci5DZm5TZXJ2ZXIuRW5kcG9pbnREZXRhaWxzUHJvcGVydHkifV19fQ==")), "endpointDetails") unless value.nil?
  jsii_set_property("endpointDetails", value)
end

#endpoint_type ⇒ String?

The type of endpoint that you want your server to use.

Returns:

  • (String, nil) 


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

def endpoint_type()
  jsii_get_property("endpointType")
end

#endpoint_type=(value) ⇒ Object 



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

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

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



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

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:



673
674
675
676
677
 
# File 'transfer/cfn_server.rb', line 673

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:



684
685
686
687
 
# File 'transfer/cfn_server.rb', line 684

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

#identity_provider_details ⇒ AWSCDK::IResolvable, ...

Required when IdentityProviderType is set to AWS_DIRECTORY_SERVICE , AWS _LAMBDA or API_GATEWAY .

Returns:



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

def identity_provider_details()
  jsii_get_property("identityProviderDetails")
end

#identity_provider_details=(value) ⇒ Object 



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

def identity_provider_details=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Transfer::CfnServer::IdentityProviderDetailsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c190cmFuc2Zlci5DZm5TZXJ2ZXIuSWRlbnRpdHlQcm92aWRlckRldGFpbHNQcm9wZXJ0eSJ9XX19")), "identityProviderDetails") unless value.nil?
  jsii_set_property("identityProviderDetails", value)
end

#identity_provider_type ⇒ String?

The mode of authentication for a server.

Returns:

  • (String, nil) 


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

def identity_provider_type()
  jsii_get_property("identityProviderType")
end

#identity_provider_type=(value) ⇒ Object 



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

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

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



754
755
756
757
 
# File 'transfer/cfn_server.rb', line 754

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?

Specifies whether to use IPv4 only, or to use dual-stack (IPv4 and IPv6) for your AWS Transfer Family endpoint.

Returns:

  • (String, nil) 


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

def ip_address_type()
  jsii_get_property("ipAddressType")
end

#ip_address_type=(value) ⇒ Object 



337
338
339
340
 
# File 'transfer/cfn_server.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 server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFS events.

Returns:

  • (String, nil) 


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

def logging_role()
  jsii_get_property("loggingRole")
end

#logging_role=(value) ⇒ Object 



349
350
351
352
 
# File 'transfer/cfn_server.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) 


127
128
129
 
# File 'transfer/cfn_server.rb', line 127

def logical_id()
  jsii_get_property("logicalId")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


110
111
112
 
# File 'transfer/cfn_server.rb', line 110

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:



695
696
697
 
# File 'transfer/cfn_server.rb', line 695

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:



702
703
704
 
# File 'transfer/cfn_server.rb', line 702

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.



495
496
497
498
 
# File 'transfer/cfn_server.rb', line 495

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

#post_authentication_login_banner ⇒ String?

Specifies a string to display when users connect to a server.

This string is displayed after the user authenticates.

Returns:

  • (String, nil) 


359
360
361
 
# File 'transfer/cfn_server.rb', line 359

def ()
  jsii_get_property("postAuthenticationLoginBanner")
end

#post_authentication_login_banner=(value) ⇒ Object 



363
364
365
366
 
# File 'transfer/cfn_server.rb', line 363

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

#pre_authentication_login_banner ⇒ String?

Specifies a string to display when users connect to a server.

Returns:

  • (String, nil) 


371
372
373
 
# File 'transfer/cfn_server.rb', line 371

def ()
  jsii_get_property("preAuthenticationLoginBanner")
end

#pre_authentication_login_banner=(value) ⇒ Object 



375
376
377
378
 
# File 'transfer/cfn_server.rb', line 375

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

#protocol_details ⇒ AWSCDK::IResolvable, ...

The protocol settings that are configured for your server.

Returns:



383
384
385
 
# File 'transfer/cfn_server.rb', line 383

def protocol_details()
  jsii_get_property("protocolDetails")
end

#protocol_details=(value) ⇒ Object 



387
388
389
390
391
 
# File 'transfer/cfn_server.rb', line 387

def protocol_details=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Transfer::CfnServer::ProtocolDetailsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c190cmFuc2Zlci5DZm5TZXJ2ZXIuUHJvdG9jb2xEZXRhaWxzUHJvcGVydHkifV19fQ==")), "protocolDetails") unless value.nil?
  jsii_set_property("protocolDetails", value)
end

#protocols ⇒ Array<String>?

Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint.

Returns:

  • (Array<String>, nil) 


396
397
398
 
# File 'transfer/cfn_server.rb', line 396

def protocols()
  jsii_get_property("protocols")
end

#protocols=(value) ⇒ Object 



400
401
402
403
 
# File 'transfer/cfn_server.rb', line 400

def protocols=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "protocols") unless value.nil?
  jsii_set_property("protocols", value)
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) 


146
147
148
 
# File 'transfer/cfn_server.rb', line 146

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:



713
714
715
716
 
# File 'transfer/cfn_server.rb', line 713

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}) 


720
721
722
723
 
# File 'transfer/cfn_server.rb', line 720

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:



730
731
732
733
734
 
# File 'transfer/cfn_server.rb', line 730

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

#s3_storage_options ⇒ AWSCDK::IResolvable, ...

Specifies whether or not performance for your Amazon S3 directories is optimized.

Returns:



408
409
410
 
# File 'transfer/cfn_server.rb', line 408

def s3_storage_options()
  jsii_get_property("s3StorageOptions")
end

#s3_storage_options=(value) ⇒ Object 



412
413
414
415
416
 
# File 'transfer/cfn_server.rb', line 412

def s3_storage_options=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Transfer::CfnServer::S3StorageOptionsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c190cmFuc2Zlci5DZm5TZXJ2ZXIuUzNTdG9yYWdlT3B0aW9uc1Byb3BlcnR5In1dfX0=")), "s3StorageOptions") unless value.nil?
  jsii_set_property("s3StorageOptions", value)
end

#security_policy_name ⇒ String?

Specifies the name of the security policy for the server.

Returns:

  • (String, nil) 


421
422
423
 
# File 'transfer/cfn_server.rb', line 421

def security_policy_name()
  jsii_get_property("securityPolicyName")
end

#security_policy_name=(value) ⇒ Object 



425
426
427
428
 
# File 'transfer/cfn_server.rb', line 425

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

#server_ref ⇒ AWSCDK::Interfaces::AWSTransfer::ServerReference

A reference to a Server resource.

Returns:



243
244
245
 
# File 'transfer/cfn_server.rb', line 243

def server_ref()
  jsii_get_property("serverRef")
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.



739
740
741
 
# File 'transfer/cfn_server.rb', line 739

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:



136
137
138
 
# File 'transfer/cfn_server.rb', line 136

def stack()
  jsii_get_property("stack")
end

#structured_log_destinations ⇒ Array<String>?

Specifies the log groups to which your server logs are sent.

Returns:

  • (Array<String>, nil) 


433
434
435
 
# File 'transfer/cfn_server.rb', line 433

def structured_log_destinations()
  jsii_get_property("structuredLogDestinations")
end

#structured_log_destinations=(value) ⇒ Object 



437
438
439
440
 
# File 'transfer/cfn_server.rb', line 437

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

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



250
251
252
 
# File 'transfer/cfn_server.rb', line 250

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Array<AWSCDK::CfnTag>?

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

Returns:



445
446
447
 
# File 'transfer/cfn_server.rb', line 445

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



449
450
451
452
453
 
# File 'transfer/cfn_server.rb', line 449

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



471
472
473
 
# File 'transfer/cfn_server.rb', line 471

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}) 


183
184
185
 
# File 'transfer/cfn_server.rb', line 183

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}) 


193
194
195
 
# File 'transfer/cfn_server.rb', line 193

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


745
746
747
748
 
# File 'transfer/cfn_server.rb', line 745

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) 


484
485
486
487
488
489
 
# File 'transfer/cfn_server.rb', line 484

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

#workflow_details ⇒ AWSCDK::IResolvable, ...

Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow.

Returns:



458
459
460
 
# File 'transfer/cfn_server.rb', line 458

def workflow_details()
  jsii_get_property("workflowDetails")
end

#workflow_details=(value) ⇒ Object 



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

def workflow_details=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Transfer::CfnServer::WorkflowDetailsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c190cmFuc2Zlci5DZm5TZXJ2ZXIuV29ya2Zsb3dEZXRhaWxzUHJvcGVydHkifV19fQ==")), "workflowDetails") unless value.nil?
  jsii_set_property("workflowDetails", value)
end