Class: AWSCDK::Datasync::CfnTask

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

Overview

The AWS::DataSync::Task resource specifies a task.

A task is a set of two locations (source and destination) and a set of Options that you use to control the behavior of a task. If you don't specify Options when you create a task, AWS DataSync populates them with service defaults.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnTask

Create a new AWS::DataSync::Task.

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

    Resource properties.



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

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

Class Method Details

.arn_for_task(resource) ⇒ String

Parameters:

Returns:

  • (String) 


88
89
90
91
 
# File 'datasync/cfn_task.rb', line 88

def self.arn_for_task(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19kYXRhc3luYy5JVGFza1JlZiJ9")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_datasync.CfnTask", "arnForTask", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


195
196
197
 
# File 'datasync/cfn_task.rb', line 195

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

.is_cfn_task(x) ⇒ Boolean

Checks whether the given object is a CfnTask.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


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

def self.is_cfn_task(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_datasync.CfnTask", "isCfnTask", [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_task.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_destination_network_interface_arns => { kind: :property, name: "attrDestinationNetworkInterfaceArns", is_optional: false },
    :attr_source_network_interface_arns => { kind: :property, name: "attrSourceNetworkInterfaceArns", is_optional: false },
    :attr_status => { kind: :property, name: "attrStatus", is_optional: false },
    :attr_task_arn => { kind: :property, name: "attrTaskArn", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :task_ref => { kind: :property, name: "taskRef", is_optional: false },
    :destination_location_arn => { kind: :property, name: "destinationLocationArn", is_optional: false },
    :source_location_arn => { kind: :property, name: "sourceLocationArn", is_optional: false },
    :cloud_watch_log_group_arn => { kind: :property, name: "cloudWatchLogGroupArn", is_optional: true },
    :excludes => { kind: :property, name: "excludes", is_optional: true },
    :includes => { kind: :property, name: "includes", is_optional: true },
    :manifest_config => { kind: :property, name: "manifestConfig", is_optional: true },
    :name => { kind: :property, name: "name", is_optional: true },
    :options => { kind: :property, name: "options", is_optional: true },
    :schedule => { kind: :property, name: "schedule", is_optional: true },
    :tags_raw => { kind: :property, name: "tagsRaw", is_optional: true },
    :task_mode => { kind: :property, name: "taskMode", is_optional: true },
    :task_report_config => { kind: :property, name: "taskReportConfig", 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.



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

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:



438
439
440
441
 
# File 'datasync/cfn_task.rb', line 438

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:



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

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:



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

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.


516
517
518
519
520
 
# File 'datasync/cfn_task.rb', line 516

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.



526
527
528
529
 
# File 'datasync/cfn_task.rb', line 526

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.



538
539
540
541
542
 
# File 'datasync/cfn_task.rb', line 538

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

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Sets the cross-stack reference strength for this resource.

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

Parameters:



551
552
553
554
 
# File 'datasync/cfn_task.rb', line 551

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:



573
574
575
576
577
578
 
# File 'datasync/cfn_task.rb', line 573

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_destination_network_interface_arns ⇒ Array<String>

The ARNs of the destination elastic network interfaces (ENIs) that were created for your subnet.

Returns:

  • (Array<String>) 


202
203
204
 
# File 'datasync/cfn_task.rb', line 202

def attr_destination_network_interface_arns()
  jsii_get_property("attrDestinationNetworkInterfaceArns")
end

#attr_source_network_interface_arns ⇒ Array<String>

The ARNs of the source ENIs that were created for your subnet.

Returns:

  • (Array<String>) 


209
210
211
 
# File 'datasync/cfn_task.rb', line 209

def attr_source_network_interface_arns()
  jsii_get_property("attrSourceNetworkInterfaceArns")
end

#attr_status ⇒ String

The status of the task that was described.

Returns:

  • (String) 


216
217
218
 
# File 'datasync/cfn_task.rb', line 216

def attr_status()
  jsii_get_property("attrStatus")
end

#attr_task_arn ⇒ String

The ARN of the task.

Returns:

  • (String) 


223
224
225
 
# File 'datasync/cfn_task.rb', line 223

def attr_task_arn()
  jsii_get_property("attrTaskArn")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



148
149
150
 
# File 'datasync/cfn_task.rb', line 148

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


153
154
155
 
# File 'datasync/cfn_task.rb', line 153

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


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

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


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

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


165
166
167
 
# File 'datasync/cfn_task.rb', line 165

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#cloud_watch_log_group_arn ⇒ String?

Specifies the Amazon Resource Name (ARN) of an Amazon CloudWatch log group for monitoring your task.

Returns:

  • (String, nil) 


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

def cloud_watch_log_group_arn()
  jsii_get_property("cloudWatchLogGroupArn")
end

#cloud_watch_log_group_arn=(value) ⇒ Object 



272
273
274
275
 
# File 'datasync/cfn_task.rb', line 272

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

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


110
111
112
 
# File 'datasync/cfn_task.rb', line 110

def creation_stack()
  jsii_get_property("creationStack")
end

#destination_location_arn ⇒ String

The Amazon Resource Name (ARN) of an AWS storage resource's location.

Returns:

  • (String) 


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

def destination_location_arn()
  jsii_get_property("destinationLocationArn")
end

#destination_location_arn=(value) ⇒ Object 



248
249
250
251
 
# File 'datasync/cfn_task.rb', line 248

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

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



170
171
172
 
# File 'datasync/cfn_task.rb', line 170

def env()
  jsii_get_property("env")
end

#excludes ⇒ AWSCDK::IResolvable, ...

Specifies exclude filters that define the files, objects, and folders in your source location that you don't want DataSync to transfer.

Returns:



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

def excludes()
  jsii_get_property("excludes")
end

#excludes=(value) ⇒ Object 



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

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



595
596
597
598
599
 
# File 'datasync/cfn_task.rb', line 595

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:



606
607
608
609
 
# File 'datasync/cfn_task.rb', line 606

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

#includes ⇒ AWSCDK::IResolvable, ...

Specifies include filters that define the files, objects, and folders in your source location that you want DataSync to transfer.

Returns:



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

def includes()
  jsii_get_property("includes")
end

#includes=(value) ⇒ Object 



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

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

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



676
677
678
679
 
# File 'datasync/cfn_task.rb', line 676

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
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) 


122
123
124
 
# File 'datasync/cfn_task.rb', line 122

def logical_id()
  jsii_get_property("logicalId")
end

#manifest_config ⇒ AWSCDK::IResolvable, ...

The configuration of the manifest that lists the files or objects that you want DataSync to transfer.

Returns:



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

def manifest_config()
  jsii_get_property("manifestConfig")
end

#manifest_config=(value) ⇒ Object 



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

def manifest_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Datasync::CfnTask::ManifestConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19kYXRhc3luYy5DZm5UYXNrLk1hbmlmZXN0Q29uZmlnUHJvcGVydHkifV19fQ==")), "manifestConfig") unless value.nil?
  jsii_set_property("manifestConfig", value)
end

#name ⇒ String?

Specifies the name of your task.

Returns:

  • (String, nil) 


317
318
319
 
# File 'datasync/cfn_task.rb', line 317

def name()
  jsii_get_property("name")
end

#name=(value) ⇒ Object 



321
322
323
324
 
# File 'datasync/cfn_task.rb', line 321

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

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


105
106
107
 
# File 'datasync/cfn_task.rb', line 105

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:



617
618
619
 
# File 'datasync/cfn_task.rb', line 617

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:



624
625
626
 
# File 'datasync/cfn_task.rb', line 624

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

#options ⇒ AWSCDK::IResolvable, ...

Specifies your task's settings, such as preserving file metadata, verifying data integrity, among other options.

Returns:



329
330
331
 
# File 'datasync/cfn_task.rb', line 329

def options()
  jsii_get_property("options")
end

#options=(value) ⇒ Object 



333
334
335
336
337
 
# File 'datasync/cfn_task.rb', line 333

def options=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Datasync::CfnTask::OptionsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19kYXRhc3luYy5DZm5UYXNrLk9wdGlvbnNQcm9wZXJ0eSJ9XX19")), "options") unless value.nil?
  jsii_set_property("options", value)
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.



417
418
419
420
 
# File 'datasync/cfn_task.rb', line 417

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) 


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

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:



635
636
637
638
 
# File 'datasync/cfn_task.rb', line 635

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


642
643
644
645
 
# File 'datasync/cfn_task.rb', line 642

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:



652
653
654
655
656
 
# File 'datasync/cfn_task.rb', line 652

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

#schedule ⇒ AWSCDK::IResolvable, ...

Specifies a schedule for when you want your task to run.

Returns:



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

def schedule()
  jsii_get_property("schedule")
end

#schedule=(value) ⇒ Object 



346
347
348
349
350
 
# File 'datasync/cfn_task.rb', line 346

def schedule=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Datasync::CfnTask::TaskScheduleProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19kYXRhc3luYy5DZm5UYXNrLlRhc2tTY2hlZHVsZVByb3BlcnR5In1dfX0=")), "schedule") unless value.nil?
  jsii_set_property("schedule", 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.



661
662
663
 
# File 'datasync/cfn_task.rb', line 661

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

#source_location_arn ⇒ String

Specifies the ARN of your transfer's source location.

Returns:

  • (String) 


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

def source_location_arn()
  jsii_get_property("sourceLocationArn")
end

#source_location_arn=(value) ⇒ Object 



260
261
262
263
 
# File 'datasync/cfn_task.rb', line 260

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



131
132
133
 
# File 'datasync/cfn_task.rb', line 131

def stack()
  jsii_get_property("stack")
end

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



230
231
232
 
# File 'datasync/cfn_task.rb', line 230

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Array<AWSCDK::CfnTag>?

Specifies the tags that you want to apply to your task.

Returns:



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

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



359
360
361
362
363
 
# File 'datasync/cfn_task.rb', line 359

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

#task_mode ⇒ String?

The task mode that you're using.

Returns:

  • (String, nil) 


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

def task_mode()
  jsii_get_property("taskMode")
end

#task_mode=(value) ⇒ Object 



372
373
374
375
 
# File 'datasync/cfn_task.rb', line 372

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

#task_ref ⇒ AWSCDK::Interfaces::AWSDatasync::TaskReference

A reference to a Task resource.

Returns:



237
238
239
 
# File 'datasync/cfn_task.rb', line 237

def task_ref()
  jsii_get_property("taskRef")
end

#task_report_config ⇒ AWSCDK::IResolvable, ...

The configuration of your task report, which provides detailed information about your DataSync transfer.

Returns:



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

def task_report_config()
  jsii_get_property("taskReportConfig")
end

#task_report_config=(value) ⇒ Object 



384
385
386
387
388
 
# File 'datasync/cfn_task.rb', line 384

def task_report_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Datasync::CfnTask::TaskReportConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19kYXRhc3luYy5DZm5UYXNrLlRhc2tSZXBvcnRDb25maWdQcm9wZXJ0eSJ9XX19")), "taskReportConfig") unless value.nil?
  jsii_set_property("taskReportConfig", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



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

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


178
179
180
 
# File 'datasync/cfn_task.rb', line 178

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


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

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


667
668
669
670
 
# File 'datasync/cfn_task.rb', line 667

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) 


406
407
408
409
410
411
 
# File 'datasync/cfn_task.rb', line 406

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