Skip to content

Latest commit

 

History

History
591 lines (358 loc) · 20.4 KB

API.md

File metadata and controls

591 lines (358 loc) · 20.4 KB

API Reference

Constructs

DataPipelineBackup

  • Implements: aws-cdk-lib.ITaggable

Initializers 

import { DataPipelineBackup } from '@pepperize/cdk-dynamodb-backup'

new DataPipelineBackup(scope: Construct, id: string, props: DataPipelineBackupProps)
Name Type Description
scope constructs.Construct No description.
id string No description.
props DataPipelineBackupProps 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 { DataPipelineBackup } from '@pepperize/cdk-dynamodb-backup'

DataPipelineBackup.isConstruct(x: any)

Checks if x is a construct.

xRequired
  • Type: any

Any object.

Properties

Name Type Description
node constructs.Node The tree node.
instanceProfile aws-cdk-lib.aws_iam.CfnInstanceProfile The instance profile of the emr cluster resources.
resourceRole aws-cdk-lib.aws_iam.IRole The role used by the emr cluster resources.
role aws-cdk-lib.aws_iam.IRole The role used by datapipelines service.
tags aws-cdk-lib.TagManager TagManager to set, remove and format tags.
nodeRequired 
public readonly node: Node;
  • Type: constructs.Node

The tree node.

instanceProfileRequired 
public readonly instanceProfile: CfnInstanceProfile;
  • Type: aws-cdk-lib.aws_iam.CfnInstanceProfile

The instance profile of the emr cluster resources.

resourceRoleRequired 
public readonly resourceRole: IRole;
  • Type: aws-cdk-lib.aws_iam.IRole

The role used by the emr cluster resources.

roleRequired 
public readonly role: IRole;
  • Type: aws-cdk-lib.aws_iam.IRole

The role used by datapipelines service.

tagsRequired 
public readonly tags: TagManager;
  • Type: aws-cdk-lib.TagManager

TagManager to set, remove and format tags.

DataPipelineRestore

  • Implements: aws-cdk-lib.ITaggable

Initializers 

import { DataPipelineRestore } from '@pepperize/cdk-dynamodb-backup'

new DataPipelineRestore(scope: Construct, id: string, props: DataPipelineRestoreProps)
Name Type Description
scope constructs.Construct No description.
id string No description.
props DataPipelineRestoreProps 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 { DataPipelineRestore } from '@pepperize/cdk-dynamodb-backup'

DataPipelineRestore.isConstruct(x: any)

Checks if x is a construct.

xRequired
  • Type: any

Any object.

Properties

Name Type Description
node constructs.Node The tree node.
instanceProfile aws-cdk-lib.aws_iam.CfnInstanceProfile The instance profile of the emr cluster resources.
resourceRole aws-cdk-lib.aws_iam.IRole The role used by the emr cluster resources.
role aws-cdk-lib.aws_iam.IRole The role used by datapipelines service.
tags aws-cdk-lib.TagManager TagManager to set, remove and format tags.
nodeRequired 
public readonly node: Node;
  • Type: constructs.Node

The tree node.

instanceProfileRequired 
public readonly instanceProfile: CfnInstanceProfile;
  • Type: aws-cdk-lib.aws_iam.CfnInstanceProfile

The instance profile of the emr cluster resources.

resourceRoleRequired 
public readonly resourceRole: IRole;
  • Type: aws-cdk-lib.aws_iam.IRole

The role used by the emr cluster resources.

roleRequired 
public readonly role: IRole;
  • Type: aws-cdk-lib.aws_iam.IRole

The role used by datapipelines service.

tagsRequired 
public readonly tags: TagManager;
  • Type: aws-cdk-lib.TagManager

TagManager to set, remove and format tags.

Structs

DataPipelineBackupOptions

Initializer 

import { DataPipelineBackupOptions } from '@pepperize/cdk-dynamodb-backup'

const dataPipelineBackupOptions: DataPipelineBackupOptions = { ... }

Properties

Name Type Description
dynamoDbThroughputRatio number No description.
logsBucket aws-cdk-lib.aws_s3.IBucket No description.
pipelineName string No description.
schedule aws-cdk-lib.Duration No description.
dynamoDbThroughputRatioOptional 
public readonly dynamoDbThroughputRatio: number;
  • Type: number
logsBucketOptional 
public readonly logsBucket: IBucket;
  • Type: aws-cdk-lib.aws_s3.IBucket
pipelineNameOptional 
public readonly pipelineName: string;
  • Type: string
scheduleOptional 
public readonly schedule: Duration;
  • Type: aws-cdk-lib.Duration

DataPipelineBackupProps

Initializer 

import { DataPipelineBackupProps } from '@pepperize/cdk-dynamodb-backup'

const dataPipelineBackupProps: DataPipelineBackupProps = { ... }

Properties

Name Type Description
dynamoDbThroughputRatio number No description.
logsBucket aws-cdk-lib.aws_s3.IBucket No description.
pipelineName string No description.
schedule aws-cdk-lib.Duration No description.
backupBucket aws-cdk-lib.aws_s3.IBucket No description.
table aws-cdk-lib.aws_dynamodb.ITable No description.
dynamoDbThroughputRatioOptional 
public readonly dynamoDbThroughputRatio: number;
  • Type: number
logsBucketOptional 
public readonly logsBucket: IBucket;
  • Type: aws-cdk-lib.aws_s3.IBucket
pipelineNameOptional 
public readonly pipelineName: string;
  • Type: string
scheduleOptional 
public readonly schedule: Duration;
  • Type: aws-cdk-lib.Duration
backupBucketRequired 
public readonly backupBucket: IBucket;
  • Type: aws-cdk-lib.aws_s3.IBucket
tableRequired 
public readonly table: ITable;
  • Type: aws-cdk-lib.aws_dynamodb.ITable

DataPipelineRestoreOptions

Initializer 

import { DataPipelineRestoreOptions } from '@pepperize/cdk-dynamodb-backup'

const dataPipelineRestoreOptions: DataPipelineRestoreOptions = { ... }

Properties

Name Type Description
dynamoDbThroughputRatio number No description.
logsBucket aws-cdk-lib.aws_s3.IBucket No description.
pipelineName string No description.
dynamoDbThroughputRatioOptional 
public readonly dynamoDbThroughputRatio: number;
  • Type: number
logsBucketOptional 
public readonly logsBucket: IBucket;
  • Type: aws-cdk-lib.aws_s3.IBucket
pipelineNameOptional 
public readonly pipelineName: string;
  • Type: string

DataPipelineRestoreProps

Initializer 

import { DataPipelineRestoreProps } from '@pepperize/cdk-dynamodb-backup'

const dataPipelineRestoreProps: DataPipelineRestoreProps = { ... }

Properties

Name Type Description
dynamoDbThroughputRatio number No description.
logsBucket aws-cdk-lib.aws_s3.IBucket No description.
pipelineName string No description.
restoreBucket aws-cdk-lib.aws_s3.IBucket No description.
restoreFolder string No description.
table aws-cdk-lib.aws_dynamodb.ITable No description.
dynamoDbThroughputRatioOptional 
public readonly dynamoDbThroughputRatio: number;
  • Type: number
logsBucketOptional 
public readonly logsBucket: IBucket;
  • Type: aws-cdk-lib.aws_s3.IBucket
pipelineNameOptional 
public readonly pipelineName: string;
  • Type: string
restoreBucketRequired 
public readonly restoreBucket: IBucket;
  • Type: aws-cdk-lib.aws_s3.IBucket
restoreFolderRequired 
public readonly restoreFolder: string;
  • Type: string
tableRequired 
public readonly table: ITable;
  • Type: aws-cdk-lib.aws_dynamodb.ITable