@Deprecated public static final class GlobalTableProps.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements GlobalTableProps
GlobalTableProps
GlobalTableProps.Builder, GlobalTableProps.Jsii$Proxy
Modifier | Constructor and Description |
---|---|
protected |
Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
Deprecated.
Constructor that initializes the object based on values retrieved from the JsiiObject.
|
Modifier and Type | Method and Description |
---|---|
com.fasterxml.jackson.databind.JsonNode |
$jsii$toJson()
Deprecated.
|
boolean |
equals(java.lang.Object o)
Deprecated.
|
java.lang.Boolean |
getAnalyticsReporting()
Deprecated.
Include runtime versioning information in this Stack.
|
BillingMode |
getBillingMode()
Deprecated.
Specify how you are charged for read and write throughput and how you manage capacity.
|
java.lang.Boolean |
getContributorInsightsEnabled()
Deprecated.
Whether CloudWatch contributor insights is enabled.
|
java.lang.String |
getDescription()
Deprecated.
A description of the stack.
|
TableEncryption |
getEncryption()
Deprecated.
Whether server-side encryption with an AWS managed customer master key is enabled.
|
IKey |
getEncryptionKey()
Deprecated.
External KMS key to use for table encryption.
|
Environment |
getEnv()
Deprecated.
The AWS environment (account/region) where this stack will be deployed.
|
Attribute |
getPartitionKey()
Deprecated.
Partition key attribute definition.
|
java.lang.Boolean |
getPointInTimeRecovery()
Deprecated.
Whether point-in-time recovery is enabled.
|
java.lang.Number |
getReadCapacity()
Deprecated.
The read capacity for the table.
|
java.util.List<java.lang.String> |
getRegions()
Deprecated.
(deprecated) Array of environments to create DynamoDB tables in.
|
RemovalPolicy |
getRemovalPolicy()
Deprecated.
The removal policy to apply to the DynamoDB Table.
|
java.util.List<java.lang.String> |
getReplicationRegions()
Deprecated.
Regions where replica tables will be created.
|
Duration |
getReplicationTimeout()
Deprecated.
The timeout for a table replication operation in a single region.
|
java.lang.Boolean |
getServerSideEncryption()
Deprecated.
(deprecated) Whether server-side encryption with an AWS managed customer master key is enabled.
|
Attribute |
getSortKey()
Deprecated.
Sort key attribute definition.
|
java.lang.String |
getStackName()
Deprecated.
Name to deploy the stack with.
|
StreamViewType |
getStream()
Deprecated.
When an item in the table is modified, StreamViewType determines what information is written to the stream for this table.
|
IStackSynthesizer |
getSynthesizer()
Deprecated.
Synthesis method to use while deploying this stack.
|
TableClass |
getTableClass()
Deprecated.
Specify the table class.
|
java.lang.String |
getTableName()
Deprecated.
(deprecated) Name of the DynamoDB table to use across all regional tables.
|
java.util.Map<java.lang.String,java.lang.String> |
getTags()
Deprecated.
Stack tags that will be applied to all the taggable resources and the stack itself.
|
java.lang.Boolean |
getTerminationProtection()
Deprecated.
Whether to enable termination protection for this stack.
|
java.lang.String |
getTimeToLiveAttribute()
Deprecated.
The name of TTL attribute.
|
java.lang.Boolean |
getWaitForReplicationToFinish()
Deprecated.
Indicates whether CloudFormation stack waits for replication to finish.
|
java.lang.Number |
getWriteCapacity()
Deprecated.
The write capacity for the table.
|
int |
hashCode()
Deprecated.
|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
builder
protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
objRef
- Reference to the JSII managed object.public final java.util.List<java.lang.String> getRegions()
GlobalTableProps
The tables will all be created in the same account.
getRegions
in interface GlobalTableProps
public final java.lang.String getTableName()
GlobalTableProps
This is required for global tables.
getTableName
in interface GlobalTableProps
public final java.lang.Boolean getAnalyticsReporting()
StackProps
Default: `analyticsReporting` setting of containing `App`, or value of 'aws:cdk:version-reporting' context key
getAnalyticsReporting
in interface StackProps
public final java.lang.String getDescription()
StackProps
Default: - No description.
getDescription
in interface StackProps
public final Environment getEnv()
StackProps
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");
getEnv
in interface StackProps
public final java.lang.String getStackName()
StackProps
Default: - Derived from construct path.
getStackName
in interface StackProps
public final IStackSynthesizer getSynthesizer()
StackProps
Default: - `DefaultStackSynthesizer` if the `@aws-cdk/core:newStyleStackSynthesis` feature flag is set, `LegacyStackSynthesizer` otherwise.
getSynthesizer
in interface StackProps
public final java.util.Map<java.lang.String,java.lang.String> getTags()
StackProps
Default: {}
getTags
in interface StackProps
public final java.lang.Boolean getTerminationProtection()
StackProps
Default: false
getTerminationProtection
in interface StackProps
public final BillingMode getBillingMode()
TableOptions
Default: PROVISIONED if `replicationRegions` is not specified, PAY_PER_REQUEST otherwise
getBillingMode
in interface TableOptions
public final java.lang.Boolean getContributorInsightsEnabled()
TableOptions
Default: false
getContributorInsightsEnabled
in interface TableOptions
public final TableEncryption getEncryption()
TableOptions
This property cannot be set if serverSideEncryption
is set.
NOTE: if you set this to
CUSTOMER_MANAGED
andencryptionKey
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 totrue
in yourcdk.json
.
Default: - server-side encryption is enabled with an AWS owned customer master key
getEncryption
in interface TableOptions
public final IKey getEncryptionKey()
TableOptions
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.
getEncryptionKey
in interface TableOptions
public final java.lang.Boolean getPointInTimeRecovery()
TableOptions
Default: - point-in-time recovery is disabled
getPointInTimeRecovery
in interface TableOptions
public final java.lang.Number getReadCapacity()
TableOptions
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
getReadCapacity
in interface TableOptions
public final RemovalPolicy getRemovalPolicy()
TableOptions
Default: RemovalPolicy.RETAIN
getRemovalPolicy
in interface TableOptions
public final java.util.List<java.lang.String> getReplicationRegions()
TableOptions
Default: - no replica tables are created
getReplicationRegions
in interface TableOptions
public final Duration getReplicationTimeout()
TableOptions
Default: Duration.minutes(30)
getReplicationTimeout
in interface TableOptions
public final java.lang.Boolean getServerSideEncryption()
TableOptions
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
getServerSideEncryption
in interface TableOptions
public final StreamViewType getStream()
TableOptions
Default: - streams are disabled unless `replicationRegions` is specified
getStream
in interface TableOptions
public final TableClass getTableClass()
TableOptions
Default: STANDARD
getTableClass
in interface TableOptions
public final java.lang.String getTimeToLiveAttribute()
TableOptions
Default: - TTL is disabled
getTimeToLiveAttribute
in interface TableOptions
public final java.lang.Boolean getWaitForReplicationToFinish()
TableOptions
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
public final java.lang.Number getWriteCapacity()
TableOptions
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
getWriteCapacity
in interface TableOptions
public final Attribute getPartitionKey()
SchemaOptions
getPartitionKey
in interface SchemaOptions
public final Attribute getSortKey()
SchemaOptions
Default: no sort key
getSortKey
in interface SchemaOptions
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
public final boolean equals(java.lang.Object o)
public final int hashCode()