Class: AWSCDK::Datasync::CfnLocationSMB

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggable, Interfaces::AWSDatasync::ILocationSMBRef
Defined in:
datasync/cfn_location_smb.rb

Overview

The AWS::DataSync::LocationSMB resource specifies a Server Message Block (SMB) location that AWS DataSync can use as a transfer source or destination.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnLocationSMB

Create a new AWS::DataSync::LocationSMB.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

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

  • props (AWSCDK::Datasync::CfnLocationSMBProps) —

    Resource properties.



18
19
20
21
22
23
24
 
# File 'datasync/cfn_location_smb.rb', line 18

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::Datasync::CfnLocationSMBProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZGF0YXN5bmMuQ2ZuTG9jYXRpb25TTUJQcm9wcyJ9")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


189
190
191
 
# File 'datasync/cfn_location_smb.rb', line 189

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

.is_cfn_location_smb(x) ⇒ Boolean

Checks whether the given object is a CfnLocationSMB.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


91
92
93
94
 
# File 'datasync/cfn_location_smb.rb', line 91

def self.is_cfn_location_smb(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_datasync.CfnLocationSMB", "isCfnLocationSMB", [x])
end

.jsii_overridable_methods ⇒ Object 



26
27
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
 
# File 'datasync/cfn_location_smb.rb', line 26

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_cmk_secret_config_secret_arn => { kind: :property, name: "attrCmkSecretConfigSecretArn", is_optional: false },
    :attr_location_arn => { kind: :property, name: "attrLocationArn", is_optional: false },
    :attr_location_uri => { kind: :property, name: "attrLocationUri", is_optional: false },
    :attr_managed_secret_config => { kind: :property, name: "attrManagedSecretConfig", is_optional: false },
    :location_smb_ref => { kind: :property, name: "locationSmbRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :agent_arns => { kind: :property, name: "agentArns", is_optional: false },
    :authentication_type => { kind: :property, name: "authenticationType", is_optional: true },
    :cmk_secret_config => { kind: :property, name: "cmkSecretConfig", is_optional: true },
    :custom_secret_config => { kind: :property, name: "customSecretConfig", is_optional: true },
    :dns_ip_addresses => { kind: :property, name: "dnsIpAddresses", is_optional: true },
    :domain => { kind: :property, name: "domain", is_optional: true },
    :kerberos_keytab => { kind: :property, name: "kerberosKeytab", is_optional: true },
    :kerberos_krb5_conf => { kind: :property, name: "kerberosKrb5Conf", is_optional: true },
    :kerberos_principal => { kind: :property, name: "kerberosPrincipal", is_optional: true },
    :mount_options => { kind: :property, name: "mountOptions", is_optional: true },
    :password => { kind: :property, name: "password", is_optional: true },
    :server_hostname => { kind: :property, name: "serverHostname", is_optional: true },
    :subdirectory => { kind: :property, name: "subdirectory", is_optional: true },
    :tags_raw => { kind: :property, name: "tagsRaw", is_optional: true },
    :user => { kind: :property, name: "user", 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.



459
460
461
462
 
# File 'datasync/cfn_location_smb.rb', line 459

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:



471
472
473
474
 
# File 'datasync/cfn_location_smb.rb', line 471

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:



481
482
483
484
 
# File 'datasync/cfn_location_smb.rb', line 481

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:



492
493
494
495
496
 
# File 'datasync/cfn_location_smb.rb', line 492

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.


549
550
551
552
553
 
# File 'datasync/cfn_location_smb.rb', line 549

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.



559
560
561
562
 
# File 'datasync/cfn_location_smb.rb', line 559

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.



571
572
573
574
575
 
# File 'datasync/cfn_location_smb.rb', line 571

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

#agent_arns ⇒ Array<String>

Specifies the DataSync agent (or agents) that can connect to your SMB file server.

Returns:

  • (Array<String>) 


242
243
244
 
# File 'datasync/cfn_location_smb.rb', line 242

def agent_arns()
  jsii_get_property("agentArns")
end

#agent_arns=(value) ⇒ Object 



246
247
248
249
 
# File 'datasync/cfn_location_smb.rb', line 246

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



584
585
586
587
 
# File 'datasync/cfn_location_smb.rb', line 584

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:



606
607
608
609
610
611
 
# File 'datasync/cfn_location_smb.rb', line 606

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_cmk_secret_config_secret_arn ⇒ String

Specifies the ARN for the DataSync-managed AWS Secrets Manager secret that that is used to access a specific storage location.

This property is generated by DataSync and is read-only. DataSync encrypts this secret with the KMS key that you specify for KmsKeyArn .

Returns:

  • (String) 


198
199
200
 
# File 'datasync/cfn_location_smb.rb', line 198

def attr_cmk_secret_config_secret_arn()
  jsii_get_property("attrCmkSecretConfigSecretArn")
end

#attr_location_arn ⇒ String

The Amazon Resource Name (ARN) of the specified SMB location.

Returns:

  • (String) 


205
206
207
 
# File 'datasync/cfn_location_smb.rb', line 205

def attr_location_arn()
  jsii_get_property("attrLocationArn")
end

#attr_location_uri ⇒ String

The URI of the specified SMB location.

Returns:

  • (String) 


212
213
214
 
# File 'datasync/cfn_location_smb.rb', line 212

def attr_location_uri()
  jsii_get_property("attrLocationUri")
end

#attr_managed_secret_config ⇒ AWSCDK::IResolvable

Specifies configuration information for a DataSync-managed secret, such as a password or set of credentials that DataSync uses to access a specific transfer location.

DataSync uses the default AWS-managed KMS key to encrypt this secret in AWS Secrets Manager.

Returns:



221
222
223
 
# File 'datasync/cfn_location_smb.rb', line 221

def attr_managed_secret_config()
  jsii_get_property("attrManagedSecretConfig")
end

#authentication_type ⇒ String?

The authentication mode used to determine identity of user.

Returns:

  • (String, nil) 


254
255
256
 
# File 'datasync/cfn_location_smb.rb', line 254

def authentication_type()
  jsii_get_property("authenticationType")
end

#authentication_type=(value) ⇒ Object 



258
259
260
261
 
# File 'datasync/cfn_location_smb.rb', line 258

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

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



142
143
144
 
# File 'datasync/cfn_location_smb.rb', line 142

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


147
148
149
 
# File 'datasync/cfn_location_smb.rb', line 147

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


615
616
617
618
 
# File 'datasync/cfn_location_smb.rb', line 615

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


152
153
154
 
# File 'datasync/cfn_location_smb.rb', line 152

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


159
160
161
 
# File 'datasync/cfn_location_smb.rb', line 159

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#cmk_secret_config ⇒ AWSCDK::IResolvable, ...

Specifies configuration information for a DataSync-managed secret, such as an authentication token, secret key, password, or Kerberos keytab that DataSync uses to access a specific storage location, with a customer-managed AWS KMS key .

Returns:



266
267
268
 
# File 'datasync/cfn_location_smb.rb', line 266

def cmk_secret_config()
  jsii_get_property("cmkSecretConfig")
end

#cmk_secret_config=(value) ⇒ Object 



270
271
272
273
274
 
# File 'datasync/cfn_location_smb.rb', line 270

def cmk_secret_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Datasync::CfnLocationSMB::CmkSecretConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19kYXRhc3luYy5DZm5Mb2NhdGlvblNNQi5DbWtTZWNyZXRDb25maWdQcm9wZXJ0eSJ9XX19")), "cmkSecretConfig") unless value.nil?
  jsii_set_property("cmkSecretConfig", value)
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


104
105
106
 
# File 'datasync/cfn_location_smb.rb', line 104

def creation_stack()
  jsii_get_property("creationStack")
end

#custom_secret_config ⇒ AWSCDK::IResolvable, ...

Specifies configuration information for a customer-managed Secrets Manager secret where a storage location credentials is stored in Secrets Manager as plain text (for authentication token, secret key, or password) or as binary (for Kerberos keytab).

Returns:



279
280
281
 
# File 'datasync/cfn_location_smb.rb', line 279

def custom_secret_config()
  jsii_get_property("customSecretConfig")
end

#custom_secret_config=(value) ⇒ Object 



283
284
285
286
287
 
# File 'datasync/cfn_location_smb.rb', line 283

def custom_secret_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Datasync::CfnLocationSMB::CustomSecretConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19kYXRhc3luYy5DZm5Mb2NhdGlvblNNQi5DdXN0b21TZWNyZXRDb25maWdQcm9wZXJ0eSJ9XX19")), "customSecretConfig") unless value.nil?
  jsii_set_property("customSecretConfig", value)
end

#dns_ip_addresses ⇒ Array<String>?

Specifies the IPv4 addresses for the DNS servers that your SMB file server belongs to.

Returns:

  • (Array<String>, nil) 


292
293
294
 
# File 'datasync/cfn_location_smb.rb', line 292

def dns_ip_addresses()
  jsii_get_property("dnsIpAddresses")
end

#dns_ip_addresses=(value) ⇒ Object 



296
297
298
299
 
# File 'datasync/cfn_location_smb.rb', line 296

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

#domain ⇒ String?

Specifies the Windows domain name that your SMB file server belongs to.

Returns:

  • (String, nil) 


304
305
306
 
# File 'datasync/cfn_location_smb.rb', line 304

def domain()
  jsii_get_property("domain")
end

#domain=(value) ⇒ Object 



308
309
310
311
 
# File 'datasync/cfn_location_smb.rb', line 308

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

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



164
165
166
 
# File 'datasync/cfn_location_smb.rb', line 164

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:



628
629
630
631
632
 
# File 'datasync/cfn_location_smb.rb', line 628

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:



639
640
641
642
 
# File 'datasync/cfn_location_smb.rb', line 639

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:



709
710
711
712
 
# File 'datasync/cfn_location_smb.rb', line 709

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

#kerberos_keytab ⇒ String?

The Base64 string representation of the Keytab file.

Returns:

  • (String, nil) 


316
317
318
 
# File 'datasync/cfn_location_smb.rb', line 316

def kerberos_keytab()
  jsii_get_property("kerberosKeytab")
end

#kerberos_keytab=(value) ⇒ Object 



320
321
322
323
 
# File 'datasync/cfn_location_smb.rb', line 320

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

#kerberos_krb5_conf ⇒ String?

The string representation of the Krb5Conf file, or the presigned URL to access the Krb5.conf file within an S3 bucket. Specifies a Kerberos configuration file (krb5.conf) that defines your Kerberos realm configuration. To avoid task execution errors, make sure that the service principal name (SPN) in the krb5.conf file matches exactly what you specify for KerberosPrincipal and in your keytab file.

Returns:

  • (String, nil) 


328
329
330
 
# File 'datasync/cfn_location_smb.rb', line 328

def kerberos_krb5_conf()
  jsii_get_property("kerberosKrb5Conf")
end

#kerberos_krb5_conf=(value) ⇒ Object 



332
333
334
335
 
# File 'datasync/cfn_location_smb.rb', line 332

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

#kerberos_principal ⇒ String?

Specifies a service principal name (SPN), which is an identity in your Kerberos realm that has permission to access the files, folders, and file metadata in your SMB file server.

Returns:

  • (String, nil) 


340
341
342
 
# File 'datasync/cfn_location_smb.rb', line 340

def kerberos_principal()
  jsii_get_property("kerberosPrincipal")
end

#kerberos_principal=(value) ⇒ Object 



344
345
346
347
 
# File 'datasync/cfn_location_smb.rb', line 344

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

#location_smb_ref ⇒ AWSCDK::Interfaces::AWSDatasync::LocationSMBReference

A reference to a LocationSMB resource.

Returns:



228
229
230
 
# File 'datasync/cfn_location_smb.rb', line 228

def location_smb_ref()
  jsii_get_property("locationSmbRef")
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) 


116
117
118
 
# File 'datasync/cfn_location_smb.rb', line 116

def logical_id()
  jsii_get_property("logicalId")
end

#mount_options ⇒ AWSCDK::IResolvable, ...

Specifies the version of the SMB protocol that DataSync uses to access your SMB file server.

Returns:



352
353
354
 
# File 'datasync/cfn_location_smb.rb', line 352

def mount_options()
  jsii_get_property("mountOptions")
end

#mount_options=(value) ⇒ Object 



356
357
358
359
360
 
# File 'datasync/cfn_location_smb.rb', line 356

def mount_options=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Datasync::CfnLocationSMB::MountOptionsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19kYXRhc3luYy5DZm5Mb2NhdGlvblNNQi5Nb3VudE9wdGlvbnNQcm9wZXJ0eSJ9XX19")), "mountOptions") unless value.nil?
  jsii_set_property("mountOptions", value)
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


99
100
101
 
# File 'datasync/cfn_location_smb.rb', line 99

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:



650
651
652
 
# File 'datasync/cfn_location_smb.rb', line 650

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:



657
658
659
 
# File 'datasync/cfn_location_smb.rb', line 657

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.



450
451
452
453
 
# File 'datasync/cfn_location_smb.rb', line 450

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

#password ⇒ String?

Specifies the password of the user who can mount your SMB file server and has permission to access the files and folders involved in your transfer.

Returns:

  • (String, nil) 


365
366
367
 
# File 'datasync/cfn_location_smb.rb', line 365

def password()
  jsii_get_property("password")
end

#password=(value) ⇒ Object 



369
370
371
372
 
# File 'datasync/cfn_location_smb.rb', line 369

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


135
136
137
 
# File 'datasync/cfn_location_smb.rb', line 135

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:



668
669
670
671
 
# File 'datasync/cfn_location_smb.rb', line 668

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


675
676
677
678
 
# File 'datasync/cfn_location_smb.rb', line 675

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:



685
686
687
688
689
 
# File 'datasync/cfn_location_smb.rb', line 685

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

#server_hostname ⇒ String?

Specifies the domain name or IP address (IPv4 or IPv6) of the SMB file server that your DataSync agent connects to.

Returns:

  • (String, nil) 


377
378
379
 
# File 'datasync/cfn_location_smb.rb', line 377

def server_hostname()
  jsii_get_property("serverHostname")
end

#server_hostname=(value) ⇒ Object 



381
382
383
384
 
# File 'datasync/cfn_location_smb.rb', line 381

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



694
695
696
 
# File 'datasync/cfn_location_smb.rb', line 694

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:



125
126
127
 
# File 'datasync/cfn_location_smb.rb', line 125

def stack()
  jsii_get_property("stack")
end

#subdirectory ⇒ String?

Specifies the name of the share exported by your SMB file server where DataSync will read or write data.

Returns:

  • (String, nil) 


389
390
391
 
# File 'datasync/cfn_location_smb.rb', line 389

def subdirectory()
  jsii_get_property("subdirectory")
end

#subdirectory=(value) ⇒ Object 



393
394
395
396
 
# File 'datasync/cfn_location_smb.rb', line 393

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

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



235
236
237
 
# File 'datasync/cfn_location_smb.rb', line 235

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Array<AWSCDK::CfnTag>?

Specifies labels that help you categorize, filter, and search for your AWS resources.

Returns:



401
402
403
 
# File 'datasync/cfn_location_smb.rb', line 401

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



405
406
407
408
409
 
# File 'datasync/cfn_location_smb.rb', line 405

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



426
427
428
 
# File 'datasync/cfn_location_smb.rb', line 426

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


172
173
174
 
# File 'datasync/cfn_location_smb.rb', line 172

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


182
183
184
 
# File 'datasync/cfn_location_smb.rb', line 182

def updated_properties()
  jsii_get_property("updatedProperties")
end

#user ⇒ String?

Specifies the user that can mount and access the files, folders, and file metadata in your SMB file server.

Returns:

  • (String, nil) 


414
415
416
 
# File 'datasync/cfn_location_smb.rb', line 414

def user()
  jsii_get_property("user")
end

#user=(value) ⇒ Object 



418
419
420
421
 
# File 'datasync/cfn_location_smb.rb', line 418

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

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


700
701
702
703
 
# File 'datasync/cfn_location_smb.rb', line 700

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) 


439
440
441
442
443
444
 
# File 'datasync/cfn_location_smb.rb', line 439

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