1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Functions
  5. getFusionEnvironmentFamily
Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi

oci.Functions.getFusionEnvironmentFamily

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi

    This data source provides details about a specific Fusion Environment Family resource in Oracle Cloud Infrastructure Fusion Apps service.

    Retrieves a fusion environment family identified by its OCID.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as oci from "@pulumi/oci";
    
    const testFusionEnvironmentFamily = oci.Functions.getFusionEnvironmentFamily({
        fusionEnvironmentFamilyId: testFusionEnvironmentFamilyOciFusionAppsFusionEnvironmentFamily.id,
    });
    
    import pulumi
    import pulumi_oci as oci
    
    test_fusion_environment_family = oci.Functions.get_fusion_environment_family(fusion_environment_family_id=test_fusion_environment_family_oci_fusion_apps_fusion_environment_family["id"])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/Functions"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := Functions.GetFusionEnvironmentFamily(ctx, &functions.GetFusionEnvironmentFamilyArgs{
    			FusionEnvironmentFamilyId: testFusionEnvironmentFamilyOciFusionAppsFusionEnvironmentFamily.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 testFusionEnvironmentFamily = Oci.Functions.GetFusionEnvironmentFamily.Invoke(new()
        {
            FusionEnvironmentFamilyId = testFusionEnvironmentFamilyOciFusionAppsFusionEnvironmentFamily.Id,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.oci.Functions.FunctionsFunctions;
    import com.pulumi.oci.Functions.inputs.GetFusionEnvironmentFamilyArgs;
    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 testFusionEnvironmentFamily = FunctionsFunctions.getFusionEnvironmentFamily(GetFusionEnvironmentFamilyArgs.builder()
                .fusionEnvironmentFamilyId(testFusionEnvironmentFamilyOciFusionAppsFusionEnvironmentFamily.id())
                .build());
    
        }
    }
    
    variables:
      testFusionEnvironmentFamily:
        fn::invoke:
          Function: oci:Functions:getFusionEnvironmentFamily
          Arguments:
            fusionEnvironmentFamilyId: ${testFusionEnvironmentFamilyOciFusionAppsFusionEnvironmentFamily.id}
    

    Using getFusionEnvironmentFamily

    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 getFusionEnvironmentFamily(args: GetFusionEnvironmentFamilyArgs, opts?: InvokeOptions): Promise<GetFusionEnvironmentFamilyResult>
    function getFusionEnvironmentFamilyOutput(args: GetFusionEnvironmentFamilyOutputArgs, opts?: InvokeOptions): Output<GetFusionEnvironmentFamilyResult>
    def get_fusion_environment_family(fusion_environment_family_id: Optional[str] = None,
                                      opts: Optional[InvokeOptions] = None) -> GetFusionEnvironmentFamilyResult
    def get_fusion_environment_family_output(fusion_environment_family_id: Optional[pulumi.Input[str]] = None,
                                      opts: Optional[InvokeOptions] = None) -> Output[GetFusionEnvironmentFamilyResult]
    func GetFusionEnvironmentFamily(ctx *Context, args *GetFusionEnvironmentFamilyArgs, opts ...InvokeOption) (*GetFusionEnvironmentFamilyResult, error)
    func GetFusionEnvironmentFamilyOutput(ctx *Context, args *GetFusionEnvironmentFamilyOutputArgs, opts ...InvokeOption) GetFusionEnvironmentFamilyResultOutput

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

    public static class GetFusionEnvironmentFamily 
    {
        public static Task<GetFusionEnvironmentFamilyResult> InvokeAsync(GetFusionEnvironmentFamilyArgs args, InvokeOptions? opts = null)
        public static Output<GetFusionEnvironmentFamilyResult> Invoke(GetFusionEnvironmentFamilyInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetFusionEnvironmentFamilyResult> getFusionEnvironmentFamily(GetFusionEnvironmentFamilyArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: oci:Functions/getFusionEnvironmentFamily:getFusionEnvironmentFamily
      arguments:
        # arguments dictionary

    The following arguments are supported:

    FusionEnvironmentFamilyId string
    The unique identifier (OCID) of the FusionEnvironmentFamily.
    FusionEnvironmentFamilyId string
    The unique identifier (OCID) of the FusionEnvironmentFamily.
    fusionEnvironmentFamilyId String
    The unique identifier (OCID) of the FusionEnvironmentFamily.
    fusionEnvironmentFamilyId string
    The unique identifier (OCID) of the FusionEnvironmentFamily.
    fusion_environment_family_id str
    The unique identifier (OCID) of the FusionEnvironmentFamily.
    fusionEnvironmentFamilyId String
    The unique identifier (OCID) of the FusionEnvironmentFamily.

    getFusionEnvironmentFamily Result

    The following output properties are available:

    CompartmentId string
    The OCID of the compartment where the environment family is located.
    DefinedTags Dictionary<string, string>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    DisplayName string
    A friendly name for the environment family. The name must contain only letters, numbers, dashes, and underscores. Can be changed later.
    FamilyMaintenancePolicies List<GetFusionEnvironmentFamilyFamilyMaintenancePolicy>
    The policy that specifies the maintenance and upgrade preferences for an environment. For more information about the options, see Understanding Environment Maintenance.
    FreeformTags Dictionary<string, string>
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    FusionEnvironmentFamilyId string
    Id string
    The unique identifier (OCID) of the environment family. Can't be changed after creation.
    IsSubscriptionUpdateNeeded bool
    When set to True, a subscription update is required for the environment family.
    LifecycleDetails string
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
    State string
    The current state of the FusionEnvironmentFamily.
    SubscriptionIds List<string>
    The list of the IDs of the applications subscriptions that are associated with the environment family.
    SystemName string
    Environment Specific Guid/ System Name
    TimeCreated string
    The time the the FusionEnvironmentFamily was created. An RFC3339 formatted datetime string.
    TimeUpdated string
    CompartmentId string
    The OCID of the compartment where the environment family is located.
    DefinedTags map[string]string
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    DisplayName string
    A friendly name for the environment family. The name must contain only letters, numbers, dashes, and underscores. Can be changed later.
    FamilyMaintenancePolicies []GetFusionEnvironmentFamilyFamilyMaintenancePolicy
    The policy that specifies the maintenance and upgrade preferences for an environment. For more information about the options, see Understanding Environment Maintenance.
    FreeformTags map[string]string
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    FusionEnvironmentFamilyId string
    Id string
    The unique identifier (OCID) of the environment family. Can't be changed after creation.
    IsSubscriptionUpdateNeeded bool
    When set to True, a subscription update is required for the environment family.
    LifecycleDetails string
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
    State string
    The current state of the FusionEnvironmentFamily.
    SubscriptionIds []string
    The list of the IDs of the applications subscriptions that are associated with the environment family.
    SystemName string
    Environment Specific Guid/ System Name
    TimeCreated string
    The time the the FusionEnvironmentFamily was created. An RFC3339 formatted datetime string.
    TimeUpdated string
    compartmentId String
    The OCID of the compartment where the environment family is located.
    definedTags Map<String,String>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    displayName String
    A friendly name for the environment family. The name must contain only letters, numbers, dashes, and underscores. Can be changed later.
    familyMaintenancePolicies List<GetFusionEnvironmentFamilyFamilyMaintenancePolicy>
    The policy that specifies the maintenance and upgrade preferences for an environment. For more information about the options, see Understanding Environment Maintenance.
    freeformTags Map<String,String>
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    fusionEnvironmentFamilyId String
    id String
    The unique identifier (OCID) of the environment family. Can't be changed after creation.
    isSubscriptionUpdateNeeded Boolean
    When set to True, a subscription update is required for the environment family.
    lifecycleDetails String
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
    state String
    The current state of the FusionEnvironmentFamily.
    subscriptionIds List<String>
    The list of the IDs of the applications subscriptions that are associated with the environment family.
    systemName String
    Environment Specific Guid/ System Name
    timeCreated String
    The time the the FusionEnvironmentFamily was created. An RFC3339 formatted datetime string.
    timeUpdated String
    compartmentId string
    The OCID of the compartment where the environment family is located.
    definedTags {[key: string]: string}
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    displayName string
    A friendly name for the environment family. The name must contain only letters, numbers, dashes, and underscores. Can be changed later.
    familyMaintenancePolicies GetFusionEnvironmentFamilyFamilyMaintenancePolicy[]
    The policy that specifies the maintenance and upgrade preferences for an environment. For more information about the options, see Understanding Environment Maintenance.
    freeformTags {[key: string]: string}
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    fusionEnvironmentFamilyId string
    id string
    The unique identifier (OCID) of the environment family. Can't be changed after creation.
    isSubscriptionUpdateNeeded boolean
    When set to True, a subscription update is required for the environment family.
    lifecycleDetails string
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
    state string
    The current state of the FusionEnvironmentFamily.
    subscriptionIds string[]
    The list of the IDs of the applications subscriptions that are associated with the environment family.
    systemName string
    Environment Specific Guid/ System Name
    timeCreated string
    The time the the FusionEnvironmentFamily was created. An RFC3339 formatted datetime string.
    timeUpdated string
    compartment_id str
    The OCID of the compartment where the environment family is located.
    defined_tags Mapping[str, str]
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    display_name str
    A friendly name for the environment family. The name must contain only letters, numbers, dashes, and underscores. Can be changed later.
    family_maintenance_policies Sequence[functions.GetFusionEnvironmentFamilyFamilyMaintenancePolicy]
    The policy that specifies the maintenance and upgrade preferences for an environment. For more information about the options, see Understanding Environment Maintenance.
    freeform_tags Mapping[str, str]
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    fusion_environment_family_id str
    id str
    The unique identifier (OCID) of the environment family. Can't be changed after creation.
    is_subscription_update_needed bool
    When set to True, a subscription update is required for the environment family.
    lifecycle_details str
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
    state str
    The current state of the FusionEnvironmentFamily.
    subscription_ids Sequence[str]
    The list of the IDs of the applications subscriptions that are associated with the environment family.
    system_name str
    Environment Specific Guid/ System Name
    time_created str
    The time the the FusionEnvironmentFamily was created. An RFC3339 formatted datetime string.
    time_updated str
    compartmentId String
    The OCID of the compartment where the environment family is located.
    definedTags Map<String>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    displayName String
    A friendly name for the environment family. The name must contain only letters, numbers, dashes, and underscores. Can be changed later.
    familyMaintenancePolicies List<Property Map>
    The policy that specifies the maintenance and upgrade preferences for an environment. For more information about the options, see Understanding Environment Maintenance.
    freeformTags Map<String>
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    fusionEnvironmentFamilyId String
    id String
    The unique identifier (OCID) of the environment family. Can't be changed after creation.
    isSubscriptionUpdateNeeded Boolean
    When set to True, a subscription update is required for the environment family.
    lifecycleDetails String
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
    state String
    The current state of the FusionEnvironmentFamily.
    subscriptionIds List<String>
    The list of the IDs of the applications subscriptions that are associated with the environment family.
    systemName String
    Environment Specific Guid/ System Name
    timeCreated String
    The time the the FusionEnvironmentFamily was created. An RFC3339 formatted datetime string.
    timeUpdated String

    Supporting Types

    GetFusionEnvironmentFamilyFamilyMaintenancePolicy

    ConcurrentMaintenance string
    Option to upgrade both production and non-production environments at the same time. When set to PROD both types of environnments are upgraded on the production schedule. When set to NON_PROD both types of environments are upgraded on the non-production schedule.
    IsMonthlyPatchingEnabled bool
    When True, monthly patching is enabled for the environment family.
    QuarterlyUpgradeBeginTimes string
    The quarterly maintenance month group schedule of the Fusion environment family.
    ConcurrentMaintenance string
    Option to upgrade both production and non-production environments at the same time. When set to PROD both types of environnments are upgraded on the production schedule. When set to NON_PROD both types of environments are upgraded on the non-production schedule.
    IsMonthlyPatchingEnabled bool
    When True, monthly patching is enabled for the environment family.
    QuarterlyUpgradeBeginTimes string
    The quarterly maintenance month group schedule of the Fusion environment family.
    concurrentMaintenance String
    Option to upgrade both production and non-production environments at the same time. When set to PROD both types of environnments are upgraded on the production schedule. When set to NON_PROD both types of environments are upgraded on the non-production schedule.
    isMonthlyPatchingEnabled Boolean
    When True, monthly patching is enabled for the environment family.
    quarterlyUpgradeBeginTimes String
    The quarterly maintenance month group schedule of the Fusion environment family.
    concurrentMaintenance string
    Option to upgrade both production and non-production environments at the same time. When set to PROD both types of environnments are upgraded on the production schedule. When set to NON_PROD both types of environments are upgraded on the non-production schedule.
    isMonthlyPatchingEnabled boolean
    When True, monthly patching is enabled for the environment family.
    quarterlyUpgradeBeginTimes string
    The quarterly maintenance month group schedule of the Fusion environment family.
    concurrent_maintenance str
    Option to upgrade both production and non-production environments at the same time. When set to PROD both types of environnments are upgraded on the production schedule. When set to NON_PROD both types of environments are upgraded on the non-production schedule.
    is_monthly_patching_enabled bool
    When True, monthly patching is enabled for the environment family.
    quarterly_upgrade_begin_times str
    The quarterly maintenance month group schedule of the Fusion environment family.
    concurrentMaintenance String
    Option to upgrade both production and non-production environments at the same time. When set to PROD both types of environnments are upgraded on the production schedule. When set to NON_PROD both types of environments are upgraded on the non-production schedule.
    isMonthlyPatchingEnabled Boolean
    When True, monthly patching is enabled for the environment family.
    quarterlyUpgradeBeginTimes String
    The quarterly maintenance month group schedule of the Fusion environment family.

    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 v2.17.0 published on Friday, Nov 15, 2024 by Pulumi