1. Packages
  2. AWS Native
  3. API Docs
  4. cassandra
  5. getTable

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.108.4 published on Tuesday, Jun 18, 2024 by Pulumi

aws-native.cassandra.getTable

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.108.4 published on Tuesday, Jun 18, 2024 by Pulumi

    Resource schema for AWS::Cassandra::Table

    Using getTable

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getTable(args: GetTableArgs, opts?: InvokeOptions): Promise<GetTableResult>
    function getTableOutput(args: GetTableOutputArgs, opts?: InvokeOptions): Output<GetTableResult>
    def get_table(keyspace_name: Optional[str] = None,
                  table_name: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetTableResult
    def get_table_output(keyspace_name: Optional[pulumi.Input[str]] = None,
                  table_name: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetTableResult]
    func LookupTable(ctx *Context, args *LookupTableArgs, opts ...InvokeOption) (*LookupTableResult, error)
    func LookupTableOutput(ctx *Context, args *LookupTableOutputArgs, opts ...InvokeOption) LookupTableResultOutput

    > Note: This function is named LookupTable in the Go SDK.

    public static class GetTable 
    {
        public static Task<GetTableResult> InvokeAsync(GetTableArgs args, InvokeOptions? opts = null)
        public static Output<GetTableResult> Invoke(GetTableInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetTableResult> getTable(GetTableArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: aws-native:cassandra:getTable
      arguments:
        # arguments dictionary

    The following arguments are supported:

    KeyspaceName string
    Name for Cassandra keyspace
    TableName string
    Name for Cassandra table
    KeyspaceName string
    Name for Cassandra keyspace
    TableName string
    Name for Cassandra table
    keyspaceName String
    Name for Cassandra keyspace
    tableName String
    Name for Cassandra table
    keyspaceName string
    Name for Cassandra keyspace
    tableName string
    Name for Cassandra table
    keyspace_name str
    Name for Cassandra keyspace
    table_name str
    Name for Cassandra table
    keyspaceName String
    Name for Cassandra keyspace
    tableName String
    Name for Cassandra table

    getTable Result

    The following output properties are available:

    BillingMode Pulumi.AwsNative.Cassandra.Outputs.TableBillingMode

    The billing mode for the table, which determines how you'll be charged for reads and writes:

    • On-demand mode (default) - You pay based on the actual reads and writes your application performs.
    • Provisioned mode - Lets you specify the number of reads and writes per second that you need for your application.

    If you don't specify a value for this property, then the table will use on-demand mode.

    DefaultTimeToLive int
    Default TTL (Time To Live) in seconds, where zero is disabled. If the value is greater than zero, TTL is enabled for the entire table and an expiration timestamp is added to each column.
    EncryptionSpecification Pulumi.AwsNative.Cassandra.Outputs.TableEncryptionSpecification

    The encryption at rest options for the table.

    • AWS owned key (default) - The key is owned by Amazon Keyspaces .
    • Customer managed key - The key is stored in your account and is created, owned, and managed by you.

    If you choose encryption with a customer managed key, you must specify a valid customer managed KMS key with permissions granted to Amazon Keyspaces.

    For more information, see Encryption at rest in Amazon Keyspaces in the Amazon Keyspaces Developer Guide .

    PointInTimeRecoveryEnabled bool
    Indicates whether point in time recovery is enabled (true) or disabled (false) on the table
    RegularColumns List<Pulumi.AwsNative.Cassandra.Outputs.TableColumn>
    Non-key columns of the table
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    An array of key-value pairs to apply to this resource
    BillingMode TableBillingMode

    The billing mode for the table, which determines how you'll be charged for reads and writes:

    • On-demand mode (default) - You pay based on the actual reads and writes your application performs.
    • Provisioned mode - Lets you specify the number of reads and writes per second that you need for your application.

    If you don't specify a value for this property, then the table will use on-demand mode.

    DefaultTimeToLive int
    Default TTL (Time To Live) in seconds, where zero is disabled. If the value is greater than zero, TTL is enabled for the entire table and an expiration timestamp is added to each column.
    EncryptionSpecification TableEncryptionSpecification

    The encryption at rest options for the table.

    • AWS owned key (default) - The key is owned by Amazon Keyspaces .
    • Customer managed key - The key is stored in your account and is created, owned, and managed by you.

    If you choose encryption with a customer managed key, you must specify a valid customer managed KMS key with permissions granted to Amazon Keyspaces.

    For more information, see Encryption at rest in Amazon Keyspaces in the Amazon Keyspaces Developer Guide .

    PointInTimeRecoveryEnabled bool
    Indicates whether point in time recovery is enabled (true) or disabled (false) on the table
    RegularColumns []TableColumn
    Non-key columns of the table
    Tags Tag
    An array of key-value pairs to apply to this resource
    billingMode TableBillingMode

    The billing mode for the table, which determines how you'll be charged for reads and writes:

    • On-demand mode (default) - You pay based on the actual reads and writes your application performs.
    • Provisioned mode - Lets you specify the number of reads and writes per second that you need for your application.

    If you don't specify a value for this property, then the table will use on-demand mode.

    defaultTimeToLive Integer
    Default TTL (Time To Live) in seconds, where zero is disabled. If the value is greater than zero, TTL is enabled for the entire table and an expiration timestamp is added to each column.
    encryptionSpecification TableEncryptionSpecification

    The encryption at rest options for the table.

    • AWS owned key (default) - The key is owned by Amazon Keyspaces .
    • Customer managed key - The key is stored in your account and is created, owned, and managed by you.

    If you choose encryption with a customer managed key, you must specify a valid customer managed KMS key with permissions granted to Amazon Keyspaces.

    For more information, see Encryption at rest in Amazon Keyspaces in the Amazon Keyspaces Developer Guide .

    pointInTimeRecoveryEnabled Boolean
    Indicates whether point in time recovery is enabled (true) or disabled (false) on the table
    regularColumns List<TableColumn>
    Non-key columns of the table
    tags List<Tag>
    An array of key-value pairs to apply to this resource
    billingMode TableBillingMode

    The billing mode for the table, which determines how you'll be charged for reads and writes:

    • On-demand mode (default) - You pay based on the actual reads and writes your application performs.
    • Provisioned mode - Lets you specify the number of reads and writes per second that you need for your application.

    If you don't specify a value for this property, then the table will use on-demand mode.

    defaultTimeToLive number
    Default TTL (Time To Live) in seconds, where zero is disabled. If the value is greater than zero, TTL is enabled for the entire table and an expiration timestamp is added to each column.
    encryptionSpecification TableEncryptionSpecification

    The encryption at rest options for the table.

    • AWS owned key (default) - The key is owned by Amazon Keyspaces .
    • Customer managed key - The key is stored in your account and is created, owned, and managed by you.

    If you choose encryption with a customer managed key, you must specify a valid customer managed KMS key with permissions granted to Amazon Keyspaces.

    For more information, see Encryption at rest in Amazon Keyspaces in the Amazon Keyspaces Developer Guide .

    pointInTimeRecoveryEnabled boolean
    Indicates whether point in time recovery is enabled (true) or disabled (false) on the table
    regularColumns TableColumn[]
    Non-key columns of the table
    tags Tag[]
    An array of key-value pairs to apply to this resource
    billing_mode TableBillingMode

    The billing mode for the table, which determines how you'll be charged for reads and writes:

    • On-demand mode (default) - You pay based on the actual reads and writes your application performs.
    • Provisioned mode - Lets you specify the number of reads and writes per second that you need for your application.

    If you don't specify a value for this property, then the table will use on-demand mode.

    default_time_to_live int
    Default TTL (Time To Live) in seconds, where zero is disabled. If the value is greater than zero, TTL is enabled for the entire table and an expiration timestamp is added to each column.
    encryption_specification TableEncryptionSpecification

    The encryption at rest options for the table.

    • AWS owned key (default) - The key is owned by Amazon Keyspaces .
    • Customer managed key - The key is stored in your account and is created, owned, and managed by you.

    If you choose encryption with a customer managed key, you must specify a valid customer managed KMS key with permissions granted to Amazon Keyspaces.

    For more information, see Encryption at rest in Amazon Keyspaces in the Amazon Keyspaces Developer Guide .

    point_in_time_recovery_enabled bool
    Indicates whether point in time recovery is enabled (true) or disabled (false) on the table
    regular_columns Sequence[TableColumn]
    Non-key columns of the table
    tags Sequence[root_Tag]
    An array of key-value pairs to apply to this resource
    billingMode Property Map

    The billing mode for the table, which determines how you'll be charged for reads and writes:

    • On-demand mode (default) - You pay based on the actual reads and writes your application performs.
    • Provisioned mode - Lets you specify the number of reads and writes per second that you need for your application.

    If you don't specify a value for this property, then the table will use on-demand mode.

    defaultTimeToLive Number
    Default TTL (Time To Live) in seconds, where zero is disabled. If the value is greater than zero, TTL is enabled for the entire table and an expiration timestamp is added to each column.
    encryptionSpecification Property Map

    The encryption at rest options for the table.

    • AWS owned key (default) - The key is owned by Amazon Keyspaces .
    • Customer managed key - The key is stored in your account and is created, owned, and managed by you.

    If you choose encryption with a customer managed key, you must specify a valid customer managed KMS key with permissions granted to Amazon Keyspaces.

    For more information, see Encryption at rest in Amazon Keyspaces in the Amazon Keyspaces Developer Guide .

    pointInTimeRecoveryEnabled Boolean
    Indicates whether point in time recovery is enabled (true) or disabled (false) on the table
    regularColumns List<Property Map>
    Non-key columns of the table
    tags List<Property Map>
    An array of key-value pairs to apply to this resource

    Supporting Types

    TableBillingMode

    Mode Pulumi.AwsNative.Cassandra.TableMode

    The billing mode for the table:

    • On-demand mode - ON_DEMAND
    • Provisioned mode - PROVISIONED

    If you choose PROVISIONED mode, then you also need to specify provisioned throughput (read and write capacity) for the table.

    Valid values: ON_DEMAND | PROVISIONED

    ProvisionedThroughput Pulumi.AwsNative.Cassandra.Inputs.TableProvisionedThroughput
    The provisioned read capacity and write capacity for the table. For more information, see Provisioned throughput capacity mode in the Amazon Keyspaces Developer Guide .
    Mode TableMode

    The billing mode for the table:

    • On-demand mode - ON_DEMAND
    • Provisioned mode - PROVISIONED

    If you choose PROVISIONED mode, then you also need to specify provisioned throughput (read and write capacity) for the table.

    Valid values: ON_DEMAND | PROVISIONED

    ProvisionedThroughput TableProvisionedThroughput
    The provisioned read capacity and write capacity for the table. For more information, see Provisioned throughput capacity mode in the Amazon Keyspaces Developer Guide .
    mode TableMode

    The billing mode for the table:

    • On-demand mode - ON_DEMAND
    • Provisioned mode - PROVISIONED

    If you choose PROVISIONED mode, then you also need to specify provisioned throughput (read and write capacity) for the table.

    Valid values: ON_DEMAND | PROVISIONED

    provisionedThroughput TableProvisionedThroughput
    The provisioned read capacity and write capacity for the table. For more information, see Provisioned throughput capacity mode in the Amazon Keyspaces Developer Guide .
    mode TableMode

    The billing mode for the table:

    • On-demand mode - ON_DEMAND
    • Provisioned mode - PROVISIONED

    If you choose PROVISIONED mode, then you also need to specify provisioned throughput (read and write capacity) for the table.

    Valid values: ON_DEMAND | PROVISIONED

    provisionedThroughput TableProvisionedThroughput
    The provisioned read capacity and write capacity for the table. For more information, see Provisioned throughput capacity mode in the Amazon Keyspaces Developer Guide .
    mode TableMode

    The billing mode for the table:

    • On-demand mode - ON_DEMAND
    • Provisioned mode - PROVISIONED

    If you choose PROVISIONED mode, then you also need to specify provisioned throughput (read and write capacity) for the table.

    Valid values: ON_DEMAND | PROVISIONED

    provisioned_throughput TableProvisionedThroughput
    The provisioned read capacity and write capacity for the table. For more information, see Provisioned throughput capacity mode in the Amazon Keyspaces Developer Guide .
    mode "PROVISIONED" | "ON_DEMAND"

    The billing mode for the table:

    • On-demand mode - ON_DEMAND
    • Provisioned mode - PROVISIONED

    If you choose PROVISIONED mode, then you also need to specify provisioned throughput (read and write capacity) for the table.

    Valid values: ON_DEMAND | PROVISIONED

    provisionedThroughput Property Map
    The provisioned read capacity and write capacity for the table. For more information, see Provisioned throughput capacity mode in the Amazon Keyspaces Developer Guide .

    TableColumn

    ColumnName string
    The name of the column. For more information, see Identifiers in the Amazon Keyspaces Developer Guide .
    ColumnType string
    The data type of the column. For more information, see Data types in the Amazon Keyspaces Developer Guide .
    ColumnName string
    The name of the column. For more information, see Identifiers in the Amazon Keyspaces Developer Guide .
    ColumnType string
    The data type of the column. For more information, see Data types in the Amazon Keyspaces Developer Guide .
    columnName String
    The name of the column. For more information, see Identifiers in the Amazon Keyspaces Developer Guide .
    columnType String
    The data type of the column. For more information, see Data types in the Amazon Keyspaces Developer Guide .
    columnName string
    The name of the column. For more information, see Identifiers in the Amazon Keyspaces Developer Guide .
    columnType string
    The data type of the column. For more information, see Data types in the Amazon Keyspaces Developer Guide .
    column_name str
    The name of the column. For more information, see Identifiers in the Amazon Keyspaces Developer Guide .
    column_type str
    The data type of the column. For more information, see Data types in the Amazon Keyspaces Developer Guide .
    columnName String
    The name of the column. For more information, see Identifiers in the Amazon Keyspaces Developer Guide .
    columnType String
    The data type of the column. For more information, see Data types in the Amazon Keyspaces Developer Guide .

    TableEncryptionSpecification

    EncryptionType Pulumi.AwsNative.Cassandra.TableEncryptionType

    The encryption at rest options for the table.

    • AWS owned key (default) - AWS_OWNED_KMS_KEY
    • Customer managed key - CUSTOMER_MANAGED_KMS_KEY

    If you choose CUSTOMER_MANAGED_KMS_KEY , a kms_key_identifier in the format of a key ARN is required.

    Valid values: CUSTOMER_MANAGED_KMS_KEY | AWS_OWNED_KMS_KEY .

    KmsKeyIdentifier string
    Requires a kms_key_identifier in the format of a key ARN.
    EncryptionType TableEncryptionType

    The encryption at rest options for the table.

    • AWS owned key (default) - AWS_OWNED_KMS_KEY
    • Customer managed key - CUSTOMER_MANAGED_KMS_KEY

    If you choose CUSTOMER_MANAGED_KMS_KEY , a kms_key_identifier in the format of a key ARN is required.

    Valid values: CUSTOMER_MANAGED_KMS_KEY | AWS_OWNED_KMS_KEY .

    KmsKeyIdentifier string
    Requires a kms_key_identifier in the format of a key ARN.
    encryptionType TableEncryptionType

    The encryption at rest options for the table.

    • AWS owned key (default) - AWS_OWNED_KMS_KEY
    • Customer managed key - CUSTOMER_MANAGED_KMS_KEY

    If you choose CUSTOMER_MANAGED_KMS_KEY , a kms_key_identifier in the format of a key ARN is required.

    Valid values: CUSTOMER_MANAGED_KMS_KEY | AWS_OWNED_KMS_KEY .

    kmsKeyIdentifier String
    Requires a kms_key_identifier in the format of a key ARN.
    encryptionType TableEncryptionType

    The encryption at rest options for the table.

    • AWS owned key (default) - AWS_OWNED_KMS_KEY
    • Customer managed key - CUSTOMER_MANAGED_KMS_KEY

    If you choose CUSTOMER_MANAGED_KMS_KEY , a kms_key_identifier in the format of a key ARN is required.

    Valid values: CUSTOMER_MANAGED_KMS_KEY | AWS_OWNED_KMS_KEY .

    kmsKeyIdentifier string
    Requires a kms_key_identifier in the format of a key ARN.
    encryption_type TableEncryptionType

    The encryption at rest options for the table.

    • AWS owned key (default) - AWS_OWNED_KMS_KEY
    • Customer managed key - CUSTOMER_MANAGED_KMS_KEY

    If you choose CUSTOMER_MANAGED_KMS_KEY , a kms_key_identifier in the format of a key ARN is required.

    Valid values: CUSTOMER_MANAGED_KMS_KEY | AWS_OWNED_KMS_KEY .

    kms_key_identifier str
    Requires a kms_key_identifier in the format of a key ARN.
    encryptionType "AWS_OWNED_KMS_KEY" | "CUSTOMER_MANAGED_KMS_KEY"

    The encryption at rest options for the table.

    • AWS owned key (default) - AWS_OWNED_KMS_KEY
    • Customer managed key - CUSTOMER_MANAGED_KMS_KEY

    If you choose CUSTOMER_MANAGED_KMS_KEY , a kms_key_identifier in the format of a key ARN is required.

    Valid values: CUSTOMER_MANAGED_KMS_KEY | AWS_OWNED_KMS_KEY .

    kmsKeyIdentifier String
    Requires a kms_key_identifier in the format of a key ARN.

    TableEncryptionType

    TableMode

    TableProvisionedThroughput

    ReadCapacityUnits int
    The amount of read capacity that's provisioned for the table. For more information, see Read/write capacity mode in the Amazon Keyspaces Developer Guide .
    WriteCapacityUnits int
    The amount of write capacity that's provisioned for the table. For more information, see Read/write capacity mode in the Amazon Keyspaces Developer Guide .
    ReadCapacityUnits int
    The amount of read capacity that's provisioned for the table. For more information, see Read/write capacity mode in the Amazon Keyspaces Developer Guide .
    WriteCapacityUnits int
    The amount of write capacity that's provisioned for the table. For more information, see Read/write capacity mode in the Amazon Keyspaces Developer Guide .
    readCapacityUnits Integer
    The amount of read capacity that's provisioned for the table. For more information, see Read/write capacity mode in the Amazon Keyspaces Developer Guide .
    writeCapacityUnits Integer
    The amount of write capacity that's provisioned for the table. For more information, see Read/write capacity mode in the Amazon Keyspaces Developer Guide .
    readCapacityUnits number
    The amount of read capacity that's provisioned for the table. For more information, see Read/write capacity mode in the Amazon Keyspaces Developer Guide .
    writeCapacityUnits number
    The amount of write capacity that's provisioned for the table. For more information, see Read/write capacity mode in the Amazon Keyspaces Developer Guide .
    read_capacity_units int
    The amount of read capacity that's provisioned for the table. For more information, see Read/write capacity mode in the Amazon Keyspaces Developer Guide .
    write_capacity_units int
    The amount of write capacity that's provisioned for the table. For more information, see Read/write capacity mode in the Amazon Keyspaces Developer Guide .
    readCapacityUnits Number
    The amount of read capacity that's provisioned for the table. For more information, see Read/write capacity mode in the Amazon Keyspaces Developer Guide .
    writeCapacityUnits Number
    The amount of write capacity that's provisioned for the table. For more information, see Read/write capacity mode in the Amazon Keyspaces Developer Guide .

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.108.4 published on Tuesday, Jun 18, 2024 by Pulumi