Class: AWSCDK::S3Tables::CfnTableBucket

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

Overview

Creates a table bucket.

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

  • Permissions - - You must have the s3tables:CreateTableBucket permission to use this operation.
  • If you use this operation with the optional encryption_configuration parameter you must have the s3tables:PutTableBucketEncryption permission.
  • 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) ⇒ CfnTableBucket

Create a new AWS::S3Tables::TableBucket.

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::CfnTableBucketProps) —

    Resource properties.



25
26
27
28
29
30
31
 
# File 's3_tables/cfn_table_bucket.rb', line 25

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

Class Method Details

.arn_for_table_bucket(resource) ⇒ String

Parameters:

Returns:

  • (String) 


85
86
87
88
 
# File 's3_tables/cfn_table_bucket.rb', line 85

def self.arn_for_table_bucket(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19zM3RhYmxlcy5JVGFibGVCdWNrZXRSZWYifQ==")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_s3tables.CfnTableBucket", "arnForTableBucket", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


192
193
194
 
# File 's3_tables/cfn_table_bucket.rb', line 192

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

.is_cfn_table_bucket(x) ⇒ Boolean

Checks whether the given object is a CfnTableBucket.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


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

def self.is_cfn_table_bucket(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_s3tables.CfnTableBucket", "isCfnTableBucket", [x])
end

.jsii_overridable_methods ⇒ Object 



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

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_bucket_arn => { kind: :property, name: "attrTableBucketArn", is_optional: false },
    :cdk_tag_manager => { kind: :property, name: "cdkTagManager", is_optional: false },
    :table_bucket_ref => { kind: :property, name: "tableBucketRef", is_optional: false },
    :table_bucket_name => { kind: :property, name: "tableBucketName", is_optional: false },
    :encryption_configuration => { kind: :property, name: "encryptionConfiguration", is_optional: true },
    :metrics_configuration => { kind: :property, name: "metricsConfiguration", is_optional: true },
    :replication_configuration => { kind: :property, name: "replicationConfiguration", is_optional: true },
    :storage_class_configuration => { kind: :property, name: "storageClassConfiguration", is_optional: true },
    :tags => { kind: :property, name: "tags", is_optional: true },
    :unreferenced_file_removal => { kind: :property, name: "unreferencedFileRemoval", 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.



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

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:



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

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:



365
366
367
368
 
# File 's3_tables/cfn_table_bucket.rb', line 365

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:



376
377
378
379
380
 
# File 's3_tables/cfn_table_bucket.rb', line 376

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.


433
434
435
436
437
 
# File 's3_tables/cfn_table_bucket.rb', line 433

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.



443
444
445
446
 
# File 's3_tables/cfn_table_bucket.rb', line 443

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.



455
456
457
458
459
 
# File 's3_tables/cfn_table_bucket.rb', line 455

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:



468
469
470
471
 
# File 's3_tables/cfn_table_bucket.rb', line 468

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:



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

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

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

Returns:

  • (String) 


199
200
201
 
# File 's3_tables/cfn_table_bucket.rb', line 199

def attr_table_bucket_arn()
  jsii_get_property("attrTableBucketArn")
end

#cdk_tag_manager ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



206
207
208
 
# File 's3_tables/cfn_table_bucket.rb', line 206

def cdk_tag_manager()
  jsii_get_property("cdkTagManager")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



145
146
147
 
# File 's3_tables/cfn_table_bucket.rb', line 145

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


150
151
152
 
# File 's3_tables/cfn_table_bucket.rb', line 150

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


499
500
501
502
 
# File 's3_tables/cfn_table_bucket.rb', line 499

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


155
156
157
 
# File 's3_tables/cfn_table_bucket.rb', line 155

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


162
163
164
 
# File 's3_tables/cfn_table_bucket.rb', line 162

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


107
108
109
 
# File 's3_tables/cfn_table_bucket.rb', line 107

def creation_stack()
  jsii_get_property("creationStack")
end

#encryption_configuration ⇒ AWSCDK::IResolvable, ...

Configuration specifying how data should be encrypted.

Returns:



232
233
234
 
# File 's3_tables/cfn_table_bucket.rb', line 232

def encryption_configuration()
  jsii_get_property("encryptionConfiguration")
end

#encryption_configuration=(value) ⇒ Object 



236
237
238
239
240
 
# File 's3_tables/cfn_table_bucket.rb', line 236

def encryption_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::S3Tables::CfnTableBucket::EncryptionConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zM3RhYmxlcy5DZm5UYWJsZUJ1Y2tldC5FbmNyeXB0aW9uQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "encryptionConfiguration") unless value.nil?
  jsii_set_property("encryptionConfiguration", value)
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



167
168
169
 
# File 's3_tables/cfn_table_bucket.rb', line 167

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:



512
513
514
515
516
 
# File 's3_tables/cfn_table_bucket.rb', line 512

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:



523
524
525
526
 
# File 's3_tables/cfn_table_bucket.rb', line 523

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:



593
594
595
596
 
# File 's3_tables/cfn_table_bucket.rb', line 593

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) 


119
120
121
 
# File 's3_tables/cfn_table_bucket.rb', line 119

def logical_id()
  jsii_get_property("logicalId")
end

#metrics_configuration ⇒ AWSCDK::IResolvable, ...

Settings governing the Metric configuration for the table bucket.

Returns:



245
246
247
 
# File 's3_tables/cfn_table_bucket.rb', line 245

def metrics_configuration()
  jsii_get_property("metricsConfiguration")
end

#metrics_configuration=(value) ⇒ Object 



249
250
251
252
253
 
# File 's3_tables/cfn_table_bucket.rb', line 249

def metrics_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::S3Tables::CfnTableBucket::MetricsConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zM3RhYmxlcy5DZm5UYWJsZUJ1Y2tldC5NZXRyaWNzQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "metricsConfiguration") unless value.nil?
  jsii_set_property("metricsConfiguration", value)
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


102
103
104
 
# File 's3_tables/cfn_table_bucket.rb', line 102

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:



534
535
536
 
# File 's3_tables/cfn_table_bucket.rb', line 534

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:



541
542
543
 
# File 's3_tables/cfn_table_bucket.rb', line 541

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.



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

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) 


138
139
140
 
# File 's3_tables/cfn_table_bucket.rb', line 138

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:



552
553
554
555
 
# File 's3_tables/cfn_table_bucket.rb', line 552

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


559
560
561
562
 
# File 's3_tables/cfn_table_bucket.rb', line 559

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:



569
570
571
572
573
 
# File 's3_tables/cfn_table_bucket.rb', line 569

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

#replication_configuration ⇒ AWSCDK::IResolvable, ...

Specifies replication configuration for the table bucket.

Returns:



258
259
260
 
# File 's3_tables/cfn_table_bucket.rb', line 258

def replication_configuration()
  jsii_get_property("replicationConfiguration")
end

#replication_configuration=(value) ⇒ Object 



262
263
264
265
266
 
# File 's3_tables/cfn_table_bucket.rb', line 262

def replication_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::S3Tables::CfnTableBucket::ReplicationConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zM3RhYmxlcy5DZm5UYWJsZUJ1Y2tldC5SZXBsaWNhdGlvbkNvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "replicationConfiguration") unless value.nil?
  jsii_set_property("replicationConfiguration", 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.



578
579
580
 
# File 's3_tables/cfn_table_bucket.rb', line 578

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:



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

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:



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

def storage_class_configuration()
  jsii_get_property("storageClassConfiguration")
end

#storage_class_configuration=(value) ⇒ Object 



275
276
277
278
279
 
# File 's3_tables/cfn_table_bucket.rb', line 275

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

#table_bucket_name ⇒ String

The name for the table bucket.

Returns:

  • (String) 


220
221
222
 
# File 's3_tables/cfn_table_bucket.rb', line 220

def table_bucket_name()
  jsii_get_property("tableBucketName")
end

#table_bucket_name=(value) ⇒ Object 



224
225
226
227
 
# File 's3_tables/cfn_table_bucket.rb', line 224

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

#table_bucket_ref ⇒ AWSCDK::Interfaces::AWSS3Tables::TableBucketReference

A reference to a TableBucket resource.

Returns:



213
214
215
 
# File 's3_tables/cfn_table_bucket.rb', line 213

def table_bucket_ref()
  jsii_get_property("tableBucketRef")
end

#tags ⇒ Array<AWSCDK::CfnTag>?

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

Returns:



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

def tags()
  jsii_get_property("tags")
end

#tags=(value) ⇒ Object 



288
289
290
291
292
 
# File 's3_tables/cfn_table_bucket.rb', line 288

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



310
311
312
 
# File 's3_tables/cfn_table_bucket.rb', line 310

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

#unreferenced_file_removal ⇒ AWSCDK::IResolvable, ...

The unreferenced file removal settings for your table bucket.

Returns:



297
298
299
 
# File 's3_tables/cfn_table_bucket.rb', line 297

def unreferenced_file_removal()
  jsii_get_property("unreferencedFileRemoval")
end

#unreferenced_file_removal=(value) ⇒ Object 



301
302
303
304
305
 
# File 's3_tables/cfn_table_bucket.rb', line 301

def unreferenced_file_removal=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::S3Tables::CfnTableBucket::UnreferencedFileRemovalProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zM3RhYmxlcy5DZm5UYWJsZUJ1Y2tldC5VbnJlZmVyZW5jZWRGaWxlUmVtb3ZhbFByb3BlcnR5In1dfX0=")), "unreferencedFileRemoval") unless value.nil?
  jsii_set_property("unreferencedFileRemoval", value)
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}) 


175
176
177
 
# File 's3_tables/cfn_table_bucket.rb', line 175

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


185
186
187
 
# File 's3_tables/cfn_table_bucket.rb', line 185

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


584
585
586
587
 
# File 's3_tables/cfn_table_bucket.rb', line 584

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) 


323
324
325
326
327
328
 
# File 's3_tables/cfn_table_bucket.rb', line 323

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