Class: AWSCDK::DynamoDB::CfnGlobalTable

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, Interfaces::AWSDynamodb::IGlobalTableRef
Defined in:
dynamo_db/cfn_global_table.rb

Overview

The AWS::DynamoDB::GlobalTable resource enables you to create and manage a Version 2019.11.21 global table. This resource cannot be used to create or manage a Version 2017.11.29 global table. For more information, see Global tables .

You cannot convert a resource of type AWS::DynamoDB::Table into a resource of type AWS::DynamoDB::GlobalTable by changing its type in your template. Doing so might result in the deletion of your DynamoDB table.

You can instead use the GlobalTable resource to create a new table in a single Region. This will be billed the same as a single Region table. If you later update the stack to add other Regions then Global Tables pricing will apply.

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

  • The IAM Principal executing the stack operation must have the permissions listed below in all regions where you plan to have a global table replica. The IAM Principal's permissions should not have restrictions based on IP source address. Some global tables operations (for example, adding a replica) are asynchronous, and require that the IAM Principal is valid until they complete. You should not delete the Principal (user or IAM role) until CloudFormation has finished updating your stack.
  • application-autoscaling:DeleteScalingPolicy
  • application-autoscaling:DeleteScheduledAction
  • application-autoscaling:DeregisterScalableTarget
  • application-autoscaling:DescribeScalableTargets
  • application-autoscaling:DescribeScalingPolicies
  • application-autoscaling:PutScalingPolicy
  • application-autoscaling:PutScheduledAction
  • application-autoscaling:RegisterScalableTarget
  • dynamodb:BatchWriteItem
  • dynamodb:CreateGlobalTableWitness
  • dynamodb:CreateTable
  • dynamodb:CreateTableReplica
  • dynamodb:DeleteGlobalTableWitness
  • dynamodb:DeleteItem
  • dynamodb:DeleteTable
  • dynamodb:DeleteTableReplica
  • dynamodb:DescribeContinuousBackups
  • dynamodb:DescribeContributorInsights
  • dynamodb:DescribeTable
  • dynamodb:DescribeTableReplicaAutoScaling
  • dynamodb:DescribeTimeToLive
  • dynamodb:DisableKinesisStreamingDestination
  • dynamodb:EnableKinesisStreamingDestination
  • dynamodb:GetItem
  • dynamodb:ListTables
  • dynamodb:ListTagsOfResource
  • dynamodb:PutItem
  • dynamodb:Query
  • dynamodb:Scan
  • dynamodb:TagResource
  • dynamodb:UntagResource
  • dynamodb:UpdateContinuousBackups
  • dynamodb:UpdateContributorInsights
  • dynamodb:UpdateItem
  • dynamodb:UpdateTable
  • dynamodb:UpdateTableReplicaAutoScaling
  • dynamodb:UpdateTimeToLive
  • iam:CreateServiceLinkedRole
  • kms:CreateGrant
  • kms:DescribeKey
  • When using provisioned billing mode, CloudFormation will create an auto scaling policy on each of your replicas to control their write capacities. You must configure this policy using the WriteProvisionedThroughputSettings property. CloudFormation will ensure that all replicas have the same write capacity auto scaling property. You cannot directly specify a value for write capacity for a global table.
  • If your table uses provisioned capacity, you must configure auto scaling directly in the AWS::DynamoDB::GlobalTable resource. You should not configure additional auto scaling policies on any of the table replicas or global secondary indexes, either via API or via AWS::ApplicationAutoScaling::ScalableTarget or AWS::ApplicationAutoScaling::ScalingPolicy . Doing so might result in unexpected behavior and is unsupported.
  • In AWS CloudFormation , each global table is controlled by a single stack, in a single region, regardless of the number of replicas. When you deploy your template, CloudFormation will create/update all replicas as part of a single stack operation. You should not deploy the same AWS::DynamoDB::GlobalTable resource in multiple regions. Doing so will result in errors, and is unsupported. If you deploy your application template in multiple regions, you can use conditions to only create the resource in a single region. Alternatively, you can choose to define your AWS::DynamoDB::GlobalTable resources in a stack separate from your application stack, and make sure it is only deployed to a single region.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnGlobalTable

Create a new AWS::DynamoDB::GlobalTable.

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::CfnGlobalTableProps)

    Resource properties.



68
69
70
71
72
73
74
# File 'dynamo_db/cfn_global_table.rb', line 68

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

Class Method Details

.arn_for_global_table(resource) ⇒ String

Parameters:

Returns:

  • (String)


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

def self.arn_for_global_table(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19keW5hbW9kYi5JR2xvYmFsVGFibGVSZWYifQ==")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_dynamodb.CfnGlobalTable", "arnForGlobalTable", [resource])
end

.CFN_RESOURCE_TYPE_NAMEString

The CloudFormation resource type name for this resource class.

Returns:

  • (String)


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

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

.is_cfn_global_table(x) ⇒ Boolean

Checks whether the given object is a CfnGlobalTable.

Parameters:

  • x (Object)

Returns:

  • (Boolean)


149
150
151
152
# File 'dynamo_db/cfn_global_table.rb', line 149

def self.is_cfn_global_table(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_dynamodb.CfnGlobalTable", "isCfnGlobalTable", [x])
end

.jsii_overridable_methodsObject



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
# File 'dynamo_db/cfn_global_table.rb', line 76

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 },
    :attr_table_id => { kind: :property, name: "attrTableId", is_optional: false },
    :global_table_ref => { kind: :property, name: "globalTableRef", is_optional: false },
    :replicas => { kind: :property, name: "replicas", is_optional: false },
    :attribute_definitions => { kind: :property, name: "attributeDefinitions", is_optional: true },
    :billing_mode => { kind: :property, name: "billingMode", is_optional: true },
    :global_secondary_indexes => { kind: :property, name: "globalSecondaryIndexes", is_optional: true },
    :global_table_source_arn => { kind: :property, name: "globalTableSourceArn", is_optional: true },
    :global_table_witnesses => { kind: :property, name: "globalTableWitnesses", is_optional: true },
    :key_schema => { kind: :property, name: "keySchema", is_optional: true },
    :local_secondary_indexes => { kind: :property, name: "localSecondaryIndexes", is_optional: true },
    :multi_region_consistency => { kind: :property, name: "multiRegionConsistency", is_optional: true },
    :read_on_demand_throughput_settings => { kind: :property, name: "readOnDemandThroughputSettings", is_optional: true },
    :read_provisioned_throughput_settings => { kind: :property, name: "readProvisionedThroughputSettings", is_optional: true },
    :sse_specification => { kind: :property, name: "sseSpecification", is_optional: true },
    :stream_specification => { kind: :property, name: "streamSpecification", is_optional: true },
    :table_name => { kind: :property, name: "tableName", is_optional: true },
    :time_to_live_specification => { kind: :property, name: "timeToLiveSpecification", is_optional: true },
    :warm_throughput => { kind: :property, name: "warmThroughput", is_optional: true },
    :write_on_demand_throughput_settings => { kind: :property, name: "writeOnDemandThroughputSettings", is_optional: true },
    :write_provisioned_throughput_settings => { kind: :property, name: "writeProvisionedThroughputSettings", 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.



541
542
543
544
# File 'dynamo_db/cfn_global_table.rb', line 541

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:



553
554
555
556
# File 'dynamo_db/cfn_global_table.rb', line 553

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:



563
564
565
566
# File 'dynamo_db/cfn_global_table.rb', line 563

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.



574
575
576
577
578
# File 'dynamo_db/cfn_global_table.rb', line 574

def (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.


631
632
633
634
635
# File 'dynamo_db/cfn_global_table.rb', line 631

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.



641
642
643
644
# File 'dynamo_db/cfn_global_table.rb', line 641

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.



653
654
655
656
657
# File 'dynamo_db/cfn_global_table.rb', line 653

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:



666
667
668
669
# File 'dynamo_db/cfn_global_table.rb', line 666

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:



688
689
690
691
692
693
# File 'dynamo_db/cfn_global_table.rb', line 688

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_arnString

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

The ARN returned is that of the replica in the region the stack is deployed to.

Returns:

  • (String)


256
257
258
# File 'dynamo_db/cfn_global_table.rb', line 256

def attr_arn()
  jsii_get_property("attrArn")
end

#attr_stream_arnString

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 . The StreamArn returned is that of the replica in the region the stack is deployed to.

You must specify the StreamSpecification property to use this attribute.

Returns:

  • (String)


265
266
267
# File 'dynamo_db/cfn_global_table.rb', line 265

def attr_stream_arn()
  jsii_get_property("attrStreamArn")
end

#attr_table_idString

Unique identifier for the table, such as a123b456-01ab-23cd-123a-111222aaabbb .

The TableId returned is that of the replica in the region the stack is deployed to.

Returns:

  • (String)


274
275
276
# File 'dynamo_db/cfn_global_table.rb', line 274

def attr_table_id()
  jsii_get_property("attrTableId")
end

#attribute_definitionsAWSCDK::IResolvable, ...

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



300
301
302
# File 'dynamo_db/cfn_global_table.rb', line 300

def attribute_definitions()
  jsii_get_property("attributeDefinitions")
end

#attribute_definitions=(value) ⇒ Object



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

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

#billing_modeString?

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

Valid values are:.

Returns:

  • (String, nil)


314
315
316
# File 'dynamo_db/cfn_global_table.rb', line 314

def billing_mode()
  jsii_get_property("billingMode")
end

#billing_mode=(value) ⇒ Object



318
319
320
321
# File 'dynamo_db/cfn_global_table.rb', line 318

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_optionsAWSCDK::ICfnResourceOptions

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



200
201
202
# File 'dynamo_db/cfn_global_table.rb', line 200

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_propertiesHash{String => Object}

Returns:

  • (Hash{String => Object})


205
206
207
# File 'dynamo_db/cfn_global_table.rb', line 205

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil)


697
698
699
700
# File 'dynamo_db/cfn_global_table.rb', line 697

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_namesHash{String => String}

Returns:

  • (Hash{String => String})


210
211
212
# File 'dynamo_db/cfn_global_table.rb', line 210

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_typeString

AWS resource type.

Returns:

  • (String)


217
218
219
# File 'dynamo_db/cfn_global_table.rb', line 217

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stackArray<String>

Returns:

  • (Array<String>)


162
163
164
# File 'dynamo_db/cfn_global_table.rb', line 162

def creation_stack()
  jsii_get_property("creationStack")
end

#envAWSCDK::Interfaces::ResourceEnvironment



222
223
224
# File 'dynamo_db/cfn_global_table.rb', line 222

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:



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

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.



721
722
723
724
# File 'dynamo_db/cfn_global_table.rb', line 721

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

#global_secondary_indexesAWSCDK::IResolvable, ...

Global secondary indexes to be created on the global table.



326
327
328
# File 'dynamo_db/cfn_global_table.rb', line 326

def global_secondary_indexes()
  jsii_get_property("globalSecondaryIndexes")
end

#global_secondary_indexes=(value) ⇒ Object



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

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

#global_table_refAWSCDK::Interfaces::AWSDynamodb::GlobalTableReference

A reference to a GlobalTable resource.



281
282
283
# File 'dynamo_db/cfn_global_table.rb', line 281

def global_table_ref()
  jsii_get_property("globalTableRef")
end

#global_table_source_arnString?

Returns:

  • (String, nil)


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

def global_table_source_arn()
  jsii_get_property("globalTableSourceArn")
end

#global_table_source_arn=(value) ⇒ Object



340
341
342
343
# File 'dynamo_db/cfn_global_table.rb', line 340

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

#global_table_witnessesAWSCDK::IResolvable, ...

The list of witnesses of the MRSC global table.



348
349
350
# File 'dynamo_db/cfn_global_table.rb', line 348

def global_table_witnesses()
  jsii_get_property("globalTableWitnesses")
end

#global_table_witnesses=(value) ⇒ Object



352
353
354
355
# File 'dynamo_db/cfn_global_table.rb', line 352

def global_table_witnesses=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZHluYW1vZGIuQ2ZuR2xvYmFsVGFibGUuR2xvYmFsVGFibGVXaXRuZXNzUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "globalTableWitnesses") unless value.nil?
  jsii_set_property("globalTableWitnesses", value)
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



791
792
793
794
# File 'dynamo_db/cfn_global_table.rb', line 791

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

#key_schemaAWSCDK::IResolvable, ...

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



360
361
362
# File 'dynamo_db/cfn_global_table.rb', line 360

def key_schema()
  jsii_get_property("keySchema")
end

#key_schema=(value) ⇒ Object



364
365
366
367
# File 'dynamo_db/cfn_global_table.rb', line 364

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

#local_secondary_indexesAWSCDK::IResolvable, ...

Local secondary indexes to be created on the table.



372
373
374
# File 'dynamo_db/cfn_global_table.rb', line 372

def local_secondary_indexes()
  jsii_get_property("localSecondaryIndexes")
end

#local_secondary_indexes=(value) ⇒ Object



376
377
378
379
# File 'dynamo_db/cfn_global_table.rb', line 376

def local_secondary_indexes=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZHluYW1vZGIuQ2ZuR2xvYmFsVGFibGUuTG9jYWxTZWNvbmRhcnlJbmRleFByb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "localSecondaryIndexes") unless value.nil?
  jsii_set_property("localSecondaryIndexes", value)
end

#logical_idString

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)


174
175
176
# File 'dynamo_db/cfn_global_table.rb', line 174

def logical_id()
  jsii_get_property("logicalId")
end

#multi_region_consistencyString?

Specifies the consistency mode for a new global table.

Returns:

  • (String, nil)


384
385
386
# File 'dynamo_db/cfn_global_table.rb', line 384

def multi_region_consistency()
  jsii_get_property("multiRegionConsistency")
end

#multi_region_consistency=(value) ⇒ Object



388
389
390
391
# File 'dynamo_db/cfn_global_table.rb', line 388

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

#nodeConstructs::Node

The tree node.

Returns:

  • (Constructs::Node)


157
158
159
# File 'dynamo_db/cfn_global_table.rb', line 157

def node()
  jsii_get_property("node")
end

#obtain_dependenciesArray<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:



732
733
734
# File 'dynamo_db/cfn_global_table.rb', line 732

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

#obtain_resource_dependenciesArray<AWSCDK::CfnResource>

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

Returns:



739
740
741
# File 'dynamo_db/cfn_global_table.rb', line 739

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.



532
533
534
535
# File 'dynamo_db/cfn_global_table.rb', line 532

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

#read_on_demand_throughput_settingsAWSCDK::IResolvable, ...



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

def read_on_demand_throughput_settings()
  jsii_get_property("readOnDemandThroughputSettings")
end

#read_on_demand_throughput_settings=(value) ⇒ Object



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

def read_on_demand_throughput_settings=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::DynamoDB::CfnGlobalTable::ReadOnDemandThroughputSettingsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19keW5hbW9kYi5DZm5HbG9iYWxUYWJsZS5SZWFkT25EZW1hbmRUaHJvdWdocHV0U2V0dGluZ3NQcm9wZXJ0eSJ9XX19")), "readOnDemandThroughputSettings") unless value.nil?
  jsii_set_property("readOnDemandThroughputSettings", value)
end

#read_provisioned_throughput_settingsAWSCDK::IResolvable, ...



405
406
407
# File 'dynamo_db/cfn_global_table.rb', line 405

def read_provisioned_throughput_settings()
  jsii_get_property("readProvisionedThroughputSettings")
end

#read_provisioned_throughput_settings=(value) ⇒ Object



409
410
411
412
413
# File 'dynamo_db/cfn_global_table.rb', line 409

def read_provisioned_throughput_settings=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::DynamoDB::CfnGlobalTable::GlobalReadProvisionedThroughputSettingsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19keW5hbW9kYi5DZm5HbG9iYWxUYWJsZS5HbG9iYWxSZWFkUHJvdmlzaW9uZWRUaHJvdWdocHV0U2V0dGluZ3NQcm9wZXJ0eSJ9XX19")), "readProvisionedThroughputSettings") unless value.nil?
  jsii_set_property("readProvisionedThroughputSettings", value)
end

#refString

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)


193
194
195
# File 'dynamo_db/cfn_global_table.rb', line 193

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:



750
751
752
753
# File 'dynamo_db/cfn_global_table.rb', line 750

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


757
758
759
760
# File 'dynamo_db/cfn_global_table.rb', line 757

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:



767
768
769
770
771
# File 'dynamo_db/cfn_global_table.rb', line 767

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

#replicasAWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::DynamoDB::CfnGlobalTable::ReplicaSpecificationProperty>

Specifies the list of replicas for your global table.



288
289
290
# File 'dynamo_db/cfn_global_table.rb', line 288

def replicas()
  jsii_get_property("replicas")
end

#replicas=(value) ⇒ Object



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

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

#should_synthesizeBoolean

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.



776
777
778
# File 'dynamo_db/cfn_global_table.rb', line 776

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

#sse_specificationAWSCDK::IResolvable, ...

Specifies the settings to enable server-side encryption.



418
419
420
# File 'dynamo_db/cfn_global_table.rb', line 418

def sse_specification()
  jsii_get_property("sseSpecification")
end

#sse_specification=(value) ⇒ Object



422
423
424
425
426
# File 'dynamo_db/cfn_global_table.rb', line 422

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

#stackAWSCDK::Stack

The stack in which this element is defined.

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

Returns:



183
184
185
# File 'dynamo_db/cfn_global_table.rb', line 183

def stack()
  jsii_get_property("stack")
end

#stream_specificationAWSCDK::IResolvable, ...

Specifies the streams settings on your global table.



431
432
433
# File 'dynamo_db/cfn_global_table.rb', line 431

def stream_specification()
  jsii_get_property("streamSpecification")
end

#stream_specification=(value) ⇒ Object



435
436
437
438
439
# File 'dynamo_db/cfn_global_table.rb', line 435

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

#table_nameString?

A name for the global table.

Returns:

  • (String, nil)


444
445
446
# File 'dynamo_db/cfn_global_table.rb', line 444

def table_name()
  jsii_get_property("tableName")
end

#table_name=(value) ⇒ Object



448
449
450
451
# File 'dynamo_db/cfn_global_table.rb', line 448

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

#time_to_live_specificationAWSCDK::IResolvable, ...

Specifies the time to live (TTL) settings for the table.



456
457
458
# File 'dynamo_db/cfn_global_table.rb', line 456

def time_to_live_specification()
  jsii_get_property("timeToLiveSpecification")
end

#time_to_live_specification=(value) ⇒ Object



460
461
462
463
464
# File 'dynamo_db/cfn_global_table.rb', line 460

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

#to_stringString

Returns a string representation of this construct.

Returns:

  • (String)

    a string representation of this resource



508
509
510
# File 'dynamo_db/cfn_global_table.rb', line 508

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

#updated_properitesHash{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})


230
231
232
# File 'dynamo_db/cfn_global_table.rb', line 230

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_propertiesHash{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})


240
241
242
# File 'dynamo_db/cfn_global_table.rb', line 240

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object)


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

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

#warm_throughputAWSCDK::IResolvable, ...

Provides visibility into the number of read and write operations your table or secondary index can instantaneously support.



469
470
471
# File 'dynamo_db/cfn_global_table.rb', line 469

def warm_throughput()
  jsii_get_property("warmThroughput")
end

#warm_throughput=(value) ⇒ Object



473
474
475
476
477
# File 'dynamo_db/cfn_global_table.rb', line 473

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


521
522
523
524
525
526
# File 'dynamo_db/cfn_global_table.rb', line 521

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

#write_on_demand_throughput_settingsAWSCDK::IResolvable, ...

Sets the write request settings for a global table or a global secondary index.



482
483
484
# File 'dynamo_db/cfn_global_table.rb', line 482

def write_on_demand_throughput_settings()
  jsii_get_property("writeOnDemandThroughputSettings")
end

#write_on_demand_throughput_settings=(value) ⇒ Object



486
487
488
489
490
# File 'dynamo_db/cfn_global_table.rb', line 486

def write_on_demand_throughput_settings=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::DynamoDB::CfnGlobalTable::WriteOnDemandThroughputSettingsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19keW5hbW9kYi5DZm5HbG9iYWxUYWJsZS5Xcml0ZU9uRGVtYW5kVGhyb3VnaHB1dFNldHRpbmdzUHJvcGVydHkifV19fQ==")), "writeOnDemandThroughputSettings") unless value.nil?
  jsii_set_property("writeOnDemandThroughputSettings", value)
end

#write_provisioned_throughput_settingsAWSCDK::IResolvable, ...

Specifies an auto scaling policy for write capacity.



495
496
497
# File 'dynamo_db/cfn_global_table.rb', line 495

def write_provisioned_throughput_settings()
  jsii_get_property("writeProvisionedThroughputSettings")
end

#write_provisioned_throughput_settings=(value) ⇒ Object



499
500
501
502
503
# File 'dynamo_db/cfn_global_table.rb', line 499

def write_provisioned_throughput_settings=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::DynamoDB::CfnGlobalTable::WriteProvisionedThroughputSettingsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19keW5hbW9kYi5DZm5HbG9iYWxUYWJsZS5Xcml0ZVByb3Zpc2lvbmVkVGhyb3VnaHB1dFNldHRpbmdzUHJvcGVydHkifV19fQ==")), "writeProvisionedThroughputSettings") unless value.nil?
  jsii_set_property("writeProvisionedThroughputSettings", value)
end