Oracle Cloud Infrastructure v0.13.0, Mar 28 23

oci.DatabaseManagement.ExternalClusterInstance

This resource provides the External Cluster Instance resource in Oracle Cloud Infrastructure Database Management service.

Updates the external cluster instance specified by externalClusterInstanceId.

Create ExternalClusterInstance Resource

new ExternalClusterInstance(name: string, args: ExternalClusterInstanceArgs, opts?: CustomResourceOptions);

@overload
def ExternalClusterInstance(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            external_cluster_instance_id: Optional[str] = None,
                            external_connector_id: Optional[str] = None)
@overload
def ExternalClusterInstance(resource_name: str,
                            args: ExternalClusterInstanceArgs,
                            opts: Optional[ResourceOptions] = None)

func NewExternalClusterInstance(ctx *Context, name string, args ExternalClusterInstanceArgs, opts ...ResourceOption) (*ExternalClusterInstance, error)

public ExternalClusterInstance(string name, ExternalClusterInstanceArgs args, CustomResourceOptions? opts = null)

public ExternalClusterInstance(String name, ExternalClusterInstanceArgs args)
public ExternalClusterInstance(String name, ExternalClusterInstanceArgs args, CustomResourceOptions options)

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

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

name string: The unique name of the resource.
args ExternalClusterInstanceArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args ExternalClusterInstanceArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

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

ExternalClusterInstanceId string: The OCID of the external cluster instance.
ExternalConnectorId string: (Updatable) The OCID of the external connector.

ExternalClusterInstanceId string: The OCID of the external cluster instance.
ExternalConnectorId string: (Updatable) The OCID of the external connector.

externalClusterInstanceId String: The OCID of the external cluster instance.
externalConnectorId String: (Updatable) The OCID of the external connector.

externalClusterInstanceId string: The OCID of the external cluster instance.
externalConnectorId string: (Updatable) The OCID of the external connector.

external_cluster_instance_id str: The OCID of the external cluster instance.
external_connector_id str: (Updatable) The OCID of the external connector.

externalClusterInstanceId String: The OCID of the external cluster instance.
externalConnectorId String: (Updatable) The OCID of the external connector.

Outputs

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

AdrHomeDirectory string: The Automatic Diagnostic Repository (ADR) home directory for the cluster instance.
CompartmentId string: The OCID of the compartment.
ComponentName string: The name of the external cluster instance.
CrsBaseDirectory string: The Oracle base location of Cluster Ready Services (CRS).
DisplayName string: The user-friendly name for the cluster instance. The name does not have to be unique.
ExternalClusterId string: The OCID of the external cluster that the cluster instance belongs to.
ExternalDbNodeId string: The OCID of the external DB node.
ExternalDbSystemId string: The OCID of the external DB system that the cluster instance is a part of.
HostName string: The name of the host on which the cluster instance is running.
Id string: The provider-assigned unique ID for this managed resource.
LifecycleDetails string: Additional information about the current lifecycle state.
NodeRole string: The role of the cluster node.
State string: The current lifecycle state of the external cluster instance.
TimeCreated string: The date and time the external cluster instance was created.
TimeUpdated string: The date and time the external cluster instance was last updated.

AdrHomeDirectory string: The Automatic Diagnostic Repository (ADR) home directory for the cluster instance.
CompartmentId string: The OCID of the compartment.
ComponentName string: The name of the external cluster instance.
CrsBaseDirectory string: The Oracle base location of Cluster Ready Services (CRS).
DisplayName string: The user-friendly name for the cluster instance. The name does not have to be unique.
ExternalClusterId string: The OCID of the external cluster that the cluster instance belongs to.
ExternalDbNodeId string: The OCID of the external DB node.
ExternalDbSystemId string: The OCID of the external DB system that the cluster instance is a part of.
HostName string: The name of the host on which the cluster instance is running.
Id string: The provider-assigned unique ID for this managed resource.
LifecycleDetails string: Additional information about the current lifecycle state.
NodeRole string: The role of the cluster node.
State string: The current lifecycle state of the external cluster instance.
TimeCreated string: The date and time the external cluster instance was created.
TimeUpdated string: The date and time the external cluster instance was last updated.

adrHomeDirectory String: The Automatic Diagnostic Repository (ADR) home directory for the cluster instance.
compartmentId String: The OCID of the compartment.
componentName String: The name of the external cluster instance.
crsBaseDirectory String: The Oracle base location of Cluster Ready Services (CRS).
displayName String: The user-friendly name for the cluster instance. The name does not have to be unique.
externalClusterId String: The OCID of the external cluster that the cluster instance belongs to.
externalDbNodeId String: The OCID of the external DB node.
externalDbSystemId String: The OCID of the external DB system that the cluster instance is a part of.
hostName String: The name of the host on which the cluster instance is running.
id String: The provider-assigned unique ID for this managed resource.
lifecycleDetails String: Additional information about the current lifecycle state.
nodeRole String: The role of the cluster node.
state String: The current lifecycle state of the external cluster instance.
timeCreated String: The date and time the external cluster instance was created.
timeUpdated String: The date and time the external cluster instance was last updated.

adrHomeDirectory string: The Automatic Diagnostic Repository (ADR) home directory for the cluster instance.
compartmentId string: The OCID of the compartment.
componentName string: The name of the external cluster instance.
crsBaseDirectory string: The Oracle base location of Cluster Ready Services (CRS).
displayName string: The user-friendly name for the cluster instance. The name does not have to be unique.
externalClusterId string: The OCID of the external cluster that the cluster instance belongs to.
externalDbNodeId string: The OCID of the external DB node.
externalDbSystemId string: The OCID of the external DB system that the cluster instance is a part of.
hostName string: The name of the host on which the cluster instance is running.
id string: The provider-assigned unique ID for this managed resource.
lifecycleDetails string: Additional information about the current lifecycle state.
nodeRole string: The role of the cluster node.
state string: The current lifecycle state of the external cluster instance.
timeCreated string: The date and time the external cluster instance was created.
timeUpdated string: The date and time the external cluster instance was last updated.

adr_home_directory str: The Automatic Diagnostic Repository (ADR) home directory for the cluster instance.
compartment_id str: The OCID of the compartment.
component_name str: The name of the external cluster instance.
crs_base_directory str: The Oracle base location of Cluster Ready Services (CRS).
display_name str: The user-friendly name for the cluster instance. The name does not have to be unique.
external_cluster_id str: The OCID of the external cluster that the cluster instance belongs to.
external_db_node_id str: The OCID of the external DB node.
external_db_system_id str: The OCID of the external DB system that the cluster instance is a part of.
host_name str: The name of the host on which the cluster instance is running.
id str: The provider-assigned unique ID for this managed resource.
lifecycle_details str: Additional information about the current lifecycle state.
node_role str: The role of the cluster node.
state str: The current lifecycle state of the external cluster instance.
time_created str: The date and time the external cluster instance was created.
time_updated str: The date and time the external cluster instance was last updated.

adrHomeDirectory String: The Automatic Diagnostic Repository (ADR) home directory for the cluster instance.
compartmentId String: The OCID of the compartment.
componentName String: The name of the external cluster instance.
crsBaseDirectory String: The Oracle base location of Cluster Ready Services (CRS).
displayName String: The user-friendly name for the cluster instance. The name does not have to be unique.
externalClusterId String: The OCID of the external cluster that the cluster instance belongs to.
externalDbNodeId String: The OCID of the external DB node.
externalDbSystemId String: The OCID of the external DB system that the cluster instance is a part of.
hostName String: The name of the host on which the cluster instance is running.
id String: The provider-assigned unique ID for this managed resource.
lifecycleDetails String: Additional information about the current lifecycle state.
nodeRole String: The role of the cluster node.
state String: The current lifecycle state of the external cluster instance.
timeCreated String: The date and time the external cluster instance was created.
timeUpdated String: The date and time the external cluster instance was last updated.

Look up Existing ExternalClusterInstance Resource

Get an existing ExternalClusterInstance 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?: ExternalClusterInstanceState, opts?: CustomResourceOptions): ExternalClusterInstance

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        adr_home_directory: Optional[str] = None,
        compartment_id: Optional[str] = None,
        component_name: Optional[str] = None,
        crs_base_directory: Optional[str] = None,
        display_name: Optional[str] = None,
        external_cluster_id: Optional[str] = None,
        external_cluster_instance_id: 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,
        node_role: Optional[str] = None,
        state: Optional[str] = None,
        time_created: Optional[str] = None,
        time_updated: Optional[str] = None) -> ExternalClusterInstance

func GetExternalClusterInstance(ctx *Context, name string, id IDInput, state *ExternalClusterInstanceState, opts ...ResourceOption) (*ExternalClusterInstance, error)

public static ExternalClusterInstance Get(string name, Input<string> id, ExternalClusterInstanceState? state, CustomResourceOptions? opts = null)

public static ExternalClusterInstance get(String name, Output<String> id, ExternalClusterInstanceState 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:

AdrHomeDirectory string: The Automatic Diagnostic Repository (ADR) home directory for the cluster instance.
CompartmentId string: The OCID of the compartment.
ComponentName string: The name of the external cluster instance.
CrsBaseDirectory string: The Oracle base location of Cluster Ready Services (CRS).
DisplayName string: The user-friendly name for the cluster instance. The name does not have to be unique.
ExternalClusterId string: The OCID of the external cluster that the cluster instance belongs to.
ExternalClusterInstanceId string: The OCID of the external cluster instance.
ExternalConnectorId string: (Updatable) The OCID of the external connector.
ExternalDbNodeId string: The OCID of the external DB node.
ExternalDbSystemId string: The OCID of the external DB system that the cluster instance is a part of.
HostName string: The name of the host on which the cluster instance is running.
LifecycleDetails string: Additional information about the current lifecycle state.
NodeRole string: The role of the cluster node.
State string: The current lifecycle state of the external cluster instance.
TimeCreated string: The date and time the external cluster instance was created.
TimeUpdated string: The date and time the external cluster instance was last updated.

AdrHomeDirectory string: The Automatic Diagnostic Repository (ADR) home directory for the cluster instance.
CompartmentId string: The OCID of the compartment.
ComponentName string: The name of the external cluster instance.
CrsBaseDirectory string: The Oracle base location of Cluster Ready Services (CRS).
DisplayName string: The user-friendly name for the cluster instance. The name does not have to be unique.
ExternalClusterId string: The OCID of the external cluster that the cluster instance belongs to.
ExternalClusterInstanceId string: The OCID of the external cluster instance.
ExternalConnectorId string: (Updatable) The OCID of the external connector.
ExternalDbNodeId string: The OCID of the external DB node.
ExternalDbSystemId string: The OCID of the external DB system that the cluster instance is a part of.
HostName string: The name of the host on which the cluster instance is running.
LifecycleDetails string: Additional information about the current lifecycle state.
NodeRole string: The role of the cluster node.
State string: The current lifecycle state of the external cluster instance.
TimeCreated string: The date and time the external cluster instance was created.
TimeUpdated string: The date and time the external cluster instance was last updated.

adrHomeDirectory String: The Automatic Diagnostic Repository (ADR) home directory for the cluster instance.
compartmentId String: The OCID of the compartment.
componentName String: The name of the external cluster instance.
crsBaseDirectory String: The Oracle base location of Cluster Ready Services (CRS).
displayName String: The user-friendly name for the cluster instance. The name does not have to be unique.
externalClusterId String: The OCID of the external cluster that the cluster instance belongs to.
externalClusterInstanceId String: The OCID of the external cluster instance.
externalConnectorId String: (Updatable) The OCID of the external connector.
externalDbNodeId String: The OCID of the external DB node.
externalDbSystemId String: The OCID of the external DB system that the cluster instance is a part of.
hostName String: The name of the host on which the cluster instance is running.
lifecycleDetails String: Additional information about the current lifecycle state.
nodeRole String: The role of the cluster node.
state String: The current lifecycle state of the external cluster instance.
timeCreated String: The date and time the external cluster instance was created.
timeUpdated String: The date and time the external cluster instance was last updated.

adrHomeDirectory string: The Automatic Diagnostic Repository (ADR) home directory for the cluster instance.
compartmentId string: The OCID of the compartment.
componentName string: The name of the external cluster instance.
crsBaseDirectory string: The Oracle base location of Cluster Ready Services (CRS).
displayName string: The user-friendly name for the cluster instance. The name does not have to be unique.
externalClusterId string: The OCID of the external cluster that the cluster instance belongs to.
externalClusterInstanceId string: The OCID of the external cluster instance.
externalConnectorId string: (Updatable) The OCID of the external connector.
externalDbNodeId string: The OCID of the external DB node.
externalDbSystemId string: The OCID of the external DB system that the cluster instance is a part of.
hostName string: The name of the host on which the cluster instance is running.
lifecycleDetails string: Additional information about the current lifecycle state.
nodeRole string: The role of the cluster node.
state string: The current lifecycle state of the external cluster instance.
timeCreated string: The date and time the external cluster instance was created.
timeUpdated string: The date and time the external cluster instance was last updated.

adr_home_directory str: The Automatic Diagnostic Repository (ADR) home directory for the cluster instance.
compartment_id str: The OCID of the compartment.
component_name str: The name of the external cluster instance.
crs_base_directory str: The Oracle base location of Cluster Ready Services (CRS).
display_name str: The user-friendly name for the cluster instance. The name does not have to be unique.
external_cluster_id str: The OCID of the external cluster that the cluster instance belongs to.
external_cluster_instance_id str: The OCID of the external cluster instance.
external_connector_id str: (Updatable) The OCID of the external connector.
external_db_node_id str: The OCID of the external DB node.
external_db_system_id str: The OCID of the external DB system that the cluster instance is a part of.
host_name str: The name of the host on which the cluster instance is running.
lifecycle_details str: Additional information about the current lifecycle state.
node_role str: The role of the cluster node.
state str: The current lifecycle state of the external cluster instance.
time_created str: The date and time the external cluster instance was created.
time_updated str: The date and time the external cluster instance was last updated.

adrHomeDirectory String: The Automatic Diagnostic Repository (ADR) home directory for the cluster instance.
compartmentId String: The OCID of the compartment.
componentName String: The name of the external cluster instance.
crsBaseDirectory String: The Oracle base location of Cluster Ready Services (CRS).
displayName String: The user-friendly name for the cluster instance. The name does not have to be unique.
externalClusterId String: The OCID of the external cluster that the cluster instance belongs to.
externalClusterInstanceId String: The OCID of the external cluster instance.
externalConnectorId String: (Updatable) The OCID of the external connector.
externalDbNodeId String: The OCID of the external DB node.
externalDbSystemId String: The OCID of the external DB system that the cluster instance is a part of.
hostName String: The name of the host on which the cluster instance is running.
lifecycleDetails String: Additional information about the current lifecycle state.
nodeRole String: The role of the cluster node.
state String: The current lifecycle state of the external cluster instance.
timeCreated String: The date and time the external cluster instance was created.
timeUpdated String: The date and time the external cluster instance was last updated.

Import

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

 $ pulumi import oci:DatabaseManagement/externalClusterInstance:ExternalClusterInstance test_external_cluster_instance "id"

Package Details

Repository: oci pulumi/pulumi-oci
License: Apache-2.0
Notes: This Pulumi package is based on the oci Terraform Provider.