CfnAssessment
- class aws_cdk.aws_auditmanager.CfnAssessment(scope_, id, *, assessment_reports_destination=None, aws_account=None, delegations=None, description=None, framework_id=None, name=None, roles=None, scope=None, status=None, tags=None)
Bases:
CfnResource
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:
- CloudformationResource:
AWS::AuditManager::Assessment
- 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 import aws_auditmanager as auditmanager cfn_assessment = auditmanager.CfnAssessment(self, "MyCfnAssessment", assessment_reports_destination=auditmanager.CfnAssessment.AssessmentReportsDestinationProperty( destination="destination", destination_type="destinationType" ), aws_account=auditmanager.CfnAssessment.AWSAccountProperty( email_address="emailAddress", id="id", name="name" ), delegations=[auditmanager.CfnAssessment.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.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" )] )
- Parameters:
scope (
Union
[IResolvable
,ScopeProperty
,Dict
[str
,Any
],None
]) – Scope in which this resource is defined.id (
str
) – Construct identifier for this resource (unique in its scope).assessment_reports_destination (
Union
[IResolvable
,AssessmentReportsDestinationProperty
,Dict
[str
,Any
],None
]) – The destination that evidence reports are stored in for the assessment.aws_account (
Union
[IResolvable
,AWSAccountProperty
,Dict
[str
,Any
],None
]) – The AWS account that’s associated with the assessment.delegations (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,DelegationProperty
,Dict
[str
,Any
]]],None
]) – The delegations that are 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
,Dict
[str
,Any
]]],None
]) – The roles that are associated with the assessment.scope – The wrapper of AWS accounts and services that are in scope for the assessment.
status (
Optional
[str
]) – The overall status of the assessment. When you create a new assessment, the initialStatus
value is alwaysACTIVE
. When you create an assessment, even if you specify the value asINACTIVE
, the value overrides toACTIVE
. After you create an assessment, you can change the value of theStatus
property at any time. For example, when you want to stop collecting evidence for your assessment, you can change the assessment status toINACTIVE
.tags (
Optional
[Sequence
[Union
[CfnTag
,Dict
[str
,Any
]]]]) – The tags that are associated with the assessment.
Methods
- add_deletion_override(path)
Syntactic sugar for
addOverride(path, undefined)
.- Parameters:
path (
str
) – The path of the value to delete.- Return type:
None
- add_dependency(target)
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
- Parameters:
target (
CfnResource
) –- Return type:
None
- add_depends_on(target)
(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
- Parameters:
target (
CfnResource
) –- Deprecated:
use addDependency
- Stability:
deprecated
- Return type:
None
- add_metadata(key, value)
Add a value to the CloudFormation Resource Metadata.
- Parameters:
key (
str
) –value (
Any
) –
- See:
- Return type:
None
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- add_override(path, value)
Adds an override to the synthesized CloudFormation resource.
To add a property override, either use
addPropertyOverride
or prefixpath
with “Properties.” (i.e.Properties.TopicName
).If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.
To include a literal
.
in the property name, prefix with a\
. In most programming languages you will need to write this as"\\."
because the\
itself will need to be escaped.For example:
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"]) cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")
would add the overrides Example:
"Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... }
The
value
argument toaddOverride
will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.- Parameters:
path (
str
) –The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.
value (
Any
) –The value. Could be primitive or complex.
- Return type:
None
- add_property_deletion_override(property_path)
Adds an override that deletes the value of a property from the resource definition.
- Parameters:
property_path (
str
) – The path to the property.- Return type:
None
- add_property_override(property_path, value)
Adds an override to a resource property.
Syntactic sugar for
addOverride("Properties.<...>", value)
.- Parameters:
property_path (
str
) – The path of the property.value (
Any
) – The value.
- Return type:
None
- apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)
Sets the deletion policy of the resource based on the removal policy specified.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.
The resource can be deleted (
RemovalPolicy.DESTROY
), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN
). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT
). A list of resources that support this policy can be found in the following link:- Parameters:
policy (
Optional
[RemovalPolicy
]) –apply_to_update_replace_policy (
Optional
[bool
]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: truedefault (
Optional
[RemovalPolicy
]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.
- See:
- Return type:
None
- get_att(attribute_name, type_hint=None)
Returns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g.
resource.arn
), but this can be used for future compatibility in case there is no generated attribute.- Parameters:
attribute_name (
str
) – The name of the attribute.type_hint (
Optional
[ResolutionTypeHint
]) –
- Return type:
- get_metadata(key)
Retrieve a value value from the CloudFormation Resource Metadata.
- Parameters:
key (
str
) –- See:
- Return type:
Any
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- inspect(inspector)
Examines the CloudFormation resource and discloses attributes.
- Parameters:
inspector (
TreeInspector
) – tree inspector to collect and process attributes.- Return type:
None
- obtain_dependencies()
Retrieves an array of resources this resource depends on.
This assembles dependencies on resources across stacks (including nested stacks) automatically.
- Return type:
List
[Union
[Stack
,CfnResource
]]
- obtain_resource_dependencies()
Get a shallow copy of dependencies between this resource and other resources in the same stack.
- Return type:
List
[CfnResource
]
- override_logical_id(new_logical_id)
Overrides the auto-generated logical ID with a specific ID.
- Parameters:
new_logical_id (
str
) – The new logical ID to use for this stack element.- Return type:
None
- remove_dependency(target)
Indicates that this resource no longer depends on another resource.
This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.
- Parameters:
target (
CfnResource
) –- Return type:
None
- replace_dependency(target, new_target)
Replaces one dependency with another.
- Parameters:
target (
CfnResource
) – The dependency to replace.new_target (
CfnResource
) – The new dependency to add.
- Return type:
None
- to_string()
Returns a string representation of this construct.
- Return type:
str
- Returns:
a string representation of this resource
Attributes
- CFN_RESOURCE_TYPE_NAME = 'AWS::AuditManager::Assessment'
- assessment_reports_destination
The destination that evidence reports are stored in for the assessment.
- attr_arn
The Amazon Resource Name (ARN) of the assessment.
- CloudformationAttribute:
Arn
- attr_assessment_id
The unique identifier for the assessment.
- CloudformationAttribute:
AssessmentId
- attr_creation_time
Specifies when the assessment was created.
- CloudformationAttribute:
CreationTime
- aws_account
The AWS account that’s associated with the assessment.
- cfn_options
Options for this resource, such as condition, update policy etc.
- cfn_resource_type
AWS resource type.
- creation_stack
return:
the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.
- delegations
The delegations that are associated with the assessment.
- description
The description of the assessment.
- framework_id
The unique identifier for the framework.
- logical_id
The logical ID for this CloudFormation stack element.
The logical ID of the element is calculated from the path of the resource node in the construct tree.
To override this value, use
overrideLogicalId(newLogicalId)
.- Returns:
the logical ID as a stringified token. This value will only get resolved during synthesis.
- name
The name of the assessment.
- node
The tree node.
- ref
Return a string that will be resolved to a CloudFormation
{ Ref }
for this element.If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through
Lazy.any({ produce: resource.ref })
.
- roles
The roles that are associated with the assessment.
- scope
The wrapper of AWS accounts and services that are in scope for the assessment.
- stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
- status
The overall status of the assessment.
- tags
Tag Manager which manages the tags for this resource.
- tags_raw
The tags that are associated with the assessment.
Static Methods
- classmethod is_cfn_element(x)
Returns
true
if a construct is a stack element (i.e. part of the synthesized cloudformation template).Uses duck-typing instead of
instanceof
to allow stack elements from different versions of this library to be included in the same stack.- Parameters:
x (
Any
) –- Return type:
bool
- Returns:
The construct as a stack element or undefined if it is not a stack element.
- classmethod is_cfn_resource(x)
Check whether the given object is a CfnResource.
- Parameters:
x (
Any
) –- Return type:
bool
- classmethod is_construct(x)
Checks if
x
is a construct.Use this method instead of
instanceof
to properly detectConstruct
instances, even when the construct library is symlinked.Explanation: in JavaScript, multiple copies of the
constructs
library on disk are seen as independent, completely different libraries. As a consequence, the classConstruct
in each copy of theconstructs
library is seen as a different class, and an instance of one class will not test asinstanceof
the other class.npm install
will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of theconstructs
library can be accidentally installed, andinstanceof
will behave unpredictably. It is safest to avoid usinginstanceof
, and using this type-testing method instead.- Parameters:
x (
Any
) – Any object.- Return type:
bool
- Returns:
true if
x
is an object created from a class which extendsConstruct
.
AWSAccountProperty
- class CfnAssessment.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:
- 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 import aws_auditmanager as auditmanager a_wSAccount_property = auditmanager.CfnAssessment.AWSAccountProperty( email_address="emailAddress", id="id", name="name" )
Attributes
- email_address
The email address that’s associated with the AWS account .
- id
The identifier for the AWS account .
AWSServiceProperty
- class CfnAssessment.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:
- 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 import aws_auditmanager as auditmanager a_wSService_property = auditmanager.CfnAssessment.AWSServiceProperty( service_name="serviceName" )
Attributes
- service_name
The name of the AWS service .
AssessmentReportsDestinationProperty
- class CfnAssessment.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:
- 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 import aws_auditmanager as auditmanager assessment_reports_destination_property = auditmanager.CfnAssessment.AssessmentReportsDestinationProperty( destination="destination", destination_type="destinationType" )
Attributes
- destination
The destination bucket where Audit Manager stores assessment reports.
- destination_type
The destination type, such as Amazon S3.
DelegationProperty
- class CfnAssessment.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:: InCreateAssessment
,roleType
can only bePROCESS_OWNER
. InUpdateSettings
,roleType
can only bePROCESS_OWNER
. InBatchCreateDelegationByAssessment
,roleType
can only beRESOURCE_OWNER
.status (
Optional
[str
]) – The status of the delegation.
- See:
- 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 import aws_auditmanager as auditmanager delegation_property = auditmanager.CfnAssessment.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.
- assessment_name
The name of the assessment that’s associated with the delegation.
- comment
The comment that’s related to the delegation.
- control_set_id
The identifier for the control set that’s associated with the delegation.
- created_by
The user or role that created the delegation.
Minimum :
1
Maximum :
100
Pattern :
^[a-zA-Z0-9-_()\\[\\]\\s]+$
- creation_time
Specifies when the delegation was created.
- id
The unique identifier for the delegation.
- last_updated
Specifies when the delegation was last updated.
- role_arn
The Amazon Resource Name (ARN) of the IAM role.
- role_type
The type of customer persona.
In
CreateAssessment
,roleType
can only bePROCESS_OWNER
.In
UpdateSettings
,roleType
can only bePROCESS_OWNER
.In
BatchCreateDelegationByAssessment
,roleType
can only beRESOURCE_OWNER
.
- status
The status of the delegation.
RoleProperty
- class CfnAssessment.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:: InCreateAssessment
,roleType
can only bePROCESS_OWNER
. InUpdateSettings
,roleType
can only bePROCESS_OWNER
. InBatchCreateDelegationByAssessment
,roleType
can only beRESOURCE_OWNER
.
- See:
- 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 import aws_auditmanager as auditmanager role_property = auditmanager.CfnAssessment.RoleProperty( role_arn="roleArn", role_type="roleType" )
Attributes
- role_arn
The Amazon Resource Name (ARN) of the IAM role.
- role_type
The type of customer persona.
In
CreateAssessment
,roleType
can only bePROCESS_OWNER
.In
UpdateSettings
,roleType
can only bePROCESS_OWNER
.In
BatchCreateDelegationByAssessment
,roleType
can only beRESOURCE_OWNER
.
ScopeProperty
- class CfnAssessment.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 forawsServices
will show as empty.
- See:
- 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 import aws_auditmanager as auditmanager scope_property = auditmanager.CfnAssessment.ScopeProperty( aws_accounts=[auditmanager.CfnAssessment.AWSAccountProperty( email_address="emailAddress", id="id", name="name" )], aws_services=[auditmanager.CfnAssessment.AWSServiceProperty( service_name="serviceName" )] )
Attributes
- aws_accounts
The AWS accounts that are included in the scope of the assessment.
- 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.