Skip to content

API.md

Latest commit

 

History

History
144 lines (75 loc) · 5.77 KB

API.md

File metadata and controls

144 lines (75 loc) · 5.77 KB

API Reference

Classes

Name Description
TempStack No description
TimeToLive No description

Structs

Name Description
TempStackProps No description
TimeToLiveProps No description

class TempStack

Implements: IConstruct, IConstruct, IConstruct, IDependable, ITaggable Extends: Stack

Initializer

new TempStack(scope: Construct, id: string, props: TempStackProps)
  • scope (Construct) No description
  • id (string) No description
  • props (TempStackProps) No description
    • analyticsReporting (boolean) Include runtime versioning information in this Stack. Default: analyticsReporting setting of containing App, or value of 'aws:cdk:version-reporting' context key
    • description (string) A description of the stack. Default: No description.
    • env (Environment) The AWS environment (account/region) where this stack will be deployed. Default: The environment of the containing Stage if available, otherwise create the stack will be environment-agnostic.
    • stackName (string) Name to deploy the stack with. Default: Derived from construct path.
    • synthesizer (IStackSynthesizer) Synthesis method to use while deploying this stack. Default: DefaultStackSynthesizer if the @aws-cdk/core:newStyleStackSynthesis feature flag is set, LegacyStackSynthesizer otherwise.
    • tags (Map<string, string>) Stack tags that will be applied to all the taggable resources and the stack itself. Default: {}
    • terminationProtection (boolean) Whether to enable termination protection for this stack. Default: false
    • ttl (Duration) Specifies the Time to Live (TTL) settings for the stack.

class TimeToLive

Implements: IConstruct, IConstruct, IConstruct, IDependable Extends: Construct

Initializer

new TimeToLive(scope: Construct, id: string, props: TimeToLiveProps)
  • scope (Construct) No description
  • id (string) No description
  • props (TimeToLiveProps) No description
    • ttl (Duration) Specifies the Time to Live (TTL) settings for the stack.

Methods

protected onPrepare()

Perform final modifications before synthesis.

This method can be implemented by derived constructs in order to perform final changes before synthesis. prepare() will be called after child constructs have been prepared.

This is an advanced framework feature. Only use this if you understand the implications.

protected onPrepare(): void

protected validate()

Validate the current construct.

This method can be implemented by derived constructs in order to perform validation logic. It is called on all constructs before synthesis.

protected validate(): Array<string>

Returns:

  • Array

struct TempStackProps

Name Type Description
ttl Duration Specifies the Time to Live (TTL) settings for the stack.
analyticsReporting? boolean Include runtime versioning information in this Stack.
Default: analyticsReporting setting of containing App, or value of 'aws:cdk:version-reporting' context key
description? string A description of the stack.
Default: No description.
env? Environment The AWS environment (account/region) where this stack will be deployed.
Default: The environment of the containing Stage if available, otherwise create the stack will be environment-agnostic.
stackName? string Name to deploy the stack with.
Default: Derived from construct path.
synthesizer? IStackSynthesizer Synthesis method to use while deploying this stack.
Default: DefaultStackSynthesizer if the @aws-cdk/core:newStyleStackSynthesis feature flag is set, LegacyStackSynthesizer otherwise.
tags? Map<string, string> Stack tags that will be applied to all the taggable resources and the stack itself.
Default: {}
terminationProtection? boolean Whether to enable termination protection for this stack.
Default: false

struct TimeToLiveProps

Name Type Description
ttl Duration Specifies the Time to Live (TTL) settings for the stack.