Class: AWSCDK::SSM::CfnAssociation

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggableV2, Interfaces::AWSSSM::IAssociationRef
Defined in:
ssm/cfn_association.rb

Overview

The AWS::SSM::Association resource creates a State Manager association for your managed instances.

A State Manager association defines the state that you want to maintain on your instances. For example, an association can specify that anti-virus software must be installed and running on your instances, or that certain ports must be closed. For static targets, the association specifies a schedule for when the configuration is reapplied. For dynamic targets, such as an Resource Groups or an AWS Auto Scaling Group, State Manager applies the configuration when new instances are added to the group. The association also specifies actions to take when applying the configuration. For example, an association for anti-virus software might run once a day. If the software is not installed, then State Manager installs it. If the software is installed, but the service is not running, then the association might instruct State Manager to start the service.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnAssociation

Create a new AWS::SSM::Association.

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

    Resource properties.



20
21
22
23
24
25
26
 
# File 'ssm/cfn_association.rb', line 20

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

Class Method Details

.arn_for_association(resource) ⇒ String

Parameters:

Returns:

  • (String) 


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

def self.arn_for_association(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19zc20uSUFzc29jaWF0aW9uUmVmIn0=")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ssm.CfnAssociation", "arnForAssociation", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


212
213
214
 
# File 'ssm/cfn_association.rb', line 212

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

.from_association_id(scope, id, association_id) ⇒ AWSCDK::Interfaces::AWSSSM::IAssociationRef

Creates a new IAssociationRef from a associationId.

Parameters:

  • scope (Constructs::Construct)
  • id (String)
  • association_id (String)

Returns:



103
104
105
106
107
108
 
# File 'ssm/cfn_association.rb', line 103

def self.from_association_id(scope, id, association_id)
  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(association_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "associationId")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ssm.CfnAssociation", "fromAssociationId", [scope, id, association_id])
end

.is_cfn_association(x) ⇒ Boolean

Checks whether the given object is a CfnAssociation.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


114
115
116
117
 
# File 'ssm/cfn_association.rb', line 114

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

.jsii_overridable_methods ⇒ Object 



28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'ssm/cfn_association.rb', line 28

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :creation_stack => { kind: :property, name: "creationStack", is_optional: false },
    :logical_id => { kind: :property, name: "logicalId", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :ref => { kind: :property, name: "ref", is_optional: false },
    :cfn_options => { kind: :property, name: "cfnOptions", is_optional: false },
    :cfn_properties => { kind: :property, name: "cfnProperties", is_optional: false },
    :cfn_property_names => { kind: :property, name: "cfnPropertyNames", is_optional: false },
    :cfn_resource_type => { kind: :property, name: "cfnResourceType", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :updated_properites => { kind: :property, name: "updatedProperites", is_optional: false },
    :updated_properties => { kind: :property, name: "updatedProperties", is_optional: false },
    :association_ref => { kind: :property, name: "associationRef", is_optional: false },
    :attr_association_id => { kind: :property, name: "attrAssociationId", is_optional: false },
    :cdk_tag_manager => { kind: :property, name: "cdkTagManager", is_optional: false },
    :name => { kind: :property, name: "name", is_optional: false },
    :parameters => { kind: :property, name: "parameters", is_optional: false },
    :apply_only_at_cron_interval => { kind: :property, name: "applyOnlyAtCronInterval", is_optional: true },
    :association_dispatch_assume_role => { kind: :property, name: "associationDispatchAssumeRole", is_optional: true },
    :association_name => { kind: :property, name: "associationName", is_optional: true },
    :automation_target_parameter_name => { kind: :property, name: "automationTargetParameterName", is_optional: true },
    :calendar_names => { kind: :property, name: "calendarNames", is_optional: true },
    :compliance_severity => { kind: :property, name: "complianceSeverity", is_optional: true },
    :document_version => { kind: :property, name: "documentVersion", is_optional: true },
    :instance_id => { kind: :property, name: "instanceId", is_optional: true },
    :max_concurrency => { kind: :property, name: "maxConcurrency", is_optional: true },
    :max_errors => { kind: :property, name: "maxErrors", is_optional: true },
    :output_location => { kind: :property, name: "outputLocation", is_optional: true },
    :schedule_expression => { kind: :property, name: "scheduleExpression", is_optional: true },
    :schedule_offset => { kind: :property, name: "scheduleOffset", is_optional: true },
    :sync_compliance => { kind: :property, name: "syncCompliance", is_optional: true },
    :tags => { kind: :property, name: "tags", is_optional: true },
    :targets => { kind: :property, name: "targets", is_optional: true },
    :wait_for_success_timeout_seconds => { kind: :property, name: "waitForSuccessTimeoutSeconds", 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.



503
504
505
506
 
# File 'ssm/cfn_association.rb', line 503

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:



515
516
517
518
 
# File 'ssm/cfn_association.rb', line 515

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:



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

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:



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

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.


593
594
595
596
597
 
# File 'ssm/cfn_association.rb', line 593

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.



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

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.



615
616
617
618
619
 
# File 'ssm/cfn_association.rb', line 615

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:



628
629
630
631
 
# File 'ssm/cfn_association.rb', line 628

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_only_at_cron_interval ⇒ Boolean, ...

By default, when you create a new association, the system runs it immediately after it is created and then according to the schedule you specified.

Returns:



264
265
266
 
# File 'ssm/cfn_association.rb', line 264

def apply_only_at_cron_interval()
  jsii_get_property("applyOnlyAtCronInterval")
end

#apply_only_at_cron_interval=(value) ⇒ Object 



268
269
270
271
 
# File 'ssm/cfn_association.rb', line 268

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



650
651
652
653
654
655
 
# File 'ssm/cfn_association.rb', line 650

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

#association_dispatch_assume_role ⇒ String?

A role used by association to take actions on your behalf.

Returns:

  • (String, nil) 


276
277
278
 
# File 'ssm/cfn_association.rb', line 276

def association_dispatch_assume_role()
  jsii_get_property("associationDispatchAssumeRole")
end

#association_dispatch_assume_role=(value) ⇒ Object 



280
281
282
283
 
# File 'ssm/cfn_association.rb', line 280

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

#association_name ⇒ String?

Specify a descriptive name for the association.

Returns:

  • (String, nil) 


288
289
290
 
# File 'ssm/cfn_association.rb', line 288

def association_name()
  jsii_get_property("associationName")
end

#association_name=(value) ⇒ Object 



292
293
294
295
 
# File 'ssm/cfn_association.rb', line 292

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

#association_ref ⇒ AWSCDK::Interfaces::AWSSSM::AssociationReference

A reference to a Association resource.

Returns:



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

def association_ref()
  jsii_get_property("associationRef")
end

#attr_association_id ⇒ String

The association ID.

Returns:

  • (String) 


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

def attr_association_id()
  jsii_get_property("attrAssociationId")
end

#automation_target_parameter_name ⇒ String?

Choose the parameter that will define how your automation will branch out.

Returns:

  • (String, nil) 


300
301
302
 
# File 'ssm/cfn_association.rb', line 300

def automation_target_parameter_name()
  jsii_get_property("automationTargetParameterName")
end

#automation_target_parameter_name=(value) ⇒ Object 



304
305
306
307
 
# File 'ssm/cfn_association.rb', line 304

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

#calendar_names ⇒ Array<String>?

The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your associations are gated under.

Returns:

  • (Array<String>, nil) 


312
313
314
 
# File 'ssm/cfn_association.rb', line 312

def calendar_names()
  jsii_get_property("calendarNames")
end

#calendar_names=(value) ⇒ Object 



316
317
318
319
 
# File 'ssm/cfn_association.rb', line 316

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

#cdk_tag_manager ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



233
234
235
 
# File 'ssm/cfn_association.rb', line 233

def cdk_tag_manager()
  jsii_get_property("cdkTagManager")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



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

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


170
171
172
 
# File 'ssm/cfn_association.rb', line 170

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


659
660
661
662
 
# File 'ssm/cfn_association.rb', line 659

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


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

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


182
183
184
 
# File 'ssm/cfn_association.rb', line 182

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#compliance_severity ⇒ String?

The severity level that is assigned to the association.

Returns:

  • (String, nil) 


324
325
326
 
# File 'ssm/cfn_association.rb', line 324

def compliance_severity()
  jsii_get_property("complianceSeverity")
end

#compliance_severity=(value) ⇒ Object 



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

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

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


127
128
129
 
# File 'ssm/cfn_association.rb', line 127

def creation_stack()
  jsii_get_property("creationStack")
end

#document_version ⇒ String?

The version of the SSM document to associate with the target.

Returns:

  • (String, nil) 


336
337
338
 
# File 'ssm/cfn_association.rb', line 336

def document_version()
  jsii_get_property("documentVersion")
end

#document_version=(value) ⇒ Object 



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

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

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



187
188
189
 
# File 'ssm/cfn_association.rb', line 187

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:



672
673
674
675
676
 
# File 'ssm/cfn_association.rb', line 672

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:



683
684
685
686
 
# File 'ssm/cfn_association.rb', line 683

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:



753
754
755
756
 
# File 'ssm/cfn_association.rb', line 753

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

#instance_id ⇒ String?

InstanceId has been deprecated.

Returns:

  • (String, nil) 


348
349
350
 
# File 'ssm/cfn_association.rb', line 348

def instance_id()
  jsii_get_property("instanceId")
end

#instance_id=(value) ⇒ Object 



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

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


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

def logical_id()
  jsii_get_property("logicalId")
end

#max_concurrency ⇒ String?

The maximum number of targets allowed to run the association at the same time.

Returns:

  • (String, nil) 


360
361
362
 
# File 'ssm/cfn_association.rb', line 360

def max_concurrency()
  jsii_get_property("maxConcurrency")
end

#max_concurrency=(value) ⇒ Object 



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

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 number of errors that are allowed before the system stops sending requests to run the association on additional targets.

Returns:

  • (String, nil) 


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

def max_errors()
  jsii_get_property("maxErrors")
end

#max_errors=(value) ⇒ Object 



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

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 name of the SSM document that contains the configuration information for the instance.

Returns:

  • (String) 


240
241
242
 
# File 'ssm/cfn_association.rb', line 240

def name()
  jsii_get_property("name")
end

#name=(value) ⇒ Object 



244
245
246
247
 
# File 'ssm/cfn_association.rb', line 244

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) 


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

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:



694
695
696
 
# File 'ssm/cfn_association.rb', line 694

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:



701
702
703
 
# File 'ssm/cfn_association.rb', line 701

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

#output_location ⇒ AWSCDK::IResolvable, ...

An Amazon Simple Storage Service (Amazon S3) bucket where you want to store the output details of the request.

Returns:



384
385
386
 
# File 'ssm/cfn_association.rb', line 384

def output_location()
  jsii_get_property("outputLocation")
end

#output_location=(value) ⇒ Object 



388
389
390
391
392
 
# File 'ssm/cfn_association.rb', line 388

def output_location=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::SSM::CfnAssociation::InstanceAssociationOutputLocationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zc20uQ2ZuQXNzb2NpYXRpb24uSW5zdGFuY2VBc3NvY2lhdGlvbk91dHB1dExvY2F0aW9uUHJvcGVydHkifV19fQ==")), "outputLocation") unless value.nil?
  jsii_set_property("outputLocation", 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.



494
495
496
497
 
# File 'ssm/cfn_association.rb', line 494

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

#parameters ⇒ Object

The parameters for the runtime configuration of the document.

Returns:

  • (Object) 


252
253
254
 
# File 'ssm/cfn_association.rb', line 252

def parameters()
  jsii_get_property("parameters")
end

#parameters=(value) ⇒ Object 



256
257
258
259
 
# File 'ssm/cfn_association.rb', line 256

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


158
159
160
 
# File 'ssm/cfn_association.rb', line 158

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:



712
713
714
715
 
# File 'ssm/cfn_association.rb', line 712

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


719
720
721
722
 
# File 'ssm/cfn_association.rb', line 719

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:



729
730
731
732
733
 
# File 'ssm/cfn_association.rb', line 729

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

A cron expression that specifies a schedule when the association runs.

Returns:

  • (String, nil) 


397
398
399
 
# File 'ssm/cfn_association.rb', line 397

def schedule_expression()
  jsii_get_property("scheduleExpression")
end

#schedule_expression=(value) ⇒ Object 



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

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

#schedule_offset ⇒ Numeric?

Number of days to wait after the scheduled day to run an association.

Returns:

  • (Numeric, nil) 


409
410
411
 
# File 'ssm/cfn_association.rb', line 409

def schedule_offset()
  jsii_get_property("scheduleOffset")
end

#schedule_offset=(value) ⇒ Object 



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

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

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



738
739
740
 
# File 'ssm/cfn_association.rb', line 738

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:



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

def stack()
  jsii_get_property("stack")
end

#sync_compliance ⇒ String?

The mode for generating association compliance.

Returns:

  • (String, nil) 


421
422
423
 
# File 'ssm/cfn_association.rb', line 421

def sync_compliance()
  jsii_get_property("syncCompliance")
end

#sync_compliance=(value) ⇒ Object 



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

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

#tags ⇒ Array<AWSCDK::CfnTag>?

A key-value pair to associate with a resource.

Returns:



433
434
435
 
# File 'ssm/cfn_association.rb', line 433

def tags()
  jsii_get_property("tags")
end

#tags=(value) ⇒ Object 



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

def tags=(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=")), "tags") unless value.nil?
  jsii_set_property("tags", value)
end

#targets ⇒ AWSCDK::IResolvable, ...

The targets for the association.

Returns:



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

def targets()
  jsii_get_property("targets")
end

#targets=(value) ⇒ Object 



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

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

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



470
471
472
 
# File 'ssm/cfn_association.rb', line 470

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


195
196
197
 
# File 'ssm/cfn_association.rb', line 195

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


205
206
207
 
# File 'ssm/cfn_association.rb', line 205

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


744
745
746
747
 
# File 'ssm/cfn_association.rb', line 744

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

#wait_for_success_timeout_seconds ⇒ Numeric?

The number of seconds the service should wait for the association status to show "Success" before proceeding with the stack execution.

Returns:

  • (Numeric, nil) 


458
459
460
 
# File 'ssm/cfn_association.rb', line 458

def wait_for_success_timeout_seconds()
  jsii_get_property("waitForSuccessTimeoutSeconds")
end

#wait_for_success_timeout_seconds=(value) ⇒ Object 



462
463
464
465
 
# File 'ssm/cfn_association.rb', line 462

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


483
484
485
486
487
488
 
# File 'ssm/cfn_association.rb', line 483

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