Skip to content

Latest commit

 

History

History
186 lines (110 loc) · 6.23 KB

API.md

File metadata and controls

186 lines (110 loc) · 6.23 KB
Raw

API Reference

Constructs

TerraformStateBackend

Initializers 

import { TerraformStateBackend } from 'terraform-backend-s3-bucket'

new TerraformStateBackend(scope: Construct, id: string, props: TerraformStateBackendProperties)
Name Type Description
scope constructs.Construct No description.
id string No description.
props TerraformStateBackendProperties No description.
scopeRequired
  • Type: constructs.Construct
idRequired
  • Type: string
propsRequired

Methods

Name Description
toString Returns a string representation of this construct.
toString 
public toString(): string

Returns a string representation of this construct.

Static Functions

Name Description
isConstruct Checks if x is a construct.
isConstruct 
import { TerraformStateBackend } from 'terraform-backend-s3-bucket'

TerraformStateBackend.isConstruct(x: any)

Checks if x is a construct.

xRequired
  • Type: any

Any object.

Properties

Name Type Description
node constructs.Node The tree node.
bucket aws-cdk-lib.aws_s3.IBucket No description.
table aws-cdk-lib.aws_dynamodb.ITable No description.
nodeRequired 
public readonly node: Node;
  • Type: constructs.Node

The tree node.

bucketRequired 
public readonly bucket: IBucket;
  • Type: aws-cdk-lib.aws_s3.IBucket
tableRequired 
public readonly table: ITable;
  • Type: aws-cdk-lib.aws_dynamodb.ITable

Structs

TerraformStateBackendProperties

Initializer 

import { TerraformStateBackendProperties } from 'terraform-backend-s3-bucket'

const terraformStateBackendProperties: TerraformStateBackendProperties = { ... }

Properties

Name Type Description
bucketName string The name of the bucket to create.
tableName string The name of the DynamoDB table to create.
tableDeletionProtection boolean Whether to protect the created DynamoDB table from being accidentally deleted.
bucketNameRequired 
public readonly bucketName: string;
  • Type: string

The name of the bucket to create.

tableNameRequired 
public readonly tableName: string;
  • Type: string

The name of the DynamoDB table to create.

tableDeletionProtectionOptional 
public readonly tableDeletionProtection: boolean;
  • Type: boolean
  • Default: false

Whether to protect the created DynamoDB table from being accidentally deleted.