Class: AWSCDK::S3Tables::CfnTable

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggableV2, Interfaces::AWSS3Tables::ITableRef
Defined in:
s3_tables/cfn_table.rb

Overview

Creates a new table associated with the given namespace in a table bucket.

For more information, see Creating an Amazon S3 table in the Amazon Simple Storage Service User Guide .

  • Permissions - - You must have the s3tables:CreateTable permission to use this operation.
  • If you use this operation with the optional metadata request parameter you must have the s3tables:PutTableData permission.
  • If you use this operation with the optional encryption_configuration request parameter you must have the s3tables:PutTableEncryption permission.

Additionally, If you choose SSE-KMS encryption you must grant the S3 Tables maintenance principal access to your KMS key. For more information, see Permissions requirements for S3 Tables SSE-KMS encryption .

  • Cloud Development Kit - To use S3 Tables AWS CDK constructs, add the @aws-cdk/aws-s3tables-alpha dependency with one of the following options:
  • NPM: `npm i

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnTable

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

    Resource properties.



29
30
31
32
33
34
35
 
# File 's3_tables/cfn_table.rb', line 29

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

Class Method Details

.arn_for_table(resource) ⇒ String

Parameters:

Returns:

  • (String) 


94
95
96
97
 
# File 's3_tables/cfn_table.rb', line 94

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

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


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

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

.is_cfn_table(x) ⇒ Boolean

Checks whether the given object is a CfnTable.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


103
104
105
106
 
# File 's3_tables/cfn_table.rb', line 103

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

.jsii_overridable_methods ⇒ Object 



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
 
# File 's3_tables/cfn_table.rb', line 37

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_table_arn => { kind: :property, name: "attrTableArn", is_optional: false },
    :attr_version_token => { kind: :property, name: "attrVersionToken", is_optional: false },
    :attr_warehouse_location => { kind: :property, name: "attrWarehouseLocation", is_optional: false },
    :cdk_tag_manager => { kind: :property, name: "cdkTagManager", is_optional: false },
    :table_ref => { kind: :property, name: "tableRef", is_optional: false },
    :namespace => { kind: :property, name: "namespace", is_optional: false },
    :open_table_format => { kind: :property, name: "openTableFormat", is_optional: false },
    :table_bucket_arn => { kind: :property, name: "tableBucketArn", is_optional: false },
    :table_name => { kind: :property, name: "tableName", is_optional: false },
    :compaction => { kind: :property, name: "compaction", is_optional: true },
    :iceberg_metadata => { kind: :property, name: "icebergMetadata", is_optional: true },
    :snapshot_management => { kind: :property, name: "snapshotManagement", is_optional: true },
    :storage_class_configuration => { kind: :property, name: "storageClassConfiguration", is_optional: true },
    :tags => { kind: :property, name: "tags", is_optional: true },
    :without_metadata => { kind: :property, name: "withoutMetadata", 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.



401
402
403
404
 
# File 's3_tables/cfn_table.rb', line 401

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:



413
414
415
416
 
# File 's3_tables/cfn_table.rb', line 413

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:



423
424
425
426
 
# File 's3_tables/cfn_table.rb', line 423

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:



434
435
436
437
438
 
# File 's3_tables/cfn_table.rb', line 434

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.


491
492
493
494
495
 
# File 's3_tables/cfn_table.rb', line 491

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.



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

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.



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

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:



526
527
528
529
 
# File 's3_tables/cfn_table.rb', line 526

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:



548
549
550
551
552
553
 
# File 's3_tables/cfn_table.rb', line 548

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_table_arn ⇒ String

The Amazon Resource Name (ARN) of the table.

Returns:

  • (String) 


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

def attr_table_arn()
  jsii_get_property("attrTableArn")
end

#attr_version_token ⇒ String

The version token of the table.

Returns:

  • (String) 


215
216
217
 
# File 's3_tables/cfn_table.rb', line 215

def attr_version_token()
  jsii_get_property("attrVersionToken")
end

#attr_warehouse_location ⇒ String

The warehouse location of the table.

Returns:

  • (String) 


222
223
224
 
# File 's3_tables/cfn_table.rb', line 222

def attr_warehouse_location()
  jsii_get_property("attrWarehouseLocation")
end

#cdk_tag_manager ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



229
230
231
 
# File 's3_tables/cfn_table.rb', line 229

def cdk_tag_manager()
  jsii_get_property("cdkTagManager")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



154
155
156
 
# File 's3_tables/cfn_table.rb', line 154

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


159
160
161
 
# File 's3_tables/cfn_table.rb', line 159

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


557
558
559
560
 
# File 's3_tables/cfn_table.rb', line 557

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


164
165
166
 
# File 's3_tables/cfn_table.rb', line 164

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


171
172
173
 
# File 's3_tables/cfn_table.rb', line 171

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#compaction ⇒ AWSCDK::IResolvable, ...

Contains details about the compaction settings for an Iceberg table.

Returns:



291
292
293
 
# File 's3_tables/cfn_table.rb', line 291

def compaction()
  jsii_get_property("compaction")
end

#compaction=(value) ⇒ Object 



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

def compaction=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::S3Tables::CfnTable::CompactionProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zM3RhYmxlcy5DZm5UYWJsZS5Db21wYWN0aW9uUHJvcGVydHkifV19fQ==")), "compaction") unless value.nil?
  jsii_set_property("compaction", value)
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


116
117
118
 
# File 's3_tables/cfn_table.rb', line 116

def creation_stack()
  jsii_get_property("creationStack")
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



176
177
178
 
# File 's3_tables/cfn_table.rb', line 176

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:



570
571
572
573
574
 
# File 's3_tables/cfn_table.rb', line 570

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:



581
582
583
584
 
# File 's3_tables/cfn_table.rb', line 581

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

#iceberg_metadata ⇒ AWSCDK::IResolvable, ...

Contains details about the metadata for an Iceberg table.

Returns:



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

def iceberg_metadata()
  jsii_get_property("icebergMetadata")
end

#iceberg_metadata=(value) ⇒ Object 



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

def iceberg_metadata=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::S3Tables::CfnTable::IcebergMetadataProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zM3RhYmxlcy5DZm5UYWJsZS5JY2ViZXJnTWV0YWRhdGFQcm9wZXJ0eSJ9XX19")), "icebergMetadata") unless value.nil?
  jsii_set_property("icebergMetadata", value)
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



651
652
653
654
 
# File 's3_tables/cfn_table.rb', line 651

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
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) 


128
129
130
 
# File 's3_tables/cfn_table.rb', line 128

def logical_id()
  jsii_get_property("logicalId")
end

#namespace ⇒ String

The name of the namespace.

Returns:

  • (String) 


243
244
245
 
# File 's3_tables/cfn_table.rb', line 243

def namespace()
  jsii_get_property("namespace")
end

#namespace=(value) ⇒ Object 



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

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

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


111
112
113
 
# File 's3_tables/cfn_table.rb', line 111

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:



592
593
594
 
# File 's3_tables/cfn_table.rb', line 592

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:



599
600
601
 
# File 's3_tables/cfn_table.rb', line 599

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

#open_table_format ⇒ String

The format of the table.

Returns:

  • (String) 


255
256
257
 
# File 's3_tables/cfn_table.rb', line 255

def open_table_format()
  jsii_get_property("openTableFormat")
end

#open_table_format=(value) ⇒ Object 



259
260
261
262
 
# File 's3_tables/cfn_table.rb', line 259

def open_table_format=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "openTableFormat")
  jsii_set_property("openTableFormat", 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.



392
393
394
395
 
# File 's3_tables/cfn_table.rb', line 392

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

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


147
148
149
 
# File 's3_tables/cfn_table.rb', line 147

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:



610
611
612
613
 
# File 's3_tables/cfn_table.rb', line 610

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


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

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:



627
628
629
630
631
 
# File 's3_tables/cfn_table.rb', line 627

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

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



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

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

#snapshot_management ⇒ AWSCDK::IResolvable, ...

Contains details about the Iceberg snapshot management settings for the table.

Returns:



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

def snapshot_management()
  jsii_get_property("snapshotManagement")
end

#snapshot_management=(value) ⇒ Object 



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

def snapshot_management=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::S3Tables::CfnTable::SnapshotManagementProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zM3RhYmxlcy5DZm5UYWJsZS5TbmFwc2hvdE1hbmFnZW1lbnRQcm9wZXJ0eSJ9XX19")), "snapshotManagement") unless value.nil?
  jsii_set_property("snapshotManagement", 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:



137
138
139
 
# File 's3_tables/cfn_table.rb', line 137

def stack()
  jsii_get_property("stack")
end

#storage_class_configuration ⇒ AWSCDK::IResolvable, ...

The configuration details for the storage class of tables or table buckets.

Returns:



330
331
332
 
# File 's3_tables/cfn_table.rb', line 330

def storage_class_configuration()
  jsii_get_property("storageClassConfiguration")
end

#storage_class_configuration=(value) ⇒ Object 



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

def storage_class_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::S3Tables::CfnTable::StorageClassConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zM3RhYmxlcy5DZm5UYWJsZS5TdG9yYWdlQ2xhc3NDb25maWd1cmF0aW9uUHJvcGVydHkifV19fQ==")), "storageClassConfiguration") unless value.nil?
  jsii_set_property("storageClassConfiguration", value)
end

#table_bucket_arn ⇒ String

The Amazon Resource Name (ARN) of the table bucket to create the table in.

Returns:

  • (String) 


267
268
269
 
# File 's3_tables/cfn_table.rb', line 267

def table_bucket_arn()
  jsii_get_property("tableBucketArn")
end

#table_bucket_arn=(value) ⇒ Object 



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

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

#table_name ⇒ String

The name for the table.

Returns:

  • (String) 


279
280
281
 
# File 's3_tables/cfn_table.rb', line 279

def table_name()
  jsii_get_property("tableName")
end

#table_name=(value) ⇒ Object 



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

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

#table_ref ⇒ AWSCDK::Interfaces::AWSS3Tables::TableReference

A reference to a Table resource.

Returns:



236
237
238
 
# File 's3_tables/cfn_table.rb', line 236

def table_ref()
  jsii_get_property("tableRef")
end

#tags ⇒ Array<AWSCDK::CfnTag>?

User tags (key-value pairs) to associate with the table.

Returns:



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

def tags()
  jsii_get_property("tags")
end

#tags=(value) ⇒ Object 



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

def tags=(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=")), "tags") unless value.nil?
  jsii_set_property("tags", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



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

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


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

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


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

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


642
643
644
645
 
# File 's3_tables/cfn_table.rb', line 642

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
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) 


381
382
383
384
385
386
 
# File 's3_tables/cfn_table.rb', line 381

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

#without_metadata ⇒ String?

Indicates that you don't want to specify a schema for the table.

Returns:

  • (String, nil) 


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

def without_metadata()
  jsii_get_property("withoutMetadata")
end

#without_metadata=(value) ⇒ Object 



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

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