software.amazon.awscdk.services.sam

Class CfnSimpleTable

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.sam.CfnSimpleTable

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:41.996Z")
 @Stability(value=Stable)
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 class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnSimpleTable(software.constructs.Construct scope, String id) Create a new `AWS::Serverless::SimpleTable`.
	CfnSimpleTable(software.constructs.Construct scope, 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 Map<String,Object>	getCfnProperties()
Object	getPrimaryKey() `AWS::Serverless::SimpleTable.PrimaryKey`.
Object	getProvisionedThroughput() `AWS::Serverless::SimpleTable.ProvisionedThroughput`.
Object	getSseSpecification() `AWS::Serverless::SimpleTable.SSESpecification`.
String	getTableName() `AWS::Serverless::SimpleTable.TableName`.
TagManager	getTags() `AWS::Serverless::SimpleTable.Tags`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,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(String value) `AWS::Serverless::SimpleTable.TableName`.

Methods inherited from class software.amazon.awscdk.CfnResource

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

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

REQUIRED_TRANSFORM

@Stability(value=Stable)
public static final 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

@Stability(value=Stable)
public CfnSimpleTable(@NotNull
                                               software.constructs.Construct scope,
                                               @NotNull
                                               String id,
                                               @Nullable
                                               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

@Stability(value=Stable)
public CfnSimpleTable(@NotNull
                                               software.constructs.Construct scope,
                                               @NotNull
                                               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

@Stability(value=Stable)
public void inspect(@NotNull
                                             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

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

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

getPrimaryKey

@Stability(value=Stable)
 @Nullable
public Object getPrimaryKey()

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

setPrimaryKey

@Stability(value=Stable)
public void setPrimaryKey(@Nullable
                                                   CfnSimpleTable.PrimaryKeyProperty value)

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

setPrimaryKey

@Stability(value=Stable)
public void setPrimaryKey(@Nullable
                                                   IResolvable value)

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

getProvisionedThroughput

@Stability(value=Stable)
 @Nullable
public Object getProvisionedThroughput()

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

setProvisionedThroughput

@Stability(value=Stable)
public void setProvisionedThroughput(@Nullable
                                                              CfnSimpleTable.ProvisionedThroughputProperty value)

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

setProvisionedThroughput

@Stability(value=Stable)
public void setProvisionedThroughput(@Nullable
                                                              IResolvable value)

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

getSseSpecification

@Stability(value=Stable)
 @Nullable
public Object getSseSpecification()

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

setSseSpecification

@Stability(value=Stable)
public void setSseSpecification(@Nullable
                                                         CfnSimpleTable.SSESpecificationProperty value)

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

setSseSpecification

@Stability(value=Stable)
public void setSseSpecification(@Nullable
                                                         IResolvable value)

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

getTableName

@Stability(value=Stable)
 @Nullable
public String getTableName()

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

setTableName

@Stability(value=Stable)
public void setTableName(@Nullable
                                                  String value)

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