CfnAssessmentPropsMixin

class aws_cdk.mixins_preview.aws_auditmanager.mixins.CfnAssessmentPropsMixin(props, *, strategy=None)

Bases: Mixin

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.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-auditmanager-assessment.html
CloudformationResource:: AWS::AuditManager::Assessment
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

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

cfn_assessment_props_mixin = auditmanager_mixins.CfnAssessmentPropsMixin(auditmanager_mixins.CfnAssessmentMixinProps(
    assessment_reports_destination=auditmanager_mixins.CfnAssessmentPropsMixin.AssessmentReportsDestinationProperty(
        destination="destination",
        destination_type="destinationType"
    ),
    aws_account=auditmanager_mixins.CfnAssessmentPropsMixin.AWSAccountProperty(
        email_address="emailAddress",
        id="id",
        name="name"
    ),
    delegations=[auditmanager_mixins.CfnAssessmentPropsMixin.DelegationProperty(
        assessment_id="assessmentId",
        assessment_name="assessmentName",
        comment="comment",
        control_set_id="controlSetId",
        created_by="createdBy",
        creation_time=123,
        id="id",
        last_updated=123,
        role_arn="roleArn",
        role_type="roleType",
        status="status"
    )],
    description="description",
    framework_id="frameworkId",
    name="name",
    roles=[auditmanager_mixins.CfnAssessmentPropsMixin.RoleProperty(
        role_arn="roleArn",
        role_type="roleType"
    )],
    scope=auditmanager_mixins.CfnAssessmentPropsMixin.ScopeProperty(
        aws_accounts=[auditmanager_mixins.CfnAssessmentPropsMixin.AWSAccountProperty(
            email_address="emailAddress",
            id="id",
            name="name"
        )],
        aws_services=[auditmanager_mixins.CfnAssessmentPropsMixin.AWSServiceProperty(
            service_name="serviceName"
        )]
    ),
    status="status",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::AuditManager::Assessment.

Parameters:

props (Union[CfnAssessmentMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['assessmentReportsDestination', 'awsAccount', 'delegations', 'description', 'frameworkId', 'name', 'roles', 'scope', 'status', 'tags']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

AWSAccountProperty

class CfnAssessmentPropsMixin.AWSAccountProperty(*, email_address=None, id=None, name=None)

Bases: object

The AWSAccount property type specifies the wrapper of the AWS account details, such as account ID, email address, and so on.

Parameters:

email_address (Optional[str]) – The email address that’s associated with the AWS account .
id (Optional[str]) – The identifier for the AWS account .
name (Optional[str]) – The name of the AWS account .

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

a_wSAccount_property = auditmanager_mixins.CfnAssessmentPropsMixin.AWSAccountProperty(
    email_address="emailAddress",
    id="id",
    name="name"
)

Attributes

email_address

The email address that’s associated with the AWS account .

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

id

The identifier for the AWS account .

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

name

The name of the AWS account .

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

AWSServiceProperty

class CfnAssessmentPropsMixin.AWSServiceProperty(*, service_name=None)

Bases: object

The AWSService property type specifies an AWS service such as Amazon S3 , AWS CloudTrail , and so on.

Parameters:: service_name (Optional[str]) – The name of the AWS service .
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-auditmanager-assessment-awsservice.html
ExampleMetadata:: fixture=_generated

Example:

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

a_wSService_property = auditmanager_mixins.CfnAssessmentPropsMixin.AWSServiceProperty(
    service_name="serviceName"
)

Attributes

service_name

The name of the AWS service .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-auditmanager-assessment-awsservice.html#cfn-auditmanager-assessment-awsservice-servicename

AssessmentReportsDestinationProperty

class CfnAssessmentPropsMixin.AssessmentReportsDestinationProperty(*, destination=None, destination_type=None)

Bases: object

The AssessmentReportsDestination property type specifies the location in which AWS Audit Manager saves assessment reports for the given assessment.

Parameters:

destination (Optional[str]) – The destination bucket where Audit Manager stores assessment reports.
destination_type (Optional[str]) – The destination type, such as Amazon S3.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

assessment_reports_destination_property = auditmanager_mixins.CfnAssessmentPropsMixin.AssessmentReportsDestinationProperty(
    destination="destination",
    destination_type="destinationType"
)

Attributes

destination

The destination bucket where Audit Manager stores assessment reports.

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

destination_type

The destination type, such as Amazon S3.

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

DelegationProperty

class CfnAssessmentPropsMixin.DelegationProperty(*, assessment_id=None, assessment_name=None, comment=None, control_set_id=None, created_by=None, creation_time=None, id=None, last_updated=None, role_arn=None, role_type=None, status=None)

Bases: object

The Delegation property type specifies the assignment of a control set to a delegate for review.

Parameters:

assessment_id (Optional[str]) – The identifier for the assessment that’s associated with the delegation.
assessment_name (Optional[str]) – The name of the assessment that’s associated with the delegation.
comment (Optional[str]) – The comment that’s related to the delegation.
control_set_id (Optional[str]) – The identifier for the control set that’s associated with the delegation.
created_by (Optional[str]) – The user or role that created the delegation. Minimum : 1 Maximum : 100 Pattern : ^[a-zA-Z0-9-_()\\[\\]\\s]+$
creation_time (Union[int, float, None]) – Specifies when the delegation was created.
id (Optional[str]) – The unique identifier for the delegation.
last_updated (Union[int, float, None]) – Specifies when the delegation was last updated.
role_arn (Optional[str]) – The Amazon Resource Name (ARN) of the IAM role.
role_type (Optional[str]) – The type of customer persona. .. epigraph:: In CreateAssessment , roleType can only be PROCESS_OWNER . In UpdateSettings , roleType can only be PROCESS_OWNER . In BatchCreateDelegationByAssessment , roleType can only be RESOURCE_OWNER .
status (Optional[str]) – The status of the delegation.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

delegation_property = auditmanager_mixins.CfnAssessmentPropsMixin.DelegationProperty(
    assessment_id="assessmentId",
    assessment_name="assessmentName",
    comment="comment",
    control_set_id="controlSetId",
    created_by="createdBy",
    creation_time=123,
    id="id",
    last_updated=123,
    role_arn="roleArn",
    role_type="roleType",
    status="status"
)

Attributes

assessment_id

The identifier for the assessment that’s associated with the delegation.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-auditmanager-assessment-delegation.html#cfn-auditmanager-assessment-delegation-assessmentid

assessment_name

The name of the assessment that’s associated with the delegation.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-auditmanager-assessment-delegation.html#cfn-auditmanager-assessment-delegation-assessmentname

comment

The comment that’s related to the delegation.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-auditmanager-assessment-delegation.html#cfn-auditmanager-assessment-delegation-comment

control_set_id

The identifier for the control set that’s associated with the delegation.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-auditmanager-assessment-delegation.html#cfn-auditmanager-assessment-delegation-controlsetid

created_by

The user or role that created the delegation.

Minimum : 1

Maximum : 100

Pattern : ^[a-zA-Z0-9-_()\\[\\]\\s]+$

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-auditmanager-assessment-delegation.html#cfn-auditmanager-assessment-delegation-createdby

creation_time

Specifies when the delegation was created.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-auditmanager-assessment-delegation.html#cfn-auditmanager-assessment-delegation-creationtime

id

The unique identifier for the delegation.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-auditmanager-assessment-delegation.html#cfn-auditmanager-assessment-delegation-id

last_updated

Specifies when the delegation was last updated.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-auditmanager-assessment-delegation.html#cfn-auditmanager-assessment-delegation-lastupdated

role_arn

The Amazon Resource Name (ARN) of the IAM role.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-auditmanager-assessment-delegation.html#cfn-auditmanager-assessment-delegation-rolearn

role_type

The type of customer persona.

In CreateAssessment , roleType can only be PROCESS_OWNER .

In UpdateSettings , roleType can only be PROCESS_OWNER .

In BatchCreateDelegationByAssessment , roleType can only be RESOURCE_OWNER .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-auditmanager-assessment-delegation.html#cfn-auditmanager-assessment-delegation-roletype

status

The status of the delegation.

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

RoleProperty

class CfnAssessmentPropsMixin.RoleProperty(*, role_arn=None, role_type=None)

Bases: object

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

Parameters:

role_arn (Optional[str]) – The Amazon Resource Name (ARN) of the IAM role.
role_type (Optional[str]) – The type of customer persona. .. epigraph:: In CreateAssessment , roleType can only be PROCESS_OWNER . In UpdateSettings , roleType can only be PROCESS_OWNER . In BatchCreateDelegationByAssessment , roleType can only be RESOURCE_OWNER .

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

role_property = auditmanager_mixins.CfnAssessmentPropsMixin.RoleProperty(
    role_arn="roleArn",
    role_type="roleType"
)

Attributes

role_arn

The Amazon Resource Name (ARN) of the IAM role.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-auditmanager-assessment-role.html#cfn-auditmanager-assessment-role-rolearn

role_type

The type of customer persona.

In CreateAssessment , roleType can only be PROCESS_OWNER .

In UpdateSettings , roleType can only be PROCESS_OWNER .

In BatchCreateDelegationByAssessment , roleType can only be RESOURCE_OWNER .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-auditmanager-assessment-role.html#cfn-auditmanager-assessment-role-roletype

ScopeProperty

class CfnAssessmentPropsMixin.ScopeProperty(*, aws_accounts=None, aws_services=None)

Bases: object

The Scope property type specifies the wrapper that contains the AWS accounts and services that are in scope for the assessment.

Parameters:

aws_accounts (Union[IResolvable, Sequence[Union[IResolvable, AWSAccountProperty, Dict[str, Any]]], None]) – The AWS accounts that are included in the scope of the assessment.
aws_services (Union[IResolvable, Sequence[Union[IResolvable, AWSServiceProperty, Dict[str, Any]]], None]) – The AWS services that are included in the scope of the assessment. .. epigraph:: This API parameter is no longer supported. If you use this parameter to specify one or more AWS services , Audit Manager ignores this input. Instead, the value for awsServices will show as empty.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

scope_property = auditmanager_mixins.CfnAssessmentPropsMixin.ScopeProperty(
    aws_accounts=[auditmanager_mixins.CfnAssessmentPropsMixin.AWSAccountProperty(
        email_address="emailAddress",
        id="id",
        name="name"
    )],
    aws_services=[auditmanager_mixins.CfnAssessmentPropsMixin.AWSServiceProperty(
        service_name="serviceName"
    )]
)

Attributes

aws_accounts

The AWS accounts that are included in the scope of the assessment.

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

aws_services

The AWS services that are included in the scope of the assessment.

This API parameter is no longer supported. If you use this parameter to specify one or more AWS services , Audit Manager ignores this input. Instead, the value for awsServices will show as empty.

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