1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. DataSafe
  5. getDataSafeConfiguration
Oracle Cloud Infrastructure v1.31.0 published on Wednesday, Apr 10, 2024 by Pulumi

oci.DataSafe.getDataSafeConfiguration

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v1.31.0 published on Wednesday, Apr 10, 2024 by Pulumi

    This data source provides details about a specific Data Safe Configuration resource in Oracle Cloud Infrastructure Data Safe service.

    Gets the details of the Data Safe configuration.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as oci from "@pulumi/oci";
    
    const testDataSafeConfiguration = oci.DataSafe.getDataSafeConfiguration({
        compartmentId: _var.compartment_id,
    });
    
    import pulumi
    import pulumi_oci as oci
    
    test_data_safe_configuration = oci.DataSafe.get_data_safe_configuration(compartment_id=var["compartment_id"])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-oci/sdk/go/oci/DataSafe"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := DataSafe.GetDataSafeConfiguration(ctx, &datasafe.GetDataSafeConfigurationArgs{
    			CompartmentId: _var.Compartment_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 testDataSafeConfiguration = Oci.DataSafe.GetDataSafeConfiguration.Invoke(new()
        {
            CompartmentId = @var.Compartment_id,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.oci.DataSafe.DataSafeFunctions;
    import com.pulumi.oci.DataSafe.inputs.GetDataSafeConfigurationArgs;
    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 testDataSafeConfiguration = DataSafeFunctions.getDataSafeConfiguration(GetDataSafeConfigurationArgs.builder()
                .compartmentId(var_.compartment_id())
                .build());
    
        }
    }
    
    variables:
      testDataSafeConfiguration:
        fn::invoke:
          Function: oci:DataSafe:getDataSafeConfiguration
          Arguments:
            compartmentId: ${var.compartment_id}
    

    Using getDataSafeConfiguration

    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 getDataSafeConfiguration(args: GetDataSafeConfigurationArgs, opts?: InvokeOptions): Promise<GetDataSafeConfigurationResult>
    function getDataSafeConfigurationOutput(args: GetDataSafeConfigurationOutputArgs, opts?: InvokeOptions): Output<GetDataSafeConfigurationResult>
    def get_data_safe_configuration(compartment_id: Optional[str] = None,
                                    opts: Optional[InvokeOptions] = None) -> GetDataSafeConfigurationResult
    def get_data_safe_configuration_output(compartment_id: Optional[pulumi.Input[str]] = None,
                                    opts: Optional[InvokeOptions] = None) -> Output[GetDataSafeConfigurationResult]
    func GetDataSafeConfiguration(ctx *Context, args *GetDataSafeConfigurationArgs, opts ...InvokeOption) (*GetDataSafeConfigurationResult, error)
    func GetDataSafeConfigurationOutput(ctx *Context, args *GetDataSafeConfigurationOutputArgs, opts ...InvokeOption) GetDataSafeConfigurationResultOutput

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

    public static class GetDataSafeConfiguration 
    {
        public static Task<GetDataSafeConfigurationResult> InvokeAsync(GetDataSafeConfigurationArgs args, InvokeOptions? opts = null)
        public static Output<GetDataSafeConfigurationResult> Invoke(GetDataSafeConfigurationInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetDataSafeConfigurationResult> getDataSafeConfiguration(GetDataSafeConfigurationArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: oci:DataSafe/getDataSafeConfiguration:getDataSafeConfiguration
      arguments:
        # arguments dictionary

    The following arguments are supported:

    CompartmentId string
    A filter to return only resources that match the specified compartment OCID.
    CompartmentId string
    A filter to return only resources that match the specified compartment OCID.
    compartmentId String
    A filter to return only resources that match the specified compartment OCID.
    compartmentId string
    A filter to return only resources that match the specified compartment OCID.
    compartment_id str
    A filter to return only resources that match the specified compartment OCID.
    compartmentId String
    A filter to return only resources that match the specified compartment OCID.

    getDataSafeConfiguration Result

    The following output properties are available:

    CompartmentId string
    The OCID of the tenancy used to enable Data Safe.
    DataSafeNatGatewayIpAddress string
    The Oracle Data Safe's NAT Gateway IP Address.
    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: {"Operations.CostCenter": "42"}
    FreeformTags Dictionary<string, object>
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags Example: {"Department": "Finance"}
    GlobalSettings List<GetDataSafeConfigurationGlobalSetting>
    Details of the tenancy level global settings in Data Safe.
    Id string
    IsEnabled bool
    Indicates if Data Safe is enabled.
    State string
    The current state of Data Safe.
    TimeEnabled string
    The date and time Data Safe was enabled, in the format defined by RFC3339.
    Url string
    The URL of the Data Safe service.
    CompartmentId string
    The OCID of the tenancy used to enable Data Safe.
    DataSafeNatGatewayIpAddress string
    The Oracle Data Safe's NAT Gateway IP Address.
    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: {"Operations.CostCenter": "42"}
    FreeformTags map[string]interface{}
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags Example: {"Department": "Finance"}
    GlobalSettings []GetDataSafeConfigurationGlobalSetting
    Details of the tenancy level global settings in Data Safe.
    Id string
    IsEnabled bool
    Indicates if Data Safe is enabled.
    State string
    The current state of Data Safe.
    TimeEnabled string
    The date and time Data Safe was enabled, in the format defined by RFC3339.
    Url string
    The URL of the Data Safe service.
    compartmentId String
    The OCID of the tenancy used to enable Data Safe.
    dataSafeNatGatewayIpAddress String
    The Oracle Data Safe's NAT Gateway IP Address.
    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: {"Operations.CostCenter": "42"}
    freeformTags Map<String,Object>
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags Example: {"Department": "Finance"}
    globalSettings List<GetConfigurationGlobalSetting>
    Details of the tenancy level global settings in Data Safe.
    id String
    isEnabled Boolean
    Indicates if Data Safe is enabled.
    state String
    The current state of Data Safe.
    timeEnabled String
    The date and time Data Safe was enabled, in the format defined by RFC3339.
    url String
    The URL of the Data Safe service.
    compartmentId string
    The OCID of the tenancy used to enable Data Safe.
    dataSafeNatGatewayIpAddress string
    The Oracle Data Safe's NAT Gateway IP Address.
    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: {"Operations.CostCenter": "42"}
    freeformTags {[key: string]: any}
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags Example: {"Department": "Finance"}
    globalSettings GetDataSafeConfigurationGlobalSetting[]
    Details of the tenancy level global settings in Data Safe.
    id string
    isEnabled boolean
    Indicates if Data Safe is enabled.
    state string
    The current state of Data Safe.
    timeEnabled string
    The date and time Data Safe was enabled, in the format defined by RFC3339.
    url string
    The URL of the Data Safe service.
    compartment_id str
    The OCID of the tenancy used to enable Data Safe.
    data_safe_nat_gateway_ip_address str
    The Oracle Data Safe's NAT Gateway IP Address.
    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: {"Operations.CostCenter": "42"}
    freeform_tags Mapping[str, Any]
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags Example: {"Department": "Finance"}
    global_settings Sequence[datasafe.GetDataSafeConfigurationGlobalSetting]
    Details of the tenancy level global settings in Data Safe.
    id str
    is_enabled bool
    Indicates if Data Safe is enabled.
    state str
    The current state of Data Safe.
    time_enabled str
    The date and time Data Safe was enabled, in the format defined by RFC3339.
    url str
    The URL of the Data Safe service.
    compartmentId String
    The OCID of the tenancy used to enable Data Safe.
    dataSafeNatGatewayIpAddress String
    The Oracle Data Safe's NAT Gateway IP Address.
    definedTags Map<Any>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {"Operations.CostCenter": "42"}
    freeformTags Map<Any>
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags Example: {"Department": "Finance"}
    globalSettings List<Property Map>
    Details of the tenancy level global settings in Data Safe.
    id String
    isEnabled Boolean
    Indicates if Data Safe is enabled.
    state String
    The current state of Data Safe.
    timeEnabled String
    The date and time Data Safe was enabled, in the format defined by RFC3339.
    url String
    The URL of the Data Safe service.

    Supporting Types

    GetDataSafeConfigurationGlobalSetting

    IsPaidUsage bool
    The paid usage option chosen by the customer admin.
    OfflineRetentionPeriod int
    The offline retention period in months.
    OnlineRetentionPeriod int
    The online retention period in months.
    IsPaidUsage bool
    The paid usage option chosen by the customer admin.
    OfflineRetentionPeriod int
    The offline retention period in months.
    OnlineRetentionPeriod int
    The online retention period in months.
    isPaidUsage Boolean
    The paid usage option chosen by the customer admin.
    offlineRetentionPeriod Integer
    The offline retention period in months.
    onlineRetentionPeriod Integer
    The online retention period in months.
    isPaidUsage boolean
    The paid usage option chosen by the customer admin.
    offlineRetentionPeriod number
    The offline retention period in months.
    onlineRetentionPeriod number
    The online retention period in months.
    is_paid_usage bool
    The paid usage option chosen by the customer admin.
    offline_retention_period int
    The offline retention period in months.
    online_retention_period int
    The online retention period in months.
    isPaidUsage Boolean
    The paid usage option chosen by the customer admin.
    offlineRetentionPeriod Number
    The offline retention period in months.
    onlineRetentionPeriod Number
    The online retention period in months.

    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.31.0 published on Wednesday, Apr 10, 2024 by Pulumi