Class: AWSCDK::CloudFormation::CfnStackSet::AutoDeploymentProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
cloud_formation/cfn_stack_set.rb

Overview

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

For more information, see Enable or disable automatic deployments for StackSets in AWS Organizations in the CloudFormation User Guide .

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(depends_on: nil, enabled: nil, retain_stacks_on_account_removal: nil) ⇒ AutoDeploymentProperty

Returns a new instance of AutoDeploymentProperty.

Parameters:

  • depends_on (Array<String>, nil) (defaults to: nil) —

    A list of StackSet ARNs that this StackSet depends on for auto-deployment operations.

  • enabled (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    If set to true , StackSets automatically deploys additional stack instances to AWS Organizations accounts that are added to a target organization or organizational unit (OU) in the specified Regions.

  • retain_stacks_on_account_removal (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    If set to true , stack resources are retained when an account is removed from a target organization or OU.



702
703
704
705
706
707
708
709
 
# File 'cloud_formation/cfn_stack_set.rb', line 702

def initialize(depends_on: nil, enabled: nil, retain_stacks_on_account_removal: nil)
  @depends_on = depends_on
  Jsii::Type.check_type(@depends_on, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "dependsOn") unless @depends_on.nil?
  @enabled = enabled
  Jsii::Type.check_type(@enabled, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "enabled") unless @enabled.nil?
  @retain_stacks_on_account_removal = 
  Jsii::Type.check_type(@retain_stacks_on_account_removal, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "retainStacksOnAccountRemoval") unless @retain_stacks_on_account_removal.nil?
end

Instance Attribute Details

#depends_on ⇒ Array<String>? (readonly)

A list of StackSet ARNs that this StackSet depends on for auto-deployment operations.

When auto-deployment is triggered, operations will be sequenced to ensure all dependencies complete successfully before this StackSet's operation begins.

Returns:

  • (Array<String>, nil)

See Also:



717
718
719
 
# File 'cloud_formation/cfn_stack_set.rb', line 717

def depends_on
  @depends_on
end

#enabled ⇒ Boolean, ... (readonly)

If set to true , StackSets automatically deploys additional stack instances to AWS Organizations accounts that are added to a target organization or organizational unit (OU) in the specified Regions.

If an account is removed from a target organization or OU, StackSets deletes stack instances from the account in the specified Regions.

Returns:

See Also:



724
725
726
 
# File 'cloud_formation/cfn_stack_set.rb', line 724

def enabled
  @enabled
end

#retain_stacks_on_account_removal ⇒ Boolean, ... (readonly)

If set to true , stack resources are retained when an account is removed from a target organization or OU.

If set to false , stack resources are deleted. Specify only if Enabled is set to True .

Returns:

See Also:



731
732
733
 
# File 'cloud_formation/cfn_stack_set.rb', line 731

def 
  @retain_stacks_on_account_removal
end

Class Method Details

.jsii_properties ⇒ Object 



733
734
735
736
737
738
739
 
# File 'cloud_formation/cfn_stack_set.rb', line 733

def self.jsii_properties
  {
    :depends_on => "dependsOn",
    :enabled => "enabled",
    :retain_stacks_on_account_removal => "retainStacksOnAccountRemoval",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



741
742
743
744
745
746
747
748
749
 
# File 'cloud_formation/cfn_stack_set.rb', line 741

def to_jsii
  result = {}
  result.merge!({
    "dependsOn" => @depends_on,
    "enabled" => @enabled,
    "retainStacksOnAccountRemoval" => @retain_stacks_on_account_removal,
  })
  result.compact
end