oci.GloballyDistributedDatabase.ShardedDatabase
Explore with Pulumi AI
This resource provides the Sharded Database resource in Oracle Cloud Infrastructure Globally Distributed Database service.
Creates a Sharded Database.
Patch operation to add, remove or update shards to the sharded database topology. In single patch operation, multiple shards can be either added, or removed or updated. Combination of inserts, update and remove in single operation is not allowed.
Example Usage
Coming soon!
Coming soon!
Coming soon!
Coming soon!
Coming soon!
resources:
  testShardedDatabase:
    type: oci:GloballyDistributedDatabase:ShardedDatabase
    name: test_sharded_database
    properties:
      catalogDetails:
        - adminPassword: ${shardedDatabaseCatalogDetailsAdminPassword}
          cloudAutonomousVmClusterId: ${testCloudAutonomousVmCluster.id}
          computeCount: ${shardedDatabaseCatalogDetailsComputeCount}
          dataStorageSizeInGbs: ${shardedDatabaseCatalogDetailsDataStorageSizeInGbs}
          isAutoScalingEnabled: ${shardedDatabaseCatalogDetailsIsAutoScalingEnabled}
          encryptionKeyDetails:
            kmsKeyId: ${testKey.id}
            vaultId: ${testVault.id}
            kmsKeyVersionId: ${testKeyVersion.id}
          peerCloudAutonomousVmClusterId: ${testCloudAutonomousVmCluster.id}
      characterSet: ${shardedDatabaseCharacterSet}
      compartmentId: ${compartmentId}
      dbDeploymentType: ${shardedDatabaseDbDeploymentType}
      dbVersion: ${shardedDatabaseDbVersion}
      dbWorkload: ${shardedDatabaseDbWorkload}
      displayName: ${shardedDatabaseDisplayName}
      listenerPort: ${shardedDatabaseListenerPort}
      listenerPortTls: ${shardedDatabaseListenerPortTls}
      ncharacterSet: ${shardedDatabaseNcharacterSet}
      onsPortLocal: ${shardedDatabaseOnsPortLocal}
      onsPortRemote: ${shardedDatabaseOnsPortRemote}
      prefix: ${shardedDatabasePrefix}
      shardDetails:
        - adminPassword: ${shardedDatabaseShardDetailsAdminPassword}
          cloudAutonomousVmClusterId: ${testCloudAutonomousVmCluster.id}
          computeCount: ${shardedDatabaseShardDetailsComputeCount}
          dataStorageSizeInGbs: ${shardedDatabaseShardDetailsDataStorageSizeInGbs}
          isAutoScalingEnabled: ${shardedDatabaseShardDetailsIsAutoScalingEnabled}
          encryptionKeyDetails:
            kmsKeyId: ${testKey.id}
            vaultId: ${testVault.id}
            kmsKeyVersionId: ${testKeyVersion.id}
          peerCloudAutonomousVmClusterId: ${testCloudAutonomousVmCluster.id}
          shardSpace: ${shardedDatabaseShardDetailsShardSpace}
      shardedDatabaseId: ${shardedDatabaseShardedDatabaseId}
      shardingMethod: ${shardedDatabaseShardingMethod}
      chunks: ${shardedDatabaseChunks}
      clusterCertificateCommonName: ${shardedDatabaseClusterCertificateCommonName}
      definedTags:
        foo-namespace.bar-key: value
      freeformTags:
        bar-key: value
      patchOperations:
        - operation: ${shardedDatabasePatchOperationsOperation}
          selection: ${shardedDatabasePatchOperationsSelection}
          value: ${shardedDatabasePatchOperationsValue}
      replicationFactor: ${shardedDatabaseReplicationFactor}
      replicationMethod: ${shardedDatabaseReplicationMethod}
      replicationUnit: ${shardedDatabaseReplicationUnit}
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[ShardedDatabaseCatalogDetailArgs]] = None,
                    character_set: Optional[str] = None,
                    sharding_method: Optional[str] = None,
                    shard_details: Optional[Sequence[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[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 string
- The unique name of the resource.
- args ShardedDatabaseArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args ShardedDatabaseArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args ShardedDatabaseArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ShardedDatabaseArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ShardedDatabaseArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var shardedDatabaseResource = new Oci.GloballyDistributedDatabase.ShardedDatabase("shardedDatabaseResource", new()
{
    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,
});
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),
})
var shardedDatabaseResource = new ShardedDatabase("shardedDatabaseResource", ShardedDatabaseArgs.builder()
    .listenerPort(0)
    .catalogDetails(ShardedDatabaseCatalogDetailArgs.builder()
        .dataStorageSizeInGbs(0.0)
        .cloudAutonomousVmClusterId("string")
        .computeCount(0.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.0)
        .cloudAutonomousVmClusterId("string")
        .computeCount(0.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());
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)
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,
});
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
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 List<ShardedDatabase Catalog Detail> 
- Collection of ATP-Dedicated catalogs that needs to be created.
- CharacterSet 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 string
- (Updatable) Identifier of the compartment where sharded database is to be created.
- DbDeployment stringType 
- The database deployment type.
- DbVersion string
- Oracle Database version of the Autonomous Container Database.
- DbWorkload string
- Possible workload types.
- DisplayName string
- (Updatable) Oracle sharded database display name.
- ListenerPort int
- The listener port number for sharded database.
- ListenerPort intTls 
- The TLS listener port number for sharded database.
- NcharacterSet 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
- OnsPort intLocal 
- Ons port local for sharded database.
- OnsPort intRemote 
- Ons remote port for sharded database.
- Prefix string
- Unique name prefix for the sharded databases. Only alpha-numeric values are allowed. First character has to be a letter followed by any combination of letter and number.
- 
List<ShardedDatabase Shard Detail> 
- Collection of ATP-Dedicated shards that needs to be created.
- string
- Sharding Method.
- CaSigned stringCertificate 
- Chunks int
- The default number of unique chunks in a shardspace. The value of chunks must be greater than 2 times the size of the largest shardgroup in any shardspace.
- ClusterCertificate stringCommon Name 
- The certificate common name used in all cloudAutonomousVmClusters for the sharded database topology. Eg. Production. All the clusters used in one sharded database topology shall have same CABundle setup. Valid characterset for clusterCertificateCommonName include uppercase or lowercase letters, numbers, hyphens, underscores, and period.
- ConfigureGsms intTrigger 
- (Updatable) An optional property when incremented triggers Configure Gsms. Could be set to any integer value.
- ConfigureGsms boolTrigger Is Latest Gsm Image 
- ConfigureGsms List<string>Trigger Old Gsm Names 
- ConfigureSharding intTrigger 
- (Updatable) An optional property when incremented triggers Configure Sharding. Could be set to any integer value.
- Dictionary<string, string>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- DownloadGsm intCertificate Signing Request Trigger 
- (Updatable) An optional property when incremented triggers Download Gsm Certificate Signing Request. Could be set to any integer value.
- Dictionary<string, string>
- (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
- GenerateGsm intCertificate Signing Request Trigger 
- (Updatable) An optional property when incremented triggers Generate Gsm Certificate Signing Request. Could be set to any integer value.
- GenerateWallet stringPassword 
- GenerateWallet intTrigger 
- (Updatable) An optional property when incremented triggers Generate Wallet. Could be set to any integer value.
- GetConnection intString Trigger 
- (Updatable) An optional property when incremented triggers Get Connection String. Could be set to any integer value.
- PatchOperations List<ShardedDatabase Patch Operation> 
- (Updatable)
- ReplicationFactor int
- The Replication factor for RAFT replication based sharded database. Currently supported values are 3, 5 and 7.
- ReplicationMethod string
- The Replication method for sharded database.
- ReplicationUnit int
- For RAFT replication based sharded database, the value should be atleast twice the number of shards.
- StartDatabase intTrigger 
- (Updatable) An optional property when incremented triggers Start Database. Could be set to any integer value.
- StopDatabase intTrigger 
- (Updatable) An optional property when incremented triggers Stop Database. Could be set to any integer value.
- UploadSigned intCertificate And Generate Wallet Trigger 
- (Updatable) An optional property when incremented triggers Upload Signed Certificate And Generate Wallet. Could be set to any integer value.
- ValidateNetwork intTrigger 
- (Updatable) An optional property when incremented triggers Validate Network. Could be set to any integer value. - ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values 
- CatalogDetails []ShardedDatabase Catalog Detail Args 
- Collection of ATP-Dedicated catalogs that needs to be created.
- CharacterSet 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 string
- (Updatable) Identifier of the compartment where sharded database is to be created.
- DbDeployment stringType 
- The database deployment type.
- DbVersion string
- Oracle Database version of the Autonomous Container Database.
- DbWorkload string
- Possible workload types.
- DisplayName string
- (Updatable) Oracle sharded database display name.
- ListenerPort int
- The listener port number for sharded database.
- ListenerPort intTls 
- The TLS listener port number for sharded database.
- NcharacterSet 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
- OnsPort intLocal 
- Ons port local for sharded database.
- OnsPort intRemote 
- Ons remote port for sharded database.
- Prefix string
- Unique name prefix for the sharded databases. Only alpha-numeric values are allowed. First character has to be a letter followed by any combination of letter and number.
- 
[]ShardedDatabase Shard Detail Args 
- Collection of ATP-Dedicated shards that needs to be created.
- string
- Sharding Method.
- CaSigned stringCertificate 
- Chunks int
- The default number of unique chunks in a shardspace. The value of chunks must be greater than 2 times the size of the largest shardgroup in any shardspace.
- ClusterCertificate stringCommon Name 
- The certificate common name used in all cloudAutonomousVmClusters for the sharded database topology. Eg. Production. All the clusters used in one sharded database topology shall have same CABundle setup. Valid characterset for clusterCertificateCommonName include uppercase or lowercase letters, numbers, hyphens, underscores, and period.
- ConfigureGsms intTrigger 
- (Updatable) An optional property when incremented triggers Configure Gsms. Could be set to any integer value.
- ConfigureGsms boolTrigger Is Latest Gsm Image 
- ConfigureGsms []stringTrigger Old Gsm Names 
- ConfigureSharding intTrigger 
- (Updatable) An optional property when incremented triggers Configure Sharding. Could be set to any integer value.
- map[string]string
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- DownloadGsm intCertificate Signing Request Trigger 
- (Updatable) An optional property when incremented triggers Download Gsm Certificate Signing Request. Could be set to any integer value.
- map[string]string
- (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
- GenerateGsm intCertificate Signing Request Trigger 
- (Updatable) An optional property when incremented triggers Generate Gsm Certificate Signing Request. Could be set to any integer value.
- GenerateWallet stringPassword 
- GenerateWallet intTrigger 
- (Updatable) An optional property when incremented triggers Generate Wallet. Could be set to any integer value.
- GetConnection intString Trigger 
- (Updatable) An optional property when incremented triggers Get Connection String. Could be set to any integer value.
- PatchOperations []ShardedDatabase Patch Operation Args 
- (Updatable)
- ReplicationFactor int
- The Replication factor for RAFT replication based sharded database. Currently supported values are 3, 5 and 7.
- ReplicationMethod string
- The Replication method for sharded database.
- ReplicationUnit int
- For RAFT replication based sharded database, the value should be atleast twice the number of shards.
- StartDatabase intTrigger 
- (Updatable) An optional property when incremented triggers Start Database. Could be set to any integer value.
- StopDatabase intTrigger 
- (Updatable) An optional property when incremented triggers Stop Database. Could be set to any integer value.
- UploadSigned intCertificate And Generate Wallet Trigger 
- (Updatable) An optional property when incremented triggers Upload Signed Certificate And Generate Wallet. Could be set to any integer value.
- ValidateNetwork intTrigger 
- (Updatable) An optional property when incremented triggers Validate Network. Could be set to any integer value. - ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values 
- catalogDetails List<ShardedDatabase Catalog Detail> 
- Collection of ATP-Dedicated catalogs that needs to be created.
- characterSet 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 String
- (Updatable) Identifier of the compartment where sharded database is to be created.
- dbDeployment StringType 
- The database deployment type.
- dbVersion String
- Oracle Database version of the Autonomous Container Database.
- dbWorkload String
- Possible workload types.
- displayName String
- (Updatable) Oracle sharded database display name.
- listenerPort Integer
- The listener port number for sharded database.
- listenerPort IntegerTls 
- The TLS listener port number for sharded database.
- ncharacterSet 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
- onsPort IntegerLocal 
- Ons port local for sharded database.
- onsPort IntegerRemote 
- Ons remote port for sharded database.
- prefix String
- Unique name prefix for the sharded databases. Only alpha-numeric values are allowed. First character has to be a letter followed by any combination of letter and number.
- 
List<ShardedDatabase Shard Detail> 
- Collection of ATP-Dedicated shards that needs to be created.
- String
- Sharding Method.
- caSigned StringCertificate 
- chunks Integer
- The default number of unique chunks in a shardspace. The value of chunks must be greater than 2 times the size of the largest shardgroup in any shardspace.
- clusterCertificate StringCommon Name 
- The certificate common name used in all cloudAutonomousVmClusters for the sharded database topology. Eg. Production. All the clusters used in one sharded database topology shall have same CABundle setup. Valid characterset for clusterCertificateCommonName include uppercase or lowercase letters, numbers, hyphens, underscores, and period.
- configureGsms IntegerTrigger 
- (Updatable) An optional property when incremented triggers Configure Gsms. Could be set to any integer value.
- configureGsms BooleanTrigger Is Latest Gsm Image 
- configureGsms List<String>Trigger Old Gsm Names 
- configureSharding IntegerTrigger 
- (Updatable) An optional property when incremented triggers Configure Sharding. Could be set to any integer value.
- Map<String,String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- downloadGsm IntegerCertificate Signing Request Trigger 
- (Updatable) An optional property when incremented triggers Download Gsm Certificate Signing Request. Could be set to any integer value.
- Map<String,String>
- (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
- generateGsm IntegerCertificate Signing Request Trigger 
- (Updatable) An optional property when incremented triggers Generate Gsm Certificate Signing Request. Could be set to any integer value.
- generateWallet StringPassword 
- generateWallet IntegerTrigger 
- (Updatable) An optional property when incremented triggers Generate Wallet. Could be set to any integer value.
- getConnection IntegerString Trigger 
- (Updatable) An optional property when incremented triggers Get Connection String. Could be set to any integer value.
- patchOperations List<ShardedDatabase Patch Operation> 
- (Updatable)
- replicationFactor Integer
- The Replication factor for RAFT replication based sharded database. Currently supported values are 3, 5 and 7.
- replicationMethod String
- The Replication method for sharded database.
- replicationUnit Integer
- For RAFT replication based sharded database, the value should be atleast twice the number of shards.
- startDatabase IntegerTrigger 
- (Updatable) An optional property when incremented triggers Start Database. Could be set to any integer value.
- stopDatabase IntegerTrigger 
- (Updatable) An optional property when incremented triggers Stop Database. Could be set to any integer value.
- uploadSigned IntegerCertificate And Generate Wallet Trigger 
- (Updatable) An optional property when incremented triggers Upload Signed Certificate And Generate Wallet. Could be set to any integer value.
- validateNetwork IntegerTrigger 
- (Updatable) An optional property when incremented triggers Validate Network. Could be set to any integer value. - ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values 
- catalogDetails ShardedDatabase Catalog Detail[] 
- Collection of ATP-Dedicated catalogs that needs to be created.
- characterSet 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 string
- (Updatable) Identifier of the compartment where sharded database is to be created.
- dbDeployment stringType 
- The database deployment type.
- dbVersion string
- Oracle Database version of the Autonomous Container Database.
- dbWorkload string
- Possible workload types.
- displayName string
- (Updatable) Oracle sharded database display name.
- listenerPort number
- The listener port number for sharded database.
- listenerPort numberTls 
- The TLS listener port number for sharded database.
- ncharacterSet 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
- onsPort numberLocal 
- Ons port local for sharded database.
- onsPort numberRemote 
- Ons remote port for sharded database.
- prefix string
- Unique name prefix for the sharded databases. Only alpha-numeric values are allowed. First character has to be a letter followed by any combination of letter and number.
- 
ShardedDatabase Shard Detail[] 
- Collection of ATP-Dedicated shards that needs to be created.
- string
- Sharding Method.
- caSigned stringCertificate 
- chunks number
- The default number of unique chunks in a shardspace. The value of chunks must be greater than 2 times the size of the largest shardgroup in any shardspace.
- clusterCertificate stringCommon Name 
- The certificate common name used in all cloudAutonomousVmClusters for the sharded database topology. Eg. Production. All the clusters used in one sharded database topology shall have same CABundle setup. Valid characterset for clusterCertificateCommonName include uppercase or lowercase letters, numbers, hyphens, underscores, and period.
- configureGsms numberTrigger 
- (Updatable) An optional property when incremented triggers Configure Gsms. Could be set to any integer value.
- configureGsms booleanTrigger Is Latest Gsm Image 
- configureGsms string[]Trigger Old Gsm Names 
- configureSharding numberTrigger 
- (Updatable) An optional property when incremented triggers Configure Sharding. Could be set to any integer value.
- {[key: string]: string}
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- downloadGsm numberCertificate Signing Request Trigger 
- (Updatable) An optional property when incremented triggers Download Gsm Certificate Signing Request. Could be set to any integer value.
- {[key: string]: string}
- (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
- generateGsm numberCertificate Signing Request Trigger 
- (Updatable) An optional property when incremented triggers Generate Gsm Certificate Signing Request. Could be set to any integer value.
- generateWallet stringPassword 
- generateWallet numberTrigger 
- (Updatable) An optional property when incremented triggers Generate Wallet. Could be set to any integer value.
- getConnection numberString Trigger 
- (Updatable) An optional property when incremented triggers Get Connection String. Could be set to any integer value.
- patchOperations ShardedDatabase Patch Operation[] 
- (Updatable)
- replicationFactor number
- The Replication factor for RAFT replication based sharded database. Currently supported values are 3, 5 and 7.
- replicationMethod string
- The Replication method for sharded database.
- replicationUnit number
- For RAFT replication based sharded database, the value should be atleast twice the number of shards.
- startDatabase numberTrigger 
- (Updatable) An optional property when incremented triggers Start Database. Could be set to any integer value.
- stopDatabase numberTrigger 
- (Updatable) An optional property when incremented triggers Stop Database. Could be set to any integer value.
- uploadSigned numberCertificate And Generate Wallet Trigger 
- (Updatable) An optional property when incremented triggers Upload Signed Certificate And Generate Wallet. Could be set to any integer value.
- validateNetwork numberTrigger 
- (Updatable) An optional property when incremented triggers Validate Network. Could be set to any integer value. - ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values 
- catalog_details Sequence[ShardedDatabase Catalog Detail Args] 
- Collection of ATP-Dedicated catalogs that needs to be created.
- character_set str
- The character set for the new shard database being created. Use database api ListAutonomousDatabaseCharacterSets to get the list of allowed character set for autonomous dedicated database. See documentation: https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabaseCharacterSets/ListAutonomousDatabaseCharacterSets
- compartment_id str
- (Updatable) Identifier of the compartment where sharded database is to be created.
- db_deployment_ strtype 
- The database deployment type.
- db_version str
- Oracle Database version of the Autonomous Container Database.
- db_workload str
- Possible workload types.
- display_name str
- (Updatable) Oracle sharded database display name.
- listener_port int
- The listener port number for sharded database.
- listener_port_ inttls 
- The TLS listener port number for sharded database.
- ncharacter_set str
- The national character set for the new shard database being created. Use database api ListAutonomousDatabaseCharacterSets to get the list of allowed national character set for autonomous dedicated database. See documentation: https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabaseCharacterSets/ListAutonomousDatabaseCharacterSets
- ons_port_ intlocal 
- Ons port local for sharded database.
- ons_port_ intremote 
- Ons remote port for sharded database.
- prefix str
- Unique name prefix for the sharded databases. Only alpha-numeric values are allowed. First character has to be a letter followed by any combination of letter and number.
- 
Sequence[ShardedDatabase Shard Detail Args] 
- Collection of ATP-Dedicated shards that needs to be created.
- str
- Sharding Method.
- ca_signed_ strcertificate 
- chunks int
- The default number of unique chunks in a shardspace. The value of chunks must be greater than 2 times the size of the largest shardgroup in any shardspace.
- cluster_certificate_ strcommon_ name 
- The certificate common name used in all cloudAutonomousVmClusters for the sharded database topology. Eg. Production. All the clusters used in one sharded database topology shall have same CABundle setup. Valid characterset for clusterCertificateCommonName include uppercase or lowercase letters, numbers, hyphens, underscores, and period.
- configure_gsms_ inttrigger 
- (Updatable) An optional property when incremented triggers Configure Gsms. Could be set to any integer value.
- configure_gsms_ booltrigger_ is_ latest_ gsm_ image 
- configure_gsms_ Sequence[str]trigger_ old_ gsm_ names 
- configure_sharding_ inttrigger 
- (Updatable) An optional property when incremented triggers Configure Sharding. Could be set to any integer value.
- Mapping[str, str]
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- download_gsm_ intcertificate_ signing_ request_ trigger 
- (Updatable) An optional property when incremented triggers Download Gsm Certificate Signing Request. Could be set to any integer value.
- Mapping[str, str]
- (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
- generate_gsm_ intcertificate_ signing_ request_ trigger 
- (Updatable) An optional property when incremented triggers Generate Gsm Certificate Signing Request. Could be set to any integer value.
- generate_wallet_ strpassword 
- generate_wallet_ inttrigger 
- (Updatable) An optional property when incremented triggers Generate Wallet. Could be set to any integer value.
- get_connection_ intstring_ trigger 
- (Updatable) An optional property when incremented triggers Get Connection String. Could be set to any integer value.
- patch_operations Sequence[ShardedDatabase Patch Operation Args] 
- (Updatable)
- replication_factor int
- The Replication factor for RAFT replication based sharded database. Currently supported values are 3, 5 and 7.
- replication_method str
- The Replication method for sharded database.
- replication_unit int
- For RAFT replication based sharded database, the value should be atleast twice the number of shards.
- start_database_ inttrigger 
- (Updatable) An optional property when incremented triggers Start Database. Could be set to any integer value.
- stop_database_ inttrigger 
- (Updatable) An optional property when incremented triggers Stop Database. Could be set to any integer value.
- upload_signed_ intcertificate_ and_ generate_ wallet_ trigger 
- (Updatable) An optional property when incremented triggers Upload Signed Certificate And Generate Wallet. Could be set to any integer value.
- validate_network_ inttrigger 
- (Updatable) An optional property when incremented triggers Validate Network. Could be set to any integer value. - ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values 
- catalogDetails List<Property Map>
- Collection of ATP-Dedicated catalogs that needs to be created.
- characterSet 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 String
- (Updatable) Identifier of the compartment where sharded database is to be created.
- dbDeployment StringType 
- The database deployment type.
- dbVersion String
- Oracle Database version of the Autonomous Container Database.
- dbWorkload String
- Possible workload types.
- displayName String
- (Updatable) Oracle sharded database display name.
- listenerPort Number
- The listener port number for sharded database.
- listenerPort NumberTls 
- The TLS listener port number for sharded database.
- ncharacterSet 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
- onsPort NumberLocal 
- Ons port local for sharded database.
- onsPort NumberRemote 
- Ons remote port for sharded database.
- prefix String
- Unique name prefix for the sharded databases. Only alpha-numeric values are allowed. First character has to be a letter followed by any combination of letter and number.
- List<Property Map>
- Collection of ATP-Dedicated shards that needs to be created.
- String
- Sharding Method.
- caSigned StringCertificate 
- chunks Number
- The default number of unique chunks in a shardspace. The value of chunks must be greater than 2 times the size of the largest shardgroup in any shardspace.
- clusterCertificate StringCommon Name 
- The certificate common name used in all cloudAutonomousVmClusters for the sharded database topology. Eg. Production. All the clusters used in one sharded database topology shall have same CABundle setup. Valid characterset for clusterCertificateCommonName include uppercase or lowercase letters, numbers, hyphens, underscores, and period.
- configureGsms NumberTrigger 
- (Updatable) An optional property when incremented triggers Configure Gsms. Could be set to any integer value.
- configureGsms BooleanTrigger Is Latest Gsm Image 
- configureGsms List<String>Trigger Old Gsm Names 
- configureSharding NumberTrigger 
- (Updatable) An optional property when incremented triggers Configure Sharding. Could be set to any integer value.
- Map<String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- downloadGsm NumberCertificate Signing Request Trigger 
- (Updatable) An optional property when incremented triggers Download Gsm Certificate Signing Request. Could be set to any integer value.
- Map<String>
- (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
- generateGsm NumberCertificate Signing Request Trigger 
- (Updatable) An optional property when incremented triggers Generate Gsm Certificate Signing Request. Could be set to any integer value.
- generateWallet StringPassword 
- generateWallet NumberTrigger 
- (Updatable) An optional property when incremented triggers Generate Wallet. Could be set to any integer value.
- getConnection NumberString Trigger 
- (Updatable) An optional property when incremented triggers Get Connection String. Could be set to any integer value.
- patchOperations List<Property Map>
- (Updatable)
- replicationFactor Number
- The Replication factor for RAFT replication based sharded database. Currently supported values are 3, 5 and 7.
- replicationMethod String
- The Replication method for sharded database.
- replicationUnit Number
- For RAFT replication based sharded database, the value should be atleast twice the number of shards.
- startDatabase NumberTrigger 
- (Updatable) An optional property when incremented triggers Start Database. Could be set to any integer value.
- stopDatabase NumberTrigger 
- (Updatable) An optional property when incremented triggers Stop Database. Could be set to any integer value.
- uploadSigned NumberCertificate And Generate Wallet Trigger 
- (Updatable) An optional property when incremented triggers Upload Signed Certificate And Generate Wallet. Could be set to any integer value.
- validateNetwork NumberTrigger 
- (Updatable) An optional property when incremented triggers Validate Network. Could be set to any integer value. - ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values 
Outputs
All input properties are implicitly available as output properties. Additionally, the ShardedDatabase resource produces the following output properties:
- ConnectionStrings List<ShardedDatabase Connection String> 
- Details of sharded database connection String.
- Gsms
List<ShardedDatabase Gsm> 
- Details of GSM instances for the sharded database.
- Id string
- The provider-assigned unique ID for this managed resource.
- LifecycleState string
- LifecycleState stringDetails 
- Detailed message for the lifecycle state.
- PrivateEndpoint string
- The OCID of private endpoint being used by the sharded database.
- string
- State string
- Lifecycle states for sharded databases.
- Dictionary<string, string>
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
- 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 []ShardedDatabase Connection String 
- Details of sharded database connection String.
- Gsms
[]ShardedDatabase Gsm 
- Details of GSM instances for the sharded database.
- Id string
- The provider-assigned unique ID for this managed resource.
- LifecycleState string
- LifecycleState stringDetails 
- Detailed message for the lifecycle state.
- PrivateEndpoint string
- The OCID of private endpoint being used by the sharded database.
- string
- State string
- Lifecycle states for sharded databases.
- map[string]string
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
- 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<ShardedDatabase Connection String> 
- Details of sharded database connection String.
- gsms
List<ShardedDatabase Gsm> 
- Details of GSM instances for the sharded database.
- id String
- The provider-assigned unique ID for this managed resource.
- lifecycleState String
- lifecycleState StringDetails 
- Detailed message for the lifecycle state.
- privateEndpoint String
- The OCID of private endpoint being used by the sharded database.
- String
- state String
- Lifecycle states for sharded databases.
- Map<String,String>
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
- 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 ShardedDatabase Connection String[] 
- Details of sharded database connection String.
- gsms
ShardedDatabase Gsm[] 
- Details of GSM instances for the sharded database.
- id string
- The provider-assigned unique ID for this managed resource.
- lifecycleState string
- lifecycleState stringDetails 
- Detailed message for the lifecycle state.
- privateEndpoint string
- The OCID of private endpoint being used by the sharded database.
- string
- state string
- Lifecycle states for sharded databases.
- {[key: string]: string}
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
- 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[ShardedDatabase Connection String] 
- Details of sharded database connection String.
- gsms
Sequence[ShardedDatabase Gsm] 
- Details of GSM instances for the sharded database.
- id str
- The provider-assigned unique ID for this managed resource.
- lifecycle_state str
- lifecycle_state_ strdetails 
- Detailed message for the lifecycle state.
- private_endpoint str
- The OCID of private endpoint being used by the sharded database.
- str
- state str
- Lifecycle states for sharded databases.
- Mapping[str, str]
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
- time_created str
- The time the the Sharded Database was created. An RFC3339 formatted datetime string
- time_updated str
- The time the Sharded Database was last updated. An RFC3339 formatted datetime string
- time_zone str
- Timezone associated with the sharded database.
- 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
- lifecycleState StringDetails 
- Detailed message for the lifecycle state.
- privateEndpoint String
- The OCID of private endpoint being used by the sharded database.
- String
- state String
- Lifecycle states for sharded databases.
- Map<String>
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
- 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[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[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[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[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[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) -> ShardedDatabasefunc 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
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- CaSigned stringCertificate 
- CatalogDetails List<ShardedDatabase Catalog Detail> 
- Collection of ATP-Dedicated catalogs that needs to be created.
- CharacterSet string
- The character set for the new shard database being created. Use database api ListAutonomousDatabaseCharacterSets to get the list of allowed character set for autonomous dedicated database. See documentation: https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabaseCharacterSets/ListAutonomousDatabaseCharacterSets
- Chunks int
- The default number of unique chunks in a shardspace. The value of chunks must be greater than 2 times the size of the largest shardgroup in any shardspace.
- ClusterCertificate stringCommon Name 
- The certificate common name used in all cloudAutonomousVmClusters for the sharded database topology. Eg. Production. All the clusters used in one sharded database topology shall have same CABundle setup. Valid characterset for clusterCertificateCommonName include uppercase or lowercase letters, numbers, hyphens, underscores, and period.
- CompartmentId string
- (Updatable) Identifier of the compartment where sharded database is to be created.
- ConfigureGsms intTrigger 
- (Updatable) An optional property when incremented triggers Configure Gsms. Could be set to any integer value.
- ConfigureGsms boolTrigger Is Latest Gsm Image 
- ConfigureGsms List<string>Trigger Old Gsm Names 
- ConfigureSharding intTrigger 
- (Updatable) An optional property when incremented triggers Configure Sharding. Could be set to any integer value.
- ConnectionStrings List<ShardedDatabase Connection String> 
- Details of sharded database connection String.
- DbDeployment stringType 
- The database deployment type.
- DbVersion string
- Oracle Database version of the Autonomous Container Database.
- DbWorkload string
- Possible workload types.
- Dictionary<string, string>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- DisplayName string
- (Updatable) Oracle sharded database display name.
- DownloadGsm intCertificate Signing Request Trigger 
- (Updatable) An optional property when incremented triggers Download Gsm Certificate Signing Request. Could be set to any integer value.
- Dictionary<string, string>
- (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
- GenerateGsm intCertificate Signing Request Trigger 
- (Updatable) An optional property when incremented triggers Generate Gsm Certificate Signing Request. Could be set to any integer value.
- GenerateWallet stringPassword 
- GenerateWallet intTrigger 
- (Updatable) An optional property when incremented triggers Generate Wallet. Could be set to any integer value.
- GetConnection intString Trigger 
- (Updatable) An optional property when incremented triggers Get Connection String. Could be set to any integer value.
- Gsms
List<ShardedDatabase Gsm> 
- Details of GSM instances for the sharded database.
- LifecycleState string
- LifecycleState stringDetails 
- Detailed message for the lifecycle state.
- ListenerPort int
- The listener port number for sharded database.
- ListenerPort intTls 
- The TLS listener port number for sharded database.
- NcharacterSet 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
- OnsPort intLocal 
- Ons port local for sharded database.
- OnsPort intRemote 
- Ons remote port for sharded database.
- PatchOperations List<ShardedDatabase Patch Operation> 
- (Updatable)
- Prefix string
- Unique name prefix for the sharded databases. Only alpha-numeric values are allowed. First character has to be a letter followed by any combination of letter and number.
- PrivateEndpoint string
- The OCID of private endpoint being used by the sharded database.
- ReplicationFactor int
- The Replication factor for RAFT replication based sharded database. Currently supported values are 3, 5 and 7.
- ReplicationMethod string
- The Replication method for sharded database.
- ReplicationUnit int
- For RAFT replication based sharded database, the value should be atleast twice the number of shards.
- ShardDetails List<ShardedDatabase Shard Detail> 
- Collection of ATP-Dedicated shards that needs to be created.
- ShardedDatabase stringId 
- ShardingMethod string
- Sharding Method.
- StartDatabase intTrigger 
- (Updatable) An optional property when incremented triggers Start Database. Could be set to any integer value.
- State string
- Lifecycle states for sharded databases.
- StopDatabase intTrigger 
- (Updatable) An optional property when incremented triggers Stop Database. Could be set to any integer value.
- Dictionary<string, string>
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
- 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.
- UploadSigned intCertificate And Generate Wallet Trigger 
- (Updatable) An optional property when incremented triggers Upload Signed Certificate And Generate Wallet. Could be set to any integer value.
- ValidateNetwork intTrigger 
- (Updatable) An optional property when incremented triggers Validate Network. Could be set to any integer value. - ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values 
- CaSigned stringCertificate 
- CatalogDetails []ShardedDatabase Catalog Detail Args 
- Collection of ATP-Dedicated catalogs that needs to be created.
- CharacterSet string
- The character set for the new shard database being created. Use database api ListAutonomousDatabaseCharacterSets to get the list of allowed character set for autonomous dedicated database. See documentation: https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabaseCharacterSets/ListAutonomousDatabaseCharacterSets
- Chunks int
- The default number of unique chunks in a shardspace. The value of chunks must be greater than 2 times the size of the largest shardgroup in any shardspace.
- ClusterCertificate stringCommon Name 
- The certificate common name used in all cloudAutonomousVmClusters for the sharded database topology. Eg. Production. All the clusters used in one sharded database topology shall have same CABundle setup. Valid characterset for clusterCertificateCommonName include uppercase or lowercase letters, numbers, hyphens, underscores, and period.
- CompartmentId string
- (Updatable) Identifier of the compartment where sharded database is to be created.
- ConfigureGsms intTrigger 
- (Updatable) An optional property when incremented triggers Configure Gsms. Could be set to any integer value.
- ConfigureGsms boolTrigger Is Latest Gsm Image 
- ConfigureGsms []stringTrigger Old Gsm Names 
- ConfigureSharding intTrigger 
- (Updatable) An optional property when incremented triggers Configure Sharding. Could be set to any integer value.
- ConnectionStrings []ShardedDatabase Connection String Args 
- Details of sharded database connection String.
- DbDeployment stringType 
- The database deployment type.
- DbVersion string
- Oracle Database version of the Autonomous Container Database.
- DbWorkload string
- Possible workload types.
- map[string]string
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- DisplayName string
- (Updatable) Oracle sharded database display name.
- DownloadGsm intCertificate Signing Request Trigger 
- (Updatable) An optional property when incremented triggers Download Gsm Certificate Signing Request. Could be set to any integer value.
- map[string]string
- (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
- GenerateGsm intCertificate Signing Request Trigger 
- (Updatable) An optional property when incremented triggers Generate Gsm Certificate Signing Request. Could be set to any integer value.
- GenerateWallet stringPassword 
- GenerateWallet intTrigger 
- (Updatable) An optional property when incremented triggers Generate Wallet. Could be set to any integer value.
- GetConnection intString Trigger 
- (Updatable) An optional property when incremented triggers Get Connection String. Could be set to any integer value.
- Gsms
[]ShardedDatabase Gsm Args 
- Details of GSM instances for the sharded database.
- LifecycleState string
- LifecycleState stringDetails 
- Detailed message for the lifecycle state.
- ListenerPort int
- The listener port number for sharded database.
- ListenerPort intTls 
- The TLS listener port number for sharded database.
- NcharacterSet 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
- OnsPort intLocal 
- Ons port local for sharded database.
- OnsPort intRemote 
- Ons remote port for sharded database.
- PatchOperations []ShardedDatabase Patch Operation Args 
- (Updatable)
- Prefix string
- Unique name prefix for the sharded databases. Only alpha-numeric values are allowed. First character has to be a letter followed by any combination of letter and number.
- PrivateEndpoint string
- The OCID of private endpoint being used by the sharded database.
- ReplicationFactor int
- The Replication factor for RAFT replication based sharded database. Currently supported values are 3, 5 and 7.
- ReplicationMethod string
- The Replication method for sharded database.
- ReplicationUnit int
- For RAFT replication based sharded database, the value should be atleast twice the number of shards.
- ShardDetails []ShardedDatabase Shard Detail Args 
- Collection of ATP-Dedicated shards that needs to be created.
- ShardedDatabase stringId 
- ShardingMethod string
- Sharding Method.
- StartDatabase intTrigger 
- (Updatable) An optional property when incremented triggers Start Database. Could be set to any integer value.
- State string
- Lifecycle states for sharded databases.
- StopDatabase intTrigger 
- (Updatable) An optional property when incremented triggers Stop Database. Could be set to any integer value.
- map[string]string
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
- 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.
- UploadSigned intCertificate And Generate Wallet Trigger 
- (Updatable) An optional property when incremented triggers Upload Signed Certificate And Generate Wallet. Could be set to any integer value.
- ValidateNetwork intTrigger 
- (Updatable) An optional property when incremented triggers Validate Network. Could be set to any integer value. - ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values 
- caSigned StringCertificate 
- catalogDetails List<ShardedDatabase Catalog Detail> 
- Collection of ATP-Dedicated catalogs that needs to be created.
- characterSet String
- The character set for the new shard database being created. Use database api ListAutonomousDatabaseCharacterSets to get the list of allowed character set for autonomous dedicated database. See documentation: https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabaseCharacterSets/ListAutonomousDatabaseCharacterSets
- chunks Integer
- The default number of unique chunks in a shardspace. The value of chunks must be greater than 2 times the size of the largest shardgroup in any shardspace.
- clusterCertificate StringCommon Name 
- The certificate common name used in all cloudAutonomousVmClusters for the sharded database topology. Eg. Production. All the clusters used in one sharded database topology shall have same CABundle setup. Valid characterset for clusterCertificateCommonName include uppercase or lowercase letters, numbers, hyphens, underscores, and period.
- compartmentId String
- (Updatable) Identifier of the compartment where sharded database is to be created.
- configureGsms IntegerTrigger 
- (Updatable) An optional property when incremented triggers Configure Gsms. Could be set to any integer value.
- configureGsms BooleanTrigger Is Latest Gsm Image 
- configureGsms List<String>Trigger Old Gsm Names 
- configureSharding IntegerTrigger 
- (Updatable) An optional property when incremented triggers Configure Sharding. Could be set to any integer value.
- connectionStrings List<ShardedDatabase Connection String> 
- Details of sharded database connection String.
- dbDeployment StringType 
- The database deployment type.
- dbVersion String
- Oracle Database version of the Autonomous Container Database.
- dbWorkload String
- Possible workload types.
- Map<String,String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- displayName String
- (Updatable) Oracle sharded database display name.
- downloadGsm IntegerCertificate Signing Request Trigger 
- (Updatable) An optional property when incremented triggers Download Gsm Certificate Signing Request. Could be set to any integer value.
- Map<String,String>
- (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
- generateGsm IntegerCertificate Signing Request Trigger 
- (Updatable) An optional property when incremented triggers Generate Gsm Certificate Signing Request. Could be set to any integer value.
- generateWallet StringPassword 
- generateWallet IntegerTrigger 
- (Updatable) An optional property when incremented triggers Generate Wallet. Could be set to any integer value.
- getConnection IntegerString Trigger 
- (Updatable) An optional property when incremented triggers Get Connection String. Could be set to any integer value.
- gsms
List<ShardedDatabase Gsm> 
- Details of GSM instances for the sharded database.
- lifecycleState String
- lifecycleState StringDetails 
- Detailed message for the lifecycle state.
- listenerPort Integer
- The listener port number for sharded database.
- listenerPort IntegerTls 
- The TLS listener port number for sharded database.
- ncharacterSet 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
- onsPort IntegerLocal 
- Ons port local for sharded database.
- onsPort IntegerRemote 
- Ons remote port for sharded database.
- patchOperations List<ShardedDatabase Patch Operation> 
- (Updatable)
- prefix String
- Unique name prefix for the sharded databases. Only alpha-numeric values are allowed. First character has to be a letter followed by any combination of letter and number.
- privateEndpoint String
- The OCID of private endpoint being used by the sharded database.
- replicationFactor Integer
- The Replication factor for RAFT replication based sharded database. Currently supported values are 3, 5 and 7.
- replicationMethod String
- The Replication method for sharded database.
- replicationUnit Integer
- For RAFT replication based sharded database, the value should be atleast twice the number of shards.
- shardDetails List<ShardedDatabase Shard Detail> 
- Collection of ATP-Dedicated shards that needs to be created.
- shardedDatabase StringId 
- shardingMethod String
- Sharding Method.
- startDatabase IntegerTrigger 
- (Updatable) An optional property when incremented triggers Start Database. Could be set to any integer value.
- state String
- Lifecycle states for sharded databases.
- stopDatabase IntegerTrigger 
- (Updatable) An optional property when incremented triggers Stop Database. Could be set to any integer value.
- Map<String,String>
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
- 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.
- uploadSigned IntegerCertificate And Generate Wallet Trigger 
- (Updatable) An optional property when incremented triggers Upload Signed Certificate And Generate Wallet. Could be set to any integer value.
- validateNetwork IntegerTrigger 
- (Updatable) An optional property when incremented triggers Validate Network. Could be set to any integer value. - ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values 
- caSigned stringCertificate 
- catalogDetails ShardedDatabase Catalog Detail[] 
- Collection of ATP-Dedicated catalogs that needs to be created.
- characterSet string
- The character set for the new shard database being created. Use database api ListAutonomousDatabaseCharacterSets to get the list of allowed character set for autonomous dedicated database. See documentation: https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabaseCharacterSets/ListAutonomousDatabaseCharacterSets
- chunks number
- The default number of unique chunks in a shardspace. The value of chunks must be greater than 2 times the size of the largest shardgroup in any shardspace.
- clusterCertificate stringCommon Name 
- The certificate common name used in all cloudAutonomousVmClusters for the sharded database topology. Eg. Production. All the clusters used in one sharded database topology shall have same CABundle setup. Valid characterset for clusterCertificateCommonName include uppercase or lowercase letters, numbers, hyphens, underscores, and period.
- compartmentId string
- (Updatable) Identifier of the compartment where sharded database is to be created.
- configureGsms numberTrigger 
- (Updatable) An optional property when incremented triggers Configure Gsms. Could be set to any integer value.
- configureGsms booleanTrigger Is Latest Gsm Image 
- configureGsms string[]Trigger Old Gsm Names 
- configureSharding numberTrigger 
- (Updatable) An optional property when incremented triggers Configure Sharding. Could be set to any integer value.
- connectionStrings ShardedDatabase Connection String[] 
- Details of sharded database connection String.
- dbDeployment stringType 
- The database deployment type.
- dbVersion string
- Oracle Database version of the Autonomous Container Database.
- dbWorkload string
- Possible workload types.
- {[key: string]: string}
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- displayName string
- (Updatable) Oracle sharded database display name.
- downloadGsm numberCertificate Signing Request Trigger 
- (Updatable) An optional property when incremented triggers Download Gsm Certificate Signing Request. Could be set to any integer value.
- {[key: string]: string}
- (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
- generateGsm numberCertificate Signing Request Trigger 
- (Updatable) An optional property when incremented triggers Generate Gsm Certificate Signing Request. Could be set to any integer value.
- generateWallet stringPassword 
- generateWallet numberTrigger 
- (Updatable) An optional property when incremented triggers Generate Wallet. Could be set to any integer value.
- getConnection numberString Trigger 
- (Updatable) An optional property when incremented triggers Get Connection String. Could be set to any integer value.
- gsms
ShardedDatabase Gsm[] 
- Details of GSM instances for the sharded database.
- lifecycleState string
- lifecycleState stringDetails 
- Detailed message for the lifecycle state.
- listenerPort number
- The listener port number for sharded database.
- listenerPort numberTls 
- The TLS listener port number for sharded database.
- ncharacterSet 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
- onsPort numberLocal 
- Ons port local for sharded database.
- onsPort numberRemote 
- Ons remote port for sharded database.
- patchOperations ShardedDatabase Patch Operation[] 
- (Updatable)
- prefix string
- Unique name prefix for the sharded databases. Only alpha-numeric values are allowed. First character has to be a letter followed by any combination of letter and number.
- privateEndpoint string
- The OCID of private endpoint being used by the sharded database.
- replicationFactor number
- The Replication factor for RAFT replication based sharded database. Currently supported values are 3, 5 and 7.
- replicationMethod string
- The Replication method for sharded database.
- replicationUnit number
- For RAFT replication based sharded database, the value should be atleast twice the number of shards.
- shardDetails ShardedDatabase Shard Detail[] 
- Collection of ATP-Dedicated shards that needs to be created.
- shardedDatabase stringId 
- shardingMethod string
- Sharding Method.
- startDatabase numberTrigger 
- (Updatable) An optional property when incremented triggers Start Database. Could be set to any integer value.
- state string
- Lifecycle states for sharded databases.
- stopDatabase numberTrigger 
- (Updatable) An optional property when incremented triggers Stop Database. Could be set to any integer value.
- {[key: string]: string}
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
- 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.
- uploadSigned numberCertificate And Generate Wallet Trigger 
- (Updatable) An optional property when incremented triggers Upload Signed Certificate And Generate Wallet. Could be set to any integer value.
- validateNetwork numberTrigger 
- (Updatable) An optional property when incremented triggers Validate Network. Could be set to any integer value. - ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values 
- ca_signed_ strcertificate 
- catalog_details Sequence[ShardedDatabase Catalog Detail Args] 
- Collection of ATP-Dedicated catalogs that needs to be created.
- character_set str
- The character set for the new shard database being created. Use database api ListAutonomousDatabaseCharacterSets to get the list of allowed character set for autonomous dedicated database. See documentation: https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabaseCharacterSets/ListAutonomousDatabaseCharacterSets
- chunks int
- The default number of unique chunks in a shardspace. The value of chunks must be greater than 2 times the size of the largest shardgroup in any shardspace.
- cluster_certificate_ strcommon_ name 
- The certificate common name used in all cloudAutonomousVmClusters for the sharded database topology. Eg. Production. All the clusters used in one sharded database topology shall have same CABundle setup. Valid characterset for clusterCertificateCommonName include uppercase or lowercase letters, numbers, hyphens, underscores, and period.
- compartment_id str
- (Updatable) Identifier of the compartment where sharded database is to be created.
- configure_gsms_ inttrigger 
- (Updatable) An optional property when incremented triggers Configure Gsms. Could be set to any integer value.
- configure_gsms_ booltrigger_ is_ latest_ gsm_ image 
- configure_gsms_ Sequence[str]trigger_ old_ gsm_ names 
- configure_sharding_ inttrigger 
- (Updatable) An optional property when incremented triggers Configure Sharding. Could be set to any integer value.
- connection_strings Sequence[ShardedDatabase Connection String Args] 
- Details of sharded database connection String.
- db_deployment_ strtype 
- The database deployment type.
- db_version str
- Oracle Database version of the Autonomous Container Database.
- db_workload str
- Possible workload types.
- Mapping[str, str]
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- display_name str
- (Updatable) Oracle sharded database display name.
- download_gsm_ intcertificate_ signing_ request_ trigger 
- (Updatable) An optional property when incremented triggers Download Gsm Certificate Signing Request. Could be set to any integer value.
- Mapping[str, str]
- (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
- generate_gsm_ intcertificate_ signing_ request_ trigger 
- (Updatable) An optional property when incremented triggers Generate Gsm Certificate Signing Request. Could be set to any integer value.
- generate_wallet_ strpassword 
- generate_wallet_ inttrigger 
- (Updatable) An optional property when incremented triggers Generate Wallet. Could be set to any integer value.
- get_connection_ intstring_ trigger 
- (Updatable) An optional property when incremented triggers Get Connection String. Could be set to any integer value.
- gsms
Sequence[ShardedDatabase Gsm Args] 
- Details of GSM instances for the sharded database.
- lifecycle_state str
- lifecycle_state_ strdetails 
- Detailed message for the lifecycle state.
- listener_port int
- The listener port number for sharded database.
- listener_port_ inttls 
- The TLS listener port number for sharded database.
- ncharacter_set str
- The national character set for the new shard database being created. Use database api ListAutonomousDatabaseCharacterSets to get the list of allowed national character set for autonomous dedicated database. See documentation: https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabaseCharacterSets/ListAutonomousDatabaseCharacterSets
- ons_port_ intlocal 
- Ons port local for sharded database.
- ons_port_ intremote 
- Ons remote port for sharded database.
- patch_operations Sequence[ShardedDatabase Patch Operation Args] 
- (Updatable)
- prefix str
- Unique name prefix for the sharded databases. Only alpha-numeric values are allowed. First character has to be a letter followed by any combination of letter and number.
- private_endpoint str
- The OCID of private endpoint being used by the sharded database.
- replication_factor int
- The Replication factor for RAFT replication based sharded database. Currently supported values are 3, 5 and 7.
- replication_method str
- The Replication method for sharded database.
- replication_unit int
- For RAFT replication based sharded database, the value should be atleast twice the number of shards.
- shard_details Sequence[ShardedDatabase Shard Detail Args] 
- Collection of ATP-Dedicated shards that needs to be created.
- sharded_database_ strid 
- sharding_method str
- Sharding Method.
- start_database_ inttrigger 
- (Updatable) An optional property when incremented triggers Start Database. Could be set to any integer value.
- state str
- Lifecycle states for sharded databases.
- stop_database_ inttrigger 
- (Updatable) An optional property when incremented triggers Stop Database. Could be set to any integer value.
- Mapping[str, str]
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
- time_created str
- The time the the Sharded Database was created. An RFC3339 formatted datetime string
- time_updated str
- The time the Sharded Database was last updated. An RFC3339 formatted datetime string
- time_zone str
- Timezone associated with the sharded database.
- upload_signed_ intcertificate_ and_ generate_ wallet_ trigger 
- (Updatable) An optional property when incremented triggers Upload Signed Certificate And Generate Wallet. Could be set to any integer value.
- validate_network_ inttrigger 
- (Updatable) An optional property when incremented triggers Validate Network. Could be set to any integer value. - ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values 
- caSigned StringCertificate 
- catalogDetails List<Property Map>
- Collection of ATP-Dedicated catalogs that needs to be created.
- characterSet String
- The character set for the new shard database being created. Use database api ListAutonomousDatabaseCharacterSets to get the list of allowed character set for autonomous dedicated database. See documentation: https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabaseCharacterSets/ListAutonomousDatabaseCharacterSets
- chunks Number
- The default number of unique chunks in a shardspace. The value of chunks must be greater than 2 times the size of the largest shardgroup in any shardspace.
- clusterCertificate StringCommon Name 
- The certificate common name used in all cloudAutonomousVmClusters for the sharded database topology. Eg. Production. All the clusters used in one sharded database topology shall have same CABundle setup. Valid characterset for clusterCertificateCommonName include uppercase or lowercase letters, numbers, hyphens, underscores, and period.
- compartmentId String
- (Updatable) Identifier of the compartment where sharded database is to be created.
- configureGsms NumberTrigger 
- (Updatable) An optional property when incremented triggers Configure Gsms. Could be set to any integer value.
- configureGsms BooleanTrigger Is Latest Gsm Image 
- configureGsms List<String>Trigger Old Gsm Names 
- configureSharding NumberTrigger 
- (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.
- dbDeployment StringType 
- The database deployment type.
- dbVersion String
- Oracle Database version of the Autonomous Container Database.
- dbWorkload String
- Possible workload types.
- Map<String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- displayName String
- (Updatable) Oracle sharded database display name.
- downloadGsm NumberCertificate Signing Request Trigger 
- (Updatable) An optional property when incremented triggers Download Gsm Certificate Signing Request. Could be set to any integer value.
- Map<String>
- (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
- generateGsm NumberCertificate Signing Request Trigger 
- (Updatable) An optional property when incremented triggers Generate Gsm Certificate Signing Request. Could be set to any integer value.
- generateWallet StringPassword 
- generateWallet NumberTrigger 
- (Updatable) An optional property when incremented triggers Generate Wallet. Could be set to any integer value.
- getConnection NumberString Trigger 
- (Updatable) An optional property when incremented triggers Get Connection String. Could be set to any integer value.
- gsms List<Property Map>
- Details of GSM instances for the sharded database.
- lifecycleState String
- lifecycleState StringDetails 
- Detailed message for the lifecycle state.
- listenerPort Number
- The listener port number for sharded database.
- listenerPort NumberTls 
- The TLS listener port number for sharded database.
- ncharacterSet 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
- onsPort NumberLocal 
- Ons port local for sharded database.
- onsPort NumberRemote 
- Ons remote port for sharded database.
- patchOperations List<Property Map>
- (Updatable)
- prefix String
- Unique name prefix for the sharded databases. Only alpha-numeric values are allowed. First character has to be a letter followed by any combination of letter and number.
- privateEndpoint String
- The OCID of private endpoint being used by the sharded database.
- replicationFactor Number
- The Replication factor for RAFT replication based sharded database. Currently supported values are 3, 5 and 7.
- replicationMethod String
- The Replication method for sharded database.
- replicationUnit Number
- For RAFT replication based sharded database, the value should be atleast twice the number of shards.
- shardDetails List<Property Map>
- Collection of ATP-Dedicated shards that needs to be created.
- shardedDatabase StringId 
- shardingMethod String
- Sharding Method.
- startDatabase NumberTrigger 
- (Updatable) An optional property when incremented triggers Start Database. Could be set to any integer value.
- state String
- Lifecycle states for sharded databases.
- stopDatabase NumberTrigger 
- (Updatable) An optional property when incremented triggers Stop Database. Could be set to any integer value.
- Map<String>
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
- 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.
- uploadSigned NumberCertificate And Generate Wallet Trigger 
- (Updatable) An optional property when incremented triggers Upload Signed Certificate And Generate Wallet. Could be set to any integer value.
- validateNetwork NumberTrigger 
- (Updatable) An optional property when incremented triggers Validate Network. Could be set to any integer value. - ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values 
Supporting Types
ShardedDatabaseCatalogDetail, ShardedDatabaseCatalogDetailArgs        
- AdminPassword string
- Admin password for the catalog database.
- CloudAutonomous stringVm Cluster Id 
- The OCID of the cloud Autonomous Exadata VM Cluster.
- ComputeCount double
- The compute count for the catalog database. It has to be in multiple of 2.
- DataStorage doubleSize In Gbs 
- The data disk group size to be allocated in GBs for the catalog database.
- IsAuto boolScaling Enabled 
- Determines the auto-scaling mode for the catalog database.
- ContainerDatabase stringId 
- Identifier of the underlying container database.
- ContainerDatabase stringParent Id 
- Identifier of the underlying container database parent.
- EncryptionKey ShardedDetails Database Catalog Detail Encryption Key Details 
- Details of encryption key to be used to encrypt data for shards and catalog for sharded database. For system-defined sharding type, all shards have to use same encryptionKeyDetails. For system-defined sharding, if encryptionKeyDetails are not specified for catalog, then Oracle managed key will be used for catalog. For user-defined sharding type, if encryptionKeyDetails are not provided for any shard or catalog, then Oracle managed key will be used for such shard or catalog. For system-defined or user-defined sharding type, if the shard or catalog has a peer in region other than primary shard or catalog region, then make sure to provide virtual vault for such shard or catalog, which is also replicated to peer region (the region where peer or standby shard or catalog exists).
- Metadata Dictionary<string, string>
- Additional metadata related to shard's underlying supporting resource.
- Name string
- Name of the shard.
- PeerCloud stringAutonomous Vm Cluster Id 
- The OCID of the peer cloud Autonomous Exadata VM Cluster.
- string
- Name of the shard-group to which the shard belongs.
- Status string
- Status of shard or catalog or gsm for the sharded database.
- SupportingResource stringId 
- Identifier of the underlying supporting resource.
- TimeCreated string
- The time the the Sharded Database was created. An RFC3339 formatted datetime string
- TimeSsl stringCertificate Expires 
- The time the ssl certificate associated with shard expires. An RFC3339 formatted datetime string
- TimeUpdated string
- The time the Sharded Database was last updated. An RFC3339 formatted datetime string
- AdminPassword string
- Admin password for the catalog database.
- CloudAutonomous stringVm Cluster Id 
- The OCID of the cloud Autonomous Exadata VM Cluster.
- ComputeCount float64
- The compute count for the catalog database. It has to be in multiple of 2.
- DataStorage float64Size In Gbs 
- The data disk group size to be allocated in GBs for the catalog database.
- IsAuto boolScaling Enabled 
- Determines the auto-scaling mode for the catalog database.
- ContainerDatabase stringId 
- Identifier of the underlying container database.
- ContainerDatabase stringParent Id 
- Identifier of the underlying container database parent.
- EncryptionKey ShardedDetails Database Catalog Detail Encryption Key Details 
- Details of encryption key to be used to encrypt data for shards and catalog for sharded database. For system-defined sharding type, all shards have to use same encryptionKeyDetails. For system-defined sharding, if encryptionKeyDetails are not specified for catalog, then Oracle managed key will be used for catalog. For user-defined sharding type, if encryptionKeyDetails are not provided for any shard or catalog, then Oracle managed key will be used for such shard or catalog. For system-defined or user-defined sharding type, if the shard or catalog has a peer in region other than primary shard or catalog region, then make sure to provide virtual vault for such shard or catalog, which is also replicated to peer region (the region where peer or standby shard or catalog exists).
- Metadata map[string]string
- Additional metadata related to shard's underlying supporting resource.
- Name string
- Name of the shard.
- PeerCloud stringAutonomous Vm Cluster Id 
- The OCID of the peer cloud Autonomous Exadata VM Cluster.
- string
- Name of the shard-group to which the shard belongs.
- Status string
- Status of shard or catalog or gsm for the sharded database.
- SupportingResource stringId 
- Identifier of the underlying supporting resource.
- TimeCreated string
- The time the the Sharded Database was created. An RFC3339 formatted datetime string
- TimeSsl stringCertificate Expires 
- The time the ssl certificate associated with shard expires. An RFC3339 formatted datetime string
- TimeUpdated string
- The time the Sharded Database was last updated. An RFC3339 formatted datetime string
- adminPassword String
- Admin password for the catalog database.
- cloudAutonomous StringVm Cluster Id 
- The OCID of the cloud Autonomous Exadata VM Cluster.
- computeCount Double
- The compute count for the catalog database. It has to be in multiple of 2.
- dataStorage DoubleSize In Gbs 
- The data disk group size to be allocated in GBs for the catalog database.
- isAuto BooleanScaling Enabled 
- Determines the auto-scaling mode for the catalog database.
- containerDatabase StringId 
- Identifier of the underlying container database.
- containerDatabase StringParent Id 
- Identifier of the underlying container database parent.
- encryptionKey ShardedDetails Database Catalog Detail Encryption Key Details 
- Details of encryption key to be used to encrypt data for shards and catalog for sharded database. For system-defined sharding type, all shards have to use same encryptionKeyDetails. For system-defined sharding, if encryptionKeyDetails are not specified for catalog, then Oracle managed key will be used for catalog. For user-defined sharding type, if encryptionKeyDetails are not provided for any shard or catalog, then Oracle managed key will be used for such shard or catalog. For system-defined or user-defined sharding type, if the shard or catalog has a peer in region other than primary shard or catalog region, then make sure to provide virtual vault for such shard or catalog, which is also replicated to peer region (the region where peer or standby shard or catalog exists).
- metadata Map<String,String>
- Additional metadata related to shard's underlying supporting resource.
- name String
- Name of the shard.
- peerCloud StringAutonomous Vm Cluster Id 
- The OCID of the peer cloud Autonomous Exadata VM Cluster.
- String
- Name of the shard-group to which the shard belongs.
- status String
- Status of shard or catalog or gsm for the sharded database.
- supportingResource StringId 
- Identifier of the underlying supporting resource.
- timeCreated String
- The time the the Sharded Database was created. An RFC3339 formatted datetime string
- timeSsl StringCertificate Expires 
- The time the ssl certificate associated with shard expires. An RFC3339 formatted datetime string
- timeUpdated String
- The time the Sharded Database was last updated. An RFC3339 formatted datetime string
- adminPassword string
- Admin password for the catalog database.
- cloudAutonomous stringVm Cluster Id 
- The OCID of the cloud Autonomous Exadata VM Cluster.
- computeCount number
- The compute count for the catalog database. It has to be in multiple of 2.
- dataStorage numberSize In Gbs 
- The data disk group size to be allocated in GBs for the catalog database.
- isAuto booleanScaling Enabled 
- Determines the auto-scaling mode for the catalog database.
- containerDatabase stringId 
- Identifier of the underlying container database.
- containerDatabase stringParent Id 
- Identifier of the underlying container database parent.
- encryptionKey ShardedDetails Database Catalog Detail Encryption Key Details 
- Details of encryption key to be used to encrypt data for shards and catalog for sharded database. For system-defined sharding type, all shards have to use same encryptionKeyDetails. For system-defined sharding, if encryptionKeyDetails are not specified for catalog, then Oracle managed key will be used for catalog. For user-defined sharding type, if encryptionKeyDetails are not provided for any shard or catalog, then Oracle managed key will be used for such shard or catalog. For system-defined or user-defined sharding type, if the shard or catalog has a peer in region other than primary shard or catalog region, then make sure to provide virtual vault for such shard or catalog, which is also replicated to peer region (the region where peer or standby shard or catalog exists).
- metadata {[key: string]: string}
- Additional metadata related to shard's underlying supporting resource.
- name string
- Name of the shard.
- peerCloud stringAutonomous Vm Cluster Id 
- The OCID of the peer cloud Autonomous Exadata VM Cluster.
- string
- Name of the shard-group to which the shard belongs.
- status string
- Status of shard or catalog or gsm for the sharded database.
- supportingResource stringId 
- Identifier of the underlying supporting resource.
- timeCreated string
- The time the the Sharded Database was created. An RFC3339 formatted datetime string
- timeSsl stringCertificate Expires 
- The time the ssl certificate associated with shard expires. An RFC3339 formatted datetime string
- timeUpdated string
- The time the Sharded Database was last updated. An RFC3339 formatted datetime string
- admin_password str
- Admin password for the catalog database.
- cloud_autonomous_ strvm_ cluster_ id 
- The OCID of the cloud Autonomous Exadata VM Cluster.
- compute_count float
- The compute count for the catalog database. It has to be in multiple of 2.
- data_storage_ floatsize_ in_ gbs 
- The data disk group size to be allocated in GBs for the catalog database.
- is_auto_ boolscaling_ enabled 
- Determines the auto-scaling mode for the catalog database.
- container_database_ strid 
- Identifier of the underlying container database.
- container_database_ strparent_ id 
- Identifier of the underlying container database parent.
- encryption_key_ Shardeddetails Database Catalog Detail Encryption Key Details 
- Details of encryption key to be used to encrypt data for shards and catalog for sharded database. For system-defined sharding type, all shards have to use same encryptionKeyDetails. For system-defined sharding, if encryptionKeyDetails are not specified for catalog, then Oracle managed key will be used for catalog. For user-defined sharding type, if encryptionKeyDetails are not provided for any shard or catalog, then Oracle managed key will be used for such shard or catalog. For system-defined or user-defined sharding type, if the shard or catalog has a peer in region other than primary shard or catalog region, then make sure to provide virtual vault for such shard or catalog, which is also replicated to peer region (the region where peer or standby shard or catalog exists).
- metadata Mapping[str, str]
- Additional metadata related to shard's underlying supporting resource.
- name str
- Name of the shard.
- peer_cloud_ strautonomous_ vm_ cluster_ id 
- The OCID of the peer cloud Autonomous Exadata VM Cluster.
- str
- Name of the shard-group to which the shard belongs.
- status str
- Status of shard or catalog or gsm for the sharded database.
- supporting_resource_ strid 
- Identifier of the underlying supporting resource.
- time_created str
- The time the the Sharded Database was created. An RFC3339 formatted datetime string
- time_ssl_ strcertificate_ expires 
- The time the ssl certificate associated with shard expires. An RFC3339 formatted datetime string
- time_updated str
- The time the Sharded Database was last updated. An RFC3339 formatted datetime string
- adminPassword String
- Admin password for the catalog database.
- cloudAutonomous StringVm Cluster Id 
- The OCID of the cloud Autonomous Exadata VM Cluster.
- computeCount Number
- The compute count for the catalog database. It has to be in multiple of 2.
- dataStorage NumberSize In Gbs 
- The data disk group size to be allocated in GBs for the catalog database.
- isAuto BooleanScaling Enabled 
- Determines the auto-scaling mode for the catalog database.
- containerDatabase StringId 
- Identifier of the underlying container database.
- containerDatabase StringParent Id 
- Identifier of the underlying container database parent.
- encryptionKey Property MapDetails 
- Details of encryption key to be used to encrypt data for shards and catalog for sharded database. For system-defined sharding type, all shards have to use same encryptionKeyDetails. For system-defined sharding, if encryptionKeyDetails are not specified for catalog, then Oracle managed key will be used for catalog. For user-defined sharding type, if encryptionKeyDetails are not provided for any shard or catalog, then Oracle managed key will be used for such shard or catalog. For system-defined or user-defined sharding type, if the shard or catalog has a peer in region other than primary shard or catalog region, then make sure to provide virtual vault for such shard or catalog, which is also replicated to peer region (the region where peer or standby shard or catalog exists).
- metadata Map<String>
- Additional metadata related to shard's underlying supporting resource.
- name String
- Name of the shard.
- peerCloud StringAutonomous Vm Cluster Id 
- The OCID of the peer cloud Autonomous Exadata VM Cluster.
- String
- Name of the shard-group to which the shard belongs.
- status String
- Status of shard or catalog or gsm for the sharded database.
- supportingResource StringId 
- Identifier of the underlying supporting resource.
- timeCreated String
- The time the the Sharded Database was created. An RFC3339 formatted datetime string
- timeSsl StringCertificate Expires 
- 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              
- KmsKey stringId 
- The OCID of the KMS key in vault identified by vaultId in customer tenancy that is used as the master encryption key.
- VaultId string
- The OCID of the vault in customer tenancy where KMS key is present. For shard or catalog with cross-region data guard enabled, user needs to make sure to provide virtual private vault only, which is also replicated in the region of standby shard.
- KmsKey stringVersion Id 
- The OCID of the KMS key version for key identified by kmsKeyId that is used in data encryption (TDE) operations.
- KmsKey stringId 
- The OCID of the KMS key in vault identified by vaultId in customer tenancy that is used as the master encryption key.
- VaultId string
- The OCID of the vault in customer tenancy where KMS key is present. For shard or catalog with cross-region data guard enabled, user needs to make sure to provide virtual private vault only, which is also replicated in the region of standby shard.
- KmsKey stringVersion Id 
- The OCID of the KMS key version for key identified by kmsKeyId that is used in data encryption (TDE) operations.
- kmsKey StringId 
- The OCID of the KMS key in vault identified by vaultId in customer tenancy that is used as the master encryption key.
- vaultId String
- The OCID of the vault in customer tenancy where KMS key is present. For shard or catalog with cross-region data guard enabled, user needs to make sure to provide virtual private vault only, which is also replicated in the region of standby shard.
- kmsKey StringVersion Id 
- The OCID of the KMS key version for key identified by kmsKeyId that is used in data encryption (TDE) operations.
- kmsKey stringId 
- The OCID of the KMS key in vault identified by vaultId in customer tenancy that is used as the master encryption key.
- vaultId string
- The OCID of the vault in customer tenancy where KMS key is present. For shard or catalog with cross-region data guard enabled, user needs to make sure to provide virtual private vault only, which is also replicated in the region of standby shard.
- kmsKey stringVersion Id 
- The OCID of the KMS key version for key identified by kmsKeyId that is used in data encryption (TDE) operations.
- kms_key_ strid 
- The OCID of the KMS key in vault identified by vaultId in customer tenancy that is used as the master encryption key.
- vault_id str
- The OCID of the vault in customer tenancy where KMS key is present. For shard or catalog with cross-region data guard enabled, user needs to make sure to provide virtual private vault only, which is also replicated in the region of standby shard.
- kms_key_ strversion_ id 
- The OCID of the KMS key version for key identified by kmsKeyId that is used in data encryption (TDE) operations.
- kmsKey StringId 
- The OCID of the KMS key in vault identified by vaultId in customer tenancy that is used as the master encryption key.
- vaultId String
- The OCID of the vault in customer tenancy where KMS key is present. For shard or catalog with cross-region data guard enabled, user needs to make sure to provide virtual private vault only, which is also replicated in the region of standby shard.
- kmsKey StringVersion Id 
- The OCID of the KMS key version for key identified by kmsKeyId that is used in data encryption (TDE) operations.
ShardedDatabaseConnectionString, ShardedDatabaseConnectionStringArgs        
- AllConnection Dictionary<string, string>Strings 
- Collection of connection strings.
- AllConnection map[string]stringStrings 
- Collection of connection strings.
- allConnection Map<String,String>Strings 
- Collection of connection strings.
- allConnection {[key: string]: string}Strings 
- Collection of connection strings.
- all_connection_ Mapping[str, str]strings 
- Collection of connection strings.
- allConnection Map<String>Strings 
- Collection of connection strings.
ShardedDatabaseGsm, ShardedDatabaseGsmArgs      
- ComputeCount double
- The compute amount available to the underlying autonomous database associated with shard.
- DataStorage doubleSize In Gbs 
- The data disk group size to be allocated in GBs.
- Metadata Dictionary<string, string>
- Additional metadata related to shard's underlying supporting resource.
- Name string
- Name of the shard.
- Status string
- Status of shard or catalog or gsm for the sharded database.
- SupportingResource stringId 
- Identifier of the underlying supporting resource.
- TimeCreated string
- The time the the Sharded Database was created. An RFC3339 formatted datetime string
- TimeSsl stringCertificate Expires 
- 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.
- DataStorage float64Size In Gbs 
- The data disk group size to be allocated in GBs.
- Metadata map[string]string
- Additional metadata related to shard's underlying supporting resource.
- Name string
- Name of the shard.
- Status string
- Status of shard or catalog or gsm for the sharded database.
- SupportingResource stringId 
- Identifier of the underlying supporting resource.
- TimeCreated string
- The time the the Sharded Database was created. An RFC3339 formatted datetime string
- TimeSsl stringCertificate Expires 
- 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.
- dataStorage DoubleSize In Gbs 
- The data disk group size to be allocated in GBs.
- metadata Map<String,String>
- Additional metadata related to shard's underlying supporting resource.
- name String
- Name of the shard.
- status String
- Status of shard or catalog or gsm for the sharded database.
- supportingResource StringId 
- Identifier of the underlying supporting resource.
- timeCreated String
- The time the the Sharded Database was created. An RFC3339 formatted datetime string
- timeSsl StringCertificate Expires 
- 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.
- dataStorage numberSize In Gbs 
- The data disk group size to be allocated in GBs.
- metadata {[key: string]: string}
- Additional metadata related to shard's underlying supporting resource.
- name string
- Name of the shard.
- status string
- Status of shard or catalog or gsm for the sharded database.
- supportingResource stringId 
- Identifier of the underlying supporting resource.
- timeCreated string
- The time the the Sharded Database was created. An RFC3339 formatted datetime string
- timeSsl stringCertificate Expires 
- 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_ floatsize_ in_ gbs 
- The data disk group size to be allocated in GBs.
- metadata Mapping[str, str]
- Additional metadata related to shard's underlying supporting resource.
- name str
- Name of the shard.
- status str
- Status of shard or catalog or gsm for the sharded database.
- supporting_resource_ strid 
- Identifier of the underlying supporting resource.
- time_created str
- The time the the Sharded Database was created. An RFC3339 formatted datetime string
- time_ssl_ strcertificate_ expires 
- The time the ssl certificate associated with shard expires. An RFC3339 formatted datetime string
- time_updated str
- The time the Sharded Database was last updated. An RFC3339 formatted datetime string
- computeCount Number
- The compute amount available to the underlying autonomous database associated with shard.
- dataStorage NumberSize In Gbs 
- The data disk group size to be allocated in GBs.
- metadata Map<String>
- Additional metadata related to shard's underlying supporting resource.
- name String
- Name of the shard.
- status String
- Status of shard or catalog or gsm for the sharded database.
- supportingResource StringId 
- Identifier of the underlying supporting resource.
- timeCreated String
- The time the the Sharded Database was created. An RFC3339 formatted datetime string
- timeSsl StringCertificate Expires 
- 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        
ShardedDatabaseShardDetail, ShardedDatabaseShardDetailArgs        
- AdminPassword string
- Admin password for shard database.
- CloudAutonomous stringVm Cluster Id 
- The OCID of the cloud Autonomous Exadata VM Cluster.
- ComputeCount double
- The compute count for the shard database. It has to be in multiples of 2.
- DataStorage doubleSize In Gbs 
- The data disk group size to be allocated in GBs for the shard database.
- IsAuto boolScaling Enabled 
- Determines the auto-scaling mode for the shard database.
- ContainerDatabase stringId 
- Identifier of the underlying container database.
- ContainerDatabase stringParent Id 
- Identifier of the underlying container database parent.
- EncryptionKey ShardedDetails Database Shard Detail Encryption Key Details 
- Details of encryption key to be used to encrypt data for shards and catalog for sharded database. For system-defined sharding type, all shards have to use same encryptionKeyDetails. For system-defined sharding, if encryptionKeyDetails are not specified for catalog, then Oracle managed key will be used for catalog. For user-defined sharding type, if encryptionKeyDetails are not provided for any shard or catalog, then Oracle managed key will be used for such shard or catalog. For system-defined or user-defined sharding type, if the shard or catalog has a peer in region other than primary shard or catalog region, then make sure to provide virtual vault for such shard or catalog, which is also replicated to peer region (the region where peer or standby shard or catalog exists).
- Metadata Dictionary<string, string>
- Additional metadata related to shard's underlying supporting resource.
- Name string
- Name of the shard.
- PeerCloud stringAutonomous Vm Cluster Id 
- The OCID of the peer cloud Autonomous Exadata VM Cluster.
- string
- Name of the shard-group to which the shard belongs.
- string
- The shard space name for the shard database. Shard space for existing shard cannot be changed, once shard is created. Shard space name shall be used while creation of new shards. For User defined sharding, every shard must have a unique shard space name. For system defined sharding, shard space name is not required.
- Status string
- Status of shard or catalog or gsm for the sharded database.
- SupportingResource stringId 
- Identifier of the underlying supporting resource.
- TimeCreated string
- The time the the Sharded Database was created. An RFC3339 formatted datetime string
- TimeSsl stringCertificate Expires 
- The time the ssl certificate associated with shard expires. An RFC3339 formatted datetime string
- TimeUpdated string
- The time the Sharded Database was last updated. An RFC3339 formatted datetime string
- AdminPassword string
- Admin password for shard database.
- CloudAutonomous stringVm Cluster Id 
- The OCID of the cloud Autonomous Exadata VM Cluster.
- ComputeCount float64
- The compute count for the shard database. It has to be in multiples of 2.
- DataStorage float64Size In Gbs 
- The data disk group size to be allocated in GBs for the shard database.
- IsAuto boolScaling Enabled 
- Determines the auto-scaling mode for the shard database.
- ContainerDatabase stringId 
- Identifier of the underlying container database.
- ContainerDatabase stringParent Id 
- Identifier of the underlying container database parent.
- EncryptionKey ShardedDetails Database Shard Detail Encryption Key Details 
- Details of encryption key to be used to encrypt data for shards and catalog for sharded database. For system-defined sharding type, all shards have to use same encryptionKeyDetails. For system-defined sharding, if encryptionKeyDetails are not specified for catalog, then Oracle managed key will be used for catalog. For user-defined sharding type, if encryptionKeyDetails are not provided for any shard or catalog, then Oracle managed key will be used for such shard or catalog. For system-defined or user-defined sharding type, if the shard or catalog has a peer in region other than primary shard or catalog region, then make sure to provide virtual vault for such shard or catalog, which is also replicated to peer region (the region where peer or standby shard or catalog exists).
- Metadata map[string]string
- Additional metadata related to shard's underlying supporting resource.
- Name string
- Name of the shard.
- PeerCloud stringAutonomous Vm Cluster Id 
- The OCID of the peer cloud Autonomous Exadata VM Cluster.
- string
- Name of the shard-group to which the shard belongs.
- string
- The shard space name for the shard database. Shard space for existing shard cannot be changed, once shard is created. Shard space name shall be used while creation of new shards. For User defined sharding, every shard must have a unique shard space name. For system defined sharding, shard space name is not required.
- Status string
- Status of shard or catalog or gsm for the sharded database.
- SupportingResource stringId 
- Identifier of the underlying supporting resource.
- TimeCreated string
- The time the the Sharded Database was created. An RFC3339 formatted datetime string
- TimeSsl stringCertificate Expires 
- The time the ssl certificate associated with shard expires. An RFC3339 formatted datetime string
- TimeUpdated string
- The time the Sharded Database was last updated. An RFC3339 formatted datetime string
- adminPassword String
- Admin password for shard database.
- cloudAutonomous StringVm Cluster Id 
- The OCID of the cloud Autonomous Exadata VM Cluster.
- computeCount Double
- The compute count for the shard database. It has to be in multiples of 2.
- dataStorage DoubleSize In Gbs 
- The data disk group size to be allocated in GBs for the shard database.
- isAuto BooleanScaling Enabled 
- Determines the auto-scaling mode for the shard database.
- containerDatabase StringId 
- Identifier of the underlying container database.
- containerDatabase StringParent Id 
- Identifier of the underlying container database parent.
- encryptionKey ShardedDetails Database Shard Detail Encryption Key Details 
- Details of encryption key to be used to encrypt data for shards and catalog for sharded database. For system-defined sharding type, all shards have to use same encryptionKeyDetails. For system-defined sharding, if encryptionKeyDetails are not specified for catalog, then Oracle managed key will be used for catalog. For user-defined sharding type, if encryptionKeyDetails are not provided for any shard or catalog, then Oracle managed key will be used for such shard or catalog. For system-defined or user-defined sharding type, if the shard or catalog has a peer in region other than primary shard or catalog region, then make sure to provide virtual vault for such shard or catalog, which is also replicated to peer region (the region where peer or standby shard or catalog exists).
- metadata Map<String,String>
- Additional metadata related to shard's underlying supporting resource.
- name String
- Name of the shard.
- peerCloud StringAutonomous Vm Cluster Id 
- The OCID of the peer cloud Autonomous Exadata VM Cluster.
- String
- Name of the shard-group to which the shard belongs.
- String
- The shard space name for the shard database. Shard space for existing shard cannot be changed, once shard is created. Shard space name shall be used while creation of new shards. For User defined sharding, every shard must have a unique shard space name. For system defined sharding, shard space name is not required.
- status String
- Status of shard or catalog or gsm for the sharded database.
- supportingResource StringId 
- Identifier of the underlying supporting resource.
- timeCreated String
- The time the the Sharded Database was created. An RFC3339 formatted datetime string
- timeSsl StringCertificate Expires 
- The time the ssl certificate associated with shard expires. An RFC3339 formatted datetime string
- timeUpdated String
- The time the Sharded Database was last updated. An RFC3339 formatted datetime string
- adminPassword string
- Admin password for shard database.
- cloudAutonomous stringVm Cluster Id 
- The OCID of the cloud Autonomous Exadata VM Cluster.
- computeCount number
- The compute count for the shard database. It has to be in multiples of 2.
- dataStorage numberSize In Gbs 
- The data disk group size to be allocated in GBs for the shard database.
- isAuto booleanScaling Enabled 
- Determines the auto-scaling mode for the shard database.
- containerDatabase stringId 
- Identifier of the underlying container database.
- containerDatabase stringParent Id 
- Identifier of the underlying container database parent.
- encryptionKey ShardedDetails Database Shard Detail Encryption Key Details 
- Details of encryption key to be used to encrypt data for shards and catalog for sharded database. For system-defined sharding type, all shards have to use same encryptionKeyDetails. For system-defined sharding, if encryptionKeyDetails are not specified for catalog, then Oracle managed key will be used for catalog. For user-defined sharding type, if encryptionKeyDetails are not provided for any shard or catalog, then Oracle managed key will be used for such shard or catalog. For system-defined or user-defined sharding type, if the shard or catalog has a peer in region other than primary shard or catalog region, then make sure to provide virtual vault for such shard or catalog, which is also replicated to peer region (the region where peer or standby shard or catalog exists).
- metadata {[key: string]: string}
- Additional metadata related to shard's underlying supporting resource.
- name string
- Name of the shard.
- peerCloud stringAutonomous Vm Cluster Id 
- The OCID of the peer cloud Autonomous Exadata VM Cluster.
- string
- Name of the shard-group to which the shard belongs.
- string
- The shard space name for the shard database. Shard space for existing shard cannot be changed, once shard is created. Shard space name shall be used while creation of new shards. For User defined sharding, every shard must have a unique shard space name. For system defined sharding, shard space name is not required.
- status string
- Status of shard or catalog or gsm for the sharded database.
- supportingResource stringId 
- Identifier of the underlying supporting resource.
- timeCreated string
- The time the the Sharded Database was created. An RFC3339 formatted datetime string
- timeSsl stringCertificate Expires 
- The time the ssl certificate associated with shard expires. An RFC3339 formatted datetime string
- timeUpdated string
- The time the Sharded Database was last updated. An RFC3339 formatted datetime string
- admin_password str
- Admin password for shard database.
- cloud_autonomous_ strvm_ cluster_ id 
- The OCID of the cloud Autonomous Exadata VM Cluster.
- compute_count float
- The compute count for the shard database. It has to be in multiples of 2.
- data_storage_ floatsize_ in_ gbs 
- The data disk group size to be allocated in GBs for the shard database.
- is_auto_ boolscaling_ enabled 
- Determines the auto-scaling mode for the shard database.
- container_database_ strid 
- Identifier of the underlying container database.
- container_database_ strparent_ id 
- Identifier of the underlying container database parent.
- encryption_key_ Shardeddetails Database Shard Detail Encryption Key Details 
- Details of encryption key to be used to encrypt data for shards and catalog for sharded database. For system-defined sharding type, all shards have to use same encryptionKeyDetails. For system-defined sharding, if encryptionKeyDetails are not specified for catalog, then Oracle managed key will be used for catalog. For user-defined sharding type, if encryptionKeyDetails are not provided for any shard or catalog, then Oracle managed key will be used for such shard or catalog. For system-defined or user-defined sharding type, if the shard or catalog has a peer in region other than primary shard or catalog region, then make sure to provide virtual vault for such shard or catalog, which is also replicated to peer region (the region where peer or standby shard or catalog exists).
- metadata Mapping[str, str]
- Additional metadata related to shard's underlying supporting resource.
- name str
- Name of the shard.
- peer_cloud_ strautonomous_ vm_ cluster_ id 
- The OCID of the peer cloud Autonomous Exadata VM Cluster.
- str
- Name of the shard-group to which the shard belongs.
- str
- The shard space name for the shard database. Shard space for existing shard cannot be changed, once shard is created. Shard space name shall be used while creation of new shards. For User defined sharding, every shard must have a unique shard space name. For system defined sharding, shard space name is not required.
- status str
- Status of shard or catalog or gsm for the sharded database.
- supporting_resource_ strid 
- Identifier of the underlying supporting resource.
- time_created str
- The time the the Sharded Database was created. An RFC3339 formatted datetime string
- time_ssl_ strcertificate_ expires 
- The time the ssl certificate associated with shard expires. An RFC3339 formatted datetime string
- time_updated str
- The time the Sharded Database was last updated. An RFC3339 formatted datetime string
- adminPassword String
- Admin password for shard database.
- cloudAutonomous StringVm Cluster Id 
- The OCID of the cloud Autonomous Exadata VM Cluster.
- computeCount Number
- The compute count for the shard database. It has to be in multiples of 2.
- dataStorage NumberSize In Gbs 
- The data disk group size to be allocated in GBs for the shard database.
- isAuto BooleanScaling Enabled 
- Determines the auto-scaling mode for the shard database.
- containerDatabase StringId 
- Identifier of the underlying container database.
- containerDatabase StringParent Id 
- Identifier of the underlying container database parent.
- encryptionKey Property MapDetails 
- Details of encryption key to be used to encrypt data for shards and catalog for sharded database. For system-defined sharding type, all shards have to use same encryptionKeyDetails. For system-defined sharding, if encryptionKeyDetails are not specified for catalog, then Oracle managed key will be used for catalog. For user-defined sharding type, if encryptionKeyDetails are not provided for any shard or catalog, then Oracle managed key will be used for such shard or catalog. For system-defined or user-defined sharding type, if the shard or catalog has a peer in region other than primary shard or catalog region, then make sure to provide virtual vault for such shard or catalog, which is also replicated to peer region (the region where peer or standby shard or catalog exists).
- metadata Map<String>
- Additional metadata related to shard's underlying supporting resource.
- name String
- Name of the shard.
- peerCloud StringAutonomous Vm Cluster Id 
- The OCID of the peer cloud Autonomous Exadata VM Cluster.
- String
- Name of the shard-group to which the shard belongs.
- String
- The shard space name for the shard database. Shard space for existing shard cannot be changed, once shard is created. Shard space name shall be used while creation of new shards. For User defined sharding, every shard must have a unique shard space name. For system defined sharding, shard space name is not required.
- status String
- Status of shard or catalog or gsm for the sharded database.
- supportingResource StringId 
- Identifier of the underlying supporting resource.
- timeCreated String
- The time the the Sharded Database was created. An RFC3339 formatted datetime string
- timeSsl StringCertificate Expires 
- 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              
- KmsKey stringId 
- The OCID of the KMS key in vault identified by vaultId in customer tenancy that is used as the master encryption key.
- VaultId string
- The OCID of the vault in customer tenancy where KMS key is present. For shard or catalog with cross-region data guard enabled, user needs to make sure to provide virtual private vault only, which is also replicated in the region of standby shard.
- KmsKey stringVersion Id 
- The OCID of the KMS key version for key identified by kmsKeyId that is used in data encryption (TDE) operations.
- KmsKey stringId 
- The OCID of the KMS key in vault identified by vaultId in customer tenancy that is used as the master encryption key.
- VaultId string
- The OCID of the vault in customer tenancy where KMS key is present. For shard or catalog with cross-region data guard enabled, user needs to make sure to provide virtual private vault only, which is also replicated in the region of standby shard.
- KmsKey stringVersion Id 
- The OCID of the KMS key version for key identified by kmsKeyId that is used in data encryption (TDE) operations.
- kmsKey StringId 
- The OCID of the KMS key in vault identified by vaultId in customer tenancy that is used as the master encryption key.
- vaultId String
- The OCID of the vault in customer tenancy where KMS key is present. For shard or catalog with cross-region data guard enabled, user needs to make sure to provide virtual private vault only, which is also replicated in the region of standby shard.
- kmsKey StringVersion Id 
- The OCID of the KMS key version for key identified by kmsKeyId that is used in data encryption (TDE) operations.
- kmsKey stringId 
- The OCID of the KMS key in vault identified by vaultId in customer tenancy that is used as the master encryption key.
- vaultId string
- The OCID of the vault in customer tenancy where KMS key is present. For shard or catalog with cross-region data guard enabled, user needs to make sure to provide virtual private vault only, which is also replicated in the region of standby shard.
- kmsKey stringVersion Id 
- The OCID of the KMS key version for key identified by kmsKeyId that is used in data encryption (TDE) operations.
- kms_key_ strid 
- The OCID of the KMS key in vault identified by vaultId in customer tenancy that is used as the master encryption key.
- vault_id str
- The OCID of the vault in customer tenancy where KMS key is present. For shard or catalog with cross-region data guard enabled, user needs to make sure to provide virtual private vault only, which is also replicated in the region of standby shard.
- kms_key_ strversion_ id 
- The OCID of the KMS key version for key identified by kmsKeyId that is used in data encryption (TDE) operations.
- kmsKey StringId 
- The OCID of the KMS key in vault identified by vaultId in customer tenancy that is used as the master encryption key.
- vaultId String
- The OCID of the vault in customer tenancy where KMS key is present. For shard or catalog with cross-region data guard enabled, user needs to make sure to provide virtual private vault only, which is also replicated in the region of standby shard.
- kmsKey StringVersion Id 
- The OCID of the KMS key version for key identified by kmsKeyId that is used in data encryption (TDE) operations.
Import
ShardedDatabases can be imported using the id, e.g.
$ pulumi import oci:GloballyDistributedDatabase/shardedDatabase:ShardedDatabase test_sharded_database "id"
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the ociTerraform Provider.