Class: AWSCDK::ControlTower::CfnLandingZoneProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
control_tower/cfn_landing_zone_props.rb

Overview

Properties for defining a CfnLandingZone.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(manifest:, version:, remediation_types: nil, tags: nil) ⇒ CfnLandingZoneProps

Returns a new instance of CfnLandingZoneProps.

Parameters:

  • manifest (Object) —

    The landing zone manifest JSON text file that specifies the landing zone configurations.

  • version (String) —

    The landing zone's current deployed version.

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

    The types of remediation actions configured for the landing zone, such as automatic drift correction or compliance enforcement.

  • tags (Array<AWSCDK::CfnTag>, nil) (defaults to: nil) —

    Tags to be applied to the landing zone.



13
14
15
16
17
18
19
20
21
22
 
# File 'control_tower/cfn_landing_zone_props.rb', line 13

def initialize(manifest:, version:, remediation_types: nil, tags: nil)
  @manifest = manifest
  Jsii::Type.check_type(@manifest, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "manifest")
  @version = version
  Jsii::Type.check_type(@version, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "version")
  @remediation_types = remediation_types
  Jsii::Type.check_type(@remediation_types, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "remediationTypes") unless @remediation_types.nil?
  @tags = tags.is_a?(Array) ? tags.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless @tags.nil?
end

Instance Attribute Details

#manifest ⇒ Object (readonly)

The landing zone manifest JSON text file that specifies the landing zone configurations.

Returns:

  • (Object)

See Also:



28
29
30
 
# File 'control_tower/cfn_landing_zone_props.rb', line 28

def manifest
  @manifest
end

#remediation_types ⇒ Array<String>? (readonly)

The types of remediation actions configured for the landing zone, such as automatic drift correction or compliance enforcement.

Returns:

  • (Array<String>, nil)

See Also:



38
39
40
 
# File 'control_tower/cfn_landing_zone_props.rb', line 38

def remediation_types
  @remediation_types
end

#tags ⇒ Array<AWSCDK::CfnTag>? (readonly)

Tags to be applied to the landing zone.

Returns:

See Also:



43
44
45
 
# File 'control_tower/cfn_landing_zone_props.rb', line 43

def tags
  @tags
end

#version ⇒ String (readonly)

The landing zone's current deployed version.

Returns:

  • (String)

See Also:



33
34
35
 
# File 'control_tower/cfn_landing_zone_props.rb', line 33

def version
  @version
end

Class Method Details

.jsii_properties ⇒ Object 



45
46
47
48
49
50
51
52
 
# File 'control_tower/cfn_landing_zone_props.rb', line 45

def self.jsii_properties
  {
    :manifest => "manifest",
    :version => "version",
    :remediation_types => "remediationTypes",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



54
55
56
57
58
59
60
61
62
63
 
# File 'control_tower/cfn_landing_zone_props.rb', line 54

def to_jsii
  result = {}
  result.merge!({
    "manifest" => @manifest,
    "version" => @version,
    "remediationTypes" => @remediation_types,
    "tags" => @tags,
  })
  result.compact
end