Package software.amazon.awscdk.services.auditmanager

Class CfnAssessment

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.auditmanager.CfnAssessment
All Implemented Interfaces:
IInspectable, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)", date="2024-10-05T03:43:39.004Z") @Stability(Stable) public class CfnAssessment extends CfnResource implements IInspectable, ITaggable
The AWS::AuditManager::Assessment resource is an Audit Manager resource type that defines the scope of audit evidence collected by Audit Manager .

An Audit Manager assessment is an implementation of an Audit Manager framework.

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.*;
 CfnAssessment cfnAssessment = CfnAssessment.Builder.create(this, "MyCfnAssessment")
         .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();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnAssessment

      protected CfnAssessment(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnAssessment

      protected CfnAssessment(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnAssessment

      @Stability(Stable) public CfnAssessment(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable CfnAssessmentProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties.

    • CfnAssessment

      @Stability(Stable) public CfnAssessment(@NotNull software.constructs.Construct scope, @NotNull String id)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) of the assessment.

    • getAttrAssessmentId

      @Stability(Stable) @NotNull public String getAttrAssessmentId()
      The unique identifier for the assessment.

    • getAttrCreationTime

      @Stability(Stable) @NotNull public IResolvable getAttrCreationTime()
      Specifies when the assessment was created.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getAssessmentReportsDestination

      @Stability(Stable) @Nullable public Object getAssessmentReportsDestination()
      The destination that evidence reports are stored in for the assessment.

    • setAssessmentReportsDestination

      @Stability(Stable) public void setAssessmentReportsDestination(@Nullable IResolvable value)
      The destination that evidence reports are stored in for the assessment.

    • setAssessmentReportsDestination

      @Stability(Stable) public void setAssessmentReportsDestination(@Nullable CfnAssessment.AssessmentReportsDestinationProperty value)
      The destination that evidence reports are stored in for the assessment.

    • getAwsAccount

      @Stability(Stable) @Nullable public Object getAwsAccount()
      The AWS account that's associated with the assessment.

    • setAwsAccount

      @Stability(Stable) public void setAwsAccount(@Nullable IResolvable value)
      The AWS account that's associated with the assessment.

    • setAwsAccount

      @Stability(Stable) public void setAwsAccount(@Nullable CfnAssessment.AWSAccountProperty value)
      The AWS account that's associated with the assessment.

    • getDelegations

      @Stability(Stable) @Nullable public Object getDelegations()
      The delegations that are associated with the assessment.

    • setDelegations

      @Stability(Stable) public void setDelegations(@Nullable IResolvable value)
      The delegations that are associated with the assessment.

    • setDelegations

      @Stability(Stable) public void setDelegations(@Nullable List<Object> value)
      The delegations that are associated with the assessment.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      The description of the assessment.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      The description of the assessment.

    • getFrameworkId

      @Stability(Stable) @Nullable public String getFrameworkId()
      The unique identifier for the framework.

    • setFrameworkId

      @Stability(Stable) public void setFrameworkId(@Nullable String value)
      The unique identifier for the framework.

    • getName

      @Stability(Stable) @Nullable public String getName()
      The name of the assessment.

    • setName

      @Stability(Stable) public void setName(@Nullable String value)
      The name of the assessment.

    • getRoles

      @Stability(Stable) @Nullable public Object getRoles()
      The roles that are associated with the assessment.

    • setRoles

      @Stability(Stable) public void setRoles(@Nullable IResolvable value)
      The roles that are associated with the assessment.

    • setRoles

      @Stability(Stable) public void setRoles(@Nullable List<Object> value)
      The roles that are associated with the assessment.

    • getScope

      @Stability(Stable) @Nullable public Object getScope()
      The wrapper of AWS accounts and services that are in scope for the assessment.

    • setScope

      @Stability(Stable) public void setScope(@Nullable IResolvable value)
      The wrapper of AWS accounts and services that are in scope for the assessment.

    • setScope

      @Stability(Stable) public void setScope(@Nullable CfnAssessment.ScopeProperty value)
      The wrapper of AWS accounts and services that are in scope for the assessment.

    • getStatus

      @Stability(Stable) @Nullable public String getStatus()
      The overall status of the assessment.

    • setStatus

      @Stability(Stable) public void setStatus(@Nullable String value)
      The overall status of the assessment.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      The tags that are associated with the assessment.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      The tags that are associated with the assessment.