Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. GloballyDistributedDatabase
  5. getShardedDatabase
Oracle Cloud Infrastructure v2.27.0 published on Thursday, Mar 20, 2025 by Pulumi
pulumi/pulumi-oci

oci.GloballyDistributedDatabase.getShardedDatabase

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.27.0 published on Thursday, Mar 20, 2025 by Pulumi
pulumi/pulumi-oci

    This data source provides details about a specific Sharded Database resource in Oracle Cloud Infrastructure Globally Distributed Database service.

    Gets the details of the Sharded database identified by given id.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testShardedDatabase = oci.GloballyDistributedDatabase.getShardedDatabase({
    shardedDatabaseId: testShardedDatabaseOciGloballyDistributedDatabaseShardedDatabase.id,
    metadata: shardedDatabaseMetadata,
});

    import pulumi
import pulumi_oci as oci

test_sharded_database = oci.GloballyDistributedDatabase.get_sharded_database(sharded_database_id=test_sharded_database_oci_globally_distributed_database_sharded_database["id"],
    metadata=sharded_database_metadata)

    package main

import (
	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/globallydistributeddatabase"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := globallydistributeddatabase.GetShardedDatabase(ctx, &globallydistributeddatabase.GetShardedDatabaseArgs{
			ShardedDatabaseId: testShardedDatabaseOciGloballyDistributedDatabaseShardedDatabase.Id,
			Metadata:          pulumi.StringRef(shardedDatabaseMetadata),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testShardedDatabase = Oci.GloballyDistributedDatabase.GetShardedDatabase.Invoke(new()
    {
        ShardedDatabaseId = testShardedDatabaseOciGloballyDistributedDatabaseShardedDatabase.Id,
        Metadata = shardedDatabaseMetadata,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.GloballyDistributedDatabase.GloballyDistributedDatabaseFunctions;
import com.pulumi.oci.GloballyDistributedDatabase.inputs.GetShardedDatabaseArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var testShardedDatabase = GloballyDistributedDatabaseFunctions.getShardedDatabase(GetShardedDatabaseArgs.builder()
            .shardedDatabaseId(testShardedDatabaseOciGloballyDistributedDatabaseShardedDatabase.id())
            .metadata(shardedDatabaseMetadata)
            .build());

    }
}

    variables:
  testShardedDatabase:
    fn::invoke:
      function: oci:GloballyDistributedDatabase:getShardedDatabase
      arguments:
        shardedDatabaseId: ${testShardedDatabaseOciGloballyDistributedDatabaseShardedDatabase.id}
        metadata: ${shardedDatabaseMetadata}

    Using getShardedDatabase

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getShardedDatabase(args: GetShardedDatabaseArgs, opts?: InvokeOptions): Promise<GetShardedDatabaseResult>
function getShardedDatabaseOutput(args: GetShardedDatabaseOutputArgs, opts?: InvokeOptions): Output<GetShardedDatabaseResult>
    def get_sharded_database(metadata: Optional[str] = None,
                         sharded_database_id: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetShardedDatabaseResult
def get_sharded_database_output(metadata: Optional[pulumi.Input[str]] = None,
                         sharded_database_id: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetShardedDatabaseResult]
    func GetShardedDatabase(ctx *Context, args *GetShardedDatabaseArgs, opts ...InvokeOption) (*GetShardedDatabaseResult, error)
func GetShardedDatabaseOutput(ctx *Context, args *GetShardedDatabaseOutputArgs, opts ...InvokeOption) GetShardedDatabaseResultOutput

    > Note: This function is named GetShardedDatabase in the Go SDK.

    public static class GetShardedDatabase 
{
    public static Task<GetShardedDatabaseResult> InvokeAsync(GetShardedDatabaseArgs args, InvokeOptions? opts = null)
    public static Output<GetShardedDatabaseResult> Invoke(GetShardedDatabaseInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetShardedDatabaseResult> getShardedDatabase(GetShardedDatabaseArgs args, InvokeOptions options)
public static Output<GetShardedDatabaseResult> getShardedDatabase(GetShardedDatabaseArgs args, InvokeOptions options)

    fn::invoke:
  function: oci:GloballyDistributedDatabase/getShardedDatabase:getShardedDatabase
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ShardedDatabaseId string
    Sharded Database identifier
    Metadata string
    Comma separated names of argument corresponding to which metadata need to be retrived, namely VM_CLUSTER_INFO, ADDITIONAL_RESOURCE_INFO. An example is metadata=VM_CLUSTER_INFO,ADDITIONAL_RESOURCE_INFO.
    ShardedDatabaseId string
    Sharded Database identifier
    Metadata string
    Comma separated names of argument corresponding to which metadata need to be retrived, namely VM_CLUSTER_INFO, ADDITIONAL_RESOURCE_INFO. An example is metadata=VM_CLUSTER_INFO,ADDITIONAL_RESOURCE_INFO.
    shardedDatabaseId String
    Sharded Database identifier
    metadata String
    Comma separated names of argument corresponding to which metadata need to be retrived, namely VM_CLUSTER_INFO, ADDITIONAL_RESOURCE_INFO. An example is metadata=VM_CLUSTER_INFO,ADDITIONAL_RESOURCE_INFO.
    shardedDatabaseId string
    Sharded Database identifier
    metadata string
    Comma separated names of argument corresponding to which metadata need to be retrived, namely VM_CLUSTER_INFO, ADDITIONAL_RESOURCE_INFO. An example is metadata=VM_CLUSTER_INFO,ADDITIONAL_RESOURCE_INFO.
    sharded_database_id str
    Sharded Database identifier
    metadata str
    Comma separated names of argument corresponding to which metadata need to be retrived, namely VM_CLUSTER_INFO, ADDITIONAL_RESOURCE_INFO. An example is metadata=VM_CLUSTER_INFO,ADDITIONAL_RESOURCE_INFO.
    shardedDatabaseId String
    Sharded Database identifier
    metadata String
    Comma separated names of argument corresponding to which metadata need to be retrived, namely VM_CLUSTER_INFO, ADDITIONAL_RESOURCE_INFO. An example is metadata=VM_CLUSTER_INFO,ADDITIONAL_RESOURCE_INFO.

    getShardedDatabase Result

    The following output properties are available:

    CaSignedCertificate string
    CatalogDetails List<GetShardedDatabaseCatalogDetail>
    Details of ATP-D based catalogs.
    CharacterSet string
    The character set for the database.
    Chunks int
    The default number of unique chunks in a shardspace. The value of chunks must be greater than 2 times the size of the largest shardgroup in any shardspace.
    ClusterCertificateCommonName string
    The certificate common name used in all cloudAutonomousVmClusters for the sharded database topology. Eg. Production. All the clusters used in one sharded database topology shall have same CABundle setup. Valid characterset for clusterCertificateCommonName include uppercase or lowercase letters, numbers, hyphens, underscores, and period.
    CompartmentId string
    Identifier of the compartment in which sharded database exists.
    ConfigureGsmsTrigger int
    ConfigureGsmsTriggerIsLatestGsmImage bool
    ConfigureGsmsTriggerOldGsmNames List<string>
    ConfigureShardingTrigger int
    ConnectionStrings List<GetShardedDatabaseConnectionString>
    Details of sharded database connection String.
    DbDeploymentType string
    The database deployment type.
    DbVersion string
    Oracle Database version number.
    DbWorkload string
    Possible workload types.
    DefinedTags Dictionary<string, string>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    DisplayName string
    Oracle sharded database display name.
    DownloadGsmCertificateSigningRequestTrigger int
    FreeformTags Dictionary<string, string>
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    GenerateGsmCertificateSigningRequestTrigger int
    GenerateWalletPassword string
    GenerateWalletTrigger int
    GetConnectionStringTrigger int
    Gsms List<GetShardedDatabaseGsm>
    Details of GSM instances for the sharded database.
    Id string
    Sharded Database identifier
    LifecycleState string
    LifecycleStateDetails string
    Detailed message for the lifecycle state.
    ListenerPort int
    The GSM listener port number.
    ListenerPortTls int
    The TLS listener port number for sharded database.
    NcharacterSet string
    The national character set for the database.
    OnsPortLocal int
    Ons local port number.
    OnsPortRemote int
    Ons remote port number.
    PatchOperations List<GetShardedDatabasePatchOperation>
    Prefix string
    Unique prefix for the sharded database.
    PrivateEndpoint string
    The OCID of private endpoint being used by the sharded database.
    ReplicationFactor int
    The Replication factor for RAFT replication based sharded database. Currently supported values are 3, 5 and 7.
    ReplicationMethod string
    The Replication method for sharded database. Use RAFT for Raft replication, and DG for DataGuard. If replicationMethod is not provided, it defaults to DG.
    ReplicationUnit int
    For RAFT replication based sharded database, the value should be atleast twice the number of shards.
    ShardDetails List<GetShardedDatabaseShardDetail>
    Details of ATP-D based shards.
    ShardedDatabaseId string
    ShardingMethod string
    Sharding Method.
    StartDatabaseTrigger int
    State string
    Lifecycle states for sharded databases.
    StopDatabaseTrigger int
    SystemTags Dictionary<string, string>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The time the the Sharded Database was created. An RFC3339 formatted datetime string
    TimeUpdated string
    The time the Sharded Database was last updated. An RFC3339 formatted datetime string
    TimeZone string
    Timezone associated with the sharded database.
    UploadSignedCertificateAndGenerateWalletTrigger int
    ValidateNetworkTrigger int
    Metadata string
    Additional metadata related to shard's underlying supporting resource.
    CaSignedCertificate string
    CatalogDetails []GetShardedDatabaseCatalogDetail
    Details of ATP-D based catalogs.
    CharacterSet string
    The character set for the database.
    Chunks int
    The default number of unique chunks in a shardspace. The value of chunks must be greater than 2 times the size of the largest shardgroup in any shardspace.
    ClusterCertificateCommonName string
    The certificate common name used in all cloudAutonomousVmClusters for the sharded database topology. Eg. Production. All the clusters used in one sharded database topology shall have same CABundle setup. Valid characterset for clusterCertificateCommonName include uppercase or lowercase letters, numbers, hyphens, underscores, and period.
    CompartmentId string
    Identifier of the compartment in which sharded database exists.
    ConfigureGsmsTrigger int
    ConfigureGsmsTriggerIsLatestGsmImage bool
    ConfigureGsmsTriggerOldGsmNames []string
    ConfigureShardingTrigger int
    ConnectionStrings []GetShardedDatabaseConnectionString
    Details of sharded database connection String.
    DbDeploymentType string
    The database deployment type.
    DbVersion string
    Oracle Database version number.
    DbWorkload string
    Possible workload types.
    DefinedTags map[string]string
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    DisplayName string
    Oracle sharded database display name.
    DownloadGsmCertificateSigningRequestTrigger int
    FreeformTags map[string]string
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    GenerateGsmCertificateSigningRequestTrigger int
    GenerateWalletPassword string
    GenerateWalletTrigger int
    GetConnectionStringTrigger int
    Gsms []GetShardedDatabaseGsm
    Details of GSM instances for the sharded database.
    Id string
    Sharded Database identifier
    LifecycleState string
    LifecycleStateDetails string
    Detailed message for the lifecycle state.
    ListenerPort int
    The GSM listener port number.
    ListenerPortTls int
    The TLS listener port number for sharded database.
    NcharacterSet string
    The national character set for the database.
    OnsPortLocal int
    Ons local port number.
    OnsPortRemote int
    Ons remote port number.
    PatchOperations []GetShardedDatabasePatchOperation
    Prefix string
    Unique prefix for the sharded database.
    PrivateEndpoint string
    The OCID of private endpoint being used by the sharded database.
    ReplicationFactor int
    The Replication factor for RAFT replication based sharded database. Currently supported values are 3, 5 and 7.
    ReplicationMethod string
    The Replication method for sharded database. Use RAFT for Raft replication, and DG for DataGuard. If replicationMethod is not provided, it defaults to DG.
    ReplicationUnit int
    For RAFT replication based sharded database, the value should be atleast twice the number of shards.
    ShardDetails []GetShardedDatabaseShardDetail
    Details of ATP-D based shards.
    ShardedDatabaseId string
    ShardingMethod string
    Sharding Method.
    StartDatabaseTrigger int
    State string
    Lifecycle states for sharded databases.
    StopDatabaseTrigger int
    SystemTags map[string]string
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The time the the Sharded Database was created. An RFC3339 formatted datetime string
    TimeUpdated string
    The time the Sharded Database was last updated. An RFC3339 formatted datetime string
    TimeZone string
    Timezone associated with the sharded database.
    UploadSignedCertificateAndGenerateWalletTrigger int
    ValidateNetworkTrigger int
    Metadata string
    Additional metadata related to shard's underlying supporting resource.
    caSignedCertificate String
    catalogDetails List<GetShardedDatabaseCatalogDetail>
    Details of ATP-D based catalogs.
    characterSet String
    The character set for the database.
    chunks Integer
    The default number of unique chunks in a shardspace. The value of chunks must be greater than 2 times the size of the largest shardgroup in any shardspace.
    clusterCertificateCommonName String
    The certificate common name used in all cloudAutonomousVmClusters for the sharded database topology. Eg. Production. All the clusters used in one sharded database topology shall have same CABundle setup. Valid characterset for clusterCertificateCommonName include uppercase or lowercase letters, numbers, hyphens, underscores, and period.
    compartmentId String
    Identifier of the compartment in which sharded database exists.
    configureGsmsTrigger Integer
    configureGsmsTriggerIsLatestGsmImage Boolean
    configureGsmsTriggerOldGsmNames List<String>
    configureShardingTrigger Integer
    connectionStrings List<GetShardedDatabaseConnectionString>
    Details of sharded database connection String.
    dbDeploymentType String
    The database deployment type.
    dbVersion String
    Oracle Database version number.
    dbWorkload String
    Possible workload types.
    definedTags Map<String,String>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    displayName String
    Oracle sharded database display name.
    downloadGsmCertificateSigningRequestTrigger Integer
    freeformTags Map<String,String>
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    generateGsmCertificateSigningRequestTrigger Integer
    generateWalletPassword String
    generateWalletTrigger Integer
    getConnectionStringTrigger Integer
    gsms List<GetShardedDatabaseGsm>
    Details of GSM instances for the sharded database.
    id String
    Sharded Database identifier
    lifecycleState String
    lifecycleStateDetails String
    Detailed message for the lifecycle state.
    listenerPort Integer
    The GSM listener port number.
    listenerPortTls Integer
    The TLS listener port number for sharded database.
    ncharacterSet String
    The national character set for the database.
    onsPortLocal Integer
    Ons local port number.
    onsPortRemote Integer
    Ons remote port number.
    patchOperations List<GetShardedDatabasePatchOperation>
    prefix String
    Unique prefix for the sharded database.
    privateEndpoint String
    The OCID of private endpoint being used by the sharded database.
    replicationFactor Integer
    The Replication factor for RAFT replication based sharded database. Currently supported values are 3, 5 and 7.
    replicationMethod String
    The Replication method for sharded database. Use RAFT for Raft replication, and DG for DataGuard. If replicationMethod is not provided, it defaults to DG.
    replicationUnit Integer
    For RAFT replication based sharded database, the value should be atleast twice the number of shards.
    shardDetails List<GetShardedDatabaseShardDetail>
    Details of ATP-D based shards.
    shardedDatabaseId String
    shardingMethod String
    Sharding Method.
    startDatabaseTrigger Integer
    state String
    Lifecycle states for sharded databases.
    stopDatabaseTrigger Integer
    systemTags Map<String,String>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The time the the Sharded Database was created. An RFC3339 formatted datetime string
    timeUpdated String
    The time the Sharded Database was last updated. An RFC3339 formatted datetime string
    timeZone String
    Timezone associated with the sharded database.
    uploadSignedCertificateAndGenerateWalletTrigger Integer
    validateNetworkTrigger Integer
    metadata String
    Additional metadata related to shard's underlying supporting resource.
    caSignedCertificate string
    catalogDetails GetShardedDatabaseCatalogDetail[]
    Details of ATP-D based catalogs.
    characterSet string
    The character set for the database.
    chunks number
    The default number of unique chunks in a shardspace. The value of chunks must be greater than 2 times the size of the largest shardgroup in any shardspace.
    clusterCertificateCommonName string
    The certificate common name used in all cloudAutonomousVmClusters for the sharded database topology. Eg. Production. All the clusters used in one sharded database topology shall have same CABundle setup. Valid characterset for clusterCertificateCommonName include uppercase or lowercase letters, numbers, hyphens, underscores, and period.
    compartmentId string
    Identifier of the compartment in which sharded database exists.
    configureGsmsTrigger number
    configureGsmsTriggerIsLatestGsmImage boolean
    configureGsmsTriggerOldGsmNames string[]
    configureShardingTrigger number
    connectionStrings GetShardedDatabaseConnectionString[]
    Details of sharded database connection String.
    dbDeploymentType string
    The database deployment type.
    dbVersion string
    Oracle Database version number.
    dbWorkload string
    Possible workload types.
    definedTags {[key: string]: string}
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    displayName string
    Oracle sharded database display name.
    downloadGsmCertificateSigningRequestTrigger number
    freeformTags {[key: string]: string}
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    generateGsmCertificateSigningRequestTrigger number
    generateWalletPassword string
    generateWalletTrigger number
    getConnectionStringTrigger number
    gsms GetShardedDatabaseGsm[]
    Details of GSM instances for the sharded database.
    id string
    Sharded Database identifier
    lifecycleState string
    lifecycleStateDetails string
    Detailed message for the lifecycle state.
    listenerPort number
    The GSM listener port number.
    listenerPortTls number
    The TLS listener port number for sharded database.
    ncharacterSet string
    The national character set for the database.
    onsPortLocal number
    Ons local port number.
    onsPortRemote number
    Ons remote port number.
    patchOperations GetShardedDatabasePatchOperation[]
    prefix string
    Unique prefix for the sharded database.
    privateEndpoint string
    The OCID of private endpoint being used by the sharded database.
    replicationFactor number
    The Replication factor for RAFT replication based sharded database. Currently supported values are 3, 5 and 7.
    replicationMethod string
    The Replication method for sharded database. Use RAFT for Raft replication, and DG for DataGuard. If replicationMethod is not provided, it defaults to DG.
    replicationUnit number
    For RAFT replication based sharded database, the value should be atleast twice the number of shards.
    shardDetails GetShardedDatabaseShardDetail[]
    Details of ATP-D based shards.
    shardedDatabaseId string
    shardingMethod string
    Sharding Method.
    startDatabaseTrigger number
    state string
    Lifecycle states for sharded databases.
    stopDatabaseTrigger number
    systemTags {[key: string]: string}
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated string
    The time the the Sharded Database was created. An RFC3339 formatted datetime string
    timeUpdated string
    The time the Sharded Database was last updated. An RFC3339 formatted datetime string
    timeZone string
    Timezone associated with the sharded database.
    uploadSignedCertificateAndGenerateWalletTrigger number
    validateNetworkTrigger number
    metadata string
    Additional metadata related to shard's underlying supporting resource.
    ca_signed_certificate str
    catalog_details Sequence[globallydistributeddatabase.GetShardedDatabaseCatalogDetail]
    Details of ATP-D based catalogs.
    character_set str
    The character set for the database.
    chunks int
    The default number of unique chunks in a shardspace. The value of chunks must be greater than 2 times the size of the largest shardgroup in any shardspace.
    cluster_certificate_common_name str
    The certificate common name used in all cloudAutonomousVmClusters for the sharded database topology. Eg. Production. All the clusters used in one sharded database topology shall have same CABundle setup. Valid characterset for clusterCertificateCommonName include uppercase or lowercase letters, numbers, hyphens, underscores, and period.
    compartment_id str
    Identifier of the compartment in which sharded database exists.
    configure_gsms_trigger int
    configure_gsms_trigger_is_latest_gsm_image bool
    configure_gsms_trigger_old_gsm_names Sequence[str]
    configure_sharding_trigger int
    connection_strings Sequence[globallydistributeddatabase.GetShardedDatabaseConnectionString]
    Details of sharded database connection String.
    db_deployment_type str
    The database deployment type.
    db_version str
    Oracle Database version number.
    db_workload str
    Possible workload types.
    defined_tags Mapping[str, str]
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    display_name str
    Oracle sharded database display name.
    download_gsm_certificate_signing_request_trigger int
    freeform_tags Mapping[str, str]
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    generate_gsm_certificate_signing_request_trigger int
    generate_wallet_password str
    generate_wallet_trigger int
    get_connection_string_trigger int
    gsms Sequence[globallydistributeddatabase.GetShardedDatabaseGsm]
    Details of GSM instances for the sharded database.
    id str
    Sharded Database identifier
    lifecycle_state str
    lifecycle_state_details str
    Detailed message for the lifecycle state.
    listener_port int
    The GSM listener port number.
    listener_port_tls int
    The TLS listener port number for sharded database.
    ncharacter_set str
    The national character set for the database.
    ons_port_local int
    Ons local port number.
    ons_port_remote int
    Ons remote port number.
    patch_operations Sequence[globallydistributeddatabase.GetShardedDatabasePatchOperation]
    prefix str
    Unique prefix for the sharded database.
    private_endpoint str
    The OCID of private endpoint being used by the sharded database.
    replication_factor int
    The Replication factor for RAFT replication based sharded database. Currently supported values are 3, 5 and 7.
    replication_method str
    The Replication method for sharded database. Use RAFT for Raft replication, and DG for DataGuard. If replicationMethod is not provided, it defaults to DG.
    replication_unit int
    For RAFT replication based sharded database, the value should be atleast twice the number of shards.
    shard_details Sequence[globallydistributeddatabase.GetShardedDatabaseShardDetail]
    Details of ATP-D based shards.
    sharded_database_id str
    sharding_method str
    Sharding Method.
    start_database_trigger int
    state str
    Lifecycle states for sharded databases.
    stop_database_trigger int
    system_tags Mapping[str, str]
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    time_created str
    The time the the Sharded Database was created. An RFC3339 formatted datetime string
    time_updated str
    The time the Sharded Database was last updated. An RFC3339 formatted datetime string
    time_zone str
    Timezone associated with the sharded database.
    upload_signed_certificate_and_generate_wallet_trigger int
    validate_network_trigger int
    metadata str
    Additional metadata related to shard's underlying supporting resource.
    caSignedCertificate String
    catalogDetails List<Property Map>
    Details of ATP-D based catalogs.
    characterSet String
    The character set for the database.
    chunks Number
    The default number of unique chunks in a shardspace. The value of chunks must be greater than 2 times the size of the largest shardgroup in any shardspace.
    clusterCertificateCommonName String
    The certificate common name used in all cloudAutonomousVmClusters for the sharded database topology. Eg. Production. All the clusters used in one sharded database topology shall have same CABundle setup. Valid characterset for clusterCertificateCommonName include uppercase or lowercase letters, numbers, hyphens, underscores, and period.
    compartmentId String
    Identifier of the compartment in which sharded database exists.
    configureGsmsTrigger Number
    configureGsmsTriggerIsLatestGsmImage Boolean
    configureGsmsTriggerOldGsmNames List<String>
    configureShardingTrigger Number
    connectionStrings List<Property Map>
    Details of sharded database connection String.
    dbDeploymentType String
    The database deployment type.
    dbVersion String
    Oracle Database version number.
    dbWorkload String
    Possible workload types.
    definedTags Map<String>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    displayName String
    Oracle sharded database display name.
    downloadGsmCertificateSigningRequestTrigger Number
    freeformTags Map<String>
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    generateGsmCertificateSigningRequestTrigger Number
    generateWalletPassword String
    generateWalletTrigger Number
    getConnectionStringTrigger Number
    gsms List<Property Map>
    Details of GSM instances for the sharded database.
    id String
    Sharded Database identifier
    lifecycleState String
    lifecycleStateDetails String
    Detailed message for the lifecycle state.
    listenerPort Number
    The GSM listener port number.
    listenerPortTls Number
    The TLS listener port number for sharded database.
    ncharacterSet String
    The national character set for the database.
    onsPortLocal Number
    Ons local port number.
    onsPortRemote Number
    Ons remote port number.
    patchOperations List<Property Map>
    prefix String
    Unique prefix for the sharded database.
    privateEndpoint String
    The OCID of private endpoint being used by the sharded database.
    replicationFactor Number
    The Replication factor for RAFT replication based sharded database. Currently supported values are 3, 5 and 7.
    replicationMethod String
    The Replication method for sharded database. Use RAFT for Raft replication, and DG for DataGuard. If replicationMethod is not provided, it defaults to DG.
    replicationUnit Number
    For RAFT replication based sharded database, the value should be atleast twice the number of shards.
    shardDetails List<Property Map>
    Details of ATP-D based shards.
    shardedDatabaseId String
    shardingMethod String
    Sharding Method.
    startDatabaseTrigger Number
    state String
    Lifecycle states for sharded databases.
    stopDatabaseTrigger Number
    systemTags Map<String>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The time the the Sharded Database was created. An RFC3339 formatted datetime string
    timeUpdated String
    The time the Sharded Database was last updated. An RFC3339 formatted datetime string
    timeZone String
    Timezone associated with the sharded database.
    uploadSignedCertificateAndGenerateWalletTrigger Number
    validateNetworkTrigger Number
    metadata String
    Additional metadata related to shard's underlying supporting resource.

    Supporting Types

    GetShardedDatabaseCatalogDetail

    AdminPassword string
    CloudAutonomousVmClusterId string
    Identifier of the primary cloudAutonomousVmCluster for the shard.
    ComputeCount double
    The compute amount available to the underlying autonomous database associated with shard.
    ContainerDatabaseId string
    Identifier of the underlying container database.
    ContainerDatabaseParentId string
    Identifier of the underlying container database parent.
    DataStorageSizeInGbs double
    The data disk group size to be allocated in GBs.
    EncryptionKeyDetails List<GetShardedDatabaseCatalogDetailEncryptionKeyDetail>
    Details of encryption key to be used to encrypt data for shards and catalog for sharded database. For system-defined sharding type, all shards have to use same encryptionKeyDetails. For system-defined sharding, if encryptionKeyDetails are not specified for catalog, then Oracle managed key will be used for catalog. For user-defined sharding type, if encryptionKeyDetails are not provided for any shard or catalog, then Oracle managed key will be used for such shard or catalog. For system-defined or user-defined sharding type, if the shard or catalog has a peer in region other than primary shard or catalog region, then make sure to provide virtual vault for such shard or catalog, which is also replicated to peer region (the region where peer or standby shard or catalog exists).
    IsAutoScalingEnabled bool
    Determines the auto-scaling mode.
    Metadata Dictionary<string, string>
    Comma separated names of argument corresponding to which metadata need to be retrived, namely VM_CLUSTER_INFO, ADDITIONAL_RESOURCE_INFO. An example is metadata=VM_CLUSTER_INFO,ADDITIONAL_RESOURCE_INFO.
    Name string
    Name of the shard.
    PeerCloudAutonomousVmClusterId string
    Identifier of the peer cloudAutonomousVmCluster for the shard.
    ShardGroup string
    Name of the shard-group to which the shard belongs.
    Status string
    Status of shard or catalog or gsm for the sharded database.
    SupportingResourceId string
    Identifier of the underlying supporting resource.
    TimeCreated string
    The time the the Sharded Database was created. An RFC3339 formatted datetime string
    TimeSslCertificateExpires string
    The time the ssl certificate associated with shard expires. An RFC3339 formatted datetime string
    TimeUpdated string
    The time the Sharded Database was last updated. An RFC3339 formatted datetime string
    AdminPassword string
    CloudAutonomousVmClusterId string
    Identifier of the primary cloudAutonomousVmCluster for the shard.
    ComputeCount float64
    The compute amount available to the underlying autonomous database associated with shard.
    ContainerDatabaseId string
    Identifier of the underlying container database.
    ContainerDatabaseParentId string
    Identifier of the underlying container database parent.
    DataStorageSizeInGbs float64
    The data disk group size to be allocated in GBs.
    EncryptionKeyDetails []GetShardedDatabaseCatalogDetailEncryptionKeyDetail
    Details of encryption key to be used to encrypt data for shards and catalog for sharded database. For system-defined sharding type, all shards have to use same encryptionKeyDetails. For system-defined sharding, if encryptionKeyDetails are not specified for catalog, then Oracle managed key will be used for catalog. For user-defined sharding type, if encryptionKeyDetails are not provided for any shard or catalog, then Oracle managed key will be used for such shard or catalog. For system-defined or user-defined sharding type, if the shard or catalog has a peer in region other than primary shard or catalog region, then make sure to provide virtual vault for such shard or catalog, which is also replicated to peer region (the region where peer or standby shard or catalog exists).
    IsAutoScalingEnabled bool
    Determines the auto-scaling mode.
    Metadata map[string]string
    Comma separated names of argument corresponding to which metadata need to be retrived, namely VM_CLUSTER_INFO, ADDITIONAL_RESOURCE_INFO. An example is metadata=VM_CLUSTER_INFO,ADDITIONAL_RESOURCE_INFO.
    Name string
    Name of the shard.
    PeerCloudAutonomousVmClusterId string
    Identifier of the peer cloudAutonomousVmCluster for the shard.
    ShardGroup string
    Name of the shard-group to which the shard belongs.
    Status string
    Status of shard or catalog or gsm for the sharded database.
    SupportingResourceId string
    Identifier of the underlying supporting resource.
    TimeCreated string
    The time the the Sharded Database was created. An RFC3339 formatted datetime string
    TimeSslCertificateExpires string
    The time the ssl certificate associated with shard expires. An RFC3339 formatted datetime string
    TimeUpdated string
    The time the Sharded Database was last updated. An RFC3339 formatted datetime string
    adminPassword String
    cloudAutonomousVmClusterId String
    Identifier of the primary cloudAutonomousVmCluster for the shard.
    computeCount Double
    The compute amount available to the underlying autonomous database associated with shard.
    containerDatabaseId String
    Identifier of the underlying container database.
    containerDatabaseParentId String
    Identifier of the underlying container database parent.
    dataStorageSizeInGbs Double
    The data disk group size to be allocated in GBs.
    encryptionKeyDetails List<GetShardedDatabaseCatalogDetailEncryptionKeyDetail>
    Details of encryption key to be used to encrypt data for shards and catalog for sharded database. For system-defined sharding type, all shards have to use same encryptionKeyDetails. For system-defined sharding, if encryptionKeyDetails are not specified for catalog, then Oracle managed key will be used for catalog. For user-defined sharding type, if encryptionKeyDetails are not provided for any shard or catalog, then Oracle managed key will be used for such shard or catalog. For system-defined or user-defined sharding type, if the shard or catalog has a peer in region other than primary shard or catalog region, then make sure to provide virtual vault for such shard or catalog, which is also replicated to peer region (the region where peer or standby shard or catalog exists).
    isAutoScalingEnabled Boolean
    Determines the auto-scaling mode.
    metadata Map<String,String>
    Comma separated names of argument corresponding to which metadata need to be retrived, namely VM_CLUSTER_INFO, ADDITIONAL_RESOURCE_INFO. An example is metadata=VM_CLUSTER_INFO,ADDITIONAL_RESOURCE_INFO.
    name String
    Name of the shard.
    peerCloudAutonomousVmClusterId String
    Identifier of the peer cloudAutonomousVmCluster for the shard.
    shardGroup String
    Name of the shard-group to which the shard belongs.
    status String
    Status of shard or catalog or gsm for the sharded database.
    supportingResourceId String
    Identifier of the underlying supporting resource.
    timeCreated String
    The time the the Sharded Database was created. An RFC3339 formatted datetime string
    timeSslCertificateExpires String
    The time the ssl certificate associated with shard expires. An RFC3339 formatted datetime string
    timeUpdated String
    The time the Sharded Database was last updated. An RFC3339 formatted datetime string
    adminPassword string
    cloudAutonomousVmClusterId string
    Identifier of the primary cloudAutonomousVmCluster for the shard.
    computeCount number
    The compute amount available to the underlying autonomous database associated with shard.
    containerDatabaseId string
    Identifier of the underlying container database.
    containerDatabaseParentId string
    Identifier of the underlying container database parent.
    dataStorageSizeInGbs number
    The data disk group size to be allocated in GBs.
    encryptionKeyDetails GetShardedDatabaseCatalogDetailEncryptionKeyDetail[]
    Details of encryption key to be used to encrypt data for shards and catalog for sharded database. For system-defined sharding type, all shards have to use same encryptionKeyDetails. For system-defined sharding, if encryptionKeyDetails are not specified for catalog, then Oracle managed key will be used for catalog. For user-defined sharding type, if encryptionKeyDetails are not provided for any shard or catalog, then Oracle managed key will be used for such shard or catalog. For system-defined or user-defined sharding type, if the shard or catalog has a peer in region other than primary shard or catalog region, then make sure to provide virtual vault for such shard or catalog, which is also replicated to peer region (the region where peer or standby shard or catalog exists).
    isAutoScalingEnabled boolean
    Determines the auto-scaling mode.
    metadata {[key: string]: string}
    Comma separated names of argument corresponding to which metadata need to be retrived, namely VM_CLUSTER_INFO, ADDITIONAL_RESOURCE_INFO. An example is metadata=VM_CLUSTER_INFO,ADDITIONAL_RESOURCE_INFO.
    name string
    Name of the shard.
    peerCloudAutonomousVmClusterId string
    Identifier of the peer cloudAutonomousVmCluster for the shard.
    shardGroup string
    Name of the shard-group to which the shard belongs.
    status string
    Status of shard or catalog or gsm for the sharded database.
    supportingResourceId string
    Identifier of the underlying supporting resource.
    timeCreated string
    The time the the Sharded Database was created. An RFC3339 formatted datetime string
    timeSslCertificateExpires string
    The time the ssl certificate associated with shard expires. An RFC3339 formatted datetime string
    timeUpdated string
    The time the Sharded Database was last updated. An RFC3339 formatted datetime string
    admin_password str
    cloud_autonomous_vm_cluster_id str
    Identifier of the primary cloudAutonomousVmCluster for the shard.
    compute_count float
    The compute amount available to the underlying autonomous database associated with shard.
    container_database_id str
    Identifier of the underlying container database.
    container_database_parent_id str
    Identifier of the underlying container database parent.
    data_storage_size_in_gbs float
    The data disk group size to be allocated in GBs.
    encryption_key_details Sequence[globallydistributeddatabase.GetShardedDatabaseCatalogDetailEncryptionKeyDetail]
    Details of encryption key to be used to encrypt data for shards and catalog for sharded database. For system-defined sharding type, all shards have to use same encryptionKeyDetails. For system-defined sharding, if encryptionKeyDetails are not specified for catalog, then Oracle managed key will be used for catalog. For user-defined sharding type, if encryptionKeyDetails are not provided for any shard or catalog, then Oracle managed key will be used for such shard or catalog. For system-defined or user-defined sharding type, if the shard or catalog has a peer in region other than primary shard or catalog region, then make sure to provide virtual vault for such shard or catalog, which is also replicated to peer region (the region where peer or standby shard or catalog exists).
    is_auto_scaling_enabled bool
    Determines the auto-scaling mode.
    metadata Mapping[str, str]
    Comma separated names of argument corresponding to which metadata need to be retrived, namely VM_CLUSTER_INFO, ADDITIONAL_RESOURCE_INFO. An example is metadata=VM_CLUSTER_INFO,ADDITIONAL_RESOURCE_INFO.
    name str
    Name of the shard.
    peer_cloud_autonomous_vm_cluster_id str
    Identifier of the peer cloudAutonomousVmCluster for the shard.
    shard_group str
    Name of the shard-group to which the shard belongs.
    status str
    Status of shard or catalog or gsm for the sharded database.
    supporting_resource_id str
    Identifier of the underlying supporting resource.
    time_created str
    The time the the Sharded Database was created. An RFC3339 formatted datetime string
    time_ssl_certificate_expires str
    The time the ssl certificate associated with shard expires. An RFC3339 formatted datetime string
    time_updated str
    The time the Sharded Database was last updated. An RFC3339 formatted datetime string
    adminPassword String
    cloudAutonomousVmClusterId String
    Identifier of the primary cloudAutonomousVmCluster for the shard.
    computeCount Number
    The compute amount available to the underlying autonomous database associated with shard.
    containerDatabaseId String
    Identifier of the underlying container database.
    containerDatabaseParentId String
    Identifier of the underlying container database parent.
    dataStorageSizeInGbs Number
    The data disk group size to be allocated in GBs.
    encryptionKeyDetails List<Property Map>
    Details of encryption key to be used to encrypt data for shards and catalog for sharded database. For system-defined sharding type, all shards have to use same encryptionKeyDetails. For system-defined sharding, if encryptionKeyDetails are not specified for catalog, then Oracle managed key will be used for catalog. For user-defined sharding type, if encryptionKeyDetails are not provided for any shard or catalog, then Oracle managed key will be used for such shard or catalog. For system-defined or user-defined sharding type, if the shard or catalog has a peer in region other than primary shard or catalog region, then make sure to provide virtual vault for such shard or catalog, which is also replicated to peer region (the region where peer or standby shard or catalog exists).
    isAutoScalingEnabled Boolean
    Determines the auto-scaling mode.
    metadata Map<String>
    Comma separated names of argument corresponding to which metadata need to be retrived, namely VM_CLUSTER_INFO, ADDITIONAL_RESOURCE_INFO. An example is metadata=VM_CLUSTER_INFO,ADDITIONAL_RESOURCE_INFO.
    name String
    Name of the shard.
    peerCloudAutonomousVmClusterId String
    Identifier of the peer cloudAutonomousVmCluster for the shard.
    shardGroup String
    Name of the shard-group to which the shard belongs.
    status String
    Status of shard or catalog or gsm for the sharded database.
    supportingResourceId String
    Identifier of the underlying supporting resource.
    timeCreated String
    The time the the Sharded Database was created. An RFC3339 formatted datetime string
    timeSslCertificateExpires String
    The time the ssl certificate associated with shard expires. An RFC3339 formatted datetime string
    timeUpdated String
    The time the Sharded Database was last updated. An RFC3339 formatted datetime string

    GetShardedDatabaseCatalogDetailEncryptionKeyDetail

    KmsKeyId string
    The OCID of the KMS key in vault identified by vaultId in customer tenancy that is used as the master encryption key.
    KmsKeyVersionId string
    The OCID of the KMS key version for key identified by kmsKeyId that is used in data encryption (TDE) operations.
    VaultId string
    The OCID of the vault in customer tenancy where KMS key is present. For shard or catalog with cross-region data guard enabled, user needs to make sure to provide virtual private vault only, which is also replicated in the region of standby shard.
    KmsKeyId string
    The OCID of the KMS key in vault identified by vaultId in customer tenancy that is used as the master encryption key.
    KmsKeyVersionId string
    The OCID of the KMS key version for key identified by kmsKeyId that is used in data encryption (TDE) operations.
    VaultId string
    The OCID of the vault in customer tenancy where KMS key is present. For shard or catalog with cross-region data guard enabled, user needs to make sure to provide virtual private vault only, which is also replicated in the region of standby shard.
    kmsKeyId String
    The OCID of the KMS key in vault identified by vaultId in customer tenancy that is used as the master encryption key.
    kmsKeyVersionId String
    The OCID of the KMS key version for key identified by kmsKeyId that is used in data encryption (TDE) operations.
    vaultId String
    The OCID of the vault in customer tenancy where KMS key is present. For shard or catalog with cross-region data guard enabled, user needs to make sure to provide virtual private vault only, which is also replicated in the region of standby shard.
    kmsKeyId string
    The OCID of the KMS key in vault identified by vaultId in customer tenancy that is used as the master encryption key.
    kmsKeyVersionId string
    The OCID of the KMS key version for key identified by kmsKeyId that is used in data encryption (TDE) operations.
    vaultId string
    The OCID of the vault in customer tenancy where KMS key is present. For shard or catalog with cross-region data guard enabled, user needs to make sure to provide virtual private vault only, which is also replicated in the region of standby shard.
    kms_key_id str
    The OCID of the KMS key in vault identified by vaultId in customer tenancy that is used as the master encryption key.
    kms_key_version_id str
    The OCID of the KMS key version for key identified by kmsKeyId that is used in data encryption (TDE) operations.
    vault_id str
    The OCID of the vault in customer tenancy where KMS key is present. For shard or catalog with cross-region data guard enabled, user needs to make sure to provide virtual private vault only, which is also replicated in the region of standby shard.
    kmsKeyId String
    The OCID of the KMS key in vault identified by vaultId in customer tenancy that is used as the master encryption key.
    kmsKeyVersionId String
    The OCID of the KMS key version for key identified by kmsKeyId that is used in data encryption (TDE) operations.
    vaultId String
    The OCID of the vault in customer tenancy where KMS key is present. For shard or catalog with cross-region data guard enabled, user needs to make sure to provide virtual private vault only, which is also replicated in the region of standby shard.

    GetShardedDatabaseConnectionString

    AllConnectionStrings Dictionary<string, string>
    Collection of connection strings.
    AllConnectionStrings map[string]string
    Collection of connection strings.
    allConnectionStrings Map<String,String>
    Collection of connection strings.
    allConnectionStrings {[key: string]: string}
    Collection of connection strings.
    all_connection_strings Mapping[str, str]
    Collection of connection strings.
    allConnectionStrings Map<String>
    Collection of connection strings.

    GetShardedDatabaseGsm

    ComputeCount double
    The compute amount available to the underlying autonomous database associated with shard.
    DataStorageSizeInGbs double
    The data disk group size to be allocated in GBs.
    Metadata Dictionary<string, string>
    Comma separated names of argument corresponding to which metadata need to be retrived, namely VM_CLUSTER_INFO, ADDITIONAL_RESOURCE_INFO. An example is metadata=VM_CLUSTER_INFO,ADDITIONAL_RESOURCE_INFO.
    Name string
    Name of the shard.
    Status string
    Status of shard or catalog or gsm for the sharded database.
    SupportingResourceId string
    Identifier of the underlying supporting resource.
    TimeCreated string
    The time the the Sharded Database was created. An RFC3339 formatted datetime string
    TimeSslCertificateExpires string
    The time the ssl certificate associated with shard expires. An RFC3339 formatted datetime string
    TimeUpdated string
    The time the Sharded Database was last updated. An RFC3339 formatted datetime string
    ComputeCount float64
    The compute amount available to the underlying autonomous database associated with shard.
    DataStorageSizeInGbs float64
    The data disk group size to be allocated in GBs.
    Metadata map[string]string
    Comma separated names of argument corresponding to which metadata need to be retrived, namely VM_CLUSTER_INFO, ADDITIONAL_RESOURCE_INFO. An example is metadata=VM_CLUSTER_INFO,ADDITIONAL_RESOURCE_INFO.
    Name string
    Name of the shard.
    Status string
    Status of shard or catalog or gsm for the sharded database.
    SupportingResourceId string
    Identifier of the underlying supporting resource.
    TimeCreated string
    The time the the Sharded Database was created. An RFC3339 formatted datetime string
    TimeSslCertificateExpires string
    The time the ssl certificate associated with shard expires. An RFC3339 formatted datetime string
    TimeUpdated string
    The time the Sharded Database was last updated. An RFC3339 formatted datetime string
    computeCount Double
    The compute amount available to the underlying autonomous database associated with shard.
    dataStorageSizeInGbs Double
    The data disk group size to be allocated in GBs.
    metadata Map<String,String>
    Comma separated names of argument corresponding to which metadata need to be retrived, namely VM_CLUSTER_INFO, ADDITIONAL_RESOURCE_INFO. An example is metadata=VM_CLUSTER_INFO,ADDITIONAL_RESOURCE_INFO.
    name String
    Name of the shard.
    status String
    Status of shard or catalog or gsm for the sharded database.
    supportingResourceId String
    Identifier of the underlying supporting resource.
    timeCreated String
    The time the the Sharded Database was created. An RFC3339 formatted datetime string
    timeSslCertificateExpires String
    The time the ssl certificate associated with shard expires. An RFC3339 formatted datetime string
    timeUpdated String
    The time the Sharded Database was last updated. An RFC3339 formatted datetime string
    computeCount number
    The compute amount available to the underlying autonomous database associated with shard.
    dataStorageSizeInGbs number
    The data disk group size to be allocated in GBs.
    metadata {[key: string]: string}
    Comma separated names of argument corresponding to which metadata need to be retrived, namely VM_CLUSTER_INFO, ADDITIONAL_RESOURCE_INFO. An example is metadata=VM_CLUSTER_INFO,ADDITIONAL_RESOURCE_INFO.
    name string
    Name of the shard.
    status string
    Status of shard or catalog or gsm for the sharded database.
    supportingResourceId string
    Identifier of the underlying supporting resource.
    timeCreated string
    The time the the Sharded Database was created. An RFC3339 formatted datetime string
    timeSslCertificateExpires string
    The time the ssl certificate associated with shard expires. An RFC3339 formatted datetime string
    timeUpdated string
    The time the Sharded Database was last updated. An RFC3339 formatted datetime string
    compute_count float
    The compute amount available to the underlying autonomous database associated with shard.
    data_storage_size_in_gbs float
    The data disk group size to be allocated in GBs.
    metadata Mapping[str, str]
    Comma separated names of argument corresponding to which metadata need to be retrived, namely VM_CLUSTER_INFO, ADDITIONAL_RESOURCE_INFO. An example is metadata=VM_CLUSTER_INFO,ADDITIONAL_RESOURCE_INFO.
    name str
    Name of the shard.
    status str
    Status of shard or catalog or gsm for the sharded database.
    supporting_resource_id str
    Identifier of the underlying supporting resource.
    time_created str
    The time the the Sharded Database was created. An RFC3339 formatted datetime string
    time_ssl_certificate_expires str
    The time the ssl certificate associated with shard expires. An RFC3339 formatted datetime string
    time_updated str
    The time the Sharded Database was last updated. An RFC3339 formatted datetime string
    computeCount Number
    The compute amount available to the underlying autonomous database associated with shard.
    dataStorageSizeInGbs Number
    The data disk group size to be allocated in GBs.
    metadata Map<String>
    Comma separated names of argument corresponding to which metadata need to be retrived, namely VM_CLUSTER_INFO, ADDITIONAL_RESOURCE_INFO. An example is metadata=VM_CLUSTER_INFO,ADDITIONAL_RESOURCE_INFO.
    name String
    Name of the shard.
    status String
    Status of shard or catalog or gsm for the sharded database.
    supportingResourceId String
    Identifier of the underlying supporting resource.
    timeCreated String
    The time the the Sharded Database was created. An RFC3339 formatted datetime string
    timeSslCertificateExpires String
    The time the ssl certificate associated with shard expires. An RFC3339 formatted datetime string
    timeUpdated String
    The time the Sharded Database was last updated. An RFC3339 formatted datetime string

    GetShardedDatabasePatchOperation

    Operation string
    Selection string
    Value string
    Operation string
    Selection string
    Value string
    operation String
    selection String
    value String
    operation string
    selection string
    value string
    operation String
    selection String
    value String

    GetShardedDatabaseShardDetail

    AdminPassword string
    CloudAutonomousVmClusterId string
    Identifier of the primary cloudAutonomousVmCluster for the shard.
    ComputeCount double
    The compute amount available to the underlying autonomous database associated with shard.
    ContainerDatabaseId string
    Identifier of the underlying container database.
    ContainerDatabaseParentId string
    Identifier of the underlying container database parent.
    DataStorageSizeInGbs double
    The data disk group size to be allocated in GBs.
    EncryptionKeyDetails List<GetShardedDatabaseShardDetailEncryptionKeyDetail>
    Details of encryption key to be used to encrypt data for shards and catalog for sharded database. For system-defined sharding type, all shards have to use same encryptionKeyDetails. For system-defined sharding, if encryptionKeyDetails are not specified for catalog, then Oracle managed key will be used for catalog. For user-defined sharding type, if encryptionKeyDetails are not provided for any shard or catalog, then Oracle managed key will be used for such shard or catalog. For system-defined or user-defined sharding type, if the shard or catalog has a peer in region other than primary shard or catalog region, then make sure to provide virtual vault for such shard or catalog, which is also replicated to peer region (the region where peer or standby shard or catalog exists).
    IsAutoScalingEnabled bool
    Determines the auto-scaling mode.
    Metadata Dictionary<string, string>
    Comma separated names of argument corresponding to which metadata need to be retrived, namely VM_CLUSTER_INFO, ADDITIONAL_RESOURCE_INFO. An example is metadata=VM_CLUSTER_INFO,ADDITIONAL_RESOURCE_INFO.
    Name string
    Name of the shard.
    PeerCloudAutonomousVmClusterId string
    Identifier of the peer cloudAutonomousVmCluster for the shard.
    ShardGroup string
    Name of the shard-group to which the shard belongs.
    ShardSpace string
    Shard space name.
    Status string
    Status of shard or catalog or gsm for the sharded database.
    SupportingResourceId string
    Identifier of the underlying supporting resource.
    TimeCreated string
    The time the the Sharded Database was created. An RFC3339 formatted datetime string
    TimeSslCertificateExpires string
    The time the ssl certificate associated with shard expires. An RFC3339 formatted datetime string
    TimeUpdated string
    The time the Sharded Database was last updated. An RFC3339 formatted datetime string
    AdminPassword string
    CloudAutonomousVmClusterId string
    Identifier of the primary cloudAutonomousVmCluster for the shard.
    ComputeCount float64
    The compute amount available to the underlying autonomous database associated with shard.
    ContainerDatabaseId string
    Identifier of the underlying container database.
    ContainerDatabaseParentId string
    Identifier of the underlying container database parent.
    DataStorageSizeInGbs float64
    The data disk group size to be allocated in GBs.
    EncryptionKeyDetails []GetShardedDatabaseShardDetailEncryptionKeyDetail
    Details of encryption key to be used to encrypt data for shards and catalog for sharded database. For system-defined sharding type, all shards have to use same encryptionKeyDetails. For system-defined sharding, if encryptionKeyDetails are not specified for catalog, then Oracle managed key will be used for catalog. For user-defined sharding type, if encryptionKeyDetails are not provided for any shard or catalog, then Oracle managed key will be used for such shard or catalog. For system-defined or user-defined sharding type, if the shard or catalog has a peer in region other than primary shard or catalog region, then make sure to provide virtual vault for such shard or catalog, which is also replicated to peer region (the region where peer or standby shard or catalog exists).
    IsAutoScalingEnabled bool
    Determines the auto-scaling mode.
    Metadata map[string]string
    Comma separated names of argument corresponding to which metadata need to be retrived, namely VM_CLUSTER_INFO, ADDITIONAL_RESOURCE_INFO. An example is metadata=VM_CLUSTER_INFO,ADDITIONAL_RESOURCE_INFO.
    Name string
    Name of the shard.
    PeerCloudAutonomousVmClusterId string
    Identifier of the peer cloudAutonomousVmCluster for the shard.
    ShardGroup string
    Name of the shard-group to which the shard belongs.
    ShardSpace string
    Shard space name.
    Status string
    Status of shard or catalog or gsm for the sharded database.
    SupportingResourceId string
    Identifier of the underlying supporting resource.
    TimeCreated string
    The time the the Sharded Database was created. An RFC3339 formatted datetime string
    TimeSslCertificateExpires string
    The time the ssl certificate associated with shard expires. An RFC3339 formatted datetime string
    TimeUpdated string
    The time the Sharded Database was last updated. An RFC3339 formatted datetime string
    adminPassword String
    cloudAutonomousVmClusterId String
    Identifier of the primary cloudAutonomousVmCluster for the shard.
    computeCount Double
    The compute amount available to the underlying autonomous database associated with shard.
    containerDatabaseId String
    Identifier of the underlying container database.
    containerDatabaseParentId String
    Identifier of the underlying container database parent.
    dataStorageSizeInGbs Double
    The data disk group size to be allocated in GBs.
    encryptionKeyDetails List<GetShardedDatabaseShardDetailEncryptionKeyDetail>
    Details of encryption key to be used to encrypt data for shards and catalog for sharded database. For system-defined sharding type, all shards have to use same encryptionKeyDetails. For system-defined sharding, if encryptionKeyDetails are not specified for catalog, then Oracle managed key will be used for catalog. For user-defined sharding type, if encryptionKeyDetails are not provided for any shard or catalog, then Oracle managed key will be used for such shard or catalog. For system-defined or user-defined sharding type, if the shard or catalog has a peer in region other than primary shard or catalog region, then make sure to provide virtual vault for such shard or catalog, which is also replicated to peer region (the region where peer or standby shard or catalog exists).
    isAutoScalingEnabled Boolean
    Determines the auto-scaling mode.
    metadata Map<String,String>
    Comma separated names of argument corresponding to which metadata need to be retrived, namely VM_CLUSTER_INFO, ADDITIONAL_RESOURCE_INFO. An example is metadata=VM_CLUSTER_INFO,ADDITIONAL_RESOURCE_INFO.
    name String
    Name of the shard.
    peerCloudAutonomousVmClusterId String
    Identifier of the peer cloudAutonomousVmCluster for the shard.
    shardGroup String
    Name of the shard-group to which the shard belongs.
    shardSpace String
    Shard space name.
    status String
    Status of shard or catalog or gsm for the sharded database.
    supportingResourceId String
    Identifier of the underlying supporting resource.
    timeCreated String
    The time the the Sharded Database was created. An RFC3339 formatted datetime string
    timeSslCertificateExpires String
    The time the ssl certificate associated with shard expires. An RFC3339 formatted datetime string
    timeUpdated String
    The time the Sharded Database was last updated. An RFC3339 formatted datetime string
    adminPassword string
    cloudAutonomousVmClusterId string
    Identifier of the primary cloudAutonomousVmCluster for the shard.
    computeCount number
    The compute amount available to the underlying autonomous database associated with shard.
    containerDatabaseId string
    Identifier of the underlying container database.
    containerDatabaseParentId string
    Identifier of the underlying container database parent.
    dataStorageSizeInGbs number
    The data disk group size to be allocated in GBs.
    encryptionKeyDetails GetShardedDatabaseShardDetailEncryptionKeyDetail[]
    Details of encryption key to be used to encrypt data for shards and catalog for sharded database. For system-defined sharding type, all shards have to use same encryptionKeyDetails. For system-defined sharding, if encryptionKeyDetails are not specified for catalog, then Oracle managed key will be used for catalog. For user-defined sharding type, if encryptionKeyDetails are not provided for any shard or catalog, then Oracle managed key will be used for such shard or catalog. For system-defined or user-defined sharding type, if the shard or catalog has a peer in region other than primary shard or catalog region, then make sure to provide virtual vault for such shard or catalog, which is also replicated to peer region (the region where peer or standby shard or catalog exists).
    isAutoScalingEnabled boolean
    Determines the auto-scaling mode.
    metadata {[key: string]: string}
    Comma separated names of argument corresponding to which metadata need to be retrived, namely VM_CLUSTER_INFO, ADDITIONAL_RESOURCE_INFO. An example is metadata=VM_CLUSTER_INFO,ADDITIONAL_RESOURCE_INFO.
    name string
    Name of the shard.
    peerCloudAutonomousVmClusterId string
    Identifier of the peer cloudAutonomousVmCluster for the shard.
    shardGroup string
    Name of the shard-group to which the shard belongs.
    shardSpace string
    Shard space name.
    status string
    Status of shard or catalog or gsm for the sharded database.
    supportingResourceId string
    Identifier of the underlying supporting resource.
    timeCreated string
    The time the the Sharded Database was created. An RFC3339 formatted datetime string
    timeSslCertificateExpires string
    The time the ssl certificate associated with shard expires. An RFC3339 formatted datetime string
    timeUpdated string
    The time the Sharded Database was last updated. An RFC3339 formatted datetime string
    admin_password str
    cloud_autonomous_vm_cluster_id str
    Identifier of the primary cloudAutonomousVmCluster for the shard.
    compute_count float
    The compute amount available to the underlying autonomous database associated with shard.
    container_database_id str
    Identifier of the underlying container database.
    container_database_parent_id str
    Identifier of the underlying container database parent.
    data_storage_size_in_gbs float
    The data disk group size to be allocated in GBs.
    encryption_key_details Sequence[globallydistributeddatabase.GetShardedDatabaseShardDetailEncryptionKeyDetail]
    Details of encryption key to be used to encrypt data for shards and catalog for sharded database. For system-defined sharding type, all shards have to use same encryptionKeyDetails. For system-defined sharding, if encryptionKeyDetails are not specified for catalog, then Oracle managed key will be used for catalog. For user-defined sharding type, if encryptionKeyDetails are not provided for any shard or catalog, then Oracle managed key will be used for such shard or catalog. For system-defined or user-defined sharding type, if the shard or catalog has a peer in region other than primary shard or catalog region, then make sure to provide virtual vault for such shard or catalog, which is also replicated to peer region (the region where peer or standby shard or catalog exists).
    is_auto_scaling_enabled bool
    Determines the auto-scaling mode.
    metadata Mapping[str, str]
    Comma separated names of argument corresponding to which metadata need to be retrived, namely VM_CLUSTER_INFO, ADDITIONAL_RESOURCE_INFO. An example is metadata=VM_CLUSTER_INFO,ADDITIONAL_RESOURCE_INFO.
    name str
    Name of the shard.
    peer_cloud_autonomous_vm_cluster_id str
    Identifier of the peer cloudAutonomousVmCluster for the shard.
    shard_group str
    Name of the shard-group to which the shard belongs.
    shard_space str
    Shard space name.
    status str
    Status of shard or catalog or gsm for the sharded database.
    supporting_resource_id str
    Identifier of the underlying supporting resource.
    time_created str
    The time the the Sharded Database was created. An RFC3339 formatted datetime string
    time_ssl_certificate_expires str
    The time the ssl certificate associated with shard expires. An RFC3339 formatted datetime string
    time_updated str
    The time the Sharded Database was last updated. An RFC3339 formatted datetime string
    adminPassword String
    cloudAutonomousVmClusterId String
    Identifier of the primary cloudAutonomousVmCluster for the shard.
    computeCount Number
    The compute amount available to the underlying autonomous database associated with shard.
    containerDatabaseId String
    Identifier of the underlying container database.
    containerDatabaseParentId String
    Identifier of the underlying container database parent.
    dataStorageSizeInGbs Number
    The data disk group size to be allocated in GBs.
    encryptionKeyDetails List<Property Map>
    Details of encryption key to be used to encrypt data for shards and catalog for sharded database. For system-defined sharding type, all shards have to use same encryptionKeyDetails. For system-defined sharding, if encryptionKeyDetails are not specified for catalog, then Oracle managed key will be used for catalog. For user-defined sharding type, if encryptionKeyDetails are not provided for any shard or catalog, then Oracle managed key will be used for such shard or catalog. For system-defined or user-defined sharding type, if the shard or catalog has a peer in region other than primary shard or catalog region, then make sure to provide virtual vault for such shard or catalog, which is also replicated to peer region (the region where peer or standby shard or catalog exists).
    isAutoScalingEnabled Boolean
    Determines the auto-scaling mode.
    metadata Map<String>
    Comma separated names of argument corresponding to which metadata need to be retrived, namely VM_CLUSTER_INFO, ADDITIONAL_RESOURCE_INFO. An example is metadata=VM_CLUSTER_INFO,ADDITIONAL_RESOURCE_INFO.
    name String
    Name of the shard.
    peerCloudAutonomousVmClusterId String
    Identifier of the peer cloudAutonomousVmCluster for the shard.
    shardGroup String
    Name of the shard-group to which the shard belongs.
    shardSpace String
    Shard space name.
    status String
    Status of shard or catalog or gsm for the sharded database.
    supportingResourceId String
    Identifier of the underlying supporting resource.
    timeCreated String
    The time the the Sharded Database was created. An RFC3339 formatted datetime string
    timeSslCertificateExpires String
    The time the ssl certificate associated with shard expires. An RFC3339 formatted datetime string
    timeUpdated String
    The time the Sharded Database was last updated. An RFC3339 formatted datetime string

    GetShardedDatabaseShardDetailEncryptionKeyDetail

    KmsKeyId string
    The OCID of the KMS key in vault identified by vaultId in customer tenancy that is used as the master encryption key.
    KmsKeyVersionId string
    The OCID of the KMS key version for key identified by kmsKeyId that is used in data encryption (TDE) operations.
    VaultId string
    The OCID of the vault in customer tenancy where KMS key is present. For shard or catalog with cross-region data guard enabled, user needs to make sure to provide virtual private vault only, which is also replicated in the region of standby shard.
    KmsKeyId string
    The OCID of the KMS key in vault identified by vaultId in customer tenancy that is used as the master encryption key.
    KmsKeyVersionId string
    The OCID of the KMS key version for key identified by kmsKeyId that is used in data encryption (TDE) operations.
    VaultId string
    The OCID of the vault in customer tenancy where KMS key is present. For shard or catalog with cross-region data guard enabled, user needs to make sure to provide virtual private vault only, which is also replicated in the region of standby shard.
    kmsKeyId String
    The OCID of the KMS key in vault identified by vaultId in customer tenancy that is used as the master encryption key.
    kmsKeyVersionId String
    The OCID of the KMS key version for key identified by kmsKeyId that is used in data encryption (TDE) operations.
    vaultId String
    The OCID of the vault in customer tenancy where KMS key is present. For shard or catalog with cross-region data guard enabled, user needs to make sure to provide virtual private vault only, which is also replicated in the region of standby shard.
    kmsKeyId string
    The OCID of the KMS key in vault identified by vaultId in customer tenancy that is used as the master encryption key.
    kmsKeyVersionId string
    The OCID of the KMS key version for key identified by kmsKeyId that is used in data encryption (TDE) operations.
    vaultId string
    The OCID of the vault in customer tenancy where KMS key is present. For shard or catalog with cross-region data guard enabled, user needs to make sure to provide virtual private vault only, which is also replicated in the region of standby shard.
    kms_key_id str
    The OCID of the KMS key in vault identified by vaultId in customer tenancy that is used as the master encryption key.
    kms_key_version_id str
    The OCID of the KMS key version for key identified by kmsKeyId that is used in data encryption (TDE) operations.
    vault_id str
    The OCID of the vault in customer tenancy where KMS key is present. For shard or catalog with cross-region data guard enabled, user needs to make sure to provide virtual private vault only, which is also replicated in the region of standby shard.
    kmsKeyId String
    The OCID of the KMS key in vault identified by vaultId in customer tenancy that is used as the master encryption key.
    kmsKeyVersionId String
    The OCID of the KMS key version for key identified by kmsKeyId that is used in data encryption (TDE) operations.
    vaultId String
    The OCID of the vault in customer tenancy where KMS key is present. For shard or catalog with cross-region data guard enabled, user needs to make sure to provide virtual private vault only, which is also replicated in the region of standby shard.

    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 v2.27.0 published on Thursday, Mar 20, 2025 by Pulumi
    pulumi/pulumi-oci