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

Class GlobalTableProps.Jsii$Proxy

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.dynamodb.global.GlobalTableProps.Jsii$Proxy
All Implemented Interfaces:
StackProps, GlobalTableProps, SchemaOptions, TableOptions, software.amazon.jsii.JsiiSerializable
Enclosing interface:
GlobalTableProps
@Stability(Deprecated) @Deprecated @Internal public static final class GlobalTableProps.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements GlobalTableProps
Deprecated.
An implementation for GlobalTableProps

  • Constructor Details

    • Jsii$Proxy

      protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
      Deprecated.
      Constructor that initializes the object based on values retrieved from the JsiiObject.
      Parameters:
      objRef - Reference to the JSII managed object.

    • Jsii$Proxy

      protected Jsii$Proxy(GlobalTableProps.Builder builder)
      Deprecated.
      Constructor that initializes the object based on literal property values passed by the GlobalTableProps.Builder.

  • Method Details

    • getRegions

      public final List<String> getRegions()
      Deprecated.
      Description copied from interface: GlobalTableProps
      (deprecated) Array of environments to create DynamoDB tables in.

      The tables will all be created in the same account.

      Specified by:
      getRegions in interface GlobalTableProps

    • getTableName

      public final String getTableName()
      Deprecated.
      Description copied from interface: GlobalTableProps
      (deprecated) Name of the DynamoDB table to use across all regional tables.

      This is required for global tables.

      Specified by:
      getTableName in interface GlobalTableProps

    • getAnalyticsReporting

      public final Boolean getAnalyticsReporting()
      Deprecated.
      Description copied from interface: StackProps
      Include runtime versioning information in this Stack.

      Default: `analyticsReporting` setting of containing `App`, or value of 'aws:cdk:version-reporting' context key

      Specified by:
      getAnalyticsReporting in interface StackProps

    • getDescription

      public final String getDescription()
      Deprecated.
      Description copied from interface: StackProps
      A description of the stack.

      Default: - No description.

      Specified by:
      getDescription in interface StackProps

    • getEnv

      public final Environment getEnv()
      Deprecated.
      Description copied from interface: StackProps
      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.

      Default: - The environment of the containing `Stage` if available, otherwise create the stack will be environment-agnostic.

      Example: 

       // Use a concrete account and region to deploy this stack to:
 // `.account` and `.region` will simply return these values.
 // Use a concrete account and region to deploy this stack to:
 // `.account` and `.region` will simply return these values.
 Stack.Builder.create(app, "Stack1")
         .env(Environment.builder()
                 .account("123456789012")
                 .region("us-east-1")
                 .build())
         .build();
 // Use the CLI's current credentials to determine the target environment:
 // `.account` and `.region` will reflect the account+region the CLI
 // is configured to use (based on the user CLI credentials)
 // Use the CLI's current credentials to determine the target environment:
 // `.account` and `.region` will reflect the account+region the CLI
 // is configured to use (based on the user CLI credentials)
 Stack.Builder.create(app, "Stack2")
         .env(Environment.builder()
                 .account(process.getEnv().getCDK_DEFAULT_ACCOUNT())
                 .region(process.getEnv().getCDK_DEFAULT_REGION())
                 .build())
         .build();
 // Define multiple stacks stage associated with an environment
 Stage myStage = Stage.Builder.create(app, "MyStage")
         .env(Environment.builder()
                 .account("123456789012")
                 .region("us-east-1")
                 .build())
         .build();
 // both of these stacks will use the stage's account/region:
 // `.account` and `.region` will resolve to the concrete values as above
 // both of these stacks will use the stage's account/region:
 // `.account` and `.region` will resolve to the concrete values as above
 new MyStack(myStage, "Stack1");
 new YourStack(myStage, "Stack2");
 // Define an environment-agnostic stack:
 // `.account` and `.region` will resolve to `{ "Ref": "AWS::AccountId" }` and `{ "Ref": "AWS::Region" }` respectively.
 // which will only resolve to actual values by CloudFormation during deployment.
 // Define an environment-agnostic stack:
 // `.account` and `.region` will resolve to `{ "Ref": "AWS::AccountId" }` and `{ "Ref": "AWS::Region" }` respectively.
 // which will only resolve to actual values by CloudFormation during deployment.
 new MyStack(app, "Stack1");
      Specified by:
      getEnv in interface StackProps

    • getStackName

      public final String getStackName()
      Deprecated.
      Description copied from interface: StackProps
      Name to deploy the stack with.

      Default: - Derived from construct path.

      Specified by:
      getStackName in interface StackProps

    • getSynthesizer

      public final IStackSynthesizer getSynthesizer()
      Deprecated.
      Description copied from interface: StackProps
      Synthesis method to use while deploying this stack.

      Default: - `DefaultStackSynthesizer` if the `@aws-cdk/core:newStyleStackSynthesis` feature flag is set, `LegacyStackSynthesizer` otherwise.

      Specified by:
      getSynthesizer in interface StackProps

    • getTags

      public final Map<String,String> getTags()
      Deprecated.
      Description copied from interface: StackProps
      Stack tags that will be applied to all the taggable resources and the stack itself.

      Default: {}

      Specified by:
      getTags in interface StackProps

    • getTerminationProtection

      public final Boolean getTerminationProtection()
      Deprecated.
      Description copied from interface: StackProps
      Whether to enable termination protection for this stack.

      Default: false

      Specified by:
      getTerminationProtection in interface StackProps

    • getBillingMode

      public final BillingMode getBillingMode()
      Deprecated.
      Description copied from interface: TableOptions
      Specify how you are charged for read and write throughput and how you manage capacity.

      Default: PROVISIONED if `replicationRegions` is not specified, PAY_PER_REQUEST otherwise

      Specified by:
      getBillingMode in interface TableOptions

    • getContributorInsightsEnabled

      public final Boolean getContributorInsightsEnabled()
      Deprecated.
      Description copied from interface: TableOptions
      Whether CloudWatch contributor insights is enabled.

      Default: false

      Specified by:
      getContributorInsightsEnabled in interface TableOptions

    • getEncryption

      public final TableEncryption getEncryption()
      Deprecated.
      Description copied from interface: TableOptions
      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.

      Default: - server-side encryption is enabled with an AWS owned customer master key

      Specified by:
      getEncryption in interface TableOptions

    • getEncryptionKey

      public final IKey getEncryptionKey()
      Deprecated.
      Description copied from interface: TableOptions
      External KMS key to use for table encryption.

      This property can only be set if encryption is set to TableEncryption.CUSTOMER_MANAGED.

      Default: - If `encryption` is set to `TableEncryption.CUSTOMER_MANAGED` and this property is undefined, a new KMS key will be created and associated with this table.

      Specified by:
      getEncryptionKey in interface TableOptions

    • getPointInTimeRecovery

      public final Boolean getPointInTimeRecovery()
      Deprecated.
      Description copied from interface: TableOptions
      Whether point-in-time recovery is enabled.

      Default: - point-in-time recovery is disabled

      Specified by:
      getPointInTimeRecovery in interface TableOptions

    • getReadCapacity

      public final Number getReadCapacity()
      Deprecated.
      Description copied from interface: TableOptions
      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.

      Default: 5

      Specified by:
      getReadCapacity in interface TableOptions

    • getRemovalPolicy

      public final RemovalPolicy getRemovalPolicy()
      Deprecated.
      Description copied from interface: TableOptions
      The removal policy to apply to the DynamoDB Table.

      Default: RemovalPolicy.RETAIN

      Specified by:
      getRemovalPolicy in interface TableOptions

    • getReplicationRegions

      public final List<String> getReplicationRegions()
      Deprecated.
      Description copied from interface: TableOptions
      Regions where replica tables will be created.

      Default: - no replica tables are created

      Specified by:
      getReplicationRegions in interface TableOptions

    • getReplicationTimeout

      public final Duration getReplicationTimeout()
      Deprecated.
      Description copied from interface: TableOptions
      The timeout for a table replication operation in a single region.

      Default: Duration.minutes(30)

      Specified by:
      getReplicationTimeout in interface TableOptions

    • getServerSideEncryption

      public final Boolean getServerSideEncryption()
      Deprecated.
      Description copied from interface: TableOptions
      (deprecated) 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.

      Default: - server-side encryption is enabled with an AWS owned customer master key

      Specified by:
      getServerSideEncryption in interface TableOptions

    • getStream

      public final StreamViewType getStream()
      Deprecated.
      Description copied from interface: TableOptions
      When an item in the table is modified, StreamViewType determines what information is written to the stream for this table.

      Default: - streams are disabled unless `replicationRegions` is specified

      Specified by:
      getStream in interface TableOptions

    • getTableClass

      public final TableClass getTableClass()
      Deprecated.
      Description copied from interface: TableOptions
      Specify the table class.

      Default: STANDARD

      Specified by:
      getTableClass in interface TableOptions

    • getTimeToLiveAttribute

      public final String getTimeToLiveAttribute()
      Deprecated.
      Description copied from interface: TableOptions
      The name of TTL attribute.

      Default: - TTL is disabled

      Specified by:
      getTimeToLiveAttribute in interface TableOptions

    • getWaitForReplicationToFinish

      public final Boolean getWaitForReplicationToFinish()
      Deprecated.
      Description copied from interface: TableOptions
      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.

      Default: true

      Specified by:
      getWaitForReplicationToFinish in interface TableOptions
      See Also:

    • getWriteCapacity

      public final Number getWriteCapacity()
      Deprecated.
      Description copied from interface: TableOptions
      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.

      Default: 5

      Specified by:
      getWriteCapacity in interface TableOptions

    • getPartitionKey

      public final Attribute getPartitionKey()
      Deprecated.
      Description copied from interface: SchemaOptions
      Partition key attribute definition.
      Specified by:
      getPartitionKey in interface SchemaOptions

    • getSortKey

      public final Attribute getSortKey()
      Deprecated.
      Description copied from interface: SchemaOptions
      Sort key attribute definition.

      Default: no sort key

      Specified by:
      getSortKey in interface SchemaOptions

    • $jsii$toJson

      @Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
      Deprecated.
      Specified by:
      $jsii$toJson in interface software.amazon.jsii.JsiiSerializable

    • equals

      public final boolean equals(Object o)
      Deprecated.
      Overrides:
      equals in class Object

    • hashCode

      public final int hashCode()
      Deprecated.
      Overrides:
      hashCode in class Object