1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Optimizer
  5. getProfile
Oracle Cloud Infrastructure v1.41.0 published on Wednesday, Jun 19, 2024 by Pulumi

oci.Optimizer.getProfile

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v1.41.0 published on Wednesday, Jun 19, 2024 by Pulumi

    This data source provides details about a specific Profile resource in Oracle Cloud Infrastructure Optimizer service.

    Gets the specified profile’s information. Uses the profile’s OCID to determine which profile to retrieve.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as oci from "@pulumi/oci";
    
    const testProfile = oci.Optimizer.getProfile({
        profileId: testProfileOciOptimizerProfile.id,
    });
    
    import pulumi
    import pulumi_oci as oci
    
    test_profile = oci.Optimizer.get_profile(profile_id=test_profile_oci_optimizer_profile["id"])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-oci/sdk/go/oci/Optimizer"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := Optimizer.GetProfile(ctx, &optimizer.GetProfileArgs{
    			ProfileId: testProfileOciOptimizerProfile.Id,
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Oci = Pulumi.Oci;
    
    return await Deployment.RunAsync(() => 
    {
        var testProfile = Oci.Optimizer.GetProfile.Invoke(new()
        {
            ProfileId = testProfileOciOptimizerProfile.Id,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.oci.Optimizer.OptimizerFunctions;
    import com.pulumi.oci.Optimizer.inputs.GetProfileArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            final var testProfile = OptimizerFunctions.getProfile(GetProfileArgs.builder()
                .profileId(testProfileOciOptimizerProfile.id())
                .build());
    
        }
    }
    
    variables:
      testProfile:
        fn::invoke:
          Function: oci:Optimizer:getProfile
          Arguments:
            profileId: ${testProfileOciOptimizerProfile.id}
    

    Using getProfile

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getProfile(args: GetProfileArgs, opts?: InvokeOptions): Promise<GetProfileResult>
    function getProfileOutput(args: GetProfileOutputArgs, opts?: InvokeOptions): Output<GetProfileResult>
    def get_profile(profile_id: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetProfileResult
    def get_profile_output(profile_id: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetProfileResult]
    func GetProfile(ctx *Context, args *GetProfileArgs, opts ...InvokeOption) (*GetProfileResult, error)
    func GetProfileOutput(ctx *Context, args *GetProfileOutputArgs, opts ...InvokeOption) GetProfileResultOutput

    > Note: This function is named GetProfile in the Go SDK.

    public static class GetProfile 
    {
        public static Task<GetProfileResult> InvokeAsync(GetProfileArgs args, InvokeOptions? opts = null)
        public static Output<GetProfileResult> Invoke(GetProfileInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetProfileResult> getProfile(GetProfileArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: oci:Optimizer/getProfile:getProfile
      arguments:
        # arguments dictionary

    The following arguments are supported:

    ProfileId string
    The unique OCID of the profile.
    ProfileId string
    The unique OCID of the profile.
    profileId String
    The unique OCID of the profile.
    profileId string
    The unique OCID of the profile.
    profile_id str
    The unique OCID of the profile.
    profileId String
    The unique OCID of the profile.

    getProfile Result

    The following output properties are available:

    AggregationIntervalInDays int
    The time period over which to collect data for the recommendations, measured in number of days.
    CompartmentId string
    The OCID of the tenancy. The tenancy is the root compartment.
    DefinedTags Dictionary<string, object>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"foo-namespace.bar-key": "value"}
    Description string
    Text describing the profile. Avoid entering confidential information.
    FreeformTags Dictionary<string, object>
    Simple key-value pair applied without any predefined name, type, or namespace. For more information, see Resource Tags. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    Id string
    The unique OCID of the profile.
    LevelsConfigurations List<GetProfileLevelsConfiguration>
    A list of configuration levels for each recommendation.
    Name string
    The name assigned to the profile. Avoid entering confidential information.
    ProfileId string
    State string
    The profile's current state.
    SystemTags Dictionary<string, object>
    TargetCompartments List<GetProfileTargetCompartment>
    Optional. The compartments specified in the profile override for a recommendation.
    TargetTags List<GetProfileTargetTag>
    Optional. The tags specified in the profile override for a recommendation.
    TimeCreated string
    The date and time the profile was created, in the format defined by RFC3339.
    TimeUpdated string
    The date and time the profile was last updated, in the format defined by RFC3339.
    AggregationIntervalInDays int
    The time period over which to collect data for the recommendations, measured in number of days.
    CompartmentId string
    The OCID of the tenancy. The tenancy is the root compartment.
    DefinedTags map[string]interface{}
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"foo-namespace.bar-key": "value"}
    Description string
    Text describing the profile. Avoid entering confidential information.
    FreeformTags map[string]interface{}
    Simple key-value pair applied without any predefined name, type, or namespace. For more information, see Resource Tags. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    Id string
    The unique OCID of the profile.
    LevelsConfigurations []GetProfileLevelsConfiguration
    A list of configuration levels for each recommendation.
    Name string
    The name assigned to the profile. Avoid entering confidential information.
    ProfileId string
    State string
    The profile's current state.
    SystemTags map[string]interface{}
    TargetCompartments []GetProfileTargetCompartment
    Optional. The compartments specified in the profile override for a recommendation.
    TargetTags []GetProfileTargetTag
    Optional. The tags specified in the profile override for a recommendation.
    TimeCreated string
    The date and time the profile was created, in the format defined by RFC3339.
    TimeUpdated string
    The date and time the profile was last updated, in the format defined by RFC3339.
    aggregationIntervalInDays Integer
    The time period over which to collect data for the recommendations, measured in number of days.
    compartmentId String
    The OCID of the tenancy. The tenancy is the root compartment.
    definedTags Map<String,Object>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"foo-namespace.bar-key": "value"}
    description String
    Text describing the profile. Avoid entering confidential information.
    freeformTags Map<String,Object>
    Simple key-value pair applied without any predefined name, type, or namespace. For more information, see Resource Tags. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    id String
    The unique OCID of the profile.
    levelsConfigurations List<GetProfileLevelsConfiguration>
    A list of configuration levels for each recommendation.
    name String
    The name assigned to the profile. Avoid entering confidential information.
    profileId String
    state String
    The profile's current state.
    systemTags Map<String,Object>
    targetCompartments List<GetProfileTargetCompartment>
    Optional. The compartments specified in the profile override for a recommendation.
    targetTags List<GetProfileTargetTag>
    Optional. The tags specified in the profile override for a recommendation.
    timeCreated String
    The date and time the profile was created, in the format defined by RFC3339.
    timeUpdated String
    The date and time the profile was last updated, in the format defined by RFC3339.
    aggregationIntervalInDays number
    The time period over which to collect data for the recommendations, measured in number of days.
    compartmentId string
    The OCID of the tenancy. The tenancy is the root compartment.
    definedTags {[key: string]: any}
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"foo-namespace.bar-key": "value"}
    description string
    Text describing the profile. Avoid entering confidential information.
    freeformTags {[key: string]: any}
    Simple key-value pair applied without any predefined name, type, or namespace. For more information, see Resource Tags. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    id string
    The unique OCID of the profile.
    levelsConfigurations GetProfileLevelsConfiguration[]
    A list of configuration levels for each recommendation.
    name string
    The name assigned to the profile. Avoid entering confidential information.
    profileId string
    state string
    The profile's current state.
    systemTags {[key: string]: any}
    targetCompartments GetProfileTargetCompartment[]
    Optional. The compartments specified in the profile override for a recommendation.
    targetTags GetProfileTargetTag[]
    Optional. The tags specified in the profile override for a recommendation.
    timeCreated string
    The date and time the profile was created, in the format defined by RFC3339.
    timeUpdated string
    The date and time the profile was last updated, in the format defined by RFC3339.
    aggregation_interval_in_days int
    The time period over which to collect data for the recommendations, measured in number of days.
    compartment_id str
    The OCID of the tenancy. The tenancy is the root compartment.
    defined_tags Mapping[str, Any]
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"foo-namespace.bar-key": "value"}
    description str
    Text describing the profile. Avoid entering confidential information.
    freeform_tags Mapping[str, Any]
    Simple key-value pair applied without any predefined name, type, or namespace. For more information, see Resource Tags. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    id str
    The unique OCID of the profile.
    levels_configurations Sequence[optimizer.GetProfileLevelsConfiguration]
    A list of configuration levels for each recommendation.
    name str
    The name assigned to the profile. Avoid entering confidential information.
    profile_id str
    state str
    The profile's current state.
    system_tags Mapping[str, Any]
    target_compartments Sequence[optimizer.GetProfileTargetCompartment]
    Optional. The compartments specified in the profile override for a recommendation.
    target_tags Sequence[optimizer.GetProfileTargetTag]
    Optional. The tags specified in the profile override for a recommendation.
    time_created str
    The date and time the profile was created, in the format defined by RFC3339.
    time_updated str
    The date and time the profile was last updated, in the format defined by RFC3339.
    aggregationIntervalInDays Number
    The time period over which to collect data for the recommendations, measured in number of days.
    compartmentId String
    The OCID of the tenancy. The tenancy is the root compartment.
    definedTags Map<Any>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"foo-namespace.bar-key": "value"}
    description String
    Text describing the profile. Avoid entering confidential information.
    freeformTags Map<Any>
    Simple key-value pair applied without any predefined name, type, or namespace. For more information, see Resource Tags. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    id String
    The unique OCID of the profile.
    levelsConfigurations List<Property Map>
    A list of configuration levels for each recommendation.
    name String
    The name assigned to the profile. Avoid entering confidential information.
    profileId String
    state String
    The profile's current state.
    systemTags Map<Any>
    targetCompartments List<Property Map>
    Optional. The compartments specified in the profile override for a recommendation.
    targetTags List<Property Map>
    Optional. The tags specified in the profile override for a recommendation.
    timeCreated String
    The date and time the profile was created, in the format defined by RFC3339.
    timeUpdated String
    The date and time the profile was last updated, in the format defined by RFC3339.

    Supporting Types

    GetProfileLevelsConfiguration

    Items List<GetProfileLevelsConfigurationItem>
    The list of tags specified in the current profile override.
    Items []GetProfileLevelsConfigurationItem
    The list of tags specified in the current profile override.
    items List<GetProfileLevelsConfigurationItem>
    The list of tags specified in the current profile override.
    items GetProfileLevelsConfigurationItem[]
    The list of tags specified in the current profile override.
    items Sequence[optimizer.GetProfileLevelsConfigurationItem]
    The list of tags specified in the current profile override.
    items List<Property Map>
    The list of tags specified in the current profile override.

    GetProfileLevelsConfigurationItem

    Level string
    The pre-defined profile level.
    RecommendationId string
    The unique OCID of the recommendation.
    Level string
    The pre-defined profile level.
    RecommendationId string
    The unique OCID of the recommendation.
    level String
    The pre-defined profile level.
    recommendationId String
    The unique OCID of the recommendation.
    level string
    The pre-defined profile level.
    recommendationId string
    The unique OCID of the recommendation.
    level str
    The pre-defined profile level.
    recommendation_id str
    The unique OCID of the recommendation.
    level String
    The pre-defined profile level.
    recommendationId String
    The unique OCID of the recommendation.

    GetProfileTargetCompartment

    Items List<string>
    The list of tags specified in the current profile override.
    Items []string
    The list of tags specified in the current profile override.
    items List<String>
    The list of tags specified in the current profile override.
    items string[]
    The list of tags specified in the current profile override.
    items Sequence[str]
    The list of tags specified in the current profile override.
    items List<String>
    The list of tags specified in the current profile override.

    GetProfileTargetTag

    Items List<GetProfileTargetTagItem>
    The list of tags specified in the current profile override.
    Items []GetProfileTargetTagItem
    The list of tags specified in the current profile override.
    items List<GetProfileTargetTagItem>
    The list of tags specified in the current profile override.
    items GetProfileTargetTagItem[]
    The list of tags specified in the current profile override.
    items Sequence[optimizer.GetProfileTargetTagItem]
    The list of tags specified in the current profile override.
    items List<Property Map>
    The list of tags specified in the current profile override.

    GetProfileTargetTagItem

    TagDefinitionName string
    The name you use to refer to the tag, also known as the tag key.
    TagNamespaceName string
    The name of the tag namespace.
    TagValueType string
    Specifies which tag value types in the tagValues field result in overrides of the recommendation criteria.
    TagValues List<string>
    The list of tag values. The tag value is the value that the user applying the tag adds to the tag key.
    TagDefinitionName string
    The name you use to refer to the tag, also known as the tag key.
    TagNamespaceName string
    The name of the tag namespace.
    TagValueType string
    Specifies which tag value types in the tagValues field result in overrides of the recommendation criteria.
    TagValues []string
    The list of tag values. The tag value is the value that the user applying the tag adds to the tag key.
    tagDefinitionName String
    The name you use to refer to the tag, also known as the tag key.
    tagNamespaceName String
    The name of the tag namespace.
    tagValueType String
    Specifies which tag value types in the tagValues field result in overrides of the recommendation criteria.
    tagValues List<String>
    The list of tag values. The tag value is the value that the user applying the tag adds to the tag key.
    tagDefinitionName string
    The name you use to refer to the tag, also known as the tag key.
    tagNamespaceName string
    The name of the tag namespace.
    tagValueType string
    Specifies which tag value types in the tagValues field result in overrides of the recommendation criteria.
    tagValues string[]
    The list of tag values. The tag value is the value that the user applying the tag adds to the tag key.
    tag_definition_name str
    The name you use to refer to the tag, also known as the tag key.
    tag_namespace_name str
    The name of the tag namespace.
    tag_value_type str
    Specifies which tag value types in the tagValues field result in overrides of the recommendation criteria.
    tag_values Sequence[str]
    The list of tag values. The tag value is the value that the user applying the tag adds to the tag key.
    tagDefinitionName String
    The name you use to refer to the tag, also known as the tag key.
    tagNamespaceName String
    The name of the tag namespace.
    tagValueType String
    Specifies which tag value types in the tagValues field result in overrides of the recommendation criteria.
    tagValues List<String>
    The list of tag values. The tag value is the value that the user applying the tag adds to the tag key.

    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.41.0 published on Wednesday, Jun 19, 2024 by Pulumi