1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. DatabaseManagement
  5. ExternalDbNode
Oracle Cloud Infrastructure v1.27.0 published on Friday, Mar 15, 2024 by Pulumi

oci.DatabaseManagement.ExternalDbNode

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v1.27.0 published on Friday, Mar 15, 2024 by Pulumi

    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,
                       defined_tags: Optional[Mapping[str, Any]] = None,
                       external_connector_id: Optional[str] = None,
                       external_db_node_id: Optional[str] = None,
                       freeform_tags: Optional[Mapping[str, Any]] = 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.
    DefinedTags Dictionary<string, object>
    (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"}
    ExternalConnectorId string
    (Updatable) The OCID of the external connector.
    FreeformTags Dictionary<string, object>

    (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

    ExternalDbNodeId string
    The OCID of the external database node.
    DefinedTags map[string]interface{}
    (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"}
    ExternalConnectorId string
    (Updatable) The OCID of the external connector.
    FreeformTags map[string]interface{}

    (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

    externalDbNodeId String
    The OCID of the external database node.
    definedTags Map<String,Object>
    (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"}
    externalConnectorId String
    (Updatable) The OCID of the external connector.
    freeformTags Map<String,Object>

    (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

    externalDbNodeId string
    The OCID of the external database node.
    definedTags {[key: string]: any}
    (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"}
    externalConnectorId string
    (Updatable) The OCID of the external connector.
    freeformTags {[key: string]: any}

    (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_node_id str
    The OCID of the external database node.
    defined_tags Mapping[str, Any]
    (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"}
    external_connector_id str
    (Updatable) The OCID of the external connector.
    freeform_tags Mapping[str, Any]

    (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

    externalDbNodeId String
    The OCID of the external database node.
    definedTags Map<Any>
    (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"}
    externalConnectorId String
    (Updatable) The OCID of the external connector.
    freeformTags Map<Any>

    (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 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.
    DomainName string
    Name of the domain.
    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.
    DomainName string
    Name of the domain.
    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.
    domainName String
    Name of the domain.
    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.
    domainName string
    Name of the domain.
    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.
    domain_name str
    Name of the domain.
    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.
    domainName String
    Name of the domain.
    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,
            defined_tags: Optional[Mapping[str, Any]] = None,
            display_name: Optional[str] = None,
            domain_name: Optional[str] = None,
            external_connector_id: Optional[str] = None,
            external_db_node_id: Optional[str] = None,
            external_db_system_id: Optional[str] = None,
            freeform_tags: Optional[Mapping[str, Any]] = 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.
    DefinedTags Dictionary<string, object>
    (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 node. The name does not have to be unique.
    DomainName string
    Name of the domain.
    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.
    FreeformTags Dictionary<string, object>

    (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

    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.
    DefinedTags map[string]interface{}
    (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 node. The name does not have to be unique.
    DomainName string
    Name of the domain.
    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.
    FreeformTags map[string]interface{}

    (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

    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.
    definedTags Map<String,Object>
    (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 node. The name does not have to be unique.
    domainName String
    Name of the domain.
    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.
    freeformTags Map<String,Object>

    (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

    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.
    definedTags {[key: string]: any}
    (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 node. The name does not have to be unique.
    domainName string
    Name of the domain.
    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.
    freeformTags {[key: string]: any}

    (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

    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.
    defined_tags Mapping[str, Any]
    (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 node. The name does not have to be unique.
    domain_name str
    Name of the domain.
    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.
    freeform_tags Mapping[str, Any]

    (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

    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.
    definedTags Map<Any>
    (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 node. The name does not have to be unique.
    domainName String
    Name of the domain.
    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.
    freeformTags Map<Any>

    (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

    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.
    oci logo
    Oracle Cloud Infrastructure v1.27.0 published on Friday, Mar 15, 2024 by Pulumi