UNPKG

@pulumi/aws

Version:

A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.

125 lines 5.2 kB
"use strict"; // *** 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.RecommendationPreferences = void 0; const pulumi = require("@pulumi/pulumi"); const utilities = require("../utilities"); /** * Manages AWS Compute Optimizer recommendation preferences. * * ## Example Usage * * ### Lookback Period Preference * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as aws from "@pulumi/aws"; * * const example = new aws.computeoptimizer.RecommendationPreferences("example", { * resourceType: "Ec2Instance", * scope: { * name: "AccountId", * value: "123456789012", * }, * lookBackPeriod: "DAYS_32", * }); * ``` * * ### Multiple Preferences * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as aws from "@pulumi/aws"; * * const example = new aws.computeoptimizer.RecommendationPreferences("example", { * resourceType: "Ec2Instance", * scope: { * name: "AccountId", * value: "123456789012", * }, * enhancedInfrastructureMetrics: "Active", * externalMetricsPreference: { * source: "Datadog", * }, * preferredResources: [{ * includeLists: [ * "m5.xlarge", * "r5", * ], * name: "Ec2InstanceTypes", * }], * }); * ``` * * ## Import * * Using `pulumi import`, import recommendation preferences using the resource type, scope name and scope value. For example: * * ```sh * $ pulumi import aws:computeoptimizer/recommendationPreferences:RecommendationPreferences example Ec2Instance,AccountId,123456789012 * ``` */ class RecommendationPreferences extends pulumi.CustomResource { /** * Get an existing RecommendationPreferences 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 RecommendationPreferences(name, state, { ...opts, id: id }); } /** * Returns true if the given object is an instance of RecommendationPreferences. 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'] === RecommendationPreferences.__pulumiType; } constructor(name, argsOrState, opts) { let resourceInputs = {}; opts = opts || {}; if (opts.id) { const state = argsOrState; resourceInputs["enhancedInfrastructureMetrics"] = state?.enhancedInfrastructureMetrics; resourceInputs["externalMetricsPreference"] = state?.externalMetricsPreference; resourceInputs["inferredWorkloadTypes"] = state?.inferredWorkloadTypes; resourceInputs["lookBackPeriod"] = state?.lookBackPeriod; resourceInputs["preferredResources"] = state?.preferredResources; resourceInputs["region"] = state?.region; resourceInputs["resourceType"] = state?.resourceType; resourceInputs["savingsEstimationMode"] = state?.savingsEstimationMode; resourceInputs["scope"] = state?.scope; resourceInputs["utilizationPreferences"] = state?.utilizationPreferences; } else { const args = argsOrState; if (args?.resourceType === undefined && !opts.urn) { throw new Error("Missing required property 'resourceType'"); } resourceInputs["enhancedInfrastructureMetrics"] = args?.enhancedInfrastructureMetrics; resourceInputs["externalMetricsPreference"] = args?.externalMetricsPreference; resourceInputs["inferredWorkloadTypes"] = args?.inferredWorkloadTypes; resourceInputs["lookBackPeriod"] = args?.lookBackPeriod; resourceInputs["preferredResources"] = args?.preferredResources; resourceInputs["region"] = args?.region; resourceInputs["resourceType"] = args?.resourceType; resourceInputs["savingsEstimationMode"] = args?.savingsEstimationMode; resourceInputs["scope"] = args?.scope; resourceInputs["utilizationPreferences"] = args?.utilizationPreferences; } opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts); super(RecommendationPreferences.__pulumiType, name, resourceInputs, opts); } } exports.RecommendationPreferences = RecommendationPreferences; /** @internal */ RecommendationPreferences.__pulumiType = 'aws:computeoptimizer/recommendationPreferences:RecommendationPreferences'; //# sourceMappingURL=recommendationPreferences.js.map