Docs Packages
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. DataSafe
  5. DataSafeConfiguration
Oracle Cloud Infrastructure v1.41.0 published on Wednesday, Jun 19, 2024 by Pulumi
pulumi/pulumi-oci

oci.DataSafe.DataSafeConfiguration

Explore with Pulumi AI

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

    This resource provides the Data Safe Configuration resource in Oracle Cloud Infrastructure Data Safe service.

    Enables Data Safe in the tenancy and region.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testDataSafeConfiguration = new oci.datasafe.DataSafeConfiguration("test_data_safe_configuration", {
    isEnabled: dataSafeConfigurationIsEnabled,
    compartmentId: compartmentId,
});

    import pulumi
import pulumi_oci as oci

test_data_safe_configuration = oci.data_safe.DataSafeConfiguration("test_data_safe_configuration",
    is_enabled=data_safe_configuration_is_enabled,
    compartment_id=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.NewDataSafeConfiguration(ctx, "test_data_safe_configuration", &DataSafe.DataSafeConfigurationArgs{
			IsEnabled:     pulumi.Any(dataSafeConfigurationIsEnabled),
			CompartmentId: pulumi.Any(compartmentId),
		})
		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 = new Oci.DataSafe.DataSafeConfiguration("test_data_safe_configuration", new()
    {
        IsEnabled = dataSafeConfigurationIsEnabled,
        CompartmentId = compartmentId,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.DataSafe.DataSafeConfiguration;
import com.pulumi.oci.DataSafe.DataSafeConfigurationArgs;
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) {
        var testDataSafeConfiguration = new DataSafeConfiguration("testDataSafeConfiguration", DataSafeConfigurationArgs.builder()
            .isEnabled(dataSafeConfigurationIsEnabled)
            .compartmentId(compartmentId)
            .build());

    }
}

    resources:
  testDataSafeConfiguration:
    type: oci:DataSafe:DataSafeConfiguration
    name: test_data_safe_configuration
    properties:
      isEnabled: ${dataSafeConfigurationIsEnabled}
      compartmentId: ${compartmentId}

    Create DataSafeConfiguration Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new DataSafeConfiguration(name: string, args: DataSafeConfigurationArgs, opts?: CustomResourceOptions);
    @overload
def DataSafeConfiguration(resource_name: str,
                          args: DataSafeConfigurationArgs,
                          opts: Optional[ResourceOptions] = None)

@overload
def DataSafeConfiguration(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          is_enabled: Optional[bool] = None,
                          compartment_id: Optional[str] = None)
    func NewDataSafeConfiguration(ctx *Context, name string, args DataSafeConfigurationArgs, opts ...ResourceOption) (*DataSafeConfiguration, error)
    public DataSafeConfiguration(string name, DataSafeConfigurationArgs args, CustomResourceOptions? opts = null)
    public DataSafeConfiguration(String name, DataSafeConfigurationArgs args)
public DataSafeConfiguration(String name, DataSafeConfigurationArgs args, CustomResourceOptions options)

    type: oci:DataSafe:DataSafeConfiguration
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args DataSafeConfigurationArgs
    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 DataSafeConfigurationArgs
    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 DataSafeConfigurationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DataSafeConfigurationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DataSafeConfigurationArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var dataSafeConfigurationResource = new Oci.DataSafe.DataSafeConfiguration("dataSafeConfigurationResource", new()
{
    IsEnabled = false,
    CompartmentId = "string",
});

    example, err := DataSafe.NewDataSafeConfiguration(ctx, "dataSafeConfigurationResource", &DataSafe.DataSafeConfigurationArgs{
	IsEnabled:     pulumi.Bool(false),
	CompartmentId: pulumi.String("string"),
})

    var dataSafeConfigurationResource = new DataSafeConfiguration("dataSafeConfigurationResource", DataSafeConfigurationArgs.builder()
    .isEnabled(false)
    .compartmentId("string")
    .build());

    data_safe_configuration_resource = oci.data_safe.DataSafeConfiguration("dataSafeConfigurationResource",
    is_enabled=False,
    compartment_id="string")

    const dataSafeConfigurationResource = new oci.datasafe.DataSafeConfiguration("dataSafeConfigurationResource", {
    isEnabled: false,
    compartmentId: "string",
});

    type: oci:DataSafe:DataSafeConfiguration
properties:
    compartmentId: string
    isEnabled: false

    DataSafeConfiguration 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 DataSafeConfiguration resource accepts the following input properties:

    IsEnabled bool

    (Updatable) Indicates if Data Safe is enabled.

    ** 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

    CompartmentId string
    (Updatable) A filter to return only resources that match the specified compartment OCID.
    IsEnabled bool

    (Updatable) Indicates if Data Safe is enabled.

    ** 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

    CompartmentId string
    (Updatable) A filter to return only resources that match the specified compartment OCID.
    isEnabled Boolean

    (Updatable) Indicates if Data Safe is enabled.

    ** 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

    compartmentId String
    (Updatable) A filter to return only resources that match the specified compartment OCID.
    isEnabled boolean

    (Updatable) Indicates if Data Safe is enabled.

    ** 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

    compartmentId string
    (Updatable) A filter to return only resources that match the specified compartment OCID.
    is_enabled bool

    (Updatable) Indicates if Data Safe is enabled.

    ** 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

    compartment_id str
    (Updatable) A filter to return only resources that match the specified compartment OCID.
    isEnabled Boolean

    (Updatable) Indicates if Data Safe is enabled.

    ** 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

    compartmentId String
    (Updatable) A filter to return only resources that match the specified compartment OCID.

    Outputs

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

    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<DataSafeConfigurationGlobalSetting>
    Details of the tenancy level global settings in Data Safe.
    Id string
    The provider-assigned unique ID for this managed resource.
    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.
    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 []DataSafeConfigurationGlobalSetting
    Details of the tenancy level global settings in Data Safe.
    Id string
    The provider-assigned unique ID for this managed resource.
    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.
    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<ConfigurationGlobalSetting>
    Details of the tenancy level global settings in Data Safe.
    id String
    The provider-assigned unique ID for this managed resource.
    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.
    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 DataSafeConfigurationGlobalSetting[]
    Details of the tenancy level global settings in Data Safe.
    id string
    The provider-assigned unique ID for this managed resource.
    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.
    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.DataSafeConfigurationGlobalSetting]
    Details of the tenancy level global settings in Data Safe.
    id str
    The provider-assigned unique ID for this managed resource.
    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.
    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
    The provider-assigned unique ID for this managed resource.
    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.

    Look up Existing DataSafeConfiguration Resource

    Get an existing DataSafeConfiguration 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?: DataSafeConfigurationState, opts?: CustomResourceOptions): DataSafeConfiguration
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        compartment_id: Optional[str] = None,
        data_safe_nat_gateway_ip_address: Optional[str] = None,
        defined_tags: Optional[Mapping[str, Any]] = None,
        freeform_tags: Optional[Mapping[str, Any]] = None,
        global_settings: Optional[Sequence[_datasafe.DataSafeConfigurationGlobalSettingArgs]] = None,
        is_enabled: Optional[bool] = None,
        state: Optional[str] = None,
        time_enabled: Optional[str] = None,
        url: Optional[str] = None) -> DataSafeConfiguration
    func GetDataSafeConfiguration(ctx *Context, name string, id IDInput, state *DataSafeConfigurationState, opts ...ResourceOption) (*DataSafeConfiguration, error)
    public static DataSafeConfiguration Get(string name, Input<string> id, DataSafeConfigurationState? state, CustomResourceOptions? opts = null)
    public static DataSafeConfiguration get(String name, Output<String> id, DataSafeConfigurationState 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:
    CompartmentId string
    (Updatable) A filter to return only resources that match the specified compartment OCID.
    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<DataSafeConfigurationGlobalSetting>
    Details of the tenancy level global settings in Data Safe.
    IsEnabled bool

    (Updatable) Indicates if Data Safe is enabled.

    ** 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

    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
    (Updatable) A filter to return only resources that match the specified compartment OCID.
    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 []DataSafeConfigurationGlobalSettingArgs
    Details of the tenancy level global settings in Data Safe.
    IsEnabled bool

    (Updatable) Indicates if Data Safe is enabled.

    ** 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

    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
    (Updatable) A filter to return only resources that match the specified compartment OCID.
    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<ConfigurationGlobalSetting>
    Details of the tenancy level global settings in Data Safe.
    isEnabled Boolean

    (Updatable) Indicates if Data Safe is enabled.

    ** 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

    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
    (Updatable) A filter to return only resources that match the specified compartment OCID.
    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 DataSafeConfigurationGlobalSetting[]
    Details of the tenancy level global settings in Data Safe.
    isEnabled boolean

    (Updatable) Indicates if Data Safe is enabled.

    ** 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

    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
    (Updatable) A filter to return only resources that match the specified compartment OCID.
    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.DataSafeConfigurationGlobalSettingArgs]
    Details of the tenancy level global settings in Data Safe.
    is_enabled bool

    (Updatable) Indicates if Data Safe is enabled.

    ** 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

    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
    (Updatable) A filter to return only resources that match the specified compartment OCID.
    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.
    isEnabled Boolean

    (Updatable) Indicates if Data Safe is enabled.

    ** 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

    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

    DataSafeConfigurationGlobalSetting, DataSafeConfigurationGlobalSettingArgs

    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.

    Import

    Import is not supported for this resource.

    To learn more about importing existing cloud resources, see Importing resources.

    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
    pulumi/pulumi-oci