oci logo
Oracle Cloud Infrastructure v0.13.0, Mar 28 23

oci.DatabaseManagement.ExternalDbNode

This resource provides the External Db Node resource in Oracle Cloud Infrastructure Database Management service.

Updates the external DB node specified by externalDbNodeId.

Create ExternalDbNode Resource

new ExternalDbNode(name: string, args: ExternalDbNodeArgs, opts?: CustomResourceOptions);
@overload
def ExternalDbNode(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   external_connector_id: Optional[str] = None,
                   external_db_node_id: Optional[str] = None)
@overload
def ExternalDbNode(resource_name: str,
                   args: ExternalDbNodeArgs,
                   opts: Optional[ResourceOptions] = None)
func NewExternalDbNode(ctx *Context, name string, args ExternalDbNodeArgs, opts ...ResourceOption) (*ExternalDbNode, error)
public ExternalDbNode(string name, ExternalDbNodeArgs args, CustomResourceOptions? opts = null)
public ExternalDbNode(String name, ExternalDbNodeArgs args)
public ExternalDbNode(String name, ExternalDbNodeArgs args, CustomResourceOptions options)
type: oci:DatabaseManagement:ExternalDbNode
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

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

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

ExternalDbNodeId string

The OCID of the external database node.

ExternalConnectorId string

(Updatable) The OCID of the external connector.

ExternalDbNodeId string

The OCID of the external database node.

ExternalConnectorId string

(Updatable) The OCID of the external connector.

externalDbNodeId String

The OCID of the external database node.

externalConnectorId String

(Updatable) The OCID of the external connector.

externalDbNodeId string

The OCID of the external database node.

externalConnectorId string

(Updatable) The OCID of the external connector.

external_db_node_id str

The OCID of the external database node.

external_connector_id str

(Updatable) The OCID of the external connector.

externalDbNodeId String

The OCID of the external database node.

externalConnectorId String

(Updatable) The OCID of the external connector.

Outputs

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

AdditionalDetails Dictionary<string, object>

The additional details of the external DB node defined in {"key": "value"} format. Example: {"bar-key": "value"}

CompartmentId string

The OCID of the compartment.

ComponentName string

The name of the external DB node.

CpuCoreCount double

The number of CPU cores available on the DB node.

DisplayName string

The user-friendly name for the external DB node. The name does not have to be unique.

ExternalDbSystemId string

The OCID of the external DB system that the DB node is a part of.

HostName string

The host name for the DB node.

Id string

The provider-assigned unique ID for this managed resource.

LifecycleDetails string

Additional information about the current lifecycle state.

MemorySizeInGbs double

The total memory in gigabytes (GB) on the DB node.

State string

The current lifecycle state of the external DB node.

TimeCreated string

The date and time the external DB node was created.

TimeUpdated string

The date and time the external DB node was last updated.

AdditionalDetails map[string]interface{}

The additional details of the external DB node defined in {"key": "value"} format. Example: {"bar-key": "value"}

CompartmentId string

The OCID of the compartment.

ComponentName string

The name of the external DB node.

CpuCoreCount float64

The number of CPU cores available on the DB node.

DisplayName string

The user-friendly name for the external DB node. The name does not have to be unique.

ExternalDbSystemId string

The OCID of the external DB system that the DB node is a part of.

HostName string

The host name for the DB node.

Id string

The provider-assigned unique ID for this managed resource.

LifecycleDetails string

Additional information about the current lifecycle state.

MemorySizeInGbs float64

The total memory in gigabytes (GB) on the DB node.

State string

The current lifecycle state of the external DB node.

TimeCreated string

The date and time the external DB node was created.

TimeUpdated string

The date and time the external DB node was last updated.

additionalDetails Map<String,Object>

The additional details of the external DB node defined in {"key": "value"} format. Example: {"bar-key": "value"}

compartmentId String

The OCID of the compartment.

componentName String

The name of the external DB node.

cpuCoreCount Double

The number of CPU cores available on the DB node.

displayName String

The user-friendly name for the external DB node. The name does not have to be unique.

externalDbSystemId String

The OCID of the external DB system that the DB node is a part of.

hostName String

The host name for the DB node.

id String

The provider-assigned unique ID for this managed resource.

lifecycleDetails String

Additional information about the current lifecycle state.

memorySizeInGbs Double

The total memory in gigabytes (GB) on the DB node.

state String

The current lifecycle state of the external DB node.

timeCreated String

The date and time the external DB node was created.

timeUpdated String

The date and time the external DB node was last updated.

additionalDetails {[key: string]: any}

The additional details of the external DB node defined in {"key": "value"} format. Example: {"bar-key": "value"}

compartmentId string

The OCID of the compartment.

componentName string

The name of the external DB node.

cpuCoreCount number

The number of CPU cores available on the DB node.

displayName string

The user-friendly name for the external DB node. The name does not have to be unique.

externalDbSystemId string

The OCID of the external DB system that the DB node is a part of.

hostName string

The host name for the DB node.

id string

The provider-assigned unique ID for this managed resource.

lifecycleDetails string

Additional information about the current lifecycle state.

memorySizeInGbs number

The total memory in gigabytes (GB) on the DB node.

state string

The current lifecycle state of the external DB node.

timeCreated string

The date and time the external DB node was created.

timeUpdated string

The date and time the external DB node was last updated.

additional_details Mapping[str, Any]

The additional details of the external DB node 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 node.

cpu_core_count float

The number of CPU cores available on the DB node.

display_name str

The user-friendly name for the external DB node. The name does not have to be unique.

external_db_system_id str

The OCID of the external DB system that the DB node is a part of.

host_name str

The host name for the DB node.

id str

The provider-assigned unique ID for this managed resource.

lifecycle_details str

Additional information about the current lifecycle state.

memory_size_in_gbs float

The total memory in gigabytes (GB) on the DB node.

state str

The current lifecycle state of the external DB node.

time_created str

The date and time the external DB node was created.

time_updated str

The date and time the external DB node was last updated.

additionalDetails Map<Any>

The additional details of the external DB node defined in {"key": "value"} format. Example: {"bar-key": "value"}

compartmentId String

The OCID of the compartment.

componentName String

The name of the external DB node.

cpuCoreCount Number

The number of CPU cores available on the DB node.

displayName String

The user-friendly name for the external DB node. The name does not have to be unique.

externalDbSystemId String

The OCID of the external DB system that the DB node is a part of.

hostName String

The host name for the DB node.

id String

The provider-assigned unique ID for this managed resource.

lifecycleDetails String

Additional information about the current lifecycle state.

memorySizeInGbs Number

The total memory in gigabytes (GB) on the DB node.

state String

The current lifecycle state of the external DB node.

timeCreated String

The date and time the external DB node was created.

timeUpdated String

The date and time the external DB node was last updated.

Look up Existing ExternalDbNode Resource

Get an existing ExternalDbNode 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?: ExternalDbNodeState, opts?: CustomResourceOptions): ExternalDbNode
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        additional_details: Optional[Mapping[str, Any]] = None,
        compartment_id: Optional[str] = None,
        component_name: Optional[str] = None,
        cpu_core_count: Optional[float] = None,
        display_name: Optional[str] = None,
        external_connector_id: Optional[str] = None,
        external_db_node_id: Optional[str] = None,
        external_db_system_id: Optional[str] = None,
        host_name: Optional[str] = None,
        lifecycle_details: Optional[str] = None,
        memory_size_in_gbs: Optional[float] = None,
        state: Optional[str] = None,
        time_created: Optional[str] = None,
        time_updated: Optional[str] = None) -> ExternalDbNode
func GetExternalDbNode(ctx *Context, name string, id IDInput, state *ExternalDbNodeState, opts ...ResourceOption) (*ExternalDbNode, error)
public static ExternalDbNode Get(string name, Input<string> id, ExternalDbNodeState? state, CustomResourceOptions? opts = null)
public static ExternalDbNode get(String name, Output<String> id, ExternalDbNodeState 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:
AdditionalDetails Dictionary<string, object>

The additional details of the external DB node defined in {"key": "value"} format. Example: {"bar-key": "value"}

CompartmentId string

The OCID of the compartment.

ComponentName string

The name of the external DB node.

CpuCoreCount double

The number of CPU cores available on the DB node.

DisplayName string

The user-friendly name for the external DB node. The name does not have to be unique.

ExternalConnectorId string

(Updatable) The OCID of the external connector.

ExternalDbNodeId string

The OCID of the external database node.

ExternalDbSystemId string

The OCID of the external DB system that the DB node is a part of.

HostName string

The host name for the DB node.

LifecycleDetails string

Additional information about the current lifecycle state.

MemorySizeInGbs double

The total memory in gigabytes (GB) on the DB node.

State string

The current lifecycle state of the external DB node.

TimeCreated string

The date and time the external DB node was created.

TimeUpdated string

The date and time the external DB node was last updated.

AdditionalDetails map[string]interface{}

The additional details of the external DB node defined in {"key": "value"} format. Example: {"bar-key": "value"}

CompartmentId string

The OCID of the compartment.

ComponentName string

The name of the external DB node.

CpuCoreCount float64

The number of CPU cores available on the DB node.

DisplayName string

The user-friendly name for the external DB node. The name does not have to be unique.

ExternalConnectorId string

(Updatable) The OCID of the external connector.

ExternalDbNodeId string

The OCID of the external database node.

ExternalDbSystemId string

The OCID of the external DB system that the DB node is a part of.

HostName string

The host name for the DB node.

LifecycleDetails string

Additional information about the current lifecycle state.

MemorySizeInGbs float64

The total memory in gigabytes (GB) on the DB node.

State string

The current lifecycle state of the external DB node.

TimeCreated string

The date and time the external DB node was created.

TimeUpdated string

The date and time the external DB node was last updated.

additionalDetails Map<String,Object>

The additional details of the external DB node defined in {"key": "value"} format. Example: {"bar-key": "value"}

compartmentId String

The OCID of the compartment.

componentName String

The name of the external DB node.

cpuCoreCount Double

The number of CPU cores available on the DB node.

displayName String

The user-friendly name for the external DB node. The name does not have to be unique.

externalConnectorId String

(Updatable) The OCID of the external connector.

externalDbNodeId String

The OCID of the external database node.

externalDbSystemId String

The OCID of the external DB system that the DB node is a part of.

hostName String

The host name for the DB node.

lifecycleDetails String

Additional information about the current lifecycle state.

memorySizeInGbs Double

The total memory in gigabytes (GB) on the DB node.

state String

The current lifecycle state of the external DB node.

timeCreated String

The date and time the external DB node was created.

timeUpdated String

The date and time the external DB node was last updated.

additionalDetails {[key: string]: any}

The additional details of the external DB node defined in {"key": "value"} format. Example: {"bar-key": "value"}

compartmentId string

The OCID of the compartment.

componentName string

The name of the external DB node.

cpuCoreCount number

The number of CPU cores available on the DB node.

displayName string

The user-friendly name for the external DB node. The name does not have to be unique.

externalConnectorId string

(Updatable) The OCID of the external connector.

externalDbNodeId string

The OCID of the external database node.

externalDbSystemId string

The OCID of the external DB system that the DB node is a part of.

hostName string

The host name for the DB node.

lifecycleDetails string

Additional information about the current lifecycle state.

memorySizeInGbs number

The total memory in gigabytes (GB) on the DB node.

state string

The current lifecycle state of the external DB node.

timeCreated string

The date and time the external DB node was created.

timeUpdated string

The date and time the external DB node was last updated.

additional_details Mapping[str, Any]

The additional details of the external DB node 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 node.

cpu_core_count float

The number of CPU cores available on the DB node.

display_name str

The user-friendly name for the external DB node. The name does not have to be unique.

external_connector_id str

(Updatable) The OCID of the external connector.

external_db_node_id str

The OCID of the external database node.

external_db_system_id str

The OCID of the external DB system that the DB node is a part of.

host_name str

The host name for the DB node.

lifecycle_details str

Additional information about the current lifecycle state.

memory_size_in_gbs float

The total memory in gigabytes (GB) on the DB node.

state str

The current lifecycle state of the external DB node.

time_created str

The date and time the external DB node was created.

time_updated str

The date and time the external DB node was last updated.

additionalDetails Map<Any>

The additional details of the external DB node defined in {"key": "value"} format. Example: {"bar-key": "value"}

compartmentId String

The OCID of the compartment.

componentName String

The name of the external DB node.

cpuCoreCount Number

The number of CPU cores available on the DB node.

displayName String

The user-friendly name for the external DB node. The name does not have to be unique.

externalConnectorId String

(Updatable) The OCID of the external connector.

externalDbNodeId String

The OCID of the external database node.

externalDbSystemId String

The OCID of the external DB system that the DB node is a part of.

hostName String

The host name for the DB node.

lifecycleDetails String

Additional information about the current lifecycle state.

memorySizeInGbs Number

The total memory in gigabytes (GB) on the DB node.

state String

The current lifecycle state of the external DB node.

timeCreated String

The date and time the external DB node was created.

timeUpdated String

The date and time the external DB node was last updated.

Import

ExternalDbNodes can be imported using the id, e.g.

 $ pulumi import oci:DatabaseManagement/externalDbNode:ExternalDbNode test_external_db_node "id"

Package Details

Repository
oci pulumi/pulumi-oci
License
Apache-2.0
Notes

This Pulumi package is based on the oci Terraform Provider.