Package software.amazon.awscdk.services.sam

Class CfnSimpleTable

java.lang.Object
software.amazon.jsii.JsiiObject
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:
software.amazon.awscdk.core.IConstruct, software.amazon.awscdk.core.IDependable, software.amazon.awscdk.core.IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-05-31T18:44:07.466Z") @Stability(Stable) public class CfnSimpleTable extends software.amazon.awscdk.core.CfnResource implements software.amazon.awscdk.core.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
    Description
    static final 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.core.IConstruct

    software.amazon.awscdk.core.IConstruct.Jsii$Default

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

    software.constructs.IConstruct.Jsii$Default

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

    software.amazon.awscdk.core.IInspectable.Jsii$Default, software.amazon.awscdk.core.IInspectable.Jsii$Proxy

  • Field Summary

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

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
     
    CfnSimpleTable(software.amazon.awscdk.core.Construct scope, String id)
    Create a new `AWS::Serverless::SimpleTable`.
     
    CfnSimpleTable(software.amazon.awscdk.core.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
    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`.
    software.amazon.awscdk.core.TagManager
    getTags()
    `AWS::Serverless::SimpleTable.Tags`.
    void
    inspect(software.amazon.awscdk.core.TreeInspector inspector)
    Examines the CloudFormation resource and discloses attributes.
    protected Map<String,Object>
    renderProperties(Map<String,Object> props)
     
    void
    setPrimaryKey(software.amazon.awscdk.core.IResolvable value)
    `AWS::Serverless::SimpleTable.PrimaryKey`.
    void
    setPrimaryKey(CfnSimpleTable.PrimaryKeyProperty value)
    `AWS::Serverless::SimpleTable.PrimaryKey`.
    void
    setProvisionedThroughput(software.amazon.awscdk.core.IResolvable value)
    `AWS::Serverless::SimpleTable.ProvisionedThroughput`.
    void
    setProvisionedThroughput(CfnSimpleTable.ProvisionedThroughputProperty value)
    `AWS::Serverless::SimpleTable.ProvisionedThroughput`.
    void
    setSseSpecification(software.amazon.awscdk.core.IResolvable value)
    `AWS::Serverless::SimpleTable.SSESpecification`.
    void
    setSseSpecification(CfnSimpleTable.SSESpecificationProperty value)
    `AWS::Serverless::SimpleTable.SSESpecification`.
    void
    setTableName(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 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 Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

    • REQUIRED_TRANSFORM

      @Stability(Stable) public static final String REQUIRED_TRANSFORM
      The `Transform` a template must use in order to use this resource.

  • Constructor Details

    • CfnSimpleTable

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

    • CfnSimpleTable

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

    • CfnSimpleTable

      @Stability(Stable) public CfnSimpleTable(@NotNull software.amazon.awscdk.core.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(Stable) public CfnSimpleTable(@NotNull software.amazon.awscdk.core.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 Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull software.amazon.awscdk.core.TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface software.amazon.awscdk.core.IInspectable
      Parameters:
      inspector - - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class software.amazon.awscdk.core.CfnResource
      Parameters:
      props - This parameter is required.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class software.amazon.awscdk.core.CfnResource

    • getTags

      @Stability(Stable) @NotNull public software.amazon.awscdk.core.TagManager getTags()
      `AWS::Serverless::SimpleTable.Tags`.

    • getPrimaryKey

      @Stability(Stable) @Nullable public Object getPrimaryKey()
      `AWS::Serverless::SimpleTable.PrimaryKey`.

    • setPrimaryKey

      @Stability(Stable) public void setPrimaryKey(@Nullable software.amazon.awscdk.core.IResolvable value)
      `AWS::Serverless::SimpleTable.PrimaryKey`.

    • setPrimaryKey

      @Stability(Stable) public void setPrimaryKey(@Nullable CfnSimpleTable.PrimaryKeyProperty value)
      `AWS::Serverless::SimpleTable.PrimaryKey`.

    • getProvisionedThroughput

      @Stability(Stable) @Nullable public Object getProvisionedThroughput()
      `AWS::Serverless::SimpleTable.ProvisionedThroughput`.

    • setProvisionedThroughput

      @Stability(Stable) public void setProvisionedThroughput(@Nullable software.amazon.awscdk.core.IResolvable value)
      `AWS::Serverless::SimpleTable.ProvisionedThroughput`.

    • setProvisionedThroughput

      @Stability(Stable) public void setProvisionedThroughput(@Nullable CfnSimpleTable.ProvisionedThroughputProperty value)
      `AWS::Serverless::SimpleTable.ProvisionedThroughput`.

    • getSseSpecification

      @Stability(Stable) @Nullable public Object getSseSpecification()
      `AWS::Serverless::SimpleTable.SSESpecification`.

    • setSseSpecification

      @Stability(Stable) public void setSseSpecification(@Nullable software.amazon.awscdk.core.IResolvable value)
      `AWS::Serverless::SimpleTable.SSESpecification`.

    • setSseSpecification

      @Stability(Stable) public void setSseSpecification(@Nullable CfnSimpleTable.SSESpecificationProperty value)
      `AWS::Serverless::SimpleTable.SSESpecification`.

    • getTableName

      @Stability(Stable) @Nullable public String getTableName()
      `AWS::Serverless::SimpleTable.TableName`.

    • setTableName

      @Stability(Stable) public void setTableName(@Nullable String value)
      `AWS::Serverless::SimpleTable.TableName`.