oci.DatabaseManagement.ExternalDbHome
Explore with Pulumi AI
This resource provides the External Db Home resource in Oracle Cloud Infrastructure Database Management service.
Updates the external DB home specified by externalDbHomeId.
Create ExternalDbHome Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new ExternalDbHome(name: string, args: ExternalDbHomeArgs, opts?: CustomResourceOptions);@overload
def ExternalDbHome(resource_name: str,
                   args: ExternalDbHomeArgs,
                   opts: Optional[ResourceOptions] = None)
@overload
def ExternalDbHome(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   external_db_home_id: Optional[str] = None,
                   defined_tags: Optional[Mapping[str, str]] = None,
                   freeform_tags: Optional[Mapping[str, str]] = None)func NewExternalDbHome(ctx *Context, name string, args ExternalDbHomeArgs, opts ...ResourceOption) (*ExternalDbHome, error)public ExternalDbHome(string name, ExternalDbHomeArgs args, CustomResourceOptions? opts = null)
public ExternalDbHome(String name, ExternalDbHomeArgs args)
public ExternalDbHome(String name, ExternalDbHomeArgs args, CustomResourceOptions options)
type: oci:DatabaseManagement:ExternalDbHome
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 ExternalDbHomeArgs
- 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 ExternalDbHomeArgs
- 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 ExternalDbHomeArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ExternalDbHomeArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ExternalDbHomeArgs
- 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 externalDbHomeResource = new Oci.DatabaseManagement.ExternalDbHome("externalDbHomeResource", new()
{
    ExternalDbHomeId = "string",
    DefinedTags = 
    {
        { "string", "string" },
    },
    FreeformTags = 
    {
        { "string", "string" },
    },
});
example, err := databasemanagement.NewExternalDbHome(ctx, "externalDbHomeResource", &databasemanagement.ExternalDbHomeArgs{
	ExternalDbHomeId: pulumi.String("string"),
	DefinedTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	FreeformTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})
var externalDbHomeResource = new ExternalDbHome("externalDbHomeResource", ExternalDbHomeArgs.builder()
    .externalDbHomeId("string")
    .definedTags(Map.of("string", "string"))
    .freeformTags(Map.of("string", "string"))
    .build());
external_db_home_resource = oci.database_management.ExternalDbHome("externalDbHomeResource",
    external_db_home_id="string",
    defined_tags={
        "string": "string",
    },
    freeform_tags={
        "string": "string",
    })
const externalDbHomeResource = new oci.databasemanagement.ExternalDbHome("externalDbHomeResource", {
    externalDbHomeId: "string",
    definedTags: {
        string: "string",
    },
    freeformTags: {
        string: "string",
    },
});
type: oci:DatabaseManagement:ExternalDbHome
properties:
    definedTags:
        string: string
    externalDbHomeId: string
    freeformTags:
        string: string
ExternalDbHome Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The ExternalDbHome resource accepts the following input properties:
- ExternalDb stringHome Id 
- The OCID of the external database home.
- Dictionary<string, string>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
- Dictionary<string, string>
- (Updatable) 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"}- ** 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 
- ExternalDb stringHome Id 
- The OCID of the external database home.
- map[string]string
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
- map[string]string
- (Updatable) 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"}- ** 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 
- externalDb StringHome Id 
- The OCID of the external database home.
- Map<String,String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
- Map<String,String>
- (Updatable) 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"}- ** 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 
- externalDb stringHome Id 
- The OCID of the external database home.
- {[key: string]: string}
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
- {[key: string]: string}
- (Updatable) 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"}- ** 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 
- external_db_ strhome_ id 
- The OCID of the external database home.
- Mapping[str, str]
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
- Mapping[str, str]
- (Updatable) 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"}- ** 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 
- externalDb StringHome Id 
- The OCID of the external database home.
- Map<String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
- Map<String>
- (Updatable) 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"}- ** 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 ExternalDbHome resource produces the following output properties:
- AdditionalDetails Dictionary<string, string>
- The additional details of the DB home defined in {"key": "value"}format. Example:{"bar-key": "value"}
- CompartmentId string
- The OCID of the compartment.
- ComponentName string
- The name of the external DB home.
- DisplayName string
- The user-friendly name for the external DB home. The name does not have to be unique.
- ExternalDb stringSystem Id 
- The OCID of the external DB system that the DB home is a part of.
- HomeDirectory string
- The location of the DB home.
- Id string
- The provider-assigned unique ID for this managed resource.
- LifecycleDetails string
- Additional information about the current lifecycle state.
- State string
- The current lifecycle state of the external DB home.
- Dictionary<string, string>
- System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
- TimeCreated string
- The date and time the external DB home was created.
- TimeUpdated string
- The date and time the external DB home was last updated.
- AdditionalDetails map[string]string
- The additional details of the DB home defined in {"key": "value"}format. Example:{"bar-key": "value"}
- CompartmentId string
- The OCID of the compartment.
- ComponentName string
- The name of the external DB home.
- DisplayName string
- The user-friendly name for the external DB home. The name does not have to be unique.
- ExternalDb stringSystem Id 
- The OCID of the external DB system that the DB home is a part of.
- HomeDirectory string
- The location of the DB home.
- Id string
- The provider-assigned unique ID for this managed resource.
- LifecycleDetails string
- Additional information about the current lifecycle state.
- State string
- The current lifecycle state of the external DB home.
- map[string]string
- System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
- TimeCreated string
- The date and time the external DB home was created.
- TimeUpdated string
- The date and time the external DB home was last updated.
- additionalDetails Map<String,String>
- The additional details of the DB home defined in {"key": "value"}format. Example:{"bar-key": "value"}
- compartmentId String
- The OCID of the compartment.
- componentName String
- The name of the external DB home.
- displayName String
- The user-friendly name for the external DB home. The name does not have to be unique.
- externalDb StringSystem Id 
- The OCID of the external DB system that the DB home is a part of.
- homeDirectory String
- The location of the DB home.
- id String
- The provider-assigned unique ID for this managed resource.
- lifecycleDetails String
- Additional information about the current lifecycle state.
- state String
- The current lifecycle state of the external DB home.
- Map<String,String>
- System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
- timeCreated String
- The date and time the external DB home was created.
- timeUpdated String
- The date and time the external DB home was last updated.
- additionalDetails {[key: string]: string}
- The additional details of the DB home defined in {"key": "value"}format. Example:{"bar-key": "value"}
- compartmentId string
- The OCID of the compartment.
- componentName string
- The name of the external DB home.
- displayName string
- The user-friendly name for the external DB home. The name does not have to be unique.
- externalDb stringSystem Id 
- The OCID of the external DB system that the DB home is a part of.
- homeDirectory string
- The location of the DB home.
- id string
- The provider-assigned unique ID for this managed resource.
- lifecycleDetails string
- Additional information about the current lifecycle state.
- state string
- The current lifecycle state of the external DB home.
- {[key: string]: string}
- System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
- timeCreated string
- The date and time the external DB home was created.
- timeUpdated string
- The date and time the external DB home was last updated.
- additional_details Mapping[str, str]
- The additional details of the DB home defined in {"key": "value"}format. Example:{"bar-key": "value"}
- compartment_id str
- The OCID of the compartment.
- component_name str
- The name of the external DB home.
- display_name str
- The user-friendly name for the external DB home. The name does not have to be unique.
- external_db_ strsystem_ id 
- The OCID of the external DB system that the DB home is a part of.
- home_directory str
- The location of the DB home.
- id str
- The provider-assigned unique ID for this managed resource.
- lifecycle_details str
- Additional information about the current lifecycle state.
- state str
- The current lifecycle state of the external DB home.
- Mapping[str, str]
- System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
- time_created str
- The date and time the external DB home was created.
- time_updated str
- The date and time the external DB home was last updated.
- additionalDetails Map<String>
- The additional details of the DB home defined in {"key": "value"}format. Example:{"bar-key": "value"}
- compartmentId String
- The OCID of the compartment.
- componentName String
- The name of the external DB home.
- displayName String
- The user-friendly name for the external DB home. The name does not have to be unique.
- externalDb StringSystem Id 
- The OCID of the external DB system that the DB home is a part of.
- homeDirectory String
- The location of the DB home.
- id String
- The provider-assigned unique ID for this managed resource.
- lifecycleDetails String
- Additional information about the current lifecycle state.
- state String
- The current lifecycle state of the external DB home.
- Map<String>
- System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
- timeCreated String
- The date and time the external DB home was created.
- timeUpdated String
- The date and time the external DB home was last updated.
Look up Existing ExternalDbHome Resource
Get an existing ExternalDbHome 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?: ExternalDbHomeState, opts?: CustomResourceOptions): ExternalDbHome@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        additional_details: Optional[Mapping[str, str]] = None,
        compartment_id: Optional[str] = None,
        component_name: Optional[str] = None,
        defined_tags: Optional[Mapping[str, str]] = None,
        display_name: Optional[str] = None,
        external_db_home_id: Optional[str] = None,
        external_db_system_id: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, str]] = None,
        home_directory: Optional[str] = None,
        lifecycle_details: Optional[str] = None,
        state: Optional[str] = None,
        system_tags: Optional[Mapping[str, str]] = None,
        time_created: Optional[str] = None,
        time_updated: Optional[str] = None) -> ExternalDbHomefunc GetExternalDbHome(ctx *Context, name string, id IDInput, state *ExternalDbHomeState, opts ...ResourceOption) (*ExternalDbHome, error)public static ExternalDbHome Get(string name, Input<string> id, ExternalDbHomeState? state, CustomResourceOptions? opts = null)public static ExternalDbHome get(String name, Output<String> id, ExternalDbHomeState state, CustomResourceOptions options)resources:  _:    type: oci:DatabaseManagement:ExternalDbHome    get:      id: ${id}- 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.
- AdditionalDetails Dictionary<string, string>
- The additional details of the DB home defined in {"key": "value"}format. Example:{"bar-key": "value"}
- CompartmentId string
- The OCID of the compartment.
- ComponentName string
- The name of the external DB home.
- Dictionary<string, string>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
- DisplayName string
- The user-friendly name for the external DB home. The name does not have to be unique.
- ExternalDb stringHome Id 
- The OCID of the external database home.
- ExternalDb stringSystem Id 
- The OCID of the external DB system that the DB home is a part of.
- Dictionary<string, string>
- (Updatable) 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"}- ** 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 
- HomeDirectory string
- The location of the DB home.
- LifecycleDetails string
- Additional information about the current lifecycle state.
- State string
- The current lifecycle state of the external DB home.
- Dictionary<string, string>
- System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
- TimeCreated string
- The date and time the external DB home was created.
- TimeUpdated string
- The date and time the external DB home was last updated.
- AdditionalDetails map[string]string
- The additional details of the DB home defined in {"key": "value"}format. Example:{"bar-key": "value"}
- CompartmentId string
- The OCID of the compartment.
- ComponentName string
- The name of the external DB home.
- map[string]string
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
- DisplayName string
- The user-friendly name for the external DB home. The name does not have to be unique.
- ExternalDb stringHome Id 
- The OCID of the external database home.
- ExternalDb stringSystem Id 
- The OCID of the external DB system that the DB home is a part of.
- map[string]string
- (Updatable) 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"}- ** 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 
- HomeDirectory string
- The location of the DB home.
- LifecycleDetails string
- Additional information about the current lifecycle state.
- State string
- The current lifecycle state of the external DB home.
- map[string]string
- System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
- TimeCreated string
- The date and time the external DB home was created.
- TimeUpdated string
- The date and time the external DB home was last updated.
- additionalDetails Map<String,String>
- The additional details of the DB home defined in {"key": "value"}format. Example:{"bar-key": "value"}
- compartmentId String
- The OCID of the compartment.
- componentName String
- The name of the external DB home.
- Map<String,String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
- displayName String
- The user-friendly name for the external DB home. The name does not have to be unique.
- externalDb StringHome Id 
- The OCID of the external database home.
- externalDb StringSystem Id 
- The OCID of the external DB system that the DB home is a part of.
- Map<String,String>
- (Updatable) 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"}- ** 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 
- homeDirectory String
- The location of the DB home.
- lifecycleDetails String
- Additional information about the current lifecycle state.
- state String
- The current lifecycle state of the external DB home.
- Map<String,String>
- System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
- timeCreated String
- The date and time the external DB home was created.
- timeUpdated String
- The date and time the external DB home was last updated.
- additionalDetails {[key: string]: string}
- The additional details of the DB home defined in {"key": "value"}format. Example:{"bar-key": "value"}
- compartmentId string
- The OCID of the compartment.
- componentName string
- The name of the external DB home.
- {[key: string]: string}
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
- displayName string
- The user-friendly name for the external DB home. The name does not have to be unique.
- externalDb stringHome Id 
- The OCID of the external database home.
- externalDb stringSystem Id 
- The OCID of the external DB system that the DB home is a part of.
- {[key: string]: string}
- (Updatable) 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"}- ** 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 
- homeDirectory string
- The location of the DB home.
- lifecycleDetails string
- Additional information about the current lifecycle state.
- state string
- The current lifecycle state of the external DB home.
- {[key: string]: string}
- System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
- timeCreated string
- The date and time the external DB home was created.
- timeUpdated string
- The date and time the external DB home was last updated.
- additional_details Mapping[str, str]
- The additional details of the DB home defined in {"key": "value"}format. Example:{"bar-key": "value"}
- compartment_id str
- The OCID of the compartment.
- component_name str
- The name of the external DB home.
- Mapping[str, str]
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
- display_name str
- The user-friendly name for the external DB home. The name does not have to be unique.
- external_db_ strhome_ id 
- The OCID of the external database home.
- external_db_ strsystem_ id 
- The OCID of the external DB system that the DB home is a part of.
- Mapping[str, str]
- (Updatable) 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"}- ** 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 
- home_directory str
- The location of the DB home.
- lifecycle_details str
- Additional information about the current lifecycle state.
- state str
- The current lifecycle state of the external DB home.
- Mapping[str, str]
- System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
- time_created str
- The date and time the external DB home was created.
- time_updated str
- The date and time the external DB home was last updated.
- additionalDetails Map<String>
- The additional details of the DB home defined in {"key": "value"}format. Example:{"bar-key": "value"}
- compartmentId String
- The OCID of the compartment.
- componentName String
- The name of the external DB home.
- Map<String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
- displayName String
- The user-friendly name for the external DB home. The name does not have to be unique.
- externalDb StringHome Id 
- The OCID of the external database home.
- externalDb StringSystem Id 
- The OCID of the external DB system that the DB home is a part of.
- Map<String>
- (Updatable) 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"}- ** 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 
- homeDirectory String
- The location of the DB home.
- lifecycleDetails String
- Additional information about the current lifecycle state.
- state String
- The current lifecycle state of the external DB home.
- Map<String>
- System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
- timeCreated String
- The date and time the external DB home was created.
- timeUpdated String
- The date and time the external DB home was last updated.
Import
ExternalDbHomes can be imported using the id, e.g.
$ pulumi import oci:DatabaseManagement/externalDbHome:ExternalDbHome test_external_db_home "id"
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 ociTerraform Provider.