Class: AWSCDK::Backup::CfnFrameworkProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
backup/cfn_framework_props.rb

Overview

Properties for defining a CfnFramework.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(framework_controls:, framework_description: nil, framework_name: nil, framework_tags: nil) ⇒ CfnFrameworkProps

Returns a new instance of CfnFrameworkProps.

Parameters:



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

def initialize(framework_controls:, framework_description: nil, framework_name: nil, framework_tags: nil)
  @framework_controls = framework_controls
  Jsii::Type.check_type(@framework_controls, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYmFja3VwLkNmbkZyYW1ld29yay5GcmFtZXdvcmtDb250cm9sUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "frameworkControls")
  @framework_description = framework_description
  Jsii::Type.check_type(@framework_description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "frameworkDescription") unless @framework_description.nil?
  @framework_name = framework_name
  Jsii::Type.check_type(@framework_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "frameworkName") unless @framework_name.nil?
  @framework_tags = framework_tags.is_a?(Array) ? framework_tags.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : framework_tags
  Jsii::Type.check_type(@framework_tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "frameworkTags") unless @framework_tags.nil?
end

Instance Attribute Details

#framework_controls ⇒ AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::Backup::CfnFramework::FrameworkControlProperty> (readonly)

Contains detailed information about all of the controls of a framework.

Each framework must contain at least one control.

Returns:

See Also:



30
31
32
 
# File 'backup/cfn_framework_props.rb', line 30

def framework_controls
  @framework_controls
end

#framework_description ⇒ String? (readonly)

An optional description of the framework with a maximum 1,024 characters.

Returns:

  • (String, nil)

See Also:



35
36
37
 
# File 'backup/cfn_framework_props.rb', line 35

def framework_description
  @framework_description
end

#framework_name ⇒ String? (readonly)

The unique name of a framework.

This name is between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).

Returns:

  • (String, nil)

See Also:



42
43
44
 
# File 'backup/cfn_framework_props.rb', line 42

def framework_name
  @framework_name
end

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

The tags to assign to your framework.

Returns:

See Also:



47
48
49
 
# File 'backup/cfn_framework_props.rb', line 47

def framework_tags
  @framework_tags
end

Class Method Details

.jsii_properties ⇒ Object 



49
50
51
52
53
54
55
56
 
# File 'backup/cfn_framework_props.rb', line 49

def self.jsii_properties
  {
    :framework_controls => "frameworkControls",
    :framework_description => "frameworkDescription",
    :framework_name => "frameworkName",
    :framework_tags => "frameworkTags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



58
59
60
61
62
63
64
65
66
67
 
# File 'backup/cfn_framework_props.rb', line 58

def to_jsii
  result = {}
  result.merge!({
    "frameworkControls" => @framework_controls,
    "frameworkDescription" => @framework_description,
    "frameworkName" => @framework_name,
    "frameworkTags" => @framework_tags,
  })
  result.compact
end