Oracle Cloud Infrastructure v0.13.0, Mar 28 23

oci.DatabaseManagement.ExternalAsm

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

Updates the external ASM specified by externalAsmId.

Create ExternalAsm Resource

new ExternalAsm(name: string, args: ExternalAsmArgs, opts?: CustomResourceOptions);

@overload
def ExternalAsm(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                external_asm_id: Optional[str] = None,
                external_connector_id: Optional[str] = None)
@overload
def ExternalAsm(resource_name: str,
                args: ExternalAsmArgs,
                opts: Optional[ResourceOptions] = None)

func NewExternalAsm(ctx *Context, name string, args ExternalAsmArgs, opts ...ResourceOption) (*ExternalAsm, error)

public ExternalAsm(string name, ExternalAsmArgs args, CustomResourceOptions? opts = null)

public ExternalAsm(String name, ExternalAsmArgs args)
public ExternalAsm(String name, ExternalAsmArgs args, CustomResourceOptions options)

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

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

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

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

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

ExternalAsmId string: The OCID of the external ASM.
ExternalConnectorId string: (Updatable) The OCID of the external connector.

ExternalAsmId string: The OCID of the external ASM.
ExternalConnectorId string: (Updatable) The OCID of the external connector.

externalAsmId String: The OCID of the external ASM.
externalConnectorId String: (Updatable) The OCID of the external connector.

externalAsmId string: The OCID of the external ASM.
externalConnectorId string: (Updatable) The OCID of the external connector.

external_asm_id str: The OCID of the external ASM.
external_connector_id str: (Updatable) The OCID of the external connector.

externalAsmId String: The OCID of the external ASM.
externalConnectorId String: (Updatable) The OCID of the external connector.

Outputs

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

AdditionalDetails Dictionary<string, object>: The additional details of the external ASM defined in {"key": "value"} format. Example: {"bar-key": "value"}
CompartmentId string: The OCID of the compartment in which the external database resides.
ComponentName string: The name of the external ASM.
DisplayName string: The user-friendly name for the database. The name does not have to be unique.
ExternalDbSystemId string: The OCID of the external DB system that the ASM is a part of.
GridHome string: The directory in which ASM is installed. This is the same directory in which Oracle Grid Infrastructure is installed.
Id string: The provider-assigned unique ID for this managed resource.
IsCluster bool: Indicates whether the ASM is a cluster ASM or not.
IsFlexEnabled bool: Indicates whether Oracle Flex ASM is enabled or not.
LifecycleDetails string: Additional information about the current lifecycle state.
ServicedDatabases List<ExternalAsmServicedDatabase>: The list of databases that are serviced by the ASM.
State string: The current lifecycle state of the external ASM.
TimeCreated string: The date and time the external ASM was created.
TimeUpdated string: The date and time the external ASM was last updated.
Version string: The ASM version.

AdditionalDetails map[string]interface{}: The additional details of the external ASM defined in {"key": "value"} format. Example: {"bar-key": "value"}
CompartmentId string: The OCID of the compartment in which the external database resides.
ComponentName string: The name of the external ASM.
DisplayName string: The user-friendly name for the database. The name does not have to be unique.
ExternalDbSystemId string: The OCID of the external DB system that the ASM is a part of.
GridHome string: The directory in which ASM is installed. This is the same directory in which Oracle Grid Infrastructure is installed.
Id string: The provider-assigned unique ID for this managed resource.
IsCluster bool: Indicates whether the ASM is a cluster ASM or not.
IsFlexEnabled bool: Indicates whether Oracle Flex ASM is enabled or not.
LifecycleDetails string: Additional information about the current lifecycle state.
ServicedDatabases []ExternalAsmServicedDatabase: The list of databases that are serviced by the ASM.
State string: The current lifecycle state of the external ASM.
TimeCreated string: The date and time the external ASM was created.
TimeUpdated string: The date and time the external ASM was last updated.
Version string: The ASM version.

additionalDetails Map<String,Object>: The additional details of the external ASM defined in {"key": "value"} format. Example: {"bar-key": "value"}
compartmentId String: The OCID of the compartment in which the external database resides.
componentName String: The name of the external ASM.
displayName String: The user-friendly name for the database. The name does not have to be unique.
externalDbSystemId String: The OCID of the external DB system that the ASM is a part of.
gridHome String: The directory in which ASM is installed. This is the same directory in which Oracle Grid Infrastructure is installed.
id String: The provider-assigned unique ID for this managed resource.
isCluster Boolean: Indicates whether the ASM is a cluster ASM or not.
isFlexEnabled Boolean: Indicates whether Oracle Flex ASM is enabled or not.
lifecycleDetails String: Additional information about the current lifecycle state.
servicedDatabases List<ExternalAsmServicedDatabase>: The list of databases that are serviced by the ASM.
state String: The current lifecycle state of the external ASM.
timeCreated String: The date and time the external ASM was created.
timeUpdated String: The date and time the external ASM was last updated.
version String: The ASM version.

additionalDetails {[key: string]: any}: The additional details of the external ASM defined in {"key": "value"} format. Example: {"bar-key": "value"}
compartmentId string: The OCID of the compartment in which the external database resides.
componentName string: The name of the external ASM.
displayName string: The user-friendly name for the database. The name does not have to be unique.
externalDbSystemId string: The OCID of the external DB system that the ASM is a part of.
gridHome string: The directory in which ASM is installed. This is the same directory in which Oracle Grid Infrastructure is installed.
id string: The provider-assigned unique ID for this managed resource.
isCluster boolean: Indicates whether the ASM is a cluster ASM or not.
isFlexEnabled boolean: Indicates whether Oracle Flex ASM is enabled or not.
lifecycleDetails string: Additional information about the current lifecycle state.
servicedDatabases ExternalAsmServicedDatabase[]: The list of databases that are serviced by the ASM.
state string: The current lifecycle state of the external ASM.
timeCreated string: The date and time the external ASM was created.
timeUpdated string: The date and time the external ASM was last updated.
version string: The ASM version.

additional_details Mapping[str, Any]: The additional details of the external ASM defined in {"key": "value"} format. Example: {"bar-key": "value"}
compartment_id str: The OCID of the compartment in which the external database resides.
component_name str: The name of the external ASM.
display_name str: The user-friendly name for the database. The name does not have to be unique.
external_db_system_id str: The OCID of the external DB system that the ASM is a part of.
grid_home str: The directory in which ASM is installed. This is the same directory in which Oracle Grid Infrastructure is installed.
id str: The provider-assigned unique ID for this managed resource.
is_cluster bool: Indicates whether the ASM is a cluster ASM or not.
is_flex_enabled bool: Indicates whether Oracle Flex ASM is enabled or not.
lifecycle_details str: Additional information about the current lifecycle state.
serviced_databases ExternalAsmServicedDatabase]: The list of databases that are serviced by the ASM.
state str: The current lifecycle state of the external ASM.
time_created str: The date and time the external ASM was created.
time_updated str: The date and time the external ASM was last updated.
version str: The ASM version.

additionalDetails Map<Any>: The additional details of the external ASM defined in {"key": "value"} format. Example: {"bar-key": "value"}
compartmentId String: The OCID of the compartment in which the external database resides.
componentName String: The name of the external ASM.
displayName String: The user-friendly name for the database. The name does not have to be unique.
externalDbSystemId String: The OCID of the external DB system that the ASM is a part of.
gridHome String: The directory in which ASM is installed. This is the same directory in which Oracle Grid Infrastructure is installed.
id String: The provider-assigned unique ID for this managed resource.
isCluster Boolean: Indicates whether the ASM is a cluster ASM or not.
isFlexEnabled Boolean: Indicates whether Oracle Flex ASM is enabled or not.
lifecycleDetails String: Additional information about the current lifecycle state.
servicedDatabases List<Property Map>: The list of databases that are serviced by the ASM.
state String: The current lifecycle state of the external ASM.
timeCreated String: The date and time the external ASM was created.
timeUpdated String: The date and time the external ASM was last updated.
version String: The ASM version.

Look up Existing ExternalAsm Resource

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

@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,
        display_name: Optional[str] = None,
        external_asm_id: Optional[str] = None,
        external_connector_id: Optional[str] = None,
        external_db_system_id: Optional[str] = None,
        grid_home: Optional[str] = None,
        is_cluster: Optional[bool] = None,
        is_flex_enabled: Optional[bool] = None,
        lifecycle_details: Optional[str] = None,
        serviced_databases: Optional[Sequence[_databasemanagement.ExternalAsmServicedDatabaseArgs]] = None,
        state: Optional[str] = None,
        time_created: Optional[str] = None,
        time_updated: Optional[str] = None,
        version: Optional[str] = None) -> ExternalAsm

func GetExternalAsm(ctx *Context, name string, id IDInput, state *ExternalAsmState, opts ...ResourceOption) (*ExternalAsm, error)

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

public static ExternalAsm get(String name, Output<String> id, ExternalAsmState 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 ASM defined in {"key": "value"} format. Example: {"bar-key": "value"}
CompartmentId string: The OCID of the compartment in which the external database resides.
ComponentName string: The name of the external ASM.
DisplayName string: The user-friendly name for the database. The name does not have to be unique.
ExternalAsmId string: The OCID of the external ASM.
ExternalConnectorId string: (Updatable) The OCID of the external connector.
ExternalDbSystemId string: The OCID of the external DB system that the ASM is a part of.
GridHome string: The directory in which ASM is installed. This is the same directory in which Oracle Grid Infrastructure is installed.
IsCluster bool: Indicates whether the ASM is a cluster ASM or not.
IsFlexEnabled bool: Indicates whether Oracle Flex ASM is enabled or not.
LifecycleDetails string: Additional information about the current lifecycle state.
ServicedDatabases List<ExternalAsmServicedDatabaseArgs>: The list of databases that are serviced by the ASM.
State string: The current lifecycle state of the external ASM.
TimeCreated string: The date and time the external ASM was created.
TimeUpdated string: The date and time the external ASM was last updated.
Version string: The ASM version.

AdditionalDetails map[string]interface{}: The additional details of the external ASM defined in {"key": "value"} format. Example: {"bar-key": "value"}
CompartmentId string: The OCID of the compartment in which the external database resides.
ComponentName string: The name of the external ASM.
DisplayName string: The user-friendly name for the database. The name does not have to be unique.
ExternalAsmId string: The OCID of the external ASM.
ExternalConnectorId string: (Updatable) The OCID of the external connector.
ExternalDbSystemId string: The OCID of the external DB system that the ASM is a part of.
GridHome string: The directory in which ASM is installed. This is the same directory in which Oracle Grid Infrastructure is installed.
IsCluster bool: Indicates whether the ASM is a cluster ASM or not.
IsFlexEnabled bool: Indicates whether Oracle Flex ASM is enabled or not.
LifecycleDetails string: Additional information about the current lifecycle state.
ServicedDatabases []ExternalAsmServicedDatabaseArgs: The list of databases that are serviced by the ASM.
State string: The current lifecycle state of the external ASM.
TimeCreated string: The date and time the external ASM was created.
TimeUpdated string: The date and time the external ASM was last updated.
Version string: The ASM version.

additionalDetails Map<String,Object>: The additional details of the external ASM defined in {"key": "value"} format. Example: {"bar-key": "value"}
compartmentId String: The OCID of the compartment in which the external database resides.
componentName String: The name of the external ASM.
displayName String: The user-friendly name for the database. The name does not have to be unique.
externalAsmId String: The OCID of the external ASM.
externalConnectorId String: (Updatable) The OCID of the external connector.
externalDbSystemId String: The OCID of the external DB system that the ASM is a part of.
gridHome String: The directory in which ASM is installed. This is the same directory in which Oracle Grid Infrastructure is installed.
isCluster Boolean: Indicates whether the ASM is a cluster ASM or not.
isFlexEnabled Boolean: Indicates whether Oracle Flex ASM is enabled or not.
lifecycleDetails String: Additional information about the current lifecycle state.
servicedDatabases List<ExternalAsmServicedDatabaseArgs>: The list of databases that are serviced by the ASM.
state String: The current lifecycle state of the external ASM.
timeCreated String: The date and time the external ASM was created.
timeUpdated String: The date and time the external ASM was last updated.
version String: The ASM version.

additionalDetails {[key: string]: any}: The additional details of the external ASM defined in {"key": "value"} format. Example: {"bar-key": "value"}
compartmentId string: The OCID of the compartment in which the external database resides.
componentName string: The name of the external ASM.
displayName string: The user-friendly name for the database. The name does not have to be unique.
externalAsmId string: The OCID of the external ASM.
externalConnectorId string: (Updatable) The OCID of the external connector.
externalDbSystemId string: The OCID of the external DB system that the ASM is a part of.
gridHome string: The directory in which ASM is installed. This is the same directory in which Oracle Grid Infrastructure is installed.
isCluster boolean: Indicates whether the ASM is a cluster ASM or not.
isFlexEnabled boolean: Indicates whether Oracle Flex ASM is enabled or not.
lifecycleDetails string: Additional information about the current lifecycle state.
servicedDatabases ExternalAsmServicedDatabaseArgs[]: The list of databases that are serviced by the ASM.
state string: The current lifecycle state of the external ASM.
timeCreated string: The date and time the external ASM was created.
timeUpdated string: The date and time the external ASM was last updated.
version string: The ASM version.

additional_details Mapping[str, Any]: The additional details of the external ASM defined in {"key": "value"} format. Example: {"bar-key": "value"}
compartment_id str: The OCID of the compartment in which the external database resides.
component_name str: The name of the external ASM.
display_name str: The user-friendly name for the database. The name does not have to be unique.
external_asm_id str: The OCID of the external ASM.
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 ASM is a part of.
grid_home str: The directory in which ASM is installed. This is the same directory in which Oracle Grid Infrastructure is installed.
is_cluster bool: Indicates whether the ASM is a cluster ASM or not.
is_flex_enabled bool: Indicates whether Oracle Flex ASM is enabled or not.
lifecycle_details str: Additional information about the current lifecycle state.
serviced_databases ExternalAsmServicedDatabaseArgs]: The list of databases that are serviced by the ASM.
state str: The current lifecycle state of the external ASM.
time_created str: The date and time the external ASM was created.
time_updated str: The date and time the external ASM was last updated.
version str: The ASM version.

additionalDetails Map<Any>: The additional details of the external ASM defined in {"key": "value"} format. Example: {"bar-key": "value"}
compartmentId String: The OCID of the compartment in which the external database resides.
componentName String: The name of the external ASM.
displayName String: The user-friendly name for the database. The name does not have to be unique.
externalAsmId String: The OCID of the external ASM.
externalConnectorId String: (Updatable) The OCID of the external connector.
externalDbSystemId String: The OCID of the external DB system that the ASM is a part of.
gridHome String: The directory in which ASM is installed. This is the same directory in which Oracle Grid Infrastructure is installed.
isCluster Boolean: Indicates whether the ASM is a cluster ASM or not.
isFlexEnabled Boolean: Indicates whether Oracle Flex ASM is enabled or not.
lifecycleDetails String: Additional information about the current lifecycle state.
servicedDatabases List<Property Map>: The list of databases that are serviced by the ASM.
state String: The current lifecycle state of the external ASM.
timeCreated String: The date and time the external ASM was created.
timeUpdated String: The date and time the external ASM was last updated.
version String: The ASM version.

Supporting Types

ExternalAsmServicedDatabase

CompartmentId string: The OCID of the compartment in which the external database resides.
DatabaseSubType string: The subtype of Oracle Database. Indicates whether the database is a Container Database, Pluggable Database, Non-container Database, Autonomous Database, or Autonomous Container Database.
DatabaseType string: The type of Oracle Database installation.
DbUniqueName string: The unique name of the external database.
DiskGroups List<string>: The list of ASM disk groups used by the database.
DisplayName string: The user-friendly name for the database. The name does not have to be unique.
Id string: The OCID of the external database.
IsManaged bool: Indicates whether the database is a Managed Database or not.

CompartmentId string: The OCID of the compartment in which the external database resides.
DatabaseSubType string: The subtype of Oracle Database. Indicates whether the database is a Container Database, Pluggable Database, Non-container Database, Autonomous Database, or Autonomous Container Database.
DatabaseType string: The type of Oracle Database installation.
DbUniqueName string: The unique name of the external database.
DiskGroups []string: The list of ASM disk groups used by the database.
DisplayName string: The user-friendly name for the database. The name does not have to be unique.
Id string: The OCID of the external database.
IsManaged bool: Indicates whether the database is a Managed Database or not.

compartmentId String: The OCID of the compartment in which the external database resides.
databaseSubType String: The subtype of Oracle Database. Indicates whether the database is a Container Database, Pluggable Database, Non-container Database, Autonomous Database, or Autonomous Container Database.
databaseType String: The type of Oracle Database installation.
dbUniqueName String: The unique name of the external database.
diskGroups List<String>: The list of ASM disk groups used by the database.
displayName String: The user-friendly name for the database. The name does not have to be unique.
id String: The OCID of the external database.
isManaged Boolean: Indicates whether the database is a Managed Database or not.

compartmentId string: The OCID of the compartment in which the external database resides.
databaseSubType string: The subtype of Oracle Database. Indicates whether the database is a Container Database, Pluggable Database, Non-container Database, Autonomous Database, or Autonomous Container Database.
databaseType string: The type of Oracle Database installation.
dbUniqueName string: The unique name of the external database.
diskGroups string[]: The list of ASM disk groups used by the database.
displayName string: The user-friendly name for the database. The name does not have to be unique.
id string: The OCID of the external database.
isManaged boolean: Indicates whether the database is a Managed Database or not.

compartment_id str: The OCID of the compartment in which the external database resides.
database_sub_type str: The subtype of Oracle Database. Indicates whether the database is a Container Database, Pluggable Database, Non-container Database, Autonomous Database, or Autonomous Container Database.
database_type str: The type of Oracle Database installation.
db_unique_name str: The unique name of the external database.
disk_groups Sequence[str]: The list of ASM disk groups used by the database.
display_name str: The user-friendly name for the database. The name does not have to be unique.
id str: The OCID of the external database.
is_managed bool: Indicates whether the database is a Managed Database or not.

compartmentId String: The OCID of the compartment in which the external database resides.
databaseSubType String: The subtype of Oracle Database. Indicates whether the database is a Container Database, Pluggable Database, Non-container Database, Autonomous Database, or Autonomous Container Database.
databaseType String: The type of Oracle Database installation.
dbUniqueName String: The unique name of the external database.
diskGroups List<String>: The list of ASM disk groups used by the database.
displayName String: The user-friendly name for the database. The name does not have to be unique.
id String: The OCID of the external database.
isManaged Boolean: Indicates whether the database is a Managed Database or not.

Import

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

 $ pulumi import oci:DatabaseManagement/externalAsm:ExternalAsm test_external_asm "id"

Package Details

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