Class: AWSCDK::Datasync::CfnLocationHDFS

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

Overview

The AWS::DataSync::LocationHDFS resource specifies an endpoint for a Hadoop Distributed File System (HDFS).

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnLocationHDFS

Create a new AWS::DataSync::LocationHDFS.

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::CfnLocationHDFSProps) —

    Resource properties.



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

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::Datasync::CfnLocationHDFSProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZGF0YXN5bmMuQ2ZuTG9jYXRpb25IREZTUHJvcHMifQ==")), "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_hdfs.rb', line 189

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

.is_cfn_location_hdfs(x) ⇒ Boolean

Checks whether the given object is a CfnLocationHDFS.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


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

def self.is_cfn_location_hdfs(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_datasync.CfnLocationHDFS", "isCfnLocationHDFS", [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_hdfs.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_hdfs_ref => { kind: :property, name: "locationHdfsRef", 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: false },
    :name_nodes => { kind: :property, name: "nameNodes", is_optional: false },
    :block_size => { kind: :property, name: "blockSize", is_optional: true },
    :cmk_secret_config => { kind: :property, name: "cmkSecretConfig", is_optional: true },
    :custom_secret_config => { kind: :property, name: "customSecretConfig", 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 },
    :kms_key_provider_uri => { kind: :property, name: "kmsKeyProviderUri", is_optional: true },
    :qop_configuration => { kind: :property, name: "qopConfiguration", is_optional: true },
    :replication_factor => { kind: :property, name: "replicationFactor", is_optional: true },
    :simple_user => { kind: :property, name: "simpleUser", is_optional: true },
    :subdirectory => { kind: :property, name: "subdirectory", is_optional: true },
    :tags_raw => { kind: :property, name: "tagsRaw", 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.



457
458
459
460
 
# File 'datasync/cfn_location_hdfs.rb', line 457

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:



469
470
471
472
 
# File 'datasync/cfn_location_hdfs.rb', line 469

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:



479
480
481
482
 
# File 'datasync/cfn_location_hdfs.rb', line 479

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:



490
491
492
493
494
 
# File 'datasync/cfn_location_hdfs.rb', line 490

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.


547
548
549
550
551
 
# File 'datasync/cfn_location_hdfs.rb', line 547

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.



557
558
559
560
 
# File 'datasync/cfn_location_hdfs.rb', line 557

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.



569
570
571
572
573
 
# File 'datasync/cfn_location_hdfs.rb', line 569

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>

The Amazon Resource Names (ARNs) of the DataSync agents that can connect to your HDFS cluster.

Returns:

  • (Array<String>) 


240
241
242
 
# File 'datasync/cfn_location_hdfs.rb', line 240

def agent_arns()
  jsii_get_property("agentArns")
end

#agent_arns=(value) ⇒ Object 



244
245
246
247
 
# File 'datasync/cfn_location_hdfs.rb', line 244

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:



582
583
584
585
 
# File 'datasync/cfn_location_hdfs.rb', line 582

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:



604
605
606
607
608
609
 
# File 'datasync/cfn_location_hdfs.rb', line 604

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 an AWS Secrets Manager secret, managed by DataSync.

Returns:

  • (String) 


196
197
198
 
# File 'datasync/cfn_location_hdfs.rb', line 196

def attr_cmk_secret_config_secret_arn()
  jsii_get_property("attrCmkSecretConfigSecretArn")
end

#attr_location_arn ⇒ String

The Amazon Resource Name (ARN) of the HDFS cluster location to describe.

Returns:

  • (String) 


203
204
205
 
# File 'datasync/cfn_location_hdfs.rb', line 203

def attr_location_arn()
  jsii_get_property("attrLocationArn")
end

#attr_location_uri ⇒ String

The URI of the HDFS cluster location.

Returns:

  • (String) 


210
211
212
 
# File 'datasync/cfn_location_hdfs.rb', line 210

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 an authentication token 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:



219
220
221
 
# File 'datasync/cfn_location_hdfs.rb', line 219

def attr_managed_secret_config()
  jsii_get_property("attrManagedSecretConfig")
end

#authentication_type ⇒ String

The authentication mode used to determine identity of user.

Returns:

  • (String) 


252
253
254
 
# File 'datasync/cfn_location_hdfs.rb', line 252

def authentication_type()
  jsii_get_property("authenticationType")
end

#authentication_type=(value) ⇒ Object 



256
257
258
259
 
# File 'datasync/cfn_location_hdfs.rb', line 256

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

#block_size ⇒ Numeric?

The size of data blocks to write into the HDFS cluster.

Returns:

  • (Numeric, nil) 


276
277
278
 
# File 'datasync/cfn_location_hdfs.rb', line 276

def block_size()
  jsii_get_property("blockSize")
end

#block_size=(value) ⇒ Object 



280
281
282
283
 
# File 'datasync/cfn_location_hdfs.rb', line 280

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

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



142
143
144
 
# File 'datasync/cfn_location_hdfs.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_hdfs.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) 


613
614
615
616
 
# File 'datasync/cfn_location_hdfs.rb', line 613

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_hdfs.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_hdfs.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 or set of credentials that DataSync uses to access a specific transfer location, and a customer-managed AWS KMS key.

Returns:



288
289
290
 
# File 'datasync/cfn_location_hdfs.rb', line 288

def cmk_secret_config()
  jsii_get_property("cmkSecretConfig")
end

#cmk_secret_config=(value) ⇒ Object 



292
293
294
295
296
 
# File 'datasync/cfn_location_hdfs.rb', line 292

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

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


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

def creation_stack()
  jsii_get_property("creationStack")
end

#custom_secret_config ⇒ AWSCDK::IResolvable, ...

Specifies configuration information for a customer-managed secret, such as an authentication token or set of credentials that DataSync uses to access a specific transfer location, and an IAM role that DataSync can assume and access the customer-managed secret.

Returns:



301
302
303
 
# File 'datasync/cfn_location_hdfs.rb', line 301

def custom_secret_config()
  jsii_get_property("customSecretConfig")
end

#custom_secret_config=(value) ⇒ Object 



305
306
307
308
309
 
# File 'datasync/cfn_location_hdfs.rb', line 305

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

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



164
165
166
 
# File 'datasync/cfn_location_hdfs.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:



626
627
628
629
630
 
# File 'datasync/cfn_location_hdfs.rb', line 626

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:



637
638
639
640
 
# File 'datasync/cfn_location_hdfs.rb', line 637

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:



707
708
709
710
 
# File 'datasync/cfn_location_hdfs.rb', line 707

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 Kerberos key table (keytab) that contains mappings between the defined Kerberos principal and the encrypted keys.

Returns:

  • (String, nil) 


314
315
316
 
# File 'datasync/cfn_location_hdfs.rb', line 314

def kerberos_keytab()
  jsii_get_property("kerberosKeytab")
end

#kerberos_keytab=(value) ⇒ Object 



318
319
320
321
 
# File 'datasync/cfn_location_hdfs.rb', line 318

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 krb5.conf file that contains the Kerberos configuration information. You can load the krb5.conf by providing a string of the file's contents or an Amazon S3 presigned URL of the file. If KERBEROS is specified for AuthType , this value is required.

Returns:

  • (String, nil) 


326
327
328
 
# File 'datasync/cfn_location_hdfs.rb', line 326

def kerberos_krb5_conf()
  jsii_get_property("kerberosKrb5Conf")
end

#kerberos_krb5_conf=(value) ⇒ Object 



330
331
332
333
 
# File 'datasync/cfn_location_hdfs.rb', line 330

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?

The Kerberos principal with access to the files and folders on the HDFS cluster.

Returns:

  • (String, nil) 


338
339
340
 
# File 'datasync/cfn_location_hdfs.rb', line 338

def kerberos_principal()
  jsii_get_property("kerberosPrincipal")
end

#kerberos_principal=(value) ⇒ Object 



342
343
344
345
 
# File 'datasync/cfn_location_hdfs.rb', line 342

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

#kms_key_provider_uri ⇒ String?

The URI of the HDFS cluster's Key Management Server (KMS).

Returns:

  • (String, nil) 


350
351
352
 
# File 'datasync/cfn_location_hdfs.rb', line 350

def kms_key_provider_uri()
  jsii_get_property("kmsKeyProviderUri")
end

#kms_key_provider_uri=(value) ⇒ Object 



354
355
356
357
 
# File 'datasync/cfn_location_hdfs.rb', line 354

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

#location_hdfs_ref ⇒ AWSCDK::Interfaces::AWSDatasync::LocationHDFSReference

A reference to a LocationHDFS resource.

Returns:



226
227
228
 
# File 'datasync/cfn_location_hdfs.rb', line 226

def location_hdfs_ref()
  jsii_get_property("locationHdfsRef")
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_hdfs.rb', line 116

def logical_id()
  jsii_get_property("logicalId")
end

#name_nodes ⇒ AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::Datasync::CfnLocationHDFS::NameNodeProperty>

The NameNode that manages the HDFS namespace.

Returns:



264
265
266
 
# File 'datasync/cfn_location_hdfs.rb', line 264

def name_nodes()
  jsii_get_property("nameNodes")
end

#name_nodes=(value) ⇒ Object 



268
269
270
271
 
# File 'datasync/cfn_location_hdfs.rb', line 268

def name_nodes=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZGF0YXN5bmMuQ2ZuTG9jYXRpb25IREZTLk5hbWVOb2RlUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "nameNodes")
  jsii_set_property("nameNodes", value)
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


99
100
101
 
# File 'datasync/cfn_location_hdfs.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:



648
649
650
 
# File 'datasync/cfn_location_hdfs.rb', line 648

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:



655
656
657
 
# File 'datasync/cfn_location_hdfs.rb', line 655

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.



448
449
450
451
 
# File 'datasync/cfn_location_hdfs.rb', line 448

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

#qop_configuration ⇒ AWSCDK::IResolvable, ...

The Quality of Protection (QOP) configuration specifies the Remote Procedure Call (RPC) and data transfer protection settings configured on the Hadoop Distributed File System (HDFS) cluster.

Returns:



362
363
364
 
# File 'datasync/cfn_location_hdfs.rb', line 362

def qop_configuration()
  jsii_get_property("qopConfiguration")
end

#qop_configuration=(value) ⇒ Object 



366
367
368
369
370
 
# File 'datasync/cfn_location_hdfs.rb', line 366

def qop_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Datasync::CfnLocationHDFS::QopConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19kYXRhc3luYy5DZm5Mb2NhdGlvbkhERlMuUW9wQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "qopConfiguration") unless value.nil?
  jsii_set_property("qopConfiguration", 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_hdfs.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:



666
667
668
669
 
# File 'datasync/cfn_location_hdfs.rb', line 666

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


673
674
675
676
 
# File 'datasync/cfn_location_hdfs.rb', line 673

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:



683
684
685
686
687
 
# File 'datasync/cfn_location_hdfs.rb', line 683

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

#replication_factor ⇒ Numeric?

The number of DataNodes to replicate the data to when writing to the HDFS cluster.

Returns:

  • (Numeric, nil) 


375
376
377
 
# File 'datasync/cfn_location_hdfs.rb', line 375

def replication_factor()
  jsii_get_property("replicationFactor")
end

#replication_factor=(value) ⇒ Object 



379
380
381
382
 
# File 'datasync/cfn_location_hdfs.rb', line 379

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



692
693
694
 
# File 'datasync/cfn_location_hdfs.rb', line 692

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

#simple_user ⇒ String?

The user name used to identify the client on the host operating system.

Returns:

  • (String, nil) 


387
388
389
 
# File 'datasync/cfn_location_hdfs.rb', line 387

def simple_user()
  jsii_get_property("simpleUser")
end

#simple_user=(value) ⇒ Object 



391
392
393
394
 
# File 'datasync/cfn_location_hdfs.rb', line 391

def simple_user=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "simpleUser") unless value.nil?
  jsii_set_property("simpleUser", value)
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_hdfs.rb', line 125

def stack()
  jsii_get_property("stack")
end

#subdirectory ⇒ String?

A subdirectory in the HDFS cluster.

Returns:

  • (String, nil) 


399
400
401
 
# File 'datasync/cfn_location_hdfs.rb', line 399

def subdirectory()
  jsii_get_property("subdirectory")
end

#subdirectory=(value) ⇒ Object 



403
404
405
406
 
# File 'datasync/cfn_location_hdfs.rb', line 403

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:



233
234
235
 
# File 'datasync/cfn_location_hdfs.rb', line 233

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Array<AWSCDK::CfnTag>?

The key-value pair that represents the tag that you want to add to the location.

Returns:



411
412
413
 
# File 'datasync/cfn_location_hdfs.rb', line 411

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



415
416
417
418
419
 
# File 'datasync/cfn_location_hdfs.rb', line 415

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



424
425
426
 
# File 'datasync/cfn_location_hdfs.rb', line 424

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_hdfs.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_hdfs.rb', line 182

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


698
699
700
701
 
# File 'datasync/cfn_location_hdfs.rb', line 698

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) 


437
438
439
440
441
442
 
# File 'datasync/cfn_location_hdfs.rb', line 437

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