Class: AWSCDK::AccessAnalyzer::CfnAnalyzerProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
access_analyzer/cfn_analyzer_props.rb

Overview

Properties for defining a CfnAnalyzer.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(type:, analyzer_configuration: nil, analyzer_name: nil, archive_rules: nil, tags: nil) ⇒ CfnAnalyzerProps

Returns a new instance of CfnAnalyzerProps.

Parameters:



14
15
16
17
18
19
20
21
22
23
24
25
 
# File 'access_analyzer/cfn_analyzer_props.rb', line 14

def initialize(type:, analyzer_configuration: nil, analyzer_name: nil, archive_rules: nil, tags: nil)
  @type = type
  Jsii::Type.check_type(@type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "type")
  @analyzer_configuration = analyzer_configuration.is_a?(Hash) ? ::AWSCDK::AccessAnalyzer::CfnAnalyzer::AnalyzerConfigurationProperty.new(**analyzer_configuration.transform_keys(&:to_sym)) : analyzer_configuration
  Jsii::Type.check_type(@analyzer_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hY2Nlc3NhbmFseXplci5DZm5BbmFseXplci5BbmFseXplckNvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "analyzerConfiguration") unless @analyzer_configuration.nil?
  @analyzer_name = analyzer_name
  Jsii::Type.check_type(@analyzer_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "analyzerName") unless @analyzer_name.nil?
  @archive_rules = archive_rules
  Jsii::Type.check_type(@archive_rules, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYWNjZXNzYW5hbHl6ZXIuQ2ZuQW5hbHl6ZXIuQXJjaGl2ZVJ1bGVQcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "archiveRules") unless @archive_rules.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

#analyzer_configuration ⇒ AWSCDK::IResolvable, ... (readonly)

Contains information about the configuration of an analyzer for an AWS organization or account.

Returns:

See Also:



38
39
40
 
# File 'access_analyzer/cfn_analyzer_props.rb', line 38

def analyzer_configuration
  @analyzer_configuration
end

#analyzer_name ⇒ String? (readonly)

The name of the analyzer.

Returns:

  • (String, nil)

See Also:



43
44
45
 
# File 'access_analyzer/cfn_analyzer_props.rb', line 43

def analyzer_name
  @analyzer_name
end

#archive_rules ⇒ AWSCDK::IResolvable, ... (readonly)

Specifies the archive rules to add for the analyzer.

Archive rules automatically archive findings that meet the criteria you define for the rule.

Returns:

See Also:



50
51
52
 
# File 'access_analyzer/cfn_analyzer_props.rb', line 50

def archive_rules
  @archive_rules
end

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

An array of key-value pairs to apply to the analyzer.

You can use the set of Unicode letters, digits, whitespace, _ , . , / , = , + , and - .

For the tag key, you can specify a value that is 1 to 128 characters in length and cannot be prefixed with aws: .

For the tag value, you can specify a value that is 0 to 256 characters in length.

Returns:

See Also:



61
62
63
 
# File 'access_analyzer/cfn_analyzer_props.rb', line 61

def tags
  @tags
end

#type ⇒ String (readonly)

The type represents the zone of trust for the analyzer.

Allowed Values : ACCOUNT | ORGANIZATION | ACCOUNT_UNUSED_ACCESS | ACCOUNT_INTERNAL_ACCESS | ORGANIZATION_INTERNAL_ACCESS | ORGANIZATION_UNUSED_ACCESS

Returns:

  • (String)

See Also:



33
34
35
 
# File 'access_analyzer/cfn_analyzer_props.rb', line 33

def type
  @type
end

Class Method Details

.jsii_properties ⇒ Object 



63
64
65
66
67
68
69
70
71
 
# File 'access_analyzer/cfn_analyzer_props.rb', line 63

def self.jsii_properties
  {
    :type => "type",
    :analyzer_configuration => "analyzerConfiguration",
    :analyzer_name => "analyzerName",
    :archive_rules => "archiveRules",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



73
74
75
76
77
78
79
80
81
82
83
 
# File 'access_analyzer/cfn_analyzer_props.rb', line 73

def to_jsii
  result = {}
  result.merge!({
    "type" => @type,
    "analyzerConfiguration" => @analyzer_configuration,
    "analyzerName" => @analyzer_name,
    "archiveRules" => @archive_rules,
    "tags" => @tags,
  })
  result.compact
end