Class: AWSCDK::SSM::CfnPatchBaseline

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

Overview

The AWS::SSM::PatchBaseline resource defines the basic information for an AWS Systems Manager patch baseline.

A patch baseline defines which patches are approved for installation on your instances.

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

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnPatchBaseline

Create a new AWS::SSM::PatchBaseline.

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

    Resource properties.



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

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::SSM::CfnPatchBaselineProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3NtLkNmblBhdGNoQmFzZWxpbmVQcm9wcyJ9")), "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) 


190
191
192
 
# File 'ssm/cfn_patch_baseline.rb', line 190

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

.is_cfn_patch_baseline(x) ⇒ Boolean

Checks whether the given object is a CfnPatchBaseline.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


92
93
94
95
 
# File 'ssm/cfn_patch_baseline.rb', line 92

def self.is_cfn_patch_baseline(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ssm.CfnPatchBaseline", "isCfnPatchBaseline", [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
83
84
85
86
 
# File 'ssm/cfn_patch_baseline.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_id => { kind: :property, name: "attrId", is_optional: false },
    :patch_baseline_ref => { kind: :property, name: "patchBaselineRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :name => { kind: :property, name: "name", is_optional: false },
    :approval_rules => { kind: :property, name: "approvalRules", is_optional: true },
    :approved_patches => { kind: :property, name: "approvedPatches", is_optional: true },
    :approved_patches_compliance_level => { kind: :property, name: "approvedPatchesComplianceLevel", is_optional: true },
    :approved_patches_enable_non_security => { kind: :property, name: "approvedPatchesEnableNonSecurity", is_optional: true },
    :available_security_updates_compliance_status => { kind: :property, name: "availableSecurityUpdatesComplianceStatus", is_optional: true },
    :default_baseline => { kind: :property, name: "defaultBaseline", is_optional: true },
    :description => { kind: :property, name: "description", is_optional: true },
    :global_filters => { kind: :property, name: "globalFilters", is_optional: true },
    :operating_system => { kind: :property, name: "operatingSystem", is_optional: true },
    :patch_groups => { kind: :property, name: "patchGroups", is_optional: true },
    :rejected_patches => { kind: :property, name: "rejectedPatches", is_optional: true },
    :rejected_patches_action => { kind: :property, name: "rejectedPatchesAction", is_optional: true },
    :sources => { kind: :property, name: "sources", 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.



434
435
436
437
 
# File 'ssm/cfn_patch_baseline.rb', line 434

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:



446
447
448
449
 
# File 'ssm/cfn_patch_baseline.rb', line 446

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:



456
457
458
459
 
# File 'ssm/cfn_patch_baseline.rb', line 456

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:



467
468
469
470
471
 
# File 'ssm/cfn_patch_baseline.rb', line 467

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.


524
525
526
527
528
 
# File 'ssm/cfn_patch_baseline.rb', line 524

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.



534
535
536
537
 
# File 'ssm/cfn_patch_baseline.rb', line 534

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.



546
547
548
549
550
 
# File 'ssm/cfn_patch_baseline.rb', line 546

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:



559
560
561
562
 
# File 'ssm/cfn_patch_baseline.rb', line 559

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:



581
582
583
584
585
586
 
# File 'ssm/cfn_patch_baseline.rb', line 581

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

#approval_rules ⇒ AWSCDK::IResolvable, ...

A set of rules used to include patches in the baseline.

Returns:



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

def approval_rules()
  jsii_get_property("approvalRules")
end

#approval_rules=(value) ⇒ Object 



234
235
236
237
238
 
# File 'ssm/cfn_patch_baseline.rb', line 234

def approval_rules=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::SSM::CfnPatchBaseline::RuleGroupProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zc20uQ2ZuUGF0Y2hCYXNlbGluZS5SdWxlR3JvdXBQcm9wZXJ0eSJ9XX19")), "approvalRules") unless value.nil?
  jsii_set_property("approvalRules", value)
end

#approved_patches ⇒ Array<String>?

A list of explicitly approved patches for the baseline.

Returns:

  • (Array<String>, nil) 


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

def approved_patches()
  jsii_get_property("approvedPatches")
end

#approved_patches=(value) ⇒ Object 



247
248
249
250
 
# File 'ssm/cfn_patch_baseline.rb', line 247

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

#approved_patches_compliance_level ⇒ String?

Defines the compliance level for approved patches.

Returns:

  • (String, nil) 


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

def approved_patches_compliance_level()
  jsii_get_property("approvedPatchesComplianceLevel")
end

#approved_patches_compliance_level=(value) ⇒ Object 



259
260
261
262
 
# File 'ssm/cfn_patch_baseline.rb', line 259

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

#approved_patches_enable_non_security ⇒ Boolean, ...

Indicates whether the list of approved patches includes non-security updates that should be applied to the managed nodes.

Returns:



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

def approved_patches_enable_non_security()
  jsii_get_property("approvedPatchesEnableNonSecurity")
end

#approved_patches_enable_non_security=(value) ⇒ Object 



271
272
273
274
 
# File 'ssm/cfn_patch_baseline.rb', line 271

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

#attr_id ⇒ String

The ID of the patch baseline.

Returns:

  • (String) 


197
198
199
 
# File 'ssm/cfn_patch_baseline.rb', line 197

def attr_id()
  jsii_get_property("attrId")
end

#available_security_updates_compliance_status ⇒ String?

Indicates the status you want to assign to security patches that are available but not approved because they don't meet the installation criteria specified in the patch baseline.

Returns:

  • (String, nil) 


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

def available_security_updates_compliance_status()
  jsii_get_property("availableSecurityUpdatesComplianceStatus")
end

#available_security_updates_compliance_status=(value) ⇒ Object 



283
284
285
286
 
# File 'ssm/cfn_patch_baseline.rb', line 283

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

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



143
144
145
 
# File 'ssm/cfn_patch_baseline.rb', line 143

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


148
149
150
 
# File 'ssm/cfn_patch_baseline.rb', line 148

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


590
591
592
593
 
# File 'ssm/cfn_patch_baseline.rb', line 590

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


153
154
155
 
# File 'ssm/cfn_patch_baseline.rb', line 153

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


160
161
162
 
# File 'ssm/cfn_patch_baseline.rb', line 160

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


105
106
107
 
# File 'ssm/cfn_patch_baseline.rb', line 105

def creation_stack()
  jsii_get_property("creationStack")
end

#default_baseline ⇒ Boolean, ...

Indicates whether this is the default baseline.

Returns:



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

def default_baseline()
  jsii_get_property("defaultBaseline")
end

#default_baseline=(value) ⇒ Object 



295
296
297
298
 
# File 'ssm/cfn_patch_baseline.rb', line 295

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

#description ⇒ String?

A description of the patch baseline.

Returns:

  • (String, nil) 


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

def description()
  jsii_get_property("description")
end

#description=(value) ⇒ Object 



307
308
309
310
 
# File 'ssm/cfn_patch_baseline.rb', line 307

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:



165
166
167
 
# File 'ssm/cfn_patch_baseline.rb', line 165

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:



603
604
605
606
607
 
# File 'ssm/cfn_patch_baseline.rb', line 603

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:



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

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

#global_filters ⇒ AWSCDK::IResolvable, ...

A set of global filters used to include patches in the baseline.

Returns:



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

def global_filters()
  jsii_get_property("globalFilters")
end

#global_filters=(value) ⇒ Object 



319
320
321
322
323
 
# File 'ssm/cfn_patch_baseline.rb', line 319

def global_filters=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::SSM::CfnPatchBaseline::PatchFilterGroupProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zc20uQ2ZuUGF0Y2hCYXNlbGluZS5QYXRjaEZpbHRlckdyb3VwUHJvcGVydHkifV19fQ==")), "globalFilters") unless value.nil?
  jsii_set_property("globalFilters", value)
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



684
685
686
687
 
# File 'ssm/cfn_patch_baseline.rb', line 684

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) 


117
118
119
 
# File 'ssm/cfn_patch_baseline.rb', line 117

def logical_id()
  jsii_get_property("logicalId")
end

#name ⇒ String

The name of the patch baseline.

Returns:

  • (String) 


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

def name()
  jsii_get_property("name")
end

#name=(value) ⇒ Object 



222
223
224
225
 
# File 'ssm/cfn_patch_baseline.rb', line 222

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) 


100
101
102
 
# File 'ssm/cfn_patch_baseline.rb', line 100

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:



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

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:



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

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

#operating_system ⇒ String?

Defines the operating system the patch baseline applies to.

Returns:

  • (String, nil) 


328
329
330
 
# File 'ssm/cfn_patch_baseline.rb', line 328

def operating_system()
  jsii_get_property("operatingSystem")
end

#operating_system=(value) ⇒ Object 



332
333
334
335
 
# File 'ssm/cfn_patch_baseline.rb', line 332

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



425
426
427
428
 
# File 'ssm/cfn_patch_baseline.rb', line 425

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

#patch_baseline_ref ⇒ AWSCDK::Interfaces::AWSSSM::PatchBaselineReference

A reference to a PatchBaseline resource.

Returns:



204
205
206
 
# File 'ssm/cfn_patch_baseline.rb', line 204

def patch_baseline_ref()
  jsii_get_property("patchBaselineRef")
end

#patch_groups ⇒ Array<String>?

The name of the patch group to be registered with the patch baseline.

Returns:

  • (Array<String>, nil) 


340
341
342
 
# File 'ssm/cfn_patch_baseline.rb', line 340

def patch_groups()
  jsii_get_property("patchGroups")
end

#patch_groups=(value) ⇒ Object 



344
345
346
347
 
# File 'ssm/cfn_patch_baseline.rb', line 344

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


136
137
138
 
# File 'ssm/cfn_patch_baseline.rb', line 136

def ref()
  jsii_get_property("ref")
end

#rejected_patches ⇒ Array<String>?

A list of explicitly rejected patches for the baseline.

Returns:

  • (Array<String>, nil) 


352
353
354
 
# File 'ssm/cfn_patch_baseline.rb', line 352

def rejected_patches()
  jsii_get_property("rejectedPatches")
end

#rejected_patches=(value) ⇒ Object 



356
357
358
359
 
# File 'ssm/cfn_patch_baseline.rb', line 356

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

#rejected_patches_action ⇒ String?

The action for Patch Manager to take on patches included in the RejectedPackages list.

Returns:

  • (String, nil) 


364
365
366
 
# File 'ssm/cfn_patch_baseline.rb', line 364

def rejected_patches_action()
  jsii_get_property("rejectedPatchesAction")
end

#rejected_patches_action=(value) ⇒ Object 



368
369
370
371
 
# File 'ssm/cfn_patch_baseline.rb', line 368

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



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

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


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

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:



660
661
662
663
664
 
# File 'ssm/cfn_patch_baseline.rb', line 660

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

#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.



669
670
671
 
# File 'ssm/cfn_patch_baseline.rb', line 669

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

#sources ⇒ AWSCDK::IResolvable, ...

Information about the patches to use to update the managed nodes, including target operating systems and source repositories.

Returns:



376
377
378
 
# File 'ssm/cfn_patch_baseline.rb', line 376

def sources()
  jsii_get_property("sources")
end

#sources=(value) ⇒ Object 



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

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



126
127
128
 
# File 'ssm/cfn_patch_baseline.rb', line 126

def stack()
  jsii_get_property("stack")
end

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



211
212
213
 
# File 'ssm/cfn_patch_baseline.rb', line 211

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Array<AWSCDK::CfnTag>?

Optional metadata that you assign to a resource.

Returns:



388
389
390
 
# File 'ssm/cfn_patch_baseline.rb', line 388

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



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

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



401
402
403
 
# File 'ssm/cfn_patch_baseline.rb', line 401

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


173
174
175
 
# File 'ssm/cfn_patch_baseline.rb', line 173

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


183
184
185
 
# File 'ssm/cfn_patch_baseline.rb', line 183

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


675
676
677
678
 
# File 'ssm/cfn_patch_baseline.rb', line 675

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) 


414
415
416
417
418
419
 
# File 'ssm/cfn_patch_baseline.rb', line 414

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