Package software.amazon.awscdk.services.auditmanager

Interface CfnAssessmentProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnAssessmentProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:29:55.791Z")
@Stability(Stable)
public interface CfnAssessmentProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnAssessment.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.auditmanager.*;
 CfnAssessmentProps cfnAssessmentProps = CfnAssessmentProps.builder()
         .assessmentReportsDestination(AssessmentReportsDestinationProperty.builder()
                 .destination("destination")
                 .destinationType("destinationType")
                 .build())
         .awsAccount(AWSAccountProperty.builder()
                 .emailAddress("emailAddress")
                 .id("id")
                 .name("name")
                 .build())
         .delegations(List.of(DelegationProperty.builder()
                 .assessmentId("assessmentId")
                 .assessmentName("assessmentName")
                 .comment("comment")
                 .controlSetId("controlSetId")
                 .createdBy("createdBy")
                 .creationTime(123)
                 .id("id")
                 .lastUpdated(123)
                 .roleArn("roleArn")
                 .roleType("roleType")
                 .status("status")
                 .build()))
         .description("description")
         .frameworkId("frameworkId")
         .name("name")
         .roles(List.of(RoleProperty.builder()
                 .roleArn("roleArn")
                 .roleType("roleType")
                 .build()))
         .scope(ScopeProperty.builder()
                 .awsAccounts(List.of(AWSAccountProperty.builder()
                         .emailAddress("emailAddress")
                         .id("id")
                         .name("name")
                         .build()))
                 .awsServices(List.of(AWSServiceProperty.builder()
                         .serviceName("serviceName")
                         .build()))
                 .build())
         .status("status")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnAssessmentProps.Builder	A builder for CfnAssessmentProps
static final class	CfnAssessmentProps.Jsii$Proxy	An implementation for CfnAssessmentProps

Method Summary

Modifier and Type	Method	Description
static CfnAssessmentProps.Builder	builder()
default Object	getAssessmentReportsDestination()	The destination that evidence reports are stored in for the assessment.
default Object	getAwsAccount()	The AWS account that's associated with the assessment.
default Object	getDelegations()	The delegations that are associated with the assessment.
default String	getDescription()	The description of the assessment.
default String	getFrameworkId()	The unique identifier for the framework.
default String	getName()	The name of the assessment.
default Object	getRoles()	The roles that are associated with the assessment.
default Object	getScope()	The wrapper of AWS accounts and services that are in scope for the assessment.
default String	getStatus()	The overall status of the assessment.
default List<CfnTag>	getTags()	The tags that are associated with the assessment.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAssessmentReportsDestination

@Stability(Stable)
@Nullable
default Object getAssessmentReportsDestination()

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

getAwsAccount

@Stability(Stable)
@Nullable
default Object getAwsAccount()

The AWS account that's associated with the assessment.

getDelegations

@Stability(Stable)
@Nullable
default Object getDelegations()

The delegations that are associated with the assessment.

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

The description of the assessment.

getFrameworkId

@Stability(Stable)
@Nullable
default String getFrameworkId()

The unique identifier for the framework.

getName

@Stability(Stable)
@Nullable
default String getName()

The name of the assessment.

getRoles

@Stability(Stable)
@Nullable
default Object getRoles()

The roles that are associated with the assessment.

getScope

@Stability(Stable)
@Nullable
default Object getScope()

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

getStatus

@Stability(Stable)
@Nullable
default String getStatus()

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 .

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

The tags that are associated with the assessment.

builder

@Stability(Stable)
static CfnAssessmentProps.Builder builder()

Returns:

a CfnAssessmentProps.Builder of CfnAssessmentProps