Class: AWSCDK::Cassandra::CfnTable

Inherits:
AWSCDK::CfnResource
  • Object
show all
Includes:
IInspectable, ITaggable, Interfaces::AWSCassandra::ITableRef
Defined in:
cassandra/cfn_table.rb

Overview

You can use the AWS::Cassandra::Table resource to create a new table in Amazon Keyspaces (for Apache Cassandra).

For more information, see Create a table in the Amazon Keyspaces Developer Guide .

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnTable

Create a new AWS::Cassandra::Table.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

    Construct identifier for this resource (unique in its scope).

  • props (AWSCDK::Cassandra::CfnTableProps) —

    Resource properties.



20
21
22
23
24
25
26
 
# File 'cassandra/cfn_table.rb', line 20

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::Cassandra::CfnTableProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2Fzc2FuZHJhLkNmblRhYmxlUHJvcHMifQ==")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


187
188
189
 
# File 'cassandra/cfn_table.rb', line 187

def self.CFN_RESOURCE_TYPE_NAME()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_cassandra.CfnTable", "CFN_RESOURCE_TYPE_NAME")
end

.is_cfn_table(x) ⇒ Boolean

Checks whether the given object is a CfnTable.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


89
90
91
92
 
# File 'cassandra/cfn_table.rb', line 89

def self.is_cfn_table(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_cassandra.CfnTable", "isCfnTable", [x])
end

.jsii_overridable_methods ⇒ Object 



28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'cassandra/cfn_table.rb', line 28

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :creation_stack => { kind: :property, name: "creationStack", is_optional: false },
    :logical_id => { kind: :property, name: "logicalId", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :ref => { kind: :property, name: "ref", is_optional: false },
    :cfn_options => { kind: :property, name: "cfnOptions", is_optional: false },
    :cfn_properties => { kind: :property, name: "cfnProperties", is_optional: false },
    :cfn_property_names => { kind: :property, name: "cfnPropertyNames", is_optional: false },
    :cfn_resource_type => { kind: :property, name: "cfnResourceType", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :updated_properites => { kind: :property, name: "updatedProperites", is_optional: false },
    :updated_properties => { kind: :property, name: "updatedProperties", is_optional: false },
    :table_ref => { kind: :property, name: "tableRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :keyspace_name => { kind: :property, name: "keyspaceName", is_optional: false },
    :partition_key_columns => { kind: :property, name: "partitionKeyColumns", is_optional: false },
    :auto_scaling_specifications => { kind: :property, name: "autoScalingSpecifications", is_optional: true },
    :billing_mode => { kind: :property, name: "billingMode", is_optional: true },
    :cdc_specification => { kind: :property, name: "cdcSpecification", is_optional: true },
    :client_side_timestamps_enabled => { kind: :property, name: "clientSideTimestampsEnabled", is_optional: true },
    :clustering_key_columns => { kind: :property, name: "clusteringKeyColumns", is_optional: true },
    :default_time_to_live => { kind: :property, name: "defaultTimeToLive", is_optional: true },
    :encryption_specification => { kind: :property, name: "encryptionSpecification", is_optional: true },
    :point_in_time_recovery_enabled => { kind: :property, name: "pointInTimeRecoveryEnabled", is_optional: true },
    :regular_columns => { kind: :property, name: "regularColumns", is_optional: true },
    :replica_specifications => { kind: :property, name: "replicaSpecifications", is_optional: true },
    :table_name => { kind: :property, name: "tableName", is_optional: true },
    :tags_raw => { kind: :property, name: "tagsRaw", is_optional: true },
    :warm_throughput => { kind: :property, name: "warmThroughput", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :override_logical_id => { kind: :method, name: "overrideLogicalId", is_optional: false },
    :add_deletion_override => { kind: :method, name: "addDeletionOverride", is_optional: false },
    :add_dependency => { kind: :method, name: "addDependency", is_optional: false },
    :add_depends_on => { kind: :method, name: "addDependsOn", is_optional: false },
    :add_metadata => { kind: :method, name: "addMetadata", is_optional: false },
    :add_override => { kind: :method, name: "addOverride", is_optional: false },
    :add_property_deletion_override => { kind: :method, name: "addPropertyDeletionOverride", is_optional: false },
    :add_property_override => { kind: :method, name: "addPropertyOverride", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :cfn_property_name => { kind: :method, name: "cfnPropertyName", is_optional: false },
    :get_att => { kind: :method, name: "getAtt", is_optional: false },
    :get_metadata => { kind: :method, name: "getMetadata", is_optional: false },
    :obtain_dependencies => { kind: :method, name: "obtainDependencies", is_optional: false },
    :obtain_resource_dependencies => { kind: :method, name: "obtainResourceDependencies", is_optional: false },
    :remove_dependency => { kind: :method, name: "removeDependency", is_optional: false },
    :render_properties => { kind: :method, name: "renderProperties", is_optional: false },
    :replace_dependency => { kind: :method, name: "replaceDependency", is_optional: false },
    :should_synthesize => { kind: :method, name: "shouldSynthesize", is_optional: false },
    :validate_properties => { kind: :method, name: "validateProperties", is_optional: false },
    :inspect => { kind: :method, name: "inspect", is_optional: false },
  }
end

Instance Method Details

#add_deletion_override(path) ⇒ void

This method returns an undefined value.

Syntactic sugar for addOverride(path, undefined).

Parameters:

  • path (String) —

    The path of the value to delete.



427
428
429
430
 
# File 'cassandra/cfn_table.rb', line 427

def add_deletion_override(path)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  jsii_call_method("addDeletionOverride", [path])
end

#add_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:



439
440
441
442
 
# File 'cassandra/cfn_table.rb', line 439

def add_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependency", [target])
end

#add_depends_on(target) ⇒ void

Deprecated.

use addDependency

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:



449
450
451
452
 
# File 'cassandra/cfn_table.rb', line 449

def add_depends_on(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependsOn", [target])
end

#add_metadata(key, value) ⇒ void

This method returns an undefined value.

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (String)
  • value (Object)

See Also:



460
461
462
463
464
 
# File 'cassandra/cfn_table.rb', line 460

def add_metadata(key, value)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addMetadata", [key, value])
end

#add_override(path, value) ⇒ void

This method returns an undefined value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use add_property_override or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

# Example automatically generated from non-compiling source. May contain errors.
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to add_override will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (String) —
    • The path of the property, you can use dot notation to override values in complex types.
  • value (Object) —
    • The value.


517
518
519
520
521
 
# File 'cassandra/cfn_table.rb', line 517

def add_override(path, value)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addOverride", [path, value])
end

#add_property_deletion_override(property_path) ⇒ void

This method returns an undefined value.

Adds an override that deletes the value of a property from the resource definition.

Parameters:

  • property_path (String) —

    The path to the property.



527
528
529
530
 
# File 'cassandra/cfn_table.rb', line 527

def add_property_deletion_override(property_path)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  jsii_call_method("addPropertyDeletionOverride", [property_path])
end

#add_property_override(property_path, value) ⇒ void

This method returns an undefined value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (String) —

    The path of the property.

  • value (Object) —

    The value.



539
540
541
542
543
 
# File 'cassandra/cfn_table.rb', line 539

def add_property_override(property_path, value)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addPropertyOverride", [property_path, value])
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.

Parameters:



552
553
554
555
 
# File 'cassandra/cfn_table.rb', line 552

def apply_cross_stack_reference_strength(strength)
  Jsii::Type.check_type(strength, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZWZlcmVuY2VTdHJlbmd0aCJ9")), "strength")
  jsii_call_method("applyCrossStackReferenceStrength", [strength])
end

#apply_removal_policy(policy = nil, options = nil) ⇒ void

This method returns an undefined value.

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

See Also:



574
575
576
577
578
579
 
# File 'cassandra/cfn_table.rb', line 574

def apply_removal_policy(policy = nil, options = nil)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy") unless policy.nil?
  options = options.is_a?(Hash) ? ::AWSCDK::RemovalPolicyOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5T3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("applyRemovalPolicy", [policy, options])
end

#auto_scaling_specifications ⇒ AWSCDK::IResolvable, ...

The optional auto scaling capacity settings for a table in provisioned capacity mode.

Returns:



232
233
234
 
# File 'cassandra/cfn_table.rb', line 232

def auto_scaling_specifications()
  jsii_get_property("autoScalingSpecifications")
end

#auto_scaling_specifications=(value) ⇒ Object 



236
237
238
239
240
 
# File 'cassandra/cfn_table.rb', line 236

def auto_scaling_specifications=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Cassandra::CfnTable::AutoScalingSpecificationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jYXNzYW5kcmEuQ2ZuVGFibGUuQXV0b1NjYWxpbmdTcGVjaWZpY2F0aW9uUHJvcGVydHkifV19fQ==")), "autoScalingSpecifications") unless value.nil?
  jsii_set_property("autoScalingSpecifications", value)
end

#billing_mode ⇒ AWSCDK::IResolvable, ...

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

Returns:



245
246
247
 
# File 'cassandra/cfn_table.rb', line 245

def billing_mode()
  jsii_get_property("billingMode")
end

#billing_mode=(value) ⇒ Object 



249
250
251
252
253
 
# File 'cassandra/cfn_table.rb', line 249

def billing_mode=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Cassandra::CfnTable::BillingModeProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jYXNzYW5kcmEuQ2ZuVGFibGUuQmlsbGluZ01vZGVQcm9wZXJ0eSJ9XX19")), "billingMode") unless value.nil?
  jsii_set_property("billingMode", value)
end

#cdc_specification ⇒ AWSCDK::IResolvable, ...

The settings for the CDC stream of a table.

Returns:



258
259
260
 
# File 'cassandra/cfn_table.rb', line 258

def cdc_specification()
  jsii_get_property("cdcSpecification")
end

#cdc_specification=(value) ⇒ Object 



262
263
264
265
266
 
# File 'cassandra/cfn_table.rb', line 262

def cdc_specification=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Cassandra::CfnTable::CdcSpecificationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jYXNzYW5kcmEuQ2ZuVGFibGUuQ2RjU3BlY2lmaWNhdGlvblByb3BlcnR5In1dfX0=")), "cdcSpecification") unless value.nil?
  jsii_set_property("cdcSpecification", value)
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

Returns:



140
141
142
 
# File 'cassandra/cfn_table.rb', line 140

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


145
146
147
 
# File 'cassandra/cfn_table.rb', line 145

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


583
584
585
586
 
# File 'cassandra/cfn_table.rb', line 583

def cfn_property_name(cdk_property_name)
  Jsii::Type.check_type(cdk_property_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cdkPropertyName")
  jsii_call_method("cfnPropertyName", [cdk_property_name])
end

#cfn_property_names ⇒ Hash{String => String}

Returns:

  • (Hash{String => String}) 


150
151
152
 
# File 'cassandra/cfn_table.rb', line 150

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


157
158
159
 
# File 'cassandra/cfn_table.rb', line 157

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#client_side_timestamps_enabled ⇒ Boolean, ...

Enables client-side timestamps for the table.

Returns:



271
272
273
 
# File 'cassandra/cfn_table.rb', line 271

def client_side_timestamps_enabled()
  jsii_get_property("clientSideTimestampsEnabled")
end

#client_side_timestamps_enabled=(value) ⇒ Object 



275
276
277
278
 
# File 'cassandra/cfn_table.rb', line 275

def client_side_timestamps_enabled=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "clientSideTimestampsEnabled") unless value.nil?
  jsii_set_property("clientSideTimestampsEnabled", value)
end

#clustering_key_columns ⇒ AWSCDK::IResolvable, ...

One or more columns that determine how the table data is sorted.

Returns:



283
284
285
 
# File 'cassandra/cfn_table.rb', line 283

def clustering_key_columns()
  jsii_get_property("clusteringKeyColumns")
end

#clustering_key_columns=(value) ⇒ Object 



287
288
289
290
 
# File 'cassandra/cfn_table.rb', line 287

def clustering_key_columns=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2Fzc2FuZHJhLkNmblRhYmxlLkNsdXN0ZXJpbmdLZXlDb2x1bW5Qcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "clusteringKeyColumns") unless value.nil?
  jsii_set_property("clusteringKeyColumns", value)
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


102
103
104
 
# File 'cassandra/cfn_table.rb', line 102

def creation_stack()
  jsii_get_property("creationStack")
end

#default_time_to_live ⇒ Numeric?

The default Time To Live (TTL) value for all rows in a table in seconds.

Returns:

  • (Numeric, nil) 


295
296
297
 
# File 'cassandra/cfn_table.rb', line 295

def default_time_to_live()
  jsii_get_property("defaultTimeToLive")
end

#default_time_to_live=(value) ⇒ Object 



299
300
301
302
 
# File 'cassandra/cfn_table.rb', line 299

def default_time_to_live=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "defaultTimeToLive") unless value.nil?
  jsii_set_property("defaultTimeToLive", value)
end

#encryption_specification ⇒ AWSCDK::IResolvable, ...

The encryption at rest options for the table.

Returns:



307
308
309
 
# File 'cassandra/cfn_table.rb', line 307

def encryption_specification()
  jsii_get_property("encryptionSpecification")
end

#encryption_specification=(value) ⇒ Object 



311
312
313
314
315
 
# File 'cassandra/cfn_table.rb', line 311

def encryption_specification=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Cassandra::CfnTable::EncryptionSpecificationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jYXNzYW5kcmEuQ2ZuVGFibGUuRW5jcnlwdGlvblNwZWNpZmljYXRpb25Qcm9wZXJ0eSJ9XX19")), "encryptionSpecification") unless value.nil?
  jsii_set_property("encryptionSpecification", value)
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



162
163
164
 
# File 'cassandra/cfn_table.rb', line 162

def env()
  jsii_get_property("env")
end

#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

Returns:



596
597
598
599
600
 
# File 'cassandra/cfn_table.rb', line 596

def get_att(attribute_name, type_hint = nil)
  Jsii::Type.check_type(attribute_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "attributeName")
  Jsii::Type.check_type(type_hint, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZXNvbHV0aW9uVHlwZUhpbnQifQ==")), "typeHint") unless type_hint.nil?
  jsii_call_method("getAtt", [attribute_name, type_hint])
end

#get_metadata(key) ⇒ Object

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

  • key (String)

Returns:

  • (Object)

See Also:



607
608
609
610
 
# File 'cassandra/cfn_table.rb', line 607

def get_metadata(key)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  jsii_call_method("getMetadata", [key])
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



677
678
679
680
 
# File 'cassandra/cfn_table.rb', line 677

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
end

#keyspace_name ⇒ String

The name of the keyspace to create the table in.

Returns:

  • (String) 


208
209
210
 
# File 'cassandra/cfn_table.rb', line 208

def keyspace_name()
  jsii_get_property("keyspaceName")
end

#keyspace_name=(value) ⇒ Object 



212
213
214
215
 
# File 'cassandra/cfn_table.rb', line 212

def keyspace_name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "keyspaceName")
  jsii_set_property("keyspaceName", value)
end

#logical_id ⇒ String

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use override_logical_id(new_logical_id).

Returns:

  • (String) 


114
115
116
 
# File 'cassandra/cfn_table.rb', line 114

def logical_id()
  jsii_get_property("logicalId")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


97
98
99
 
# File 'cassandra/cfn_table.rb', line 97

def node()
  jsii_get_property("node")
end

#obtain_dependencies ⇒ Array<AWSCDK::CfnResource, AWSCDK::Stack>

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Returns:



618
619
620
 
# File 'cassandra/cfn_table.rb', line 618

def obtain_dependencies()
  jsii_call_method("obtainDependencies", [])
end

#obtain_resource_dependencies ⇒ Array<AWSCDK::CfnResource>

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Returns:



625
626
627
 
# File 'cassandra/cfn_table.rb', line 625

def obtain_resource_dependencies()
  jsii_call_method("obtainResourceDependencies", [])
end

#override_logical_id(new_logical_id) ⇒ void

This method returns an undefined value.

Overrides the auto-generated logical ID with a specific ID.

Parameters:

  • new_logical_id (String) —

    The new logical ID to use for this stack element.



418
419
420
421
 
# File 'cassandra/cfn_table.rb', line 418

def override_logical_id(new_logical_id)
  Jsii::Type.check_type(new_logical_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "newLogicalId")
  jsii_call_method("overrideLogicalId", [new_logical_id])
end

#partition_key_columns ⇒ AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::Cassandra::CfnTable::ColumnProperty>

One or more columns that uniquely identify every row in the table.

Returns:



220
221
222
 
# File 'cassandra/cfn_table.rb', line 220

def partition_key_columns()
  jsii_get_property("partitionKeyColumns")
end

#partition_key_columns=(value) ⇒ Object 



224
225
226
227
 
# File 'cassandra/cfn_table.rb', line 224

def partition_key_columns=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2Fzc2FuZHJhLkNmblRhYmxlLkNvbHVtblByb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "partitionKeyColumns")
  jsii_set_property("partitionKeyColumns", value)
end

#point_in_time_recovery_enabled ⇒ Boolean, ...

Specifies if point-in-time recovery is enabled or disabled for the table.

Returns:



320
321
322
 
# File 'cassandra/cfn_table.rb', line 320

def point_in_time_recovery_enabled()
  jsii_get_property("pointInTimeRecoveryEnabled")
end

#point_in_time_recovery_enabled=(value) ⇒ Object 



324
325
326
327
 
# File 'cassandra/cfn_table.rb', line 324

def point_in_time_recovery_enabled=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "pointInTimeRecoveryEnabled") unless value.nil?
  jsii_set_property("pointInTimeRecoveryEnabled", value)
end

#ref ⇒ String

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Returns:

  • (String) 


133
134
135
 
# File 'cassandra/cfn_table.rb', line 133

def ref()
  jsii_get_property("ref")
end

#regular_columns ⇒ AWSCDK::IResolvable, ...

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.

Returns:



332
333
334
 
# File 'cassandra/cfn_table.rb', line 332

def regular_columns()
  jsii_get_property("regularColumns")
end

#regular_columns=(value) ⇒ Object 



336
337
338
339
 
# File 'cassandra/cfn_table.rb', line 336

def regular_columns=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2Fzc2FuZHJhLkNmblRhYmxlLkNvbHVtblByb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "regularColumns") unless value.nil?
  jsii_set_property("regularColumns", value)
end

#remove_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:



636
637
638
639
 
# File 'cassandra/cfn_table.rb', line 636

def remove_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("removeDependency", [target])
end

#render_properties(props) ⇒ Hash{String => Object}

Parameters:

  • props (Hash{String => Object})

Returns:

  • (Hash{String => Object}) 


643
644
645
646
 
# File 'cassandra/cfn_table.rb', line 643

def render_properties(props)
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "props")
  jsii_call_method("renderProperties", [props])
end

#replace_dependency(target, new_target) ⇒ void

This method returns an undefined value.

Replaces one dependency with another.

Parameters:



653
654
655
656
657
 
# File 'cassandra/cfn_table.rb', line 653

def replace_dependency(target, new_target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  Jsii::Type.check_type(new_target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "newTarget")
  jsii_call_method("replaceDependency", [target, new_target])
end

#replica_specifications ⇒ AWSCDK::IResolvable, ...

The AWS Region specific settings of a multi-Region table.

Returns:



344
345
346
 
# File 'cassandra/cfn_table.rb', line 344

def replica_specifications()
  jsii_get_property("replicaSpecifications")
end

#replica_specifications=(value) ⇒ Object 



348
349
350
351
 
# File 'cassandra/cfn_table.rb', line 348

def replica_specifications=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2Fzc2FuZHJhLkNmblRhYmxlLlJlcGxpY2FTcGVjaWZpY2F0aW9uUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "replicaSpecifications") unless value.nil?
  jsii_set_property("replicaSpecifications", value)
end

#should_synthesize ⇒ Boolean

Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.

Returns:

  • (Boolean) —

    true if the resource should be included or false is the resource should be omitted.



662
663
664
 
# File 'cassandra/cfn_table.rb', line 662

def should_synthesize()
  jsii_call_method("shouldSynthesize", [])
end

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Returns:



123
124
125
 
# File 'cassandra/cfn_table.rb', line 123

def stack()
  jsii_get_property("stack")
end

#table_name ⇒ String?

The name of the table to be created.

Returns:

  • (String, nil) 


356
357
358
 
# File 'cassandra/cfn_table.rb', line 356

def table_name()
  jsii_get_property("tableName")
end

#table_name=(value) ⇒ Object 



360
361
362
363
 
# File 'cassandra/cfn_table.rb', line 360

def table_name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "tableName") unless value.nil?
  jsii_set_property("tableName", value)
end

#table_ref ⇒ AWSCDK::Interfaces::AWSCassandra::TableReference

A reference to a Table resource.

Returns:



194
195
196
 
# File 'cassandra/cfn_table.rb', line 194

def table_ref()
  jsii_get_property("tableRef")
end

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



201
202
203
 
# File 'cassandra/cfn_table.rb', line 201

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Array<AWSCDK::CfnTag>?

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

Returns:



368
369
370
 
# File 'cassandra/cfn_table.rb', line 368

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



372
373
374
375
376
 
# File 'cassandra/cfn_table.rb', line 372

def tags_raw=(value)
  value = value.is_a?(Array) ? value.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tagsRaw") unless value.nil?
  jsii_set_property("tagsRaw", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



394
395
396
 
# File 'cassandra/cfn_table.rb', line 394

def to_string()
  jsii_call_method("toString", [])
end

#updated_properites ⇒ Hash{String => Object}

Deprecated.

use updatedProperties Return properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Deprecated.

Returns:

  • (Hash{String => Object}) 


170
171
172
 
# File 'cassandra/cfn_table.rb', line 170

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_properties ⇒ Hash{String => Object}

Return properties modified after initiation.

Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Returns:

  • (Hash{String => Object}) 


180
181
182
 
# File 'cassandra/cfn_table.rb', line 180

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


668
669
670
671
 
# File 'cassandra/cfn_table.rb', line 668

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
end

#warm_throughput ⇒ AWSCDK::IResolvable, ...

Warm throughput configuration for the table.

Returns:



381
382
383
 
# File 'cassandra/cfn_table.rb', line 381

def warm_throughput()
  jsii_get_property("warmThroughput")
end

#warm_throughput=(value) ⇒ Object 



385
386
387
388
389
 
# File 'cassandra/cfn_table.rb', line 385

def warm_throughput=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Cassandra::CfnTable::WarmThroughputProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jYXNzYW5kcmEuQ2ZuVGFibGUuV2FybVRocm91Z2hwdXRQcm9wZXJ0eSJ9XX19")), "warmThroughput") unless value.nil?
  jsii_set_property("warmThroughput", value)
end

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct) 


407
408
409
410
411
412
 
# File 'cassandra/cfn_table.rb', line 407

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end