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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:36.698Z")
 @Stability(value=Stable)
public class CfnAssessment
extends CfnResource
implements IInspectable

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

The AWS::AuditManager::Assessment resource is an AWS 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())
         .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 in scope for the assessment.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnAssessment(software.constructs.Construct scope, String id) Create a new `AWS::AuditManager::Assessment`.
	CfnAssessment(software.constructs.Construct scope, 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

Modifier and Type	Method and Description
Object	getAssessmentReportsDestination() The destination that evidence reports are stored in for the assessment.
String	getAttrArn() The Amazon Resource Name (ARN) of the assessment.
String	getAttrAssessmentId() The unique identifier for the assessment.
IResolvable	getAttrCreationTime() The time when the assessment was created.
IResolvable	getAttrDelegations() The delegations associated with the assessment.
Object	getAwsAccount() The AWS account that's associated with the assessment.
protected Map<String,Object>	getCfnProperties()
String	getDescription() The description of the assessment.
String	getFrameworkId() The unique identifier for the framework.
String	getName() The name of the assessment.
Object	getRoles() The roles that are associated with the assessment.
Object	getScope() The wrapper of AWS accounts and services that are in scope for the assessment.
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 Map<String,Object>	renderProperties(Map<String,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	setDescription(String value) The description of the assessment.
void	setFrameworkId(String value) The unique identifier for the framework.
void	setName(String value) The name of the assessment.
void	setRoles(IResolvable value) The roles that are associated with the assessment.
void	setRoles(List<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(String value) The overall status of the assessment.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final 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

@Stability(value=Stable)
public CfnAssessment(@NotNull
                                              software.constructs.Construct scope,
                                              @NotNull
                                              String id,
                                              @Nullable
                                              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

@Stability(value=Stable)
public CfnAssessment(@NotNull
                                              software.constructs.Construct scope,
                                              @NotNull
                                              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

@Stability(value=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(value=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(value=Stable)
 @NotNull
public 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

@Stability(value=Stable)
 @NotNull
public String getAttrAssessmentId()

The unique identifier for the assessment.

For example, 111A1A1A-22B2-33C3-DDD4-55E5E5E555E5 .

getAttrCreationTime

@Stability(value=Stable)
 @NotNull
public IResolvable getAttrCreationTime()

The time when the assessment was created.

For example, 1607582033.373 .

getAttrDelegations

@Stability(value=Stable)
 @NotNull
public IResolvable getAttrDelegations()

The delegations associated with the assessment.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

The tags that are associated with the assessment.

getAssessmentReportsDestination

@Stability(value=Stable)
 @Nullable
public Object getAssessmentReportsDestination()

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

setAssessmentReportsDestination

@Stability(value=Stable)
public void setAssessmentReportsDestination(@Nullable
                                                                     CfnAssessment.AssessmentReportsDestinationProperty value)

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

setAssessmentReportsDestination

@Stability(value=Stable)
public void setAssessmentReportsDestination(@Nullable
                                                                     IResolvable value)

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

getAwsAccount

@Stability(value=Stable)
 @Nullable
public Object getAwsAccount()

The AWS account that's associated with the assessment.

setAwsAccount

@Stability(value=Stable)
public void setAwsAccount(@Nullable
                                                   CfnAssessment.AWSAccountProperty value)

The AWS account that's associated with the assessment.

setAwsAccount

@Stability(value=Stable)
public void setAwsAccount(@Nullable
                                                   IResolvable value)

The AWS account that's associated with the assessment.

getDescription

@Stability(value=Stable)
 @Nullable
public String getDescription()

The description of the assessment.

setDescription

@Stability(value=Stable)
public void setDescription(@Nullable
                                                    String value)

The description of the assessment.

getFrameworkId

@Stability(value=Stable)
 @Nullable
public String getFrameworkId()

The unique identifier for the framework.

setFrameworkId

@Stability(value=Stable)
public void setFrameworkId(@Nullable
                                                    String value)

The unique identifier for the framework.

getName

@Stability(value=Stable)
 @Nullable
public String getName()

The name of the assessment.

setName

@Stability(value=Stable)
public void setName(@Nullable
                                             String value)

The name of the assessment.

getRoles

@Stability(value=Stable)
 @Nullable
public Object getRoles()

The roles that are associated with the assessment.

setRoles

@Stability(value=Stable)
public void setRoles(@Nullable
                                              IResolvable value)

The roles that are associated with the assessment.

setRoles

@Stability(value=Stable)
public void setRoles(@Nullable
                                              List<Object> value)

The roles that are associated with the assessment.

getScope

@Stability(value=Stable)
 @Nullable
public Object getScope()

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

setScope

@Stability(value=Stable)
public void setScope(@Nullable
                                              CfnAssessment.ScopeProperty value)

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

setScope

@Stability(value=Stable)
public void setScope(@Nullable
                                              IResolvable value)

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

getStatus

@Stability(value=Stable)
 @Nullable
public String getStatus()

The overall status of the assessment.

setStatus

@Stability(value=Stable)
public void setStatus(@Nullable
                                               String value)

The overall status of the assessment.