Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. auditmanager
  5. AssessmentReport
AWS v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-aws

aws.auditmanager.AssessmentReport

Explore with Pulumi AI

AWS v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-aws

Resource for managing an AWS Audit Manager Assessment Report.

Example Usage

Basic Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const test = new aws.auditmanager.AssessmentReport("test", {
    name: "example",
    assessmentId: testAwsAuditmanagerAssessment.id,
});
Copy
import pulumi
import pulumi_aws as aws

test = aws.auditmanager.AssessmentReport("test",
    name="example",
    assessment_id=test_aws_auditmanager_assessment["id"])
Copy
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/auditmanager"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := auditmanager.NewAssessmentReport(ctx, "test", &auditmanager.AssessmentReportArgs{
			Name:         pulumi.String("example"),
			AssessmentId: pulumi.Any(testAwsAuditmanagerAssessment.Id),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var test = new Aws.Auditmanager.AssessmentReport("test", new()
    {
        Name = "example",
        AssessmentId = testAwsAuditmanagerAssessment.Id,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.auditmanager.AssessmentReport;
import com.pulumi.aws.auditmanager.AssessmentReportArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var test = new AssessmentReport("test", AssessmentReportArgs.builder()
            .name("example")
            .assessmentId(testAwsAuditmanagerAssessment.id())
            .build());

    }
}
Copy
resources:
  test:
    type: aws:auditmanager:AssessmentReport
    properties:
      name: example
      assessmentId: ${testAwsAuditmanagerAssessment.id}
Copy

Create AssessmentReport Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new AssessmentReport(name: string, args: AssessmentReportArgs, opts?: CustomResourceOptions);
@overload
def AssessmentReport(resource_name: str,
                     args: AssessmentReportArgs,
                     opts: Optional[ResourceOptions] = None)

@overload
def AssessmentReport(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     assessment_id: Optional[str] = None,
                     description: Optional[str] = None,
                     name: Optional[str] = None)
func NewAssessmentReport(ctx *Context, name string, args AssessmentReportArgs, opts ...ResourceOption) (*AssessmentReport, error)
public AssessmentReport(string name, AssessmentReportArgs args, CustomResourceOptions? opts = null)
public AssessmentReport(String name, AssessmentReportArgs args)
public AssessmentReport(String name, AssessmentReportArgs args, CustomResourceOptions options)

type: aws:auditmanager:AssessmentReport
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. AssessmentReportArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. AssessmentReportArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. AssessmentReportArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. AssessmentReportArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. AssessmentReportArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var assessmentReportResource = new Aws.Auditmanager.AssessmentReport("assessmentReportResource", new()
{
    AssessmentId = "string",
    Description = "string",
    Name = "string",
});
Copy
example, err := auditmanager.NewAssessmentReport(ctx, "assessmentReportResource", &auditmanager.AssessmentReportArgs{
	AssessmentId: pulumi.String("string"),
	Description:  pulumi.String("string"),
	Name:         pulumi.String("string"),
})
Copy
var assessmentReportResource = new AssessmentReport("assessmentReportResource", AssessmentReportArgs.builder()
    .assessmentId("string")
    .description("string")
    .name("string")
    .build());
Copy
assessment_report_resource = aws.auditmanager.AssessmentReport("assessmentReportResource",
    assessment_id="string",
    description="string",
    name="string")
Copy
const assessmentReportResource = new aws.auditmanager.AssessmentReport("assessmentReportResource", {
    assessmentId: "string",
    description: "string",
    name: "string",
});
Copy
type: aws:auditmanager:AssessmentReport
properties:
    assessmentId: string
    description: string
    name: string
Copy

AssessmentReport Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The AssessmentReport resource accepts the following input properties:

AssessmentId This property is required. string

Unique identifier of the assessment to create the report from.

The following arguments are optional:

Description string
Description of the assessment report.
Name string
Name of the assessment report.
AssessmentId This property is required. string

Unique identifier of the assessment to create the report from.

The following arguments are optional:

Description string
Description of the assessment report.
Name string
Name of the assessment report.
assessmentId This property is required. String

Unique identifier of the assessment to create the report from.

The following arguments are optional:

description String
Description of the assessment report.
name String
Name of the assessment report.
assessmentId This property is required. string

Unique identifier of the assessment to create the report from.

The following arguments are optional:

description string
Description of the assessment report.
name string
Name of the assessment report.
assessment_id This property is required. str

Unique identifier of the assessment to create the report from.

The following arguments are optional:

description str
Description of the assessment report.
name str
Name of the assessment report.
assessmentId This property is required. String

Unique identifier of the assessment to create the report from.

The following arguments are optional:

description String
Description of the assessment report.
name String
Name of the assessment report.

Outputs

All input properties are implicitly available as output properties. Additionally, the AssessmentReport resource produces the following output properties:

Author string
Name of the user who created the assessment report.
Id string
The provider-assigned unique ID for this managed resource.
Status string
Current status of the specified assessment report. Valid values are COMPLETE, IN_PROGRESS, and FAILED.
Author string
Name of the user who created the assessment report.
Id string
The provider-assigned unique ID for this managed resource.
Status string
Current status of the specified assessment report. Valid values are COMPLETE, IN_PROGRESS, and FAILED.
author String
Name of the user who created the assessment report.
id String
The provider-assigned unique ID for this managed resource.
status String
Current status of the specified assessment report. Valid values are COMPLETE, IN_PROGRESS, and FAILED.
author string
Name of the user who created the assessment report.
id string
The provider-assigned unique ID for this managed resource.
status string
Current status of the specified assessment report. Valid values are COMPLETE, IN_PROGRESS, and FAILED.
author str
Name of the user who created the assessment report.
id str
The provider-assigned unique ID for this managed resource.
status str
Current status of the specified assessment report. Valid values are COMPLETE, IN_PROGRESS, and FAILED.
author String
Name of the user who created the assessment report.
id String
The provider-assigned unique ID for this managed resource.
status String
Current status of the specified assessment report. Valid values are COMPLETE, IN_PROGRESS, and FAILED.

Look up Existing AssessmentReport Resource

Get an existing AssessmentReport resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: AssessmentReportState, opts?: CustomResourceOptions): AssessmentReport
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        assessment_id: Optional[str] = None,
        author: Optional[str] = None,
        description: Optional[str] = None,
        name: Optional[str] = None,
        status: Optional[str] = None) -> AssessmentReport
func GetAssessmentReport(ctx *Context, name string, id IDInput, state *AssessmentReportState, opts ...ResourceOption) (*AssessmentReport, error)
public static AssessmentReport Get(string name, Input<string> id, AssessmentReportState? state, CustomResourceOptions? opts = null)
public static AssessmentReport get(String name, Output<String> id, AssessmentReportState state, CustomResourceOptions options)
resources:  _:    type: aws:auditmanager:AssessmentReport    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
AssessmentId string

Unique identifier of the assessment to create the report from.

The following arguments are optional:

Author string
Name of the user who created the assessment report.
Description string
Description of the assessment report.
Name string
Name of the assessment report.
Status string
Current status of the specified assessment report. Valid values are COMPLETE, IN_PROGRESS, and FAILED.
AssessmentId string

Unique identifier of the assessment to create the report from.

The following arguments are optional:

Author string
Name of the user who created the assessment report.
Description string
Description of the assessment report.
Name string
Name of the assessment report.
Status string
Current status of the specified assessment report. Valid values are COMPLETE, IN_PROGRESS, and FAILED.
assessmentId String

Unique identifier of the assessment to create the report from.

The following arguments are optional:

author String
Name of the user who created the assessment report.
description String
Description of the assessment report.
name String
Name of the assessment report.
status String
Current status of the specified assessment report. Valid values are COMPLETE, IN_PROGRESS, and FAILED.
assessmentId string

Unique identifier of the assessment to create the report from.

The following arguments are optional:

author string
Name of the user who created the assessment report.
description string
Description of the assessment report.
name string
Name of the assessment report.
status string
Current status of the specified assessment report. Valid values are COMPLETE, IN_PROGRESS, and FAILED.
assessment_id str

Unique identifier of the assessment to create the report from.

The following arguments are optional:

author str
Name of the user who created the assessment report.
description str
Description of the assessment report.
name str
Name of the assessment report.
status str
Current status of the specified assessment report. Valid values are COMPLETE, IN_PROGRESS, and FAILED.
assessmentId String

Unique identifier of the assessment to create the report from.

The following arguments are optional:

author String
Name of the user who created the assessment report.
description String
Description of the assessment report.
name String
Name of the assessment report.
status String
Current status of the specified assessment report. Valid values are COMPLETE, IN_PROGRESS, and FAILED.

Import

Using pulumi import, import Audit Manager Assessment Reports using the assessment report id. For example:

$ pulumi import aws:auditmanager/assessmentReport:AssessmentReport example abc123-de45
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
AWS Classic pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.
AWS v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-aws