Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. GloballyDistributedDatabase
  5. ShardedDatabase
Oracle Cloud Infrastructure v2.30.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-oci

oci.GloballyDistributedDatabase.ShardedDatabase

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.30.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-oci

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}
      replicationFactor: ${shardedDatabaseReplicationFactor}
      replicationMethod: ${shardedDatabaseReplicationMethod}
      replicationUnit: ${shardedDatabaseReplicationUnit}
Copy

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,
                    listener_port: Optional[int] = None,
                    catalog_details: Optional[Sequence[_globallydistributeddatabase.ShardedDatabaseCatalogDetailArgs]] = None,
                    character_set: Optional[str] = None,
                    sharding_method: Optional[str] = None,
                    shard_details: Optional[Sequence[_globallydistributeddatabase.ShardedDatabaseShardDetailArgs]] = None,
                    compartment_id: Optional[str] = None,
                    prefix: Optional[str] = None,
                    ons_port_remote: Optional[int] = None,
                    ons_port_local: Optional[int] = None,
                    ncharacter_set: Optional[str] = None,
                    db_deployment_type: Optional[str] = None,
                    db_version: Optional[str] = None,
                    db_workload: Optional[str] = None,
                    listener_port_tls: Optional[int] = None,
                    display_name: Optional[str] = None,
                    configure_sharding_trigger: Optional[int] = None,
                    patch_operations: Optional[Sequence[_globallydistributeddatabase.ShardedDatabasePatchOperationArgs]] = None,
                    generate_gsm_certificate_signing_request_trigger: Optional[int] = None,
                    generate_wallet_password: Optional[str] = None,
                    generate_wallet_trigger: Optional[int] = None,
                    get_connection_string_trigger: Optional[int] = None,
                    download_gsm_certificate_signing_request_trigger: Optional[int] = None,
                    defined_tags: Optional[Mapping[str, str]] = None,
                    ca_signed_certificate: Optional[str] = None,
                    configure_gsms_trigger_old_gsm_names: Optional[Sequence[str]] = None,
                    configure_gsms_trigger_is_latest_gsm_image: Optional[bool] = None,
                    freeform_tags: Optional[Mapping[str, str]] = None,
                    configure_gsms_trigger: Optional[int] = None,
                    replication_factor: Optional[int] = None,
                    replication_method: Optional[str] = None,
                    replication_unit: Optional[int] = None,
                    cluster_certificate_common_name: Optional[str] = None,
                    chunks: Optional[int] = None,
                    start_database_trigger: Optional[int] = None,
                    stop_database_trigger: Optional[int] = None,
                    upload_signed_certificate_and_generate_wallet_trigger: Optional[int] = None,
                    validate_network_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 This property is required. string
The unique name of the resource.
args This property is required. ShardedDatabaseArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. 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 This property is required. string
The unique name of the resource.
args This property is required. ShardedDatabaseArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ShardedDatabaseArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. 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()
{
    ListenerPort = 0,
    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",
        },
    },
    CharacterSet = "string",
    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",
    Prefix = "string",
    OnsPortRemote = 0,
    OnsPortLocal = 0,
    NcharacterSet = "string",
    DbDeploymentType = "string",
    DbVersion = "string",
    DbWorkload = "string",
    ListenerPortTls = 0,
    DisplayName = "string",
    ConfigureShardingTrigger = 0,
    PatchOperations = new[]
    {
        new Oci.GloballyDistributedDatabase.Inputs.ShardedDatabasePatchOperationArgs
        {
            Operation = "string",
            Selection = "string",
            Value = "string",
        },
    },
    GenerateGsmCertificateSigningRequestTrigger = 0,
    GenerateWalletPassword = "string",
    GenerateWalletTrigger = 0,
    GetConnectionStringTrigger = 0,
    DownloadGsmCertificateSigningRequestTrigger = 0,
    DefinedTags = 
    {
        { "string", "string" },
    },
    CaSignedCertificate = "string",
    ConfigureGsmsTriggerOldGsmNames = new[]
    {
        "string",
    },
    ConfigureGsmsTriggerIsLatestGsmImage = false,
    FreeformTags = 
    {
        { "string", "string" },
    },
    ConfigureGsmsTrigger = 0,
    ReplicationFactor = 0,
    ReplicationMethod = "string",
    ReplicationUnit = 0,
    ClusterCertificateCommonName = "string",
    Chunks = 0,
    StartDatabaseTrigger = 0,
    StopDatabaseTrigger = 0,
    UploadSignedCertificateAndGenerateWalletTrigger = 0,
    ValidateNetworkTrigger = 0,
});
Copy
example, err := GloballyDistributedDatabase.NewShardedDatabase(ctx, "shardedDatabaseResource", &GloballyDistributedDatabase.ShardedDatabaseArgs{
	ListenerPort: pulumi.Int(0),
	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"),
		},
	},
	CharacterSet:   pulumi.String("string"),
	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"),
	Prefix:                   pulumi.String("string"),
	OnsPortRemote:            pulumi.Int(0),
	OnsPortLocal:             pulumi.Int(0),
	NcharacterSet:            pulumi.String("string"),
	DbDeploymentType:         pulumi.String("string"),
	DbVersion:                pulumi.String("string"),
	DbWorkload:               pulumi.String("string"),
	ListenerPortTls:          pulumi.Int(0),
	DisplayName:              pulumi.String("string"),
	ConfigureShardingTrigger: pulumi.Int(0),
	PatchOperations: globallydistributeddatabase.ShardedDatabasePatchOperationArray{
		&globallydistributeddatabase.ShardedDatabasePatchOperationArgs{
			Operation: pulumi.String("string"),
			Selection: pulumi.String("string"),
			Value:     pulumi.String("string"),
		},
	},
	GenerateGsmCertificateSigningRequestTrigger: pulumi.Int(0),
	GenerateWalletPassword:                      pulumi.String("string"),
	GenerateWalletTrigger:                       pulumi.Int(0),
	GetConnectionStringTrigger:                  pulumi.Int(0),
	DownloadGsmCertificateSigningRequestTrigger: pulumi.Int(0),
	DefinedTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	CaSignedCertificate: pulumi.String("string"),
	ConfigureGsmsTriggerOldGsmNames: pulumi.StringArray{
		pulumi.String("string"),
	},
	ConfigureGsmsTriggerIsLatestGsmImage: pulumi.Bool(false),
	FreeformTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	ConfigureGsmsTrigger:         pulumi.Int(0),
	ReplicationFactor:            pulumi.Int(0),
	ReplicationMethod:            pulumi.String("string"),
	ReplicationUnit:              pulumi.Int(0),
	ClusterCertificateCommonName: pulumi.String("string"),
	Chunks:                       pulumi.Int(0),
	StartDatabaseTrigger:         pulumi.Int(0),
	StopDatabaseTrigger:          pulumi.Int(0),
	UploadSignedCertificateAndGenerateWalletTrigger: pulumi.Int(0),
	ValidateNetworkTrigger:                          pulumi.Int(0),
})
Copy
var shardedDatabaseResource = new ShardedDatabase("shardedDatabaseResource", ShardedDatabaseArgs.builder()
    .listenerPort(0)
    .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())
    .characterSet("string")
    .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")
    .prefix("string")
    .onsPortRemote(0)
    .onsPortLocal(0)
    .ncharacterSet("string")
    .dbDeploymentType("string")
    .dbVersion("string")
    .dbWorkload("string")
    .listenerPortTls(0)
    .displayName("string")
    .configureShardingTrigger(0)
    .patchOperations(ShardedDatabasePatchOperationArgs.builder()
        .operation("string")
        .selection("string")
        .value("string")
        .build())
    .generateGsmCertificateSigningRequestTrigger(0)
    .generateWalletPassword("string")
    .generateWalletTrigger(0)
    .getConnectionStringTrigger(0)
    .downloadGsmCertificateSigningRequestTrigger(0)
    .definedTags(Map.of("string", "string"))
    .caSignedCertificate("string")
    .configureGsmsTriggerOldGsmNames("string")
    .configureGsmsTriggerIsLatestGsmImage(false)
    .freeformTags(Map.of("string", "string"))
    .configureGsmsTrigger(0)
    .replicationFactor(0)
    .replicationMethod("string")
    .replicationUnit(0)
    .clusterCertificateCommonName("string")
    .chunks(0)
    .startDatabaseTrigger(0)
    .stopDatabaseTrigger(0)
    .uploadSignedCertificateAndGenerateWalletTrigger(0)
    .validateNetworkTrigger(0)
    .build());
Copy
sharded_database_resource = oci.globally_distributed_database.ShardedDatabase("shardedDatabaseResource",
    listener_port=0,
    catalog_details=[{
        "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": {
            "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",
    }],
    character_set="string",
    sharding_method="string",
    shard_details=[{
        "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": {
            "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",
    prefix="string",
    ons_port_remote=0,
    ons_port_local=0,
    ncharacter_set="string",
    db_deployment_type="string",
    db_version="string",
    db_workload="string",
    listener_port_tls=0,
    display_name="string",
    configure_sharding_trigger=0,
    patch_operations=[{
        "operation": "string",
        "selection": "string",
        "value": "string",
    }],
    generate_gsm_certificate_signing_request_trigger=0,
    generate_wallet_password="string",
    generate_wallet_trigger=0,
    get_connection_string_trigger=0,
    download_gsm_certificate_signing_request_trigger=0,
    defined_tags={
        "string": "string",
    },
    ca_signed_certificate="string",
    configure_gsms_trigger_old_gsm_names=["string"],
    configure_gsms_trigger_is_latest_gsm_image=False,
    freeform_tags={
        "string": "string",
    },
    configure_gsms_trigger=0,
    replication_factor=0,
    replication_method="string",
    replication_unit=0,
    cluster_certificate_common_name="string",
    chunks=0,
    start_database_trigger=0,
    stop_database_trigger=0,
    upload_signed_certificate_and_generate_wallet_trigger=0,
    validate_network_trigger=0)
Copy
const shardedDatabaseResource = new oci.globallydistributeddatabase.ShardedDatabase("shardedDatabaseResource", {
    listenerPort: 0,
    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",
    }],
    characterSet: "string",
    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",
    prefix: "string",
    onsPortRemote: 0,
    onsPortLocal: 0,
    ncharacterSet: "string",
    dbDeploymentType: "string",
    dbVersion: "string",
    dbWorkload: "string",
    listenerPortTls: 0,
    displayName: "string",
    configureShardingTrigger: 0,
    patchOperations: [{
        operation: "string",
        selection: "string",
        value: "string",
    }],
    generateGsmCertificateSigningRequestTrigger: 0,
    generateWalletPassword: "string",
    generateWalletTrigger: 0,
    getConnectionStringTrigger: 0,
    downloadGsmCertificateSigningRequestTrigger: 0,
    definedTags: {
        string: "string",
    },
    caSignedCertificate: "string",
    configureGsmsTriggerOldGsmNames: ["string"],
    configureGsmsTriggerIsLatestGsmImage: false,
    freeformTags: {
        string: "string",
    },
    configureGsmsTrigger: 0,
    replicationFactor: 0,
    replicationMethod: "string",
    replicationUnit: 0,
    clusterCertificateCommonName: "string",
    chunks: 0,
    startDatabaseTrigger: 0,
    stopDatabaseTrigger: 0,
    uploadSignedCertificateAndGenerateWalletTrigger: 0,
    validateNetworkTrigger: 0,
});
Copy
type: oci:GloballyDistributedDatabase:ShardedDatabase
properties:
    caSignedCertificate: string
    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
    configureGsmsTrigger: 0
    configureGsmsTriggerIsLatestGsmImage: false
    configureGsmsTriggerOldGsmNames:
        - string
    configureShardingTrigger: 0
    dbDeploymentType: string
    dbVersion: string
    dbWorkload: string
    definedTags:
        string: string
    displayName: string
    downloadGsmCertificateSigningRequestTrigger: 0
    freeformTags:
        string: string
    generateGsmCertificateSigningRequestTrigger: 0
    generateWalletPassword: string
    generateWalletTrigger: 0
    getConnectionStringTrigger: 0
    listenerPort: 0
    listenerPortTls: 0
    ncharacterSet: string
    onsPortLocal: 0
    onsPortRemote: 0
    patchOperations:
        - operation: string
          selection: string
          value: string
    prefix: string
    replicationFactor: 0
    replicationMethod: string
    replicationUnit: 0
    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
    uploadSignedCertificateAndGenerateWalletTrigger: 0
    validateNetworkTrigger: 0
Copy

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

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The ShardedDatabase resource accepts the following input properties:

CatalogDetails
This property is required.
Changes to this property will trigger replacement.
List<ShardedDatabaseCatalogDetail>
Collection of ATP-Dedicated catalogs that needs to be created.
CharacterSet
This property is required.
Changes to this property will trigger replacement.
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
CompartmentId This property is required. string
(Updatable) Identifier of the compartment where sharded database is to be created.
DbDeploymentType
This property is required.
Changes to this property will trigger replacement.
string
The database deployment type.
DbVersion
This property is required.
Changes to this property will trigger replacement.
string
Oracle Database version of the Autonomous Container Database.
DbWorkload
This property is required.
Changes to this property will trigger replacement.
string
Possible workload types.
DisplayName This property is required. string
(Updatable) Oracle sharded database display name.
ListenerPort
This property is required.
Changes to this property will trigger replacement.
int
The listener port number for sharded database.
ListenerPortTls
This property is required.
Changes to this property will trigger replacement.
int
The TLS listener port number for sharded database.
NcharacterSet
This property is required.
Changes to this property will trigger replacement.
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
OnsPortLocal
This property is required.
Changes to this property will trigger replacement.
int
Ons port local for sharded database.
OnsPortRemote
This property is required.
Changes to this property will trigger replacement.
int
Ons remote port for sharded database.
Prefix
This property is required.
Changes to this property will trigger replacement.
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.
ShardDetails
This property is required.
Changes to this property will trigger replacement.
List<ShardedDatabaseShardDetail>
Collection of ATP-Dedicated shards that needs to be created.
ShardingMethod
This property is required.
Changes to this property will trigger replacement.
string
Sharding Method.
CaSignedCertificate string
Chunks Changes to this property will trigger replacement. int
The default number of unique chunks in a shardspace. The value of chunks must be greater than 2 times the size of the largest shardgroup in any shardspace.
ClusterCertificateCommonName Changes to this property will trigger replacement. string
The certificate common name used in all cloudAutonomousVmClusters for the sharded database topology. Eg. Production. All the clusters used in one sharded database topology shall have same CABundle setup. Valid characterset for clusterCertificateCommonName include uppercase or lowercase letters, numbers, hyphens, underscores, and period.
ConfigureGsmsTrigger int
(Updatable) An optional property when incremented triggers Configure Gsms. Could be set to any integer value.
ConfigureGsmsTriggerIsLatestGsmImage bool
ConfigureGsmsTriggerOldGsmNames List<string>
ConfigureShardingTrigger int
(Updatable) An optional property when incremented triggers Configure Sharding. Could be set to any integer value.
DefinedTags Dictionary<string, string>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
DownloadGsmCertificateSigningRequestTrigger int
(Updatable) An optional property when incremented triggers Download Gsm Certificate Signing Request. Could be set to any integer value.
FreeformTags 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"}
GenerateGsmCertificateSigningRequestTrigger int
(Updatable) An optional property when incremented triggers Generate Gsm Certificate Signing Request. Could be set to any integer value.
GenerateWalletPassword string
GenerateWalletTrigger int
(Updatable) An optional property when incremented triggers Generate Wallet. Could be set to any integer value.
GetConnectionStringTrigger int
(Updatable) An optional property when incremented triggers Get Connection String. Could be set to any integer value.
PatchOperations List<ShardedDatabasePatchOperation>
(Updatable)
ReplicationFactor Changes to this property will trigger replacement. int
The Replication factor for RAFT replication based sharded database. Currently supported values are 3, 5 and 7.
ReplicationMethod Changes to this property will trigger replacement. string
The Replication method for sharded database.
ReplicationUnit Changes to this property will trigger replacement. int
For RAFT replication based sharded database, the value should be atleast twice the number of shards.
StartDatabaseTrigger int
(Updatable) An optional property when incremented triggers Start Database. Could be set to any integer value.
StopDatabaseTrigger int
(Updatable) An optional property when incremented triggers Stop Database. Could be set to any integer value.
UploadSignedCertificateAndGenerateWalletTrigger int
(Updatable) An optional property when incremented triggers Upload Signed Certificate And Generate Wallet. Could be set to any integer value.
ValidateNetworkTrigger int

(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

CatalogDetails
This property is required.
Changes to this property will trigger replacement.
[]ShardedDatabaseCatalogDetailArgs
Collection of ATP-Dedicated catalogs that needs to be created.
CharacterSet
This property is required.
Changes to this property will trigger replacement.
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
CompartmentId This property is required. string
(Updatable) Identifier of the compartment where sharded database is to be created.
DbDeploymentType
This property is required.
Changes to this property will trigger replacement.
string
The database deployment type.
DbVersion
This property is required.
Changes to this property will trigger replacement.
string
Oracle Database version of the Autonomous Container Database.
DbWorkload
This property is required.
Changes to this property will trigger replacement.
string
Possible workload types.
DisplayName This property is required. string
(Updatable) Oracle sharded database display name.
ListenerPort
This property is required.
Changes to this property will trigger replacement.
int
The listener port number for sharded database.
ListenerPortTls
This property is required.
Changes to this property will trigger replacement.
int
The TLS listener port number for sharded database.
NcharacterSet
This property is required.
Changes to this property will trigger replacement.
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
OnsPortLocal
This property is required.
Changes to this property will trigger replacement.
int
Ons port local for sharded database.
OnsPortRemote
This property is required.
Changes to this property will trigger replacement.
int
Ons remote port for sharded database.
Prefix
This property is required.
Changes to this property will trigger replacement.
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.
ShardDetails
This property is required.
Changes to this property will trigger replacement.
[]ShardedDatabaseShardDetailArgs
Collection of ATP-Dedicated shards that needs to be created.
ShardingMethod
This property is required.
Changes to this property will trigger replacement.
string
Sharding Method.
CaSignedCertificate string
Chunks Changes to this property will trigger replacement. int
The default number of unique chunks in a shardspace. The value of chunks must be greater than 2 times the size of the largest shardgroup in any shardspace.
ClusterCertificateCommonName Changes to this property will trigger replacement. string
The certificate common name used in all cloudAutonomousVmClusters for the sharded database topology. Eg. Production. All the clusters used in one sharded database topology shall have same CABundle setup. Valid characterset for clusterCertificateCommonName include uppercase or lowercase letters, numbers, hyphens, underscores, and period.
ConfigureGsmsTrigger int
(Updatable) An optional property when incremented triggers Configure Gsms. Could be set to any integer value.
ConfigureGsmsTriggerIsLatestGsmImage bool
ConfigureGsmsTriggerOldGsmNames []string
ConfigureShardingTrigger int
(Updatable) An optional property when incremented triggers Configure Sharding. Could be set to any integer value.
DefinedTags map[string]string
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
DownloadGsmCertificateSigningRequestTrigger int
(Updatable) An optional property when incremented triggers Download Gsm Certificate Signing Request. Could be set to any integer value.
FreeformTags 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"}
GenerateGsmCertificateSigningRequestTrigger int
(Updatable) An optional property when incremented triggers Generate Gsm Certificate Signing Request. Could be set to any integer value.
GenerateWalletPassword string
GenerateWalletTrigger int
(Updatable) An optional property when incremented triggers Generate Wallet. Could be set to any integer value.
GetConnectionStringTrigger int
(Updatable) An optional property when incremented triggers Get Connection String. Could be set to any integer value.
PatchOperations []ShardedDatabasePatchOperationArgs
(Updatable)
ReplicationFactor Changes to this property will trigger replacement. int
The Replication factor for RAFT replication based sharded database. Currently supported values are 3, 5 and 7.
ReplicationMethod Changes to this property will trigger replacement. string
The Replication method for sharded database.
ReplicationUnit Changes to this property will trigger replacement. int
For RAFT replication based sharded database, the value should be atleast twice the number of shards.
StartDatabaseTrigger int
(Updatable) An optional property when incremented triggers Start Database. Could be set to any integer value.
StopDatabaseTrigger int
(Updatable) An optional property when incremented triggers Stop Database. Could be set to any integer value.
UploadSignedCertificateAndGenerateWalletTrigger int
(Updatable) An optional property when incremented triggers Upload Signed Certificate And Generate Wallet. Could be set to any integer value.
ValidateNetworkTrigger int

(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

catalogDetails
This property is required.
Changes to this property will trigger replacement.
List<ShardedDatabaseCatalogDetail>
Collection of ATP-Dedicated catalogs that needs to be created.
characterSet
This property is required.
Changes to this property will trigger replacement.
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
compartmentId This property is required. String
(Updatable) Identifier of the compartment where sharded database is to be created.
dbDeploymentType
This property is required.
Changes to this property will trigger replacement.
String
The database deployment type.
dbVersion
This property is required.
Changes to this property will trigger replacement.
String
Oracle Database version of the Autonomous Container Database.
dbWorkload
This property is required.
Changes to this property will trigger replacement.
String
Possible workload types.
displayName This property is required. String
(Updatable) Oracle sharded database display name.
listenerPort
This property is required.
Changes to this property will trigger replacement.
Integer
The listener port number for sharded database.
listenerPortTls
This property is required.
Changes to this property will trigger replacement.
Integer
The TLS listener port number for sharded database.
ncharacterSet
This property is required.
Changes to this property will trigger replacement.
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
onsPortLocal
This property is required.
Changes to this property will trigger replacement.
Integer
Ons port local for sharded database.
onsPortRemote
This property is required.
Changes to this property will trigger replacement.
Integer
Ons remote port for sharded database.
prefix
This property is required.
Changes to this property will trigger replacement.
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.
shardDetails
This property is required.
Changes to this property will trigger replacement.
List<ShardedDatabaseShardDetail>
Collection of ATP-Dedicated shards that needs to be created.
shardingMethod
This property is required.
Changes to this property will trigger replacement.
String
Sharding Method.
caSignedCertificate String
chunks Changes to this property will trigger replacement. Integer
The default number of unique chunks in a shardspace. The value of chunks must be greater than 2 times the size of the largest shardgroup in any shardspace.
clusterCertificateCommonName Changes to this property will trigger replacement. String
The certificate common name used in all cloudAutonomousVmClusters for the sharded database topology. Eg. Production. All the clusters used in one sharded database topology shall have same CABundle setup. Valid characterset for clusterCertificateCommonName include uppercase or lowercase letters, numbers, hyphens, underscores, and period.
configureGsmsTrigger Integer
(Updatable) An optional property when incremented triggers Configure Gsms. Could be set to any integer value.
configureGsmsTriggerIsLatestGsmImage Boolean
configureGsmsTriggerOldGsmNames List<String>
configureShardingTrigger Integer
(Updatable) An optional property when incremented triggers Configure Sharding. Could be set to any integer value.
definedTags Map<String,String>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
downloadGsmCertificateSigningRequestTrigger Integer
(Updatable) An optional property when incremented triggers Download Gsm Certificate Signing Request. Could be set to any integer value.
freeformTags 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"}
generateGsmCertificateSigningRequestTrigger Integer
(Updatable) An optional property when incremented triggers Generate Gsm Certificate Signing Request. Could be set to any integer value.
generateWalletPassword String
generateWalletTrigger Integer
(Updatable) An optional property when incremented triggers Generate Wallet. Could be set to any integer value.
getConnectionStringTrigger Integer
(Updatable) An optional property when incremented triggers Get Connection String. Could be set to any integer value.
patchOperations List<ShardedDatabasePatchOperation>
(Updatable)
replicationFactor Changes to this property will trigger replacement. Integer
The Replication factor for RAFT replication based sharded database. Currently supported values are 3, 5 and 7.
replicationMethod Changes to this property will trigger replacement. String
The Replication method for sharded database.
replicationUnit Changes to this property will trigger replacement. Integer
For RAFT replication based sharded database, the value should be atleast twice the number of shards.
startDatabaseTrigger Integer
(Updatable) An optional property when incremented triggers Start Database. Could be set to any integer value.
stopDatabaseTrigger Integer
(Updatable) An optional property when incremented triggers Stop Database. Could be set to any integer value.
uploadSignedCertificateAndGenerateWalletTrigger Integer
(Updatable) An optional property when incremented triggers Upload Signed Certificate And Generate Wallet. Could be set to any integer value.
validateNetworkTrigger Integer

(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

catalogDetails
This property is required.
Changes to this property will trigger replacement.
ShardedDatabaseCatalogDetail[]
Collection of ATP-Dedicated catalogs that needs to be created.
characterSet
This property is required.
Changes to this property will trigger replacement.
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
compartmentId This property is required. string
(Updatable) Identifier of the compartment where sharded database is to be created.
dbDeploymentType
This property is required.
Changes to this property will trigger replacement.
string
The database deployment type.
dbVersion
This property is required.
Changes to this property will trigger replacement.
string
Oracle Database version of the Autonomous Container Database.
dbWorkload
This property is required.
Changes to this property will trigger replacement.
string
Possible workload types.
displayName This property is required. string
(Updatable) Oracle sharded database display name.
listenerPort
This property is required.
Changes to this property will trigger replacement.
number
The listener port number for sharded database.
listenerPortTls
This property is required.
Changes to this property will trigger replacement.
number
The TLS listener port number for sharded database.
ncharacterSet
This property is required.
Changes to this property will trigger replacement.
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
onsPortLocal
This property is required.
Changes to this property will trigger replacement.
number
Ons port local for sharded database.
onsPortRemote
This property is required.
Changes to this property will trigger replacement.
number
Ons remote port for sharded database.
prefix
This property is required.
Changes to this property will trigger replacement.
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.
shardDetails
This property is required.
Changes to this property will trigger replacement.
ShardedDatabaseShardDetail[]
Collection of ATP-Dedicated shards that needs to be created.
shardingMethod
This property is required.
Changes to this property will trigger replacement.
string
Sharding Method.
caSignedCertificate string
chunks Changes to this property will trigger replacement. number
The default number of unique chunks in a shardspace. The value of chunks must be greater than 2 times the size of the largest shardgroup in any shardspace.
clusterCertificateCommonName Changes to this property will trigger replacement. string
The certificate common name used in all cloudAutonomousVmClusters for the sharded database topology. Eg. Production. All the clusters used in one sharded database topology shall have same CABundle setup. Valid characterset for clusterCertificateCommonName include uppercase or lowercase letters, numbers, hyphens, underscores, and period.
configureGsmsTrigger number
(Updatable) An optional property when incremented triggers Configure Gsms. Could be set to any integer value.
configureGsmsTriggerIsLatestGsmImage boolean
configureGsmsTriggerOldGsmNames string[]
configureShardingTrigger number
(Updatable) An optional property when incremented triggers Configure Sharding. Could be set to any integer value.
definedTags {[key: string]: string}
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
downloadGsmCertificateSigningRequestTrigger number
(Updatable) An optional property when incremented triggers Download Gsm Certificate Signing Request. Could be set to any integer value.
freeformTags {[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"}
generateGsmCertificateSigningRequestTrigger number
(Updatable) An optional property when incremented triggers Generate Gsm Certificate Signing Request. Could be set to any integer value.
generateWalletPassword string
generateWalletTrigger number
(Updatable) An optional property when incremented triggers Generate Wallet. Could be set to any integer value.
getConnectionStringTrigger number
(Updatable) An optional property when incremented triggers Get Connection String. Could be set to any integer value.
patchOperations ShardedDatabasePatchOperation[]
(Updatable)
replicationFactor Changes to this property will trigger replacement. number
The Replication factor for RAFT replication based sharded database. Currently supported values are 3, 5 and 7.
replicationMethod Changes to this property will trigger replacement. string
The Replication method for sharded database.
replicationUnit Changes to this property will trigger replacement. number
For RAFT replication based sharded database, the value should be atleast twice the number of shards.
startDatabaseTrigger number
(Updatable) An optional property when incremented triggers Start Database. Could be set to any integer value.
stopDatabaseTrigger number
(Updatable) An optional property when incremented triggers Stop Database. Could be set to any integer value.
uploadSignedCertificateAndGenerateWalletTrigger number
(Updatable) An optional property when incremented triggers Upload Signed Certificate And Generate Wallet. Could be set to any integer value.
validateNetworkTrigger number

(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
This property is required.
Changes to this property will trigger replacement.
Sequence[globallydistributeddatabase.ShardedDatabaseCatalogDetailArgs]
Collection of ATP-Dedicated catalogs that needs to be created.
character_set
This property is required.
Changes to this property will trigger replacement.
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 This property is required. str
(Updatable) Identifier of the compartment where sharded database is to be created.
db_deployment_type
This property is required.
Changes to this property will trigger replacement.
str
The database deployment type.
db_version
This property is required.
Changes to this property will trigger replacement.
str
Oracle Database version of the Autonomous Container Database.
db_workload
This property is required.
Changes to this property will trigger replacement.
str
Possible workload types.
display_name This property is required. str
(Updatable) Oracle sharded database display name.
listener_port
This property is required.
Changes to this property will trigger replacement.
int
The listener port number for sharded database.
listener_port_tls
This property is required.
Changes to this property will trigger replacement.
int
The TLS listener port number for sharded database.
ncharacter_set
This property is required.
Changes to this property will trigger replacement.
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_local
This property is required.
Changes to this property will trigger replacement.
int
Ons port local for sharded database.
ons_port_remote
This property is required.
Changes to this property will trigger replacement.
int
Ons remote port for sharded database.
prefix
This property is required.
Changes to this property will trigger replacement.
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.
shard_details
This property is required.
Changes to this property will trigger replacement.
Sequence[globallydistributeddatabase.ShardedDatabaseShardDetailArgs]
Collection of ATP-Dedicated shards that needs to be created.
sharding_method
This property is required.
Changes to this property will trigger replacement.
str
Sharding Method.
ca_signed_certificate str
chunks Changes to this property will trigger replacement. int
The default number of unique chunks in a shardspace. The value of chunks must be greater than 2 times the size of the largest shardgroup in any shardspace.
cluster_certificate_common_name Changes to this property will trigger replacement. str
The certificate common name used in all cloudAutonomousVmClusters for the sharded database topology. Eg. Production. All the clusters used in one sharded database topology shall have same CABundle setup. Valid characterset for clusterCertificateCommonName include uppercase or lowercase letters, numbers, hyphens, underscores, and period.
configure_gsms_trigger int
(Updatable) An optional property when incremented triggers Configure Gsms. Could be set to any integer value.
configure_gsms_trigger_is_latest_gsm_image bool
configure_gsms_trigger_old_gsm_names Sequence[str]
configure_sharding_trigger int
(Updatable) An optional property when incremented triggers Configure Sharding. Could be set to any integer value.
defined_tags 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_certificate_signing_request_trigger int
(Updatable) An optional property when incremented triggers Download Gsm Certificate Signing Request. Could be set to any integer value.
freeform_tags 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_certificate_signing_request_trigger int
(Updatable) An optional property when incremented triggers Generate Gsm Certificate Signing Request. Could be set to any integer value.
generate_wallet_password str
generate_wallet_trigger int
(Updatable) An optional property when incremented triggers Generate Wallet. Could be set to any integer value.
get_connection_string_trigger int
(Updatable) An optional property when incremented triggers Get Connection String. Could be set to any integer value.
patch_operations Sequence[globallydistributeddatabase.ShardedDatabasePatchOperationArgs]
(Updatable)
replication_factor Changes to this property will trigger replacement. int
The Replication factor for RAFT replication based sharded database. Currently supported values are 3, 5 and 7.
replication_method Changes to this property will trigger replacement. str
The Replication method for sharded database.
replication_unit Changes to this property will trigger replacement. int
For RAFT replication based sharded database, the value should be atleast twice the number of shards.
start_database_trigger int
(Updatable) An optional property when incremented triggers Start Database. Could be set to any integer value.
stop_database_trigger int
(Updatable) An optional property when incremented triggers Stop Database. Could be set to any integer value.
upload_signed_certificate_and_generate_wallet_trigger int
(Updatable) An optional property when incremented triggers Upload Signed Certificate And Generate Wallet. Could be set to any integer value.
validate_network_trigger int

(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

catalogDetails
This property is required.
Changes to this property will trigger replacement.
List<Property Map>
Collection of ATP-Dedicated catalogs that needs to be created.
characterSet
This property is required.
Changes to this property will trigger replacement.
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
compartmentId This property is required. String
(Updatable) Identifier of the compartment where sharded database is to be created.
dbDeploymentType
This property is required.
Changes to this property will trigger replacement.
String
The database deployment type.
dbVersion
This property is required.
Changes to this property will trigger replacement.
String
Oracle Database version of the Autonomous Container Database.
dbWorkload
This property is required.
Changes to this property will trigger replacement.
String
Possible workload types.
displayName This property is required. String
(Updatable) Oracle sharded database display name.
listenerPort
This property is required.
Changes to this property will trigger replacement.
Number
The listener port number for sharded database.
listenerPortTls
This property is required.
Changes to this property will trigger replacement.
Number
The TLS listener port number for sharded database.
ncharacterSet
This property is required.
Changes to this property will trigger replacement.
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
onsPortLocal
This property is required.
Changes to this property will trigger replacement.
Number
Ons port local for sharded database.
onsPortRemote
This property is required.
Changes to this property will trigger replacement.
Number
Ons remote port for sharded database.
prefix
This property is required.
Changes to this property will trigger replacement.
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.
shardDetails
This property is required.
Changes to this property will trigger replacement.
List<Property Map>
Collection of ATP-Dedicated shards that needs to be created.
shardingMethod
This property is required.
Changes to this property will trigger replacement.
String
Sharding Method.
caSignedCertificate String
chunks Changes to this property will trigger replacement. Number
The default number of unique chunks in a shardspace. The value of chunks must be greater than 2 times the size of the largest shardgroup in any shardspace.
clusterCertificateCommonName Changes to this property will trigger replacement. String
The certificate common name used in all cloudAutonomousVmClusters for the sharded database topology. Eg. Production. All the clusters used in one sharded database topology shall have same CABundle setup. Valid characterset for clusterCertificateCommonName include uppercase or lowercase letters, numbers, hyphens, underscores, and period.
configureGsmsTrigger Number
(Updatable) An optional property when incremented triggers Configure Gsms. Could be set to any integer value.
configureGsmsTriggerIsLatestGsmImage Boolean
configureGsmsTriggerOldGsmNames List<String>
configureShardingTrigger Number
(Updatable) An optional property when incremented triggers Configure Sharding. Could be set to any integer value.
definedTags Map<String>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
downloadGsmCertificateSigningRequestTrigger Number
(Updatable) An optional property when incremented triggers Download Gsm Certificate Signing Request. Could be set to any integer value.
freeformTags 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"}
generateGsmCertificateSigningRequestTrigger Number
(Updatable) An optional property when incremented triggers Generate Gsm Certificate Signing Request. Could be set to any integer value.
generateWalletPassword String
generateWalletTrigger Number
(Updatable) An optional property when incremented triggers Generate Wallet. Could be set to any integer value.
getConnectionStringTrigger Number
(Updatable) An optional property when incremented triggers Get Connection String. Could be set to any integer value.
patchOperations List<Property Map>
(Updatable)
replicationFactor Changes to this property will trigger replacement. Number
The Replication factor for RAFT replication based sharded database. Currently supported values are 3, 5 and 7.
replicationMethod Changes to this property will trigger replacement. String
The Replication method for sharded database.
replicationUnit Changes to this property will trigger replacement. Number
For RAFT replication based sharded database, the value should be atleast twice the number of shards.
startDatabaseTrigger Number
(Updatable) An optional property when incremented triggers Start Database. Could be set to any integer value.
stopDatabaseTrigger Number
(Updatable) An optional property when incremented triggers Stop Database. Could be set to any integer value.
uploadSignedCertificateAndGenerateWalletTrigger Number
(Updatable) An optional property when incremented triggers Upload Signed Certificate And Generate Wallet. Could be set to any integer value.
validateNetworkTrigger Number

(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:

ConnectionStrings List<ShardedDatabaseConnectionString>
Details of sharded database connection String.
Gsms List<ShardedDatabaseGsm>
Details of GSM instances for the sharded database.
Id string
The provider-assigned unique ID for this managed resource.
LifecycleState string
LifecycleStateDetails string
Detailed message for the lifecycle state.
PrivateEndpoint string
The OCID of private endpoint being used by the sharded database.
ShardedDatabaseId string
State string
Lifecycle states for sharded databases.
SystemTags Dictionary<string, string>
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
TimeCreated string
The time the the Sharded Database was created. An RFC3339 formatted datetime string
TimeUpdated string
The time the Sharded Database was last updated. An RFC3339 formatted datetime string
TimeZone string
Timezone associated with the sharded database.
ConnectionStrings []ShardedDatabaseConnectionString
Details of sharded database connection String.
Gsms []ShardedDatabaseGsm
Details of GSM instances for the sharded database.
Id string
The provider-assigned unique ID for this managed resource.
LifecycleState string
LifecycleStateDetails string
Detailed message for the lifecycle state.
PrivateEndpoint string
The OCID of private endpoint being used by the sharded database.
ShardedDatabaseId string
State string
Lifecycle states for sharded databases.
SystemTags map[string]string
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
TimeCreated string
The time the the Sharded Database was created. An RFC3339 formatted datetime string
TimeUpdated string
The time the Sharded Database was last updated. An RFC3339 formatted datetime string
TimeZone string
Timezone associated with the sharded database.
connectionStrings List<ShardedDatabaseConnectionString>
Details of sharded database connection String.
gsms List<ShardedDatabaseGsm>
Details of GSM instances for the sharded database.
id String
The provider-assigned unique ID for this managed resource.
lifecycleState String
lifecycleStateDetails String
Detailed message for the lifecycle state.
privateEndpoint String
The OCID of private endpoint being used by the sharded database.
shardedDatabaseId String
state String
Lifecycle states for sharded databases.
systemTags Map<String,String>
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated String
The time the the Sharded Database was created. An RFC3339 formatted datetime string
timeUpdated String
The time the Sharded Database was last updated. An RFC3339 formatted datetime string
timeZone String
Timezone associated with the sharded database.
connectionStrings ShardedDatabaseConnectionString[]
Details of sharded database connection String.
gsms ShardedDatabaseGsm[]
Details of GSM instances for the sharded database.
id string
The provider-assigned unique ID for this managed resource.
lifecycleState string
lifecycleStateDetails string
Detailed message for the lifecycle state.
privateEndpoint string
The OCID of private endpoint being used by the sharded database.
shardedDatabaseId string
state string
Lifecycle states for sharded databases.
systemTags {[key: string]: string}
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated string
The time the the Sharded Database was created. An RFC3339 formatted datetime string
timeUpdated string
The time the Sharded Database was last updated. An RFC3339 formatted datetime string
timeZone string
Timezone associated with the sharded database.
connection_strings Sequence[globallydistributeddatabase.ShardedDatabaseConnectionString]
Details of sharded database connection String.
gsms Sequence[globallydistributeddatabase.ShardedDatabaseGsm]
Details of GSM instances for the sharded database.
id str
The provider-assigned unique ID for this managed resource.
lifecycle_state str
lifecycle_state_details str
Detailed message for the lifecycle state.
private_endpoint str
The OCID of private endpoint being used by the sharded database.
sharded_database_id str
state str
Lifecycle states for sharded databases.
system_tags Mapping[str, str]
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
time_created str
The time the the Sharded Database was created. An RFC3339 formatted datetime string
time_updated str
The time the Sharded Database was last updated. An RFC3339 formatted datetime string
time_zone str
Timezone associated with the sharded database.
connectionStrings List<Property Map>
Details of sharded database connection String.
gsms List<Property Map>
Details of GSM instances for the sharded database.
id String
The provider-assigned unique ID for this managed resource.
lifecycleState String
lifecycleStateDetails String
Detailed message for the lifecycle state.
privateEndpoint String
The OCID of private endpoint being used by the sharded database.
shardedDatabaseId String
state String
Lifecycle states for sharded databases.
systemTags Map<String>
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated String
The time the the Sharded Database was created. An RFC3339 formatted datetime string
timeUpdated String
The time the Sharded Database was last updated. An RFC3339 formatted datetime string
timeZone String
Timezone associated with the sharded database.

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,
        ca_signed_certificate: Optional[str] = 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_gsms_trigger_is_latest_gsm_image: Optional[bool] = None,
        configure_gsms_trigger_old_gsm_names: Optional[Sequence[str]] = 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_password: Optional[str] = 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,
        replication_factor: Optional[int] = None,
        replication_method: Optional[str] = None,
        replication_unit: Optional[int] = 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)
resources:  _:    type: oci:GloballyDistributedDatabase:ShardedDatabase    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
CaSignedCertificate string
CatalogDetails Changes to this property will trigger replacement. List<ShardedDatabaseCatalogDetail>
Collection of ATP-Dedicated catalogs that needs to be created.
CharacterSet Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. int
The default number of unique chunks in a shardspace. The value of chunks must be greater than 2 times the size of the largest shardgroup in any shardspace.
ClusterCertificateCommonName Changes to this property will trigger replacement. string
The certificate common name used in all cloudAutonomousVmClusters for the sharded database topology. Eg. Production. All the clusters used in one sharded database topology shall have same CABundle setup. Valid characterset for clusterCertificateCommonName include uppercase or lowercase letters, numbers, hyphens, underscores, and period.
CompartmentId string
(Updatable) Identifier of the compartment where sharded database is to be created.
ConfigureGsmsTrigger int
(Updatable) An optional property when incremented triggers Configure Gsms. Could be set to any integer value.
ConfigureGsmsTriggerIsLatestGsmImage bool
ConfigureGsmsTriggerOldGsmNames List<string>
ConfigureShardingTrigger int
(Updatable) An optional property when incremented triggers Configure Sharding. Could be set to any integer value.
ConnectionStrings List<ShardedDatabaseConnectionString>
Details of sharded database connection String.
DbDeploymentType Changes to this property will trigger replacement. string
The database deployment type.
DbVersion Changes to this property will trigger replacement. string
Oracle Database version of the Autonomous Container Database.
DbWorkload Changes to this property will trigger replacement. string
Possible workload types.
DefinedTags Dictionary<string, string>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
DisplayName string
(Updatable) Oracle sharded database display name.
DownloadGsmCertificateSigningRequestTrigger int
(Updatable) An optional property when incremented triggers Download Gsm Certificate Signing Request. Could be set to any integer value.
FreeformTags 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"}
GenerateGsmCertificateSigningRequestTrigger int
(Updatable) An optional property when incremented triggers Generate Gsm Certificate Signing Request. Could be set to any integer value.
GenerateWalletPassword string
GenerateWalletTrigger int
(Updatable) An optional property when incremented triggers Generate Wallet. Could be set to any integer value.
GetConnectionStringTrigger int
(Updatable) An optional property when incremented triggers Get Connection String. Could be set to any integer value.
Gsms List<ShardedDatabaseGsm>
Details of GSM instances for the sharded database.
LifecycleState string
LifecycleStateDetails string
Detailed message for the lifecycle state.
ListenerPort Changes to this property will trigger replacement. int
The listener port number for sharded database.
ListenerPortTls Changes to this property will trigger replacement. int
The TLS listener port number for sharded database.
NcharacterSet Changes to this property will trigger replacement. 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
OnsPortLocal Changes to this property will trigger replacement. int
Ons port local for sharded database.
OnsPortRemote Changes to this property will trigger replacement. int
Ons remote port for sharded database.
PatchOperations List<ShardedDatabasePatchOperation>
(Updatable)
Prefix Changes to this property will trigger replacement. 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.
PrivateEndpoint string
The OCID of private endpoint being used by the sharded database.
ReplicationFactor Changes to this property will trigger replacement. int
The Replication factor for RAFT replication based sharded database. Currently supported values are 3, 5 and 7.
ReplicationMethod Changes to this property will trigger replacement. string
The Replication method for sharded database.
ReplicationUnit Changes to this property will trigger replacement. int
For RAFT replication based sharded database, the value should be atleast twice the number of shards.
ShardDetails Changes to this property will trigger replacement. List<ShardedDatabaseShardDetail>
Collection of ATP-Dedicated shards that needs to be created.
ShardedDatabaseId string
ShardingMethod Changes to this property will trigger replacement. string
Sharding Method.
StartDatabaseTrigger int
(Updatable) An optional property when incremented triggers Start Database. Could be set to any integer value.
State string
Lifecycle states for sharded databases.
StopDatabaseTrigger int
(Updatable) An optional property when incremented triggers Stop Database. Could be set to any integer value.
SystemTags Dictionary<string, string>
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
TimeCreated string
The time the the Sharded Database was created. An RFC3339 formatted datetime string
TimeUpdated string
The time the Sharded Database was last updated. An RFC3339 formatted datetime string
TimeZone string
Timezone associated with the sharded database.
UploadSignedCertificateAndGenerateWalletTrigger int
(Updatable) An optional property when incremented triggers Upload Signed Certificate And Generate Wallet. Could be set to any integer value.
ValidateNetworkTrigger int

(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

CaSignedCertificate string
CatalogDetails Changes to this property will trigger replacement. []ShardedDatabaseCatalogDetailArgs
Collection of ATP-Dedicated catalogs that needs to be created.
CharacterSet Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. int
The default number of unique chunks in a shardspace. The value of chunks must be greater than 2 times the size of the largest shardgroup in any shardspace.
ClusterCertificateCommonName Changes to this property will trigger replacement. string
The certificate common name used in all cloudAutonomousVmClusters for the sharded database topology. Eg. Production. All the clusters used in one sharded database topology shall have same CABundle setup. Valid characterset for clusterCertificateCommonName include uppercase or lowercase letters, numbers, hyphens, underscores, and period.
CompartmentId string
(Updatable) Identifier of the compartment where sharded database is to be created.
ConfigureGsmsTrigger int
(Updatable) An optional property when incremented triggers Configure Gsms. Could be set to any integer value.
ConfigureGsmsTriggerIsLatestGsmImage bool
ConfigureGsmsTriggerOldGsmNames []string
ConfigureShardingTrigger int
(Updatable) An optional property when incremented triggers Configure Sharding. Could be set to any integer value.
ConnectionStrings []ShardedDatabaseConnectionStringArgs
Details of sharded database connection String.
DbDeploymentType Changes to this property will trigger replacement. string
The database deployment type.
DbVersion Changes to this property will trigger replacement. string
Oracle Database version of the Autonomous Container Database.
DbWorkload Changes to this property will trigger replacement. string
Possible workload types.
DefinedTags map[string]string
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
DisplayName string
(Updatable) Oracle sharded database display name.
DownloadGsmCertificateSigningRequestTrigger int
(Updatable) An optional property when incremented triggers Download Gsm Certificate Signing Request. Could be set to any integer value.
FreeformTags 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"}
GenerateGsmCertificateSigningRequestTrigger int
(Updatable) An optional property when incremented triggers Generate Gsm Certificate Signing Request. Could be set to any integer value.
GenerateWalletPassword string
GenerateWalletTrigger int
(Updatable) An optional property when incremented triggers Generate Wallet. Could be set to any integer value.
GetConnectionStringTrigger int
(Updatable) An optional property when incremented triggers Get Connection String. Could be set to any integer value.
Gsms []ShardedDatabaseGsmArgs
Details of GSM instances for the sharded database.
LifecycleState string
LifecycleStateDetails string
Detailed message for the lifecycle state.
ListenerPort Changes to this property will trigger replacement. int
The listener port number for sharded database.
ListenerPortTls Changes to this property will trigger replacement. int
The TLS listener port number for sharded database.
NcharacterSet Changes to this property will trigger replacement. 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
OnsPortLocal Changes to this property will trigger replacement. int
Ons port local for sharded database.
OnsPortRemote Changes to this property will trigger replacement. int
Ons remote port for sharded database.
PatchOperations []ShardedDatabasePatchOperationArgs
(Updatable)
Prefix Changes to this property will trigger replacement. 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.
PrivateEndpoint string
The OCID of private endpoint being used by the sharded database.
ReplicationFactor Changes to this property will trigger replacement. int
The Replication factor for RAFT replication based sharded database. Currently supported values are 3, 5 and 7.
ReplicationMethod Changes to this property will trigger replacement. string
The Replication method for sharded database.
ReplicationUnit Changes to this property will trigger replacement. int
For RAFT replication based sharded database, the value should be atleast twice the number of shards.
ShardDetails Changes to this property will trigger replacement. []ShardedDatabaseShardDetailArgs
Collection of ATP-Dedicated shards that needs to be created.
ShardedDatabaseId string
ShardingMethod Changes to this property will trigger replacement. string
Sharding Method.
StartDatabaseTrigger int
(Updatable) An optional property when incremented triggers Start Database. Could be set to any integer value.
State string
Lifecycle states for sharded databases.
StopDatabaseTrigger int
(Updatable) An optional property when incremented triggers Stop Database. Could be set to any integer value.
SystemTags map[string]string
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
TimeCreated string
The time the the Sharded Database was created. An RFC3339 formatted datetime string
TimeUpdated string
The time the Sharded Database was last updated. An RFC3339 formatted datetime string
TimeZone string
Timezone associated with the sharded database.
UploadSignedCertificateAndGenerateWalletTrigger int
(Updatable) An optional property when incremented triggers Upload Signed Certificate And Generate Wallet. Could be set to any integer value.
ValidateNetworkTrigger int

(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

caSignedCertificate String
catalogDetails Changes to this property will trigger replacement. List<ShardedDatabaseCatalogDetail>
Collection of ATP-Dedicated catalogs that needs to be created.
characterSet Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. Integer
The default number of unique chunks in a shardspace. The value of chunks must be greater than 2 times the size of the largest shardgroup in any shardspace.
clusterCertificateCommonName Changes to this property will trigger replacement. String
The certificate common name used in all cloudAutonomousVmClusters for the sharded database topology. Eg. Production. All the clusters used in one sharded database topology shall have same CABundle setup. Valid characterset for clusterCertificateCommonName include uppercase or lowercase letters, numbers, hyphens, underscores, and period.
compartmentId String
(Updatable) Identifier of the compartment where sharded database is to be created.
configureGsmsTrigger Integer
(Updatable) An optional property when incremented triggers Configure Gsms. Could be set to any integer value.
configureGsmsTriggerIsLatestGsmImage Boolean
configureGsmsTriggerOldGsmNames List<String>
configureShardingTrigger Integer
(Updatable) An optional property when incremented triggers Configure Sharding. Could be set to any integer value.
connectionStrings List<ShardedDatabaseConnectionString>
Details of sharded database connection String.
dbDeploymentType Changes to this property will trigger replacement. String
The database deployment type.
dbVersion Changes to this property will trigger replacement. String
Oracle Database version of the Autonomous Container Database.
dbWorkload Changes to this property will trigger replacement. String
Possible workload types.
definedTags Map<String,String>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
displayName String
(Updatable) Oracle sharded database display name.
downloadGsmCertificateSigningRequestTrigger Integer
(Updatable) An optional property when incremented triggers Download Gsm Certificate Signing Request. Could be set to any integer value.
freeformTags 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"}
generateGsmCertificateSigningRequestTrigger Integer
(Updatable) An optional property when incremented triggers Generate Gsm Certificate Signing Request. Could be set to any integer value.
generateWalletPassword String
generateWalletTrigger Integer
(Updatable) An optional property when incremented triggers Generate Wallet. Could be set to any integer value.
getConnectionStringTrigger Integer
(Updatable) An optional property when incremented triggers Get Connection String. Could be set to any integer value.
gsms List<ShardedDatabaseGsm>
Details of GSM instances for the sharded database.
lifecycleState String
lifecycleStateDetails String
Detailed message for the lifecycle state.
listenerPort Changes to this property will trigger replacement. Integer
The listener port number for sharded database.
listenerPortTls Changes to this property will trigger replacement. Integer
The TLS listener port number for sharded database.
ncharacterSet Changes to this property will trigger replacement. 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
onsPortLocal Changes to this property will trigger replacement. Integer
Ons port local for sharded database.
onsPortRemote Changes to this property will trigger replacement. Integer
Ons remote port for sharded database.
patchOperations List<ShardedDatabasePatchOperation>
(Updatable)
prefix Changes to this property will trigger replacement. 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.
privateEndpoint String
The OCID of private endpoint being used by the sharded database.
replicationFactor Changes to this property will trigger replacement. Integer
The Replication factor for RAFT replication based sharded database. Currently supported values are 3, 5 and 7.
replicationMethod Changes to this property will trigger replacement. String
The Replication method for sharded database.
replicationUnit Changes to this property will trigger replacement. Integer
For RAFT replication based sharded database, the value should be atleast twice the number of shards.
shardDetails Changes to this property will trigger replacement. List<ShardedDatabaseShardDetail>
Collection of ATP-Dedicated shards that needs to be created.
shardedDatabaseId String
shardingMethod Changes to this property will trigger replacement. String
Sharding Method.
startDatabaseTrigger Integer
(Updatable) An optional property when incremented triggers Start Database. Could be set to any integer value.
state String
Lifecycle states for sharded databases.
stopDatabaseTrigger Integer
(Updatable) An optional property when incremented triggers Stop Database. Could be set to any integer value.
systemTags Map<String,String>
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated String
The time the the Sharded Database was created. An RFC3339 formatted datetime string
timeUpdated String
The time the Sharded Database was last updated. An RFC3339 formatted datetime string
timeZone String
Timezone associated with the sharded database.
uploadSignedCertificateAndGenerateWalletTrigger Integer
(Updatable) An optional property when incremented triggers Upload Signed Certificate And Generate Wallet. Could be set to any integer value.
validateNetworkTrigger Integer

(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

caSignedCertificate string
catalogDetails Changes to this property will trigger replacement. ShardedDatabaseCatalogDetail[]
Collection of ATP-Dedicated catalogs that needs to be created.
characterSet Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. number
The default number of unique chunks in a shardspace. The value of chunks must be greater than 2 times the size of the largest shardgroup in any shardspace.
clusterCertificateCommonName Changes to this property will trigger replacement. string
The certificate common name used in all cloudAutonomousVmClusters for the sharded database topology. Eg. Production. All the clusters used in one sharded database topology shall have same CABundle setup. Valid characterset for clusterCertificateCommonName include uppercase or lowercase letters, numbers, hyphens, underscores, and period.
compartmentId string
(Updatable) Identifier of the compartment where sharded database is to be created.
configureGsmsTrigger number
(Updatable) An optional property when incremented triggers Configure Gsms. Could be set to any integer value.
configureGsmsTriggerIsLatestGsmImage boolean
configureGsmsTriggerOldGsmNames string[]
configureShardingTrigger number
(Updatable) An optional property when incremented triggers Configure Sharding. Could be set to any integer value.
connectionStrings ShardedDatabaseConnectionString[]
Details of sharded database connection String.
dbDeploymentType Changes to this property will trigger replacement. string
The database deployment type.
dbVersion Changes to this property will trigger replacement. string
Oracle Database version of the Autonomous Container Database.
dbWorkload Changes to this property will trigger replacement. string
Possible workload types.
definedTags {[key: string]: string}
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
displayName string
(Updatable) Oracle sharded database display name.
downloadGsmCertificateSigningRequestTrigger number
(Updatable) An optional property when incremented triggers Download Gsm Certificate Signing Request. Could be set to any integer value.
freeformTags {[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"}
generateGsmCertificateSigningRequestTrigger number
(Updatable) An optional property when incremented triggers Generate Gsm Certificate Signing Request. Could be set to any integer value.
generateWalletPassword string
generateWalletTrigger number
(Updatable) An optional property when incremented triggers Generate Wallet. Could be set to any integer value.
getConnectionStringTrigger number
(Updatable) An optional property when incremented triggers Get Connection String. Could be set to any integer value.
gsms ShardedDatabaseGsm[]
Details of GSM instances for the sharded database.
lifecycleState string
lifecycleStateDetails string
Detailed message for the lifecycle state.
listenerPort Changes to this property will trigger replacement. number
The listener port number for sharded database.
listenerPortTls Changes to this property will trigger replacement. number
The TLS listener port number for sharded database.
ncharacterSet Changes to this property will trigger replacement. 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
onsPortLocal Changes to this property will trigger replacement. number
Ons port local for sharded database.
onsPortRemote Changes to this property will trigger replacement. number
Ons remote port for sharded database.
patchOperations ShardedDatabasePatchOperation[]
(Updatable)
prefix Changes to this property will trigger replacement. 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.
privateEndpoint string
The OCID of private endpoint being used by the sharded database.
replicationFactor Changes to this property will trigger replacement. number
The Replication factor for RAFT replication based sharded database. Currently supported values are 3, 5 and 7.
replicationMethod Changes to this property will trigger replacement. string
The Replication method for sharded database.
replicationUnit Changes to this property will trigger replacement. number
For RAFT replication based sharded database, the value should be atleast twice the number of shards.
shardDetails Changes to this property will trigger replacement. ShardedDatabaseShardDetail[]
Collection of ATP-Dedicated shards that needs to be created.
shardedDatabaseId string
shardingMethod Changes to this property will trigger replacement. string
Sharding Method.
startDatabaseTrigger number
(Updatable) An optional property when incremented triggers Start Database. Could be set to any integer value.
state string
Lifecycle states for sharded databases.
stopDatabaseTrigger number
(Updatable) An optional property when incremented triggers Stop Database. Could be set to any integer value.
systemTags {[key: string]: string}
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated string
The time the the Sharded Database was created. An RFC3339 formatted datetime string
timeUpdated string
The time the Sharded Database was last updated. An RFC3339 formatted datetime string
timeZone string
Timezone associated with the sharded database.
uploadSignedCertificateAndGenerateWalletTrigger number
(Updatable) An optional property when incremented triggers Upload Signed Certificate And Generate Wallet. Could be set to any integer value.
validateNetworkTrigger number

(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

ca_signed_certificate str
catalog_details Changes to this property will trigger replacement. Sequence[globallydistributeddatabase.ShardedDatabaseCatalogDetailArgs]
Collection of ATP-Dedicated catalogs that needs to be created.
character_set Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. int
The default number of unique chunks in a shardspace. The value of chunks must be greater than 2 times the size of the largest shardgroup in any shardspace.
cluster_certificate_common_name Changes to this property will trigger replacement. str
The certificate common name used in all cloudAutonomousVmClusters for the sharded database topology. Eg. Production. All the clusters used in one sharded database topology shall have same CABundle setup. Valid characterset for clusterCertificateCommonName include uppercase or lowercase letters, numbers, hyphens, underscores, and period.
compartment_id str
(Updatable) Identifier of the compartment where sharded database is to be created.
configure_gsms_trigger int
(Updatable) An optional property when incremented triggers Configure Gsms. Could be set to any integer value.
configure_gsms_trigger_is_latest_gsm_image bool
configure_gsms_trigger_old_gsm_names Sequence[str]
configure_sharding_trigger int
(Updatable) An optional property when incremented triggers Configure Sharding. Could be set to any integer value.
connection_strings Sequence[globallydistributeddatabase.ShardedDatabaseConnectionStringArgs]
Details of sharded database connection String.
db_deployment_type Changes to this property will trigger replacement. str
The database deployment type.
db_version Changes to this property will trigger replacement. str
Oracle Database version of the Autonomous Container Database.
db_workload Changes to this property will trigger replacement. str
Possible workload types.
defined_tags 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_certificate_signing_request_trigger int
(Updatable) An optional property when incremented triggers Download Gsm Certificate Signing Request. Could be set to any integer value.
freeform_tags 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_certificate_signing_request_trigger int
(Updatable) An optional property when incremented triggers Generate Gsm Certificate Signing Request. Could be set to any integer value.
generate_wallet_password str
generate_wallet_trigger int
(Updatable) An optional property when incremented triggers Generate Wallet. Could be set to any integer value.
get_connection_string_trigger int
(Updatable) An optional property when incremented triggers Get Connection String. Could be set to any integer value.
gsms Sequence[globallydistributeddatabase.ShardedDatabaseGsmArgs]
Details of GSM instances for the sharded database.
lifecycle_state str
lifecycle_state_details str
Detailed message for the lifecycle state.
listener_port Changes to this property will trigger replacement. int
The listener port number for sharded database.
listener_port_tls Changes to this property will trigger replacement. int
The TLS listener port number for sharded database.
ncharacter_set Changes to this property will trigger replacement. 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_local Changes to this property will trigger replacement. int
Ons port local for sharded database.
ons_port_remote Changes to this property will trigger replacement. int
Ons remote port for sharded database.
patch_operations Sequence[globallydistributeddatabase.ShardedDatabasePatchOperationArgs]
(Updatable)
prefix Changes to this property will trigger replacement. 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.
replication_factor Changes to this property will trigger replacement. int
The Replication factor for RAFT replication based sharded database. Currently supported values are 3, 5 and 7.
replication_method Changes to this property will trigger replacement. str
The Replication method for sharded database.
replication_unit Changes to this property will trigger replacement. int
For RAFT replication based sharded database, the value should be atleast twice the number of shards.
shard_details Changes to this property will trigger replacement. Sequence[globallydistributeddatabase.ShardedDatabaseShardDetailArgs]
Collection of ATP-Dedicated shards that needs to be created.
sharded_database_id str
sharding_method Changes to this property will trigger replacement. str
Sharding Method.
start_database_trigger int
(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_trigger int
(Updatable) An optional property when incremented triggers Stop Database. Could be set to any integer value.
system_tags Mapping[str, str]
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
time_created str
The time the the Sharded Database was created. An RFC3339 formatted datetime string
time_updated str
The time the Sharded Database was last updated. An RFC3339 formatted datetime string
time_zone str
Timezone associated with the sharded database.
upload_signed_certificate_and_generate_wallet_trigger int
(Updatable) An optional property when incremented triggers Upload Signed Certificate And Generate Wallet. Could be set to any integer value.
validate_network_trigger int

(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

caSignedCertificate String
catalogDetails Changes to this property will trigger replacement. List<Property Map>
Collection of ATP-Dedicated catalogs that needs to be created.
characterSet Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. Number
The default number of unique chunks in a shardspace. The value of chunks must be greater than 2 times the size of the largest shardgroup in any shardspace.
clusterCertificateCommonName Changes to this property will trigger replacement. String
The certificate common name used in all cloudAutonomousVmClusters for the sharded database topology. Eg. Production. All the clusters used in one sharded database topology shall have same CABundle setup. Valid characterset for clusterCertificateCommonName include uppercase or lowercase letters, numbers, hyphens, underscores, and period.
compartmentId String
(Updatable) Identifier of the compartment where sharded database is to be created.
configureGsmsTrigger Number
(Updatable) An optional property when incremented triggers Configure Gsms. Could be set to any integer value.
configureGsmsTriggerIsLatestGsmImage Boolean
configureGsmsTriggerOldGsmNames List<String>
configureShardingTrigger Number
(Updatable) An optional property when incremented triggers Configure Sharding. Could be set to any integer value.
connectionStrings List<Property Map>
Details of sharded database connection String.
dbDeploymentType Changes to this property will trigger replacement. String
The database deployment type.
dbVersion Changes to this property will trigger replacement. String
Oracle Database version of the Autonomous Container Database.
dbWorkload Changes to this property will trigger replacement. String
Possible workload types.
definedTags Map<String>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
displayName String
(Updatable) Oracle sharded database display name.
downloadGsmCertificateSigningRequestTrigger Number
(Updatable) An optional property when incremented triggers Download Gsm Certificate Signing Request. Could be set to any integer value.
freeformTags 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"}
generateGsmCertificateSigningRequestTrigger Number
(Updatable) An optional property when incremented triggers Generate Gsm Certificate Signing Request. Could be set to any integer value.
generateWalletPassword String
generateWalletTrigger Number
(Updatable) An optional property when incremented triggers Generate Wallet. Could be set to any integer value.
getConnectionStringTrigger Number
(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.
lifecycleState String
lifecycleStateDetails String
Detailed message for the lifecycle state.
listenerPort Changes to this property will trigger replacement. Number
The listener port number for sharded database.
listenerPortTls Changes to this property will trigger replacement. Number
The TLS listener port number for sharded database.
ncharacterSet Changes to this property will trigger replacement. 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
onsPortLocal Changes to this property will trigger replacement. Number
Ons port local for sharded database.
onsPortRemote Changes to this property will trigger replacement. Number
Ons remote port for sharded database.
patchOperations List<Property Map>
(Updatable)
prefix Changes to this property will trigger replacement. 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.
privateEndpoint String
The OCID of private endpoint being used by the sharded database.
replicationFactor Changes to this property will trigger replacement. Number
The Replication factor for RAFT replication based sharded database. Currently supported values are 3, 5 and 7.
replicationMethod Changes to this property will trigger replacement. String
The Replication method for sharded database.
replicationUnit Changes to this property will trigger replacement. Number
For RAFT replication based sharded database, the value should be atleast twice the number of shards.
shardDetails Changes to this property will trigger replacement. List<Property Map>
Collection of ATP-Dedicated shards that needs to be created.
shardedDatabaseId String
shardingMethod Changes to this property will trigger replacement. String
Sharding Method.
startDatabaseTrigger Number
(Updatable) An optional property when incremented triggers Start Database. Could be set to any integer value.
state String
Lifecycle states for sharded databases.
stopDatabaseTrigger Number
(Updatable) An optional property when incremented triggers Stop Database. Could be set to any integer value.
systemTags Map<String>
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated String
The time the the Sharded Database was created. An RFC3339 formatted datetime string
timeUpdated String
The time the Sharded Database was last updated. An RFC3339 formatted datetime string
timeZone String
Timezone associated with the sharded database.
uploadSignedCertificateAndGenerateWalletTrigger Number
(Updatable) An optional property when incremented triggers Upload Signed Certificate And Generate Wallet. Could be set to any integer value.
validateNetworkTrigger Number

(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

AdminPassword This property is required. string
Admin password for the catalog database.
CloudAutonomousVmClusterId
This property is required.
Changes to this property will trigger replacement.
string
The OCID of the cloud Autonomous Exadata VM Cluster.
ComputeCount
This property is required.
Changes to this property will trigger replacement.
double
The compute count for the catalog database. It has to be in multiple of 2.
DataStorageSizeInGbs
This property is required.
Changes to this property will trigger replacement.
double
The data disk group size to be allocated in GBs for the catalog database.
IsAutoScalingEnabled
This property is required.
Changes to this property will trigger replacement.
bool
Determines the auto-scaling mode for the catalog database.
ContainerDatabaseId string
Identifier of the underlying container database.
ContainerDatabaseParentId string
Identifier of the underlying container database parent.
EncryptionKeyDetails Changes to this property will trigger replacement. ShardedDatabaseCatalogDetailEncryptionKeyDetails
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.
PeerCloudAutonomousVmClusterId Changes to this property will trigger replacement. string
The OCID of the peer cloud Autonomous Exadata VM Cluster.
ShardGroup string
Name of the shard-group to which the shard belongs.
Status string
Status of shard or catalog or gsm for the sharded database.
SupportingResourceId string
Identifier of the underlying supporting resource.
TimeCreated string
The time the the Sharded Database was created. An RFC3339 formatted datetime string
TimeSslCertificateExpires string
The time the ssl certificate associated with shard expires. An RFC3339 formatted datetime string
TimeUpdated string
The time the Sharded Database was last updated. An RFC3339 formatted datetime string
AdminPassword This property is required. string
Admin password for the catalog database.
CloudAutonomousVmClusterId
This property is required.
Changes to this property will trigger replacement.
string
The OCID of the cloud Autonomous Exadata VM Cluster.
ComputeCount
This property is required.
Changes to this property will trigger replacement.
float64
The compute count for the catalog database. It has to be in multiple of 2.
DataStorageSizeInGbs
This property is required.
Changes to this property will trigger replacement.
float64
The data disk group size to be allocated in GBs for the catalog database.
IsAutoScalingEnabled
This property is required.
Changes to this property will trigger replacement.
bool
Determines the auto-scaling mode for the catalog database.
ContainerDatabaseId string
Identifier of the underlying container database.
ContainerDatabaseParentId string
Identifier of the underlying container database parent.
EncryptionKeyDetails Changes to this property will trigger replacement. ShardedDatabaseCatalogDetailEncryptionKeyDetails
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.
PeerCloudAutonomousVmClusterId Changes to this property will trigger replacement. string
The OCID of the peer cloud Autonomous Exadata VM Cluster.
ShardGroup string
Name of the shard-group to which the shard belongs.
Status string
Status of shard or catalog or gsm for the sharded database.
SupportingResourceId string
Identifier of the underlying supporting resource.
TimeCreated string
The time the the Sharded Database was created. An RFC3339 formatted datetime string
TimeSslCertificateExpires string
The time the ssl certificate associated with shard expires. An RFC3339 formatted datetime string
TimeUpdated string
The time the Sharded Database was last updated. An RFC3339 formatted datetime string
adminPassword This property is required. String
Admin password for the catalog database.
cloudAutonomousVmClusterId
This property is required.
Changes to this property will trigger replacement.
String
The OCID of the cloud Autonomous Exadata VM Cluster.
computeCount
This property is required.
Changes to this property will trigger replacement.
Double
The compute count for the catalog database. It has to be in multiple of 2.
dataStorageSizeInGbs
This property is required.
Changes to this property will trigger replacement.
Double
The data disk group size to be allocated in GBs for the catalog database.
isAutoScalingEnabled
This property is required.
Changes to this property will trigger replacement.
Boolean
Determines the auto-scaling mode for the catalog database.
containerDatabaseId String
Identifier of the underlying container database.
containerDatabaseParentId String
Identifier of the underlying container database parent.
encryptionKeyDetails Changes to this property will trigger replacement. ShardedDatabaseCatalogDetailEncryptionKeyDetails
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.
peerCloudAutonomousVmClusterId Changes to this property will trigger replacement. String
The OCID of the peer cloud Autonomous Exadata VM Cluster.
shardGroup String
Name of the shard-group to which the shard belongs.
status String
Status of shard or catalog or gsm for the sharded database.
supportingResourceId String
Identifier of the underlying supporting resource.
timeCreated String
The time the the Sharded Database was created. An RFC3339 formatted datetime string
timeSslCertificateExpires String
The time the ssl certificate associated with shard expires. An RFC3339 formatted datetime string
timeUpdated String
The time the Sharded Database was last updated. An RFC3339 formatted datetime string
adminPassword This property is required. string
Admin password for the catalog database.
cloudAutonomousVmClusterId
This property is required.
Changes to this property will trigger replacement.
string
The OCID of the cloud Autonomous Exadata VM Cluster.
computeCount
This property is required.
Changes to this property will trigger replacement.
number
The compute count for the catalog database. It has to be in multiple of 2.
dataStorageSizeInGbs
This property is required.
Changes to this property will trigger replacement.
number
The data disk group size to be allocated in GBs for the catalog database.
isAutoScalingEnabled
This property is required.
Changes to this property will trigger replacement.
boolean
Determines the auto-scaling mode for the catalog database.
containerDatabaseId string
Identifier of the underlying container database.
containerDatabaseParentId string
Identifier of the underlying container database parent.
encryptionKeyDetails Changes to this property will trigger replacement. ShardedDatabaseCatalogDetailEncryptionKeyDetails
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.
peerCloudAutonomousVmClusterId Changes to this property will trigger replacement. string
The OCID of the peer cloud Autonomous Exadata VM Cluster.
shardGroup string
Name of the shard-group to which the shard belongs.
status string
Status of shard or catalog or gsm for the sharded database.
supportingResourceId string
Identifier of the underlying supporting resource.
timeCreated string
The time the the Sharded Database was created. An RFC3339 formatted datetime string
timeSslCertificateExpires string
The time the ssl certificate associated with shard expires. An RFC3339 formatted datetime string
timeUpdated string
The time the Sharded Database was last updated. An RFC3339 formatted datetime string
admin_password This property is required. str
Admin password for the catalog database.
cloud_autonomous_vm_cluster_id
This property is required.
Changes to this property will trigger replacement.
str
The OCID of the cloud Autonomous Exadata VM Cluster.
compute_count
This property is required.
Changes to this property will trigger replacement.
float
The compute count for the catalog database. It has to be in multiple of 2.
data_storage_size_in_gbs
This property is required.
Changes to this property will trigger replacement.
float
The data disk group size to be allocated in GBs for the catalog database.
is_auto_scaling_enabled
This property is required.
Changes to this property will trigger replacement.
bool
Determines the auto-scaling mode for the catalog database.
container_database_id str
Identifier of the underlying container database.
container_database_parent_id str
Identifier of the underlying container database parent.
encryption_key_details Changes to this property will trigger replacement. globallydistributeddatabase.ShardedDatabaseCatalogDetailEncryptionKeyDetails
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_autonomous_vm_cluster_id Changes to this property will trigger replacement. str
The OCID of the peer cloud Autonomous Exadata VM Cluster.
shard_group str
Name of the shard-group to which the shard belongs.
status str
Status of shard or catalog or gsm for the sharded database.
supporting_resource_id str
Identifier of the underlying supporting resource.
time_created str
The time the the Sharded Database was created. An RFC3339 formatted datetime string
time_ssl_certificate_expires str
The time the ssl certificate associated with shard expires. An RFC3339 formatted datetime string
time_updated str
The time the Sharded Database was last updated. An RFC3339 formatted datetime string
adminPassword This property is required. String
Admin password for the catalog database.
cloudAutonomousVmClusterId
This property is required.
Changes to this property will trigger replacement.
String
The OCID of the cloud Autonomous Exadata VM Cluster.
computeCount
This property is required.
Changes to this property will trigger replacement.
Number
The compute count for the catalog database. It has to be in multiple of 2.
dataStorageSizeInGbs
This property is required.
Changes to this property will trigger replacement.
Number
The data disk group size to be allocated in GBs for the catalog database.
isAutoScalingEnabled
This property is required.
Changes to this property will trigger replacement.
Boolean
Determines the auto-scaling mode for the catalog database.
containerDatabaseId String
Identifier of the underlying container database.
containerDatabaseParentId String
Identifier of the underlying container database parent.
encryptionKeyDetails Changes to this property will trigger replacement. Property Map
Details of encryption key to be used to encrypt data for shards and catalog for sharded database. For system-defined sharding type, all shards have to use same encryptionKeyDetails. For system-defined sharding, if encryptionKeyDetails are not specified for catalog, then Oracle managed key will be used for catalog. For user-defined sharding type, if encryptionKeyDetails are not provided for any shard or catalog, then Oracle managed key will be used for such shard or catalog. For system-defined or user-defined sharding type, if the shard or catalog has a peer in region other than primary shard or catalog region, then make sure to provide virtual vault for such shard or catalog, which is also replicated to peer region (the region where peer or standby shard or catalog exists).
metadata Map<String>
Additional metadata related to shard's underlying supporting resource.
name String
Name of the shard.
peerCloudAutonomousVmClusterId Changes to this property will trigger replacement. String
The OCID of the peer cloud Autonomous Exadata VM Cluster.
shardGroup String
Name of the shard-group to which the shard belongs.
status String
Status of shard or catalog or gsm for the sharded database.
supportingResourceId String
Identifier of the underlying supporting resource.
timeCreated String
The time the the Sharded Database was created. An RFC3339 formatted datetime string
timeSslCertificateExpires String
The time the ssl certificate associated with shard expires. An RFC3339 formatted datetime string
timeUpdated String
The time the Sharded Database was last updated. An RFC3339 formatted datetime string

ShardedDatabaseCatalogDetailEncryptionKeyDetails
, ShardedDatabaseCatalogDetailEncryptionKeyDetailsArgs

KmsKeyId
This property is required.
Changes to this property will trigger replacement.
string
The OCID of the KMS key in vault identified by vaultId in customer tenancy that is used as the master encryption key.
VaultId
This property is required.
Changes to this property will trigger replacement.
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.
KmsKeyVersionId Changes to this property will trigger replacement. string
The OCID of the KMS key version for key identified by kmsKeyId that is used in data encryption (TDE) operations.
KmsKeyId
This property is required.
Changes to this property will trigger replacement.
string
The OCID of the KMS key in vault identified by vaultId in customer tenancy that is used as the master encryption key.
VaultId
This property is required.
Changes to this property will trigger replacement.
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.
KmsKeyVersionId Changes to this property will trigger replacement. string
The OCID of the KMS key version for key identified by kmsKeyId that is used in data encryption (TDE) operations.
kmsKeyId
This property is required.
Changes to this property will trigger replacement.
String
The OCID of the KMS key in vault identified by vaultId in customer tenancy that is used as the master encryption key.
vaultId
This property is required.
Changes to this property will trigger replacement.
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.
kmsKeyVersionId Changes to this property will trigger replacement. String
The OCID of the KMS key version for key identified by kmsKeyId that is used in data encryption (TDE) operations.
kmsKeyId
This property is required.
Changes to this property will trigger replacement.
string
The OCID of the KMS key in vault identified by vaultId in customer tenancy that is used as the master encryption key.
vaultId
This property is required.
Changes to this property will trigger replacement.
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.
kmsKeyVersionId Changes to this property will trigger replacement. string
The OCID of the KMS key version for key identified by kmsKeyId that is used in data encryption (TDE) operations.
kms_key_id
This property is required.
Changes to this property will trigger replacement.
str
The OCID of the KMS key in vault identified by vaultId in customer tenancy that is used as the master encryption key.
vault_id
This property is required.
Changes to this property will trigger replacement.
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_version_id Changes to this property will trigger replacement. str
The OCID of the KMS key version for key identified by kmsKeyId that is used in data encryption (TDE) operations.
kmsKeyId
This property is required.
Changes to this property will trigger replacement.
String
The OCID of the KMS key in vault identified by vaultId in customer tenancy that is used as the master encryption key.
vaultId
This property is required.
Changes to this property will trigger replacement.
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.
kmsKeyVersionId Changes to this property will trigger replacement. String
The OCID of the KMS key version for key identified by kmsKeyId that is used in data encryption (TDE) operations.

ShardedDatabaseConnectionString
, ShardedDatabaseConnectionStringArgs

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

ShardedDatabaseGsm
, ShardedDatabaseGsmArgs

ComputeCount double
The compute amount available to the underlying autonomous database associated with shard.
DataStorageSizeInGbs double
The data disk group size to be allocated in GBs.
Metadata Dictionary<string, string>
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.
SupportingResourceId string
Identifier of the underlying supporting resource.
TimeCreated string
The time the the Sharded Database was created. An RFC3339 formatted datetime string
TimeSslCertificateExpires string
The time the ssl certificate associated with shard expires. An RFC3339 formatted datetime string
TimeUpdated string
The time the Sharded Database was last updated. An RFC3339 formatted datetime string
ComputeCount float64
The compute amount available to the underlying autonomous database associated with shard.
DataStorageSizeInGbs float64
The data disk group size to be allocated in GBs.
Metadata map[string]string
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.
SupportingResourceId string
Identifier of the underlying supporting resource.
TimeCreated string
The time the the Sharded Database was created. An RFC3339 formatted datetime string
TimeSslCertificateExpires string
The time the ssl certificate associated with shard expires. An RFC3339 formatted datetime string
TimeUpdated string
The time the Sharded Database was last updated. An RFC3339 formatted datetime string
computeCount Double
The compute amount available to the underlying autonomous database associated with shard.
dataStorageSizeInGbs Double
The data disk group size to be allocated in GBs.
metadata Map<String,String>
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.
supportingResourceId String
Identifier of the underlying supporting resource.
timeCreated String
The time the the Sharded Database was created. An RFC3339 formatted datetime string
timeSslCertificateExpires String
The time the ssl certificate associated with shard expires. An RFC3339 formatted datetime string
timeUpdated String
The time the Sharded Database was last updated. An RFC3339 formatted datetime string
computeCount number
The compute amount available to the underlying autonomous database associated with shard.
dataStorageSizeInGbs number
The data disk group size to be allocated in GBs.
metadata {[key: string]: string}
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.
supportingResourceId string
Identifier of the underlying supporting resource.
timeCreated string
The time the the Sharded Database was created. An RFC3339 formatted datetime string
timeSslCertificateExpires string
The time the ssl certificate associated with shard expires. An RFC3339 formatted datetime string
timeUpdated string
The time the Sharded Database was last updated. An RFC3339 formatted datetime string
compute_count float
The compute amount available to the underlying autonomous database associated with shard.
data_storage_size_in_gbs float
The data disk group size to be allocated in GBs.
metadata Mapping[str, str]
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_id str
Identifier of the underlying supporting resource.
time_created str
The time the the Sharded Database was created. An RFC3339 formatted datetime string
time_ssl_certificate_expires str
The time the ssl certificate associated with shard expires. An RFC3339 formatted datetime string
time_updated str
The time the Sharded Database was last updated. An RFC3339 formatted datetime string
computeCount Number
The compute amount available to the underlying autonomous database associated with shard.
dataStorageSizeInGbs Number
The data disk group size to be allocated in GBs.
metadata Map<String>
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.
supportingResourceId String
Identifier of the underlying supporting resource.
timeCreated String
The time the the Sharded Database was created. An RFC3339 formatted datetime string
timeSslCertificateExpires String
The time the ssl certificate associated with shard expires. An RFC3339 formatted datetime string
timeUpdated String
The time the Sharded Database was last updated. An RFC3339 formatted datetime string

ShardedDatabasePatchOperation
, ShardedDatabasePatchOperationArgs

Operation This property is required. string
(Updatable) The operation can be one of these values: INSERT, MERGE, REMOVE
Selection This property is required. string
(Updatable)
Value This property is required. string
(Updatable)
Operation This property is required. string
(Updatable) The operation can be one of these values: INSERT, MERGE, REMOVE
Selection This property is required. string
(Updatable)
Value This property is required. string
(Updatable)
operation This property is required. String
(Updatable) The operation can be one of these values: INSERT, MERGE, REMOVE
selection This property is required. String
(Updatable)
value This property is required. String
(Updatable)
operation This property is required. string
(Updatable) The operation can be one of these values: INSERT, MERGE, REMOVE
selection This property is required. string
(Updatable)
value This property is required. string
(Updatable)
operation This property is required. str
(Updatable) The operation can be one of these values: INSERT, MERGE, REMOVE
selection This property is required. str
(Updatable)
value This property is required. str
(Updatable)
operation This property is required. String
(Updatable) The operation can be one of these values: INSERT, MERGE, REMOVE
selection This property is required. String
(Updatable)
value This property is required. String
(Updatable)

ShardedDatabaseShardDetail
, ShardedDatabaseShardDetailArgs

AdminPassword This property is required. string
Admin password for shard database.
CloudAutonomousVmClusterId
This property is required.
Changes to this property will trigger replacement.
string
The OCID of the cloud Autonomous Exadata VM Cluster.
ComputeCount
This property is required.
Changes to this property will trigger replacement.
double
The compute count for the shard database. It has to be in multiples of 2.
DataStorageSizeInGbs
This property is required.
Changes to this property will trigger replacement.
double
The data disk group size to be allocated in GBs for the shard database.
IsAutoScalingEnabled
This property is required.
Changes to this property will trigger replacement.
bool
Determines the auto-scaling mode for the shard database.
ContainerDatabaseId string
Identifier of the underlying container database.
ContainerDatabaseParentId string
Identifier of the underlying container database parent.
EncryptionKeyDetails Changes to this property will trigger replacement. ShardedDatabaseShardDetailEncryptionKeyDetails
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.
PeerCloudAutonomousVmClusterId Changes to this property will trigger replacement. string
The OCID of the peer cloud Autonomous Exadata VM Cluster.
ShardGroup string
Name of the shard-group to which the shard belongs.
ShardSpace Changes to this property will trigger replacement. 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.
SupportingResourceId string
Identifier of the underlying supporting resource.
TimeCreated string
The time the the Sharded Database was created. An RFC3339 formatted datetime string
TimeSslCertificateExpires string
The time the ssl certificate associated with shard expires. An RFC3339 formatted datetime string
TimeUpdated string
The time the Sharded Database was last updated. An RFC3339 formatted datetime string
AdminPassword This property is required. string
Admin password for shard database.
CloudAutonomousVmClusterId
This property is required.
Changes to this property will trigger replacement.
string
The OCID of the cloud Autonomous Exadata VM Cluster.
ComputeCount
This property is required.
Changes to this property will trigger replacement.
float64
The compute count for the shard database. It has to be in multiples of 2.
DataStorageSizeInGbs
This property is required.
Changes to this property will trigger replacement.
float64
The data disk group size to be allocated in GBs for the shard database.
IsAutoScalingEnabled
This property is required.
Changes to this property will trigger replacement.
bool
Determines the auto-scaling mode for the shard database.
ContainerDatabaseId string
Identifier of the underlying container database.
ContainerDatabaseParentId string
Identifier of the underlying container database parent.
EncryptionKeyDetails Changes to this property will trigger replacement. ShardedDatabaseShardDetailEncryptionKeyDetails
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.
PeerCloudAutonomousVmClusterId Changes to this property will trigger replacement. string
The OCID of the peer cloud Autonomous Exadata VM Cluster.
ShardGroup string
Name of the shard-group to which the shard belongs.
ShardSpace Changes to this property will trigger replacement. 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.
SupportingResourceId string
Identifier of the underlying supporting resource.
TimeCreated string
The time the the Sharded Database was created. An RFC3339 formatted datetime string
TimeSslCertificateExpires string
The time the ssl certificate associated with shard expires. An RFC3339 formatted datetime string
TimeUpdated string
The time the Sharded Database was last updated. An RFC3339 formatted datetime string
adminPassword This property is required. String
Admin password for shard database.
cloudAutonomousVmClusterId
This property is required.
Changes to this property will trigger replacement.
String
The OCID of the cloud Autonomous Exadata VM Cluster.
computeCount
This property is required.
Changes to this property will trigger replacement.
Double
The compute count for the shard database. It has to be in multiples of 2.
dataStorageSizeInGbs
This property is required.
Changes to this property will trigger replacement.
Double
The data disk group size to be allocated in GBs for the shard database.
isAutoScalingEnabled
This property is required.
Changes to this property will trigger replacement.
Boolean
Determines the auto-scaling mode for the shard database.
containerDatabaseId String
Identifier of the underlying container database.
containerDatabaseParentId String
Identifier of the underlying container database parent.
encryptionKeyDetails Changes to this property will trigger replacement. ShardedDatabaseShardDetailEncryptionKeyDetails
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.
peerCloudAutonomousVmClusterId Changes to this property will trigger replacement. String
The OCID of the peer cloud Autonomous Exadata VM Cluster.
shardGroup String
Name of the shard-group to which the shard belongs.
shardSpace Changes to this property will trigger replacement. 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.
supportingResourceId String
Identifier of the underlying supporting resource.
timeCreated String
The time the the Sharded Database was created. An RFC3339 formatted datetime string
timeSslCertificateExpires String
The time the ssl certificate associated with shard expires. An RFC3339 formatted datetime string
timeUpdated String
The time the Sharded Database was last updated. An RFC3339 formatted datetime string
adminPassword This property is required. string
Admin password for shard database.
cloudAutonomousVmClusterId
This property is required.
Changes to this property will trigger replacement.
string
The OCID of the cloud Autonomous Exadata VM Cluster.
computeCount
This property is required.
Changes to this property will trigger replacement.
number
The compute count for the shard database. It has to be in multiples of 2.
dataStorageSizeInGbs
This property is required.
Changes to this property will trigger replacement.
number
The data disk group size to be allocated in GBs for the shard database.
isAutoScalingEnabled
This property is required.
Changes to this property will trigger replacement.
boolean
Determines the auto-scaling mode for the shard database.
containerDatabaseId string
Identifier of the underlying container database.
containerDatabaseParentId string
Identifier of the underlying container database parent.
encryptionKeyDetails Changes to this property will trigger replacement. ShardedDatabaseShardDetailEncryptionKeyDetails
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.
peerCloudAutonomousVmClusterId Changes to this property will trigger replacement. string
The OCID of the peer cloud Autonomous Exadata VM Cluster.
shardGroup string
Name of the shard-group to which the shard belongs.
shardSpace Changes to this property will trigger replacement. 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.
supportingResourceId string
Identifier of the underlying supporting resource.
timeCreated string
The time the the Sharded Database was created. An RFC3339 formatted datetime string
timeSslCertificateExpires string
The time the ssl certificate associated with shard expires. An RFC3339 formatted datetime string
timeUpdated string
The time the Sharded Database was last updated. An RFC3339 formatted datetime string
admin_password This property is required. str
Admin password for shard database.
cloud_autonomous_vm_cluster_id
This property is required.
Changes to this property will trigger replacement.
str
The OCID of the cloud Autonomous Exadata VM Cluster.
compute_count
This property is required.
Changes to this property will trigger replacement.
float
The compute count for the shard database. It has to be in multiples of 2.
data_storage_size_in_gbs
This property is required.
Changes to this property will trigger replacement.
float
The data disk group size to be allocated in GBs for the shard database.
is_auto_scaling_enabled
This property is required.
Changes to this property will trigger replacement.
bool
Determines the auto-scaling mode for the shard database.
container_database_id str
Identifier of the underlying container database.
container_database_parent_id str
Identifier of the underlying container database parent.
encryption_key_details Changes to this property will trigger replacement. globallydistributeddatabase.ShardedDatabaseShardDetailEncryptionKeyDetails
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_autonomous_vm_cluster_id Changes to this property will trigger replacement. str
The OCID of the peer cloud Autonomous Exadata VM Cluster.
shard_group str
Name of the shard-group to which the shard belongs.
shard_space Changes to this property will trigger replacement. 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_id str
Identifier of the underlying supporting resource.
time_created str
The time the the Sharded Database was created. An RFC3339 formatted datetime string
time_ssl_certificate_expires str
The time the ssl certificate associated with shard expires. An RFC3339 formatted datetime string
time_updated str
The time the Sharded Database was last updated. An RFC3339 formatted datetime string
adminPassword This property is required. String
Admin password for shard database.
cloudAutonomousVmClusterId
This property is required.
Changes to this property will trigger replacement.
String
The OCID of the cloud Autonomous Exadata VM Cluster.
computeCount
This property is required.
Changes to this property will trigger replacement.
Number
The compute count for the shard database. It has to be in multiples of 2.
dataStorageSizeInGbs
This property is required.
Changes to this property will trigger replacement.
Number
The data disk group size to be allocated in GBs for the shard database.
isAutoScalingEnabled
This property is required.
Changes to this property will trigger replacement.
Boolean
Determines the auto-scaling mode for the shard database.
containerDatabaseId String
Identifier of the underlying container database.
containerDatabaseParentId String
Identifier of the underlying container database parent.
encryptionKeyDetails Changes to this property will trigger replacement. Property Map
Details of encryption key to be used to encrypt data for shards and catalog for sharded database. For system-defined sharding type, all shards have to use same encryptionKeyDetails. For system-defined sharding, if encryptionKeyDetails are not specified for catalog, then Oracle managed key will be used for catalog. For user-defined sharding type, if encryptionKeyDetails are not provided for any shard or catalog, then Oracle managed key will be used for such shard or catalog. For system-defined or user-defined sharding type, if the shard or catalog has a peer in region other than primary shard or catalog region, then make sure to provide virtual vault for such shard or catalog, which is also replicated to peer region (the region where peer or standby shard or catalog exists).
metadata Map<String>
Additional metadata related to shard's underlying supporting resource.
name String
Name of the shard.
peerCloudAutonomousVmClusterId Changes to this property will trigger replacement. String
The OCID of the peer cloud Autonomous Exadata VM Cluster.
shardGroup String
Name of the shard-group to which the shard belongs.
shardSpace Changes to this property will trigger replacement. 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.
supportingResourceId String
Identifier of the underlying supporting resource.
timeCreated String
The time the the Sharded Database was created. An RFC3339 formatted datetime string
timeSslCertificateExpires String
The time the ssl certificate associated with shard expires. An RFC3339 formatted datetime string
timeUpdated String
The time the Sharded Database was last updated. An RFC3339 formatted datetime string

ShardedDatabaseShardDetailEncryptionKeyDetails
, ShardedDatabaseShardDetailEncryptionKeyDetailsArgs

KmsKeyId
This property is required.
Changes to this property will trigger replacement.
string
The OCID of the KMS key in vault identified by vaultId in customer tenancy that is used as the master encryption key.
VaultId
This property is required.
Changes to this property will trigger replacement.
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.
KmsKeyVersionId Changes to this property will trigger replacement. string
The OCID of the KMS key version for key identified by kmsKeyId that is used in data encryption (TDE) operations.
KmsKeyId
This property is required.
Changes to this property will trigger replacement.
string
The OCID of the KMS key in vault identified by vaultId in customer tenancy that is used as the master encryption key.
VaultId
This property is required.
Changes to this property will trigger replacement.
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.
KmsKeyVersionId Changes to this property will trigger replacement. string
The OCID of the KMS key version for key identified by kmsKeyId that is used in data encryption (TDE) operations.
kmsKeyId
This property is required.
Changes to this property will trigger replacement.
String
The OCID of the KMS key in vault identified by vaultId in customer tenancy that is used as the master encryption key.
vaultId
This property is required.
Changes to this property will trigger replacement.
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.
kmsKeyVersionId Changes to this property will trigger replacement. String
The OCID of the KMS key version for key identified by kmsKeyId that is used in data encryption (TDE) operations.
kmsKeyId
This property is required.
Changes to this property will trigger replacement.
string
The OCID of the KMS key in vault identified by vaultId in customer tenancy that is used as the master encryption key.
vaultId
This property is required.
Changes to this property will trigger replacement.
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.
kmsKeyVersionId Changes to this property will trigger replacement. string
The OCID of the KMS key version for key identified by kmsKeyId that is used in data encryption (TDE) operations.
kms_key_id
This property is required.
Changes to this property will trigger replacement.
str
The OCID of the KMS key in vault identified by vaultId in customer tenancy that is used as the master encryption key.
vault_id
This property is required.
Changes to this property will trigger replacement.
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_version_id Changes to this property will trigger replacement. str
The OCID of the KMS key version for key identified by kmsKeyId that is used in data encryption (TDE) operations.
kmsKeyId
This property is required.
Changes to this property will trigger replacement.
String
The OCID of the KMS key in vault identified by vaultId in customer tenancy that is used as the master encryption key.
vaultId
This property is required.
Changes to this property will trigger replacement.
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.
kmsKeyVersionId Changes to this property will trigger replacement. String
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"
Copy

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.
Oracle Cloud Infrastructure v2.30.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-oci