oci.Nosql.Table
Explore with Pulumi AI
This resource provides the Table resource in Oracle Cloud Infrastructure NoSQL Database service.
Create a new table.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testTable = new oci.nosql.Table("test_table", {
compartmentId: compartmentId,
ddlStatement: tableDdlStatement,
name: tableName,
definedTags: tableDefinedTags,
freeformTags: {
"bar-key": "value",
},
isAutoReclaimable: tableIsAutoReclaimable,
tableLimits: {
maxReadUnits: tableTableLimitsMaxReadUnits,
maxStorageInGbs: tableTableLimitsMaxStorageInGbs,
maxWriteUnits: tableTableLimitsMaxWriteUnits,
capacityMode: tableTableLimitsCapacityMode,
},
});
import pulumi
import pulumi_oci as oci
test_table = oci.nosql.Table("test_table",
compartment_id=compartment_id,
ddl_statement=table_ddl_statement,
name=table_name,
defined_tags=table_defined_tags,
freeform_tags={
"bar-key": "value",
},
is_auto_reclaimable=table_is_auto_reclaimable,
table_limits={
"max_read_units": table_table_limits_max_read_units,
"max_storage_in_gbs": table_table_limits_max_storage_in_gbs,
"max_write_units": table_table_limits_max_write_units,
"capacity_mode": table_table_limits_capacity_mode,
})
package main
import (
"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/Nosql"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := Nosql.NewTable(ctx, "test_table", &Nosql.TableArgs{
CompartmentId: pulumi.Any(compartmentId),
DdlStatement: pulumi.Any(tableDdlStatement),
Name: pulumi.Any(tableName),
DefinedTags: pulumi.Any(tableDefinedTags),
FreeformTags: pulumi.StringMap{
"bar-key": pulumi.String("value"),
},
IsAutoReclaimable: pulumi.Any(tableIsAutoReclaimable),
TableLimits: &nosql.TableTableLimitsArgs{
MaxReadUnits: pulumi.Any(tableTableLimitsMaxReadUnits),
MaxStorageInGbs: pulumi.Any(tableTableLimitsMaxStorageInGbs),
MaxWriteUnits: pulumi.Any(tableTableLimitsMaxWriteUnits),
CapacityMode: pulumi.Any(tableTableLimitsCapacityMode),
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;
return await Deployment.RunAsync(() =>
{
var testTable = new Oci.Nosql.Table("test_table", new()
{
CompartmentId = compartmentId,
DdlStatement = tableDdlStatement,
Name = tableName,
DefinedTags = tableDefinedTags,
FreeformTags =
{
{ "bar-key", "value" },
},
IsAutoReclaimable = tableIsAutoReclaimable,
TableLimits = new Oci.Nosql.Inputs.TableTableLimitsArgs
{
MaxReadUnits = tableTableLimitsMaxReadUnits,
MaxStorageInGbs = tableTableLimitsMaxStorageInGbs,
MaxWriteUnits = tableTableLimitsMaxWriteUnits,
CapacityMode = tableTableLimitsCapacityMode,
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Nosql.Table;
import com.pulumi.oci.Nosql.TableArgs;
import com.pulumi.oci.Nosql.inputs.TableTableLimitsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var testTable = new Table("testTable", TableArgs.builder()
.compartmentId(compartmentId)
.ddlStatement(tableDdlStatement)
.name(tableName)
.definedTags(tableDefinedTags)
.freeformTags(Map.of("bar-key", "value"))
.isAutoReclaimable(tableIsAutoReclaimable)
.tableLimits(TableTableLimitsArgs.builder()
.maxReadUnits(tableTableLimitsMaxReadUnits)
.maxStorageInGbs(tableTableLimitsMaxStorageInGbs)
.maxWriteUnits(tableTableLimitsMaxWriteUnits)
.capacityMode(tableTableLimitsCapacityMode)
.build())
.build());
}
}
resources:
testTable:
type: oci:Nosql:Table
name: test_table
properties:
compartmentId: ${compartmentId}
ddlStatement: ${tableDdlStatement}
name: ${tableName}
definedTags: ${tableDefinedTags}
freeformTags:
bar-key: value
isAutoReclaimable: ${tableIsAutoReclaimable}
tableLimits:
maxReadUnits: ${tableTableLimitsMaxReadUnits}
maxStorageInGbs: ${tableTableLimitsMaxStorageInGbs}
maxWriteUnits: ${tableTableLimitsMaxWriteUnits}
capacityMode: ${tableTableLimitsCapacityMode}
Create Table Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Table(name: string, args: TableArgs, opts?: CustomResourceOptions);
@overload
def Table(resource_name: str,
args: TableArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Table(resource_name: str,
opts: Optional[ResourceOptions] = None,
compartment_id: Optional[str] = None,
ddl_statement: Optional[str] = None,
defined_tags: Optional[Mapping[str, str]] = None,
freeform_tags: Optional[Mapping[str, str]] = None,
is_auto_reclaimable: Optional[bool] = None,
name: Optional[str] = None,
table_limits: Optional[_nosql.TableTableLimitsArgs] = None)
func NewTable(ctx *Context, name string, args TableArgs, opts ...ResourceOption) (*Table, error)
public Table(string name, TableArgs args, CustomResourceOptions? opts = null)
type: oci:Nosql:Table
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 TableArgs
- 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 TableArgs
- 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 TableArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args TableArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args TableArgs
- 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 tableResource = new Oci.Nosql.Table("tableResource", new()
{
CompartmentId = "string",
DdlStatement = "string",
DefinedTags =
{
{ "string", "string" },
},
FreeformTags =
{
{ "string", "string" },
},
IsAutoReclaimable = false,
Name = "string",
TableLimits = new Oci.Nosql.Inputs.TableTableLimitsArgs
{
MaxReadUnits = 0,
MaxStorageInGbs = 0,
MaxWriteUnits = 0,
CapacityMode = "string",
},
});
example, err := Nosql.NewTable(ctx, "tableResource", &Nosql.TableArgs{
CompartmentId: pulumi.String("string"),
DdlStatement: pulumi.String("string"),
DefinedTags: pulumi.StringMap{
"string": pulumi.String("string"),
},
FreeformTags: pulumi.StringMap{
"string": pulumi.String("string"),
},
IsAutoReclaimable: pulumi.Bool(false),
Name: pulumi.String("string"),
TableLimits: &nosql.TableTableLimitsArgs{
MaxReadUnits: pulumi.Int(0),
MaxStorageInGbs: pulumi.Int(0),
MaxWriteUnits: pulumi.Int(0),
CapacityMode: pulumi.String("string"),
},
})
var tableResource = new Table("tableResource", TableArgs.builder()
.compartmentId("string")
.ddlStatement("string")
.definedTags(Map.of("string", "string"))
.freeformTags(Map.of("string", "string"))
.isAutoReclaimable(false)
.name("string")
.tableLimits(TableTableLimitsArgs.builder()
.maxReadUnits(0)
.maxStorageInGbs(0)
.maxWriteUnits(0)
.capacityMode("string")
.build())
.build());
table_resource = oci.nosql.Table("tableResource",
compartment_id="string",
ddl_statement="string",
defined_tags={
"string": "string",
},
freeform_tags={
"string": "string",
},
is_auto_reclaimable=False,
name="string",
table_limits=oci.nosql.TableTableLimitsArgs(
max_read_units=0,
max_storage_in_gbs=0,
max_write_units=0,
capacity_mode="string",
))
const tableResource = new oci.nosql.Table("tableResource", {
compartmentId: "string",
ddlStatement: "string",
definedTags: {
string: "string",
},
freeformTags: {
string: "string",
},
isAutoReclaimable: false,
name: "string",
tableLimits: {
maxReadUnits: 0,
maxStorageInGbs: 0,
maxWriteUnits: 0,
capacityMode: "string",
},
});
type: oci:Nosql:Table
properties:
compartmentId: string
ddlStatement: string
definedTags:
string: string
freeformTags:
string: string
isAutoReclaimable: false
name: string
tableLimits:
capacityMode: string
maxReadUnits: 0
maxStorageInGbs: 0
maxWriteUnits: 0
Table Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The Table resource accepts the following input properties:
- Compartment
Id string - (Updatable) Compartment Identifier.
- Ddl
Statement string - (Updatable) Complete CREATE TABLE DDL statement. When update ddl_statement, it should be ALTER TABLE DDL statement.
- Dictionary<string, string>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace": {"bar-key": "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"}
- Is
Auto boolReclaimable - True if table can be reclaimed after an idle period.
- Name string
- Table name.
- Table
Limits TableTable Limits - (Updatable) Throughput and storage limits configuration of a table. It is required for top level table, must be null for child table as child table shares its top parent table's limits.
- Compartment
Id string - (Updatable) Compartment Identifier.
- Ddl
Statement string - (Updatable) Complete CREATE TABLE DDL statement. When update ddl_statement, it should be ALTER TABLE DDL statement.
- map[string]string
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace": {"bar-key": "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"}
- Is
Auto boolReclaimable - True if table can be reclaimed after an idle period.
- Name string
- Table name.
- Table
Limits TableTable Limits Args - (Updatable) Throughput and storage limits configuration of a table. It is required for top level table, must be null for child table as child table shares its top parent table's limits.
- compartment
Id String - (Updatable) Compartment Identifier.
- ddl
Statement String - (Updatable) Complete CREATE TABLE DDL statement. When update ddl_statement, it should be ALTER TABLE DDL statement.
- Map<String,String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace": {"bar-key": "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"}
- is
Auto BooleanReclaimable - True if table can be reclaimed after an idle period.
- name String
- Table name.
- table
Limits TableTable Limits - (Updatable) Throughput and storage limits configuration of a table. It is required for top level table, must be null for child table as child table shares its top parent table's limits.
- compartment
Id string - (Updatable) Compartment Identifier.
- ddl
Statement string - (Updatable) Complete CREATE TABLE DDL statement. When update ddl_statement, it should be ALTER TABLE DDL statement.
- {[key: string]: string}
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace": {"bar-key": "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"}
- is
Auto booleanReclaimable - True if table can be reclaimed after an idle period.
- name string
- Table name.
- table
Limits TableTable Limits - (Updatable) Throughput and storage limits configuration of a table. It is required for top level table, must be null for child table as child table shares its top parent table's limits.
- compartment_
id str - (Updatable) Compartment Identifier.
- ddl_
statement str - (Updatable) Complete CREATE TABLE DDL statement. When update ddl_statement, it should be ALTER TABLE DDL statement.
- Mapping[str, str]
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace": {"bar-key": "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"}
- is_
auto_ boolreclaimable - True if table can be reclaimed after an idle period.
- name str
- Table name.
- table_
limits nosql.Table Table Limits Args - (Updatable) Throughput and storage limits configuration of a table. It is required for top level table, must be null for child table as child table shares its top parent table's limits.
- compartment
Id String - (Updatable) Compartment Identifier.
- ddl
Statement String - (Updatable) Complete CREATE TABLE DDL statement. When update ddl_statement, it should be ALTER TABLE DDL statement.
- Map<String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace": {"bar-key": "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"}
- is
Auto BooleanReclaimable - True if table can be reclaimed after an idle period.
- name String
- Table name.
- table
Limits Property Map - (Updatable) Throughput and storage limits configuration of a table. It is required for top level table, must be null for child table as child table shares its top parent table's limits.
Outputs
All input properties are implicitly available as output properties. Additionally, the Table resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Is
Multi boolRegion - True if this table is currently a member of a replication set.
- Lifecycle
Details string - A message describing the current state in more detail.
- Local
Replica intInitialization In Percent - If this table is in a replication set, this value represents the progress of the initialization of the replica's data. A value of 100 indicates that initialization has completed.
- Replicas
List<Table
Replica> - An array of Replica listing this table's replicas, if any
- Schema
State string - The current state of this table's schema. Available states are MUTABLE - The schema can be changed. The table is not eligible for replication. FROZEN - The schema is immutable. The table is eligible for replication.
- Schemas
List<Table
Schema> - The table schema information as a JSON object.
- State string
- The state of a table.
- Dictionary<string, string>
- Read-only system tag. These predefined keys are scoped to namespaces. At present the only supported namespace is
"orcl-cloud"
; and the only key in that namespace is"free-tier-retained"
. Example:{"orcl-cloud"": {"free-tier-retained": "true"}}
- Time
Created string - The time the the table was created. An RFC3339 formatted datetime string.
- Time
Of stringExpiration - If lifecycleState is INACTIVE, indicates when this table will be automatically removed. An RFC3339 formatted datetime string.
- Time
Updated string - The time the the table's metadata was last updated. An RFC3339 formatted datetime string.
- Id string
- The provider-assigned unique ID for this managed resource.
- Is
Multi boolRegion - True if this table is currently a member of a replication set.
- Lifecycle
Details string - A message describing the current state in more detail.
- Local
Replica intInitialization In Percent - If this table is in a replication set, this value represents the progress of the initialization of the replica's data. A value of 100 indicates that initialization has completed.
- Replicas
[]Table
Replica Type - An array of Replica listing this table's replicas, if any
- Schema
State string - The current state of this table's schema. Available states are MUTABLE - The schema can be changed. The table is not eligible for replication. FROZEN - The schema is immutable. The table is eligible for replication.
- Schemas
[]Table
Schema - The table schema information as a JSON object.
- State string
- The state of a table.
- map[string]string
- Read-only system tag. These predefined keys are scoped to namespaces. At present the only supported namespace is
"orcl-cloud"
; and the only key in that namespace is"free-tier-retained"
. Example:{"orcl-cloud"": {"free-tier-retained": "true"}}
- Time
Created string - The time the the table was created. An RFC3339 formatted datetime string.
- Time
Of stringExpiration - If lifecycleState is INACTIVE, indicates when this table will be automatically removed. An RFC3339 formatted datetime string.
- Time
Updated string - The time the the table's metadata was last updated. An RFC3339 formatted datetime string.
- id String
- The provider-assigned unique ID for this managed resource.
- is
Multi BooleanRegion - True if this table is currently a member of a replication set.
- lifecycle
Details String - A message describing the current state in more detail.
- local
Replica IntegerInitialization In Percent - If this table is in a replication set, this value represents the progress of the initialization of the replica's data. A value of 100 indicates that initialization has completed.
- replicas
List<Table
Replica> - An array of Replica listing this table's replicas, if any
- schema
State String - The current state of this table's schema. Available states are MUTABLE - The schema can be changed. The table is not eligible for replication. FROZEN - The schema is immutable. The table is eligible for replication.
- schemas
List<Table
Schema> - The table schema information as a JSON object.
- state String
- The state of a table.
- Map<String,String>
- Read-only system tag. These predefined keys are scoped to namespaces. At present the only supported namespace is
"orcl-cloud"
; and the only key in that namespace is"free-tier-retained"
. Example:{"orcl-cloud"": {"free-tier-retained": "true"}}
- time
Created String - The time the the table was created. An RFC3339 formatted datetime string.
- time
Of StringExpiration - If lifecycleState is INACTIVE, indicates when this table will be automatically removed. An RFC3339 formatted datetime string.
- time
Updated String - The time the the table's metadata was last updated. An RFC3339 formatted datetime string.
- id string
- The provider-assigned unique ID for this managed resource.
- is
Multi booleanRegion - True if this table is currently a member of a replication set.
- lifecycle
Details string - A message describing the current state in more detail.
- local
Replica numberInitialization In Percent - If this table is in a replication set, this value represents the progress of the initialization of the replica's data. A value of 100 indicates that initialization has completed.
- replicas
Table
Replica[] - An array of Replica listing this table's replicas, if any
- schema
State string - The current state of this table's schema. Available states are MUTABLE - The schema can be changed. The table is not eligible for replication. FROZEN - The schema is immutable. The table is eligible for replication.
- schemas
Table
Schema[] - The table schema information as a JSON object.
- state string
- The state of a table.
- {[key: string]: string}
- Read-only system tag. These predefined keys are scoped to namespaces. At present the only supported namespace is
"orcl-cloud"
; and the only key in that namespace is"free-tier-retained"
. Example:{"orcl-cloud"": {"free-tier-retained": "true"}}
- time
Created string - The time the the table was created. An RFC3339 formatted datetime string.
- time
Of stringExpiration - If lifecycleState is INACTIVE, indicates when this table will be automatically removed. An RFC3339 formatted datetime string.
- time
Updated string - The time the the table's metadata was last updated. An RFC3339 formatted datetime string.
- id str
- The provider-assigned unique ID for this managed resource.
- is_
multi_ boolregion - True if this table is currently a member of a replication set.
- lifecycle_
details str - A message describing the current state in more detail.
- local_
replica_ intinitialization_ in_ percent - If this table is in a replication set, this value represents the progress of the initialization of the replica's data. A value of 100 indicates that initialization has completed.
- replicas
Sequence[nosql.
Table Replica] - An array of Replica listing this table's replicas, if any
- schema_
state str - The current state of this table's schema. Available states are MUTABLE - The schema can be changed. The table is not eligible for replication. FROZEN - The schema is immutable. The table is eligible for replication.
- schemas
Sequence[nosql.
Table Schema] - The table schema information as a JSON object.
- state str
- The state of a table.
- Mapping[str, str]
- Read-only system tag. These predefined keys are scoped to namespaces. At present the only supported namespace is
"orcl-cloud"
; and the only key in that namespace is"free-tier-retained"
. Example:{"orcl-cloud"": {"free-tier-retained": "true"}}
- time_
created str - The time the the table was created. An RFC3339 formatted datetime string.
- time_
of_ strexpiration - If lifecycleState is INACTIVE, indicates when this table will be automatically removed. An RFC3339 formatted datetime string.
- time_
updated str - The time the the table's metadata was last updated. An RFC3339 formatted datetime string.
- id String
- The provider-assigned unique ID for this managed resource.
- is
Multi BooleanRegion - True if this table is currently a member of a replication set.
- lifecycle
Details String - A message describing the current state in more detail.
- local
Replica NumberInitialization In Percent - If this table is in a replication set, this value represents the progress of the initialization of the replica's data. A value of 100 indicates that initialization has completed.
- replicas List<Property Map>
- An array of Replica listing this table's replicas, if any
- schema
State String - The current state of this table's schema. Available states are MUTABLE - The schema can be changed. The table is not eligible for replication. FROZEN - The schema is immutable. The table is eligible for replication.
- schemas List<Property Map>
- The table schema information as a JSON object.
- state String
- The state of a table.
- Map<String>
- Read-only system tag. These predefined keys are scoped to namespaces. At present the only supported namespace is
"orcl-cloud"
; and the only key in that namespace is"free-tier-retained"
. Example:{"orcl-cloud"": {"free-tier-retained": "true"}}
- time
Created String - The time the the table was created. An RFC3339 formatted datetime string.
- time
Of StringExpiration - If lifecycleState is INACTIVE, indicates when this table will be automatically removed. An RFC3339 formatted datetime string.
- time
Updated String - The time the the table's metadata was last updated. An RFC3339 formatted datetime string.
Look up Existing Table Resource
Get an existing Table 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?: TableState, opts?: CustomResourceOptions): Table
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
compartment_id: Optional[str] = None,
ddl_statement: Optional[str] = None,
defined_tags: Optional[Mapping[str, str]] = None,
freeform_tags: Optional[Mapping[str, str]] = None,
is_auto_reclaimable: Optional[bool] = None,
is_multi_region: Optional[bool] = None,
lifecycle_details: Optional[str] = None,
local_replica_initialization_in_percent: Optional[int] = None,
name: Optional[str] = None,
replicas: Optional[Sequence[_nosql.TableReplicaArgs]] = None,
schema_state: Optional[str] = None,
schemas: Optional[Sequence[_nosql.TableSchemaArgs]] = None,
state: Optional[str] = None,
system_tags: Optional[Mapping[str, str]] = None,
table_limits: Optional[_nosql.TableTableLimitsArgs] = None,
time_created: Optional[str] = None,
time_of_expiration: Optional[str] = None,
time_updated: Optional[str] = None) -> Table
func GetTable(ctx *Context, name string, id IDInput, state *TableState, opts ...ResourceOption) (*Table, error)
public static Table Get(string name, Input<string> id, TableState? state, CustomResourceOptions? opts = null)
public static Table get(String name, Output<String> id, TableState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Compartment
Id string - (Updatable) Compartment Identifier.
- Ddl
Statement string - (Updatable) Complete CREATE TABLE DDL statement. When update ddl_statement, it should be ALTER TABLE DDL statement.
- Dictionary<string, string>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace": {"bar-key": "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"}
- Is
Auto boolReclaimable - True if table can be reclaimed after an idle period.
- Is
Multi boolRegion - True if this table is currently a member of a replication set.
- Lifecycle
Details string - A message describing the current state in more detail.
- Local
Replica intInitialization In Percent - If this table is in a replication set, this value represents the progress of the initialization of the replica's data. A value of 100 indicates that initialization has completed.
- Name string
- Table name.
- Replicas
List<Table
Replica> - An array of Replica listing this table's replicas, if any
- Schema
State string - The current state of this table's schema. Available states are MUTABLE - The schema can be changed. The table is not eligible for replication. FROZEN - The schema is immutable. The table is eligible for replication.
- Schemas
List<Table
Schema> - The table schema information as a JSON object.
- State string
- The state of a table.
- Dictionary<string, string>
- Read-only system tag. These predefined keys are scoped to namespaces. At present the only supported namespace is
"orcl-cloud"
; and the only key in that namespace is"free-tier-retained"
. Example:{"orcl-cloud"": {"free-tier-retained": "true"}}
- Table
Limits TableTable Limits - (Updatable) Throughput and storage limits configuration of a table. It is required for top level table, must be null for child table as child table shares its top parent table's limits.
- Time
Created string - The time the the table was created. An RFC3339 formatted datetime string.
- Time
Of stringExpiration - If lifecycleState is INACTIVE, indicates when this table will be automatically removed. An RFC3339 formatted datetime string.
- Time
Updated string - The time the the table's metadata was last updated. An RFC3339 formatted datetime string.
- Compartment
Id string - (Updatable) Compartment Identifier.
- Ddl
Statement string - (Updatable) Complete CREATE TABLE DDL statement. When update ddl_statement, it should be ALTER TABLE DDL statement.
- map[string]string
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace": {"bar-key": "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"}
- Is
Auto boolReclaimable - True if table can be reclaimed after an idle period.
- Is
Multi boolRegion - True if this table is currently a member of a replication set.
- Lifecycle
Details string - A message describing the current state in more detail.
- Local
Replica intInitialization In Percent - If this table is in a replication set, this value represents the progress of the initialization of the replica's data. A value of 100 indicates that initialization has completed.
- Name string
- Table name.
- Replicas
[]Table
Replica Type Args - An array of Replica listing this table's replicas, if any
- Schema
State string - The current state of this table's schema. Available states are MUTABLE - The schema can be changed. The table is not eligible for replication. FROZEN - The schema is immutable. The table is eligible for replication.
- Schemas
[]Table
Schema Args - The table schema information as a JSON object.
- State string
- The state of a table.
- map[string]string
- Read-only system tag. These predefined keys are scoped to namespaces. At present the only supported namespace is
"orcl-cloud"
; and the only key in that namespace is"free-tier-retained"
. Example:{"orcl-cloud"": {"free-tier-retained": "true"}}
- Table
Limits TableTable Limits Args - (Updatable) Throughput and storage limits configuration of a table. It is required for top level table, must be null for child table as child table shares its top parent table's limits.
- Time
Created string - The time the the table was created. An RFC3339 formatted datetime string.
- Time
Of stringExpiration - If lifecycleState is INACTIVE, indicates when this table will be automatically removed. An RFC3339 formatted datetime string.
- Time
Updated string - The time the the table's metadata was last updated. An RFC3339 formatted datetime string.
- compartment
Id String - (Updatable) Compartment Identifier.
- ddl
Statement String - (Updatable) Complete CREATE TABLE DDL statement. When update ddl_statement, it should be ALTER TABLE DDL statement.
- Map<String,String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace": {"bar-key": "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"}
- is
Auto BooleanReclaimable - True if table can be reclaimed after an idle period.
- is
Multi BooleanRegion - True if this table is currently a member of a replication set.
- lifecycle
Details String - A message describing the current state in more detail.
- local
Replica IntegerInitialization In Percent - If this table is in a replication set, this value represents the progress of the initialization of the replica's data. A value of 100 indicates that initialization has completed.
- name String
- Table name.
- replicas
List<Table
Replica> - An array of Replica listing this table's replicas, if any
- schema
State String - The current state of this table's schema. Available states are MUTABLE - The schema can be changed. The table is not eligible for replication. FROZEN - The schema is immutable. The table is eligible for replication.
- schemas
List<Table
Schema> - The table schema information as a JSON object.
- state String
- The state of a table.
- Map<String,String>
- Read-only system tag. These predefined keys are scoped to namespaces. At present the only supported namespace is
"orcl-cloud"
; and the only key in that namespace is"free-tier-retained"
. Example:{"orcl-cloud"": {"free-tier-retained": "true"}}
- table
Limits TableTable Limits - (Updatable) Throughput and storage limits configuration of a table. It is required for top level table, must be null for child table as child table shares its top parent table's limits.
- time
Created String - The time the the table was created. An RFC3339 formatted datetime string.
- time
Of StringExpiration - If lifecycleState is INACTIVE, indicates when this table will be automatically removed. An RFC3339 formatted datetime string.
- time
Updated String - The time the the table's metadata was last updated. An RFC3339 formatted datetime string.
- compartment
Id string - (Updatable) Compartment Identifier.
- ddl
Statement string - (Updatable) Complete CREATE TABLE DDL statement. When update ddl_statement, it should be ALTER TABLE DDL statement.
- {[key: string]: string}
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace": {"bar-key": "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"}
- is
Auto booleanReclaimable - True if table can be reclaimed after an idle period.
- is
Multi booleanRegion - True if this table is currently a member of a replication set.
- lifecycle
Details string - A message describing the current state in more detail.
- local
Replica numberInitialization In Percent - If this table is in a replication set, this value represents the progress of the initialization of the replica's data. A value of 100 indicates that initialization has completed.
- name string
- Table name.
- replicas
Table
Replica[] - An array of Replica listing this table's replicas, if any
- schema
State string - The current state of this table's schema. Available states are MUTABLE - The schema can be changed. The table is not eligible for replication. FROZEN - The schema is immutable. The table is eligible for replication.
- schemas
Table
Schema[] - The table schema information as a JSON object.
- state string
- The state of a table.
- {[key: string]: string}
- Read-only system tag. These predefined keys are scoped to namespaces. At present the only supported namespace is
"orcl-cloud"
; and the only key in that namespace is"free-tier-retained"
. Example:{"orcl-cloud"": {"free-tier-retained": "true"}}
- table
Limits TableTable Limits - (Updatable) Throughput and storage limits configuration of a table. It is required for top level table, must be null for child table as child table shares its top parent table's limits.
- time
Created string - The time the the table was created. An RFC3339 formatted datetime string.
- time
Of stringExpiration - If lifecycleState is INACTIVE, indicates when this table will be automatically removed. An RFC3339 formatted datetime string.
- time
Updated string - The time the the table's metadata was last updated. An RFC3339 formatted datetime string.
- compartment_
id str - (Updatable) Compartment Identifier.
- ddl_
statement str - (Updatable) Complete CREATE TABLE DDL statement. When update ddl_statement, it should be ALTER TABLE DDL statement.
- Mapping[str, str]
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace": {"bar-key": "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"}
- is_
auto_ boolreclaimable - True if table can be reclaimed after an idle period.
- is_
multi_ boolregion - True if this table is currently a member of a replication set.
- lifecycle_
details str - A message describing the current state in more detail.
- local_
replica_ intinitialization_ in_ percent - If this table is in a replication set, this value represents the progress of the initialization of the replica's data. A value of 100 indicates that initialization has completed.
- name str
- Table name.
- replicas
Sequence[nosql.
Table Replica Args] - An array of Replica listing this table's replicas, if any
- schema_
state str - The current state of this table's schema. Available states are MUTABLE - The schema can be changed. The table is not eligible for replication. FROZEN - The schema is immutable. The table is eligible for replication.
- schemas
Sequence[nosql.
Table Schema Args] - The table schema information as a JSON object.
- state str
- The state of a table.
- Mapping[str, str]
- Read-only system tag. These predefined keys are scoped to namespaces. At present the only supported namespace is
"orcl-cloud"
; and the only key in that namespace is"free-tier-retained"
. Example:{"orcl-cloud"": {"free-tier-retained": "true"}}
- table_
limits nosql.Table Table Limits Args - (Updatable) Throughput and storage limits configuration of a table. It is required for top level table, must be null for child table as child table shares its top parent table's limits.
- time_
created str - The time the the table was created. An RFC3339 formatted datetime string.
- time_
of_ strexpiration - If lifecycleState is INACTIVE, indicates when this table will be automatically removed. An RFC3339 formatted datetime string.
- time_
updated str - The time the the table's metadata was last updated. An RFC3339 formatted datetime string.
- compartment
Id String - (Updatable) Compartment Identifier.
- ddl
Statement String - (Updatable) Complete CREATE TABLE DDL statement. When update ddl_statement, it should be ALTER TABLE DDL statement.
- Map<String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace": {"bar-key": "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"}
- is
Auto BooleanReclaimable - True if table can be reclaimed after an idle period.
- is
Multi BooleanRegion - True if this table is currently a member of a replication set.
- lifecycle
Details String - A message describing the current state in more detail.
- local
Replica NumberInitialization In Percent - If this table is in a replication set, this value represents the progress of the initialization of the replica's data. A value of 100 indicates that initialization has completed.
- name String
- Table name.
- replicas List<Property Map>
- An array of Replica listing this table's replicas, if any
- schema
State String - The current state of this table's schema. Available states are MUTABLE - The schema can be changed. The table is not eligible for replication. FROZEN - The schema is immutable. The table is eligible for replication.
- schemas List<Property Map>
- The table schema information as a JSON object.
- state String
- The state of a table.
- Map<String>
- Read-only system tag. These predefined keys are scoped to namespaces. At present the only supported namespace is
"orcl-cloud"
; and the only key in that namespace is"free-tier-retained"
. Example:{"orcl-cloud"": {"free-tier-retained": "true"}}
- table
Limits Property Map - (Updatable) Throughput and storage limits configuration of a table. It is required for top level table, must be null for child table as child table shares its top parent table's limits.
- time
Created String - The time the the table was created. An RFC3339 formatted datetime string.
- time
Of StringExpiration - If lifecycleState is INACTIVE, indicates when this table will be automatically removed. An RFC3339 formatted datetime string.
- time
Updated String - The time the the table's metadata was last updated. An RFC3339 formatted datetime string.
Supporting Types
TableReplica, TableReplicaArgs
- Capacity
Mode string - The capacity mode of the table. If capacityMode = ON_DEMAND, maxReadUnits and maxWriteUnits are not used, and both will have the value of zero.
- Lifecycle
Details string - A message describing the current state in more detail.
- Max
Write intUnits - Maximum sustained write throughput limit for the table.
- Region string
- A customer-facing region identifier
- State string
- The state of a table.
- Table
Id string - The OCID of the replica table
- Capacity
Mode string - The capacity mode of the table. If capacityMode = ON_DEMAND, maxReadUnits and maxWriteUnits are not used, and both will have the value of zero.
- Lifecycle
Details string - A message describing the current state in more detail.
- Max
Write intUnits - Maximum sustained write throughput limit for the table.
- Region string
- A customer-facing region identifier
- State string
- The state of a table.
- Table
Id string - The OCID of the replica table
- capacity
Mode String - The capacity mode of the table. If capacityMode = ON_DEMAND, maxReadUnits and maxWriteUnits are not used, and both will have the value of zero.
- lifecycle
Details String - A message describing the current state in more detail.
- max
Write IntegerUnits - Maximum sustained write throughput limit for the table.
- region String
- A customer-facing region identifier
- state String
- The state of a table.
- table
Id String - The OCID of the replica table
- capacity
Mode string - The capacity mode of the table. If capacityMode = ON_DEMAND, maxReadUnits and maxWriteUnits are not used, and both will have the value of zero.
- lifecycle
Details string - A message describing the current state in more detail.
- max
Write numberUnits - Maximum sustained write throughput limit for the table.
- region string
- A customer-facing region identifier
- state string
- The state of a table.
- table
Id string - The OCID of the replica table
- capacity_
mode str - The capacity mode of the table. If capacityMode = ON_DEMAND, maxReadUnits and maxWriteUnits are not used, and both will have the value of zero.
- lifecycle_
details str - A message describing the current state in more detail.
- max_
write_ intunits - Maximum sustained write throughput limit for the table.
- region str
- A customer-facing region identifier
- state str
- The state of a table.
- table_
id str - The OCID of the replica table
- capacity
Mode String - The capacity mode of the table. If capacityMode = ON_DEMAND, maxReadUnits and maxWriteUnits are not used, and both will have the value of zero.
- lifecycle
Details String - A message describing the current state in more detail.
- max
Write NumberUnits - Maximum sustained write throughput limit for the table.
- region String
- A customer-facing region identifier
- state String
- The state of a table.
- table
Id String - The OCID of the replica table
TableSchema, TableSchemaArgs
- Columns
List<Table
Schema Column> - The columns of a table.
- Identities
List<Table
Schema Identity> - The identity properties of a table, if any.
- Primary
Keys List<string> - A list of column names that make up a key.
- List<string>
- A list of column names that make up a key.
- Ttl int
- The default Time-to-Live for the table, in days.
- Columns
[]Table
Schema Column - The columns of a table.
- Identities
[]Table
Schema Identity - The identity properties of a table, if any.
- Primary
Keys []string - A list of column names that make up a key.
- []string
- A list of column names that make up a key.
- Ttl int
- The default Time-to-Live for the table, in days.
- columns
List<Table
Schema Column> - The columns of a table.
- identities
List<Table
Schema Identity> - The identity properties of a table, if any.
- primary
Keys List<String> - A list of column names that make up a key.
- List<String>
- A list of column names that make up a key.
- ttl Integer
- The default Time-to-Live for the table, in days.
- columns
Table
Schema Column[] - The columns of a table.
- identities
Table
Schema Identity[] - The identity properties of a table, if any.
- primary
Keys string[] - A list of column names that make up a key.
- string[]
- A list of column names that make up a key.
- ttl number
- The default Time-to-Live for the table, in days.
- columns
Sequence[nosql.
Table Schema Column] - The columns of a table.
- identities
Sequence[nosql.
Table Schema Identity] - The identity properties of a table, if any.
- primary_
keys Sequence[str] - A list of column names that make up a key.
- Sequence[str]
- A list of column names that make up a key.
- ttl int
- The default Time-to-Live for the table, in days.
- columns List<Property Map>
- The columns of a table.
- identities List<Property Map>
- The identity properties of a table, if any.
- primary
Keys List<String> - A list of column names that make up a key.
- List<String>
- A list of column names that make up a key.
- ttl Number
- The default Time-to-Live for the table, in days.
TableSchemaColumn, TableSchemaColumnArgs
- Default
Value string - The column default value.
- Is
As boolUuid - True if the STRING column was declared AS UUID.
- Is
Generated bool - True if the STRING AS UUID column is also GENERATED BY DEFAULT.
- Is
Nullable bool - The column nullable flag.
- Name string
- Table name.
- Type string
- The column type.
- Default
Value string - The column default value.
- Is
As boolUuid - True if the STRING column was declared AS UUID.
- Is
Generated bool - True if the STRING AS UUID column is also GENERATED BY DEFAULT.
- Is
Nullable bool - The column nullable flag.
- Name string
- Table name.
- Type string
- The column type.
- default
Value String - The column default value.
- is
As BooleanUuid - True if the STRING column was declared AS UUID.
- is
Generated Boolean - True if the STRING AS UUID column is also GENERATED BY DEFAULT.
- is
Nullable Boolean - The column nullable flag.
- name String
- Table name.
- type String
- The column type.
- default
Value string - The column default value.
- is
As booleanUuid - True if the STRING column was declared AS UUID.
- is
Generated boolean - True if the STRING AS UUID column is also GENERATED BY DEFAULT.
- is
Nullable boolean - The column nullable flag.
- name string
- Table name.
- type string
- The column type.
- default_
value str - The column default value.
- is_
as_ booluuid - True if the STRING column was declared AS UUID.
- is_
generated bool - True if the STRING AS UUID column is also GENERATED BY DEFAULT.
- is_
nullable bool - The column nullable flag.
- name str
- Table name.
- type str
- The column type.
- default
Value String - The column default value.
- is
As BooleanUuid - True if the STRING column was declared AS UUID.
- is
Generated Boolean - True if the STRING AS UUID column is also GENERATED BY DEFAULT.
- is
Nullable Boolean - The column nullable flag.
- name String
- Table name.
- type String
- The column type.
TableSchemaIdentity, TableSchemaIdentityArgs
- Column
Name string - The name of the identity column.
- Is
Always bool - True if the identity value is GENERATED ALWAYS.
- Is
Null bool - True if the identity value is GENERATED BY DEFAULT ON NULL.
- Column
Name string - The name of the identity column.
- Is
Always bool - True if the identity value is GENERATED ALWAYS.
- Is
Null bool - True if the identity value is GENERATED BY DEFAULT ON NULL.
- column
Name String - The name of the identity column.
- is
Always Boolean - True if the identity value is GENERATED ALWAYS.
- is
Null Boolean - True if the identity value is GENERATED BY DEFAULT ON NULL.
- column
Name string - The name of the identity column.
- is
Always boolean - True if the identity value is GENERATED ALWAYS.
- is
Null boolean - True if the identity value is GENERATED BY DEFAULT ON NULL.
- column_
name str - The name of the identity column.
- is_
always bool - True if the identity value is GENERATED ALWAYS.
- is_
null bool - True if the identity value is GENERATED BY DEFAULT ON NULL.
- column
Name String - The name of the identity column.
- is
Always Boolean - True if the identity value is GENERATED ALWAYS.
- is
Null Boolean - True if the identity value is GENERATED BY DEFAULT ON NULL.
TableTableLimits, TableTableLimitsArgs
- Max
Read intUnits - (Updatable) Maximum sustained read throughput limit for the table.
- Max
Storage intIn Gbs - (Updatable) Maximum size of storage used by the table.
- Max
Write intUnits (Updatable) Maximum sustained write throughput limit for the table.
** 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
- Capacity
Mode string - (Updatable) The capacity mode of the table. If capacityMode = ON_DEMAND, maxReadUnits and maxWriteUnits are not used, and both will have the value of zero.
- Max
Read intUnits - (Updatable) Maximum sustained read throughput limit for the table.
- Max
Storage intIn Gbs - (Updatable) Maximum size of storage used by the table.
- Max
Write intUnits (Updatable) Maximum sustained write throughput limit for the table.
** 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
- Capacity
Mode string - (Updatable) The capacity mode of the table. If capacityMode = ON_DEMAND, maxReadUnits and maxWriteUnits are not used, and both will have the value of zero.
- max
Read IntegerUnits - (Updatable) Maximum sustained read throughput limit for the table.
- max
Storage IntegerIn Gbs - (Updatable) Maximum size of storage used by the table.
- max
Write IntegerUnits (Updatable) Maximum sustained write throughput limit for the table.
** 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
- capacity
Mode String - (Updatable) The capacity mode of the table. If capacityMode = ON_DEMAND, maxReadUnits and maxWriteUnits are not used, and both will have the value of zero.
- max
Read numberUnits - (Updatable) Maximum sustained read throughput limit for the table.
- max
Storage numberIn Gbs - (Updatable) Maximum size of storage used by the table.
- max
Write numberUnits (Updatable) Maximum sustained write throughput limit for the table.
** 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
- capacity
Mode string - (Updatable) The capacity mode of the table. If capacityMode = ON_DEMAND, maxReadUnits and maxWriteUnits are not used, and both will have the value of zero.
- max_
read_ intunits - (Updatable) Maximum sustained read throughput limit for the table.
- max_
storage_ intin_ gbs - (Updatable) Maximum size of storage used by the table.
- max_
write_ intunits (Updatable) Maximum sustained write throughput limit for the table.
** 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
- capacity_
mode str - (Updatable) The capacity mode of the table. If capacityMode = ON_DEMAND, maxReadUnits and maxWriteUnits are not used, and both will have the value of zero.
- max
Read NumberUnits - (Updatable) Maximum sustained read throughput limit for the table.
- max
Storage NumberIn Gbs - (Updatable) Maximum size of storage used by the table.
- max
Write NumberUnits (Updatable) Maximum sustained write throughput limit for the table.
** 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
- capacity
Mode String - (Updatable) The capacity mode of the table. If capacityMode = ON_DEMAND, maxReadUnits and maxWriteUnits are not used, and both will have the value of zero.
Import
Tables can be imported using the id
, e.g.
$ pulumi import oci:Nosql/table:Table test_table "id"
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
oci
Terraform Provider.