1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Optimizer
  5. Recommendation
Oracle Cloud Infrastructure v1.29.0 published on Thursday, Mar 28, 2024 by Pulumi

oci.Optimizer.Recommendation

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v1.29.0 published on Thursday, Mar 28, 2024 by Pulumi

    This resource provides the Recommendation resource in Oracle Cloud Infrastructure Optimizer service.

    Updates the recommendation that corresponds to the specified OCID. Use this operation to implement the following actions:

    • Postpone recommendation
    • Dismiss recommendation
    • Reactivate recommendation

    Create Recommendation Resource

    new Recommendation(name: string, args: RecommendationArgs, opts?: CustomResourceOptions);
    @overload
    def Recommendation(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       recommendation_id: Optional[str] = None,
                       status: Optional[str] = None,
                       time_status_end: Optional[str] = None)
    @overload
    def Recommendation(resource_name: str,
                       args: RecommendationArgs,
                       opts: Optional[ResourceOptions] = None)
    func NewRecommendation(ctx *Context, name string, args RecommendationArgs, opts ...ResourceOption) (*Recommendation, error)
    public Recommendation(string name, RecommendationArgs args, CustomResourceOptions? opts = null)
    public Recommendation(String name, RecommendationArgs args)
    public Recommendation(String name, RecommendationArgs args, CustomResourceOptions options)
    
    type: oci:Optimizer:Recommendation
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args RecommendationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args RecommendationArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args RecommendationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args RecommendationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args RecommendationArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Recommendation Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Recommendation resource accepts the following input properties:

    RecommendationId string
    The unique OCID associated with the recommendation.
    Status string
    (Updatable) The status of the recommendation.
    TimeStatusEnd string

    (Updatable) The date and time the current status will change. The format is defined by RFC3339.

    For example, "The current postponed status of the recommendation will end and change to pending on this date and time."

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    RecommendationId string
    The unique OCID associated with the recommendation.
    Status string
    (Updatable) The status of the recommendation.
    TimeStatusEnd string

    (Updatable) The date and time the current status will change. The format is defined by RFC3339.

    For example, "The current postponed status of the recommendation will end and change to pending on this date and time."

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    recommendationId String
    The unique OCID associated with the recommendation.
    status String
    (Updatable) The status of the recommendation.
    timeStatusEnd String

    (Updatable) The date and time the current status will change. The format is defined by RFC3339.

    For example, "The current postponed status of the recommendation will end and change to pending on this date and time."

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    recommendationId string
    The unique OCID associated with the recommendation.
    status string
    (Updatable) The status of the recommendation.
    timeStatusEnd string

    (Updatable) The date and time the current status will change. The format is defined by RFC3339.

    For example, "The current postponed status of the recommendation will end and change to pending on this date and time."

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    recommendation_id str
    The unique OCID associated with the recommendation.
    status str
    (Updatable) The status of the recommendation.
    time_status_end str

    (Updatable) The date and time the current status will change. The format is defined by RFC3339.

    For example, "The current postponed status of the recommendation will end and change to pending on this date and time."

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    recommendationId String
    The unique OCID associated with the recommendation.
    status String
    (Updatable) The status of the recommendation.
    timeStatusEnd String

    (Updatable) The date and time the current status will change. The format is defined by RFC3339.

    For example, "The current postponed status of the recommendation will end and change to pending on this date and time."

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Recommendation resource produces the following output properties:

    CategoryId string
    The unique OCID associated with the category.
    CompartmentId string
    The OCID of the tenancy. The tenancy is the root compartment.
    Description string
    Text describing the recommendation.
    EstimatedCostSaving double
    The estimated cost savings, in dollars, for the recommendation.
    ExtendedMetadata Dictionary<string, object>
    Additional metadata key/value pairs for the recommendation.
    Id string
    The provider-assigned unique ID for this managed resource.
    Importance string
    The level of importance assigned to the recommendation.
    Name string
    The name of the profile level.
    ResourceCounts List<RecommendationResourceCount>
    An array of ResourceCount objects grouped by the status of the resource actions.
    State string
    The recommendation's current state.
    SupportedLevels List<RecommendationSupportedLevel>
    Optional. The profile levels supported by a recommendation. For example, profile level values could be Low, Medium, and High. Not all recommendations support this field.
    TimeCreated string
    The date and time the recommendation details were created, in the format defined by RFC3339.
    TimeStatusBegin string
    The date and time that the recommendation entered its current status. The format is defined by RFC3339.
    TimeUpdated string
    The date and time the recommendation details were last updated, in the format defined by RFC3339.
    CategoryId string
    The unique OCID associated with the category.
    CompartmentId string
    The OCID of the tenancy. The tenancy is the root compartment.
    Description string
    Text describing the recommendation.
    EstimatedCostSaving float64
    The estimated cost savings, in dollars, for the recommendation.
    ExtendedMetadata map[string]interface{}
    Additional metadata key/value pairs for the recommendation.
    Id string
    The provider-assigned unique ID for this managed resource.
    Importance string
    The level of importance assigned to the recommendation.
    Name string
    The name of the profile level.
    ResourceCounts []RecommendationResourceCount
    An array of ResourceCount objects grouped by the status of the resource actions.
    State string
    The recommendation's current state.
    SupportedLevels []RecommendationSupportedLevel
    Optional. The profile levels supported by a recommendation. For example, profile level values could be Low, Medium, and High. Not all recommendations support this field.
    TimeCreated string
    The date and time the recommendation details were created, in the format defined by RFC3339.
    TimeStatusBegin string
    The date and time that the recommendation entered its current status. The format is defined by RFC3339.
    TimeUpdated string
    The date and time the recommendation details were last updated, in the format defined by RFC3339.
    categoryId String
    The unique OCID associated with the category.
    compartmentId String
    The OCID of the tenancy. The tenancy is the root compartment.
    description String
    Text describing the recommendation.
    estimatedCostSaving Double
    The estimated cost savings, in dollars, for the recommendation.
    extendedMetadata Map<String,Object>
    Additional metadata key/value pairs for the recommendation.
    id String
    The provider-assigned unique ID for this managed resource.
    importance String
    The level of importance assigned to the recommendation.
    name String
    The name of the profile level.
    resourceCounts List<RecommendationResourceCount>
    An array of ResourceCount objects grouped by the status of the resource actions.
    state String
    The recommendation's current state.
    supportedLevels List<RecommendationSupportedLevel>
    Optional. The profile levels supported by a recommendation. For example, profile level values could be Low, Medium, and High. Not all recommendations support this field.
    timeCreated String
    The date and time the recommendation details were created, in the format defined by RFC3339.
    timeStatusBegin String
    The date and time that the recommendation entered its current status. The format is defined by RFC3339.
    timeUpdated String
    The date and time the recommendation details were last updated, in the format defined by RFC3339.
    categoryId string
    The unique OCID associated with the category.
    compartmentId string
    The OCID of the tenancy. The tenancy is the root compartment.
    description string
    Text describing the recommendation.
    estimatedCostSaving number
    The estimated cost savings, in dollars, for the recommendation.
    extendedMetadata {[key: string]: any}
    Additional metadata key/value pairs for the recommendation.
    id string
    The provider-assigned unique ID for this managed resource.
    importance string
    The level of importance assigned to the recommendation.
    name string
    The name of the profile level.
    resourceCounts RecommendationResourceCount[]
    An array of ResourceCount objects grouped by the status of the resource actions.
    state string
    The recommendation's current state.
    supportedLevels RecommendationSupportedLevel[]
    Optional. The profile levels supported by a recommendation. For example, profile level values could be Low, Medium, and High. Not all recommendations support this field.
    timeCreated string
    The date and time the recommendation details were created, in the format defined by RFC3339.
    timeStatusBegin string
    The date and time that the recommendation entered its current status. The format is defined by RFC3339.
    timeUpdated string
    The date and time the recommendation details were last updated, in the format defined by RFC3339.
    category_id str
    The unique OCID associated with the category.
    compartment_id str
    The OCID of the tenancy. The tenancy is the root compartment.
    description str
    Text describing the recommendation.
    estimated_cost_saving float
    The estimated cost savings, in dollars, for the recommendation.
    extended_metadata Mapping[str, Any]
    Additional metadata key/value pairs for the recommendation.
    id str
    The provider-assigned unique ID for this managed resource.
    importance str
    The level of importance assigned to the recommendation.
    name str
    The name of the profile level.
    resource_counts RecommendationResourceCount]
    An array of ResourceCount objects grouped by the status of the resource actions.
    state str
    The recommendation's current state.
    supported_levels RecommendationSupportedLevel]
    Optional. The profile levels supported by a recommendation. For example, profile level values could be Low, Medium, and High. Not all recommendations support this field.
    time_created str
    The date and time the recommendation details were created, in the format defined by RFC3339.
    time_status_begin str
    The date and time that the recommendation entered its current status. The format is defined by RFC3339.
    time_updated str
    The date and time the recommendation details were last updated, in the format defined by RFC3339.
    categoryId String
    The unique OCID associated with the category.
    compartmentId String
    The OCID of the tenancy. The tenancy is the root compartment.
    description String
    Text describing the recommendation.
    estimatedCostSaving Number
    The estimated cost savings, in dollars, for the recommendation.
    extendedMetadata Map<Any>
    Additional metadata key/value pairs for the recommendation.
    id String
    The provider-assigned unique ID for this managed resource.
    importance String
    The level of importance assigned to the recommendation.
    name String
    The name of the profile level.
    resourceCounts List<Property Map>
    An array of ResourceCount objects grouped by the status of the resource actions.
    state String
    The recommendation's current state.
    supportedLevels List<Property Map>
    Optional. The profile levels supported by a recommendation. For example, profile level values could be Low, Medium, and High. Not all recommendations support this field.
    timeCreated String
    The date and time the recommendation details were created, in the format defined by RFC3339.
    timeStatusBegin String
    The date and time that the recommendation entered its current status. The format is defined by RFC3339.
    timeUpdated String
    The date and time the recommendation details were last updated, in the format defined by RFC3339.

    Look up Existing Recommendation Resource

    Get an existing Recommendation resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: RecommendationState, opts?: CustomResourceOptions): Recommendation
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            category_id: Optional[str] = None,
            compartment_id: Optional[str] = None,
            description: Optional[str] = None,
            estimated_cost_saving: Optional[float] = None,
            extended_metadata: Optional[Mapping[str, Any]] = None,
            importance: Optional[str] = None,
            name: Optional[str] = None,
            recommendation_id: Optional[str] = None,
            resource_counts: Optional[Sequence[_optimizer.RecommendationResourceCountArgs]] = None,
            state: Optional[str] = None,
            status: Optional[str] = None,
            supported_levels: Optional[Sequence[_optimizer.RecommendationSupportedLevelArgs]] = None,
            time_created: Optional[str] = None,
            time_status_begin: Optional[str] = None,
            time_status_end: Optional[str] = None,
            time_updated: Optional[str] = None) -> Recommendation
    func GetRecommendation(ctx *Context, name string, id IDInput, state *RecommendationState, opts ...ResourceOption) (*Recommendation, error)
    public static Recommendation Get(string name, Input<string> id, RecommendationState? state, CustomResourceOptions? opts = null)
    public static Recommendation get(String name, Output<String> id, RecommendationState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    CategoryId string
    The unique OCID associated with the category.
    CompartmentId string
    The OCID of the tenancy. The tenancy is the root compartment.
    Description string
    Text describing the recommendation.
    EstimatedCostSaving double
    The estimated cost savings, in dollars, for the recommendation.
    ExtendedMetadata Dictionary<string, object>
    Additional metadata key/value pairs for the recommendation.
    Importance string
    The level of importance assigned to the recommendation.
    Name string
    The name of the profile level.
    RecommendationId string
    The unique OCID associated with the recommendation.
    ResourceCounts List<RecommendationResourceCount>
    An array of ResourceCount objects grouped by the status of the resource actions.
    State string
    The recommendation's current state.
    Status string
    (Updatable) The status of the recommendation.
    SupportedLevels List<RecommendationSupportedLevel>
    Optional. The profile levels supported by a recommendation. For example, profile level values could be Low, Medium, and High. Not all recommendations support this field.
    TimeCreated string
    The date and time the recommendation details were created, in the format defined by RFC3339.
    TimeStatusBegin string
    The date and time that the recommendation entered its current status. The format is defined by RFC3339.
    TimeStatusEnd string

    (Updatable) The date and time the current status will change. The format is defined by RFC3339.

    For example, "The current postponed status of the recommendation will end and change to pending on this date and time."

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    TimeUpdated string
    The date and time the recommendation details were last updated, in the format defined by RFC3339.
    CategoryId string
    The unique OCID associated with the category.
    CompartmentId string
    The OCID of the tenancy. The tenancy is the root compartment.
    Description string
    Text describing the recommendation.
    EstimatedCostSaving float64
    The estimated cost savings, in dollars, for the recommendation.
    ExtendedMetadata map[string]interface{}
    Additional metadata key/value pairs for the recommendation.
    Importance string
    The level of importance assigned to the recommendation.
    Name string
    The name of the profile level.
    RecommendationId string
    The unique OCID associated with the recommendation.
    ResourceCounts []RecommendationResourceCountArgs
    An array of ResourceCount objects grouped by the status of the resource actions.
    State string
    The recommendation's current state.
    Status string
    (Updatable) The status of the recommendation.
    SupportedLevels []RecommendationSupportedLevelArgs
    Optional. The profile levels supported by a recommendation. For example, profile level values could be Low, Medium, and High. Not all recommendations support this field.
    TimeCreated string
    The date and time the recommendation details were created, in the format defined by RFC3339.
    TimeStatusBegin string
    The date and time that the recommendation entered its current status. The format is defined by RFC3339.
    TimeStatusEnd string

    (Updatable) The date and time the current status will change. The format is defined by RFC3339.

    For example, "The current postponed status of the recommendation will end and change to pending on this date and time."

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    TimeUpdated string
    The date and time the recommendation details were last updated, in the format defined by RFC3339.
    categoryId String
    The unique OCID associated with the category.
    compartmentId String
    The OCID of the tenancy. The tenancy is the root compartment.
    description String
    Text describing the recommendation.
    estimatedCostSaving Double
    The estimated cost savings, in dollars, for the recommendation.
    extendedMetadata Map<String,Object>
    Additional metadata key/value pairs for the recommendation.
    importance String
    The level of importance assigned to the recommendation.
    name String
    The name of the profile level.
    recommendationId String
    The unique OCID associated with the recommendation.
    resourceCounts List<RecommendationResourceCount>
    An array of ResourceCount objects grouped by the status of the resource actions.
    state String
    The recommendation's current state.
    status String
    (Updatable) The status of the recommendation.
    supportedLevels List<RecommendationSupportedLevel>
    Optional. The profile levels supported by a recommendation. For example, profile level values could be Low, Medium, and High. Not all recommendations support this field.
    timeCreated String
    The date and time the recommendation details were created, in the format defined by RFC3339.
    timeStatusBegin String
    The date and time that the recommendation entered its current status. The format is defined by RFC3339.
    timeStatusEnd String

    (Updatable) The date and time the current status will change. The format is defined by RFC3339.

    For example, "The current postponed status of the recommendation will end and change to pending on this date and time."

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    timeUpdated String
    The date and time the recommendation details were last updated, in the format defined by RFC3339.
    categoryId string
    The unique OCID associated with the category.
    compartmentId string
    The OCID of the tenancy. The tenancy is the root compartment.
    description string
    Text describing the recommendation.
    estimatedCostSaving number
    The estimated cost savings, in dollars, for the recommendation.
    extendedMetadata {[key: string]: any}
    Additional metadata key/value pairs for the recommendation.
    importance string
    The level of importance assigned to the recommendation.
    name string
    The name of the profile level.
    recommendationId string
    The unique OCID associated with the recommendation.
    resourceCounts RecommendationResourceCount[]
    An array of ResourceCount objects grouped by the status of the resource actions.
    state string
    The recommendation's current state.
    status string
    (Updatable) The status of the recommendation.
    supportedLevels RecommendationSupportedLevel[]
    Optional. The profile levels supported by a recommendation. For example, profile level values could be Low, Medium, and High. Not all recommendations support this field.
    timeCreated string
    The date and time the recommendation details were created, in the format defined by RFC3339.
    timeStatusBegin string
    The date and time that the recommendation entered its current status. The format is defined by RFC3339.
    timeStatusEnd string

    (Updatable) The date and time the current status will change. The format is defined by RFC3339.

    For example, "The current postponed status of the recommendation will end and change to pending on this date and time."

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    timeUpdated string
    The date and time the recommendation details were last updated, in the format defined by RFC3339.
    category_id str
    The unique OCID associated with the category.
    compartment_id str
    The OCID of the tenancy. The tenancy is the root compartment.
    description str
    Text describing the recommendation.
    estimated_cost_saving float
    The estimated cost savings, in dollars, for the recommendation.
    extended_metadata Mapping[str, Any]
    Additional metadata key/value pairs for the recommendation.
    importance str
    The level of importance assigned to the recommendation.
    name str
    The name of the profile level.
    recommendation_id str
    The unique OCID associated with the recommendation.
    resource_counts RecommendationResourceCountArgs]
    An array of ResourceCount objects grouped by the status of the resource actions.
    state str
    The recommendation's current state.
    status str
    (Updatable) The status of the recommendation.
    supported_levels RecommendationSupportedLevelArgs]
    Optional. The profile levels supported by a recommendation. For example, profile level values could be Low, Medium, and High. Not all recommendations support this field.
    time_created str
    The date and time the recommendation details were created, in the format defined by RFC3339.
    time_status_begin str
    The date and time that the recommendation entered its current status. The format is defined by RFC3339.
    time_status_end str

    (Updatable) The date and time the current status will change. The format is defined by RFC3339.

    For example, "The current postponed status of the recommendation will end and change to pending on this date and time."

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    time_updated str
    The date and time the recommendation details were last updated, in the format defined by RFC3339.
    categoryId String
    The unique OCID associated with the category.
    compartmentId String
    The OCID of the tenancy. The tenancy is the root compartment.
    description String
    Text describing the recommendation.
    estimatedCostSaving Number
    The estimated cost savings, in dollars, for the recommendation.
    extendedMetadata Map<Any>
    Additional metadata key/value pairs for the recommendation.
    importance String
    The level of importance assigned to the recommendation.
    name String
    The name of the profile level.
    recommendationId String
    The unique OCID associated with the recommendation.
    resourceCounts List<Property Map>
    An array of ResourceCount objects grouped by the status of the resource actions.
    state String
    The recommendation's current state.
    status String
    (Updatable) The status of the recommendation.
    supportedLevels List<Property Map>
    Optional. The profile levels supported by a recommendation. For example, profile level values could be Low, Medium, and High. Not all recommendations support this field.
    timeCreated String
    The date and time the recommendation details were created, in the format defined by RFC3339.
    timeStatusBegin String
    The date and time that the recommendation entered its current status. The format is defined by RFC3339.
    timeStatusEnd String

    (Updatable) The date and time the current status will change. The format is defined by RFC3339.

    For example, "The current postponed status of the recommendation will end and change to pending on this date and time."

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    timeUpdated String
    The date and time the recommendation details were last updated, in the format defined by RFC3339.

    Supporting Types

    RecommendationResourceCount, RecommendationResourceCountArgs

    Count int
    The count of resources.
    Status string
    (Updatable) The status of the recommendation.
    Count int
    The count of resources.
    Status string
    (Updatable) The status of the recommendation.
    count Integer
    The count of resources.
    status String
    (Updatable) The status of the recommendation.
    count number
    The count of resources.
    status string
    (Updatable) The status of the recommendation.
    count int
    The count of resources.
    status str
    (Updatable) The status of the recommendation.
    count Number
    The count of resources.
    status String
    (Updatable) The status of the recommendation.

    RecommendationSupportedLevel, RecommendationSupportedLevelArgs

    Items List<RecommendationSupportedLevelItem>
    The list of supported levels.
    Items []RecommendationSupportedLevelItem
    The list of supported levels.
    items List<RecommendationSupportedLevelItem>
    The list of supported levels.
    items RecommendationSupportedLevelItem[]
    The list of supported levels.
    items RecommendationSupportedLevelItem]
    The list of supported levels.
    items List<Property Map>
    The list of supported levels.

    RecommendationSupportedLevelItem, RecommendationSupportedLevelItemArgs

    Name string
    The name of the profile level.
    Name string
    The name of the profile level.
    name String
    The name of the profile level.
    name string
    The name of the profile level.
    name str
    The name of the profile level.
    name String
    The name of the profile level.

    Import

    Recommendations can be imported using the id, e.g.

    $ pulumi import oci:Optimizer/recommendation:Recommendation test_recommendation "id"
    

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v1.29.0 published on Thursday, Mar 28, 2024 by Pulumi