CfnAssessmentProps
- class aws_cdk.aws_auditmanager.CfnAssessmentProps(*, assessment_reports_destination=None, aws_account=None, delegations=None, description=None, framework_id=None, name=None, roles=None, scope=None, status=None, tags=None)
Bases:
object
Properties for defining a
CfnAssessment
.- Parameters:
assessment_reports_destination (
Union
[IResolvable
,AssessmentReportsDestinationProperty
,Dict
[str
,Any
],None
]) – The destination that evidence reports are stored in for the assessment.aws_account (
Union
[IResolvable
,AWSAccountProperty
,Dict
[str
,Any
],None
]) – The AWS account that’s associated with the assessment.delegations (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,DelegationProperty
,Dict
[str
,Any
]]],None
]) – The delegations that are associated with the assessment.description (
Optional
[str
]) – The description of the assessment.framework_id (
Optional
[str
]) – The unique identifier for the framework.name (
Optional
[str
]) – The name of the assessment.roles (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,RoleProperty
,Dict
[str
,Any
]]],None
]) – The roles that are associated with the assessment.scope (
Union
[IResolvable
,ScopeProperty
,Dict
[str
,Any
],None
]) – The wrapper of AWS accounts and services that are in scope for the assessment.status (
Optional
[str
]) – The overall status of the assessment. When you create a new assessment, the initialStatus
value is alwaysACTIVE
. When you create an assessment, even if you specify the value asINACTIVE
, the value overrides toACTIVE
. After you create an assessment, you can change the value of theStatus
property at any time. For example, when you want to stop collecting evidence for your assessment, you can change the assessment status toINACTIVE
.tags (
Optional
[Sequence
[Union
[CfnTag
,Dict
[str
,Any
]]]]) – The tags that are associated with the assessment.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_auditmanager as auditmanager cfn_assessment_props = auditmanager.CfnAssessmentProps( assessment_reports_destination=auditmanager.CfnAssessment.AssessmentReportsDestinationProperty( destination="destination", destination_type="destinationType" ), aws_account=auditmanager.CfnAssessment.AWSAccountProperty( email_address="emailAddress", id="id", name="name" ), delegations=[auditmanager.CfnAssessment.DelegationProperty( assessment_id="assessmentId", assessment_name="assessmentName", comment="comment", control_set_id="controlSetId", created_by="createdBy", creation_time=123, id="id", last_updated=123, role_arn="roleArn", role_type="roleType", status="status" )], description="description", framework_id="frameworkId", name="name", roles=[auditmanager.CfnAssessment.RoleProperty( role_arn="roleArn", role_type="roleType" )], scope=auditmanager.CfnAssessment.ScopeProperty( aws_accounts=[auditmanager.CfnAssessment.AWSAccountProperty( email_address="emailAddress", id="id", name="name" )], aws_services=[auditmanager.CfnAssessment.AWSServiceProperty( service_name="serviceName" )] ), status="status", tags=[CfnTag( key="key", value="value" )] )
Attributes
- assessment_reports_destination
The destination that evidence reports are stored in for the assessment.
- aws_account
The AWS account that’s associated with the assessment.
- delegations
The delegations that are associated with the assessment.
- description
The description of the assessment.
- framework_id
The unique identifier for the framework.
- name
The name of the assessment.
- roles
The roles that are associated with the assessment.
- scope
The wrapper of AWS accounts and services that are in scope for the assessment.
- status
The overall status of the assessment.
When you create a new assessment, the initial
Status
value is alwaysACTIVE
. When you create an assessment, even if you specify the value asINACTIVE
, the value overrides toACTIVE
.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 toINACTIVE
.
- tags
The tags that are associated with the assessment.