@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
107 lines • 4.79 kB
JavaScript
;
// *** WARNING: this file was generated by pulumi-language-nodejs. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
Object.defineProperty(exports, "__esModule", { value: true });
exports.DetectorFeature = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("../utilities");
/**
* Provides a resource to manage a single Amazon GuardDuty [detector feature](https://docs.aws.amazon.com/guardduty/latest/ug/guardduty-features-activation-model.html#guardduty-features).
*
* > **NOTE:** Deleting this resource does not disable the detector feature, the resource in simply removed from state instead.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = new aws.guardduty.Detector("example", {enable: true});
* const s3Protection = new aws.guardduty.DetectorFeature("s3_protection", {
* detectorId: example.id,
* name: "S3_DATA_EVENTS",
* status: "ENABLED",
* });
* ```
*
* ## Extended Threat Detection for EKS
*
* To enable GuardDuty [Extended Threat Detection](https://docs.aws.amazon.com/guardduty/latest/ug/guardduty-extended-threat-detection.html) for EKS, you need at least one of these features enabled: [EKS Protection](https://docs.aws.amazon.com/guardduty/latest/ug/kubernetes-protection.html) or [Runtime Monitoring](https://docs.aws.amazon.com/guardduty/latest/ug/runtime-monitoring-configuration.html). For maximum detection coverage, enabling both is recommended to enhance detection capabilities.
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = new aws.guardduty.Detector("example", {enable: true});
* const eksProtection = new aws.guardduty.DetectorFeature("eks_protection", {
* detectorId: example.id,
* name: "EKS_AUDIT_LOGS",
* status: "ENABLED",
* });
* const eksRuntimeMonitoring = new aws.guardduty.DetectorFeature("eks_runtime_monitoring", {
* detectorId: example.id,
* name: "EKS_RUNTIME_MONITORING",
* status: "ENABLED",
* additionalConfigurations: [{
* name: "EKS_ADDON_MANAGEMENT",
* status: "ENABLED",
* }],
* });
* ```
*/
class DetectorFeature extends pulumi.CustomResource {
/**
* Get an existing DetectorFeature 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, id, state, opts) {
return new DetectorFeature(name, state, { ...opts, id: id });
}
/**
* Returns true if the given object is an instance of DetectorFeature. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj) {
if (obj === undefined || obj === null) {
return false;
}
return obj['__pulumiType'] === DetectorFeature.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["additionalConfigurations"] = state?.additionalConfigurations;
resourceInputs["detectorId"] = state?.detectorId;
resourceInputs["name"] = state?.name;
resourceInputs["region"] = state?.region;
resourceInputs["status"] = state?.status;
}
else {
const args = argsOrState;
if (args?.detectorId === undefined && !opts.urn) {
throw new Error("Missing required property 'detectorId'");
}
if (args?.status === undefined && !opts.urn) {
throw new Error("Missing required property 'status'");
}
resourceInputs["additionalConfigurations"] = args?.additionalConfigurations;
resourceInputs["detectorId"] = args?.detectorId;
resourceInputs["name"] = args?.name;
resourceInputs["region"] = args?.region;
resourceInputs["status"] = args?.status;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
super(DetectorFeature.__pulumiType, name, resourceInputs, opts);
}
}
exports.DetectorFeature = DetectorFeature;
/** @internal */
DetectorFeature.__pulumiType = 'aws:guardduty/detectorFeature:DetectorFeature';
//# sourceMappingURL=detectorFeature.js.map