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

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

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.cassandra.Keyspace

Explore with Pulumi AI

aws-native logo

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

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
pulumi/pulumi-aws-native

    Resource schema for AWS::Cassandra::Keyspace

    Example Usage

    Example

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AwsNative = Pulumi.AwsNative;

return await Deployment.RunAsync(() => 
{
    var myNewKeyspace = new AwsNative.Cassandra.Keyspace("myNewKeyspace", new()
    {
        KeyspaceName = "MyNewKeyspace",
        Tags = new[]
        {
            new AwsNative.Inputs.TagArgs
            {
                Key = "tag1",
                Value = "val1",
            },
            new AwsNative.Inputs.TagArgs
            {
                Key = "tag2",
                Value = "val2",
            },
        },
    });

});

    package main

import (
	awsnative "github.com/pulumi/pulumi-aws-native/sdk/go/aws"
	"github.com/pulumi/pulumi-aws-native/sdk/go/aws/cassandra"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := cassandra.NewKeyspace(ctx, "myNewKeyspace", &cassandra.KeyspaceArgs{
			KeyspaceName: pulumi.String("MyNewKeyspace"),
			Tags: aws.TagArray{
				&aws.TagArgs{
					Key:   pulumi.String("tag1"),
					Value: pulumi.String("val1"),
				},
				&aws.TagArgs{
					Key:   pulumi.String("tag2"),
					Value: pulumi.String("val2"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    Coming soon!

    import pulumi
import pulumi_aws_native as aws_native

my_new_keyspace = aws_native.cassandra.Keyspace("myNewKeyspace",
    keyspace_name="MyNewKeyspace",
    tags=[
        {
            "key": "tag1",
            "value": "val1",
        },
        {
            "key": "tag2",
            "value": "val2",
        },
    ])

    import * as pulumi from "@pulumi/pulumi";
import * as aws_native from "@pulumi/aws-native";

const myNewKeyspace = new aws_native.cassandra.Keyspace("myNewKeyspace", {
    keyspaceName: "MyNewKeyspace",
    tags: [
        {
            key: "tag1",
            value: "val1",
        },
        {
            key: "tag2",
            value: "val2",
        },
    ],
});

    Coming soon!

    Example

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AwsNative = Pulumi.AwsNative;

return await Deployment.RunAsync(() => 
{
    var multiRegionKeyspace = new AwsNative.Cassandra.Keyspace("multiRegionKeyspace", new()
    {
        KeyspaceName = "MultiRegionKeyspace",
        ReplicationSpecification = new AwsNative.Cassandra.Inputs.KeyspaceReplicationSpecificationArgs
        {
            ReplicationStrategy = AwsNative.Cassandra.KeyspaceReplicationSpecificationReplicationStrategy.MultiRegion,
            RegionList = new[]
            {
                AwsNative.Cassandra.KeyspaceRegionListItem.UsEast1,
                AwsNative.Cassandra.KeyspaceRegionListItem.UsWest2,
                AwsNative.Cassandra.KeyspaceRegionListItem.EuWest1,
            },
        },
    });

});

    package main

import (
	"github.com/pulumi/pulumi-aws-native/sdk/go/aws/cassandra"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := cassandra.NewKeyspace(ctx, "multiRegionKeyspace", &cassandra.KeyspaceArgs{
			KeyspaceName: pulumi.String("MultiRegionKeyspace"),
			ReplicationSpecification: &cassandra.KeyspaceReplicationSpecificationArgs{
				ReplicationStrategy: cassandra.KeyspaceReplicationSpecificationReplicationStrategyMultiRegion,
				RegionList: cassandra.KeyspaceRegionListItemArray{
					cassandra.KeyspaceRegionListItemUsEast1,
					cassandra.KeyspaceRegionListItemUsWest2,
					cassandra.KeyspaceRegionListItemEuWest1,
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    Coming soon!

    import pulumi
import pulumi_aws_native as aws_native

multi_region_keyspace = aws_native.cassandra.Keyspace("multiRegionKeyspace",
    keyspace_name="MultiRegionKeyspace",
    replication_specification={
        "replication_strategy": aws_native.cassandra.KeyspaceReplicationSpecificationReplicationStrategy.MULTI_REGION,
        "region_list": [
            aws_native.cassandra.KeyspaceRegionListItem.US_EAST1,
            aws_native.cassandra.KeyspaceRegionListItem.US_WEST2,
            aws_native.cassandra.KeyspaceRegionListItem.EU_WEST1,
        ],
    })

    import * as pulumi from "@pulumi/pulumi";
import * as aws_native from "@pulumi/aws-native";

const multiRegionKeyspace = new aws_native.cassandra.Keyspace("multiRegionKeyspace", {
    keyspaceName: "MultiRegionKeyspace",
    replicationSpecification: {
        replicationStrategy: aws_native.cassandra.KeyspaceReplicationSpecificationReplicationStrategy.MultiRegion,
        regionList: [
            aws_native.cassandra.KeyspaceRegionListItem.UsEast1,
            aws_native.cassandra.KeyspaceRegionListItem.UsWest2,
            aws_native.cassandra.KeyspaceRegionListItem.EuWest1,
        ],
    },
});

    Coming soon!

    Example

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AwsNative = Pulumi.AwsNative;

return await Deployment.RunAsync(() => 
{
    var multiRegionKeyspace = new AwsNative.Cassandra.Keyspace("multiRegionKeyspace", new()
    {
        KeyspaceName = "MultiRegionKeyspace",
        ReplicationSpecification = new AwsNative.Cassandra.Inputs.KeyspaceReplicationSpecificationArgs
        {
            ReplicationStrategy = AwsNative.Cassandra.KeyspaceReplicationSpecificationReplicationStrategy.MultiRegion,
            RegionList = new[]
            {
                AwsNative.Cassandra.KeyspaceRegionListItem.UsEast1,
                AwsNative.Cassandra.KeyspaceRegionListItem.UsWest2,
                AwsNative.Cassandra.KeyspaceRegionListItem.EuWest1,
            },
        },
    });

});

    package main

import (
	"github.com/pulumi/pulumi-aws-native/sdk/go/aws/cassandra"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := cassandra.NewKeyspace(ctx, "multiRegionKeyspace", &cassandra.KeyspaceArgs{
			KeyspaceName: pulumi.String("MultiRegionKeyspace"),
			ReplicationSpecification: &cassandra.KeyspaceReplicationSpecificationArgs{
				ReplicationStrategy: cassandra.KeyspaceReplicationSpecificationReplicationStrategyMultiRegion,
				RegionList: cassandra.KeyspaceRegionListItemArray{
					cassandra.KeyspaceRegionListItemUsEast1,
					cassandra.KeyspaceRegionListItemUsWest2,
					cassandra.KeyspaceRegionListItemEuWest1,
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    Coming soon!

    import pulumi
import pulumi_aws_native as aws_native

multi_region_keyspace = aws_native.cassandra.Keyspace("multiRegionKeyspace",
    keyspace_name="MultiRegionKeyspace",
    replication_specification={
        "replication_strategy": aws_native.cassandra.KeyspaceReplicationSpecificationReplicationStrategy.MULTI_REGION,
        "region_list": [
            aws_native.cassandra.KeyspaceRegionListItem.US_EAST1,
            aws_native.cassandra.KeyspaceRegionListItem.US_WEST2,
            aws_native.cassandra.KeyspaceRegionListItem.EU_WEST1,
        ],
    })

    import * as pulumi from "@pulumi/pulumi";
import * as aws_native from "@pulumi/aws-native";

const multiRegionKeyspace = new aws_native.cassandra.Keyspace("multiRegionKeyspace", {
    keyspaceName: "MultiRegionKeyspace",
    replicationSpecification: {
        replicationStrategy: aws_native.cassandra.KeyspaceReplicationSpecificationReplicationStrategy.MultiRegion,
        regionList: [
            aws_native.cassandra.KeyspaceRegionListItem.UsEast1,
            aws_native.cassandra.KeyspaceRegionListItem.UsWest2,
            aws_native.cassandra.KeyspaceRegionListItem.EuWest1,
        ],
    },
});

    Coming soon!

    Create Keyspace Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Keyspace(name: string, args?: KeyspaceArgs, opts?: CustomResourceOptions);
    @overload
def Keyspace(resource_name: str,
             args: Optional[KeyspaceArgs] = None,
             opts: Optional[ResourceOptions] = None)

@overload
def Keyspace(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             keyspace_name: Optional[str] = None,
             replication_specification: Optional[KeyspaceReplicationSpecificationArgs] = None,
             tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
    func NewKeyspace(ctx *Context, name string, args *KeyspaceArgs, opts ...ResourceOption) (*Keyspace, error)
    public Keyspace(string name, KeyspaceArgs? args = null, CustomResourceOptions? opts = null)
    public Keyspace(String name, KeyspaceArgs args)
public Keyspace(String name, KeyspaceArgs args, CustomResourceOptions options)

    type: aws-native:cassandra:Keyspace
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 KeyspaceArgs
    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 KeyspaceArgs
    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 KeyspaceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args KeyspaceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args KeyspaceArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Keyspace 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 Keyspace resource accepts the following input properties:

    KeyspaceName string
    Name for Cassandra keyspace
    ReplicationSpecification Pulumi.AwsNative.Cassandra.Inputs.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.Inputs.Tag>

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

    For more information, see Tag .

    KeyspaceName string
    Name for Cassandra keyspace
    ReplicationSpecification KeyspaceReplicationSpecificationArgs

    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 TagArgs

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

    For more information, see Tag .

    keyspaceName String
    Name for Cassandra keyspace
    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 .

    keyspaceName string
    Name for Cassandra keyspace
    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 .

    keyspace_name str
    Name for Cassandra keyspace
    replication_specification KeyspaceReplicationSpecificationArgs

    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[TagArgs]

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

    For more information, see Tag .

    keyspaceName String
    Name for Cassandra keyspace
    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 .

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Keyspace resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    KeyspaceRegionListItem, KeyspaceRegionListItemArgs

    ApNortheast1
    ap-northeast-1
    ApNortheast2
    ap-northeast-2
    ApSouth1
    ap-south-1
    ApSoutheast1
    ap-southeast-1
    ApSoutheast2
    ap-southeast-2
    CaCentral1
    ca-central-1
    EuCentral1
    eu-central-1
    EuNorth1
    eu-north-1
    EuWest1
    eu-west-1
    EuWest2
    eu-west-2
    EuWest3
    eu-west-3
    SaEast1
    sa-east-1
    UsEast1
    us-east-1
    UsEast2
    us-east-2
    UsWest1
    us-west-1
    UsWest2
    us-west-2
    KeyspaceRegionListItemApNortheast1
    ap-northeast-1
    KeyspaceRegionListItemApNortheast2
    ap-northeast-2
    KeyspaceRegionListItemApSouth1
    ap-south-1
    KeyspaceRegionListItemApSoutheast1
    ap-southeast-1
    KeyspaceRegionListItemApSoutheast2
    ap-southeast-2
    KeyspaceRegionListItemCaCentral1
    ca-central-1
    KeyspaceRegionListItemEuCentral1
    eu-central-1
    KeyspaceRegionListItemEuNorth1
    eu-north-1
    KeyspaceRegionListItemEuWest1
    eu-west-1
    KeyspaceRegionListItemEuWest2
    eu-west-2
    KeyspaceRegionListItemEuWest3
    eu-west-3
    KeyspaceRegionListItemSaEast1
    sa-east-1
    KeyspaceRegionListItemUsEast1
    us-east-1
    KeyspaceRegionListItemUsEast2
    us-east-2
    KeyspaceRegionListItemUsWest1
    us-west-1
    KeyspaceRegionListItemUsWest2
    us-west-2
    ApNortheast1
    ap-northeast-1
    ApNortheast2
    ap-northeast-2
    ApSouth1
    ap-south-1
    ApSoutheast1
    ap-southeast-1
    ApSoutheast2
    ap-southeast-2
    CaCentral1
    ca-central-1
    EuCentral1
    eu-central-1
    EuNorth1
    eu-north-1
    EuWest1
    eu-west-1
    EuWest2
    eu-west-2
    EuWest3
    eu-west-3
    SaEast1
    sa-east-1
    UsEast1
    us-east-1
    UsEast2
    us-east-2
    UsWest1
    us-west-1
    UsWest2
    us-west-2
    ApNortheast1
    ap-northeast-1
    ApNortheast2
    ap-northeast-2
    ApSouth1
    ap-south-1
    ApSoutheast1
    ap-southeast-1
    ApSoutheast2
    ap-southeast-2
    CaCentral1
    ca-central-1
    EuCentral1
    eu-central-1
    EuNorth1
    eu-north-1
    EuWest1
    eu-west-1
    EuWest2
    eu-west-2
    EuWest3
    eu-west-3
    SaEast1
    sa-east-1
    UsEast1
    us-east-1
    UsEast2
    us-east-2
    UsWest1
    us-west-1
    UsWest2
    us-west-2
    AP_NORTHEAST1
    ap-northeast-1
    AP_NORTHEAST2
    ap-northeast-2
    AP_SOUTH1
    ap-south-1
    AP_SOUTHEAST1
    ap-southeast-1
    AP_SOUTHEAST2
    ap-southeast-2
    CA_CENTRAL1
    ca-central-1
    EU_CENTRAL1
    eu-central-1
    EU_NORTH1
    eu-north-1
    EU_WEST1
    eu-west-1
    EU_WEST2
    eu-west-2
    EU_WEST3
    eu-west-3
    SA_EAST1
    sa-east-1
    US_EAST1
    us-east-1
    US_EAST2
    us-east-2
    US_WEST1
    us-west-1
    US_WEST2
    us-west-2
    "ap-northeast-1"
    ap-northeast-1
    "ap-northeast-2"
    ap-northeast-2
    "ap-south-1"
    ap-south-1
    "ap-southeast-1"
    ap-southeast-1
    "ap-southeast-2"
    ap-southeast-2
    "ca-central-1"
    ca-central-1
    "eu-central-1"
    eu-central-1
    "eu-north-1"
    eu-north-1
    "eu-west-1"
    eu-west-1
    "eu-west-2"
    eu-west-2
    "eu-west-3"
    eu-west-3
    "sa-east-1"
    sa-east-1
    "us-east-1"
    us-east-1
    "us-east-2"
    us-east-2
    "us-west-1"
    us-west-1
    "us-west-2"
    us-west-2

    KeyspaceReplicationSpecification, KeyspaceReplicationSpecificationArgs

    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, KeyspaceReplicationSpecificationReplicationStrategyArgs

    SingleRegion
    SINGLE_REGION
    MultiRegion
    MULTI_REGION
    KeyspaceReplicationSpecificationReplicationStrategySingleRegion
    SINGLE_REGION
    KeyspaceReplicationSpecificationReplicationStrategyMultiRegion
    MULTI_REGION
    SingleRegion
    SINGLE_REGION
    MultiRegion
    MULTI_REGION
    SingleRegion
    SINGLE_REGION
    MultiRegion
    MULTI_REGION
    SINGLE_REGION
    SINGLE_REGION
    MULTI_REGION
    MULTI_REGION
    "SINGLE_REGION"
    SINGLE_REGION
    "MULTI_REGION"
    MULTI_REGION

    Tag, TagArgs

    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 Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
    pulumi/pulumi-aws-native