Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. GloballyDistributedDatabase
  5. getShardedDatabases
Oracle Cloud Infrastructure v2.11.0 published on Thursday, Sep 19, 2024 by Pulumi
pulumi/pulumi-oci

oci.GloballyDistributedDatabase.getShardedDatabases

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.11.0 published on Thursday, Sep 19, 2024 by Pulumi
pulumi/pulumi-oci

    This data source provides the list of Sharded Databases in Oracle Cloud Infrastructure Globally Distributed Database service.

    List of Sharded databases.

    Example Usage

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

const testShardedDatabases = oci.GloballyDistributedDatabase.getShardedDatabases({
    compartmentId: compartmentId,
    displayName: shardedDatabaseDisplayName,
    state: shardedDatabaseState,
});

    import pulumi
import pulumi_oci as oci

test_sharded_databases = oci.GloballyDistributedDatabase.get_sharded_databases(compartment_id=compartment_id,
    display_name=sharded_database_display_name,
    state=sharded_database_state)

    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.GetShardedDatabases(ctx, &globallydistributeddatabase.GetShardedDatabasesArgs{
			CompartmentId: compartmentId,
			DisplayName:   pulumi.StringRef(shardedDatabaseDisplayName),
			State:         pulumi.StringRef(shardedDatabaseState),
		}, 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 testShardedDatabases = Oci.GloballyDistributedDatabase.GetShardedDatabases.Invoke(new()
    {
        CompartmentId = compartmentId,
        DisplayName = shardedDatabaseDisplayName,
        State = shardedDatabaseState,
    });

});

    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.GetShardedDatabasesArgs;
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 testShardedDatabases = GloballyDistributedDatabaseFunctions.getShardedDatabases(GetShardedDatabasesArgs.builder()
            .compartmentId(compartmentId)
            .displayName(shardedDatabaseDisplayName)
            .state(shardedDatabaseState)
            .build());

    }
}

    variables:
  testShardedDatabases:
    fn::invoke:
      Function: oci:GloballyDistributedDatabase:getShardedDatabases
      Arguments:
        compartmentId: ${compartmentId}
        displayName: ${shardedDatabaseDisplayName}
        state: ${shardedDatabaseState}

    Using getShardedDatabases

    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 getShardedDatabases(args: GetShardedDatabasesArgs, opts?: InvokeOptions): Promise<GetShardedDatabasesResult>
function getShardedDatabasesOutput(args: GetShardedDatabasesOutputArgs, opts?: InvokeOptions): Output<GetShardedDatabasesResult>
    def get_sharded_databases(compartment_id: Optional[str] = None,
                          display_name: Optional[str] = None,
                          filters: Optional[Sequence[_globallydistributeddatabase.GetShardedDatabasesFilter]] = None,
                          state: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetShardedDatabasesResult
def get_sharded_databases_output(compartment_id: Optional[pulumi.Input[str]] = None,
                          display_name: Optional[pulumi.Input[str]] = None,
                          filters: Optional[pulumi.Input[Sequence[pulumi.Input[_globallydistributeddatabase.GetShardedDatabasesFilterArgs]]]] = None,
                          state: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetShardedDatabasesResult]
    func GetShardedDatabases(ctx *Context, args *GetShardedDatabasesArgs, opts ...InvokeOption) (*GetShardedDatabasesResult, error)
func GetShardedDatabasesOutput(ctx *Context, args *GetShardedDatabasesOutputArgs, opts ...InvokeOption) GetShardedDatabasesResultOutput

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

    public static class GetShardedDatabases 
{
    public static Task<GetShardedDatabasesResult> InvokeAsync(GetShardedDatabasesArgs args, InvokeOptions? opts = null)
    public static Output<GetShardedDatabasesResult> Invoke(GetShardedDatabasesInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetShardedDatabasesResult> getShardedDatabases(GetShardedDatabasesArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

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

    The following arguments are supported:

    CompartmentId string
    The ID of the compartment in which to list resources.
    DisplayName string
    A filter to return only sharded databases that match the entire name given. The match is not case sensitive.
    Filters List<GetShardedDatabasesFilter>
    State string
    A filter to return only resources their lifecycleState matches the given lifecycleState.
    CompartmentId string
    The ID of the compartment in which to list resources.
    DisplayName string
    A filter to return only sharded databases that match the entire name given. The match is not case sensitive.
    Filters []GetShardedDatabasesFilter
    State string
    A filter to return only resources their lifecycleState matches the given lifecycleState.
    compartmentId String
    The ID of the compartment in which to list resources.
    displayName String
    A filter to return only sharded databases that match the entire name given. The match is not case sensitive.
    filters List<GetShardedDatabasesFilter>
    state String
    A filter to return only resources their lifecycleState matches the given lifecycleState.
    compartmentId string
    The ID of the compartment in which to list resources.
    displayName string
    A filter to return only sharded databases that match the entire name given. The match is not case sensitive.
    filters GetShardedDatabasesFilter[]
    state string
    A filter to return only resources their lifecycleState matches the given lifecycleState.
    compartment_id str
    The ID of the compartment in which to list resources.
    display_name str
    A filter to return only sharded databases that match the entire name given. The match is not case sensitive.
    filters Sequence[globallydistributeddatabase.GetShardedDatabasesFilter]
    state str
    A filter to return only resources their lifecycleState matches the given lifecycleState.
    compartmentId String
    The ID of the compartment in which to list resources.
    displayName String
    A filter to return only sharded databases that match the entire name given. The match is not case sensitive.
    filters List<Property Map>
    state String
    A filter to return only resources their lifecycleState matches the given lifecycleState.

    getShardedDatabases Result

    The following output properties are available:

    CompartmentId string
    Identifier of the compartment in which sharded database exists.
    Id string
    The provider-assigned unique ID for this managed resource.
    ShardedDatabaseCollections List<GetShardedDatabasesShardedDatabaseCollection>
    The list of sharded_database_collection.
    DisplayName string
    Oracle sharded database display name.
    Filters List<GetShardedDatabasesFilter>
    State string
    Lifecycle states for sharded databases.
    CompartmentId string
    Identifier of the compartment in which sharded database exists.
    Id string
    The provider-assigned unique ID for this managed resource.
    ShardedDatabaseCollections []GetShardedDatabasesShardedDatabaseCollection
    The list of sharded_database_collection.
    DisplayName string
    Oracle sharded database display name.
    Filters []GetShardedDatabasesFilter
    State string
    Lifecycle states for sharded databases.
    compartmentId String
    Identifier of the compartment in which sharded database exists.
    id String
    The provider-assigned unique ID for this managed resource.
    shardedDatabaseCollections List<GetShardedDatabasesShardedDatabaseCollection>
    The list of sharded_database_collection.
    displayName String
    Oracle sharded database display name.
    filters List<GetShardedDatabasesFilter>
    state String
    Lifecycle states for sharded databases.
    compartmentId string
    Identifier of the compartment in which sharded database exists.
    id string
    The provider-assigned unique ID for this managed resource.
    shardedDatabaseCollections GetShardedDatabasesShardedDatabaseCollection[]
    The list of sharded_database_collection.
    displayName string
    Oracle sharded database display name.
    filters GetShardedDatabasesFilter[]
    state string
    Lifecycle states for sharded databases.
    compartment_id str
    Identifier of the compartment in which sharded database exists.
    id str
    The provider-assigned unique ID for this managed resource.
    sharded_database_collections Sequence[globallydistributeddatabase.GetShardedDatabasesShardedDatabaseCollection]
    The list of sharded_database_collection.
    display_name str
    Oracle sharded database display name.
    filters Sequence[globallydistributeddatabase.GetShardedDatabasesFilter]
    state str
    Lifecycle states for sharded databases.
    compartmentId String
    Identifier of the compartment in which sharded database exists.
    id String
    The provider-assigned unique ID for this managed resource.
    shardedDatabaseCollections List<Property Map>
    The list of sharded_database_collection.
    displayName String
    Oracle sharded database display name.
    filters List<Property Map>
    state String
    Lifecycle states for sharded databases.

    Supporting Types

    GetShardedDatabasesFilter

    Name string
    Name of the shard.
    Values List<string>
    Regex bool
    Name string
    Name of the shard.
    Values []string
    Regex bool
    name String
    Name of the shard.
    values List<String>
    regex Boolean
    name string
    Name of the shard.
    values string[]
    regex boolean
    name str
    Name of the shard.
    values Sequence[str]
    regex bool
    name String
    Name of the shard.
    values List<String>
    regex Boolean

    GetShardedDatabasesShardedDatabaseCollection

    GetShardedDatabasesShardedDatabaseCollectionItem

    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
    The ID of the compartment in which to list resources.
    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
    A filter to return only sharded databases that match the entire name given. The match is not case sensitive.
    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"}
    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.
    Prefix string
    Unique prefix for the sharded database.
    ShardingMethod string
    Sharding Method.
    State string
    A filter to return only resources their lifecycleState matches the given lifecycleState.
    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
    TotalCpuCount double
    TotalDataStorageSizeInGbs double
    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
    The ID of the compartment in which to list resources.
    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
    A filter to return only sharded databases that match the entire name given. The match is not case sensitive.
    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"}
    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.
    Prefix string
    Unique prefix for the sharded database.
    ShardingMethod string
    Sharding Method.
    State string
    A filter to return only resources their lifecycleState matches the given lifecycleState.
    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
    TotalCpuCount float64
    TotalDataStorageSizeInGbs float64
    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
    The ID of the compartment in which to list resources.
    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
    A filter to return only sharded databases that match the entire name given. The match is not case sensitive.
    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"}
    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.
    prefix String
    Unique prefix for the sharded database.
    shardingMethod String
    Sharding Method.
    state String
    A filter to return only resources their lifecycleState matches the given lifecycleState.
    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
    totalCpuCount Double
    totalDataStorageSizeInGbs Double
    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
    The ID of the compartment in which to list resources.
    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
    A filter to return only sharded databases that match the entire name given. The match is not case sensitive.
    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"}
    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.
    prefix string
    Unique prefix for the sharded database.
    shardingMethod string
    Sharding Method.
    state string
    A filter to return only resources their lifecycleState matches the given lifecycleState.
    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
    totalCpuCount number
    totalDataStorageSizeInGbs number
    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
    The ID of the compartment in which to list resources.
    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
    A filter to return only sharded databases that match the entire name given. The match is not case sensitive.
    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"}
    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.
    prefix str
    Unique prefix for the sharded database.
    sharding_method str
    Sharding Method.
    state str
    A filter to return only resources their lifecycleState matches the given lifecycleState.
    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
    total_cpu_count float
    total_data_storage_size_in_gbs float
    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
    The ID of the compartment in which to list resources.
    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
    A filter to return only sharded databases that match the entire name given. The match is not case sensitive.
    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"}
    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.
    prefix String
    Unique prefix for the sharded database.
    shardingMethod String
    Sharding Method.
    state String
    A filter to return only resources their lifecycleState matches the given lifecycleState.
    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
    totalCpuCount Number
    totalDataStorageSizeInGbs Number

    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.11.0 published on Thursday, Sep 19, 2024 by Pulumi
    pulumi/pulumi-oci