1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. DatabaseManagement
  5. ExternalCluster
Oracle Cloud Infrastructure v1.40.0 published on Wednesday, Jun 12, 2024 by Pulumi

oci.DatabaseManagement.ExternalCluster

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v1.40.0 published on Wednesday, Jun 12, 2024 by Pulumi

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

    Updates the external cluster specified by externalClusterId.

    Create ExternalCluster Resource

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

    Constructor syntax

    new ExternalCluster(name: string, args: ExternalClusterArgs, opts?: CustomResourceOptions);
    @overload
    def ExternalCluster(resource_name: str,
                        args: ExternalClusterArgs,
                        opts: Optional[ResourceOptions] = None)
    
    @overload
    def ExternalCluster(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        external_cluster_id: Optional[str] = None,
                        defined_tags: Optional[Mapping[str, Any]] = None,
                        external_connector_id: Optional[str] = None,
                        freeform_tags: Optional[Mapping[str, Any]] = None)
    func NewExternalCluster(ctx *Context, name string, args ExternalClusterArgs, opts ...ResourceOption) (*ExternalCluster, error)
    public ExternalCluster(string name, ExternalClusterArgs args, CustomResourceOptions? opts = null)
    public ExternalCluster(String name, ExternalClusterArgs args)
    public ExternalCluster(String name, ExternalClusterArgs args, CustomResourceOptions options)
    
    type: oci:DatabaseManagement:ExternalCluster
    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 ExternalClusterArgs
    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 ExternalClusterArgs
    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 ExternalClusterArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ExternalClusterArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ExternalClusterArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

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

    var externalClusterResource = new Oci.DatabaseManagement.ExternalCluster("externalClusterResource", new()
    {
        ExternalClusterId = "string",
        DefinedTags = 
        {
            { "string", "any" },
        },
        ExternalConnectorId = "string",
        FreeformTags = 
        {
            { "string", "any" },
        },
    });
    
    example, err := DatabaseManagement.NewExternalCluster(ctx, "externalClusterResource", &DatabaseManagement.ExternalClusterArgs{
    	ExternalClusterId: pulumi.String("string"),
    	DefinedTags: pulumi.Map{
    		"string": pulumi.Any("any"),
    	},
    	ExternalConnectorId: pulumi.String("string"),
    	FreeformTags: pulumi.Map{
    		"string": pulumi.Any("any"),
    	},
    })
    
    var externalClusterResource = new ExternalCluster("externalClusterResource", ExternalClusterArgs.builder()
        .externalClusterId("string")
        .definedTags(Map.of("string", "any"))
        .externalConnectorId("string")
        .freeformTags(Map.of("string", "any"))
        .build());
    
    external_cluster_resource = oci.database_management.ExternalCluster("externalClusterResource",
        external_cluster_id="string",
        defined_tags={
            "string": "any",
        },
        external_connector_id="string",
        freeform_tags={
            "string": "any",
        })
    
    const externalClusterResource = new oci.databasemanagement.ExternalCluster("externalClusterResource", {
        externalClusterId: "string",
        definedTags: {
            string: "any",
        },
        externalConnectorId: "string",
        freeformTags: {
            string: "any",
        },
    });
    
    type: oci:DatabaseManagement:ExternalCluster
    properties:
        definedTags:
            string: any
        externalClusterId: string
        externalConnectorId: string
        freeformTags:
            string: any
    

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

    ExternalClusterId string
    The OCID of the external cluster.
    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

    ExternalClusterId string
    The OCID of the external cluster.
    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

    externalClusterId String
    The OCID of the external cluster.
    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

    externalClusterId string
    The OCID of the external cluster.
    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_cluster_id str
    The OCID of the external cluster.
    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

    externalClusterId String
    The OCID of the external cluster.
    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 ExternalCluster resource produces the following output properties:

    AdditionalDetails Dictionary<string, object>
    The additional details of the external cluster defined in {"key": "value"} format. Example: {"bar-key": "value"}
    CompartmentId string
    The OCID of the compartment.
    ComponentName string
    The name of the external cluster.
    DisplayName string
    The user-friendly name for the external cluster. The name does not have to be unique.
    ExternalDbSystemId string
    The OCID of the external DB system that the cluster is a part of.
    GridHome string
    The directory in which Oracle Grid Infrastructure is installed.
    Id string
    The provider-assigned unique ID for this managed resource.
    IsFlexCluster bool
    Indicates whether the cluster is Oracle Flex Cluster or not.
    LifecycleDetails string
    Additional information about the current lifecycle state.
    NetworkConfigurations List<ExternalClusterNetworkConfiguration>
    The list of network address configurations of the external cluster.
    OcrFileLocation string
    The location of the Oracle Cluster Registry (OCR).
    ScanConfigurations List<ExternalClusterScanConfiguration>
    The list of Single Client Access Name (SCAN) configurations of the external cluster.
    State string
    The current lifecycle state of the external cluster.
    SystemTags Dictionary<string, object>
    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 cluster was created.
    TimeUpdated string
    The date and time the external cluster was last updated.
    Version string
    The cluster version.
    VipConfigurations List<ExternalClusterVipConfiguration>
    The list of Virtual IP (VIP) configurations of the external cluster.
    AdditionalDetails map[string]interface{}
    The additional details of the external cluster defined in {"key": "value"} format. Example: {"bar-key": "value"}
    CompartmentId string
    The OCID of the compartment.
    ComponentName string
    The name of the external cluster.
    DisplayName string
    The user-friendly name for the external cluster. The name does not have to be unique.
    ExternalDbSystemId string
    The OCID of the external DB system that the cluster is a part of.
    GridHome string
    The directory in which Oracle Grid Infrastructure is installed.
    Id string
    The provider-assigned unique ID for this managed resource.
    IsFlexCluster bool
    Indicates whether the cluster is Oracle Flex Cluster or not.
    LifecycleDetails string
    Additional information about the current lifecycle state.
    NetworkConfigurations []ExternalClusterNetworkConfiguration
    The list of network address configurations of the external cluster.
    OcrFileLocation string
    The location of the Oracle Cluster Registry (OCR).
    ScanConfigurations []ExternalClusterScanConfiguration
    The list of Single Client Access Name (SCAN) configurations of the external cluster.
    State string
    The current lifecycle state of the external cluster.
    SystemTags map[string]interface{}
    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 cluster was created.
    TimeUpdated string
    The date and time the external cluster was last updated.
    Version string
    The cluster version.
    VipConfigurations []ExternalClusterVipConfiguration
    The list of Virtual IP (VIP) configurations of the external cluster.
    additionalDetails Map<String,Object>
    The additional details of the external cluster defined in {"key": "value"} format. Example: {"bar-key": "value"}
    compartmentId String
    The OCID of the compartment.
    componentName String
    The name of the external cluster.
    displayName String
    The user-friendly name for the external cluster. The name does not have to be unique.
    externalDbSystemId String
    The OCID of the external DB system that the cluster is a part of.
    gridHome String
    The directory in which Oracle Grid Infrastructure is installed.
    id String
    The provider-assigned unique ID for this managed resource.
    isFlexCluster Boolean
    Indicates whether the cluster is Oracle Flex Cluster or not.
    lifecycleDetails String
    Additional information about the current lifecycle state.
    networkConfigurations List<ExternalClusterNetworkConfiguration>
    The list of network address configurations of the external cluster.
    ocrFileLocation String
    The location of the Oracle Cluster Registry (OCR).
    scanConfigurations List<ExternalClusterScanConfiguration>
    The list of Single Client Access Name (SCAN) configurations of the external cluster.
    state String
    The current lifecycle state of the external cluster.
    systemTags Map<String,Object>
    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 cluster was created.
    timeUpdated String
    The date and time the external cluster was last updated.
    version String
    The cluster version.
    vipConfigurations List<ExternalClusterVipConfiguration>
    The list of Virtual IP (VIP) configurations of the external cluster.
    additionalDetails {[key: string]: any}
    The additional details of the external cluster defined in {"key": "value"} format. Example: {"bar-key": "value"}
    compartmentId string
    The OCID of the compartment.
    componentName string
    The name of the external cluster.
    displayName string
    The user-friendly name for the external cluster. The name does not have to be unique.
    externalDbSystemId string
    The OCID of the external DB system that the cluster is a part of.
    gridHome string
    The directory in which Oracle Grid Infrastructure is installed.
    id string
    The provider-assigned unique ID for this managed resource.
    isFlexCluster boolean
    Indicates whether the cluster is Oracle Flex Cluster or not.
    lifecycleDetails string
    Additional information about the current lifecycle state.
    networkConfigurations ExternalClusterNetworkConfiguration[]
    The list of network address configurations of the external cluster.
    ocrFileLocation string
    The location of the Oracle Cluster Registry (OCR).
    scanConfigurations ExternalClusterScanConfiguration[]
    The list of Single Client Access Name (SCAN) configurations of the external cluster.
    state string
    The current lifecycle state of the external cluster.
    systemTags {[key: string]: any}
    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 cluster was created.
    timeUpdated string
    The date and time the external cluster was last updated.
    version string
    The cluster version.
    vipConfigurations ExternalClusterVipConfiguration[]
    The list of Virtual IP (VIP) configurations of the external cluster.
    additional_details Mapping[str, Any]
    The additional details of the external cluster 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 cluster.
    display_name str
    The user-friendly name for the external cluster. The name does not have to be unique.
    external_db_system_id str
    The OCID of the external DB system that the cluster is a part of.
    grid_home str
    The directory in which Oracle Grid Infrastructure is installed.
    id str
    The provider-assigned unique ID for this managed resource.
    is_flex_cluster bool
    Indicates whether the cluster is Oracle Flex Cluster or not.
    lifecycle_details str
    Additional information about the current lifecycle state.
    network_configurations Sequence[databasemanagement.ExternalClusterNetworkConfiguration]
    The list of network address configurations of the external cluster.
    ocr_file_location str
    The location of the Oracle Cluster Registry (OCR).
    scan_configurations Sequence[databasemanagement.ExternalClusterScanConfiguration]
    The list of Single Client Access Name (SCAN) configurations of the external cluster.
    state str
    The current lifecycle state of the external cluster.
    system_tags Mapping[str, Any]
    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 cluster was created.
    time_updated str
    The date and time the external cluster was last updated.
    version str
    The cluster version.
    vip_configurations Sequence[databasemanagement.ExternalClusterVipConfiguration]
    The list of Virtual IP (VIP) configurations of the external cluster.
    additionalDetails Map<Any>
    The additional details of the external cluster defined in {"key": "value"} format. Example: {"bar-key": "value"}
    compartmentId String
    The OCID of the compartment.
    componentName String
    The name of the external cluster.
    displayName String
    The user-friendly name for the external cluster. The name does not have to be unique.
    externalDbSystemId String
    The OCID of the external DB system that the cluster is a part of.
    gridHome String
    The directory in which Oracle Grid Infrastructure is installed.
    id String
    The provider-assigned unique ID for this managed resource.
    isFlexCluster Boolean
    Indicates whether the cluster is Oracle Flex Cluster or not.
    lifecycleDetails String
    Additional information about the current lifecycle state.
    networkConfigurations List<Property Map>
    The list of network address configurations of the external cluster.
    ocrFileLocation String
    The location of the Oracle Cluster Registry (OCR).
    scanConfigurations List<Property Map>
    The list of Single Client Access Name (SCAN) configurations of the external cluster.
    state String
    The current lifecycle state of the external cluster.
    systemTags Map<Any>
    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 cluster was created.
    timeUpdated String
    The date and time the external cluster was last updated.
    version String
    The cluster version.
    vipConfigurations List<Property Map>
    The list of Virtual IP (VIP) configurations of the external cluster.

    Look up Existing ExternalCluster Resource

    Get an existing ExternalCluster 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?: ExternalClusterState, opts?: CustomResourceOptions): ExternalCluster
    @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,
            defined_tags: Optional[Mapping[str, Any]] = None,
            display_name: Optional[str] = None,
            external_cluster_id: Optional[str] = None,
            external_connector_id: Optional[str] = None,
            external_db_system_id: Optional[str] = None,
            freeform_tags: Optional[Mapping[str, Any]] = None,
            grid_home: Optional[str] = None,
            is_flex_cluster: Optional[bool] = None,
            lifecycle_details: Optional[str] = None,
            network_configurations: Optional[Sequence[_databasemanagement.ExternalClusterNetworkConfigurationArgs]] = None,
            ocr_file_location: Optional[str] = None,
            scan_configurations: Optional[Sequence[_databasemanagement.ExternalClusterScanConfigurationArgs]] = None,
            state: Optional[str] = None,
            system_tags: Optional[Mapping[str, Any]] = None,
            time_created: Optional[str] = None,
            time_updated: Optional[str] = None,
            version: Optional[str] = None,
            vip_configurations: Optional[Sequence[_databasemanagement.ExternalClusterVipConfigurationArgs]] = None) -> ExternalCluster
    func GetExternalCluster(ctx *Context, name string, id IDInput, state *ExternalClusterState, opts ...ResourceOption) (*ExternalCluster, error)
    public static ExternalCluster Get(string name, Input<string> id, ExternalClusterState? state, CustomResourceOptions? opts = null)
    public static ExternalCluster get(String name, Output<String> id, ExternalClusterState 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 cluster defined in {"key": "value"} format. Example: {"bar-key": "value"}
    CompartmentId string
    The OCID of the compartment.
    ComponentName string
    The name of the external cluster.
    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 cluster. The name does not have to be unique.
    ExternalClusterId string
    The OCID of the external cluster.
    ExternalConnectorId string
    (Updatable) The OCID of the external connector.
    ExternalDbSystemId string
    The OCID of the external DB system that the cluster 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

    GridHome string
    The directory in which Oracle Grid Infrastructure is installed.
    IsFlexCluster bool
    Indicates whether the cluster is Oracle Flex Cluster or not.
    LifecycleDetails string
    Additional information about the current lifecycle state.
    NetworkConfigurations List<ExternalClusterNetworkConfiguration>
    The list of network address configurations of the external cluster.
    OcrFileLocation string
    The location of the Oracle Cluster Registry (OCR).
    ScanConfigurations List<ExternalClusterScanConfiguration>
    The list of Single Client Access Name (SCAN) configurations of the external cluster.
    State string
    The current lifecycle state of the external cluster.
    SystemTags Dictionary<string, object>
    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 cluster was created.
    TimeUpdated string
    The date and time the external cluster was last updated.
    Version string
    The cluster version.
    VipConfigurations List<ExternalClusterVipConfiguration>
    The list of Virtual IP (VIP) configurations of the external cluster.
    AdditionalDetails map[string]interface{}
    The additional details of the external cluster defined in {"key": "value"} format. Example: {"bar-key": "value"}
    CompartmentId string
    The OCID of the compartment.
    ComponentName string
    The name of the external cluster.
    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 cluster. The name does not have to be unique.
    ExternalClusterId string
    The OCID of the external cluster.
    ExternalConnectorId string
    (Updatable) The OCID of the external connector.
    ExternalDbSystemId string
    The OCID of the external DB system that the cluster 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

    GridHome string
    The directory in which Oracle Grid Infrastructure is installed.
    IsFlexCluster bool
    Indicates whether the cluster is Oracle Flex Cluster or not.
    LifecycleDetails string
    Additional information about the current lifecycle state.
    NetworkConfigurations []ExternalClusterNetworkConfigurationArgs
    The list of network address configurations of the external cluster.
    OcrFileLocation string
    The location of the Oracle Cluster Registry (OCR).
    ScanConfigurations []ExternalClusterScanConfigurationArgs
    The list of Single Client Access Name (SCAN) configurations of the external cluster.
    State string
    The current lifecycle state of the external cluster.
    SystemTags map[string]interface{}
    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 cluster was created.
    TimeUpdated string
    The date and time the external cluster was last updated.
    Version string
    The cluster version.
    VipConfigurations []ExternalClusterVipConfigurationArgs
    The list of Virtual IP (VIP) configurations of the external cluster.
    additionalDetails Map<String,Object>
    The additional details of the external cluster defined in {"key": "value"} format. Example: {"bar-key": "value"}
    compartmentId String
    The OCID of the compartment.
    componentName String
    The name of the external cluster.
    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 cluster. The name does not have to be unique.
    externalClusterId String
    The OCID of the external cluster.
    externalConnectorId String
    (Updatable) The OCID of the external connector.
    externalDbSystemId String
    The OCID of the external DB system that the cluster 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

    gridHome String
    The directory in which Oracle Grid Infrastructure is installed.
    isFlexCluster Boolean
    Indicates whether the cluster is Oracle Flex Cluster or not.
    lifecycleDetails String
    Additional information about the current lifecycle state.
    networkConfigurations List<ExternalClusterNetworkConfiguration>
    The list of network address configurations of the external cluster.
    ocrFileLocation String
    The location of the Oracle Cluster Registry (OCR).
    scanConfigurations List<ExternalClusterScanConfiguration>
    The list of Single Client Access Name (SCAN) configurations of the external cluster.
    state String
    The current lifecycle state of the external cluster.
    systemTags Map<String,Object>
    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 cluster was created.
    timeUpdated String
    The date and time the external cluster was last updated.
    version String
    The cluster version.
    vipConfigurations List<ExternalClusterVipConfiguration>
    The list of Virtual IP (VIP) configurations of the external cluster.
    additionalDetails {[key: string]: any}
    The additional details of the external cluster defined in {"key": "value"} format. Example: {"bar-key": "value"}
    compartmentId string
    The OCID of the compartment.
    componentName string
    The name of the external cluster.
    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 cluster. The name does not have to be unique.
    externalClusterId string
    The OCID of the external cluster.
    externalConnectorId string
    (Updatable) The OCID of the external connector.
    externalDbSystemId string
    The OCID of the external DB system that the cluster 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

    gridHome string
    The directory in which Oracle Grid Infrastructure is installed.
    isFlexCluster boolean
    Indicates whether the cluster is Oracle Flex Cluster or not.
    lifecycleDetails string
    Additional information about the current lifecycle state.
    networkConfigurations ExternalClusterNetworkConfiguration[]
    The list of network address configurations of the external cluster.
    ocrFileLocation string
    The location of the Oracle Cluster Registry (OCR).
    scanConfigurations ExternalClusterScanConfiguration[]
    The list of Single Client Access Name (SCAN) configurations of the external cluster.
    state string
    The current lifecycle state of the external cluster.
    systemTags {[key: string]: any}
    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 cluster was created.
    timeUpdated string
    The date and time the external cluster was last updated.
    version string
    The cluster version.
    vipConfigurations ExternalClusterVipConfiguration[]
    The list of Virtual IP (VIP) configurations of the external cluster.
    additional_details Mapping[str, Any]
    The additional details of the external cluster 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 cluster.
    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 cluster. The name does not have to be unique.
    external_cluster_id str
    The OCID of the external cluster.
    external_connector_id str
    (Updatable) The OCID of the external connector.
    external_db_system_id str
    The OCID of the external DB system that the cluster 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

    grid_home str
    The directory in which Oracle Grid Infrastructure is installed.
    is_flex_cluster bool
    Indicates whether the cluster is Oracle Flex Cluster or not.
    lifecycle_details str
    Additional information about the current lifecycle state.
    network_configurations Sequence[databasemanagement.ExternalClusterNetworkConfigurationArgs]
    The list of network address configurations of the external cluster.
    ocr_file_location str
    The location of the Oracle Cluster Registry (OCR).
    scan_configurations Sequence[databasemanagement.ExternalClusterScanConfigurationArgs]
    The list of Single Client Access Name (SCAN) configurations of the external cluster.
    state str
    The current lifecycle state of the external cluster.
    system_tags Mapping[str, Any]
    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 cluster was created.
    time_updated str
    The date and time the external cluster was last updated.
    version str
    The cluster version.
    vip_configurations Sequence[databasemanagement.ExternalClusterVipConfigurationArgs]
    The list of Virtual IP (VIP) configurations of the external cluster.
    additionalDetails Map<Any>
    The additional details of the external cluster defined in {"key": "value"} format. Example: {"bar-key": "value"}
    compartmentId String
    The OCID of the compartment.
    componentName String
    The name of the external cluster.
    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 cluster. The name does not have to be unique.
    externalClusterId String
    The OCID of the external cluster.
    externalConnectorId String
    (Updatable) The OCID of the external connector.
    externalDbSystemId String
    The OCID of the external DB system that the cluster 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

    gridHome String
    The directory in which Oracle Grid Infrastructure is installed.
    isFlexCluster Boolean
    Indicates whether the cluster is Oracle Flex Cluster or not.
    lifecycleDetails String
    Additional information about the current lifecycle state.
    networkConfigurations List<Property Map>
    The list of network address configurations of the external cluster.
    ocrFileLocation String
    The location of the Oracle Cluster Registry (OCR).
    scanConfigurations List<Property Map>
    The list of Single Client Access Name (SCAN) configurations of the external cluster.
    state String
    The current lifecycle state of the external cluster.
    systemTags Map<Any>
    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 cluster was created.
    timeUpdated String
    The date and time the external cluster was last updated.
    version String
    The cluster version.
    vipConfigurations List<Property Map>
    The list of Virtual IP (VIP) configurations of the external cluster.

    Supporting Types

    ExternalClusterNetworkConfiguration, ExternalClusterNetworkConfigurationArgs

    NetworkNumber int
    The network number from which VIPs are obtained.
    NetworkType string
    The network type.
    Subnet string
    The subnet for the network.
    NetworkNumber int
    The network number from which VIPs are obtained.
    NetworkType string
    The network type.
    Subnet string
    The subnet for the network.
    networkNumber Integer
    The network number from which VIPs are obtained.
    networkType String
    The network type.
    subnet String
    The subnet for the network.
    networkNumber number
    The network number from which VIPs are obtained.
    networkType string
    The network type.
    subnet string
    The subnet for the network.
    network_number int
    The network number from which VIPs are obtained.
    network_type str
    The network type.
    subnet str
    The subnet for the network.
    networkNumber Number
    The network number from which VIPs are obtained.
    networkType String
    The network type.
    subnet String
    The subnet for the network.

    ExternalClusterScanConfiguration, ExternalClusterScanConfigurationArgs

    NetworkNumber int
    The network number from which VIPs are obtained.
    ScanName string
    The name of the SCAN listener.
    ScanPort int
    The port number of the SCAN listener.
    ScanProtocol string
    The protocol of the SCAN listener.
    NetworkNumber int
    The network number from which VIPs are obtained.
    ScanName string
    The name of the SCAN listener.
    ScanPort int
    The port number of the SCAN listener.
    ScanProtocol string
    The protocol of the SCAN listener.
    networkNumber Integer
    The network number from which VIPs are obtained.
    scanName String
    The name of the SCAN listener.
    scanPort Integer
    The port number of the SCAN listener.
    scanProtocol String
    The protocol of the SCAN listener.
    networkNumber number
    The network number from which VIPs are obtained.
    scanName string
    The name of the SCAN listener.
    scanPort number
    The port number of the SCAN listener.
    scanProtocol string
    The protocol of the SCAN listener.
    network_number int
    The network number from which VIPs are obtained.
    scan_name str
    The name of the SCAN listener.
    scan_port int
    The port number of the SCAN listener.
    scan_protocol str
    The protocol of the SCAN listener.
    networkNumber Number
    The network number from which VIPs are obtained.
    scanName String
    The name of the SCAN listener.
    scanPort Number
    The port number of the SCAN listener.
    scanProtocol String
    The protocol of the SCAN listener.

    ExternalClusterVipConfiguration, ExternalClusterVipConfigurationArgs

    Address string
    The VIP name or IP address.
    NetworkNumber int
    The network number from which VIPs are obtained.
    NodeName string
    The name of the node with the VIP.
    Address string
    The VIP name or IP address.
    NetworkNumber int
    The network number from which VIPs are obtained.
    NodeName string
    The name of the node with the VIP.
    address String
    The VIP name or IP address.
    networkNumber Integer
    The network number from which VIPs are obtained.
    nodeName String
    The name of the node with the VIP.
    address string
    The VIP name or IP address.
    networkNumber number
    The network number from which VIPs are obtained.
    nodeName string
    The name of the node with the VIP.
    address str
    The VIP name or IP address.
    network_number int
    The network number from which VIPs are obtained.
    node_name str
    The name of the node with the VIP.
    address String
    The VIP name or IP address.
    networkNumber Number
    The network number from which VIPs are obtained.
    nodeName String
    The name of the node with the VIP.

    Import

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

    $ pulumi import oci:DatabaseManagement/externalCluster:ExternalCluster test_external_cluster "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 oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v1.40.0 published on Wednesday, Jun 12, 2024 by Pulumi