Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. keyspaces
  5. Keyspace
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-aws

aws.keyspaces.Keyspace

Explore with Pulumi AI

aws logo
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-aws

    Provides a Keyspaces Keyspace.

    More information about keyspaces can be found in the Keyspaces User Guide.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.keyspaces.Keyspace("example", {name: "my_keyspace"});

    import pulumi
import pulumi_aws as aws

example = aws.keyspaces.Keyspace("example", name="my_keyspace")

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/keyspaces"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := keyspaces.NewKeyspace(ctx, "example", &keyspaces.KeyspaceArgs{
			Name: pulumi.String("my_keyspace"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = new Aws.Keyspaces.Keyspace("example", new()
    {
        Name = "my_keyspace",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.keyspaces.Keyspace;
import com.pulumi.aws.keyspaces.KeyspaceArgs;
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 example = new Keyspace("example", KeyspaceArgs.builder()
            .name("my_keyspace")
            .build());

    }
}

    resources:
  example:
    type: aws:keyspaces:Keyspace
    properties:
      name: my_keyspace

    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,
             name: Optional[str] = None,
             replication_specification: Optional[KeyspaceReplicationSpecificationArgs] = None,
             tags: Optional[Mapping[str, str]] = 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:keyspaces: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.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var keyspaceResource = new Aws.Keyspaces.Keyspace("keyspaceResource", new()
{
    Name = "string",
    ReplicationSpecification = new Aws.Keyspaces.Inputs.KeyspaceReplicationSpecificationArgs
    {
        RegionLists = new[]
        {
            "string",
        },
        ReplicationStrategy = "string",
    },
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := keyspaces.NewKeyspace(ctx, "keyspaceResource", &keyspaces.KeyspaceArgs{
	Name: pulumi.String("string"),
	ReplicationSpecification: &keyspaces.KeyspaceReplicationSpecificationArgs{
		RegionLists: pulumi.StringArray{
			pulumi.String("string"),
		},
		ReplicationStrategy: pulumi.String("string"),
	},
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var keyspaceResource = new Keyspace("keyspaceResource", KeyspaceArgs.builder()
    .name("string")
    .replicationSpecification(KeyspaceReplicationSpecificationArgs.builder()
        .regionLists("string")
        .replicationStrategy("string")
        .build())
    .tags(Map.of("string", "string"))
    .build());

    keyspace_resource = aws.keyspaces.Keyspace("keyspaceResource",
    name="string",
    replication_specification={
        "region_lists": ["string"],
        "replication_strategy": "string",
    },
    tags={
        "string": "string",
    })

    const keyspaceResource = new aws.keyspaces.Keyspace("keyspaceResource", {
    name: "string",
    replicationSpecification: {
        regionLists: ["string"],
        replicationStrategy: "string",
    },
    tags: {
        string: "string",
    },
});

    type: aws:keyspaces:Keyspace
properties:
    name: string
    replicationSpecification:
        regionLists:
            - string
        replicationStrategy: string
    tags:
        string: string

    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

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Keyspace resource accepts the following input properties:

    Name string

    The name of the keyspace to be created.

    The following arguments are optional:

    ReplicationSpecification KeyspaceReplicationSpecification
    The replication specification of the keyspace.
    Tags Dictionary<string, string>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    Name string

    The name of the keyspace to be created.

    The following arguments are optional:

    ReplicationSpecification KeyspaceReplicationSpecificationArgs
    The replication specification of the keyspace.
    Tags map[string]string
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    name String

    The name of the keyspace to be created.

    The following arguments are optional:

    replicationSpecification KeyspaceReplicationSpecification
    The replication specification of the keyspace.
    tags Map<String,String>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    name string

    The name of the keyspace to be created.

    The following arguments are optional:

    replicationSpecification KeyspaceReplicationSpecification
    The replication specification of the keyspace.
    tags {[key: string]: string}
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    name str

    The name of the keyspace to be created.

    The following arguments are optional:

    replication_specification KeyspaceReplicationSpecificationArgs
    The replication specification of the keyspace.
    tags Mapping[str, str]
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    name String

    The name of the keyspace to be created.

    The following arguments are optional:

    replicationSpecification Property Map
    The replication specification of the keyspace.
    tags Map<String>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    Outputs

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

    Arn string
    The ARN of the keyspace.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    The ARN of the keyspace.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    The ARN of the keyspace.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    The ARN of the keyspace.
    id string
    The provider-assigned unique ID for this managed resource.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    The ARN of the keyspace.
    id str
    The provider-assigned unique ID for this managed resource.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    The ARN of the keyspace.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Look up Existing Keyspace Resource

    Get an existing Keyspace 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?: KeyspaceState, opts?: CustomResourceOptions): Keyspace
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        name: Optional[str] = None,
        replication_specification: Optional[KeyspaceReplicationSpecificationArgs] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None) -> Keyspace
    func GetKeyspace(ctx *Context, name string, id IDInput, state *KeyspaceState, opts ...ResourceOption) (*Keyspace, error)
    public static Keyspace Get(string name, Input<string> id, KeyspaceState? state, CustomResourceOptions? opts = null)
    public static Keyspace get(String name, Output<String> id, KeyspaceState 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.
    The following state arguments are supported:
    Arn string
    The ARN of the keyspace.
    Name string

    The name of the keyspace to be created.

    The following arguments are optional:

    ReplicationSpecification KeyspaceReplicationSpecification
    The replication specification of the keyspace.
    Tags Dictionary<string, string>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    The ARN of the keyspace.
    Name string

    The name of the keyspace to be created.

    The following arguments are optional:

    ReplicationSpecification KeyspaceReplicationSpecificationArgs
    The replication specification of the keyspace.
    Tags map[string]string
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    The ARN of the keyspace.
    name String

    The name of the keyspace to be created.

    The following arguments are optional:

    replicationSpecification KeyspaceReplicationSpecification
    The replication specification of the keyspace.
    tags Map<String,String>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    The ARN of the keyspace.
    name string

    The name of the keyspace to be created.

    The following arguments are optional:

    replicationSpecification KeyspaceReplicationSpecification
    The replication specification of the keyspace.
    tags {[key: string]: string}
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    The ARN of the keyspace.
    name str

    The name of the keyspace to be created.

    The following arguments are optional:

    replication_specification KeyspaceReplicationSpecificationArgs
    The replication specification of the keyspace.
    tags Mapping[str, str]
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    The ARN of the keyspace.
    name String

    The name of the keyspace to be created.

    The following arguments are optional:

    replicationSpecification Property Map
    The replication specification of the keyspace.
    tags Map<String>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Supporting Types

    KeyspaceReplicationSpecification, KeyspaceReplicationSpecificationArgs

    RegionLists List<string>
    Replication regions. If replication_strategy is MULTI_REGION, region_list requires the current Region and at least one additional AWS Region where the keyspace is going to be replicated in.
    ReplicationStrategy string
    Replication strategy. Valid values: SINGLE_REGION and MULTI_REGION.
    RegionLists []string
    Replication regions. If replication_strategy is MULTI_REGION, region_list requires the current Region and at least one additional AWS Region where the keyspace is going to be replicated in.
    ReplicationStrategy string
    Replication strategy. Valid values: SINGLE_REGION and MULTI_REGION.
    regionLists List<String>
    Replication regions. If replication_strategy is MULTI_REGION, region_list requires the current Region and at least one additional AWS Region where the keyspace is going to be replicated in.
    replicationStrategy String
    Replication strategy. Valid values: SINGLE_REGION and MULTI_REGION.
    regionLists string[]
    Replication regions. If replication_strategy is MULTI_REGION, region_list requires the current Region and at least one additional AWS Region where the keyspace is going to be replicated in.
    replicationStrategy string
    Replication strategy. Valid values: SINGLE_REGION and MULTI_REGION.
    region_lists Sequence[str]
    Replication regions. If replication_strategy is MULTI_REGION, region_list requires the current Region and at least one additional AWS Region where the keyspace is going to be replicated in.
    replication_strategy str
    Replication strategy. Valid values: SINGLE_REGION and MULTI_REGION.
    regionLists List<String>
    Replication regions. If replication_strategy is MULTI_REGION, region_list requires the current Region and at least one additional AWS Region where the keyspace is going to be replicated in.
    replicationStrategy String
    Replication strategy. Valid values: SINGLE_REGION and MULTI_REGION.

    Import

    Using pulumi import, import a keyspace using the name. For example:

    $ pulumi import aws:keyspaces/keyspace:Keyspace example my_keyspace

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
    pulumi/pulumi-aws