Class: AWSCDK::SSM::CfnMaintenanceWindowTask

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, Interfaces::AWSSSM::IMaintenanceWindowTaskRef
Defined in:
ssm/cfn_maintenance_window_task.rb

Overview

The AWS::SSM::MaintenanceWindowTask resource defines information about a task for an AWS Systems Manager maintenance window.

For more information, see RegisterTaskWithMaintenanceWindow in the AWS Systems Manager API Reference .

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnMaintenanceWindowTask

Create a new AWS::SSM::MaintenanceWindowTask.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

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

  • props (AWSCDK::SSM::CfnMaintenanceWindowTaskProps) —

    Resource properties.



19
20
21
22
23
24
25
 
# File 'ssm/cfn_maintenance_window_task.rb', line 19

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

Class Method Details

.arn_for_maintenance_window_task(resource) ⇒ String

Parameters:

Returns:

  • (String) 


85
86
87
88
 
# File 'ssm/cfn_maintenance_window_task.rb', line 85

def self.arn_for_maintenance_window_task(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19zc20uSU1haW50ZW5hbmNlV2luZG93VGFza1JlZiJ9")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ssm.CfnMaintenanceWindowTask", "arnForMaintenanceWindowTask", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


192
193
194
 
# File 'ssm/cfn_maintenance_window_task.rb', line 192

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

.is_cfn_maintenance_window_task(x) ⇒ Boolean

Checks whether the given object is a CfnMaintenanceWindowTask.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


94
95
96
97
 
# File 'ssm/cfn_maintenance_window_task.rb', line 94

def self.is_cfn_maintenance_window_task(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ssm.CfnMaintenanceWindowTask", "isCfnMaintenanceWindowTask", [x])
end

.jsii_overridable_methods ⇒ Object 



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
 
# File 'ssm/cfn_maintenance_window_task.rb', line 27

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_window_task_id => { kind: :property, name: "attrWindowTaskId", is_optional: false },
    :maintenance_window_task_ref => { kind: :property, name: "maintenanceWindowTaskRef", is_optional: false },
    :priority => { kind: :property, name: "priority", is_optional: false },
    :task_arn => { kind: :property, name: "taskArn", is_optional: false },
    :task_parameters => { kind: :property, name: "taskParameters", is_optional: false },
    :task_type => { kind: :property, name: "taskType", is_optional: false },
    :window_id => { kind: :property, name: "windowId", is_optional: false },
    :cutoff_behavior => { kind: :property, name: "cutoffBehavior", is_optional: true },
    :description => { kind: :property, name: "description", is_optional: true },
    :logging_info => { kind: :property, name: "loggingInfo", is_optional: true },
    :max_concurrency => { kind: :property, name: "maxConcurrency", is_optional: true },
    :max_errors => { kind: :property, name: "maxErrors", is_optional: true },
    :name => { kind: :property, name: "name", is_optional: true },
    :service_role_arn => { kind: :property, name: "serviceRoleArn", is_optional: true },
    :targets => { kind: :property, name: "targets", is_optional: true },
    :task_invocation_parameters => { kind: :property, name: "taskInvocationParameters", 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.



416
417
418
419
 
# File 'ssm/cfn_maintenance_window_task.rb', line 416

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:



428
429
430
431
 
# File 'ssm/cfn_maintenance_window_task.rb', line 428

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:



438
439
440
441
 
# File 'ssm/cfn_maintenance_window_task.rb', line 438

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:



449
450
451
452
453
 
# File 'ssm/cfn_maintenance_window_task.rb', line 449

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.


506
507
508
509
510
 
# File 'ssm/cfn_maintenance_window_task.rb', line 506

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.



516
517
518
519
 
# File 'ssm/cfn_maintenance_window_task.rb', line 516

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.



528
529
530
531
532
 
# File 'ssm/cfn_maintenance_window_task.rb', line 528

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:



541
542
543
544
 
# File 'ssm/cfn_maintenance_window_task.rb', line 541

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:



563
564
565
566
567
568
 
# File 'ssm/cfn_maintenance_window_task.rb', line 563

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

The task ID.

Returns:

  • (String) 


199
200
201
 
# File 'ssm/cfn_maintenance_window_task.rb', line 199

def attr_window_task_id()
  jsii_get_property("attrWindowTaskId")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



145
146
147
 
# File 'ssm/cfn_maintenance_window_task.rb', line 145

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


150
151
152
 
# File 'ssm/cfn_maintenance_window_task.rb', line 150

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


572
573
574
575
 
# File 'ssm/cfn_maintenance_window_task.rb', line 572

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


155
156
157
 
# File 'ssm/cfn_maintenance_window_task.rb', line 155

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


162
163
164
 
# File 'ssm/cfn_maintenance_window_task.rb', line 162

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


107
108
109
 
# File 'ssm/cfn_maintenance_window_task.rb', line 107

def creation_stack()
  jsii_get_property("creationStack")
end

#cutoff_behavior ⇒ String?

The specification for whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached.

Returns:

  • (String, nil) 


273
274
275
 
# File 'ssm/cfn_maintenance_window_task.rb', line 273

def cutoff_behavior()
  jsii_get_property("cutoffBehavior")
end

#cutoff_behavior=(value) ⇒ Object 



277
278
279
280
 
# File 'ssm/cfn_maintenance_window_task.rb', line 277

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

#description ⇒ String?

A description of the task.

Returns:

  • (String, nil) 


285
286
287
 
# File 'ssm/cfn_maintenance_window_task.rb', line 285

def description()
  jsii_get_property("description")
end

#description=(value) ⇒ Object 



289
290
291
292
 
# File 'ssm/cfn_maintenance_window_task.rb', line 289

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

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



167
168
169
 
# File 'ssm/cfn_maintenance_window_task.rb', line 167

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:



585
586
587
588
589
 
# File 'ssm/cfn_maintenance_window_task.rb', line 585

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:



596
597
598
599
 
# File 'ssm/cfn_maintenance_window_task.rb', line 596

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:



666
667
668
669
 
# File 'ssm/cfn_maintenance_window_task.rb', line 666

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

#logging_info ⇒ AWSCDK::IResolvable, ...

LoggingInfo has been deprecated.

Returns:



297
298
299
 
# File 'ssm/cfn_maintenance_window_task.rb', line 297

def logging_info()
  jsii_get_property("loggingInfo")
end

#logging_info=(value) ⇒ Object 



301
302
303
304
305
 
# File 'ssm/cfn_maintenance_window_task.rb', line 301

def logging_info=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::SSM::CfnMaintenanceWindowTask::LoggingInfoProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zc20uQ2ZuTWFpbnRlbmFuY2VXaW5kb3dUYXNrLkxvZ2dpbmdJbmZvUHJvcGVydHkifV19fQ==")), "loggingInfo") unless value.nil?
  jsii_set_property("loggingInfo", value)
end

#logical_id ⇒ String

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use override_logical_id(new_logical_id).

Returns:

  • (String) 


119
120
121
 
# File 'ssm/cfn_maintenance_window_task.rb', line 119

def logical_id()
  jsii_get_property("logicalId")
end

#maintenance_window_task_ref ⇒ AWSCDK::Interfaces::AWSSSM::MaintenanceWindowTaskReference

A reference to a MaintenanceWindowTask resource.

Returns:



206
207
208
 
# File 'ssm/cfn_maintenance_window_task.rb', line 206

def maintenance_window_task_ref()
  jsii_get_property("maintenanceWindowTaskRef")
end

#max_concurrency ⇒ String?

The maximum number of targets this task can be run for, in parallel.

Returns:

  • (String, nil) 


310
311
312
 
# File 'ssm/cfn_maintenance_window_task.rb', line 310

def max_concurrency()
  jsii_get_property("maxConcurrency")
end

#max_concurrency=(value) ⇒ Object 



314
315
316
317
 
# File 'ssm/cfn_maintenance_window_task.rb', line 314

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

#max_errors ⇒ String?

The maximum number of errors allowed before this task stops being scheduled.

Returns:

  • (String, nil) 


322
323
324
 
# File 'ssm/cfn_maintenance_window_task.rb', line 322

def max_errors()
  jsii_get_property("maxErrors")
end

#max_errors=(value) ⇒ Object 



326
327
328
329
 
# File 'ssm/cfn_maintenance_window_task.rb', line 326

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

#name ⇒ String?

The task name.

Returns:

  • (String, nil) 


334
335
336
 
# File 'ssm/cfn_maintenance_window_task.rb', line 334

def name()
  jsii_get_property("name")
end

#name=(value) ⇒ Object 



338
339
340
341
 
# File 'ssm/cfn_maintenance_window_task.rb', line 338

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) 


102
103
104
 
# File 'ssm/cfn_maintenance_window_task.rb', line 102

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:



607
608
609
 
# File 'ssm/cfn_maintenance_window_task.rb', line 607

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:



614
615
616
 
# File 'ssm/cfn_maintenance_window_task.rb', line 614

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.



407
408
409
410
 
# File 'ssm/cfn_maintenance_window_task.rb', line 407

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

#priority ⇒ Numeric

The priority of the task in the maintenance window.

Returns:

  • (Numeric) 


213
214
215
 
# File 'ssm/cfn_maintenance_window_task.rb', line 213

def priority()
  jsii_get_property("priority")
end

#priority=(value) ⇒ Object 



217
218
219
220
 
# File 'ssm/cfn_maintenance_window_task.rb', line 217

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


138
139
140
 
# File 'ssm/cfn_maintenance_window_task.rb', line 138

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:



625
626
627
628
 
# File 'ssm/cfn_maintenance_window_task.rb', line 625

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


632
633
634
635
 
# File 'ssm/cfn_maintenance_window_task.rb', line 632

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:



642
643
644
645
646
 
# File 'ssm/cfn_maintenance_window_task.rb', line 642

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

#service_role_arn ⇒ String?

The Amazon Resource Name (ARN) of the IAM service role for AWS Systems Manager to assume when running a maintenance window task.

Returns:

  • (String, nil) 


346
347
348
 
# File 'ssm/cfn_maintenance_window_task.rb', line 346

def service_role_arn()
  jsii_get_property("serviceRoleArn")
end

#service_role_arn=(value) ⇒ Object 



350
351
352
353
 
# File 'ssm/cfn_maintenance_window_task.rb', line 350

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



651
652
653
 
# File 'ssm/cfn_maintenance_window_task.rb', line 651

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:



128
129
130
 
# File 'ssm/cfn_maintenance_window_task.rb', line 128

def stack()
  jsii_get_property("stack")
end

#targets ⇒ AWSCDK::IResolvable, ...

The targets, either instances or window target IDs.

Returns:



358
359
360
 
# File 'ssm/cfn_maintenance_window_task.rb', line 358

def targets()
  jsii_get_property("targets")
end

#targets=(value) ⇒ Object 



362
363
364
365
 
# File 'ssm/cfn_maintenance_window_task.rb', line 362

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

#task_arn ⇒ String

The resource that the task uses during execution.

Returns:

  • (String) 


225
226
227
 
# File 'ssm/cfn_maintenance_window_task.rb', line 225

def task_arn()
  jsii_get_property("taskArn")
end

#task_arn=(value) ⇒ Object 



229
230
231
232
 
# File 'ssm/cfn_maintenance_window_task.rb', line 229

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

#task_invocation_parameters ⇒ AWSCDK::IResolvable, ...

The parameters to pass to the task when it runs.

Returns:



370
371
372
 
# File 'ssm/cfn_maintenance_window_task.rb', line 370

def task_invocation_parameters()
  jsii_get_property("taskInvocationParameters")
end

#task_invocation_parameters=(value) ⇒ Object 



374
375
376
377
378
 
# File 'ssm/cfn_maintenance_window_task.rb', line 374

def task_invocation_parameters=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::SSM::CfnMaintenanceWindowTask::TaskInvocationParametersProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zc20uQ2ZuTWFpbnRlbmFuY2VXaW5kb3dUYXNrLlRhc2tJbnZvY2F0aW9uUGFyYW1ldGVyc1Byb3BlcnR5In1dfX0=")), "taskInvocationParameters") unless value.nil?
  jsii_set_property("taskInvocationParameters", value)
end

#task_parameters ⇒ Object

TaskParameters has been deprecated.

Returns:

  • (Object) 


237
238
239
 
# File 'ssm/cfn_maintenance_window_task.rb', line 237

def task_parameters()
  jsii_get_property("taskParameters")
end

#task_parameters=(value) ⇒ Object 



241
242
243
244
 
# File 'ssm/cfn_maintenance_window_task.rb', line 241

def task_parameters=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "taskParameters")
  jsii_set_property("taskParameters", value)
end

#task_type ⇒ String

The type of task.

Returns:

  • (String) 


249
250
251
 
# File 'ssm/cfn_maintenance_window_task.rb', line 249

def task_type()
  jsii_get_property("taskType")
end

#task_type=(value) ⇒ Object 



253
254
255
256
 
# File 'ssm/cfn_maintenance_window_task.rb', line 253

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

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



383
384
385
 
# File 'ssm/cfn_maintenance_window_task.rb', line 383

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


175
176
177
 
# File 'ssm/cfn_maintenance_window_task.rb', line 175

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


185
186
187
 
# File 'ssm/cfn_maintenance_window_task.rb', line 185

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


657
658
659
660
 
# File 'ssm/cfn_maintenance_window_task.rb', line 657

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
end

#window_id ⇒ String

The ID of the maintenance window where the task is registered.

Returns:

  • (String) 


261
262
263
 
# File 'ssm/cfn_maintenance_window_task.rb', line 261

def window_id()
  jsii_get_property("windowId")
end

#window_id=(value) ⇒ Object 



265
266
267
268
 
# File 'ssm/cfn_maintenance_window_task.rb', line 265

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


396
397
398
399
400
401
 
# File 'ssm/cfn_maintenance_window_task.rb', line 396

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