Class: AWSCDK::Datasync::CfnLocationObjectStorage

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

Overview

The AWS::DataSync::LocationObjectStorage resource specifies an endpoint for a self-managed object storage bucket.

For more information about self-managed object storage locations, see Creating a Location for Object Storage .

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

Create a new AWS::DataSync::LocationObjectStorage.

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

    Resource properties.



20
21
22
23
24
25
26
 
# File 'datasync/cfn_location_object_storage.rb', line 20

def initialize(scope, id, props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::Datasync::CfnLocationObjectStorageProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZGF0YXN5bmMuQ2ZuTG9jYXRpb25PYmplY3RTdG9yYWdlUHJvcHMifQ==")), "props") unless props.nil?
  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) 


188
189
190
 
# File 'datasync/cfn_location_object_storage.rb', line 188

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

.is_cfn_location_object_storage(x) ⇒ Boolean

Checks whether the given object is a CfnLocationObjectStorage.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


90
91
92
93
 
# File 'datasync/cfn_location_object_storage.rb', line 90

def self.is_cfn_location_object_storage(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_datasync.CfnLocationObjectStorage", "isCfnLocationObjectStorage", [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
 
# File 'datasync/cfn_location_object_storage.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_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_object_storage_ref => { kind: :property, name: "locationObjectStorageRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :access_key => { kind: :property, name: "accessKey", is_optional: true },
    :agent_arns => { kind: :property, name: "agentArns", is_optional: true },
    :bucket_name => { kind: :property, name: "bucketName", is_optional: true },
    :cmk_secret_config => { kind: :property, name: "cmkSecretConfig", is_optional: true },
    :custom_secret_config => { kind: :property, name: "customSecretConfig", is_optional: true },
    :secret_key => { kind: :property, name: "secretKey", is_optional: true },
    :server_certificate => { kind: :property, name: "serverCertificate", is_optional: true },
    :server_hostname => { kind: :property, name: "serverHostname", is_optional: true },
    :server_port => { kind: :property, name: "serverPort", is_optional: true },
    :server_protocol => { kind: :property, name: "serverProtocol", 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

#access_key ⇒ String?

Specifies the access key (for example, a user name) if credentials are required to authenticate with the object storage server.

Returns:

  • (String, nil) 


241
242
243
 
# File 'datasync/cfn_location_object_storage.rb', line 241

def access_key()
  jsii_get_property("accessKey")
end

#access_key=(value) ⇒ Object 



245
246
247
248
 
# File 'datasync/cfn_location_object_storage.rb', line 245

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

#add_deletion_override(path) ⇒ void

This method returns an undefined value.

Syntactic sugar for addOverride(path, undefined).

Parameters:

  • path (String) —

    The path of the value to delete.



421
422
423
424
 
# File 'datasync/cfn_location_object_storage.rb', line 421

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:



433
434
435
436
 
# File 'datasync/cfn_location_object_storage.rb', line 433

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:



443
444
445
446
 
# File 'datasync/cfn_location_object_storage.rb', line 443

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:



454
455
456
457
458
 
# File 'datasync/cfn_location_object_storage.rb', line 454

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.


511
512
513
514
515
 
# File 'datasync/cfn_location_object_storage.rb', line 511

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.



521
522
523
524
 
# File 'datasync/cfn_location_object_storage.rb', line 521

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.



533
534
535
536
537
 
# File 'datasync/cfn_location_object_storage.rb', line 533

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>?

(Optional) Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can connect with your object storage system.

Returns:

  • (Array<String>, nil) 


253
254
255
 
# File 'datasync/cfn_location_object_storage.rb', line 253

def agent_arns()
  jsii_get_property("agentArns")
end

#agent_arns=(value) ⇒ Object 



257
258
259
260
 
# File 'datasync/cfn_location_object_storage.rb', line 257

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



546
547
548
549
 
# File 'datasync/cfn_location_object_storage.rb', line 546

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:



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

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) 


197
198
199
 
# File 'datasync/cfn_location_object_storage.rb', line 197

def attr_cmk_secret_config_secret_arn()
  jsii_get_property("attrCmkSecretConfigSecretArn")
end

#attr_location_arn ⇒ String

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

Returns:

  • (String) 


204
205
206
 
# File 'datasync/cfn_location_object_storage.rb', line 204

def attr_location_arn()
  jsii_get_property("attrLocationArn")
end

#attr_location_uri ⇒ String

The URI of the specified object storage location.

Returns:

  • (String) 


211
212
213
 
# File 'datasync/cfn_location_object_storage.rb', line 211

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:



220
221
222
 
# File 'datasync/cfn_location_object_storage.rb', line 220

def attr_managed_secret_config()
  jsii_get_property("attrManagedSecretConfig")
end

#bucket_name ⇒ String?

Specifies the name of the object storage bucket involved in the transfer.

Returns:

  • (String, nil) 


265
266
267
 
# File 'datasync/cfn_location_object_storage.rb', line 265

def bucket_name()
  jsii_get_property("bucketName")
end

#bucket_name=(value) ⇒ Object 



269
270
271
272
 
# File 'datasync/cfn_location_object_storage.rb', line 269

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

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



141
142
143
 
# File 'datasync/cfn_location_object_storage.rb', line 141

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


146
147
148
 
# File 'datasync/cfn_location_object_storage.rb', line 146

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


577
578
579
580
 
# File 'datasync/cfn_location_object_storage.rb', line 577

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


151
152
153
 
# File 'datasync/cfn_location_object_storage.rb', line 151

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


158
159
160
 
# File 'datasync/cfn_location_object_storage.rb', line 158

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#cmk_secret_config ⇒ AWSCDK::IResolvable, ...

Specifies configuration information for a DataSync-managed secret, which includes the SecretKey that DataSync uses to access a specific object storage location, with a customer-managed AWS KMS key .

Returns:



277
278
279
 
# File 'datasync/cfn_location_object_storage.rb', line 277

def cmk_secret_config()
  jsii_get_property("cmkSecretConfig")
end

#cmk_secret_config=(value) ⇒ Object 



281
282
283
284
285
 
# File 'datasync/cfn_location_object_storage.rb', line 281

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

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


103
104
105
 
# File 'datasync/cfn_location_object_storage.rb', line 103

def creation_stack()
  jsii_get_property("creationStack")
end

#custom_secret_config ⇒ AWSCDK::IResolvable, ...

Specifies configuration information for a customer-managed Secrets Manager secret where the secret key for a specific object storage location is stored in plain text, in Secrets Manager.

Returns:



290
291
292
 
# File 'datasync/cfn_location_object_storage.rb', line 290

def custom_secret_config()
  jsii_get_property("customSecretConfig")
end

#custom_secret_config=(value) ⇒ Object 



294
295
296
297
298
 
# File 'datasync/cfn_location_object_storage.rb', line 294

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

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



163
164
165
 
# File 'datasync/cfn_location_object_storage.rb', line 163

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:



590
591
592
593
594
 
# File 'datasync/cfn_location_object_storage.rb', line 590

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:



601
602
603
604
 
# File 'datasync/cfn_location_object_storage.rb', line 601

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:



671
672
673
674
 
# File 'datasync/cfn_location_object_storage.rb', line 671

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

#location_object_storage_ref ⇒ AWSCDK::Interfaces::AWSDatasync::LocationObjectStorageReference

A reference to a LocationObjectStorage resource.

Returns:



227
228
229
 
# File 'datasync/cfn_location_object_storage.rb', line 227

def location_object_storage_ref()
  jsii_get_property("locationObjectStorageRef")
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) 


115
116
117
 
# File 'datasync/cfn_location_object_storage.rb', line 115

def logical_id()
  jsii_get_property("logicalId")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


98
99
100
 
# File 'datasync/cfn_location_object_storage.rb', line 98

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:



612
613
614
 
# File 'datasync/cfn_location_object_storage.rb', line 612

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:



619
620
621
 
# File 'datasync/cfn_location_object_storage.rb', line 619

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.



412
413
414
415
 
# File 'datasync/cfn_location_object_storage.rb', line 412

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

#ref ⇒ String

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

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

Returns:

  • (String) 


134
135
136
 
# File 'datasync/cfn_location_object_storage.rb', line 134

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:



630
631
632
633
 
# File 'datasync/cfn_location_object_storage.rb', line 630

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


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

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:



647
648
649
650
651
 
# File 'datasync/cfn_location_object_storage.rb', line 647

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

#secret_key ⇒ String?

Specifies the secret key (for example, a password) if credentials are required to authenticate with the object storage server.

Returns:

  • (String, nil) 


303
304
305
 
# File 'datasync/cfn_location_object_storage.rb', line 303

def secret_key()
  jsii_get_property("secretKey")
end

#secret_key=(value) ⇒ Object 



307
308
309
310
 
# File 'datasync/cfn_location_object_storage.rb', line 307

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

#server_certificate ⇒ String?

Specifies a certificate chain for DataSync to authenticate with your object storage system if the system uses a private or self-signed certificate authority (CA).

Returns:

  • (String, nil) 


315
316
317
 
# File 'datasync/cfn_location_object_storage.rb', line 315

def server_certificate()
  jsii_get_property("serverCertificate")
end

#server_certificate=(value) ⇒ Object 



319
320
321
322
 
# File 'datasync/cfn_location_object_storage.rb', line 319

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

#server_hostname ⇒ String?

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

Returns:

  • (String, nil) 


327
328
329
 
# File 'datasync/cfn_location_object_storage.rb', line 327

def server_hostname()
  jsii_get_property("serverHostname")
end

#server_hostname=(value) ⇒ Object 



331
332
333
334
 
# File 'datasync/cfn_location_object_storage.rb', line 331

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

#server_port ⇒ Numeric?

Specifies the port that your object storage server accepts inbound network traffic on (for example, port 443).

Returns:

  • (Numeric, nil) 


339
340
341
 
# File 'datasync/cfn_location_object_storage.rb', line 339

def server_port()
  jsii_get_property("serverPort")
end

#server_port=(value) ⇒ Object 



343
344
345
346
 
# File 'datasync/cfn_location_object_storage.rb', line 343

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

#server_protocol ⇒ String?

Specifies the protocol that your object storage server uses to communicate.

Returns:

  • (String, nil) 


351
352
353
 
# File 'datasync/cfn_location_object_storage.rb', line 351

def server_protocol()
  jsii_get_property("serverProtocol")
end

#server_protocol=(value) ⇒ Object 



355
356
357
358
 
# File 'datasync/cfn_location_object_storage.rb', line 355

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



656
657
658
 
# File 'datasync/cfn_location_object_storage.rb', line 656

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:



124
125
126
 
# File 'datasync/cfn_location_object_storage.rb', line 124

def stack()
  jsii_get_property("stack")
end

#subdirectory ⇒ String?

Specifies the object prefix for your object storage server.

Returns:

  • (String, nil) 


363
364
365
 
# File 'datasync/cfn_location_object_storage.rb', line 363

def subdirectory()
  jsii_get_property("subdirectory")
end

#subdirectory=(value) ⇒ Object 



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

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:



234
235
236
 
# File 'datasync/cfn_location_object_storage.rb', line 234

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Array<AWSCDK::CfnTag>?

Specifies the key-value pair that represents a tag that you want to add to the resource.

Returns:



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

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



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

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



388
389
390
 
# File 'datasync/cfn_location_object_storage.rb', line 388

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


171
172
173
 
# File 'datasync/cfn_location_object_storage.rb', line 171

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


181
182
183
 
# File 'datasync/cfn_location_object_storage.rb', line 181

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


662
663
664
665
 
# File 'datasync/cfn_location_object_storage.rb', line 662

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) 


401
402
403
404
405
406
 
# File 'datasync/cfn_location_object_storage.rb', line 401

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