Class CfnAssessment

A CloudFormation AWS::AuditManager::Assessment.

Inheritance
System.Object
Construct
CfnElement
CfnRefElement
CfnResource
CfnAssessment
Implements
Constructs.IConstruct
Inherited Members
Namespace: Amazon.CDK.AWS.AuditManager
Assembly: Amazon.CDK.AWS.AuditManager.dll
Syntax (csharp)
public class CfnAssessment : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnAssessment
    Inherits CfnResource
    Implements IConstruct, IDependable, IInspectable
Remarks

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.

CloudformationResource: AWS::AuditManager::Assessment

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-auditmanager-assessment.html

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.AuditManager;

var cfnAssessment = new CfnAssessment(this, "MyCfnAssessment", new CfnAssessmentProps {
    AssessmentReportsDestination = new AssessmentReportsDestinationProperty {
        Destination = "destination",
        DestinationType = "destinationType"
    },
    AwsAccount = new AWSAccountProperty {
        EmailAddress = "emailAddress",
        Id = "id",
        Name = "name"
    },
    Delegations = new [] { new DelegationProperty {
        AssessmentId = "assessmentId",
        AssessmentName = "assessmentName",
        Comment = "comment",
        ControlSetId = "controlSetId",
        CreatedBy = "createdBy",
        CreationTime = 123,
        Id = "id",
        LastUpdated = 123,
        RoleArn = "roleArn",
        RoleType = "roleType",
        Status = "status"
    } },
    Description = "description",
    FrameworkId = "frameworkId",
    Name = "name",
    Roles = new [] { new RoleProperty {
        RoleArn = "roleArn",
        RoleType = "roleType"
    } },
    Scope = new ScopeProperty {
        AwsAccounts = new [] { new AWSAccountProperty {
            EmailAddress = "emailAddress",
            Id = "id",
            Name = "name"
        } },
        AwsServices = new [] { new AWSServiceProperty {
            ServiceName = "serviceName"
        } }
    },
    Status = "status",
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } }
});

Synopsis

Constructors

CfnAssessment(Construct, String, ICfnAssessmentProps)

Create a new AWS::AuditManager::Assessment.
CfnAssessment(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference
CfnAssessment(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

Properties

AssessmentReportsDestination

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

The Amazon Resource Name (ARN) of the assessment.
AttrAssessmentId

The unique identifier for the assessment.
AttrCreationTime

The time when the assessment was created.
AwsAccount

The AWS account that's associated with the assessment.
CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.
CfnProperties
Delegations

The delegations that are associated with the assessment.
Description

The description of the assessment.
FrameworkId

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.
Tags

The tags that are associated with the assessment.

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<String, Object>)

Constructors

CfnAssessment(Construct, String, ICfnAssessmentProps)

Create a new AWS::AuditManager::Assessment.

public CfnAssessment(Construct scope, string id, ICfnAssessmentProps props = null)
Parameters
scope Construct
  • scope in which this resource is defined.
id System.String
  • scoped id of the resource.
props ICfnAssessmentProps
  • resource properties.

CfnAssessment(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected CfnAssessment(ByRefValue reference)
Parameters
reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

CfnAssessment(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected CfnAssessment(DeputyBase.DeputyProps props)
Parameters
props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

Properties

AssessmentReportsDestination

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

public virtual object AssessmentReportsDestination { get; set; }
Property Value

System.Object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-auditmanager-assessment.html#cfn-auditmanager-assessment-assessmentreportsdestination

AttrArn

The Amazon Resource Name (ARN) of the assessment.

public virtual string AttrArn { get; }
Property Value

System.String

Remarks

For example, arn:aws:auditmanager:us-east-1:123456789012:assessment/111A1A1A-22B2-33C3-DDD4-55E5E5E555E5 .

CloudformationAttribute: Arn

AttrAssessmentId

The unique identifier for the assessment.

public virtual string AttrAssessmentId { get; }
Property Value

System.String

Remarks

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

CloudformationAttribute: AssessmentId

AttrCreationTime

The time when the assessment was created.

public virtual IResolvable AttrCreationTime { get; }
Property Value

IResolvable

Remarks

For example, 1607582033.373 .

CloudformationAttribute: CreationTime

AwsAccount

The AWS account that's associated with the assessment.

public virtual object AwsAccount { get; set; }
Property Value

System.Object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-auditmanager-assessment.html#cfn-auditmanager-assessment-awsaccount

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value

System.String

CfnProperties

protected override IDictionary<string, object> CfnProperties { get; }
Property Value

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

Delegations

The delegations that are associated with the assessment.

public virtual object Delegations { get; set; }
Property Value

System.Object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-auditmanager-assessment.html#cfn-auditmanager-assessment-delegations

Description

The description of the assessment.

public virtual string Description { get; set; }
Property Value

System.String

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-auditmanager-assessment.html#cfn-auditmanager-assessment-description

FrameworkId

The unique identifier for the framework.

public virtual string FrameworkId { get; set; }
Property Value

System.String

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-auditmanager-assessment.html#cfn-auditmanager-assessment-frameworkid

Name

The name of the assessment.

public virtual string Name { get; set; }
Property Value

System.String

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-auditmanager-assessment.html#cfn-auditmanager-assessment-name

Roles

The roles that are associated with the assessment.

public virtual object Roles { get; set; }
Property Value

System.Object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-auditmanager-assessment.html#cfn-auditmanager-assessment-roles

Scope

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

public virtual object Scope { get; set; }
Property Value

System.Object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-auditmanager-assessment.html#cfn-auditmanager-assessment-scope

Status

The overall status of the assessment.

public virtual string Status { get; set; }
Property Value

System.String

Remarks

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 .

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-auditmanager-assessment.html#cfn-auditmanager-assessment-status

Tags

The tags that are associated with the assessment.

public virtual TagManager Tags { get; }
Property Value

TagManager

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-auditmanager-assessment.html#cfn-auditmanager-assessment-tags

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)
Parameters
inspector TreeInspector
  • tree inspector to collect and process attributes.

RenderProperties(IDictionary<String, Object>)

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

Implements

Constructs.IConstruct