Class: AWSCDK::SSM::CfnMaintenanceWindow

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggable, Interfaces::AWSSSM::IMaintenanceWindowRef
Defined in:
ssm/cfn_maintenance_window.rb

Overview

The AWS::SSM::MaintenanceWindow resource represents general information about a maintenance window for AWS Systems Manager .

Maintenance windows let you define a schedule for when to perform potentially disruptive actions on your instances, such as patching an operating system (OS), updating drivers, or installing software. Each maintenance window has a schedule, a duration, a set of registered targets, and a set of registered tasks.

For more information, see Systems Manager Maintenance Windows in the AWS Systems Manager User Guide and CreateMaintenanceWindow in the AWS Systems Manager API Reference .

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnMaintenanceWindow

Create a new AWS::SSM::MaintenanceWindow.

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

    Resource properties.



22
23
24
25
26
27
28
 
# File 'ssm/cfn_maintenance_window.rb', line 22

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

Class Method Details

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


186
187
188
 
# File 'ssm/cfn_maintenance_window.rb', line 186

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

.is_cfn_maintenance_window(x) ⇒ Boolean

Checks whether the given object is a CfnMaintenanceWindow.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


88
89
90
91
 
# File 'ssm/cfn_maintenance_window.rb', line 88

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

.jsii_overridable_methods ⇒ Object 



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

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_id => { kind: :property, name: "attrWindowId", is_optional: false },
    :maintenance_window_ref => { kind: :property, name: "maintenanceWindowRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :allow_unassociated_targets => { kind: :property, name: "allowUnassociatedTargets", is_optional: false },
    :cutoff => { kind: :property, name: "cutoff", is_optional: false },
    :duration => { kind: :property, name: "duration", is_optional: false },
    :name => { kind: :property, name: "name", is_optional: false },
    :schedule => { kind: :property, name: "schedule", is_optional: false },
    :description => { kind: :property, name: "description", is_optional: true },
    :end_date => { kind: :property, name: "endDate", is_optional: true },
    :schedule_offset => { kind: :property, name: "scheduleOffset", is_optional: true },
    :schedule_timezone => { kind: :property, name: "scheduleTimezone", is_optional: true },
    :start_date => { kind: :property, name: "startDate", is_optional: true },
    :tags_raw => { kind: :property, name: "tagsRaw", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :override_logical_id => { kind: :method, name: "overrideLogicalId", is_optional: false },
    :add_deletion_override => { kind: :method, name: "addDeletionOverride", is_optional: false },
    :add_dependency => { kind: :method, name: "addDependency", is_optional: false },
    :add_depends_on => { kind: :method, name: "addDependsOn", is_optional: false },
    :add_metadata => { kind: :method, name: "addMetadata", is_optional: false },
    :add_override => { kind: :method, name: "addOverride", is_optional: false },
    :add_property_deletion_override => { kind: :method, name: "addPropertyDeletionOverride", is_optional: false },
    :add_property_override => { kind: :method, name: "addPropertyOverride", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :cfn_property_name => { kind: :method, name: "cfnPropertyName", is_optional: false },
    :get_att => { kind: :method, name: "getAtt", is_optional: false },
    :get_metadata => { kind: :method, name: "getMetadata", is_optional: false },
    :obtain_dependencies => { kind: :method, name: "obtainDependencies", is_optional: false },
    :obtain_resource_dependencies => { kind: :method, name: "obtainResourceDependencies", is_optional: false },
    :remove_dependency => { kind: :method, name: "removeDependency", is_optional: false },
    :render_properties => { kind: :method, name: "renderProperties", is_optional: false },
    :replace_dependency => { kind: :method, name: "replaceDependency", is_optional: false },
    :should_synthesize => { kind: :method, name: "shouldSynthesize", is_optional: false },
    :validate_properties => { kind: :method, name: "validateProperties", is_optional: false },
    :inspect => { kind: :method, name: "inspect", is_optional: false },
  }
end

Instance Method Details

#add_deletion_override(path) ⇒ void

This method returns an undefined value.

Syntactic sugar for addOverride(path, undefined).

Parameters:

  • path (String) —

    The path of the value to delete.



380
381
382
383
 
# File 'ssm/cfn_maintenance_window.rb', line 380

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:



392
393
394
395
 
# File 'ssm/cfn_maintenance_window.rb', line 392

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:



402
403
404
405
 
# File 'ssm/cfn_maintenance_window.rb', line 402

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:



413
414
415
416
417
 
# File 'ssm/cfn_maintenance_window.rb', line 413

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.


470
471
472
473
474
 
# File 'ssm/cfn_maintenance_window.rb', line 470

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.



480
481
482
483
 
# File 'ssm/cfn_maintenance_window.rb', line 480

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.



492
493
494
495
496
 
# File 'ssm/cfn_maintenance_window.rb', line 492

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

#allow_unassociated_targets ⇒ Boolean, AWSCDK::IResolvable

Enables a maintenance window task to run on managed instances, even if you have not registered those instances as targets.

Returns:



214
215
216
 
# File 'ssm/cfn_maintenance_window.rb', line 214

def allow_unassociated_targets()
  jsii_get_property("allowUnassociatedTargets")
end

#allow_unassociated_targets=(value) ⇒ Object 



218
219
220
221
 
# File 'ssm/cfn_maintenance_window.rb', line 218

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



505
506
507
508
 
# File 'ssm/cfn_maintenance_window.rb', line 505

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:



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

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

The ID of the maintenance window.

Returns:

  • (String) 


193
194
195
 
# File 'ssm/cfn_maintenance_window.rb', line 193

def attr_window_id()
  jsii_get_property("attrWindowId")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



139
140
141
 
# File 'ssm/cfn_maintenance_window.rb', line 139

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


144
145
146
 
# File 'ssm/cfn_maintenance_window.rb', line 144

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


536
537
538
539
 
# File 'ssm/cfn_maintenance_window.rb', line 536

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


149
150
151
 
# File 'ssm/cfn_maintenance_window.rb', line 149

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


156
157
158
 
# File 'ssm/cfn_maintenance_window.rb', line 156

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


101
102
103
 
# File 'ssm/cfn_maintenance_window.rb', line 101

def creation_stack()
  jsii_get_property("creationStack")
end

#cutoff ⇒ Numeric

The number of hours before the end of the maintenance window that AWS Systems Manager stops scheduling new tasks for execution.

Returns:

  • (Numeric) 


226
227
228
 
# File 'ssm/cfn_maintenance_window.rb', line 226

def cutoff()
  jsii_get_property("cutoff")
end

#cutoff=(value) ⇒ Object 



230
231
232
233
 
# File 'ssm/cfn_maintenance_window.rb', line 230

def cutoff=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "cutoff")
  jsii_set_property("cutoff", value)
end

#description ⇒ String?

A description of the maintenance window.

Returns:

  • (String, nil) 


274
275
276
 
# File 'ssm/cfn_maintenance_window.rb', line 274

def description()
  jsii_get_property("description")
end

#description=(value) ⇒ Object 



278
279
280
281
 
# File 'ssm/cfn_maintenance_window.rb', line 278

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

#duration ⇒ Numeric

The duration of the maintenance window in hours.

Returns:

  • (Numeric) 


238
239
240
 
# File 'ssm/cfn_maintenance_window.rb', line 238

def duration()
  jsii_get_property("duration")
end

#duration=(value) ⇒ Object 



242
243
244
245
 
# File 'ssm/cfn_maintenance_window.rb', line 242

def duration=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "duration")
  jsii_set_property("duration", value)
end

#end_date ⇒ String?

The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become inactive.

Returns:

  • (String, nil) 


286
287
288
 
# File 'ssm/cfn_maintenance_window.rb', line 286

def end_date()
  jsii_get_property("endDate")
end

#end_date=(value) ⇒ Object 



290
291
292
293
 
# File 'ssm/cfn_maintenance_window.rb', line 290

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

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



161
162
163
 
# File 'ssm/cfn_maintenance_window.rb', line 161

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:



549
550
551
552
553
 
# File 'ssm/cfn_maintenance_window.rb', line 549

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:



560
561
562
563
 
# File 'ssm/cfn_maintenance_window.rb', line 560

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:



630
631
632
633
 
# File 'ssm/cfn_maintenance_window.rb', line 630

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) 


113
114
115
 
# File 'ssm/cfn_maintenance_window.rb', line 113

def logical_id()
  jsii_get_property("logicalId")
end

#maintenance_window_ref ⇒ AWSCDK::Interfaces::AWSSSM::MaintenanceWindowReference

A reference to a MaintenanceWindow resource.

Returns:



200
201
202
 
# File 'ssm/cfn_maintenance_window.rb', line 200

def maintenance_window_ref()
  jsii_get_property("maintenanceWindowRef")
end

#name ⇒ String

The name of the maintenance window.

Returns:

  • (String) 


250
251
252
 
# File 'ssm/cfn_maintenance_window.rb', line 250

def name()
  jsii_get_property("name")
end

#name=(value) ⇒ Object 



254
255
256
257
 
# File 'ssm/cfn_maintenance_window.rb', line 254

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

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


96
97
98
 
# File 'ssm/cfn_maintenance_window.rb', line 96

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:



571
572
573
 
# File 'ssm/cfn_maintenance_window.rb', line 571

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:



578
579
580
 
# File 'ssm/cfn_maintenance_window.rb', line 578

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.



371
372
373
374
 
# File 'ssm/cfn_maintenance_window.rb', line 371

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) 


132
133
134
 
# File 'ssm/cfn_maintenance_window.rb', line 132

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:



589
590
591
592
 
# File 'ssm/cfn_maintenance_window.rb', line 589

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


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

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:



606
607
608
609
610
 
# File 'ssm/cfn_maintenance_window.rb', line 606

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

The schedule of the maintenance window in the form of a cron or rate expression.

Returns:

  • (String) 


262
263
264
 
# File 'ssm/cfn_maintenance_window.rb', line 262

def schedule()
  jsii_get_property("schedule")
end

#schedule=(value) ⇒ Object 



266
267
268
269
 
# File 'ssm/cfn_maintenance_window.rb', line 266

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

#schedule_offset ⇒ Numeric?

The number of days to wait to run a maintenance window after the scheduled cron expression date and time.

Returns:

  • (Numeric, nil) 


298
299
300
 
# File 'ssm/cfn_maintenance_window.rb', line 298

def schedule_offset()
  jsii_get_property("scheduleOffset")
end

#schedule_offset=(value) ⇒ Object 



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

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

#schedule_timezone ⇒ String?

The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format.

Returns:

  • (String, nil) 


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

def schedule_timezone()
  jsii_get_property("scheduleTimezone")
end

#schedule_timezone=(value) ⇒ Object 



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

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



615
616
617
 
# File 'ssm/cfn_maintenance_window.rb', line 615

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:



122
123
124
 
# File 'ssm/cfn_maintenance_window.rb', line 122

def stack()
  jsii_get_property("stack")
end

#start_date ⇒ String?

The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become active.

Returns:

  • (String, nil) 


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

def start_date()
  jsii_get_property("startDate")
end

#start_date=(value) ⇒ Object 



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

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

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



207
208
209
 
# File 'ssm/cfn_maintenance_window.rb', line 207

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Array<AWSCDK::CfnTag>?

Optional metadata that you assign to a resource in the form of an arbitrary set of tags (key-value pairs).

Returns:



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

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



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

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



347
348
349
 
# File 'ssm/cfn_maintenance_window.rb', line 347

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


169
170
171
 
# File 'ssm/cfn_maintenance_window.rb', line 169

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


179
180
181
 
# File 'ssm/cfn_maintenance_window.rb', line 179

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


621
622
623
624
 
# File 'ssm/cfn_maintenance_window.rb', line 621

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) 


360
361
362
363
364
365
 
# File 'ssm/cfn_maintenance_window.rb', line 360

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