@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
200 lines (199 loc) • 7.19 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 Control.
*
* ## Example Usage
*
* ### Basic Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = new aws.auditmanager.Control("example", {
* name: "example",
* controlMappingSources: [{
* sourceName: "example",
* sourceSetUpOption: "Procedural_Controls_Mapping",
* sourceType: "MANUAL",
* }],
* });
* ```
*
* ## Import
*
* Using `pulumi import`, import an Audit Manager Control using the `id`. For example:
*
* ```sh
* $ pulumi import aws:auditmanager/control:Control example abc123-de45
* ```
*/
export declare class Control extends pulumi.CustomResource {
/**
* Get an existing Control 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?: ControlState, opts?: pulumi.CustomResourceOptions): Control;
/**
* Returns true if the given object is an instance of Control. 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 Control;
/**
* Recommended actions to carry out if the control isn't fulfilled.
*/
readonly actionPlanInstructions: pulumi.Output<string | undefined>;
/**
* Title of the action plan for remediating the control.
*/
readonly actionPlanTitle: pulumi.Output<string | undefined>;
/**
* Amazon Resource Name (ARN) of the control.
* * `control_mapping_sources.*.source_id` - Unique identifier for the source.
*/
readonly arn: pulumi.Output<string>;
/**
* Data mapping sources. See `controlMappingSources` below.
*
* The following arguments are optional:
*/
readonly controlMappingSources: pulumi.Output<outputs.auditmanager.ControlControlMappingSource[] | undefined>;
/**
* Description of the control.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* Name of the control.
*/
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>;
/**
* A map of tags to assign to the control. 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;
}>;
/**
* Steps to follow to determine if the control is satisfied.
*/
readonly testingInformation: pulumi.Output<string | undefined>;
/**
* Type of control, such as a custom control or a standard control.
*/
readonly type: pulumi.Output<string>;
/**
* Create a Control 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?: ControlArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Control resources.
*/
export interface ControlState {
/**
* Recommended actions to carry out if the control isn't fulfilled.
*/
actionPlanInstructions?: pulumi.Input<string>;
/**
* Title of the action plan for remediating the control.
*/
actionPlanTitle?: pulumi.Input<string>;
/**
* Amazon Resource Name (ARN) of the control.
* * `control_mapping_sources.*.source_id` - Unique identifier for the source.
*/
arn?: pulumi.Input<string>;
/**
* Data mapping sources. See `controlMappingSources` below.
*
* The following arguments are optional:
*/
controlMappingSources?: pulumi.Input<pulumi.Input<inputs.auditmanager.ControlControlMappingSource>[]>;
/**
* Description of the control.
*/
description?: pulumi.Input<string>;
/**
* Name of the control.
*/
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>;
/**
* A map of tags to assign to the control. 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>;
}>;
/**
* Steps to follow to determine if the control is satisfied.
*/
testingInformation?: pulumi.Input<string>;
/**
* Type of control, such as a custom control or a standard control.
*/
type?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a Control resource.
*/
export interface ControlArgs {
/**
* Recommended actions to carry out if the control isn't fulfilled.
*/
actionPlanInstructions?: pulumi.Input<string>;
/**
* Title of the action plan for remediating the control.
*/
actionPlanTitle?: pulumi.Input<string>;
/**
* Data mapping sources. See `controlMappingSources` below.
*
* The following arguments are optional:
*/
controlMappingSources?: pulumi.Input<pulumi.Input<inputs.auditmanager.ControlControlMappingSource>[]>;
/**
* Description of the control.
*/
description?: pulumi.Input<string>;
/**
* Name of the control.
*/
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>;
/**
* A map of tags to assign to the control. 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>;
}>;
/**
* Steps to follow to determine if the control is satisfied.
*/
testingInformation?: pulumi.Input<string>;
}