Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. cassandra
  5. getKeyspace

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.cassandra.getKeyspace

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

    Resource schema for AWS::Cassandra::Keyspace

    Using getKeyspace

    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 getKeyspace(args: GetKeyspaceArgs, opts?: InvokeOptions): Promise<GetKeyspaceResult>
function getKeyspaceOutput(args: GetKeyspaceOutputArgs, opts?: InvokeOptions): Output<GetKeyspaceResult>
    def get_keyspace(keyspace_name: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetKeyspaceResult
def get_keyspace_output(keyspace_name: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetKeyspaceResult]
    func LookupKeyspace(ctx *Context, args *LookupKeyspaceArgs, opts ...InvokeOption) (*LookupKeyspaceResult, error)
func LookupKeyspaceOutput(ctx *Context, args *LookupKeyspaceOutputArgs, opts ...InvokeOption) LookupKeyspaceResultOutput

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

    public static class GetKeyspace 
{
    public static Task<GetKeyspaceResult> InvokeAsync(GetKeyspaceArgs args, InvokeOptions? opts = null)
    public static Output<GetKeyspaceResult> Invoke(GetKeyspaceInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetKeyspaceResult> getKeyspace(GetKeyspaceArgs args, InvokeOptions options)
public static Output<GetKeyspaceResult> getKeyspace(GetKeyspaceArgs args, InvokeOptions options)

    fn::invoke:
  function: aws-native:cassandra:getKeyspace
  arguments:
    # arguments dictionary

    The following arguments are supported:

    KeyspaceName string
    Name for Cassandra keyspace
    KeyspaceName string
    Name for Cassandra keyspace
    keyspaceName String
    Name for Cassandra keyspace
    keyspaceName string
    Name for Cassandra keyspace
    keyspace_name str
    Name for Cassandra keyspace
    keyspaceName String
    Name for Cassandra keyspace

    getKeyspace Result

    The following output properties are available:

    ClientSideTimestampsEnabled bool
    Indicates whether client-side timestamps are enabled (true) or disabled (false) for all tables in the keyspace. To add a Region to a single-Region keyspace with at least one table, the value must be set to true. After you enabled client-side timestamps for a table, you can’t disable it again.
    ReplicationSpecification Pulumi.AwsNative.Cassandra.Outputs.KeyspaceReplicationSpecification

    Specifies the ReplicationStrategy of a keyspace. The options are:

    • SINGLE_REGION for a single Region keyspace (optional) or
    • MULTI_REGION for a multi-Region keyspace

    If no ReplicationStrategy is provided, the default is SINGLE_REGION . If you choose MULTI_REGION , you must also provide a RegionList with the AWS Regions that the keyspace is replicated in.

    Tags List<Pulumi.AwsNative.Outputs.Tag>

    An array of key-value pairs to apply to this resource.

    For more information, see Tag .

    ClientSideTimestampsEnabled bool
    Indicates whether client-side timestamps are enabled (true) or disabled (false) for all tables in the keyspace. To add a Region to a single-Region keyspace with at least one table, the value must be set to true. After you enabled client-side timestamps for a table, you can’t disable it again.
    ReplicationSpecification KeyspaceReplicationSpecification

    Specifies the ReplicationStrategy of a keyspace. The options are:

    • SINGLE_REGION for a single Region keyspace (optional) or
    • MULTI_REGION for a multi-Region keyspace

    If no ReplicationStrategy is provided, the default is SINGLE_REGION . If you choose MULTI_REGION , you must also provide a RegionList with the AWS Regions that the keyspace is replicated in.

    Tags Tag

    An array of key-value pairs to apply to this resource.

    For more information, see Tag .

    clientSideTimestampsEnabled Boolean
    Indicates whether client-side timestamps are enabled (true) or disabled (false) for all tables in the keyspace. To add a Region to a single-Region keyspace with at least one table, the value must be set to true. After you enabled client-side timestamps for a table, you can’t disable it again.
    replicationSpecification KeyspaceReplicationSpecification

    Specifies the ReplicationStrategy of a keyspace. The options are:

    • SINGLE_REGION for a single Region keyspace (optional) or
    • MULTI_REGION for a multi-Region keyspace

    If no ReplicationStrategy is provided, the default is SINGLE_REGION . If you choose MULTI_REGION , you must also provide a RegionList with the AWS Regions that the keyspace is replicated in.

    tags List<Tag>

    An array of key-value pairs to apply to this resource.

    For more information, see Tag .

    clientSideTimestampsEnabled boolean
    Indicates whether client-side timestamps are enabled (true) or disabled (false) for all tables in the keyspace. To add a Region to a single-Region keyspace with at least one table, the value must be set to true. After you enabled client-side timestamps for a table, you can’t disable it again.
    replicationSpecification KeyspaceReplicationSpecification

    Specifies the ReplicationStrategy of a keyspace. The options are:

    • SINGLE_REGION for a single Region keyspace (optional) or
    • MULTI_REGION for a multi-Region keyspace

    If no ReplicationStrategy is provided, the default is SINGLE_REGION . If you choose MULTI_REGION , you must also provide a RegionList with the AWS Regions that the keyspace is replicated in.

    tags Tag[]

    An array of key-value pairs to apply to this resource.

    For more information, see Tag .

    client_side_timestamps_enabled bool
    Indicates whether client-side timestamps are enabled (true) or disabled (false) for all tables in the keyspace. To add a Region to a single-Region keyspace with at least one table, the value must be set to true. After you enabled client-side timestamps for a table, you can’t disable it again.
    replication_specification KeyspaceReplicationSpecification

    Specifies the ReplicationStrategy of a keyspace. The options are:

    • SINGLE_REGION for a single Region keyspace (optional) or
    • MULTI_REGION for a multi-Region keyspace

    If no ReplicationStrategy is provided, the default is SINGLE_REGION . If you choose MULTI_REGION , you must also provide a RegionList with the AWS Regions that the keyspace is replicated in.

    tags Sequence[root_Tag]

    An array of key-value pairs to apply to this resource.

    For more information, see Tag .

    clientSideTimestampsEnabled Boolean
    Indicates whether client-side timestamps are enabled (true) or disabled (false) for all tables in the keyspace. To add a Region to a single-Region keyspace with at least one table, the value must be set to true. After you enabled client-side timestamps for a table, you can’t disable it again.
    replicationSpecification Property Map

    Specifies the ReplicationStrategy of a keyspace. The options are:

    • SINGLE_REGION for a single Region keyspace (optional) or
    • MULTI_REGION for a multi-Region keyspace

    If no ReplicationStrategy is provided, the default is SINGLE_REGION . If you choose MULTI_REGION , you must also provide a RegionList with the AWS Regions that the keyspace is replicated in.

    tags List<Property Map>

    An array of key-value pairs to apply to this resource.

    For more information, see Tag .

    Supporting Types

    KeyspaceRegionListItem

    KeyspaceReplicationSpecification

    RegionList List<Pulumi.AwsNative.Cassandra.KeyspaceRegionListItem>
    Specifies the AWS Regions that the keyspace is replicated in. You must specify at least two and up to six Regions, including the Region that the keyspace is being created in.
    ReplicationStrategy Pulumi.AwsNative.Cassandra.KeyspaceReplicationSpecificationReplicationStrategy

    The options are:

    • SINGLE_REGION (optional)
    • MULTI_REGION

    If no value is specified, the default is SINGLE_REGION . If MULTI_REGION is specified, RegionList is required.

    RegionList []KeyspaceRegionListItem
    Specifies the AWS Regions that the keyspace is replicated in. You must specify at least two and up to six Regions, including the Region that the keyspace is being created in.
    ReplicationStrategy KeyspaceReplicationSpecificationReplicationStrategy

    The options are:

    • SINGLE_REGION (optional)
    • MULTI_REGION

    If no value is specified, the default is SINGLE_REGION . If MULTI_REGION is specified, RegionList is required.

    regionList List<KeyspaceRegionListItem>
    Specifies the AWS Regions that the keyspace is replicated in. You must specify at least two and up to six Regions, including the Region that the keyspace is being created in.
    replicationStrategy KeyspaceReplicationSpecificationReplicationStrategy

    The options are:

    • SINGLE_REGION (optional)
    • MULTI_REGION

    If no value is specified, the default is SINGLE_REGION . If MULTI_REGION is specified, RegionList is required.

    regionList KeyspaceRegionListItem[]
    Specifies the AWS Regions that the keyspace is replicated in. You must specify at least two and up to six Regions, including the Region that the keyspace is being created in.
    replicationStrategy KeyspaceReplicationSpecificationReplicationStrategy

    The options are:

    • SINGLE_REGION (optional)
    • MULTI_REGION

    If no value is specified, the default is SINGLE_REGION . If MULTI_REGION is specified, RegionList is required.

    region_list Sequence[KeyspaceRegionListItem]
    Specifies the AWS Regions that the keyspace is replicated in. You must specify at least two and up to six Regions, including the Region that the keyspace is being created in.
    replication_strategy KeyspaceReplicationSpecificationReplicationStrategy

    The options are:

    • SINGLE_REGION (optional)
    • MULTI_REGION

    If no value is specified, the default is SINGLE_REGION . If MULTI_REGION is specified, RegionList is required.

    regionList List<"ap-northeast-1" | "ap-northeast-2" | "ap-south-1" | "ap-southeast-1" | "ap-southeast-2" | "ca-central-1" | "eu-central-1" | "eu-north-1" | "eu-west-1" | "eu-west-2" | "eu-west-3" | "sa-east-1" | "us-east-1" | "us-east-2" | "us-west-1" | "us-west-2">
    Specifies the AWS Regions that the keyspace is replicated in. You must specify at least two and up to six Regions, including the Region that the keyspace is being created in.
    replicationStrategy "SINGLE_REGION" | "MULTI_REGION"

    The options are:

    • SINGLE_REGION (optional)
    • MULTI_REGION

    If no value is specified, the default is SINGLE_REGION . If MULTI_REGION is specified, RegionList is required.

    KeyspaceReplicationSpecificationReplicationStrategy

    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

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
    pulumi/pulumi-aws-native