Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi
oci.GloballyDistributedDatabase.getShardedDatabases
Explore with Pulumi AI
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:
- Compartment
Id string - The ID of the compartment in which to list resources.
- Display
Name string - A filter to return only sharded databases that match the entire name given. The match is not case sensitive.
- Filters
List<Get
Sharded Databases Filter> - State string
- A filter to return only resources their lifecycleState matches the given lifecycleState.
- Compartment
Id string - The ID of the compartment in which to list resources.
- Display
Name string - A filter to return only sharded databases that match the entire name given. The match is not case sensitive.
- Filters
[]Get
Sharded Databases Filter - State string
- A filter to return only resources their lifecycleState matches the given lifecycleState.
- compartment
Id String - The ID of the compartment in which to list resources.
- display
Name String - A filter to return only sharded databases that match the entire name given. The match is not case sensitive.
- filters
List<Get
Sharded Databases Filter> - state String
- A filter to return only resources their lifecycleState matches the given lifecycleState.
- compartment
Id string - The ID of the compartment in which to list resources.
- display
Name string - A filter to return only sharded databases that match the entire name given. The match is not case sensitive.
- filters
Get
Sharded Databases Filter[] - 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.
Get Sharded Databases Filter] - state str
- A filter to return only resources their lifecycleState matches the given lifecycleState.
- compartment
Id String - The ID of the compartment in which to list resources.
- display
Name 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:
- Compartment
Id string - Identifier of the compartment in which sharded database exists.
- Id string
- The provider-assigned unique ID for this managed resource.
- List<Get
Sharded Databases Sharded Database Collection> - The list of sharded_database_collection.
- Display
Name string - Oracle sharded database display name.
- Filters
List<Get
Sharded Databases Filter> - State string
- Lifecycle states for sharded databases.
- Compartment
Id string - Identifier of the compartment in which sharded database exists.
- Id string
- The provider-assigned unique ID for this managed resource.
- []Get
Sharded Databases Sharded Database Collection - The list of sharded_database_collection.
- Display
Name string - Oracle sharded database display name.
- Filters
[]Get
Sharded Databases Filter - State string
- Lifecycle states for sharded databases.
- compartment
Id String - Identifier of the compartment in which sharded database exists.
- id String
- The provider-assigned unique ID for this managed resource.
- List<Get
Sharded Databases Sharded Database Collection> - The list of sharded_database_collection.
- display
Name String - Oracle sharded database display name.
- filters
List<Get
Sharded Databases Filter> - state String
- Lifecycle states for sharded databases.
- compartment
Id string - Identifier of the compartment in which sharded database exists.
- id string
- The provider-assigned unique ID for this managed resource.
- Get
Sharded Databases Sharded Database Collection[] - The list of sharded_database_collection.
- display
Name string - Oracle sharded database display name.
- filters
Get
Sharded Databases Filter[] - 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.
- Sequence[globallydistributeddatabase.
Get Sharded Databases Sharded Database Collection] - The list of sharded_database_collection.
- display_
name str - Oracle sharded database display name.
- filters
Sequence[globallydistributeddatabase.
Get Sharded Databases Filter] - state str
- Lifecycle states for sharded databases.
- compartment
Id String - Identifier of the compartment in which sharded database exists.
- id String
- The provider-assigned unique ID for this managed resource.
- List<Property Map>
- The list of sharded_database_collection.
- display
Name String - Oracle sharded database display name.
- filters List<Property Map>
- state String
- Lifecycle states for sharded databases.
Supporting Types
GetShardedDatabasesFilter
GetShardedDatabasesShardedDatabaseCollection
GetShardedDatabasesShardedDatabaseCollectionItem
- Character
Set 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.
- Cluster
Certificate stringCommon Name - 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 string - The ID of the compartment in which to list resources.
- Db
Deployment stringType - The database deployment type.
- Db
Version string - Oracle Database version number.
- Db
Workload string - Possible workload types.
- Dictionary<string, string>
- Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- Display
Name string - A filter to return only sharded databases that match the entire name given. The match is not case sensitive.
- 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
- Lifecycle
State string - Lifecycle
State stringDetails - Detailed message for the lifecycle state.
- Listener
Port int - The GSM listener port number.
- Listener
Port intTls - The TLS listener port number for sharded database.
- Ncharacter
Set string - The national character set for the database.
- Ons
Port intLocal - Ons local port number.
- Ons
Port intRemote - Ons remote port number.
- Prefix string
- Unique prefix for 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 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.
- Replication
Unit int - For RAFT replication based sharded database, the value should be atleast twice the number of shards.
- string
- Sharding Method.
- State string
- A filter to return only resources their lifecycleState matches the given lifecycleState.
- Dictionary<string, string>
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"}
- Time
Created string - The time the the Sharded Database was created. An RFC3339 formatted datetime string
- Time
Updated string - The time the Sharded Database was last updated. An RFC3339 formatted datetime string
- Total
Cpu doubleCount - Total
Data doubleStorage Size In Gbs
- Character
Set 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.
- Cluster
Certificate stringCommon Name - 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 string - The ID of the compartment in which to list resources.
- Db
Deployment stringType - The database deployment type.
- Db
Version string - Oracle Database version number.
- Db
Workload string - Possible workload types.
- map[string]string
- Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- Display
Name string - A filter to return only sharded databases that match the entire name given. The match is not case sensitive.
- 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
- Lifecycle
State string - Lifecycle
State stringDetails - Detailed message for the lifecycle state.
- Listener
Port int - The GSM listener port number.
- Listener
Port intTls - The TLS listener port number for sharded database.
- Ncharacter
Set string - The national character set for the database.
- Ons
Port intLocal - Ons local port number.
- Ons
Port intRemote - Ons remote port number.
- Prefix string
- Unique prefix for 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 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.
- Replication
Unit int - For RAFT replication based sharded database, the value should be atleast twice the number of shards.
- string
- Sharding Method.
- State string
- A filter to return only resources their lifecycleState matches the given lifecycleState.
- map[string]string
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"}
- Time
Created string - The time the the Sharded Database was created. An RFC3339 formatted datetime string
- Time
Updated string - The time the Sharded Database was last updated. An RFC3339 formatted datetime string
- Total
Cpu float64Count - Total
Data float64Storage Size In Gbs
- character
Set 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.
- cluster
Certificate StringCommon Name - 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 String - The ID of the compartment in which to list resources.
- db
Deployment StringType - The database deployment type.
- db
Version String - Oracle Database version number.
- db
Workload String - Possible workload types.
- Map<String,String>
- Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- display
Name String - A filter to return only sharded databases that match the entire name given. The match is not case sensitive.
- 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
- lifecycle
State String - lifecycle
State StringDetails - Detailed message for the lifecycle state.
- listener
Port Integer - The GSM listener port number.
- listener
Port IntegerTls - The TLS listener port number for sharded database.
- ncharacter
Set String - The national character set for the database.
- ons
Port IntegerLocal - Ons local port number.
- ons
Port IntegerRemote - Ons remote port number.
- prefix String
- Unique prefix for the sharded database.
- replication
Factor Integer - The Replication factor for RAFT replication based sharded database. Currently supported values are 3, 5 and 7.
- replication
Method 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.
- replication
Unit Integer - For RAFT replication based sharded database, the value should be atleast twice the number of shards.
- String
- Sharding Method.
- state String
- A filter to return only resources their lifecycleState matches the given lifecycleState.
- Map<String,String>
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"}
- time
Created String - The time the the Sharded Database was created. An RFC3339 formatted datetime string
- time
Updated String - The time the Sharded Database was last updated. An RFC3339 formatted datetime string
- total
Cpu DoubleCount - total
Data DoubleStorage Size In Gbs
- character
Set 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.
- cluster
Certificate stringCommon Name - 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 string - The ID of the compartment in which to list resources.
- db
Deployment stringType - The database deployment type.
- db
Version string - Oracle Database version number.
- db
Workload string - Possible workload types.
- {[key: string]: string}
- Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- display
Name string - A filter to return only sharded databases that match the entire name given. The match is not case sensitive.
- {[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
- lifecycle
State string - lifecycle
State stringDetails - Detailed message for the lifecycle state.
- listener
Port number - The GSM listener port number.
- listener
Port numberTls - The TLS listener port number for sharded database.
- ncharacter
Set string - The national character set for the database.
- ons
Port numberLocal - Ons local port number.
- ons
Port numberRemote - Ons remote port number.
- prefix string
- Unique prefix for the sharded database.
- replication
Factor number - The Replication factor for RAFT replication based sharded database. Currently supported values are 3, 5 and 7.
- replication
Method 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.
- replication
Unit number - For RAFT replication based sharded database, the value should be atleast twice the number of shards.
- string
- Sharding Method.
- state string
- A filter to return only resources their lifecycleState matches the given lifecycleState.
- {[key: string]: string}
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"}
- time
Created string - The time the the Sharded Database was created. An RFC3339 formatted datetime string
- time
Updated string - The time the Sharded Database was last updated. An RFC3339 formatted datetime string
- total
Cpu numberCount - total
Data numberStorage Size In Gbs
- 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_ strcommon_ name - 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_ strtype - The database deployment type.
- db_
version str - Oracle Database version number.
- db_
workload str - Possible workload types.
- 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.
- 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_ strdetails - Detailed message for the lifecycle state.
- listener_
port int - The GSM listener port number.
- listener_
port_ inttls - The TLS listener port number for sharded database.
- ncharacter_
set str - The national character set for the database.
- ons_
port_ intlocal - Ons local port number.
- ons_
port_ intremote - Ons remote port number.
- prefix str
- Unique prefix for 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.
- str
- Sharding Method.
- state str
- A filter to return only resources their lifecycleState matches the given lifecycleState.
- 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_ floatcount - total_
data_ floatstorage_ size_ in_ gbs
- character
Set 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.
- cluster
Certificate StringCommon Name - 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 String - The ID of the compartment in which to list resources.
- db
Deployment StringType - The database deployment type.
- db
Version String - Oracle Database version number.
- db
Workload String - Possible workload types.
- Map<String>
- Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- display
Name String - A filter to return only sharded databases that match the entire name given. The match is not case sensitive.
- 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
- lifecycle
State String - lifecycle
State StringDetails - Detailed message for the lifecycle state.
- listener
Port Number - The GSM listener port number.
- listener
Port NumberTls - The TLS listener port number for sharded database.
- ncharacter
Set String - The national character set for the database.
- ons
Port NumberLocal - Ons local port number.
- ons
Port NumberRemote - Ons remote port number.
- prefix String
- Unique prefix for the sharded database.
- replication
Factor Number - The Replication factor for RAFT replication based sharded database. Currently supported values are 3, 5 and 7.
- replication
Method 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.
- replication
Unit Number - For RAFT replication based sharded database, the value should be atleast twice the number of shards.
- String
- Sharding Method.
- state String
- A filter to return only resources their lifecycleState matches the given lifecycleState.
- Map<String>
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"}
- time
Created String - The time the the Sharded Database was created. An RFC3339 formatted datetime string
- time
Updated String - The time the Sharded Database was last updated. An RFC3339 formatted datetime string
- total
Cpu NumberCount - total
Data NumberStorage Size In Gbs
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
oci
Terraform Provider.