Class: AWSCDK::CfnStackSet

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggable, Interfaces::AWSCloudformation::IStackSetRef
Defined in:
cfn_stack_set.rb

Overview

The AWS::CloudFormation::StackSet resource contains information about a StackSet.

With StackSets, you can provision stacks across AWS accounts and Regions from a single CloudFormation template. Each stack is based on the same CloudFormation template, but you can customize individual stacks using parameters.

Run deployments to nested StackSets from the parent stack, not directly through the StackSet API.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnStackSet

Create a new AWS::CloudFormation::StackSet.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

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

  • props (AWSCDK::CfnStackSetProps) —

    Resource properties.



22
23
24
25
26
27
28
 
# File 'cfn_stack_set.rb', line 22

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::CfnStackSetProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5TdGFja1NldFByb3BzIn0=")), "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 'cfn_stack_set.rb', line 190

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

.is_cfn_stack_set(x) ⇒ Boolean

Checks whether the given object is a CfnStackSet.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


92
93
94
95
 
# File 'cfn_stack_set.rb', line 92

def self.is_cfn_stack_set(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.CfnStackSet", "isCfnStackSet", [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 'cfn_stack_set.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_stack_set_id => { kind: :property, name: "attrStackSetId", is_optional: false },
    :stack_set_ref => { kind: :property, name: "stackSetRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :managed_execution => { kind: :property, name: "managedExecution", is_optional: false },
    :permission_model => { kind: :property, name: "permissionModel", is_optional: false },
    :stack_set_name => { kind: :property, name: "stackSetName", is_optional: false },
    :administration_role_arn => { kind: :property, name: "administrationRoleArn", is_optional: true },
    :auto_deployment => { kind: :property, name: "autoDeployment", is_optional: true },
    :call_as => { kind: :property, name: "callAs", is_optional: true },
    :capabilities => { kind: :property, name: "capabilities", is_optional: true },
    :description => { kind: :property, name: "description", is_optional: true },
    :execution_role_name => { kind: :property, name: "executionRoleName", is_optional: true },
    :operation_preferences => { kind: :property, name: "operationPreferences", is_optional: true },
    :parameters => { kind: :property, name: "parameters", is_optional: true },
    :stack_instances_group => { kind: :property, name: "stackInstancesGroup", is_optional: true },
    :tags_raw => { kind: :property, name: "tagsRaw", is_optional: true },
    :template_body => { kind: :property, name: "templateBody", is_optional: true },
    :template_url => { kind: :property, name: "templateUrl", 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 'cfn_stack_set.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 'cfn_stack_set.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 'cfn_stack_set.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 'cfn_stack_set.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 'cfn_stack_set.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 'cfn_stack_set.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 'cfn_stack_set.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

#administration_role_arn ⇒ String?

The Amazon Resource Number (ARN) of the IAM role to use to create this StackSet.

Returns:

  • (String, nil) 


254
255
256
 
# File 'cfn_stack_set.rb', line 254

def administration_role_arn()
  jsii_get_property("administrationRoleArn")
end

#administration_role_arn=(value) ⇒ Object 



258
259
260
261
 
# File 'cfn_stack_set.rb', line 258

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

#attr_stack_set_id ⇒ String

Returns the unique identifier of the resource.

Returns:

  • (String) 


197
198
199
 
# File 'cfn_stack_set.rb', line 197

def attr_stack_set_id()
  jsii_get_property("attrStackSetId")
end

#auto_deployment ⇒ AWSCDK::IResolvable, ...

Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to a target organization or organizational unit (OU).

Returns:



266
267
268
 
# File 'cfn_stack_set.rb', line 266

def auto_deployment()
  jsii_get_property("autoDeployment")
end

#auto_deployment=(value) ⇒ Object 



270
271
272
273
274
 
# File 'cfn_stack_set.rb', line 270

def auto_deployment=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::CfnStackSet::AutoDeploymentProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLkNmblN0YWNrU2V0LkF1dG9EZXBsb3ltZW50UHJvcGVydHkifV19fQ==")), "autoDeployment") unless value.nil?
  jsii_set_property("autoDeployment", value)
end

#call_as ⇒ String?

Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

Returns:

  • (String, nil) 


279
280
281
 
# File 'cfn_stack_set.rb', line 279

def call_as()
  jsii_get_property("callAs")
end

#call_as=(value) ⇒ Object 



283
284
285
286
 
# File 'cfn_stack_set.rb', line 283

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

#capabilities ⇒ Array<String>?

The capabilities that are allowed in the StackSet.

Returns:

  • (Array<String>, nil) 


291
292
293
 
# File 'cfn_stack_set.rb', line 291

def capabilities()
  jsii_get_property("capabilities")
end

#capabilities=(value) ⇒ Object 



295
296
297
298
 
# File 'cfn_stack_set.rb', line 295

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

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



143
144
145
 
# File 'cfn_stack_set.rb', line 143

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


148
149
150
 
# File 'cfn_stack_set.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 'cfn_stack_set.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 'cfn_stack_set.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 'cfn_stack_set.rb', line 160

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


105
106
107
 
# File 'cfn_stack_set.rb', line 105

def creation_stack()
  jsii_get_property("creationStack")
end

#description ⇒ String?

A description of the StackSet.

Returns:

  • (String, nil) 


303
304
305
 
# File 'cfn_stack_set.rb', line 303

def description()
  jsii_get_property("description")
end

#description=(value) ⇒ Object 



307
308
309
310
 
# File 'cfn_stack_set.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 'cfn_stack_set.rb', line 165

def env()
  jsii_get_property("env")
end

#execution_role_name ⇒ String?

The name of the IAM execution role to use to create the StackSet.

Returns:

  • (String, nil) 


315
316
317
 
# File 'cfn_stack_set.rb', line 315

def execution_role_name()
  jsii_get_property("executionRoleName")
end

#execution_role_name=(value) ⇒ Object 



319
320
321
322
 
# File 'cfn_stack_set.rb', line 319

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

#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

Returns:



603
604
605
606
607
 
# File 'cfn_stack_set.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 'cfn_stack_set.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

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



684
685
686
687
 
# File 'cfn_stack_set.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 'cfn_stack_set.rb', line 117

def logical_id()
  jsii_get_property("logicalId")
end

#managed_execution ⇒ Object

Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.

Returns:

  • (Object) 


218
219
220
 
# File 'cfn_stack_set.rb', line 218

def managed_execution()
  jsii_get_property("managedExecution")
end

#managed_execution=(value) ⇒ Object 



222
223
224
225
 
# File 'cfn_stack_set.rb', line 222

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

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


100
101
102
 
# File 'cfn_stack_set.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 'cfn_stack_set.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 'cfn_stack_set.rb', line 632

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

#operation_preferences ⇒ AWSCDK::IResolvable, ...

The user-specified preferences for how CloudFormation performs a StackSet operation.

Returns:



327
328
329
 
# File 'cfn_stack_set.rb', line 327

def operation_preferences()
  jsii_get_property("operationPreferences")
end

#operation_preferences=(value) ⇒ Object 



331
332
333
334
335
 
# File 'cfn_stack_set.rb', line 331

def operation_preferences=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::CfnStackSet::OperationPreferencesProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLkNmblN0YWNrU2V0Lk9wZXJhdGlvblByZWZlcmVuY2VzUHJvcGVydHkifV19fQ==")), "operationPreferences") unless value.nil?
  jsii_set_property("operationPreferences", 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 'cfn_stack_set.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

#parameters ⇒ AWSCDK::IResolvable, ...

The input parameters for the StackSet template.

Returns:



340
341
342
 
# File 'cfn_stack_set.rb', line 340

def parameters()
  jsii_get_property("parameters")
end

#parameters=(value) ⇒ Object 



344
345
346
347
 
# File 'cfn_stack_set.rb', line 344

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

#permission_model ⇒ String

Describes how the IAM roles required for StackSet operations are created.

Returns:

  • (String) 


230
231
232
 
# File 'cfn_stack_set.rb', line 230

def permission_model()
  jsii_get_property("permissionModel")
end

#permission_model=(value) ⇒ Object 



234
235
236
237
 
# File 'cfn_stack_set.rb', line 234

def permission_model=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "permissionModel")
  jsii_set_property("permissionModel", 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 'cfn_stack_set.rb', line 136

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:



643
644
645
646
 
# File 'cfn_stack_set.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 'cfn_stack_set.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 'cfn_stack_set.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 'cfn_stack_set.rb', line 669

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:



126
127
128
 
# File 'cfn_stack_set.rb', line 126

def stack()
  jsii_get_property("stack")
end

#stack_instances_group ⇒ AWSCDK::IResolvable, ...

A group of stack instances with parameters in some specific accounts and Regions.

Returns:



352
353
354
 
# File 'cfn_stack_set.rb', line 352

def stack_instances_group()
  jsii_get_property("stackInstancesGroup")
end

#stack_instances_group=(value) ⇒ Object 



356
357
358
359
 
# File 'cfn_stack_set.rb', line 356

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

#stack_set_name ⇒ String

The name to associate with the StackSet.

Returns:

  • (String) 


242
243
244
 
# File 'cfn_stack_set.rb', line 242

def stack_set_name()
  jsii_get_property("stackSetName")
end

#stack_set_name=(value) ⇒ Object 



246
247
248
249
 
# File 'cfn_stack_set.rb', line 246

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

#stack_set_ref ⇒ AWSCDK::Interfaces::AWSCloudformation::StackSetReference

A reference to a StackSet resource.

Returns:



204
205
206
 
# File 'cfn_stack_set.rb', line 204

def stack_set_ref()
  jsii_get_property("stackSetRef")
end

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



211
212
213
 
# File 'cfn_stack_set.rb', line 211

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Array<AWSCDK::CfnTag>?

Key-value pairs to associate with this stack.

Returns:



364
365
366
 
# File 'cfn_stack_set.rb', line 364

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



368
369
370
371
372
 
# File 'cfn_stack_set.rb', line 368

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

#template_body ⇒ String?

The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes.

Returns:

  • (String, nil) 


377
378
379
 
# File 'cfn_stack_set.rb', line 377

def template_body()
  jsii_get_property("templateBody")
end

#template_body=(value) ⇒ Object 



381
382
383
384
 
# File 'cfn_stack_set.rb', line 381

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

#template_url ⇒ String?

The URL of a file that contains the template body.

Returns:

  • (String, nil) 


389
390
391
 
# File 'cfn_stack_set.rb', line 389

def template_url()
  jsii_get_property("templateUrl")
end

#template_url=(value) ⇒ Object 



393
394
395
396
 
# File 'cfn_stack_set.rb', line 393

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

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



401
402
403
 
# File 'cfn_stack_set.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 'cfn_stack_set.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 'cfn_stack_set.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 'cfn_stack_set.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 'cfn_stack_set.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