Class: AWSCDK::AuditManager::CfnAssessmentProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
audit_manager/cfn_assessment_props.rb

Overview

Properties for defining a CfnAssessment.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(assessment_reports_destination: nil, aws_account: nil, delegations: nil, description: nil, framework_id: nil, name: nil, roles: nil, scope: nil, status: nil, tags: nil) ⇒ CfnAssessmentProps

Returns a new instance of CfnAssessmentProps.

Parameters:



19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
 
# File 'audit_manager/cfn_assessment_props.rb', line 19

def initialize(assessment_reports_destination: nil, aws_account: nil, delegations: nil, description: nil, framework_id: nil, name: nil, roles: nil, scope: nil, status: nil, tags: nil)
  @assessment_reports_destination = assessment_reports_destination.is_a?(Hash) ? ::AWSCDK::AuditManager::CfnAssessment::AssessmentReportsDestinationProperty.new(**assessment_reports_destination.transform_keys(&:to_sym)) : assessment_reports_destination
  Jsii::Type.check_type(@assessment_reports_destination, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hdWRpdG1hbmFnZXIuQ2ZuQXNzZXNzbWVudC5Bc3Nlc3NtZW50UmVwb3J0c0Rlc3RpbmF0aW9uUHJvcGVydHkifV19fQ==")), "assessmentReportsDestination") unless @assessment_reports_destination.nil?
  @aws_account = .is_a?(Hash) ? ::AWSCDK::AuditManager::CfnAssessment::AWSAccountProperty.new(**.transform_keys(&:to_sym)) : 
  Jsii::Type.check_type(@aws_account, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hdWRpdG1hbmFnZXIuQ2ZuQXNzZXNzbWVudC5BV1NBY2NvdW50UHJvcGVydHkifV19fQ==")), "awsAccount") unless @aws_account.nil?
  @delegations = delegations
  Jsii::Type.check_type(@delegations, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXVkaXRtYW5hZ2VyLkNmbkFzc2Vzc21lbnQuRGVsZWdhdGlvblByb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "delegations") unless @delegations.nil?
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @framework_id = framework_id
  Jsii::Type.check_type(@framework_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "frameworkId") unless @framework_id.nil?
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name") unless @name.nil?
  @roles = roles
  Jsii::Type.check_type(@roles, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXVkaXRtYW5hZ2VyLkNmbkFzc2Vzc21lbnQuUm9sZVByb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "roles") unless @roles.nil?
  @scope = scope.is_a?(Hash) ? ::AWSCDK::AuditManager::CfnAssessment::ScopeProperty.new(**scope.transform_keys(&:to_sym)) : scope
  Jsii::Type.check_type(@scope, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hdWRpdG1hbmFnZXIuQ2ZuQXNzZXNzbWVudC5TY29wZVByb3BlcnR5In1dfX0=")), "scope") unless @scope.nil?
  @status = status
  Jsii::Type.check_type(@status, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "status") unless @status.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

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

The destination that evidence reports are stored in for the assessment.

Returns:

See Also:



46
47
48
 
# File 'audit_manager/cfn_assessment_props.rb', line 46

def assessment_reports_destination
  @assessment_reports_destination
end

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

The AWS account that's associated with the assessment.

Returns:

See Also:



51
52
53
 
# File 'audit_manager/cfn_assessment_props.rb', line 51

def 
  @aws_account
end

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

The delegations that are associated with the assessment.

Returns:

See Also:



56
57
58
 
# File 'audit_manager/cfn_assessment_props.rb', line 56

def delegations
  @delegations
end

#description ⇒ String? (readonly)

The description of the assessment.

Returns:

  • (String, nil)

See Also:



61
62
63
 
# File 'audit_manager/cfn_assessment_props.rb', line 61

def description
  @description
end

#framework_id ⇒ String? (readonly)

The unique identifier for the framework.

Returns:

  • (String, nil)

See Also:



66
67
68
 
# File 'audit_manager/cfn_assessment_props.rb', line 66

def framework_id
  @framework_id
end

#name ⇒ String? (readonly)

The name of the assessment.

Returns:

  • (String, nil)

See Also:



71
72
73
 
# File 'audit_manager/cfn_assessment_props.rb', line 71

def name
  @name
end

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

The roles that are associated with the assessment.

Returns:

See Also:



76
77
78
 
# File 'audit_manager/cfn_assessment_props.rb', line 76

def roles
  @roles
end

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

The wrapper of AWS accounts and services that are in scope for the assessment.

Returns:

See Also:



81
82
83
 
# File 'audit_manager/cfn_assessment_props.rb', line 81

def scope
  @scope
end

#status ⇒ String? (readonly)

The overall status of the assessment.

When you create a new assessment, the initial Status value is always ACTIVE . When you create an assessment, even if you specify the value as INACTIVE , the value overrides to ACTIVE .

After you create an assessment, you can change the value of the Status property at any time. For example, when you want to stop collecting evidence for your assessment, you can change the assessment status to INACTIVE .

Returns:

  • (String, nil)

See Also:



90
91
92
 
# File 'audit_manager/cfn_assessment_props.rb', line 90

def status
  @status
end

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

The tags that are associated with the assessment.

Returns:

See Also:



95
96
97
 
# File 'audit_manager/cfn_assessment_props.rb', line 95

def tags
  @tags
end

Class Method Details

.jsii_properties ⇒ Object 



97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'audit_manager/cfn_assessment_props.rb', line 97

def self.jsii_properties
  {
    :assessment_reports_destination => "assessmentReportsDestination",
    :aws_account => "awsAccount",
    :delegations => "delegations",
    :description => "description",
    :framework_id => "frameworkId",
    :name => "name",
    :roles => "roles",
    :scope => "scope",
    :status => "status",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'audit_manager/cfn_assessment_props.rb', line 112

def to_jsii
  result = {}
  result.merge!({
    "assessmentReportsDestination" => @assessment_reports_destination,
    "awsAccount" => @aws_account,
    "delegations" => @delegations,
    "description" => @description,
    "frameworkId" => @framework_id,
    "name" => @name,
    "roles" => @roles,
    "scope" => @scope,
    "status" => @status,
    "tags" => @tags,
  })
  result.compact
end