Class: AWSCDK::DynamoDB::CfnTable

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggable, Interfaces::AWSDynamodb::ITableRef
Defined in:
dynamo_db/cfn_table.rb

Overview

The AWS::DynamoDB::Table resource creates a DynamoDB table. For more information, see CreateTable in the Amazon DynamoDB API Reference .

You should be aware of the following behaviors when working with DynamoDB tables:

  • AWS CloudFormation typically creates DynamoDB tables in parallel. However, if your template includes multiple DynamoDB tables with indexes, you must declare dependencies so that the tables are created sequentially. Amazon DynamoDB limits the number of tables with secondary indexes that are in the creating state. If you create multiple tables with indexes at the same time, DynamoDB returns an error and the stack operation fails. For an example, see DynamoDB Table with a DependsOn Attribute .

Our guidance is to use the latest schema documented for your AWS CloudFormation templates. This schema supports the provisioning of all table settings below. When using this schema in your AWS CloudFormation templates, please ensure that your Identity and Access Management ( IAM ) policies are updated with appropriate permissions to allow for the authorization of these setting changes.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnTable

Create a new AWS::DynamoDB::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::DynamoDB::CfnTableProps) —

    Resource properties.



24
25
26
27
28
29
30
 
# File 'dynamo_db/cfn_table.rb', line 24

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::DynamoDB::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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZHluYW1vZGIuQ2ZuVGFibGVQcm9wcyJ9")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.arn_for_table(resource) ⇒ String

Parameters:

Returns:

  • (String) 


98
99
100
101
 
# File 'dynamo_db/cfn_table.rb', line 98

def self.arn_for_table(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19keW5hbW9kYi5JVGFibGVSZWYifQ==")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_dynamodb.CfnTable", "arnForTable", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


231
232
233
 
# File 'dynamo_db/cfn_table.rb', line 231

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

.from_table_arn(scope, id, arn) ⇒ AWSCDK::Interfaces::AWSDynamodb::ITableRef

Creates a new ITableRef from an ARN.

Parameters:

  • scope (Constructs::Construct)
  • id (String)
  • arn (String)

Returns:



109
110
111
112
113
114
 
# File 'dynamo_db/cfn_table.rb', line 109

def self.from_table_arn(scope, id, arn)
  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(arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "arn")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_dynamodb.CfnTable", "fromTableArn", [scope, id, arn])
end

.from_table_name(scope, id, table_name) ⇒ AWSCDK::Interfaces::AWSDynamodb::ITableRef

Creates a new ITableRef from a tableName.

Parameters:

  • scope (Constructs::Construct)
  • id (String)
  • table_name (String)

Returns:



122
123
124
125
126
127
 
# File 'dynamo_db/cfn_table.rb', line 122

def self.from_table_name(scope, id, table_name)
  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(table_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "tableName")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_dynamodb.CfnTable", "fromTableName", [scope, id, table_name])
end

.is_cfn_table(x) ⇒ Boolean

Checks whether the given object is a CfnTable.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


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

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_dynamodb.CfnTable", "isCfnTable", [x])
end

.jsii_overridable_methods ⇒ Object 



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
84
85
86
87
88
89
90
91
92
93
94
 
# File 'dynamo_db/cfn_table.rb', line 32

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 },
    :attr_arn => { kind: :property, name: "attrArn", is_optional: false },
    :attr_stream_arn => { kind: :property, name: "attrStreamArn", is_optional: false },
    :table_ref => { kind: :property, name: "tableRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :key_schema => { kind: :property, name: "keySchema", is_optional: false },
    :attribute_definitions => { kind: :property, name: "attributeDefinitions", is_optional: true },
    :billing_mode => { kind: :property, name: "billingMode", is_optional: true },
    :contributor_insights_specification => { kind: :property, name: "contributorInsightsSpecification", is_optional: true },
    :deletion_protection_enabled => { kind: :property, name: "deletionProtectionEnabled", is_optional: true },
    :global_secondary_indexes => { kind: :property, name: "globalSecondaryIndexes", is_optional: true },
    :import_source_specification => { kind: :property, name: "importSourceSpecification", is_optional: true },
    :kinesis_stream_specification => { kind: :property, name: "kinesisStreamSpecification", is_optional: true },
    :local_secondary_indexes => { kind: :property, name: "localSecondaryIndexes", is_optional: true },
    :on_demand_throughput => { kind: :property, name: "onDemandThroughput", is_optional: true },
    :point_in_time_recovery_specification => { kind: :property, name: "pointInTimeRecoverySpecification", is_optional: true },
    :provisioned_throughput => { kind: :property, name: "provisionedThroughput", is_optional: true },
    :resource_policy => { kind: :property, name: "resourcePolicy", is_optional: true },
    :sse_specification => { kind: :property, name: "sseSpecification", is_optional: true },
    :stream_specification => { kind: :property, name: "streamSpecification", is_optional: true },
    :table_class => { kind: :property, name: "tableClass", is_optional: true },
    :table_name => { kind: :property, name: "tableName", is_optional: true },
    :tags_raw => { kind: :property, name: "tagsRaw", is_optional: true },
    :time_to_live_specification => { kind: :property, name: "timeToLiveSpecification", 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.



555
556
557
558
 
# File 'dynamo_db/cfn_table.rb', line 555

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:



567
568
569
570
 
# File 'dynamo_db/cfn_table.rb', line 567

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:



577
578
579
580
 
# File 'dynamo_db/cfn_table.rb', line 577

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:



588
589
590
591
592
 
# File 'dynamo_db/cfn_table.rb', line 588

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.


645
646
647
648
649
 
# File 'dynamo_db/cfn_table.rb', line 645

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.



655
656
657
658
 
# File 'dynamo_db/cfn_table.rb', line 655

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.



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

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:



680
681
682
683
 
# File 'dynamo_db/cfn_table.rb', line 680

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:



702
703
704
705
706
707
 
# File 'dynamo_db/cfn_table.rb', line 702

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

#attr_arn ⇒ String

The Amazon Resource Name (ARN) of the DynamoDB table, such as arn:aws:dynamodb:us-east-2:123456789012:table/myDynamoDBTable .

Returns:

  • (String) 


238
239
240
 
# File 'dynamo_db/cfn_table.rb', line 238

def attr_arn()
  jsii_get_property("attrArn")
end

#attr_stream_arn ⇒ String

The ARN of the DynamoDB stream, such as arn:aws:dynamodb:us-east-1:123456789012:table/testddbstack-myDynamoDBTable-012A1SL7SMP5Q/stream/2015-11-30T20:10:00.000 .

You must specify the StreamSpecification property to use this attribute.

Returns:

  • (String) 


247
248
249
 
# File 'dynamo_db/cfn_table.rb', line 247

def attr_stream_arn()
  jsii_get_property("attrStreamArn")
end

#attribute_definitions ⇒ AWSCDK::IResolvable, ...

A list of attributes that describe the key schema for the table and indexes.

Returns:



280
281
282
 
# File 'dynamo_db/cfn_table.rb', line 280

def attribute_definitions()
  jsii_get_property("attributeDefinitions")
end

#attribute_definitions=(value) ⇒ Object 



284
285
286
287
 
# File 'dynamo_db/cfn_table.rb', line 284

def attribute_definitions=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZHluYW1vZGIuQ2ZuVGFibGUuQXR0cmlidXRlRGVmaW5pdGlvblByb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "attributeDefinitions") unless value.nil?
  jsii_set_property("attributeDefinitions", value)
end

#billing_mode ⇒ String?

Specify how you are charged for read and write throughput and how you manage capacity.

Returns:

  • (String, nil) 


292
293
294
 
# File 'dynamo_db/cfn_table.rb', line 292

def billing_mode()
  jsii_get_property("billingMode")
end

#billing_mode=(value) ⇒ Object 



296
297
298
299
 
# File 'dynamo_db/cfn_table.rb', line 296

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

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



184
185
186
 
# File 'dynamo_db/cfn_table.rb', line 184

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


189
190
191
 
# File 'dynamo_db/cfn_table.rb', line 189

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


711
712
713
714
 
# File 'dynamo_db/cfn_table.rb', line 711

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}) 


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

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


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

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#contributor_insights_specification ⇒ AWSCDK::IResolvable, ...

The settings used to specify whether to enable CloudWatch Contributor Insights for the table and define which events to monitor.

Returns:



304
305
306
 
# File 'dynamo_db/cfn_table.rb', line 304

def contributor_insights_specification()
  jsii_get_property("contributorInsightsSpecification")
end

#contributor_insights_specification=(value) ⇒ Object 



308
309
310
311
312
 
# File 'dynamo_db/cfn_table.rb', line 308

def contributor_insights_specification=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::DynamoDB::CfnTable::ContributorInsightsSpecificationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19keW5hbW9kYi5DZm5UYWJsZS5Db250cmlidXRvckluc2lnaHRzU3BlY2lmaWNhdGlvblByb3BlcnR5In1dfX0=")), "contributorInsightsSpecification") unless value.nil?
  jsii_set_property("contributorInsightsSpecification", value)
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


146
147
148
 
# File 'dynamo_db/cfn_table.rb', line 146

def creation_stack()
  jsii_get_property("creationStack")
end

#deletion_protection_enabled ⇒ Boolean, ...

Determines if a table is protected from deletion.

Returns:



317
318
319
 
# File 'dynamo_db/cfn_table.rb', line 317

def deletion_protection_enabled()
  jsii_get_property("deletionProtectionEnabled")
end

#deletion_protection_enabled=(value) ⇒ Object 



321
322
323
324
 
# File 'dynamo_db/cfn_table.rb', line 321

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

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



206
207
208
 
# File 'dynamo_db/cfn_table.rb', line 206

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:



724
725
726
727
728
 
# File 'dynamo_db/cfn_table.rb', line 724

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:



735
736
737
738
 
# File 'dynamo_db/cfn_table.rb', line 735

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

#global_secondary_indexes ⇒ AWSCDK::IResolvable, ...

Global secondary indexes to be created on the table.

You can create up to 20 global secondary indexes.

Returns:



331
332
333
 
# File 'dynamo_db/cfn_table.rb', line 331

def global_secondary_indexes()
  jsii_get_property("globalSecondaryIndexes")
end

#global_secondary_indexes=(value) ⇒ Object 



335
336
337
338
 
# File 'dynamo_db/cfn_table.rb', line 335

def global_secondary_indexes=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZHluYW1vZGIuQ2ZuVGFibGUuR2xvYmFsU2Vjb25kYXJ5SW5kZXhQcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "globalSecondaryIndexes") unless value.nil?
  jsii_set_property("globalSecondaryIndexes", value)
end

#import_source_specification ⇒ AWSCDK::IResolvable, ...

Specifies the properties of data being imported from the S3 bucket source to the" table.

Returns:



343
344
345
 
# File 'dynamo_db/cfn_table.rb', line 343

def import_source_specification()
  jsii_get_property("importSourceSpecification")
end

#import_source_specification=(value) ⇒ Object 



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

def import_source_specification=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::DynamoDB::CfnTable::ImportSourceSpecificationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19keW5hbW9kYi5DZm5UYWJsZS5JbXBvcnRTb3VyY2VTcGVjaWZpY2F0aW9uUHJvcGVydHkifV19fQ==")), "importSourceSpecification") unless value.nil?
  jsii_set_property("importSourceSpecification", value)
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



805
806
807
808
 
# File 'dynamo_db/cfn_table.rb', line 805

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

#key_schema ⇒ AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::DynamoDB::CfnTable::KeySchemaProperty>

Specifies the attributes that make up the primary key for the table.

Returns:



268
269
270
 
# File 'dynamo_db/cfn_table.rb', line 268

def key_schema()
  jsii_get_property("keySchema")
end

#key_schema=(value) ⇒ Object 



272
273
274
275
 
# File 'dynamo_db/cfn_table.rb', line 272

def key_schema=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZHluYW1vZGIuQ2ZuVGFibGUuS2V5U2NoZW1hUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "keySchema")
  jsii_set_property("keySchema", value)
end

#kinesis_stream_specification ⇒ AWSCDK::IResolvable, ...

The Kinesis Data Streams configuration for the specified table.

Returns:



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

def kinesis_stream_specification()
  jsii_get_property("kinesisStreamSpecification")
end

#kinesis_stream_specification=(value) ⇒ Object 



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

def kinesis_stream_specification=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::DynamoDB::CfnTable::KinesisStreamSpecificationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19keW5hbW9kYi5DZm5UYWJsZS5LaW5lc2lzU3RyZWFtU3BlY2lmaWNhdGlvblByb3BlcnR5In1dfX0=")), "kinesisStreamSpecification") unless value.nil?
  jsii_set_property("kinesisStreamSpecification", value)
end

#local_secondary_indexes ⇒ AWSCDK::IResolvable, ...

Local secondary indexes to be created on the table.

Returns:



369
370
371
 
# File 'dynamo_db/cfn_table.rb', line 369

def local_secondary_indexes()
  jsii_get_property("localSecondaryIndexes")
end

#local_secondary_indexes=(value) ⇒ Object 



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

def local_secondary_indexes=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZHluYW1vZGIuQ2ZuVGFibGUuTG9jYWxTZWNvbmRhcnlJbmRleFByb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "localSecondaryIndexes") unless value.nil?
  jsii_set_property("localSecondaryIndexes", 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) 


158
159
160
 
# File 'dynamo_db/cfn_table.rb', line 158

def logical_id()
  jsii_get_property("logicalId")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


141
142
143
 
# File 'dynamo_db/cfn_table.rb', line 141

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:



746
747
748
 
# File 'dynamo_db/cfn_table.rb', line 746

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:



753
754
755
 
# File 'dynamo_db/cfn_table.rb', line 753

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

#on_demand_throughput ⇒ AWSCDK::IResolvable, ...

Sets the maximum number of read and write units for the specified on-demand table.

Returns:



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

def on_demand_throughput()
  jsii_get_property("onDemandThroughput")
end

#on_demand_throughput=(value) ⇒ Object 



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

def on_demand_throughput=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::DynamoDB::CfnTable::OnDemandThroughputProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19keW5hbW9kYi5DZm5UYWJsZS5PbkRlbWFuZFRocm91Z2hwdXRQcm9wZXJ0eSJ9XX19")), "onDemandThroughput") unless value.nil?
  jsii_set_property("onDemandThroughput", value)
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.



546
547
548
549
 
# File 'dynamo_db/cfn_table.rb', line 546

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

#point_in_time_recovery_specification ⇒ AWSCDK::IResolvable, ...

The settings used to enable point in time recovery.

Returns:



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

def point_in_time_recovery_specification()
  jsii_get_property("pointInTimeRecoverySpecification")
end

#point_in_time_recovery_specification=(value) ⇒ Object 



398
399
400
401
402
 
# File 'dynamo_db/cfn_table.rb', line 398

def point_in_time_recovery_specification=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::DynamoDB::CfnTable::PointInTimeRecoverySpecificationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19keW5hbW9kYi5DZm5UYWJsZS5Qb2ludEluVGltZVJlY292ZXJ5U3BlY2lmaWNhdGlvblByb3BlcnR5In1dfX0=")), "pointInTimeRecoverySpecification") unless value.nil?
  jsii_set_property("pointInTimeRecoverySpecification", value)
end

#provisioned_throughput ⇒ AWSCDK::IResolvable, ...

Throughput for the specified table, which consists of values for ReadCapacityUnits and WriteCapacityUnits .

Returns:



407
408
409
 
# File 'dynamo_db/cfn_table.rb', line 407

def provisioned_throughput()
  jsii_get_property("provisionedThroughput")
end

#provisioned_throughput=(value) ⇒ Object 



411
412
413
414
415
 
# File 'dynamo_db/cfn_table.rb', line 411

def provisioned_throughput=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::DynamoDB::CfnTable::ProvisionedThroughputProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19keW5hbW9kYi5DZm5UYWJsZS5Qcm92aXNpb25lZFRocm91Z2hwdXRQcm9wZXJ0eSJ9XX19")), "provisionedThroughput") unless value.nil?
  jsii_set_property("provisionedThroughput", 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) 


177
178
179
 
# File 'dynamo_db/cfn_table.rb', line 177

def ref()
  jsii_get_property("ref")
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:



764
765
766
767
 
# File 'dynamo_db/cfn_table.rb', line 764

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}) 


771
772
773
774
 
# File 'dynamo_db/cfn_table.rb', line 771

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:



781
782
783
784
785
 
# File 'dynamo_db/cfn_table.rb', line 781

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

#resource_policy ⇒ AWSCDK::IResolvable, ...

An AWS resource-based policy document in JSON format that will be attached to the table.

Returns:



420
421
422
 
# File 'dynamo_db/cfn_table.rb', line 420

def resource_policy()
  jsii_get_property("resourcePolicy")
end

#resource_policy=(value) ⇒ Object 



424
425
426
427
428
 
# File 'dynamo_db/cfn_table.rb', line 424

def resource_policy=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::DynamoDB::CfnTable::ResourcePolicyProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19keW5hbW9kYi5DZm5UYWJsZS5SZXNvdXJjZVBvbGljeVByb3BlcnR5In1dfX0=")), "resourcePolicy") unless value.nil?
  jsii_set_property("resourcePolicy", 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.



790
791
792
 
# File 'dynamo_db/cfn_table.rb', line 790

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

#sse_specification ⇒ AWSCDK::IResolvable, ...

Specifies the settings to enable server-side encryption.

Returns:



433
434
435
 
# File 'dynamo_db/cfn_table.rb', line 433

def sse_specification()
  jsii_get_property("sseSpecification")
end

#sse_specification=(value) ⇒ Object 



437
438
439
440
441
 
# File 'dynamo_db/cfn_table.rb', line 437

def sse_specification=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::DynamoDB::CfnTable::SSESpecificationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19keW5hbW9kYi5DZm5UYWJsZS5TU0VTcGVjaWZpY2F0aW9uUHJvcGVydHkifV19fQ==")), "sseSpecification") unless value.nil?
  jsii_set_property("sseSpecification", value)
end

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

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

Returns:



167
168
169
 
# File 'dynamo_db/cfn_table.rb', line 167

def stack()
  jsii_get_property("stack")
end

#stream_specification ⇒ AWSCDK::IResolvable, ...

The settings for the DynamoDB table stream, which captures changes to items stored in the table.

Returns:



446
447
448
 
# File 'dynamo_db/cfn_table.rb', line 446

def stream_specification()
  jsii_get_property("streamSpecification")
end

#stream_specification=(value) ⇒ Object 



450
451
452
453
454
 
# File 'dynamo_db/cfn_table.rb', line 450

def stream_specification=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::DynamoDB::CfnTable::StreamSpecificationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19keW5hbW9kYi5DZm5UYWJsZS5TdHJlYW1TcGVjaWZpY2F0aW9uUHJvcGVydHkifV19fQ==")), "streamSpecification") unless value.nil?
  jsii_set_property("streamSpecification", value)
end

#table_class ⇒ String?

The table class of the new table.

Returns:

  • (String, nil) 


459
460
461
 
# File 'dynamo_db/cfn_table.rb', line 459

def table_class()
  jsii_get_property("tableClass")
end

#table_class=(value) ⇒ Object 



463
464
465
466
 
# File 'dynamo_db/cfn_table.rb', line 463

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

#table_name ⇒ String?

A name for the table.

Returns:

  • (String, nil) 


471
472
473
 
# File 'dynamo_db/cfn_table.rb', line 471

def table_name()
  jsii_get_property("tableName")
end

#table_name=(value) ⇒ Object 



475
476
477
478
 
# File 'dynamo_db/cfn_table.rb', line 475

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::AWSDynamodb::TableReference

A reference to a Table resource.

Returns:



254
255
256
 
# File 'dynamo_db/cfn_table.rb', line 254

def table_ref()
  jsii_get_property("tableRef")
end

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



261
262
263
 
# File 'dynamo_db/cfn_table.rb', line 261

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Array<AWSCDK::CfnTag>?

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

Returns:



483
484
485
 
# File 'dynamo_db/cfn_table.rb', line 483

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



487
488
489
490
491
 
# File 'dynamo_db/cfn_table.rb', line 487

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

#time_to_live_specification ⇒ AWSCDK::IResolvable, ...

Specifies the Time to Live (TTL) settings for the table.

Returns:



496
497
498
 
# File 'dynamo_db/cfn_table.rb', line 496

def time_to_live_specification()
  jsii_get_property("timeToLiveSpecification")
end

#time_to_live_specification=(value) ⇒ Object 



500
501
502
503
504
 
# File 'dynamo_db/cfn_table.rb', line 500

def time_to_live_specification=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::DynamoDB::CfnTable::TimeToLiveSpecificationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19keW5hbW9kYi5DZm5UYWJsZS5UaW1lVG9MaXZlU3BlY2lmaWNhdGlvblByb3BlcnR5In1dfX0=")), "timeToLiveSpecification") unless value.nil?
  jsii_set_property("timeToLiveSpecification", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



522
523
524
 
# File 'dynamo_db/cfn_table.rb', line 522

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}) 


214
215
216
 
# File 'dynamo_db/cfn_table.rb', line 214

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}) 


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

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


796
797
798
799
 
# File 'dynamo_db/cfn_table.rb', line 796

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

Represents the warm throughput (in read units per second and write units per second) for creating a table.

Returns:



509
510
511
 
# File 'dynamo_db/cfn_table.rb', line 509

def warm_throughput()
  jsii_get_property("warmThroughput")
end

#warm_throughput=(value) ⇒ Object 



513
514
515
516
517
 
# File 'dynamo_db/cfn_table.rb', line 513

def warm_throughput=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::DynamoDB::CfnTable::WarmThroughputProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19keW5hbW9kYi5DZm5UYWJsZS5XYXJtVGhyb3VnaHB1dFByb3BlcnR5In1dfX0=")), "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) 


535
536
537
538
539
540
 
# File 'dynamo_db/cfn_table.rb', line 535

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