CfnAssessmentProps

class aws_cdk.aws_auditmanager.CfnAssessmentProps(*, assessment_reports_destination=None, aws_account=None, description=None, framework_id=None, name=None, roles=None, scope=None, status=None, tags=None)

Bases: object

Properties for defining a CfnAssessment.

Parameters
  • assessment_reports_destination (Union[AssessmentReportsDestinationProperty, IResolvable, None]) – The destination that evidence reports are stored in for the assessment.

  • aws_account (Union[IResolvable, AWSAccountProperty, None]) – The AWS account that’s associated with the assessment.

  • description (Optional[str]) – The description of the assessment.

  • framework_id (Optional[str]) – The unique identifier for the framework.

  • name (Optional[str]) – The name of the assessment.

  • roles (Union[IResolvable, Sequence[Union[IResolvable, RoleProperty]], None]) – The roles that are associated with the assessment.

  • scope (Union[IResolvable, ScopeProperty, None]) – The wrapper of AWS accounts and services that are in scope for the assessment.

  • status (Optional[str]) – The overall status of the assessment.

  • tags (Optional[Sequence[CfnTag]]) – The tags that are associated with the assessment.

Link

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

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_auditmanager as auditmanager

cfn_assessment_props = auditmanager.CfnAssessmentProps(
    assessment_reports_destination=auditmanager.CfnAssessment.AssessmentReportsDestinationProperty(
        destination="destination",
        destination_type="destinationType"
    ),
    aws_account=auditmanager.CfnAssessment.AWSAccountProperty(
        email_address="emailAddress",
        id="id",
        name="name"
    ),
    description="description",
    framework_id="frameworkId",
    name="name",
    roles=[auditmanager.CfnAssessment.RoleProperty(
        role_arn="roleArn",
        role_type="roleType"
    )],
    scope=auditmanager.CfnAssessment.ScopeProperty(
        aws_accounts=[auditmanager.CfnAssessment.AWSAccountProperty(
            email_address="emailAddress",
            id="id",
            name="name"
        )],
        aws_services=[auditmanager.CfnAssessment.AWSServiceProperty(
            service_name="serviceName"
        )]
    ),
    status="status",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

assessment_reports_destination

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

Link

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

Return type

Union[AssessmentReportsDestinationProperty, IResolvable, None]

aws_account

The AWS account that’s associated with the assessment.

Link

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

Return type

Union[IResolvable, AWSAccountProperty, None]

description

The description of the assessment.

Link

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

Return type

Optional[str]

framework_id

The unique identifier for the framework.

Link

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

Return type

Optional[str]

name

The name of the assessment.

Link

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

Return type

Optional[str]

roles

The roles that are associated with the assessment.

Link

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

Return type

Union[IResolvable, List[Union[IResolvable, RoleProperty]], None]

scope

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

Link

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

Return type

Union[IResolvable, ScopeProperty, None]

status

The overall status of the assessment.

Link

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

Return type

Optional[str]

tags

The tags that are associated with the assessment.

Link

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

Return type

Optional[List[CfnTag]]