CfnAssessment

java.lang.Object
- software.constructs.Construct
- - software.amazon.awscdk.core.Construct
  - - software.amazon.awscdk.core.CfnElement
    - - software.amazon.awscdk.core.CfnRefElement
      - software.amazon.awscdk.core.CfnResource
        
        software.amazon.awscdk.services.auditmanager.CfnAssessment

All Implemented Interfaces:: IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:35.505Z")
public class CfnAssessment
extends CfnResource
implements IInspectable

A CloudFormation `AWS::AuditManager::Assessment`.

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();

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CfnAssessment.AssessmentReportsDestinationProperty` The `AssessmentReportsDestination` property type specifies the location in which AWS Audit Manager saves assessment reports for the given assessment.
`static interface`	`CfnAssessment.AWSAccountProperty` The `AWSAccount` property type specifies the wrapper of the AWS account details, such as account ID, email address, and so on.
`static interface`	`CfnAssessment.AWSServiceProperty` The `AWSService` property type specifies an AWS service such as Amazon S3 , AWS CloudTrail , and so on.
`static class`	`CfnAssessment.Builder` A fluent builder for `CfnAssessment`.
`static interface`	`CfnAssessment.DelegationProperty` The `Delegation` property type specifies the assignment of a control set to a delegate for review.
`static interface`	`CfnAssessment.RoleProperty` The `Role` property type specifies the wrapper that contains AWS Audit Manager role information, such as the role type and IAM Amazon Resource Name (ARN).
`static interface`	`CfnAssessment.ScopeProperty` The `Scope` property type specifies the wrapper that contains the AWS accounts and services that are in scope for the assessment.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
IConstruct.Jsii$Default

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`CFN_RESOURCE_TYPE_NAME` The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors
Modifier	Constructor and Description
	`CfnAssessment(Construct scope, java.lang.String id)` Create a new `AWS::AuditManager::Assessment`.
	`CfnAssessment(Construct scope, java.lang.String id, CfnAssessmentProps props)` Create a new `AWS::AuditManager::Assessment`.
`protected`	`CfnAssessment(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)`
`protected`	`CfnAssessment(software.amazon.jsii.JsiiObjectRef objRef)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.Object`	`getAssessmentReportsDestination()` The destination that evidence reports are stored in for the assessment.
`java.lang.String`	`getAttrArn()` The Amazon Resource Name (ARN) of the assessment.
`java.lang.String`	`getAttrAssessmentId()` The unique identifier for the assessment.
`IResolvable`	`getAttrCreationTime()` The time when the assessment was created.
`java.lang.Object`	`getAwsAccount()` The AWS account that's associated with the assessment.
`protected java.util.Map<java.lang.String,java.lang.Object>`	`getCfnProperties()`
`java.lang.Object`	`getDelegations()` The delegations that are associated with the assessment.
`java.lang.String`	`getDescription()` The description of the assessment.
`java.lang.String`	`getFrameworkId()` The unique identifier for the framework.
`java.lang.String`	`getName()` The name of the assessment.
`java.lang.Object`	`getRoles()` The roles that are associated with the assessment.
`java.lang.Object`	`getScope()` The wrapper of AWS accounts and services that are in scope for the assessment.
`java.lang.String`	`getStatus()` The overall status of the assessment.
`TagManager`	`getTags()` The tags that are associated with the assessment.
`void`	`inspect(TreeInspector inspector)` Examines the CloudFormation resource and discloses attributes.
`protected java.util.Map<java.lang.String,java.lang.Object>`	`renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)`
`void`	`setAssessmentReportsDestination(CfnAssessment.AssessmentReportsDestinationProperty value)` The destination that evidence reports are stored in for the assessment.
`void`	`setAssessmentReportsDestination(IResolvable value)` The destination that evidence reports are stored in for the assessment.
`void`	`setAwsAccount(CfnAssessment.AWSAccountProperty value)` The AWS account that's associated with the assessment.
`void`	`setAwsAccount(IResolvable value)` The AWS account that's associated with the assessment.
`void`	`setDelegations(IResolvable value)` The delegations that are associated with the assessment.
`void`	`setDelegations(java.util.List<java.lang.Object> value)` The delegations that are associated with the assessment.
`void`	`setDescription(java.lang.String value)` The description of the assessment.
`void`	`setFrameworkId(java.lang.String value)` The unique identifier for the framework.
`void`	`setName(java.lang.String value)` The name of the assessment.
`void`	`setRoles(IResolvable value)` The roles that are associated with the assessment.
`void`	`setRoles(java.util.List<java.lang.Object> value)` The roles that are associated with the assessment.
`void`	`setScope(CfnAssessment.ScopeProperty value)` The wrapper of AWS accounts and services that are in scope for the assessment.
`void`	`setScope(IResolvable value)` The wrapper of AWS accounts and services that are in scope for the assessment.
`void`	`setStatus(java.lang.String value)` The overall status of the assessment.

Methods inherited from class software.amazon.awscdk.core.CfnResource
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement
getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - CFN_RESOURCE_TYPE_NAME
```
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
```
    The CloudFormation resource type name for this resource class.
- Constructor Detail
  - CfnAssessment
```
protected CfnAssessment(software.amazon.jsii.JsiiObjectRef objRef)
```
  - CfnAssessment
```
protected CfnAssessment(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
```
  - CfnAssessment
```
public CfnAssessment(Construct scope,
                     java.lang.String id,
                     CfnAssessmentProps props)
```
    Create a new `AWS::AuditManager::Assessment`.
    
    Parameters:
    
    scope - - scope in which this resource is defined. This parameter is required.
    
    id - - scoped id of the resource. This parameter is required.
    
    props - - resource properties.
  - CfnAssessment
```
public CfnAssessment(Construct scope,
                     java.lang.String id)
```
    Create a new `AWS::AuditManager::Assessment`.
    
    Parameters:
    
    scope - - scope in which this resource is defined. This parameter is required.
    
    id - - scoped id of the resource. This parameter is required.
- Method Detail
  - inspect
```
public void inspect(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
```
protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
```
    Overrides:
    
    renderProperties in class CfnResource
    
    Parameters:
    
    props - This parameter is required.
  - getAttrArn
```
public java.lang.String getAttrArn()
```
    The Amazon Resource Name (ARN) of the assessment.
    For example, arn:aws:auditmanager:us-east-1:123456789012:assessment/111A1A1A-22B2-33C3-DDD4-55E5E5E555E5 .
  - getAttrAssessmentId
```
public java.lang.String getAttrAssessmentId()
```
    The unique identifier for the assessment.
    For example, 111A1A1A-22B2-33C3-DDD4-55E5E5E555E5 .
  - getAttrCreationTime
```
public IResolvable getAttrCreationTime()
```
    The time when the assessment was created.
    For example, 1607582033.373 .
  - getCfnProperties
```
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
```
    Overrides:
    
    getCfnProperties in class CfnResource
  - getTags
```
public TagManager getTags()
```
    The tags that are associated with the assessment.
  - getAssessmentReportsDestination
```
public java.lang.Object getAssessmentReportsDestination()
```
    The destination that evidence reports are stored in for the assessment.
  - setAssessmentReportsDestination
```
public void setAssessmentReportsDestination(CfnAssessment.AssessmentReportsDestinationProperty value)
```
    The destination that evidence reports are stored in for the assessment.
  - setAssessmentReportsDestination
```
public void setAssessmentReportsDestination(IResolvable value)
```
    The destination that evidence reports are stored in for the assessment.
  - getAwsAccount
```
public java.lang.Object getAwsAccount()
```
    The AWS account that's associated with the assessment.
  - setAwsAccount
```
public void setAwsAccount(IResolvable value)
```
    The AWS account that's associated with the assessment.
  - setAwsAccount
```
public void setAwsAccount(CfnAssessment.AWSAccountProperty value)
```
    The AWS account that's associated with the assessment.
  - getDelegations
```
public java.lang.Object getDelegations()
```
    The delegations that are associated with the assessment.
  - setDelegations
```
public void setDelegations(IResolvable value)
```
    The delegations that are associated with the assessment.
  - setDelegations
```
public void setDelegations(java.util.List<java.lang.Object> value)
```
    The delegations that are associated with the assessment.
  - getDescription
```
public java.lang.String getDescription()
```
    The description of the assessment.
  - setDescription
```
public void setDescription(java.lang.String value)
```
    The description of the assessment.
  - getFrameworkId
```
public java.lang.String getFrameworkId()
```
    The unique identifier for the framework.
  - setFrameworkId
```
public void setFrameworkId(java.lang.String value)
```
    The unique identifier for the framework.
  - getName
```
public java.lang.String getName()
```
    The name of the assessment.
  - setName
```
public void setName(java.lang.String value)
```
    The name of the assessment.
  - getRoles
```
public java.lang.Object getRoles()
```
    The roles that are associated with the assessment.
  - setRoles
```
public void setRoles(IResolvable value)
```
    The roles that are associated with the assessment.
  - setRoles
```
public void setRoles(java.util.List<java.lang.Object> value)
```
    The roles that are associated with the assessment.
  - getScope
```
public java.lang.Object getScope()
```
    The wrapper of AWS accounts and services that are in scope for the assessment.
  - setScope
```
public void setScope(IResolvable value)
```
    The wrapper of AWS accounts and services that are in scope for the assessment.
  - setScope
```
public void setScope(CfnAssessment.ScopeProperty value)
```
    The wrapper of AWS accounts and services that are in scope for the assessment.
  - getStatus
```
public java.lang.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 .
  - setStatus
```
public void setStatus(java.lang.String value)
```
    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 .

Class CfnAssessment

Nested Class Summary

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

Field Summary

Constructor Summary

Method Summary

Methods inherited from class software.amazon.awscdk.core.CfnResource

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

Methods inherited from class software.amazon.awscdk.core.CfnElement

Methods inherited from class software.amazon.awscdk.core.Construct

Methods inherited from class java.lang.Object

Field Detail

CFN_RESOURCE_TYPE_NAME

Constructor Detail

CfnAssessment

CfnAssessment

CfnAssessment

CfnAssessment

Method Detail

inspect

renderProperties

getAttrArn

getAttrAssessmentId

getAttrCreationTime

getCfnProperties

getTags

getAssessmentReportsDestination

setAssessmentReportsDestination

setAssessmentReportsDestination

getAwsAccount

setAwsAccount

setAwsAccount

getDelegations

setDelegations

setDelegations

getDescription

setDescription

getFrameworkId

setFrameworkId

getName

setName

getRoles

setRoles

setRoles

getScope

setScope

setScope

getStatus

setStatus