Package software.amazon.awscdk.services.dynamodb.global

Class GlobalTableProps.Builder

java.lang.Object
software.amazon.awscdk.services.dynamodb.global.GlobalTableProps.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<GlobalTableProps>
Enclosing interface:
GlobalTableProps
@Stability(Deprecated) @Deprecated public static final class GlobalTableProps.Builder extends Object implements software.amazon.jsii.Builder<GlobalTableProps>
Deprecated.
A builder for GlobalTableProps

  • Constructor Details

    • Builder

      public Builder()
      Deprecated.

  • Method Details

    • regions

      @Stability(Deprecated) @Deprecated public GlobalTableProps.Builder regions(List<String> regions)
      Deprecated.
      Sets the value of GlobalTableProps.getRegions()
      Parameters:
      regions - Array of environments to create DynamoDB tables in. This parameter is required. The tables will all be created in the same account.
      Returns:
      this

    • tableName

      @Stability(Deprecated) @Deprecated public GlobalTableProps.Builder tableName(String tableName)
      Deprecated.
      Sets the value of GlobalTableProps.getTableName()
      Parameters:
      tableName - Name of the DynamoDB table to use across all regional tables. This parameter is required. This is required for global tables.
      Returns:
      this

    • analyticsReporting

      @Stability(Stable) public GlobalTableProps.Builder analyticsReporting(Boolean analyticsReporting)
      Deprecated.
      Sets the value of StackProps.getAnalyticsReporting()
      Parameters:
      analyticsReporting - Include runtime versioning information in this Stack.
      Returns:
      this

    • description

      @Stability(Stable) public GlobalTableProps.Builder description(String description)
      Deprecated.
      Sets the value of StackProps.getDescription()
      Parameters:
      description - A description of the stack.
      Returns:
      this

    • env

      @Stability(Stable) public GlobalTableProps.Builder env(Environment env)
      Deprecated.
      Sets the value of StackProps.getEnv()
      Parameters:
      env - The AWS environment (account/region) where this stack will be deployed. Set the region/account fields of env to either a concrete value to select the indicated environment (recommended for production stacks), or to the values of environment variables CDK_DEFAULT_REGION/CDK_DEFAULT_ACCOUNT to let the target environment depend on the AWS credentials/configuration that the CDK CLI is executed under (recommended for development stacks).

      If the Stack is instantiated inside a Stage, any undefined region/account fields from env will default to the same field on the encompassing Stage, if configured there.

      If either region or account are not set nor inherited from Stage, the Stack will be considered "environment-agnostic"". Environment-agnostic stacks can be deployed to any environment but may not be able to take advantage of all features of the CDK. For example, they will not be able to use environmental context lookups such as ec2.Vpc.fromLookup and will not automatically translate Service Principals to the right format based on the environment's AWS partition, and other such enhancements.

      Returns:
      this

    • stackName

      @Stability(Stable) public GlobalTableProps.Builder stackName(String stackName)
      Deprecated.
      Sets the value of StackProps.getStackName()
      Parameters:
      stackName - Name to deploy the stack with.
      Returns:
      this

    • synthesizer

      @Stability(Stable) public GlobalTableProps.Builder synthesizer(IStackSynthesizer synthesizer)
      Deprecated.
      Sets the value of StackProps.getSynthesizer()
      Parameters:
      synthesizer - Synthesis method to use while deploying this stack.
      Returns:
      this

    • tags

      @Stability(Stable) public GlobalTableProps.Builder tags(Map<String,String> tags)
      Deprecated.
      Sets the value of StackProps.getTags()
      Parameters:
      tags - Stack tags that will be applied to all the taggable resources and the stack itself.
      Returns:
      this

    • terminationProtection

      @Stability(Stable) public GlobalTableProps.Builder terminationProtection(Boolean terminationProtection)
      Deprecated.
      Sets the value of StackProps.getTerminationProtection()
      Parameters:
      terminationProtection - Whether to enable termination protection for this stack.
      Returns:
      this

    • billingMode

      @Stability(Stable) public GlobalTableProps.Builder billingMode(BillingMode billingMode)
      Deprecated.
      Sets the value of TableOptions.getBillingMode()
      Parameters:
      billingMode - Specify how you are charged for read and write throughput and how you manage capacity.
      Returns:
      this

    • contributorInsightsEnabled

      @Stability(Stable) public GlobalTableProps.Builder contributorInsightsEnabled(Boolean contributorInsightsEnabled)
      Deprecated.
      Sets the value of TableOptions.getContributorInsightsEnabled()
      Parameters:
      contributorInsightsEnabled - Whether CloudWatch contributor insights is enabled.
      Returns:
      this

    • encryption

      @Stability(Stable) public GlobalTableProps.Builder encryption(TableEncryption encryption)
      Deprecated.
      Sets the value of TableOptions.getEncryption()
      Parameters:
      encryption - Whether server-side encryption with an AWS managed customer master key is enabled. This property cannot be set if serverSideEncryption is set.

      NOTE: if you set this to CUSTOMER_MANAGED and encryptionKey is not specified, the key that the Tablet generates for you will be created with default permissions. If you are using CDKv2, these permissions will be sufficient to enable the key for use with DynamoDB tables. If you are using CDKv1, make sure the feature flag @aws-cdk/aws-kms:defaultKeyPolicies is set to true in your cdk.json.

      Returns:
      this

    • encryptionKey

      @Stability(Stable) public GlobalTableProps.Builder encryptionKey(IKey encryptionKey)
      Deprecated.
      Sets the value of TableOptions.getEncryptionKey()
      Parameters:
      encryptionKey - External KMS key to use for table encryption. This property can only be set if encryption is set to TableEncryption.CUSTOMER_MANAGED.
      Returns:
      this

    • pointInTimeRecovery

      @Stability(Stable) public GlobalTableProps.Builder pointInTimeRecovery(Boolean pointInTimeRecovery)
      Deprecated.
      Sets the value of TableOptions.getPointInTimeRecovery()
      Parameters:
      pointInTimeRecovery - Whether point-in-time recovery is enabled.
      Returns:
      this

    • readCapacity

      @Stability(Stable) public GlobalTableProps.Builder readCapacity(Number readCapacity)
      Deprecated.
      Sets the value of TableOptions.getReadCapacity()
      Parameters:
      readCapacity - The read capacity for the table. Careful if you add Global Secondary Indexes, as those will share the table's provisioned throughput.

      Can only be provided if billingMode is Provisioned.

      Returns:
      this

    • removalPolicy

      @Stability(Stable) public GlobalTableProps.Builder removalPolicy(RemovalPolicy removalPolicy)
      Deprecated.
      Sets the value of TableOptions.getRemovalPolicy()
      Parameters:
      removalPolicy - The removal policy to apply to the DynamoDB Table.
      Returns:
      this

    • replicationRegions

      @Stability(Stable) public GlobalTableProps.Builder replicationRegions(List<String> replicationRegions)
      Deprecated.
      Sets the value of TableOptions.getReplicationRegions()
      Parameters:
      replicationRegions - Regions where replica tables will be created.
      Returns:
      this

    • replicationTimeout

      @Stability(Stable) public GlobalTableProps.Builder replicationTimeout(Duration replicationTimeout)
      Deprecated.
      Sets the value of TableOptions.getReplicationTimeout()
      Parameters:
      replicationTimeout - The timeout for a table replication operation in a single region.
      Returns:
      this

    • serverSideEncryption

      @Stability(Deprecated) @Deprecated public GlobalTableProps.Builder serverSideEncryption(Boolean serverSideEncryption)
      Deprecated.
      This property is deprecated. In order to obtain the same behavior as enabling this, set the `encryption` property to `TableEncryption.AWS_MANAGED` instead.
      Sets the value of TableOptions.getServerSideEncryption()
      Parameters:
      serverSideEncryption - Whether server-side encryption with an AWS managed customer master key is enabled. This property cannot be set if encryption and/or encryptionKey is set.
      Returns:
      this

    • stream

      @Stability(Stable) public GlobalTableProps.Builder stream(StreamViewType stream)
      Deprecated.
      Sets the value of TableOptions.getStream()
      Parameters:
      stream - When an item in the table is modified, StreamViewType determines what information is written to the stream for this table.
      Returns:
      this

    • tableClass

      @Stability(Stable) public GlobalTableProps.Builder tableClass(TableClass tableClass)
      Deprecated.
      Sets the value of TableOptions.getTableClass()
      Parameters:
      tableClass - Specify the table class.
      Returns:
      this

    • timeToLiveAttribute

      @Stability(Stable) public GlobalTableProps.Builder timeToLiveAttribute(String timeToLiveAttribute)
      Deprecated.
      Sets the value of TableOptions.getTimeToLiveAttribute()
      Parameters:
      timeToLiveAttribute - The name of TTL attribute.
      Returns:
      this

    • waitForReplicationToFinish

      @Stability(Stable) public GlobalTableProps.Builder waitForReplicationToFinish(Boolean waitForReplicationToFinish)
      Deprecated.
      Sets the value of TableOptions.getWaitForReplicationToFinish()
      Parameters:
      waitForReplicationToFinish - Indicates whether CloudFormation stack waits for replication to finish. If set to false, the CloudFormation resource will mark the resource as created and replication will be completed asynchronously. This property is ignored if replicationRegions property is not set.

      DO NOT UNSET this property if adding/removing multiple replicationRegions in one deployment, as CloudFormation only supports one region replication at a time. CDK overcomes this limitation by waiting for replication to finish before starting new replicationRegion.

      Returns:
      this

    • writeCapacity

      @Stability(Stable) public GlobalTableProps.Builder writeCapacity(Number writeCapacity)
      Deprecated.
      Sets the value of TableOptions.getWriteCapacity()
      Parameters:
      writeCapacity - The write capacity for the table. Careful if you add Global Secondary Indexes, as those will share the table's provisioned throughput.

      Can only be provided if billingMode is Provisioned.

      Returns:
      this

    • partitionKey

      @Stability(Stable) public GlobalTableProps.Builder partitionKey(Attribute partitionKey)
      Deprecated.
      Sets the value of SchemaOptions.getPartitionKey()
      Parameters:
      partitionKey - Partition key attribute definition. This parameter is required.
      Returns:
      this

    • sortKey

      @Stability(Stable) public GlobalTableProps.Builder sortKey(Attribute sortKey)
      Deprecated.
      Sets the value of SchemaOptions.getSortKey()
      Parameters:
      sortKey - Sort key attribute definition.
      Returns:
      this

    • build

      @Stability(Deprecated) @Deprecated public GlobalTableProps build()
      Deprecated.
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<GlobalTableProps>
      Returns:
      a new instance of GlobalTableProps
      Throws:
      NullPointerException - if any required attribute was not provided