awscassandra

package
v2.9.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 26, 2022 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func CfnKeyspace_CFN_RESOURCE_TYPE_NAME 

func CfnKeyspace_CFN_RESOURCE_TYPE_NAME() *string

func CfnKeyspace_IsCfnElement 

func CfnKeyspace_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnKeyspace_IsCfnResource 

func CfnKeyspace_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnKeyspace_IsConstruct 

func CfnKeyspace_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnTable_CFN_RESOURCE_TYPE_NAME 

func CfnTable_CFN_RESOURCE_TYPE_NAME() *string

func CfnTable_IsCfnElement 

func CfnTable_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnTable_IsCfnResource 

func CfnTable_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnTable_IsConstruct 

func CfnTable_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func NewCfnKeyspace_Override 

func NewCfnKeyspace_Override(c CfnKeyspace, scope constructs.Construct, id *string, props *CfnKeyspaceProps)

Create a new `AWS::Cassandra::Keyspace`.

func NewCfnTable_Override 

func NewCfnTable_Override(c CfnTable, scope constructs.Construct, id *string, props *CfnTableProps)

Create a new `AWS::Cassandra::Table`.

Types

type CfnKeyspace 

type CfnKeyspace interface {
	awscdk.CfnResource
	awscdk.IInspectable
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	KeyspaceName() *string
	SetKeyspaceName(val *string)
	LogicalId() *string
	Node() constructs.Node
	Ref() *string
	Stack() awscdk.Stack
	Tags() awscdk.TagManager
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::Cassandra::Keyspace`.

The `AWS::Cassandra::Keyspace` resource allows you to create a new keyspace in Amazon Keyspaces (for Apache Cassandra). For more information, see [Create a keyspace and a table](https://docs.aws.amazon.com/keyspaces/latest/devguide/getting-started.ddl.html) in the *Amazon Keyspaces Developer Guide* .

TODO: EXAMPLE

func NewCfnKeyspace 

func NewCfnKeyspace(scope constructs.Construct, id *string, props *CfnKeyspaceProps) CfnKeyspace

Create a new `AWS::Cassandra::Keyspace`.

type CfnKeyspaceProps 

type CfnKeyspaceProps struct {
	// The name of the keyspace to be created.
	//
	// The keyspace name is case sensitive. If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the keyspace name. For more information, see [Name type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html) .
	//
	// *Length constraints:* Minimum length of 3. Maximum length of 255.
	//
	// *Pattern:* `^[a-zA-Z0-9][a-zA-Z0-9_]{1,47}$`
	KeyspaceName *string `json:"keyspaceName" yaml:"keyspaceName"`
	// A list of key-value pair tags to be attached to the resource.
	Tags *[]*awscdk.CfnTag `json:"tags" yaml:"tags"`
}

Properties for defining a `CfnKeyspace`.

TODO: EXAMPLE

type CfnTable 

type CfnTable interface {
	awscdk.CfnResource
	awscdk.IInspectable
	BillingMode() interface{}
	SetBillingMode(val interface{})
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	ClusteringKeyColumns() interface{}
	SetClusteringKeyColumns(val interface{})
	CreationStack() *[]*string
	DefaultTimeToLive() *float64
	SetDefaultTimeToLive(val *float64)
	EncryptionSpecification() interface{}
	SetEncryptionSpecification(val interface{})
	KeyspaceName() *string
	SetKeyspaceName(val *string)
	LogicalId() *string
	Node() constructs.Node
	PartitionKeyColumns() interface{}
	SetPartitionKeyColumns(val interface{})
	PointInTimeRecoveryEnabled() interface{}
	SetPointInTimeRecoveryEnabled(val interface{})
	Ref() *string
	RegularColumns() interface{}
	SetRegularColumns(val interface{})
	Stack() awscdk.Stack
	TableName() *string
	SetTableName(val *string)
	Tags() awscdk.TagManager
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::Cassandra::Table`.

The `AWS::Cassandra::Table` resource allows you to create a new table in Amazon Keyspaces (for Apache Cassandra). For more information, see [Create a keyspace and a table](https://docs.aws.amazon.com/keyspaces/latest/devguide/getting-started.ddl.html) in the *Amazon Keyspaces Developer Guide* .

TODO: EXAMPLE

func NewCfnTable 

func NewCfnTable(scope constructs.Construct, id *string, props *CfnTableProps) CfnTable

Create a new `AWS::Cassandra::Table`.

type CfnTableProps 

type CfnTableProps struct {
	// The name of the keyspace in which to create the table.
	//
	// The keyspace must already exist.
	KeyspaceName *string `json:"keyspaceName" yaml:"keyspaceName"`
	// One or more columns that uniquely identify every row in the table.
	//
	// Every table must have a partition key.
	PartitionKeyColumns interface{} `json:"partitionKeyColumns" yaml:"partitionKeyColumns"`
	// 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.
	BillingMode interface{} `json:"billingMode" yaml:"billingMode"`
	// One or more columns that determine how the table data is sorted.
	ClusteringKeyColumns interface{} `json:"clusteringKeyColumns" yaml:"clusteringKeyColumns"`
	// The default Time To Live (TTL) value for all rows in a table in seconds.
	//
	// The maximum configurable value is 630,720,000 seconds, which is the equivalent of 20 years. By default, the TTL value for a table is 0, which means data does not expire.
	//
	// For more information, see [Setting the default TTL value for a table](https://docs.aws.amazon.com/keyspaces/latest/devguide/TTL-how-it-works.html#ttl-howitworks_default_ttl) in the *Amazon Keyspaces Developer Guide* .
	DefaultTimeToLive *float64 `json:"defaultTimeToLive" yaml:"defaultTimeToLive"`
	// 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](https://docs.aws.amazon.com/keyspaces/latest/devguide/EncryptionAtRest.html) in the *Amazon Keyspaces Developer Guide* .
	EncryptionSpecification interface{} `json:"encryptionSpecification" yaml:"encryptionSpecification"`
	// Specifies if point-in-time recovery is enabled or disabled for the table.
	//
	// The options are `PointInTimeRecoveryEnabled=true` and `PointInTimeRecoveryEnabled=false` . If not specified, the default is `PointInTimeRecoveryEnabled=false` .
	PointInTimeRecoveryEnabled interface{} `json:"pointInTimeRecoveryEnabled" yaml:"pointInTimeRecoveryEnabled"`
	// One or more columns that are not part of the primary key - that is, columns that are *not* defined as partition key columns or clustering key columns.
	//
	// You can add regular columns to existing tables by adding them to the template.
	RegularColumns interface{} `json:"regularColumns" yaml:"regularColumns"`
	// The name of the table to be created.
	//
	// The table name is case sensitive. If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the table name. For more information, see [Name type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html) .
	//
	// > If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
	//
	// *Length constraints:* Minimum length of 3. Maximum length of 255.
	//
	// *Pattern:* `^[a-zA-Z0-9][a-zA-Z0-9_]{1,47}$`
	TableName *string `json:"tableName" yaml:"tableName"`
	// A list of key-value pair tags to be attached to the resource.
	Tags *[]*awscdk.CfnTag `json:"tags" yaml:"tags"`
}

Properties for defining a `CfnTable`.

TODO: EXAMPLE

type CfnTable_BillingModeProperty 

type CfnTable_BillingModeProperty struct {
	// 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`
	Mode *string `json:"mode" yaml:"mode"`
	// The provisioned read capacity and write capacity for the table.
	//
	// For more information, see [Provisioned throughput capacity mode](https://docs.aws.amazon.com/keyspaces/latest/devguide/ReadWriteCapacityMode.html#ReadWriteCapacityMode.Provisioned) in the *Amazon Keyspaces Developer Guide* .
	ProvisionedThroughput interface{} `json:"provisionedThroughput" yaml:"provisionedThroughput"`
}

Determines the billing mode for the table - On-demand or provisioned.

TODO: EXAMPLE

type CfnTable_ClusteringKeyColumnProperty 

type CfnTable_ClusteringKeyColumnProperty struct {
	// The name and data type of this clustering key column.
	Column interface{} `json:"column" yaml:"column"`
	// The order in which this column's data is stored:.
	//
	// - `ASC` (default) - The column's data is stored in ascending order.
	// - `DESC` - The column's data is stored in descending order.
	OrderBy *string `json:"orderBy" yaml:"orderBy"`
}

Defines an individual column within the clustering key.

TODO: EXAMPLE

type CfnTable_ColumnProperty 

type CfnTable_ColumnProperty struct {
	// The name of the column.
	//
	// For more information, see [Identifiers](https://docs.aws.amazon.com/keyspaces/latest/devguide/cql.elements.html#cql.elements.identifier) in the *Amazon Keyspaces Developer Guide* .
	ColumnName *string `json:"columnName" yaml:"columnName"`
	// The data type of the column.
	//
	// For more information, see [Data types](https://docs.aws.amazon.com/keyspaces/latest/devguide/cql.elements.html#cql.data-types) in the *Amazon Keyspaces Developer Guide* .
	ColumnType *string `json:"columnType" yaml:"columnType"`
}

The name and data type of an individual column in a table.

TODO: EXAMPLE

type CfnTable_EncryptionSpecificationProperty 

type CfnTable_EncryptionSpecificationProperty struct {
	// 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` .
	EncryptionType *string `json:"encryptionType" yaml:"encryptionType"`
	// Requires a `kms_key_identifier` in the format of a key ARN.
	KmsKeyIdentifier *string `json:"kmsKeyIdentifier" yaml:"kmsKeyIdentifier"`
}

Specifies the encryption at rest option selected for the table.

TODO: EXAMPLE

type CfnTable_ProvisionedThroughputProperty 

type CfnTable_ProvisionedThroughputProperty struct {
	// The amount of read capacity that's provisioned for the table.
	//
	// For more information, see [Read/write capacity mode](https://docs.aws.amazon.com/keyspaces/latest/devguide/ReadWriteCapacityMode.html) in the *Amazon Keyspaces Developer Guide* .
	ReadCapacityUnits *float64 `json:"readCapacityUnits" yaml:"readCapacityUnits"`
	// The amount of write capacity that's provisioned for the table.
	//
	// For more information, see [Read/write capacity mode](https://docs.aws.amazon.com/keyspaces/latest/devguide/ReadWriteCapacityMode.html) in the *Amazon Keyspaces Developer Guide* .
	WriteCapacityUnits *float64 `json:"writeCapacityUnits" yaml:"writeCapacityUnits"`
}

The provisioned throughput for the table, which consists of `ReadCapacityUnits` and `WriteCapacityUnits` .

TODO: EXAMPLE

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.