oci.GloballyDistributedDatabase.ShardedDatabase
Explore with Pulumi AI
This resource provides the Sharded Database resource in Oracle Cloud Infrastructure Globally Distributed Database service.
Creates a Sharded Database.
Patch operation to add, remove or update shards to the sharded database topology. In single patch operation, multiple shards can be either added, or removed or updated. Combination of inserts, update and remove in single operation is not allowed.
Example Usage
Coming soon!
Coming soon!
Coming soon!
Coming soon!
Coming soon!
resources:
testShardedDatabase:
type: oci:GloballyDistributedDatabase:ShardedDatabase
name: test_sharded_database
properties:
catalogDetails:
- adminPassword: ${shardedDatabaseCatalogDetailsAdminPassword}
cloudAutonomousVmClusterId: ${testCloudAutonomousVmCluster.id}
computeCount: ${shardedDatabaseCatalogDetailsComputeCount}
dataStorageSizeInGbs: ${shardedDatabaseCatalogDetailsDataStorageSizeInGbs}
isAutoScalingEnabled: ${shardedDatabaseCatalogDetailsIsAutoScalingEnabled}
encryptionKeyDetails:
kmsKeyId: ${testKey.id}
vaultId: ${testVault.id}
kmsKeyVersionId: ${testKeyVersion.id}
peerCloudAutonomousVmClusterId: ${testCloudAutonomousVmCluster.id}
characterSet: ${shardedDatabaseCharacterSet}
compartmentId: ${compartmentId}
dbDeploymentType: ${shardedDatabaseDbDeploymentType}
dbVersion: ${shardedDatabaseDbVersion}
dbWorkload: ${shardedDatabaseDbWorkload}
displayName: ${shardedDatabaseDisplayName}
listenerPort: ${shardedDatabaseListenerPort}
listenerPortTls: ${shardedDatabaseListenerPortTls}
ncharacterSet: ${shardedDatabaseNcharacterSet}
onsPortLocal: ${shardedDatabaseOnsPortLocal}
onsPortRemote: ${shardedDatabaseOnsPortRemote}
prefix: ${shardedDatabasePrefix}
shardDetails:
- adminPassword: ${shardedDatabaseShardDetailsAdminPassword}
cloudAutonomousVmClusterId: ${testCloudAutonomousVmCluster.id}
computeCount: ${shardedDatabaseShardDetailsComputeCount}
dataStorageSizeInGbs: ${shardedDatabaseShardDetailsDataStorageSizeInGbs}
isAutoScalingEnabled: ${shardedDatabaseShardDetailsIsAutoScalingEnabled}
encryptionKeyDetails:
kmsKeyId: ${testKey.id}
vaultId: ${testVault.id}
kmsKeyVersionId: ${testKeyVersion.id}
peerCloudAutonomousVmClusterId: ${testCloudAutonomousVmCluster.id}
shardSpace: ${shardedDatabaseShardDetailsShardSpace}
shardedDatabaseId: ${shardedDatabaseShardedDatabaseId}
shardingMethod: ${shardedDatabaseShardingMethod}
chunks: ${shardedDatabaseChunks}
clusterCertificateCommonName: ${shardedDatabaseClusterCertificateCommonName}
definedTags:
foo-namespace.bar-key: value
freeformTags:
bar-key: value
patchOperations:
- operation: ${shardedDatabasePatchOperationsOperation}
selection: ${shardedDatabasePatchOperationsSelection}
value: ${shardedDatabasePatchOperationsValue}
Create ShardedDatabase Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new ShardedDatabase(name: string, args: ShardedDatabaseArgs, opts?: CustomResourceOptions);
@overload
def ShardedDatabase(resource_name: str,
args: ShardedDatabaseArgs,
opts: Optional[ResourceOptions] = None)
@overload
def ShardedDatabase(resource_name: str,
opts: Optional[ResourceOptions] = None,
ons_port_local: Optional[int] = None,
ons_port_remote: Optional[int] = None,
sharding_method: Optional[str] = None,
shard_details: Optional[Sequence[_globallydistributeddatabase.ShardedDatabaseShardDetailArgs]] = None,
compartment_id: Optional[str] = None,
character_set: Optional[str] = None,
db_deployment_type: Optional[str] = None,
db_version: Optional[str] = None,
db_workload: Optional[str] = None,
catalog_details: Optional[Sequence[_globallydistributeddatabase.ShardedDatabaseCatalogDetailArgs]] = None,
display_name: Optional[str] = None,
ncharacter_set: Optional[str] = None,
listener_port_tls: Optional[int] = None,
listener_port: Optional[int] = None,
prefix: Optional[str] = None,
validate_network_trigger: Optional[int] = None,
chunks: Optional[int] = None,
download_gsm_certificate_signing_request_trigger: Optional[int] = None,
defined_tags: Optional[Mapping[str, str]] = None,
configure_sharding_trigger: Optional[int] = None,
patch_operations: Optional[Sequence[_globallydistributeddatabase.ShardedDatabasePatchOperationArgs]] = None,
get_connection_string_trigger: Optional[int] = None,
cluster_certificate_common_name: Optional[str] = None,
freeform_tags: Optional[Mapping[str, str]] = None,
start_database_trigger: Optional[int] = None,
stop_database_trigger: Optional[int] = None,
generate_gsm_certificate_signing_request_trigger: Optional[int] = None)
func NewShardedDatabase(ctx *Context, name string, args ShardedDatabaseArgs, opts ...ResourceOption) (*ShardedDatabase, error)
public ShardedDatabase(string name, ShardedDatabaseArgs args, CustomResourceOptions? opts = null)
public ShardedDatabase(String name, ShardedDatabaseArgs args)
public ShardedDatabase(String name, ShardedDatabaseArgs args, CustomResourceOptions options)
type: oci:GloballyDistributedDatabase:ShardedDatabase
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args ShardedDatabaseArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args ShardedDatabaseArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args ShardedDatabaseArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ShardedDatabaseArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ShardedDatabaseArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var shardedDatabaseResource = new Oci.GloballyDistributedDatabase.ShardedDatabase("shardedDatabaseResource", new()
{
OnsPortLocal = 0,
OnsPortRemote = 0,
ShardingMethod = "string",
ShardDetails = new[]
{
new Oci.GloballyDistributedDatabase.Inputs.ShardedDatabaseShardDetailArgs
{
DataStorageSizeInGbs = 0,
CloudAutonomousVmClusterId = "string",
ComputeCount = 0,
AdminPassword = "string",
IsAutoScalingEnabled = false,
Metadata =
{
{ "string", "string" },
},
EncryptionKeyDetails = new Oci.GloballyDistributedDatabase.Inputs.ShardedDatabaseShardDetailEncryptionKeyDetailsArgs
{
KmsKeyId = "string",
VaultId = "string",
KmsKeyVersionId = "string",
},
ContainerDatabaseParentId = "string",
ContainerDatabaseId = "string",
Name = "string",
PeerCloudAutonomousVmClusterId = "string",
ShardGroup = "string",
ShardSpace = "string",
Status = "string",
SupportingResourceId = "string",
TimeCreated = "string",
TimeSslCertificateExpires = "string",
TimeUpdated = "string",
},
},
CompartmentId = "string",
CharacterSet = "string",
DbDeploymentType = "string",
DbVersion = "string",
DbWorkload = "string",
CatalogDetails = new[]
{
new Oci.GloballyDistributedDatabase.Inputs.ShardedDatabaseCatalogDetailArgs
{
DataStorageSizeInGbs = 0,
CloudAutonomousVmClusterId = "string",
ComputeCount = 0,
AdminPassword = "string",
IsAutoScalingEnabled = false,
Metadata =
{
{ "string", "string" },
},
EncryptionKeyDetails = new Oci.GloballyDistributedDatabase.Inputs.ShardedDatabaseCatalogDetailEncryptionKeyDetailsArgs
{
KmsKeyId = "string",
VaultId = "string",
KmsKeyVersionId = "string",
},
ContainerDatabaseParentId = "string",
ContainerDatabaseId = "string",
Name = "string",
PeerCloudAutonomousVmClusterId = "string",
ShardGroup = "string",
Status = "string",
SupportingResourceId = "string",
TimeCreated = "string",
TimeSslCertificateExpires = "string",
TimeUpdated = "string",
},
},
DisplayName = "string",
NcharacterSet = "string",
ListenerPortTls = 0,
ListenerPort = 0,
Prefix = "string",
ValidateNetworkTrigger = 0,
Chunks = 0,
DownloadGsmCertificateSigningRequestTrigger = 0,
DefinedTags =
{
{ "string", "string" },
},
ConfigureShardingTrigger = 0,
PatchOperations = new[]
{
new Oci.GloballyDistributedDatabase.Inputs.ShardedDatabasePatchOperationArgs
{
Operation = "string",
Selection = "string",
Value = "string",
},
},
GetConnectionStringTrigger = 0,
ClusterCertificateCommonName = "string",
FreeformTags =
{
{ "string", "string" },
},
StartDatabaseTrigger = 0,
StopDatabaseTrigger = 0,
GenerateGsmCertificateSigningRequestTrigger = 0,
});
example, err := GloballyDistributedDatabase.NewShardedDatabase(ctx, "shardedDatabaseResource", &GloballyDistributedDatabase.ShardedDatabaseArgs{
OnsPortLocal: pulumi.Int(0),
OnsPortRemote: pulumi.Int(0),
ShardingMethod: pulumi.String("string"),
ShardDetails: globallydistributeddatabase.ShardedDatabaseShardDetailArray{
&globallydistributeddatabase.ShardedDatabaseShardDetailArgs{
DataStorageSizeInGbs: pulumi.Float64(0),
CloudAutonomousVmClusterId: pulumi.String("string"),
ComputeCount: pulumi.Float64(0),
AdminPassword: pulumi.String("string"),
IsAutoScalingEnabled: pulumi.Bool(false),
Metadata: pulumi.StringMap{
"string": pulumi.String("string"),
},
EncryptionKeyDetails: &globallydistributeddatabase.ShardedDatabaseShardDetailEncryptionKeyDetailsArgs{
KmsKeyId: pulumi.String("string"),
VaultId: pulumi.String("string"),
KmsKeyVersionId: pulumi.String("string"),
},
ContainerDatabaseParentId: pulumi.String("string"),
ContainerDatabaseId: pulumi.String("string"),
Name: pulumi.String("string"),
PeerCloudAutonomousVmClusterId: pulumi.String("string"),
ShardGroup: pulumi.String("string"),
ShardSpace: pulumi.String("string"),
Status: pulumi.String("string"),
SupportingResourceId: pulumi.String("string"),
TimeCreated: pulumi.String("string"),
TimeSslCertificateExpires: pulumi.String("string"),
TimeUpdated: pulumi.String("string"),
},
},
CompartmentId: pulumi.String("string"),
CharacterSet: pulumi.String("string"),
DbDeploymentType: pulumi.String("string"),
DbVersion: pulumi.String("string"),
DbWorkload: pulumi.String("string"),
CatalogDetails: globallydistributeddatabase.ShardedDatabaseCatalogDetailArray{
&globallydistributeddatabase.ShardedDatabaseCatalogDetailArgs{
DataStorageSizeInGbs: pulumi.Float64(0),
CloudAutonomousVmClusterId: pulumi.String("string"),
ComputeCount: pulumi.Float64(0),
AdminPassword: pulumi.String("string"),
IsAutoScalingEnabled: pulumi.Bool(false),
Metadata: pulumi.StringMap{
"string": pulumi.String("string"),
},
EncryptionKeyDetails: &globallydistributeddatabase.ShardedDatabaseCatalogDetailEncryptionKeyDetailsArgs{
KmsKeyId: pulumi.String("string"),
VaultId: pulumi.String("string"),
KmsKeyVersionId: pulumi.String("string"),
},
ContainerDatabaseParentId: pulumi.String("string"),
ContainerDatabaseId: pulumi.String("string"),
Name: pulumi.String("string"),
PeerCloudAutonomousVmClusterId: pulumi.String("string"),
ShardGroup: pulumi.String("string"),
Status: pulumi.String("string"),
SupportingResourceId: pulumi.String("string"),
TimeCreated: pulumi.String("string"),
TimeSslCertificateExpires: pulumi.String("string"),
TimeUpdated: pulumi.String("string"),
},
},
DisplayName: pulumi.String("string"),
NcharacterSet: pulumi.String("string"),
ListenerPortTls: pulumi.Int(0),
ListenerPort: pulumi.Int(0),
Prefix: pulumi.String("string"),
ValidateNetworkTrigger: pulumi.Int(0),
Chunks: pulumi.Int(0),
DownloadGsmCertificateSigningRequestTrigger: pulumi.Int(0),
DefinedTags: pulumi.StringMap{
"string": pulumi.String("string"),
},
ConfigureShardingTrigger: pulumi.Int(0),
PatchOperations: globallydistributeddatabase.ShardedDatabasePatchOperationArray{
&globallydistributeddatabase.ShardedDatabasePatchOperationArgs{
Operation: pulumi.String("string"),
Selection: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
GetConnectionStringTrigger: pulumi.Int(0),
ClusterCertificateCommonName: pulumi.String("string"),
FreeformTags: pulumi.StringMap{
"string": pulumi.String("string"),
},
StartDatabaseTrigger: pulumi.Int(0),
StopDatabaseTrigger: pulumi.Int(0),
GenerateGsmCertificateSigningRequestTrigger: pulumi.Int(0),
})
var shardedDatabaseResource = new ShardedDatabase("shardedDatabaseResource", ShardedDatabaseArgs.builder()
.onsPortLocal(0)
.onsPortRemote(0)
.shardingMethod("string")
.shardDetails(ShardedDatabaseShardDetailArgs.builder()
.dataStorageSizeInGbs(0)
.cloudAutonomousVmClusterId("string")
.computeCount(0)
.adminPassword("string")
.isAutoScalingEnabled(false)
.metadata(Map.of("string", "string"))
.encryptionKeyDetails(ShardedDatabaseShardDetailEncryptionKeyDetailsArgs.builder()
.kmsKeyId("string")
.vaultId("string")
.kmsKeyVersionId("string")
.build())
.containerDatabaseParentId("string")
.containerDatabaseId("string")
.name("string")
.peerCloudAutonomousVmClusterId("string")
.shardGroup("string")
.shardSpace("string")
.status("string")
.supportingResourceId("string")
.timeCreated("string")
.timeSslCertificateExpires("string")
.timeUpdated("string")
.build())
.compartmentId("string")
.characterSet("string")
.dbDeploymentType("string")
.dbVersion("string")
.dbWorkload("string")
.catalogDetails(ShardedDatabaseCatalogDetailArgs.builder()
.dataStorageSizeInGbs(0)
.cloudAutonomousVmClusterId("string")
.computeCount(0)
.adminPassword("string")
.isAutoScalingEnabled(false)
.metadata(Map.of("string", "string"))
.encryptionKeyDetails(ShardedDatabaseCatalogDetailEncryptionKeyDetailsArgs.builder()
.kmsKeyId("string")
.vaultId("string")
.kmsKeyVersionId("string")
.build())
.containerDatabaseParentId("string")
.containerDatabaseId("string")
.name("string")
.peerCloudAutonomousVmClusterId("string")
.shardGroup("string")
.status("string")
.supportingResourceId("string")
.timeCreated("string")
.timeSslCertificateExpires("string")
.timeUpdated("string")
.build())
.displayName("string")
.ncharacterSet("string")
.listenerPortTls(0)
.listenerPort(0)
.prefix("string")
.validateNetworkTrigger(0)
.chunks(0)
.downloadGsmCertificateSigningRequestTrigger(0)
.definedTags(Map.of("string", "string"))
.configureShardingTrigger(0)
.patchOperations(ShardedDatabasePatchOperationArgs.builder()
.operation("string")
.selection("string")
.value("string")
.build())
.getConnectionStringTrigger(0)
.clusterCertificateCommonName("string")
.freeformTags(Map.of("string", "string"))
.startDatabaseTrigger(0)
.stopDatabaseTrigger(0)
.generateGsmCertificateSigningRequestTrigger(0)
.build());
sharded_database_resource = oci.globally_distributed_database.ShardedDatabase("shardedDatabaseResource",
ons_port_local=0,
ons_port_remote=0,
sharding_method="string",
shard_details=[oci.globally_distributed_database.ShardedDatabaseShardDetailArgs(
data_storage_size_in_gbs=0,
cloud_autonomous_vm_cluster_id="string",
compute_count=0,
admin_password="string",
is_auto_scaling_enabled=False,
metadata={
"string": "string",
},
encryption_key_details=oci.globally_distributed_database.ShardedDatabaseShardDetailEncryptionKeyDetailsArgs(
kms_key_id="string",
vault_id="string",
kms_key_version_id="string",
),
container_database_parent_id="string",
container_database_id="string",
name="string",
peer_cloud_autonomous_vm_cluster_id="string",
shard_group="string",
shard_space="string",
status="string",
supporting_resource_id="string",
time_created="string",
time_ssl_certificate_expires="string",
time_updated="string",
)],
compartment_id="string",
character_set="string",
db_deployment_type="string",
db_version="string",
db_workload="string",
catalog_details=[oci.globally_distributed_database.ShardedDatabaseCatalogDetailArgs(
data_storage_size_in_gbs=0,
cloud_autonomous_vm_cluster_id="string",
compute_count=0,
admin_password="string",
is_auto_scaling_enabled=False,
metadata={
"string": "string",
},
encryption_key_details=oci.globally_distributed_database.ShardedDatabaseCatalogDetailEncryptionKeyDetailsArgs(
kms_key_id="string",
vault_id="string",
kms_key_version_id="string",
),
container_database_parent_id="string",
container_database_id="string",
name="string",
peer_cloud_autonomous_vm_cluster_id="string",
shard_group="string",
status="string",
supporting_resource_id="string",
time_created="string",
time_ssl_certificate_expires="string",
time_updated="string",
)],
display_name="string",
ncharacter_set="string",
listener_port_tls=0,
listener_port=0,
prefix="string",
validate_network_trigger=0,
chunks=0,
download_gsm_certificate_signing_request_trigger=0,
defined_tags={
"string": "string",
},
configure_sharding_trigger=0,
patch_operations=[oci.globally_distributed_database.ShardedDatabasePatchOperationArgs(
operation="string",
selection="string",
value="string",
)],
get_connection_string_trigger=0,
cluster_certificate_common_name="string",
freeform_tags={
"string": "string",
},
start_database_trigger=0,
stop_database_trigger=0,
generate_gsm_certificate_signing_request_trigger=0)
const shardedDatabaseResource = new oci.globallydistributeddatabase.ShardedDatabase("shardedDatabaseResource", {
onsPortLocal: 0,
onsPortRemote: 0,
shardingMethod: "string",
shardDetails: [{
dataStorageSizeInGbs: 0,
cloudAutonomousVmClusterId: "string",
computeCount: 0,
adminPassword: "string",
isAutoScalingEnabled: false,
metadata: {
string: "string",
},
encryptionKeyDetails: {
kmsKeyId: "string",
vaultId: "string",
kmsKeyVersionId: "string",
},
containerDatabaseParentId: "string",
containerDatabaseId: "string",
name: "string",
peerCloudAutonomousVmClusterId: "string",
shardGroup: "string",
shardSpace: "string",
status: "string",
supportingResourceId: "string",
timeCreated: "string",
timeSslCertificateExpires: "string",
timeUpdated: "string",
}],
compartmentId: "string",
characterSet: "string",
dbDeploymentType: "string",
dbVersion: "string",
dbWorkload: "string",
catalogDetails: [{
dataStorageSizeInGbs: 0,
cloudAutonomousVmClusterId: "string",
computeCount: 0,
adminPassword: "string",
isAutoScalingEnabled: false,
metadata: {
string: "string",
},
encryptionKeyDetails: {
kmsKeyId: "string",
vaultId: "string",
kmsKeyVersionId: "string",
},
containerDatabaseParentId: "string",
containerDatabaseId: "string",
name: "string",
peerCloudAutonomousVmClusterId: "string",
shardGroup: "string",
status: "string",
supportingResourceId: "string",
timeCreated: "string",
timeSslCertificateExpires: "string",
timeUpdated: "string",
}],
displayName: "string",
ncharacterSet: "string",
listenerPortTls: 0,
listenerPort: 0,
prefix: "string",
validateNetworkTrigger: 0,
chunks: 0,
downloadGsmCertificateSigningRequestTrigger: 0,
definedTags: {
string: "string",
},
configureShardingTrigger: 0,
patchOperations: [{
operation: "string",
selection: "string",
value: "string",
}],
getConnectionStringTrigger: 0,
clusterCertificateCommonName: "string",
freeformTags: {
string: "string",
},
startDatabaseTrigger: 0,
stopDatabaseTrigger: 0,
generateGsmCertificateSigningRequestTrigger: 0,
});
type: oci:GloballyDistributedDatabase:ShardedDatabase
properties:
catalogDetails:
- adminPassword: string
cloudAutonomousVmClusterId: string
computeCount: 0
containerDatabaseId: string
containerDatabaseParentId: string
dataStorageSizeInGbs: 0
encryptionKeyDetails:
kmsKeyId: string
kmsKeyVersionId: string
vaultId: string
isAutoScalingEnabled: false
metadata:
string: string
name: string
peerCloudAutonomousVmClusterId: string
shardGroup: string
status: string
supportingResourceId: string
timeCreated: string
timeSslCertificateExpires: string
timeUpdated: string
characterSet: string
chunks: 0
clusterCertificateCommonName: string
compartmentId: string
configureShardingTrigger: 0
dbDeploymentType: string
dbVersion: string
dbWorkload: string
definedTags:
string: string
displayName: string
downloadGsmCertificateSigningRequestTrigger: 0
freeformTags:
string: string
generateGsmCertificateSigningRequestTrigger: 0
getConnectionStringTrigger: 0
listenerPort: 0
listenerPortTls: 0
ncharacterSet: string
onsPortLocal: 0
onsPortRemote: 0
patchOperations:
- operation: string
selection: string
value: string
prefix: string
shardDetails:
- adminPassword: string
cloudAutonomousVmClusterId: string
computeCount: 0
containerDatabaseId: string
containerDatabaseParentId: string
dataStorageSizeInGbs: 0
encryptionKeyDetails:
kmsKeyId: string
kmsKeyVersionId: string
vaultId: string
isAutoScalingEnabled: false
metadata:
string: string
name: string
peerCloudAutonomousVmClusterId: string
shardGroup: string
shardSpace: string
status: string
supportingResourceId: string
timeCreated: string
timeSslCertificateExpires: string
timeUpdated: string
shardingMethod: string
startDatabaseTrigger: 0
stopDatabaseTrigger: 0
validateNetworkTrigger: 0
ShardedDatabase Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The ShardedDatabase resource accepts the following input properties:
- Catalog
Details List<ShardedDatabase Catalog Detail> - Collection of ATP-Dedicated catalogs that needs to be created.
- Character
Set string - The character set for the new shard database being created. Use database api ListAutonomousDatabaseCharacterSets to get the list of allowed character set for autonomous dedicated database. See documentation: https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabaseCharacterSets/ListAutonomousDatabaseCharacterSets
- Compartment
Id string - (Updatable) Identifier of the compartment where sharded database is to be created.
- Db
Deployment stringType - The database deployment type.
- Db
Version string - Oracle Database version of the Autonomous Container Database.
- Db
Workload string - Possible workload types.
- Display
Name string - (Updatable) Oracle sharded database display name.
- Listener
Port int - The listener port number for sharded database.
- Listener
Port intTls - The TLS listener port number for sharded database.
- Ncharacter
Set string - The national character set for the new shard database being created. Use database api ListAutonomousDatabaseCharacterSets to get the list of allowed national character set for autonomous dedicated database. See documentation: https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabaseCharacterSets/ListAutonomousDatabaseCharacterSets
- Ons
Port intLocal - Ons port local for sharded database.
- Ons
Port intRemote - Ons remote port for sharded database.
- Prefix string
- Unique name prefix for the sharded databases. Only alpha-numeric values are allowed. First character has to be a letter followed by any combination of letter and number.
- List<Sharded
Database Shard Detail> - Collection of ATP-Dedicated shards that needs to be created.
- string
- Sharding Method.
- 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.
- Configure
Sharding intTrigger - (Updatable) An optional property when incremented triggers Configure Sharding. Could be set to any integer value.
- Dictionary<string, string>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- Download
Gsm intCertificate Signing Request Trigger - (Updatable) An optional property when incremented triggers Download Gsm Certificate Signing Request. Could be set to any integer value.
- Dictionary<string, string>
- (Updatable) 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 intCertificate Signing Request Trigger - (Updatable) An optional property when incremented triggers Generate Gsm Certificate Signing Request. Could be set to any integer value.
- Get
Connection intString Trigger - (Updatable) An optional property when incremented triggers Get Connection String. Could be set to any integer value.
- Patch
Operations List<ShardedDatabase Patch Operation> - (Updatable)
- Start
Database intTrigger - (Updatable) An optional property when incremented triggers Start Database. Could be set to any integer value.
- Stop
Database intTrigger - (Updatable) An optional property when incremented triggers Stop Database. Could be set to any integer value.
- Validate
Network intTrigger (Updatable) An optional property when incremented triggers Validate Network. Could be set to any integer value.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- Catalog
Details []ShardedDatabase Catalog Detail Args - Collection of ATP-Dedicated catalogs that needs to be created.
- Character
Set string - The character set for the new shard database being created. Use database api ListAutonomousDatabaseCharacterSets to get the list of allowed character set for autonomous dedicated database. See documentation: https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabaseCharacterSets/ListAutonomousDatabaseCharacterSets
- Compartment
Id string - (Updatable) Identifier of the compartment where sharded database is to be created.
- Db
Deployment stringType - The database deployment type.
- Db
Version string - Oracle Database version of the Autonomous Container Database.
- Db
Workload string - Possible workload types.
- Display
Name string - (Updatable) Oracle sharded database display name.
- Listener
Port int - The listener port number for sharded database.
- Listener
Port intTls - The TLS listener port number for sharded database.
- Ncharacter
Set string - The national character set for the new shard database being created. Use database api ListAutonomousDatabaseCharacterSets to get the list of allowed national character set for autonomous dedicated database. See documentation: https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabaseCharacterSets/ListAutonomousDatabaseCharacterSets
- Ons
Port intLocal - Ons port local for sharded database.
- Ons
Port intRemote - Ons remote port for sharded database.
- Prefix string
- Unique name prefix for the sharded databases. Only alpha-numeric values are allowed. First character has to be a letter followed by any combination of letter and number.
- []Sharded
Database Shard Detail Args - Collection of ATP-Dedicated shards that needs to be created.
- string
- Sharding Method.
- 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.
- Configure
Sharding intTrigger - (Updatable) An optional property when incremented triggers Configure Sharding. Could be set to any integer value.
- map[string]string
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- Download
Gsm intCertificate Signing Request Trigger - (Updatable) An optional property when incremented triggers Download Gsm Certificate Signing Request. Could be set to any integer value.
- map[string]string
- (Updatable) 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 intCertificate Signing Request Trigger - (Updatable) An optional property when incremented triggers Generate Gsm Certificate Signing Request. Could be set to any integer value.
- Get
Connection intString Trigger - (Updatable) An optional property when incremented triggers Get Connection String. Could be set to any integer value.
- Patch
Operations []ShardedDatabase Patch Operation Args - (Updatable)
- Start
Database intTrigger - (Updatable) An optional property when incremented triggers Start Database. Could be set to any integer value.
- Stop
Database intTrigger - (Updatable) An optional property when incremented triggers Stop Database. Could be set to any integer value.
- Validate
Network intTrigger (Updatable) An optional property when incremented triggers Validate Network. Could be set to any integer value.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- catalog
Details List<ShardedDatabase Catalog Detail> - Collection of ATP-Dedicated catalogs that needs to be created.
- character
Set String - The character set for the new shard database being created. Use database api ListAutonomousDatabaseCharacterSets to get the list of allowed character set for autonomous dedicated database. See documentation: https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabaseCharacterSets/ListAutonomousDatabaseCharacterSets
- compartment
Id String - (Updatable) Identifier of the compartment where sharded database is to be created.
- db
Deployment StringType - The database deployment type.
- db
Version String - Oracle Database version of the Autonomous Container Database.
- db
Workload String - Possible workload types.
- display
Name String - (Updatable) Oracle sharded database display name.
- listener
Port Integer - The listener port number for sharded database.
- listener
Port IntegerTls - The TLS listener port number for sharded database.
- ncharacter
Set String - The national character set for the new shard database being created. Use database api ListAutonomousDatabaseCharacterSets to get the list of allowed national character set for autonomous dedicated database. See documentation: https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabaseCharacterSets/ListAutonomousDatabaseCharacterSets
- ons
Port IntegerLocal - Ons port local for sharded database.
- ons
Port IntegerRemote - Ons remote port for sharded database.
- prefix String
- Unique name prefix for the sharded databases. Only alpha-numeric values are allowed. First character has to be a letter followed by any combination of letter and number.
- List<Sharded
Database Shard Detail> - Collection of ATP-Dedicated shards that needs to be created.
- String
- Sharding Method.
- 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.
- configure
Sharding IntegerTrigger - (Updatable) An optional property when incremented triggers Configure Sharding. Could be set to any integer value.
- Map<String,String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- download
Gsm IntegerCertificate Signing Request Trigger - (Updatable) An optional property when incremented triggers Download Gsm Certificate Signing Request. Could be set to any integer value.
- Map<String,String>
- (Updatable) 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 IntegerCertificate Signing Request Trigger - (Updatable) An optional property when incremented triggers Generate Gsm Certificate Signing Request. Could be set to any integer value.
- get
Connection IntegerString Trigger - (Updatable) An optional property when incremented triggers Get Connection String. Could be set to any integer value.
- patch
Operations List<ShardedDatabase Patch Operation> - (Updatable)
- start
Database IntegerTrigger - (Updatable) An optional property when incremented triggers Start Database. Could be set to any integer value.
- stop
Database IntegerTrigger - (Updatable) An optional property when incremented triggers Stop Database. Could be set to any integer value.
- validate
Network IntegerTrigger (Updatable) An optional property when incremented triggers Validate Network. Could be set to any integer value.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- catalog
Details ShardedDatabase Catalog Detail[] - Collection of ATP-Dedicated catalogs that needs to be created.
- character
Set string - The character set for the new shard database being created. Use database api ListAutonomousDatabaseCharacterSets to get the list of allowed character set for autonomous dedicated database. See documentation: https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabaseCharacterSets/ListAutonomousDatabaseCharacterSets
- compartment
Id string - (Updatable) Identifier of the compartment where sharded database is to be created.
- db
Deployment stringType - The database deployment type.
- db
Version string - Oracle Database version of the Autonomous Container Database.
- db
Workload string - Possible workload types.
- display
Name string - (Updatable) Oracle sharded database display name.
- listener
Port number - The listener port number for sharded database.
- listener
Port numberTls - The TLS listener port number for sharded database.
- ncharacter
Set string - The national character set for the new shard database being created. Use database api ListAutonomousDatabaseCharacterSets to get the list of allowed national character set for autonomous dedicated database. See documentation: https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabaseCharacterSets/ListAutonomousDatabaseCharacterSets
- ons
Port numberLocal - Ons port local for sharded database.
- ons
Port numberRemote - Ons remote port for sharded database.
- prefix string
- Unique name prefix for the sharded databases. Only alpha-numeric values are allowed. First character has to be a letter followed by any combination of letter and number.
- Sharded
Database Shard Detail[] - Collection of ATP-Dedicated shards that needs to be created.
- string
- Sharding Method.
- 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.
- configure
Sharding numberTrigger - (Updatable) An optional property when incremented triggers Configure Sharding. Could be set to any integer value.
- {[key: string]: string}
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- download
Gsm numberCertificate Signing Request Trigger - (Updatable) An optional property when incremented triggers Download Gsm Certificate Signing Request. Could be set to any integer value.
- {[key: string]: string}
- (Updatable) 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 numberCertificate Signing Request Trigger - (Updatable) An optional property when incremented triggers Generate Gsm Certificate Signing Request. Could be set to any integer value.
- get
Connection numberString Trigger - (Updatable) An optional property when incremented triggers Get Connection String. Could be set to any integer value.
- patch
Operations ShardedDatabase Patch Operation[] - (Updatable)
- start
Database numberTrigger - (Updatable) An optional property when incremented triggers Start Database. Could be set to any integer value.
- stop
Database numberTrigger - (Updatable) An optional property when incremented triggers Stop Database. Could be set to any integer value.
- validate
Network numberTrigger (Updatable) An optional property when incremented triggers Validate Network. Could be set to any integer value.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- catalog_
details Sequence[globallydistributeddatabase.Sharded Database Catalog Detail Args] - Collection of ATP-Dedicated catalogs that needs to be created.
- character_
set str - The character set for the new shard database being created. Use database api ListAutonomousDatabaseCharacterSets to get the list of allowed character set for autonomous dedicated database. See documentation: https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabaseCharacterSets/ListAutonomousDatabaseCharacterSets
- compartment_
id str - (Updatable) Identifier of the compartment where sharded database is to be created.
- db_
deployment_ strtype - The database deployment type.
- db_
version str - Oracle Database version of the Autonomous Container Database.
- db_
workload str - Possible workload types.
- display_
name str - (Updatable) Oracle sharded database display name.
- listener_
port int - The listener port number for sharded database.
- listener_
port_ inttls - The TLS listener port number for sharded database.
- ncharacter_
set str - The national character set for the new shard database being created. Use database api ListAutonomousDatabaseCharacterSets to get the list of allowed national character set for autonomous dedicated database. See documentation: https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabaseCharacterSets/ListAutonomousDatabaseCharacterSets
- ons_
port_ intlocal - Ons port local for sharded database.
- ons_
port_ intremote - Ons remote port for sharded database.
- prefix str
- Unique name prefix for the sharded databases. Only alpha-numeric values are allowed. First character has to be a letter followed by any combination of letter and number.
- Sequence[globallydistributeddatabase.
Sharded Database Shard Detail Args] - Collection of ATP-Dedicated shards that needs to be created.
- str
- Sharding Method.
- 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.
- configure_
sharding_ inttrigger - (Updatable) An optional property when incremented triggers Configure Sharding. Could be set to any integer value.
- Mapping[str, str]
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- download_
gsm_ intcertificate_ signing_ request_ trigger - (Updatable) An optional property when incremented triggers Download Gsm Certificate Signing Request. Could be set to any integer value.
- Mapping[str, str]
- (Updatable) 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_ intcertificate_ signing_ request_ trigger - (Updatable) An optional property when incremented triggers Generate Gsm Certificate Signing Request. Could be set to any integer value.
- get_
connection_ intstring_ trigger - (Updatable) An optional property when incremented triggers Get Connection String. Could be set to any integer value.
- patch_
operations Sequence[globallydistributeddatabase.Sharded Database Patch Operation Args] - (Updatable)
- start_
database_ inttrigger - (Updatable) An optional property when incremented triggers Start Database. Could be set to any integer value.
- stop_
database_ inttrigger - (Updatable) An optional property when incremented triggers Stop Database. Could be set to any integer value.
- validate_
network_ inttrigger (Updatable) An optional property when incremented triggers Validate Network. Could be set to any integer value.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- catalog
Details List<Property Map> - Collection of ATP-Dedicated catalogs that needs to be created.
- character
Set String - The character set for the new shard database being created. Use database api ListAutonomousDatabaseCharacterSets to get the list of allowed character set for autonomous dedicated database. See documentation: https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabaseCharacterSets/ListAutonomousDatabaseCharacterSets
- compartment
Id String - (Updatable) Identifier of the compartment where sharded database is to be created.
- db
Deployment StringType - The database deployment type.
- db
Version String - Oracle Database version of the Autonomous Container Database.
- db
Workload String - Possible workload types.
- display
Name String - (Updatable) Oracle sharded database display name.
- listener
Port Number - The listener port number for sharded database.
- listener
Port NumberTls - The TLS listener port number for sharded database.
- ncharacter
Set String - The national character set for the new shard database being created. Use database api ListAutonomousDatabaseCharacterSets to get the list of allowed national character set for autonomous dedicated database. See documentation: https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabaseCharacterSets/ListAutonomousDatabaseCharacterSets
- ons
Port NumberLocal - Ons port local for sharded database.
- ons
Port NumberRemote - Ons remote port for sharded database.
- prefix String
- Unique name prefix for the sharded databases. Only alpha-numeric values are allowed. First character has to be a letter followed by any combination of letter and number.
- List<Property Map>
- Collection of ATP-Dedicated shards that needs to be created.
- String
- Sharding Method.
- 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.
- configure
Sharding NumberTrigger - (Updatable) An optional property when incremented triggers Configure Sharding. Could be set to any integer value.
- Map<String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- download
Gsm NumberCertificate Signing Request Trigger - (Updatable) An optional property when incremented triggers Download Gsm Certificate Signing Request. Could be set to any integer value.
- Map<String>
- (Updatable) 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 NumberCertificate Signing Request Trigger - (Updatable) An optional property when incremented triggers Generate Gsm Certificate Signing Request. Could be set to any integer value.
- get
Connection NumberString Trigger - (Updatable) An optional property when incremented triggers Get Connection String. Could be set to any integer value.
- patch
Operations List<Property Map> - (Updatable)
- start
Database NumberTrigger - (Updatable) An optional property when incremented triggers Start Database. Could be set to any integer value.
- stop
Database NumberTrigger - (Updatable) An optional property when incremented triggers Stop Database. Could be set to any integer value.
- validate
Network NumberTrigger (Updatable) An optional property when incremented triggers Validate Network. Could be set to any integer value.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
Outputs
All input properties are implicitly available as output properties. Additionally, the ShardedDatabase resource produces the following output properties:
- Configure
Gsms intTrigger - (Updatable) An optional property when incremented triggers Configure Gsms. Could be set to any integer value.
- Connection
Strings List<ShardedDatabase Connection String> - Details of sharded database connection String.
- Generate
Wallet intTrigger - (Updatable) An optional property when incremented triggers Generate Wallet. Could be set to any integer value.
- Gsms
List<Sharded
Database Gsm> - Details of GSM instances for the sharded database.
- Id string
- The provider-assigned unique ID for this managed resource.
- Lifecycle
State string - Lifecycle
State stringDetails - Detailed message for the lifecycle state.
- Private
Endpoint string - The OCID of private endpoint being used by the sharded database.
- string
- State string
- Lifecycle states for sharded databases.
- 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
- Time
Zone string - Timezone associated with the sharded database.
- Upload
Signed intCertificate And Generate Wallet Trigger - (Updatable) An optional property when incremented triggers Upload Signed Certificate And Generate Wallet. Could be set to any integer value.
- Configure
Gsms intTrigger - (Updatable) An optional property when incremented triggers Configure Gsms. Could be set to any integer value.
- Connection
Strings []ShardedDatabase Connection String - Details of sharded database connection String.
- Generate
Wallet intTrigger - (Updatable) An optional property when incremented triggers Generate Wallet. Could be set to any integer value.
- Gsms
[]Sharded
Database Gsm - Details of GSM instances for the sharded database.
- Id string
- The provider-assigned unique ID for this managed resource.
- Lifecycle
State string - Lifecycle
State stringDetails - Detailed message for the lifecycle state.
- Private
Endpoint string - The OCID of private endpoint being used by the sharded database.
- string
- State string
- Lifecycle states for sharded databases.
- 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
- Time
Zone string - Timezone associated with the sharded database.
- Upload
Signed intCertificate And Generate Wallet Trigger - (Updatable) An optional property when incremented triggers Upload Signed Certificate And Generate Wallet. Could be set to any integer value.
- configure
Gsms IntegerTrigger - (Updatable) An optional property when incremented triggers Configure Gsms. Could be set to any integer value.
- connection
Strings List<ShardedDatabase Connection String> - Details of sharded database connection String.
- generate
Wallet IntegerTrigger - (Updatable) An optional property when incremented triggers Generate Wallet. Could be set to any integer value.
- gsms
List<Sharded
Database Gsm> - Details of GSM instances for the sharded database.
- id String
- The provider-assigned unique ID for this managed resource.
- lifecycle
State String - lifecycle
State StringDetails - Detailed message for the lifecycle state.
- private
Endpoint String - The OCID of private endpoint being used by the sharded database.
- String
- state String
- Lifecycle states for sharded databases.
- 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
- time
Zone String - Timezone associated with the sharded database.
- upload
Signed IntegerCertificate And Generate Wallet Trigger - (Updatable) An optional property when incremented triggers Upload Signed Certificate And Generate Wallet. Could be set to any integer value.
- configure
Gsms numberTrigger - (Updatable) An optional property when incremented triggers Configure Gsms. Could be set to any integer value.
- connection
Strings ShardedDatabase Connection String[] - Details of sharded database connection String.
- generate
Wallet numberTrigger - (Updatable) An optional property when incremented triggers Generate Wallet. Could be set to any integer value.
- gsms
Sharded
Database Gsm[] - Details of GSM instances for the sharded database.
- id string
- The provider-assigned unique ID for this managed resource.
- lifecycle
State string - lifecycle
State stringDetails - Detailed message for the lifecycle state.
- private
Endpoint string - The OCID of private endpoint being used by the sharded database.
- string
- state string
- Lifecycle states for sharded databases.
- {[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
- time
Zone string - Timezone associated with the sharded database.
- upload
Signed numberCertificate And Generate Wallet Trigger - (Updatable) An optional property when incremented triggers Upload Signed Certificate And Generate Wallet. Could be set to any integer value.
- configure_
gsms_ inttrigger - (Updatable) An optional property when incremented triggers Configure Gsms. Could be set to any integer value.
- connection_
strings Sequence[globallydistributeddatabase.Sharded Database Connection String] - Details of sharded database connection String.
- generate_
wallet_ inttrigger - (Updatable) An optional property when incremented triggers Generate Wallet. Could be set to any integer value.
- gsms
Sequence[globallydistributeddatabase.
Sharded Database Gsm] - Details of GSM instances for the sharded database.
- id str
- The provider-assigned unique ID for this managed resource.
- lifecycle_
state str - lifecycle_
state_ strdetails - Detailed message for the lifecycle state.
- private_
endpoint str - The OCID of private endpoint being used by the sharded database.
- str
- state str
- Lifecycle states for sharded databases.
- 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_ intcertificate_ and_ generate_ wallet_ trigger - (Updatable) An optional property when incremented triggers Upload Signed Certificate And Generate Wallet. Could be set to any integer value.
- configure
Gsms NumberTrigger - (Updatable) An optional property when incremented triggers Configure Gsms. Could be set to any integer value.
- connection
Strings List<Property Map> - Details of sharded database connection String.
- generate
Wallet NumberTrigger - (Updatable) An optional property when incremented triggers Generate Wallet. Could be set to any integer value.
- gsms List<Property Map>
- Details of GSM instances for the sharded database.
- id String
- The provider-assigned unique ID for this managed resource.
- lifecycle
State String - lifecycle
State StringDetails - Detailed message for the lifecycle state.
- private
Endpoint String - The OCID of private endpoint being used by the sharded database.
- String
- state String
- Lifecycle states for sharded databases.
- 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
- time
Zone String - Timezone associated with the sharded database.
- upload
Signed NumberCertificate And Generate Wallet Trigger - (Updatable) An optional property when incremented triggers Upload Signed Certificate And Generate Wallet. Could be set to any integer value.
Look up Existing ShardedDatabase Resource
Get an existing ShardedDatabase resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: ShardedDatabaseState, opts?: CustomResourceOptions): ShardedDatabase
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
catalog_details: Optional[Sequence[_globallydistributeddatabase.ShardedDatabaseCatalogDetailArgs]] = None,
character_set: Optional[str] = None,
chunks: Optional[int] = None,
cluster_certificate_common_name: Optional[str] = None,
compartment_id: Optional[str] = None,
configure_gsms_trigger: Optional[int] = None,
configure_sharding_trigger: Optional[int] = None,
connection_strings: Optional[Sequence[_globallydistributeddatabase.ShardedDatabaseConnectionStringArgs]] = None,
db_deployment_type: Optional[str] = None,
db_version: Optional[str] = None,
db_workload: Optional[str] = None,
defined_tags: Optional[Mapping[str, str]] = None,
display_name: Optional[str] = None,
download_gsm_certificate_signing_request_trigger: Optional[int] = None,
freeform_tags: Optional[Mapping[str, str]] = None,
generate_gsm_certificate_signing_request_trigger: Optional[int] = None,
generate_wallet_trigger: Optional[int] = None,
get_connection_string_trigger: Optional[int] = None,
gsms: Optional[Sequence[_globallydistributeddatabase.ShardedDatabaseGsmArgs]] = None,
lifecycle_state: Optional[str] = None,
lifecycle_state_details: Optional[str] = None,
listener_port: Optional[int] = None,
listener_port_tls: Optional[int] = None,
ncharacter_set: Optional[str] = None,
ons_port_local: Optional[int] = None,
ons_port_remote: Optional[int] = None,
patch_operations: Optional[Sequence[_globallydistributeddatabase.ShardedDatabasePatchOperationArgs]] = None,
prefix: Optional[str] = None,
private_endpoint: Optional[str] = None,
shard_details: Optional[Sequence[_globallydistributeddatabase.ShardedDatabaseShardDetailArgs]] = None,
sharded_database_id: Optional[str] = None,
sharding_method: Optional[str] = None,
start_database_trigger: Optional[int] = None,
state: Optional[str] = None,
stop_database_trigger: Optional[int] = None,
system_tags: Optional[Mapping[str, str]] = None,
time_created: Optional[str] = None,
time_updated: Optional[str] = None,
time_zone: Optional[str] = None,
upload_signed_certificate_and_generate_wallet_trigger: Optional[int] = None,
validate_network_trigger: Optional[int] = None) -> ShardedDatabase
func GetShardedDatabase(ctx *Context, name string, id IDInput, state *ShardedDatabaseState, opts ...ResourceOption) (*ShardedDatabase, error)
public static ShardedDatabase Get(string name, Input<string> id, ShardedDatabaseState? state, CustomResourceOptions? opts = null)
public static ShardedDatabase get(String name, Output<String> id, ShardedDatabaseState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Catalog
Details List<ShardedDatabase Catalog Detail> - Collection of ATP-Dedicated catalogs that needs to be created.
- Character
Set string - The character set for the new shard database being created. Use database api ListAutonomousDatabaseCharacterSets to get the list of allowed character set for autonomous dedicated database. See documentation: https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabaseCharacterSets/ListAutonomousDatabaseCharacterSets
- 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 - (Updatable) Identifier of the compartment where sharded database is to be created.
- Configure
Gsms intTrigger - (Updatable) An optional property when incremented triggers Configure Gsms. Could be set to any integer value.
- Configure
Sharding intTrigger - (Updatable) An optional property when incremented triggers Configure Sharding. Could be set to any integer value.
- Connection
Strings List<ShardedDatabase Connection String> - Details of sharded database connection String.
- Db
Deployment stringType - The database deployment type.
- Db
Version string - Oracle Database version of the Autonomous Container Database.
- Db
Workload string - Possible workload types.
- Dictionary<string, string>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- Display
Name string - (Updatable) Oracle sharded database display name.
- Download
Gsm intCertificate Signing Request Trigger - (Updatable) An optional property when incremented triggers Download Gsm Certificate Signing Request. Could be set to any integer value.
- Dictionary<string, string>
- (Updatable) 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 intCertificate Signing Request Trigger - (Updatable) An optional property when incremented triggers Generate Gsm Certificate Signing Request. Could be set to any integer value.
- Generate
Wallet intTrigger - (Updatable) An optional property when incremented triggers Generate Wallet. Could be set to any integer value.
- Get
Connection intString Trigger - (Updatable) An optional property when incremented triggers Get Connection String. Could be set to any integer value.
- Gsms
List<Sharded
Database Gsm> - Details of GSM instances for the sharded database.
- Lifecycle
State string - Lifecycle
State stringDetails - Detailed message for the lifecycle state.
- Listener
Port int - The listener port number for sharded database.
- Listener
Port intTls - The TLS listener port number for sharded database.
- Ncharacter
Set string - The national character set for the new shard database being created. Use database api ListAutonomousDatabaseCharacterSets to get the list of allowed national character set for autonomous dedicated database. See documentation: https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabaseCharacterSets/ListAutonomousDatabaseCharacterSets
- Ons
Port intLocal - Ons port local for sharded database.
- Ons
Port intRemote - Ons remote port for sharded database.
- Patch
Operations List<ShardedDatabase Patch Operation> - (Updatable)
- Prefix string
- Unique name prefix for the sharded databases. Only alpha-numeric values are allowed. First character has to be a letter followed by any combination of letter and number.
- Private
Endpoint string - The OCID of private endpoint being used by the sharded database.
- Shard
Details List<ShardedDatabase Shard Detail> - Collection of ATP-Dedicated shards that needs to be created.
- Sharded
Database stringId - Sharding
Method string - Sharding Method.
- Start
Database intTrigger - (Updatable) An optional property when incremented triggers Start Database. Could be set to any integer value.
- State string
- Lifecycle states for sharded databases.
- Stop
Database intTrigger - (Updatable) An optional property when incremented triggers Stop Database. Could be set to any integer value.
- 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
- Time
Zone string - Timezone associated with the sharded database.
- Upload
Signed intCertificate And Generate Wallet Trigger - (Updatable) An optional property when incremented triggers Upload Signed Certificate And Generate Wallet. Could be set to any integer value.
- Validate
Network intTrigger (Updatable) An optional property when incremented triggers Validate Network. Could be set to any integer value.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- Catalog
Details []ShardedDatabase Catalog Detail Args - Collection of ATP-Dedicated catalogs that needs to be created.
- Character
Set string - The character set for the new shard database being created. Use database api ListAutonomousDatabaseCharacterSets to get the list of allowed character set for autonomous dedicated database. See documentation: https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabaseCharacterSets/ListAutonomousDatabaseCharacterSets
- 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 - (Updatable) Identifier of the compartment where sharded database is to be created.
- Configure
Gsms intTrigger - (Updatable) An optional property when incremented triggers Configure Gsms. Could be set to any integer value.
- Configure
Sharding intTrigger - (Updatable) An optional property when incremented triggers Configure Sharding. Could be set to any integer value.
- Connection
Strings []ShardedDatabase Connection String Args - Details of sharded database connection String.
- Db
Deployment stringType - The database deployment type.
- Db
Version string - Oracle Database version of the Autonomous Container Database.
- Db
Workload string - Possible workload types.
- map[string]string
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- Display
Name string - (Updatable) Oracle sharded database display name.
- Download
Gsm intCertificate Signing Request Trigger - (Updatable) An optional property when incremented triggers Download Gsm Certificate Signing Request. Could be set to any integer value.
- map[string]string
- (Updatable) 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 intCertificate Signing Request Trigger - (Updatable) An optional property when incremented triggers Generate Gsm Certificate Signing Request. Could be set to any integer value.
- Generate
Wallet intTrigger - (Updatable) An optional property when incremented triggers Generate Wallet. Could be set to any integer value.
- Get
Connection intString Trigger - (Updatable) An optional property when incremented triggers Get Connection String. Could be set to any integer value.
- Gsms
[]Sharded
Database Gsm Args - Details of GSM instances for the sharded database.
- Lifecycle
State string - Lifecycle
State stringDetails - Detailed message for the lifecycle state.
- Listener
Port int - The listener port number for sharded database.
- Listener
Port intTls - The TLS listener port number for sharded database.
- Ncharacter
Set string - The national character set for the new shard database being created. Use database api ListAutonomousDatabaseCharacterSets to get the list of allowed national character set for autonomous dedicated database. See documentation: https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabaseCharacterSets/ListAutonomousDatabaseCharacterSets
- Ons
Port intLocal - Ons port local for sharded database.
- Ons
Port intRemote - Ons remote port for sharded database.
- Patch
Operations []ShardedDatabase Patch Operation Args - (Updatable)
- Prefix string
- Unique name prefix for the sharded databases. Only alpha-numeric values are allowed. First character has to be a letter followed by any combination of letter and number.
- Private
Endpoint string - The OCID of private endpoint being used by the sharded database.
- Shard
Details []ShardedDatabase Shard Detail Args - Collection of ATP-Dedicated shards that needs to be created.
- Sharded
Database stringId - Sharding
Method string - Sharding Method.
- Start
Database intTrigger - (Updatable) An optional property when incremented triggers Start Database. Could be set to any integer value.
- State string
- Lifecycle states for sharded databases.
- Stop
Database intTrigger - (Updatable) An optional property when incremented triggers Stop Database. Could be set to any integer value.
- 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
- Time
Zone string - Timezone associated with the sharded database.
- Upload
Signed intCertificate And Generate Wallet Trigger - (Updatable) An optional property when incremented triggers Upload Signed Certificate And Generate Wallet. Could be set to any integer value.
- Validate
Network intTrigger (Updatable) An optional property when incremented triggers Validate Network. Could be set to any integer value.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- catalog
Details List<ShardedDatabase Catalog Detail> - Collection of ATP-Dedicated catalogs that needs to be created.
- character
Set String - The character set for the new shard database being created. Use database api ListAutonomousDatabaseCharacterSets to get the list of allowed character set for autonomous dedicated database. See documentation: https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabaseCharacterSets/ListAutonomousDatabaseCharacterSets
- 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 - (Updatable) Identifier of the compartment where sharded database is to be created.
- configure
Gsms IntegerTrigger - (Updatable) An optional property when incremented triggers Configure Gsms. Could be set to any integer value.
- configure
Sharding IntegerTrigger - (Updatable) An optional property when incremented triggers Configure Sharding. Could be set to any integer value.
- connection
Strings List<ShardedDatabase Connection String> - Details of sharded database connection String.
- db
Deployment StringType - The database deployment type.
- db
Version String - Oracle Database version of the Autonomous Container Database.
- db
Workload String - Possible workload types.
- Map<String,String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- display
Name String - (Updatable) Oracle sharded database display name.
- download
Gsm IntegerCertificate Signing Request Trigger - (Updatable) An optional property when incremented triggers Download Gsm Certificate Signing Request. Could be set to any integer value.
- Map<String,String>
- (Updatable) 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 IntegerCertificate Signing Request Trigger - (Updatable) An optional property when incremented triggers Generate Gsm Certificate Signing Request. Could be set to any integer value.
- generate
Wallet IntegerTrigger - (Updatable) An optional property when incremented triggers Generate Wallet. Could be set to any integer value.
- get
Connection IntegerString Trigger - (Updatable) An optional property when incremented triggers Get Connection String. Could be set to any integer value.
- gsms
List<Sharded
Database Gsm> - Details of GSM instances for the sharded database.
- lifecycle
State String - lifecycle
State StringDetails - Detailed message for the lifecycle state.
- listener
Port Integer - The listener port number for sharded database.
- listener
Port IntegerTls - The TLS listener port number for sharded database.
- ncharacter
Set String - The national character set for the new shard database being created. Use database api ListAutonomousDatabaseCharacterSets to get the list of allowed national character set for autonomous dedicated database. See documentation: https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabaseCharacterSets/ListAutonomousDatabaseCharacterSets
- ons
Port IntegerLocal - Ons port local for sharded database.
- ons
Port IntegerRemote - Ons remote port for sharded database.
- patch
Operations List<ShardedDatabase Patch Operation> - (Updatable)
- prefix String
- Unique name prefix for the sharded databases. Only alpha-numeric values are allowed. First character has to be a letter followed by any combination of letter and number.
- private
Endpoint String - The OCID of private endpoint being used by the sharded database.
- shard
Details List<ShardedDatabase Shard Detail> - Collection of ATP-Dedicated shards that needs to be created.
- sharded
Database StringId - sharding
Method String - Sharding Method.
- start
Database IntegerTrigger - (Updatable) An optional property when incremented triggers Start Database. Could be set to any integer value.
- state String
- Lifecycle states for sharded databases.
- stop
Database IntegerTrigger - (Updatable) An optional property when incremented triggers Stop Database. Could be set to any integer value.
- 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
- time
Zone String - Timezone associated with the sharded database.
- upload
Signed IntegerCertificate And Generate Wallet Trigger - (Updatable) An optional property when incremented triggers Upload Signed Certificate And Generate Wallet. Could be set to any integer value.
- validate
Network IntegerTrigger (Updatable) An optional property when incremented triggers Validate Network. Could be set to any integer value.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- catalog
Details ShardedDatabase Catalog Detail[] - Collection of ATP-Dedicated catalogs that needs to be created.
- character
Set string - The character set for the new shard database being created. Use database api ListAutonomousDatabaseCharacterSets to get the list of allowed character set for autonomous dedicated database. See documentation: https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabaseCharacterSets/ListAutonomousDatabaseCharacterSets
- 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 - (Updatable) Identifier of the compartment where sharded database is to be created.
- configure
Gsms numberTrigger - (Updatable) An optional property when incremented triggers Configure Gsms. Could be set to any integer value.
- configure
Sharding numberTrigger - (Updatable) An optional property when incremented triggers Configure Sharding. Could be set to any integer value.
- connection
Strings ShardedDatabase Connection String[] - Details of sharded database connection String.
- db
Deployment stringType - The database deployment type.
- db
Version string - Oracle Database version of the Autonomous Container Database.
- db
Workload string - Possible workload types.
- {[key: string]: string}
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- display
Name string - (Updatable) Oracle sharded database display name.
- download
Gsm numberCertificate Signing Request Trigger - (Updatable) An optional property when incremented triggers Download Gsm Certificate Signing Request. Could be set to any integer value.
- {[key: string]: string}
- (Updatable) 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 numberCertificate Signing Request Trigger - (Updatable) An optional property when incremented triggers Generate Gsm Certificate Signing Request. Could be set to any integer value.
- generate
Wallet numberTrigger - (Updatable) An optional property when incremented triggers Generate Wallet. Could be set to any integer value.
- get
Connection numberString Trigger - (Updatable) An optional property when incremented triggers Get Connection String. Could be set to any integer value.
- gsms
Sharded
Database Gsm[] - Details of GSM instances for the sharded database.
- lifecycle
State string - lifecycle
State stringDetails - Detailed message for the lifecycle state.
- listener
Port number - The listener port number for sharded database.
- listener
Port numberTls - The TLS listener port number for sharded database.
- ncharacter
Set string - The national character set for the new shard database being created. Use database api ListAutonomousDatabaseCharacterSets to get the list of allowed national character set for autonomous dedicated database. See documentation: https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabaseCharacterSets/ListAutonomousDatabaseCharacterSets
- ons
Port numberLocal - Ons port local for sharded database.
- ons
Port numberRemote - Ons remote port for sharded database.
- patch
Operations ShardedDatabase Patch Operation[] - (Updatable)
- prefix string
- Unique name prefix for the sharded databases. Only alpha-numeric values are allowed. First character has to be a letter followed by any combination of letter and number.
- private
Endpoint string - The OCID of private endpoint being used by the sharded database.
- shard
Details ShardedDatabase Shard Detail[] - Collection of ATP-Dedicated shards that needs to be created.
- sharded
Database stringId - sharding
Method string - Sharding Method.
- start
Database numberTrigger - (Updatable) An optional property when incremented triggers Start Database. Could be set to any integer value.
- state string
- Lifecycle states for sharded databases.
- stop
Database numberTrigger - (Updatable) An optional property when incremented triggers Stop Database. Could be set to any integer value.
- {[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
- time
Zone string - Timezone associated with the sharded database.
- upload
Signed numberCertificate And Generate Wallet Trigger - (Updatable) An optional property when incremented triggers Upload Signed Certificate And Generate Wallet. Could be set to any integer value.
- validate
Network numberTrigger (Updatable) An optional property when incremented triggers Validate Network. Could be set to any integer value.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- catalog_
details Sequence[globallydistributeddatabase.Sharded Database Catalog Detail Args] - Collection of ATP-Dedicated catalogs that needs to be created.
- character_
set str - The character set for the new shard database being created. Use database api ListAutonomousDatabaseCharacterSets to get the list of allowed character set for autonomous dedicated database. See documentation: https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabaseCharacterSets/ListAutonomousDatabaseCharacterSets
- 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 - (Updatable) Identifier of the compartment where sharded database is to be created.
- configure_
gsms_ inttrigger - (Updatable) An optional property when incremented triggers Configure Gsms. Could be set to any integer value.
- configure_
sharding_ inttrigger - (Updatable) An optional property when incremented triggers Configure Sharding. Could be set to any integer value.
- connection_
strings Sequence[globallydistributeddatabase.Sharded Database Connection String Args] - Details of sharded database connection String.
- db_
deployment_ strtype - The database deployment type.
- db_
version str - Oracle Database version of the Autonomous Container Database.
- db_
workload str - Possible workload types.
- Mapping[str, str]
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- display_
name str - (Updatable) Oracle sharded database display name.
- download_
gsm_ intcertificate_ signing_ request_ trigger - (Updatable) An optional property when incremented triggers Download Gsm Certificate Signing Request. Could be set to any integer value.
- Mapping[str, str]
- (Updatable) 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_ intcertificate_ signing_ request_ trigger - (Updatable) An optional property when incremented triggers Generate Gsm Certificate Signing Request. Could be set to any integer value.
- generate_
wallet_ inttrigger - (Updatable) An optional property when incremented triggers Generate Wallet. Could be set to any integer value.
- get_
connection_ intstring_ trigger - (Updatable) An optional property when incremented triggers Get Connection String. Could be set to any integer value.
- gsms
Sequence[globallydistributeddatabase.
Sharded Database Gsm Args] - Details of GSM instances for the sharded database.
- lifecycle_
state str - lifecycle_
state_ strdetails - Detailed message for the lifecycle state.
- listener_
port int - The listener port number for sharded database.
- listener_
port_ inttls - The TLS listener port number for sharded database.
- ncharacter_
set str - The national character set for the new shard database being created. Use database api ListAutonomousDatabaseCharacterSets to get the list of allowed national character set for autonomous dedicated database. See documentation: https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabaseCharacterSets/ListAutonomousDatabaseCharacterSets
- ons_
port_ intlocal - Ons port local for sharded database.
- ons_
port_ intremote - Ons remote port for sharded database.
- patch_
operations Sequence[globallydistributeddatabase.Sharded Database Patch Operation Args] - (Updatable)
- prefix str
- Unique name prefix for the sharded databases. Only alpha-numeric values are allowed. First character has to be a letter followed by any combination of letter and number.
- private_
endpoint str - The OCID of private endpoint being used by the sharded database.
- shard_
details Sequence[globallydistributeddatabase.Sharded Database Shard Detail Args] - Collection of ATP-Dedicated shards that needs to be created.
- sharded_
database_ strid - sharding_
method str - Sharding Method.
- start_
database_ inttrigger - (Updatable) An optional property when incremented triggers Start Database. Could be set to any integer value.
- state str
- Lifecycle states for sharded databases.
- stop_
database_ inttrigger - (Updatable) An optional property when incremented triggers Stop Database. Could be set to any integer value.
- 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_ intcertificate_ and_ generate_ wallet_ trigger - (Updatable) An optional property when incremented triggers Upload Signed Certificate And Generate Wallet. Could be set to any integer value.
- validate_
network_ inttrigger (Updatable) An optional property when incremented triggers Validate Network. Could be set to any integer value.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- catalog
Details List<Property Map> - Collection of ATP-Dedicated catalogs that needs to be created.
- character
Set String - The character set for the new shard database being created. Use database api ListAutonomousDatabaseCharacterSets to get the list of allowed character set for autonomous dedicated database. See documentation: https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabaseCharacterSets/ListAutonomousDatabaseCharacterSets
- 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 - (Updatable) Identifier of the compartment where sharded database is to be created.
- configure
Gsms NumberTrigger - (Updatable) An optional property when incremented triggers Configure Gsms. Could be set to any integer value.
- configure
Sharding NumberTrigger - (Updatable) An optional property when incremented triggers Configure Sharding. Could be set to any integer value.
- connection
Strings List<Property Map> - Details of sharded database connection String.
- db
Deployment StringType - The database deployment type.
- db
Version String - Oracle Database version of the Autonomous Container Database.
- db
Workload String - Possible workload types.
- Map<String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- display
Name String - (Updatable) Oracle sharded database display name.
- download
Gsm NumberCertificate Signing Request Trigger - (Updatable) An optional property when incremented triggers Download Gsm Certificate Signing Request. Could be set to any integer value.
- Map<String>
- (Updatable) 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 NumberCertificate Signing Request Trigger - (Updatable) An optional property when incremented triggers Generate Gsm Certificate Signing Request. Could be set to any integer value.
- generate
Wallet NumberTrigger - (Updatable) An optional property when incremented triggers Generate Wallet. Could be set to any integer value.
- get
Connection NumberString Trigger - (Updatable) An optional property when incremented triggers Get Connection String. Could be set to any integer value.
- gsms List<Property Map>
- Details of GSM instances for the sharded database.
- lifecycle
State String - lifecycle
State StringDetails - Detailed message for the lifecycle state.
- listener
Port Number - The listener port number for sharded database.
- listener
Port NumberTls - The TLS listener port number for sharded database.
- ncharacter
Set String - The national character set for the new shard database being created. Use database api ListAutonomousDatabaseCharacterSets to get the list of allowed national character set for autonomous dedicated database. See documentation: https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabaseCharacterSets/ListAutonomousDatabaseCharacterSets
- ons
Port NumberLocal - Ons port local for sharded database.
- ons
Port NumberRemote - Ons remote port for sharded database.
- patch
Operations List<Property Map> - (Updatable)
- prefix String
- Unique name prefix for the sharded databases. Only alpha-numeric values are allowed. First character has to be a letter followed by any combination of letter and number.
- private
Endpoint String - The OCID of private endpoint being used by the sharded database.
- shard
Details List<Property Map> - Collection of ATP-Dedicated shards that needs to be created.
- sharded
Database StringId - sharding
Method String - Sharding Method.
- start
Database NumberTrigger - (Updatable) An optional property when incremented triggers Start Database. Could be set to any integer value.
- state String
- Lifecycle states for sharded databases.
- stop
Database NumberTrigger - (Updatable) An optional property when incremented triggers Stop Database. Could be set to any integer value.
- 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
- time
Zone String - Timezone associated with the sharded database.
- upload
Signed NumberCertificate And Generate Wallet Trigger - (Updatable) An optional property when incremented triggers Upload Signed Certificate And Generate Wallet. Could be set to any integer value.
- validate
Network NumberTrigger (Updatable) An optional property when incremented triggers Validate Network. Could be set to any integer value.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
Supporting Types
ShardedDatabaseCatalogDetail, ShardedDatabaseCatalogDetailArgs
- Admin
Password string - Admin password for the catalog database.
- Cloud
Autonomous stringVm Cluster Id - The OCID of the cloud Autonomous Exadata VM Cluster.
- Compute
Count double - The compute count for the catalog database. It has to be in multiple of 2.
- Data
Storage doubleSize In Gbs - The data disk group size to be allocated in GBs for the catalog database.
- Is
Auto boolScaling Enabled - Determines the auto-scaling mode for the catalog database.
- Container
Database stringId - Identifier of the underlying container database.
- Container
Database stringParent Id - Identifier of the underlying container database parent.
- Encryption
Key ShardedDetails Database Catalog Detail Encryption Key Details - 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).
- Metadata Dictionary<string, string>
- Additional metadata related to shard's underlying supporting resource.
- Name string
- Name of the shard.
- Peer
Cloud stringAutonomous Vm Cluster Id - The OCID of the peer cloud Autonomous Exadata VM Cluster.
- string
- Name of the shard-group to which the shard belongs.
- Status string
- Status of shard or catalog or gsm for the sharded database.
- Supporting
Resource stringId - Identifier of the underlying supporting resource.
- Time
Created string - The time the the Sharded Database was created. An RFC3339 formatted datetime string
- Time
Ssl stringCertificate Expires - The time the ssl certificate associated with shard expires. An RFC3339 formatted datetime string
- Time
Updated string - The time the Sharded Database was last updated. An RFC3339 formatted datetime string
- Admin
Password string - Admin password for the catalog database.
- Cloud
Autonomous stringVm Cluster Id - The OCID of the cloud Autonomous Exadata VM Cluster.
- Compute
Count float64 - The compute count for the catalog database. It has to be in multiple of 2.
- Data
Storage float64Size In Gbs - The data disk group size to be allocated in GBs for the catalog database.
- Is
Auto boolScaling Enabled - Determines the auto-scaling mode for the catalog database.
- Container
Database stringId - Identifier of the underlying container database.
- Container
Database stringParent Id - Identifier of the underlying container database parent.
- Encryption
Key ShardedDetails Database Catalog Detail Encryption Key Details - 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).
- Metadata map[string]string
- Additional metadata related to shard's underlying supporting resource.
- Name string
- Name of the shard.
- Peer
Cloud stringAutonomous Vm Cluster Id - The OCID of the peer cloud Autonomous Exadata VM Cluster.
- string
- Name of the shard-group to which the shard belongs.
- Status string
- Status of shard or catalog or gsm for the sharded database.
- Supporting
Resource stringId - Identifier of the underlying supporting resource.
- Time
Created string - The time the the Sharded Database was created. An RFC3339 formatted datetime string
- Time
Ssl stringCertificate Expires - The time the ssl certificate associated with shard expires. An RFC3339 formatted datetime string
- Time
Updated string - The time the Sharded Database was last updated. An RFC3339 formatted datetime string
- admin
Password String - Admin password for the catalog database.
- cloud
Autonomous StringVm Cluster Id - The OCID of the cloud Autonomous Exadata VM Cluster.
- compute
Count Double - The compute count for the catalog database. It has to be in multiple of 2.
- data
Storage DoubleSize In Gbs - The data disk group size to be allocated in GBs for the catalog database.
- is
Auto BooleanScaling Enabled - Determines the auto-scaling mode for the catalog database.
- container
Database StringId - Identifier of the underlying container database.
- container
Database StringParent Id - Identifier of the underlying container database parent.
- encryption
Key ShardedDetails Database Catalog Detail Encryption Key Details - 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).
- metadata Map<String,String>
- Additional metadata related to shard's underlying supporting resource.
- name String
- Name of the shard.
- peer
Cloud StringAutonomous Vm Cluster Id - The OCID of the peer cloud Autonomous Exadata VM Cluster.
- String
- Name of the shard-group to which the shard belongs.
- status String
- Status of shard or catalog or gsm for the sharded database.
- supporting
Resource StringId - Identifier of the underlying supporting resource.
- time
Created String - The time the the Sharded Database was created. An RFC3339 formatted datetime string
- time
Ssl StringCertificate Expires - The time the ssl certificate associated with shard expires. An RFC3339 formatted datetime string
- time
Updated String - The time the Sharded Database was last updated. An RFC3339 formatted datetime string
- admin
Password string - Admin password for the catalog database.
- cloud
Autonomous stringVm Cluster Id - The OCID of the cloud Autonomous Exadata VM Cluster.
- compute
Count number - The compute count for the catalog database. It has to be in multiple of 2.
- data
Storage numberSize In Gbs - The data disk group size to be allocated in GBs for the catalog database.
- is
Auto booleanScaling Enabled - Determines the auto-scaling mode for the catalog database.
- container
Database stringId - Identifier of the underlying container database.
- container
Database stringParent Id - Identifier of the underlying container database parent.
- encryption
Key ShardedDetails Database Catalog Detail Encryption Key Details - 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).
- metadata {[key: string]: string}
- Additional metadata related to shard's underlying supporting resource.
- name string
- Name of the shard.
- peer
Cloud stringAutonomous Vm Cluster Id - The OCID of the peer cloud Autonomous Exadata VM Cluster.
- string
- Name of the shard-group to which the shard belongs.
- status string
- Status of shard or catalog or gsm for the sharded database.
- supporting
Resource stringId - Identifier of the underlying supporting resource.
- time
Created string - The time the the Sharded Database was created. An RFC3339 formatted datetime string
- time
Ssl stringCertificate Expires - The time the ssl certificate associated with shard expires. An RFC3339 formatted datetime string
- time
Updated string - The time the Sharded Database was last updated. An RFC3339 formatted datetime string
- admin_
password str - Admin password for the catalog database.
- cloud_
autonomous_ strvm_ cluster_ id - The OCID of the cloud Autonomous Exadata VM Cluster.
- compute_
count float - The compute count for the catalog database. It has to be in multiple of 2.
- data_
storage_ floatsize_ in_ gbs - The data disk group size to be allocated in GBs for the catalog database.
- is_
auto_ boolscaling_ enabled - Determines the auto-scaling mode for the catalog database.
- container_
database_ strid - Identifier of the underlying container database.
- container_
database_ strparent_ id - Identifier of the underlying container database parent.
- encryption_
key_ globallydistributeddatabase.details Sharded Database Catalog Detail Encryption Key Details - 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).
- metadata Mapping[str, str]
- Additional metadata related to shard's underlying supporting resource.
- name str
- Name of the shard.
- peer_
cloud_ strautonomous_ vm_ cluster_ id - The OCID of the peer cloud Autonomous Exadata VM Cluster.
- 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_ strid - Identifier of the underlying supporting resource.
- time_
created str - The time the the Sharded Database was created. An RFC3339 formatted datetime string
- time_
ssl_ strcertificate_ expires - 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
- admin
Password String - Admin password for the catalog database.
- cloud
Autonomous StringVm Cluster Id - The OCID of the cloud Autonomous Exadata VM Cluster.
- compute
Count Number - The compute count for the catalog database. It has to be in multiple of 2.
- data
Storage NumberSize In Gbs - The data disk group size to be allocated in GBs for the catalog database.
- is
Auto BooleanScaling Enabled - Determines the auto-scaling mode for the catalog database.
- container
Database StringId - Identifier of the underlying container database.
- container
Database StringParent Id - Identifier of the underlying container database parent.
- encryption
Key Property MapDetails - 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).
- metadata Map<String>
- Additional metadata related to shard's underlying supporting resource.
- name String
- Name of the shard.
- peer
Cloud StringAutonomous Vm Cluster Id - The OCID of the peer cloud Autonomous Exadata VM Cluster.
- String
- Name of the shard-group to which the shard belongs.
- status String
- Status of shard or catalog or gsm for the sharded database.
- supporting
Resource StringId - Identifier of the underlying supporting resource.
- time
Created String - The time the the Sharded Database was created. An RFC3339 formatted datetime string
- time
Ssl StringCertificate Expires - The time the ssl certificate associated with shard expires. An RFC3339 formatted datetime string
- time
Updated String - The time the Sharded Database was last updated. An RFC3339 formatted datetime string
ShardedDatabaseCatalogDetailEncryptionKeyDetails, ShardedDatabaseCatalogDetailEncryptionKeyDetailsArgs
- Kms
Key stringId - The OCID of the KMS key in vault identified by vaultId in customer tenancy that is used as the master encryption key.
- Vault
Id 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 stringVersion Id - The OCID of the KMS key version for key identified by kmsKeyId that is used in data encryption (TDE) operations.
- Kms
Key stringId - The OCID of the KMS key in vault identified by vaultId in customer tenancy that is used as the master encryption key.
- Vault
Id 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 stringVersion Id - The OCID of the KMS key version for key identified by kmsKeyId that is used in data encryption (TDE) operations.
- kms
Key StringId - The OCID of the KMS key in vault identified by vaultId in customer tenancy that is used as the master encryption key.
- vault
Id 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 StringVersion Id - The OCID of the KMS key version for key identified by kmsKeyId that is used in data encryption (TDE) operations.
- kms
Key stringId - The OCID of the KMS key in vault identified by vaultId in customer tenancy that is used as the master encryption key.
- vault
Id 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 stringVersion Id - The OCID of the KMS key version for key identified by kmsKeyId that is used in data encryption (TDE) operations.
- kms_
key_ strid - The OCID of the KMS key in vault identified by vaultId in customer tenancy that is used as the master encryption key.
- 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.
- kms_
key_ strversion_ id - The OCID of the KMS key version for key identified by kmsKeyId that is used in data encryption (TDE) operations.
- kms
Key StringId - The OCID of the KMS key in vault identified by vaultId in customer tenancy that is used as the master encryption key.
- vault
Id 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 StringVersion Id - The OCID of the KMS key version for key identified by kmsKeyId that is used in data encryption (TDE) operations.
ShardedDatabaseConnectionString, ShardedDatabaseConnectionStringArgs
- All
Connection Dictionary<string, string>Strings - Collection of connection strings.
- All
Connection map[string]stringStrings - Collection of connection strings.
- all
Connection Map<String,String>Strings - Collection of connection strings.
- all
Connection {[key: string]: string}Strings - Collection of connection strings.
- all_
connection_ Mapping[str, str]strings - Collection of connection strings.
- all
Connection Map<String>Strings - Collection of connection strings.
ShardedDatabaseGsm, ShardedDatabaseGsmArgs
- Compute
Count double - The compute amount available to the underlying autonomous database associated with shard.
- Data
Storage doubleSize In Gbs - The data disk group size to be allocated in GBs.
- Metadata Dictionary<string, string>
- Additional metadata related to shard's underlying supporting resource.
- Name string
- Name of the shard.
- Status string
- Status of shard or catalog or gsm for the sharded database.
- Supporting
Resource stringId - Identifier of the underlying supporting resource.
- Time
Created string - The time the the Sharded Database was created. An RFC3339 formatted datetime string
- Time
Ssl stringCertificate Expires - The time the ssl certificate associated with shard expires. An RFC3339 formatted datetime string
- Time
Updated string - The time the Sharded Database was last updated. An RFC3339 formatted datetime string
- Compute
Count float64 - The compute amount available to the underlying autonomous database associated with shard.
- Data
Storage float64Size In Gbs - The data disk group size to be allocated in GBs.
- Metadata map[string]string
- Additional metadata related to shard's underlying supporting resource.
- Name string
- Name of the shard.
- Status string
- Status of shard or catalog or gsm for the sharded database.
- Supporting
Resource stringId - Identifier of the underlying supporting resource.
- Time
Created string - The time the the Sharded Database was created. An RFC3339 formatted datetime string
- Time
Ssl stringCertificate Expires - The time the ssl certificate associated with shard expires. An RFC3339 formatted datetime string
- Time
Updated string - The time the Sharded Database was last updated. An RFC3339 formatted datetime string
- compute
Count Double - The compute amount available to the underlying autonomous database associated with shard.
- data
Storage DoubleSize In Gbs - The data disk group size to be allocated in GBs.
- metadata Map<String,String>
- Additional metadata related to shard's underlying supporting resource.
- name String
- Name of the shard.
- status String
- Status of shard or catalog or gsm for the sharded database.
- supporting
Resource StringId - Identifier of the underlying supporting resource.
- time
Created String - The time the the Sharded Database was created. An RFC3339 formatted datetime string
- time
Ssl StringCertificate Expires - The time the ssl certificate associated with shard expires. An RFC3339 formatted datetime string
- time
Updated String - The time the Sharded Database was last updated. An RFC3339 formatted datetime string
- compute
Count number - The compute amount available to the underlying autonomous database associated with shard.
- data
Storage numberSize In Gbs - The data disk group size to be allocated in GBs.
- metadata {[key: string]: string}
- Additional metadata related to shard's underlying supporting resource.
- name string
- Name of the shard.
- status string
- Status of shard or catalog or gsm for the sharded database.
- supporting
Resource stringId - Identifier of the underlying supporting resource.
- time
Created string - The time the the Sharded Database was created. An RFC3339 formatted datetime string
- time
Ssl stringCertificate Expires - The time the ssl certificate associated with shard expires. An RFC3339 formatted datetime string
- time
Updated 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_ floatsize_ in_ gbs - The data disk group size to be allocated in GBs.
- metadata Mapping[str, str]
- Additional metadata related to shard's underlying supporting resource.
- name str
- Name of the shard.
- status str
- Status of shard or catalog or gsm for the sharded database.
- supporting_
resource_ strid - Identifier of the underlying supporting resource.
- time_
created str - The time the the Sharded Database was created. An RFC3339 formatted datetime string
- time_
ssl_ strcertificate_ expires - 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
- compute
Count Number - The compute amount available to the underlying autonomous database associated with shard.
- data
Storage NumberSize In Gbs - The data disk group size to be allocated in GBs.
- metadata Map<String>
- Additional metadata related to shard's underlying supporting resource.
- name String
- Name of the shard.
- status String
- Status of shard or catalog or gsm for the sharded database.
- supporting
Resource StringId - Identifier of the underlying supporting resource.
- time
Created String - The time the the Sharded Database was created. An RFC3339 formatted datetime string
- time
Ssl StringCertificate Expires - The time the ssl certificate associated with shard expires. An RFC3339 formatted datetime string
- time
Updated String - The time the Sharded Database was last updated. An RFC3339 formatted datetime string
ShardedDatabasePatchOperation, ShardedDatabasePatchOperationArgs
ShardedDatabaseShardDetail, ShardedDatabaseShardDetailArgs
- Admin
Password string - Admin password for shard database.
- Cloud
Autonomous stringVm Cluster Id - The OCID of the cloud Autonomous Exadata VM Cluster.
- Compute
Count double - The compute count for the shard database. It has to be in multiples of 2.
- Data
Storage doubleSize In Gbs - The data disk group size to be allocated in GBs for the shard database.
- Is
Auto boolScaling Enabled - Determines the auto-scaling mode for the shard database.
- Container
Database stringId - Identifier of the underlying container database.
- Container
Database stringParent Id - Identifier of the underlying container database parent.
- Encryption
Key ShardedDetails Database Shard Detail Encryption Key Details - 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).
- Metadata Dictionary<string, string>
- Additional metadata related to shard's underlying supporting resource.
- Name string
- Name of the shard.
- Peer
Cloud stringAutonomous Vm Cluster Id - The OCID of the peer cloud Autonomous Exadata VM Cluster.
- string
- Name of the shard-group to which the shard belongs.
- string
- The shard space name for the shard database. Shard space for existing shard cannot be changed, once shard is created. Shard space name shall be used while creation of new shards. For User defined sharding, every shard must have a unique shard space name. For system defined sharding, shard space name is not required.
- Status string
- Status of shard or catalog or gsm for the sharded database.
- Supporting
Resource stringId - Identifier of the underlying supporting resource.
- Time
Created string - The time the the Sharded Database was created. An RFC3339 formatted datetime string
- Time
Ssl stringCertificate Expires - The time the ssl certificate associated with shard expires. An RFC3339 formatted datetime string
- Time
Updated string - The time the Sharded Database was last updated. An RFC3339 formatted datetime string
- Admin
Password string - Admin password for shard database.
- Cloud
Autonomous stringVm Cluster Id - The OCID of the cloud Autonomous Exadata VM Cluster.
- Compute
Count float64 - The compute count for the shard database. It has to be in multiples of 2.
- Data
Storage float64Size In Gbs - The data disk group size to be allocated in GBs for the shard database.
- Is
Auto boolScaling Enabled - Determines the auto-scaling mode for the shard database.
- Container
Database stringId - Identifier of the underlying container database.
- Container
Database stringParent Id - Identifier of the underlying container database parent.
- Encryption
Key ShardedDetails Database Shard Detail Encryption Key Details - 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).
- Metadata map[string]string
- Additional metadata related to shard's underlying supporting resource.
- Name string
- Name of the shard.
- Peer
Cloud stringAutonomous Vm Cluster Id - The OCID of the peer cloud Autonomous Exadata VM Cluster.
- string
- Name of the shard-group to which the shard belongs.
- string
- The shard space name for the shard database. Shard space for existing shard cannot be changed, once shard is created. Shard space name shall be used while creation of new shards. For User defined sharding, every shard must have a unique shard space name. For system defined sharding, shard space name is not required.
- Status string
- Status of shard or catalog or gsm for the sharded database.
- Supporting
Resource stringId - Identifier of the underlying supporting resource.
- Time
Created string - The time the the Sharded Database was created. An RFC3339 formatted datetime string
- Time
Ssl stringCertificate Expires - The time the ssl certificate associated with shard expires. An RFC3339 formatted datetime string
- Time
Updated string - The time the Sharded Database was last updated. An RFC3339 formatted datetime string
- admin
Password String - Admin password for shard database.
- cloud
Autonomous StringVm Cluster Id - The OCID of the cloud Autonomous Exadata VM Cluster.
- compute
Count Double - The compute count for the shard database. It has to be in multiples of 2.
- data
Storage DoubleSize In Gbs - The data disk group size to be allocated in GBs for the shard database.
- is
Auto BooleanScaling Enabled - Determines the auto-scaling mode for the shard database.
- container
Database StringId - Identifier of the underlying container database.
- container
Database StringParent Id - Identifier of the underlying container database parent.
- encryption
Key ShardedDetails Database Shard Detail Encryption Key Details - 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).
- metadata Map<String,String>
- Additional metadata related to shard's underlying supporting resource.
- name String
- Name of the shard.
- peer
Cloud StringAutonomous Vm Cluster Id - The OCID of the peer cloud Autonomous Exadata VM Cluster.
- String
- Name of the shard-group to which the shard belongs.
- String
- The shard space name for the shard database. Shard space for existing shard cannot be changed, once shard is created. Shard space name shall be used while creation of new shards. For User defined sharding, every shard must have a unique shard space name. For system defined sharding, shard space name is not required.
- status String
- Status of shard or catalog or gsm for the sharded database.
- supporting
Resource StringId - Identifier of the underlying supporting resource.
- time
Created String - The time the the Sharded Database was created. An RFC3339 formatted datetime string
- time
Ssl StringCertificate Expires - The time the ssl certificate associated with shard expires. An RFC3339 formatted datetime string
- time
Updated String - The time the Sharded Database was last updated. An RFC3339 formatted datetime string
- admin
Password string - Admin password for shard database.
- cloud
Autonomous stringVm Cluster Id - The OCID of the cloud Autonomous Exadata VM Cluster.
- compute
Count number - The compute count for the shard database. It has to be in multiples of 2.
- data
Storage numberSize In Gbs - The data disk group size to be allocated in GBs for the shard database.
- is
Auto booleanScaling Enabled - Determines the auto-scaling mode for the shard database.
- container
Database stringId - Identifier of the underlying container database.
- container
Database stringParent Id - Identifier of the underlying container database parent.
- encryption
Key ShardedDetails Database Shard Detail Encryption Key Details - 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).
- metadata {[key: string]: string}
- Additional metadata related to shard's underlying supporting resource.
- name string
- Name of the shard.
- peer
Cloud stringAutonomous Vm Cluster Id - The OCID of the peer cloud Autonomous Exadata VM Cluster.
- string
- Name of the shard-group to which the shard belongs.
- string
- The shard space name for the shard database. Shard space for existing shard cannot be changed, once shard is created. Shard space name shall be used while creation of new shards. For User defined sharding, every shard must have a unique shard space name. For system defined sharding, shard space name is not required.
- status string
- Status of shard or catalog or gsm for the sharded database.
- supporting
Resource stringId - Identifier of the underlying supporting resource.
- time
Created string - The time the the Sharded Database was created. An RFC3339 formatted datetime string
- time
Ssl stringCertificate Expires - The time the ssl certificate associated with shard expires. An RFC3339 formatted datetime string
- time
Updated string - The time the Sharded Database was last updated. An RFC3339 formatted datetime string
- admin_
password str - Admin password for shard database.
- cloud_
autonomous_ strvm_ cluster_ id - The OCID of the cloud Autonomous Exadata VM Cluster.
- compute_
count float - The compute count for the shard database. It has to be in multiples of 2.
- data_
storage_ floatsize_ in_ gbs - The data disk group size to be allocated in GBs for the shard database.
- is_
auto_ boolscaling_ enabled - Determines the auto-scaling mode for the shard database.
- container_
database_ strid - Identifier of the underlying container database.
- container_
database_ strparent_ id - Identifier of the underlying container database parent.
- encryption_
key_ globallydistributeddatabase.details Sharded Database Shard Detail Encryption Key Details - 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).
- metadata Mapping[str, str]
- Additional metadata related to shard's underlying supporting resource.
- name str
- Name of the shard.
- peer_
cloud_ strautonomous_ vm_ cluster_ id - The OCID of the peer cloud Autonomous Exadata VM Cluster.
- str
- Name of the shard-group to which the shard belongs.
- str
- The shard space name for the shard database. Shard space for existing shard cannot be changed, once shard is created. Shard space name shall be used while creation of new shards. For User defined sharding, every shard must have a unique shard space name. For system defined sharding, shard space name is not required.
- status str
- Status of shard or catalog or gsm for the sharded database.
- supporting_
resource_ strid - Identifier of the underlying supporting resource.
- time_
created str - The time the the Sharded Database was created. An RFC3339 formatted datetime string
- time_
ssl_ strcertificate_ expires - 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
- admin
Password String - Admin password for shard database.
- cloud
Autonomous StringVm Cluster Id - The OCID of the cloud Autonomous Exadata VM Cluster.
- compute
Count Number - The compute count for the shard database. It has to be in multiples of 2.
- data
Storage NumberSize In Gbs - The data disk group size to be allocated in GBs for the shard database.
- is
Auto BooleanScaling Enabled - Determines the auto-scaling mode for the shard database.
- container
Database StringId - Identifier of the underlying container database.
- container
Database StringParent Id - Identifier of the underlying container database parent.
- encryption
Key Property MapDetails - 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).
- metadata Map<String>
- Additional metadata related to shard's underlying supporting resource.
- name String
- Name of the shard.
- peer
Cloud StringAutonomous Vm Cluster Id - The OCID of the peer cloud Autonomous Exadata VM Cluster.
- String
- Name of the shard-group to which the shard belongs.
- String
- The shard space name for the shard database. Shard space for existing shard cannot be changed, once shard is created. Shard space name shall be used while creation of new shards. For User defined sharding, every shard must have a unique shard space name. For system defined sharding, shard space name is not required.
- status String
- Status of shard or catalog or gsm for the sharded database.
- supporting
Resource StringId - Identifier of the underlying supporting resource.
- time
Created String - The time the the Sharded Database was created. An RFC3339 formatted datetime string
- time
Ssl StringCertificate Expires - The time the ssl certificate associated with shard expires. An RFC3339 formatted datetime string
- time
Updated String - The time the Sharded Database was last updated. An RFC3339 formatted datetime string
ShardedDatabaseShardDetailEncryptionKeyDetails, ShardedDatabaseShardDetailEncryptionKeyDetailsArgs
- Kms
Key stringId - The OCID of the KMS key in vault identified by vaultId in customer tenancy that is used as the master encryption key.
- Vault
Id 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 stringVersion Id - The OCID of the KMS key version for key identified by kmsKeyId that is used in data encryption (TDE) operations.
- Kms
Key stringId - The OCID of the KMS key in vault identified by vaultId in customer tenancy that is used as the master encryption key.
- Vault
Id 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 stringVersion Id - The OCID of the KMS key version for key identified by kmsKeyId that is used in data encryption (TDE) operations.
- kms
Key StringId - The OCID of the KMS key in vault identified by vaultId in customer tenancy that is used as the master encryption key.
- vault
Id 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 StringVersion Id - The OCID of the KMS key version for key identified by kmsKeyId that is used in data encryption (TDE) operations.
- kms
Key stringId - The OCID of the KMS key in vault identified by vaultId in customer tenancy that is used as the master encryption key.
- vault
Id 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 stringVersion Id - The OCID of the KMS key version for key identified by kmsKeyId that is used in data encryption (TDE) operations.
- kms_
key_ strid - The OCID of the KMS key in vault identified by vaultId in customer tenancy that is used as the master encryption key.
- 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.
- kms_
key_ strversion_ id - The OCID of the KMS key version for key identified by kmsKeyId that is used in data encryption (TDE) operations.
- kms
Key StringId - The OCID of the KMS key in vault identified by vaultId in customer tenancy that is used as the master encryption key.
- vault
Id 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 StringVersion Id - The OCID of the KMS key version for key identified by kmsKeyId that is used in data encryption (TDE) operations.
Import
ShardedDatabases can be imported using the id
, e.g.
$ pulumi import oci:GloballyDistributedDatabase/shardedDatabase:ShardedDatabase test_sharded_database "id"
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
oci
Terraform Provider.