@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
218 lines (217 loc) • 8.41 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Resource for managing an AWS Audit Manager Assessment.
*
* ## Example Usage
*
* ### Basic Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const test = new aws.auditmanager.Assessment("test", {
* name: "example",
* assessmentReportsDestination: {
* destination: `s3://${testAwsS3Bucket.id}`,
* destinationType: "S3",
* },
* frameworkId: testAwsAuditmanagerFramework.id,
* roles: [{
* roleArn: testAwsIamRole.arn,
* roleType: "PROCESS_OWNER",
* }],
* scope: {
* awsAccounts: [{
* id: current.accountId,
* }],
* awsServices: [{
* serviceName: "S3",
* }],
* },
* });
* ```
*
* ## Import
*
* Using `pulumi import`, import Audit Manager Assessments using the assessment `id`. For example:
*
* ```sh
* $ pulumi import aws:auditmanager/assessment:Assessment example abc123-de45
* ```
*/
export declare class Assessment extends pulumi.CustomResource {
/**
* Get an existing Assessment resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: AssessmentState, opts?: pulumi.CustomResourceOptions): Assessment;
/**
* Returns true if the given object is an instance of Assessment. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is Assessment;
/**
* Amazon Resource Name (ARN) of the assessment.
*/
readonly arn: pulumi.Output<string>;
/**
* Assessment report storage destination configuration. See `assessmentReportsDestination` below.
*/
readonly assessmentReportsDestination: pulumi.Output<outputs.auditmanager.AssessmentAssessmentReportsDestination | undefined>;
/**
* Description of the assessment.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* Unique identifier of the framework the assessment will be created from.
*/
readonly frameworkId: pulumi.Output<string>;
/**
* Name of the assessment.
*/
readonly name: pulumi.Output<string>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
readonly region: pulumi.Output<string>;
/**
* List of roles for the assessment. See `roles` below.
*/
readonly roles: pulumi.Output<outputs.auditmanager.AssessmentRole[] | undefined>;
/**
* Complete list of all roles with access to the assessment. This includes both roles explicitly configured via the `roles` block, and any roles which have access to all Audit Manager assessments by default.
*/
readonly rolesAlls: pulumi.Output<outputs.auditmanager.AssessmentRolesAll[]>;
/**
* Amazon Web Services accounts and services that are in scope for the assessment. See `scope` below.
*
* The following arguments are optional:
*/
readonly scope: pulumi.Output<outputs.auditmanager.AssessmentScope | undefined>;
/**
* Status of the assessment. Valid values are `ACTIVE` and `INACTIVE`.
*/
readonly status: pulumi.Output<string>;
/**
* A map of tags to assign to the assessment. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
readonly tags: pulumi.Output<{
[key: string]: string;
} | undefined>;
readonly tagsAll: pulumi.Output<{
[key: string]: string;
}>;
/**
* Create a Assessment resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: AssessmentArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Assessment resources.
*/
export interface AssessmentState {
/**
* Amazon Resource Name (ARN) of the assessment.
*/
arn?: pulumi.Input<string>;
/**
* Assessment report storage destination configuration. See `assessmentReportsDestination` below.
*/
assessmentReportsDestination?: pulumi.Input<inputs.auditmanager.AssessmentAssessmentReportsDestination>;
/**
* Description of the assessment.
*/
description?: pulumi.Input<string>;
/**
* Unique identifier of the framework the assessment will be created from.
*/
frameworkId?: pulumi.Input<string>;
/**
* Name of the assessment.
*/
name?: pulumi.Input<string>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
region?: pulumi.Input<string>;
/**
* List of roles for the assessment. See `roles` below.
*/
roles?: pulumi.Input<pulumi.Input<inputs.auditmanager.AssessmentRole>[]>;
/**
* Complete list of all roles with access to the assessment. This includes both roles explicitly configured via the `roles` block, and any roles which have access to all Audit Manager assessments by default.
*/
rolesAlls?: pulumi.Input<pulumi.Input<inputs.auditmanager.AssessmentRolesAll>[]>;
/**
* Amazon Web Services accounts and services that are in scope for the assessment. See `scope` below.
*
* The following arguments are optional:
*/
scope?: pulumi.Input<inputs.auditmanager.AssessmentScope>;
/**
* Status of the assessment. Valid values are `ACTIVE` and `INACTIVE`.
*/
status?: pulumi.Input<string>;
/**
* A map of tags to assign to the assessment. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
tagsAll?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
}
/**
* The set of arguments for constructing a Assessment resource.
*/
export interface AssessmentArgs {
/**
* Assessment report storage destination configuration. See `assessmentReportsDestination` below.
*/
assessmentReportsDestination?: pulumi.Input<inputs.auditmanager.AssessmentAssessmentReportsDestination>;
/**
* Description of the assessment.
*/
description?: pulumi.Input<string>;
/**
* Unique identifier of the framework the assessment will be created from.
*/
frameworkId: pulumi.Input<string>;
/**
* Name of the assessment.
*/
name?: pulumi.Input<string>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
region?: pulumi.Input<string>;
/**
* List of roles for the assessment. See `roles` below.
*/
roles?: pulumi.Input<pulumi.Input<inputs.auditmanager.AssessmentRole>[]>;
/**
* Amazon Web Services accounts and services that are in scope for the assessment. See `scope` below.
*
* The following arguments are optional:
*/
scope?: pulumi.Input<inputs.auditmanager.AssessmentScope>;
/**
* A map of tags to assign to the assessment. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
}