software.amazon.awscdk.services.sam

Class CfnSimpleTable

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.sam.CfnSimpleTable

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:40.098Z")
public class CfnSimpleTable
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Serverless::SimpleTable`.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.sam.*;
 CfnSimpleTable cfnSimpleTable = CfnSimpleTable.Builder.create(this, "MyCfnSimpleTable")
         .primaryKey(PrimaryKeyProperty.builder()
                 .type("type")
                 // the properties below are optional
                 .name("name")
                 .build())
         .provisionedThroughput(ProvisionedThroughputProperty.builder()
                 .writeCapacityUnits(123)
                 // the properties below are optional
                 .readCapacityUnits(123)
                 .build())
         .sseSpecification(SSESpecificationProperty.builder()
                 .sseEnabled(false)
                 .build())
         .tableName("tableName")
         .tags(Map.of(
                 "tagsKey", "tags"))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnSimpleTable.Builder A fluent builder for CfnSimpleTable.
static interface	CfnSimpleTable.PrimaryKeyProperty Example:
static interface	CfnSimpleTable.ProvisionedThroughputProperty Example:
static interface	CfnSimpleTable.SSESpecificationProperty Example:

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.
static java.lang.String	REQUIRED_TRANSFORM The `Transform` a template must use in order to use this resource.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnSimpleTable(Construct scope, java.lang.String id) Create a new `AWS::Serverless::SimpleTable`.
	CfnSimpleTable(Construct scope, java.lang.String id, CfnSimpleTableProps props) Create a new `AWS::Serverless::SimpleTable`.
protected	CfnSimpleTable(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnSimpleTable(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.Object	getPrimaryKey() `AWS::Serverless::SimpleTable.PrimaryKey`.
java.lang.Object	getProvisionedThroughput() `AWS::Serverless::SimpleTable.ProvisionedThroughput`.
java.lang.Object	getSseSpecification() `AWS::Serverless::SimpleTable.SSESpecification`.
java.lang.String	getTableName() `AWS::Serverless::SimpleTable.TableName`.
TagManager	getTags() `AWS::Serverless::SimpleTable.Tags`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setPrimaryKey(CfnSimpleTable.PrimaryKeyProperty value) `AWS::Serverless::SimpleTable.PrimaryKey`.
void	setPrimaryKey(IResolvable value) `AWS::Serverless::SimpleTable.PrimaryKey`.
void	setProvisionedThroughput(CfnSimpleTable.ProvisionedThroughputProperty value) `AWS::Serverless::SimpleTable.ProvisionedThroughput`.
void	setProvisionedThroughput(IResolvable value) `AWS::Serverless::SimpleTable.ProvisionedThroughput`.
void	setSseSpecification(CfnSimpleTable.SSESpecificationProperty value) `AWS::Serverless::SimpleTable.SSESpecification`.
void	setSseSpecification(IResolvable value) `AWS::Serverless::SimpleTable.SSESpecification`.
void	setTableName(java.lang.String value) `AWS::Serverless::SimpleTable.TableName`.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

REQUIRED_TRANSFORM

public static final java.lang.String REQUIRED_TRANSFORM

The `Transform` a template must use in order to use this resource.

Constructor Detail

CfnSimpleTable

protected CfnSimpleTable(software.amazon.jsii.JsiiObjectRef objRef)

CfnSimpleTable

protected CfnSimpleTable(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnSimpleTable

public CfnSimpleTable(Construct scope,
                      java.lang.String id,
                      CfnSimpleTableProps props)

Create a new `AWS::Serverless::SimpleTable`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties.

CfnSimpleTable

public CfnSimpleTable(Construct scope,
                      java.lang.String id)

Create a new `AWS::Serverless::SimpleTable`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

Method Detail

inspect

public void inspect(TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

public TagManager getTags()

`AWS::Serverless::SimpleTable.Tags`.

getPrimaryKey

public java.lang.Object getPrimaryKey()

`AWS::Serverless::SimpleTable.PrimaryKey`.

setPrimaryKey

public void setPrimaryKey(IResolvable value)

`AWS::Serverless::SimpleTable.PrimaryKey`.

setPrimaryKey

public void setPrimaryKey(CfnSimpleTable.PrimaryKeyProperty value)

`AWS::Serverless::SimpleTable.PrimaryKey`.

getProvisionedThroughput

public java.lang.Object getProvisionedThroughput()

`AWS::Serverless::SimpleTable.ProvisionedThroughput`.

setProvisionedThroughput

public void setProvisionedThroughput(IResolvable value)

`AWS::Serverless::SimpleTable.ProvisionedThroughput`.

setProvisionedThroughput

public void setProvisionedThroughput(CfnSimpleTable.ProvisionedThroughputProperty value)

`AWS::Serverless::SimpleTable.ProvisionedThroughput`.

getSseSpecification

public java.lang.Object getSseSpecification()

`AWS::Serverless::SimpleTable.SSESpecification`.

setSseSpecification

public void setSseSpecification(IResolvable value)

`AWS::Serverless::SimpleTable.SSESpecification`.

setSseSpecification

public void setSseSpecification(CfnSimpleTable.SSESpecificationProperty value)

`AWS::Serverless::SimpleTable.SSESpecification`.

getTableName

public java.lang.String getTableName()

`AWS::Serverless::SimpleTable.TableName`.

setTableName

public void setTableName(java.lang.String value)

`AWS::Serverless::SimpleTable.TableName`.