@pulumi/aws-native
Version:
The Pulumi AWS Cloud Control Provider enables you to build, deploy, and manage [any AWS resource that's supported by the AWS Cloud Control API](https://github.com/pulumi/pulumi-aws-native/blob/master/provider/cmd/pulumi-gen-aws-native/supported-types.txt)
92 lines (91 loc) • 4.93 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* The AWS::SecurityHub::ConfigurationPolicy resource represents the Central Configuration Policy in your account.
*/
export declare class ConfigurationPolicy extends pulumi.CustomResource {
/**
* Get an existing ConfigurationPolicy 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 opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): ConfigurationPolicy;
/**
* Returns true if the given object is an instance of ConfigurationPolicy. 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 ConfigurationPolicy;
/**
* The Amazon Resource Name (ARN) of the configuration policy.
*/
readonly arn: pulumi.Output<string>;
/**
* The universally unique identifier (UUID) of the configuration policy.
*/
readonly awsId: pulumi.Output<string>;
/**
* An object that defines how AWS Security Hub CSPM is configured. It includes whether Security Hub CSPM is enabled or disabled, a list of enabled security standards, a list of enabled or disabled security controls, and a list of custom parameter values for specified controls. If you provide a list of security controls that are enabled in the configuration policy, Security Hub CSPM disables all other controls (including newly released controls). If you provide a list of security controls that are disabled in the configuration policy, Security Hub CSPM enables all other controls (including newly released controls).
*/
readonly configurationPolicy: pulumi.Output<outputs.securityhub.ConfigurationPolicyPolicy>;
/**
* The date and time, in UTC and ISO 8601 format.
*/
readonly createdAt: pulumi.Output<string>;
/**
* The description of the configuration policy.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* The name of the configuration policy.
*/
readonly name: pulumi.Output<string>;
/**
* Indicates whether the service that the configuration policy applies to is enabled in the policy.
*/
readonly serviceEnabled: pulumi.Output<boolean>;
/**
* User-defined tags associated with a configuration policy. For more information, see [Tagging AWS Security Hub CSPM resources](https://docs.aws.amazon.com/securityhub/latest/userguide/tagging-resources.html) in the *Security Hub CSPM user guide* .
*/
readonly tags: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* The date and time, in UTC and ISO 8601 format.
*/
readonly updatedAt: pulumi.Output<string>;
/**
* Create a ConfigurationPolicy 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: ConfigurationPolicyArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a ConfigurationPolicy resource.
*/
export interface ConfigurationPolicyArgs {
/**
* An object that defines how AWS Security Hub CSPM is configured. It includes whether Security Hub CSPM is enabled or disabled, a list of enabled security standards, a list of enabled or disabled security controls, and a list of custom parameter values for specified controls. If you provide a list of security controls that are enabled in the configuration policy, Security Hub CSPM disables all other controls (including newly released controls). If you provide a list of security controls that are disabled in the configuration policy, Security Hub CSPM enables all other controls (including newly released controls).
*/
configurationPolicy: pulumi.Input<inputs.securityhub.ConfigurationPolicyPolicyArgs>;
/**
* The description of the configuration policy.
*/
description?: pulumi.Input<string>;
/**
* The name of the configuration policy.
*/
name?: pulumi.Input<string>;
/**
* User-defined tags associated with a configuration policy. For more information, see [Tagging AWS Security Hub CSPM resources](https://docs.aws.amazon.com/securityhub/latest/userguide/tagging-resources.html) in the *Security Hub CSPM user guide* .
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
}