We recommend new projects start with resources from the AWS provider.
aws-native.auditmanager.Assessment
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
An entity that defines the scope of audit evidence collected by AWS Audit Manager.
Create Assessment Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Assessment(name: string, args?: AssessmentArgs, opts?: CustomResourceOptions);
@overload
def Assessment(resource_name: str,
args: Optional[AssessmentArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def Assessment(resource_name: str,
opts: Optional[ResourceOptions] = None,
assessment_reports_destination: Optional[AssessmentReportsDestinationArgs] = None,
aws_account: Optional[AssessmentAwsAccountArgs] = None,
delegations: Optional[Sequence[AssessmentDelegationArgs]] = None,
description: Optional[str] = None,
framework_id: Optional[str] = None,
name: Optional[str] = None,
roles: Optional[Sequence[AssessmentRoleArgs]] = None,
scope: Optional[AssessmentScopeArgs] = None,
status: Optional[AssessmentStatus] = None,
tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
func NewAssessment(ctx *Context, name string, args *AssessmentArgs, opts ...ResourceOption) (*Assessment, error)
public Assessment(string name, AssessmentArgs? args = null, CustomResourceOptions? opts = null)
public Assessment(String name, AssessmentArgs args)
public Assessment(String name, AssessmentArgs args, CustomResourceOptions options)
type: aws-native:auditmanager:Assessment
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args AssessmentArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args AssessmentArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args AssessmentArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args AssessmentArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args AssessmentArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Assessment Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The Assessment resource accepts the following input properties:
- Assessment
Reports Pulumi.Destination Aws Native. Audit Manager. Inputs. Assessment Reports Destination - The destination that evidence reports are stored in for the assessment.
- Aws
Account Pulumi.Aws Native. Audit Manager. Inputs. Assessment Aws Account - The AWS account that's associated with the assessment.
- Delegations
List<Pulumi.
Aws Native. Audit Manager. Inputs. Assessment Delegation> - The list of delegations.
- Description string
- The description of the assessment.
- Framework
Id string - The unique identifier for the framework.
- Name string
- The name of the assessment.
- Roles
List<Pulumi.
Aws Native. Audit Manager. Inputs. Assessment Role> - The list of roles for the specified assessment.
- Scope
Pulumi.
Aws Native. Audit Manager. Inputs. Assessment Scope - The wrapper of AWS accounts and services that are in scope for the assessment.
- Status
Pulumi.
Aws Native. Audit Manager. Assessment Status The overall status of the assessment.
When you create a new assessment, the initial
Status
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 the
Status
property at any time. For example, when you want to stop collecting evidence for your assessment, you can change the assessment status toINACTIVE
.- List<Pulumi.
Aws Native. Inputs. Tag> - The tags associated with the assessment.
- Assessment
Reports AssessmentDestination Reports Destination Args - The destination that evidence reports are stored in for the assessment.
- Aws
Account AssessmentAws Account Args - The AWS account that's associated with the assessment.
- Delegations
[]Assessment
Delegation Args - The list of delegations.
- Description string
- The description of the assessment.
- Framework
Id string - The unique identifier for the framework.
- Name string
- The name of the assessment.
- Roles
[]Assessment
Role Args - The list of roles for the specified assessment.
- Scope
Assessment
Scope Args - The wrapper of AWS accounts and services that are in scope for the assessment.
- Status
Assessment
Status The overall status of the assessment.
When you create a new assessment, the initial
Status
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 the
Status
property at any time. For example, when you want to stop collecting evidence for your assessment, you can change the assessment status toINACTIVE
.- Tag
Args - The tags associated with the assessment.
- assessment
Reports AssessmentDestination Reports Destination - The destination that evidence reports are stored in for the assessment.
- aws
Account AssessmentAws Account - The AWS account that's associated with the assessment.
- delegations
List<Assessment
Delegation> - The list of delegations.
- description String
- The description of the assessment.
- framework
Id String - The unique identifier for the framework.
- name String
- The name of the assessment.
- roles
List<Assessment
Role> - The list of roles for the specified assessment.
- scope
Assessment
Scope - The wrapper of AWS accounts and services that are in scope for the assessment.
- status
Assessment
Status The overall status of the assessment.
When you create a new assessment, the initial
Status
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 the
Status
property at any time. For example, when you want to stop collecting evidence for your assessment, you can change the assessment status toINACTIVE
.- List<Tag>
- The tags associated with the assessment.
- assessment
Reports AssessmentDestination Reports Destination - The destination that evidence reports are stored in for the assessment.
- aws
Account AssessmentAws Account - The AWS account that's associated with the assessment.
- delegations
Assessment
Delegation[] - The list of delegations.
- description string
- The description of the assessment.
- framework
Id string - The unique identifier for the framework.
- name string
- The name of the assessment.
- roles
Assessment
Role[] - The list of roles for the specified assessment.
- scope
Assessment
Scope - The wrapper of AWS accounts and services that are in scope for the assessment.
- status
Assessment
Status The overall status of the assessment.
When you create a new assessment, the initial
Status
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 the
Status
property at any time. For example, when you want to stop collecting evidence for your assessment, you can change the assessment status toINACTIVE
.- Tag[]
- The tags associated with the assessment.
- assessment_
reports_ Assessmentdestination Reports Destination Args - The destination that evidence reports are stored in for the assessment.
- aws_
account AssessmentAws Account Args - The AWS account that's associated with the assessment.
- delegations
Sequence[Assessment
Delegation Args] - The list of delegations.
- description str
- The description of the assessment.
- framework_
id str - The unique identifier for the framework.
- name str
- The name of the assessment.
- roles
Sequence[Assessment
Role Args] - The list of roles for the specified assessment.
- scope
Assessment
Scope Args - The wrapper of AWS accounts and services that are in scope for the assessment.
- status
Assessment
Status The overall status of the assessment.
When you create a new assessment, the initial
Status
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 the
Status
property at any time. For example, when you want to stop collecting evidence for your assessment, you can change the assessment status toINACTIVE
.- Sequence[Tag
Args] - The tags associated with the assessment.
- assessment
Reports Property MapDestination - The destination that evidence reports are stored in for the assessment.
- aws
Account Property Map - The AWS account that's associated with the assessment.
- delegations List<Property Map>
- The list of delegations.
- description String
- The description of the assessment.
- framework
Id String - The unique identifier for the framework.
- name String
- The name of the assessment.
- roles List<Property Map>
- The list of roles for the specified assessment.
- scope Property Map
- The wrapper of AWS accounts and services that are in scope for the assessment.
- status "ACTIVE" | "INACTIVE"
The overall status of the assessment.
When you create a new assessment, the initial
Status
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 the
Status
property at any time. For example, when you want to stop collecting evidence for your assessment, you can change the assessment status toINACTIVE
.- List<Property Map>
- The tags associated with the assessment.
Outputs
All input properties are implicitly available as output properties. Additionally, the Assessment resource produces the following output properties:
- Arn string
- The Amazon Resource Name (ARN) of the assessment.
- Assessment
Id string - The unique identifier for the assessment.
- Creation
Time double - Specifies when the assessment was created.
- Id string
- The provider-assigned unique ID for this managed resource.
- Arn string
- The Amazon Resource Name (ARN) of the assessment.
- Assessment
Id string - The unique identifier for the assessment.
- Creation
Time float64 - Specifies when the assessment was created.
- Id string
- The provider-assigned unique ID for this managed resource.
- arn String
- The Amazon Resource Name (ARN) of the assessment.
- assessment
Id String - The unique identifier for the assessment.
- creation
Time Double - Specifies when the assessment was created.
- id String
- The provider-assigned unique ID for this managed resource.
- arn string
- The Amazon Resource Name (ARN) of the assessment.
- assessment
Id string - The unique identifier for the assessment.
- creation
Time number - Specifies when the assessment was created.
- id string
- The provider-assigned unique ID for this managed resource.
- arn str
- The Amazon Resource Name (ARN) of the assessment.
- assessment_
id str - The unique identifier for the assessment.
- creation_
time float - Specifies when the assessment was created.
- id str
- The provider-assigned unique ID for this managed resource.
- arn String
- The Amazon Resource Name (ARN) of the assessment.
- assessment
Id String - The unique identifier for the assessment.
- creation
Time Number - Specifies when the assessment was created.
- id String
- The provider-assigned unique ID for this managed resource.
Supporting Types
AssessmentAwsAccount, AssessmentAwsAccountArgs
- Email
Address string - The email address that's associated with the AWS account .
- Id string
- The identifier for the AWS account .
- Name string
- The name of the AWS account .
- Email
Address string - The email address that's associated with the AWS account .
- Id string
- The identifier for the AWS account .
- Name string
- The name of the AWS account .
- email
Address String - The email address that's associated with the AWS account .
- id String
- The identifier for the AWS account .
- name String
- The name of the AWS account .
- email
Address string - The email address that's associated with the AWS account .
- id string
- The identifier for the AWS account .
- name string
- The name of the AWS account .
- email_
address str - The email address that's associated with the AWS account .
- id str
- The identifier for the AWS account .
- name str
- The name of the AWS account .
- email
Address String - The email address that's associated with the AWS account .
- id String
- The identifier for the AWS account .
- name String
- The name of the AWS account .
AssessmentAwsService, AssessmentAwsServiceArgs
- Service
Name string - The name of the AWS service .
- Service
Name string - The name of the AWS service .
- service
Name String - The name of the AWS service .
- service
Name string - The name of the AWS service .
- service_
name str - The name of the AWS service .
- service
Name String - The name of the AWS service .
AssessmentDelegation, AssessmentDelegationArgs
- Assessment
Id string - The identifier for the assessment that's associated with the delegation.
- Assessment
Name string - The name of the assessment that's associated with the delegation.
- Comment string
- The comment that's related to the delegation.
- Control
Set stringId - The identifier for the control set that's associated with the delegation.
- Created
By string The user or role that created the delegation.
Minimum :
1
Maximum :
100
Pattern :
^[a-zA-Z0-9-_()\\[\\]\\s]+$
- Creation
Time double - Specifies when the delegation was created.
- Id string
- The unique identifier for the delegation.
- Last
Updated double - Specifies when the delegation was last updated.
- Role
Arn string - The Amazon Resource Name (ARN) of the IAM role.
- Role
Type Pulumi.Aws Native. Audit Manager. Assessment 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
Pulumi.
Aws Native. Audit Manager. Assessment Delegation Status - The status of the delegation.
- Assessment
Id string - The identifier for the assessment that's associated with the delegation.
- Assessment
Name string - The name of the assessment that's associated with the delegation.
- Comment string
- The comment that's related to the delegation.
- Control
Set stringId - The identifier for the control set that's associated with the delegation.
- Created
By string The user or role that created the delegation.
Minimum :
1
Maximum :
100
Pattern :
^[a-zA-Z0-9-_()\\[\\]\\s]+$
- Creation
Time float64 - Specifies when the delegation was created.
- Id string
- The unique identifier for the delegation.
- Last
Updated float64 - Specifies when the delegation was last updated.
- Role
Arn string - The Amazon Resource Name (ARN) of the IAM role.
- Role
Type AssessmentRole 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
Assessment
Delegation Status - The status of the delegation.
- assessment
Id String - The identifier for the assessment that's associated with the delegation.
- assessment
Name String - The name of the assessment that's associated with the delegation.
- comment String
- The comment that's related to the delegation.
- control
Set StringId - The identifier for the control set that's associated with the delegation.
- created
By String The user or role that created the delegation.
Minimum :
1
Maximum :
100
Pattern :
^[a-zA-Z0-9-_()\\[\\]\\s]+$
- creation
Time Double - Specifies when the delegation was created.
- id String
- The unique identifier for the delegation.
- last
Updated Double - Specifies when the delegation was last updated.
- role
Arn String - The Amazon Resource Name (ARN) of the IAM role.
- role
Type AssessmentRole 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
Assessment
Delegation Status - The status of the delegation.
- assessment
Id string - The identifier for the assessment that's associated with the delegation.
- assessment
Name string - The name of the assessment that's associated with the delegation.
- comment string
- The comment that's related to the delegation.
- control
Set stringId - The identifier for the control set that's associated with the delegation.
- created
By string The user or role that created the delegation.
Minimum :
1
Maximum :
100
Pattern :
^[a-zA-Z0-9-_()\\[\\]\\s]+$
- creation
Time number - Specifies when the delegation was created.
- id string
- The unique identifier for the delegation.
- last
Updated number - Specifies when the delegation was last updated.
- role
Arn string - The Amazon Resource Name (ARN) of the IAM role.
- role
Type AssessmentRole 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
Assessment
Delegation Status - The status of the delegation.
- assessment_
id str - The identifier for the assessment that's associated with the delegation.
- assessment_
name str - The name of the assessment that's associated with the delegation.
- comment str
- The comment that's related to the delegation.
- control_
set_ strid - The identifier for the control set that's associated with the delegation.
- created_
by str The user or role that created the delegation.
Minimum :
1
Maximum :
100
Pattern :
^[a-zA-Z0-9-_()\\[\\]\\s]+$
- creation_
time float - Specifies when the delegation was created.
- id str
- The unique identifier for the delegation.
- last_
updated float - Specifies when the delegation was last updated.
- role_
arn str - The Amazon Resource Name (ARN) of the IAM role.
- role_
type AssessmentRole 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
Assessment
Delegation Status - The status of the delegation.
- assessment
Id String - The identifier for the assessment that's associated with the delegation.
- assessment
Name String - The name of the assessment that's associated with the delegation.
- comment String
- The comment that's related to the delegation.
- control
Set StringId - The identifier for the control set that's associated with the delegation.
- created
By String The user or role that created the delegation.
Minimum :
1
Maximum :
100
Pattern :
^[a-zA-Z0-9-_()\\[\\]\\s]+$
- creation
Time Number - Specifies when the delegation was created.
- id String
- The unique identifier for the delegation.
- last
Updated Number - Specifies when the delegation was last updated.
- role
Arn String - The Amazon Resource Name (ARN) of the IAM role.
- role
Type "PROCESS_OWNER" | "RESOURCE_OWNER" 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 "IN_PROGRESS" | "UNDER_REVIEW" | "COMPLETE"
- The status of the delegation.
AssessmentDelegationStatus, AssessmentDelegationStatusArgs
- In
Progress - IN_PROGRESS
- Under
Review - UNDER_REVIEW
- Complete
- COMPLETE
- Assessment
Delegation Status In Progress - IN_PROGRESS
- Assessment
Delegation Status Under Review - UNDER_REVIEW
- Assessment
Delegation Status Complete - COMPLETE
- In
Progress - IN_PROGRESS
- Under
Review - UNDER_REVIEW
- Complete
- COMPLETE
- In
Progress - IN_PROGRESS
- Under
Review - UNDER_REVIEW
- Complete
- COMPLETE
- IN_PROGRESS
- IN_PROGRESS
- UNDER_REVIEW
- UNDER_REVIEW
- COMPLETE
- COMPLETE
- "IN_PROGRESS"
- IN_PROGRESS
- "UNDER_REVIEW"
- UNDER_REVIEW
- "COMPLETE"
- COMPLETE
AssessmentReportDestinationType, AssessmentReportDestinationTypeArgs
- S3
- S3
- Assessment
Report Destination Type S3 - S3
- S3
- S3
- S3
- S3
- S3
- S3
- "S3"
- S3
AssessmentReportsDestination, AssessmentReportsDestinationArgs
- Destination string
- The destination bucket where Audit Manager stores assessment reports.
- Destination
Type Pulumi.Aws Native. Audit Manager. Assessment Report Destination Type - The destination type, such as Amazon S3.
- Destination string
- The destination bucket where Audit Manager stores assessment reports.
- Destination
Type AssessmentReport Destination Type - The destination type, such as Amazon S3.
- destination String
- The destination bucket where Audit Manager stores assessment reports.
- destination
Type AssessmentReport Destination Type - The destination type, such as Amazon S3.
- destination string
- The destination bucket where Audit Manager stores assessment reports.
- destination
Type AssessmentReport Destination Type - The destination type, such as Amazon S3.
- destination str
- The destination bucket where Audit Manager stores assessment reports.
- destination_
type AssessmentReport Destination Type - The destination type, such as Amazon S3.
- destination String
- The destination bucket where Audit Manager stores assessment reports.
- destination
Type "S3" - The destination type, such as Amazon S3.
AssessmentRole, AssessmentRoleArgs
- Role
Arn string - The Amazon Resource Name (ARN) of the IAM role.
- Role
Type Pulumi.Aws Native. Audit Manager. Assessment 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
.
- Role
Arn string - The Amazon Resource Name (ARN) of the IAM role.
- Role
Type AssessmentRole 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
.
- role
Arn String - The Amazon Resource Name (ARN) of the IAM role.
- role
Type AssessmentRole 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
.
- role
Arn string - The Amazon Resource Name (ARN) of the IAM role.
- role
Type AssessmentRole 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
.
- role_
arn str - The Amazon Resource Name (ARN) of the IAM role.
- role_
type AssessmentRole 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
.
- role
Arn String - The Amazon Resource Name (ARN) of the IAM role.
- role
Type "PROCESS_OWNER" | "RESOURCE_OWNER" 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
.
AssessmentRoleType, AssessmentRoleTypeArgs
- Process
Owner - PROCESS_OWNER
- Resource
Owner - RESOURCE_OWNER
- Assessment
Role Type Process Owner - PROCESS_OWNER
- Assessment
Role Type Resource Owner - RESOURCE_OWNER
- Process
Owner - PROCESS_OWNER
- Resource
Owner - RESOURCE_OWNER
- Process
Owner - PROCESS_OWNER
- Resource
Owner - RESOURCE_OWNER
- PROCESS_OWNER
- PROCESS_OWNER
- RESOURCE_OWNER
- RESOURCE_OWNER
- "PROCESS_OWNER"
- PROCESS_OWNER
- "RESOURCE_OWNER"
- RESOURCE_OWNER
AssessmentScope, AssessmentScopeArgs
- Aws
Accounts List<Pulumi.Aws Native. Audit Manager. Inputs. Assessment Aws Account> - The AWS accounts included in scope.
- Aws
Services List<Pulumi.Aws Native. Audit Manager. Inputs. Assessment Aws Service> - The AWS services included in scope.
- Aws
Accounts []AssessmentAws Account - The AWS accounts included in scope.
- Aws
Services []AssessmentAws Service - The AWS services included in scope.
- aws
Accounts List<AssessmentAws Account> - The AWS accounts included in scope.
- aws
Services List<AssessmentAws Service> - The AWS services included in scope.
- aws
Accounts AssessmentAws Account[] - The AWS accounts included in scope.
- aws
Services AssessmentAws Service[] - The AWS services included in scope.
- aws_
accounts Sequence[AssessmentAws Account] - The AWS accounts included in scope.
- aws_
services Sequence[AssessmentAws Service] - The AWS services included in scope.
- aws
Accounts List<Property Map> - The AWS accounts included in scope.
- aws
Services List<Property Map> - The AWS services included in scope.
AssessmentStatus, AssessmentStatusArgs
- Active
- ACTIVE
- Inactive
- INACTIVE
- Assessment
Status Active - ACTIVE
- Assessment
Status Inactive - INACTIVE
- Active
- ACTIVE
- Inactive
- INACTIVE
- Active
- ACTIVE
- Inactive
- INACTIVE
- ACTIVE
- ACTIVE
- INACTIVE
- INACTIVE
- "ACTIVE"
- ACTIVE
- "INACTIVE"
- INACTIVE
Tag, TagArgs
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.