Options
All
  • Public
  • Public/Protected
  • All
Menu

Module @aws-accelerator/config

Index

References

Classes Codec

Classes Other

Interfaces

Type aliases Codec

Type aliases Other

Variables Other

Variables primitives

Functions Other

Functions combinators

Functions constructors

References

type

Renames and re-exports interface

Codec Type aliases

TypeOf

TypeOf<C>: C["_A"]
since

1.0.0

Type parameters

Other Type aliases

AllowDeny

AllowDeny: TypeOf<typeof allowDeny>

AvailabilityZone

AvailabilityZone: TypeOf<typeof availabilityZone>

Cidr

Cidr: TypeOf<typeof cidr>

Definition

Definition<P>: TypeC<P> & { definitionName: string }

Type parameters

EnableDisable

EnableDisable: TypeOf<typeof enableDisable>

Region

Region: TypeOf<typeof region>

StorageClass

StorageClass: TypeOf<typeof storageClass>

Transition

Transition: TypeOf<typeof transition>

WithSize

WithSize: number | string | any[] | Map<any, any> | Set<any>

Other Variables

PathReporter

PathReporter: Reporter<string[]> = ...
since

1.0.0

allowDeny

allowDeny: EnumType<"allow" | "deny"> = ...

availabilityZone

availabilityZone: EnumType<"a" | "b" | "c" | "d" | "e" | "f"> = ...

cidr

cidr: CidrType = ...

deploymentTargets

deploymentTargets: TypeC<{ accounts: OptionalType<ArrayC<SizedType<string, Type<string, string, unknown>>>>; excludedAccounts: OptionalType<ArrayC<SizedType<string, Type<string, string, unknown>>>>; excludedRegions: OptionalType<ArrayC<SizedType<string, Type<string, string, unknown>>>>; organizationalUnits: OptionalType<ArrayC<SizedType<string, Type<string, string, unknown>>>> }> = ...

enableDisable

enableDisable: EnumType<"enable" | "disable"> = ...

lifecycleRule

lifecycleRule: TypeC<{ abortIncompleteMultipartUpload: OptionalType<NumberC>; enabled: OptionalType<BooleanC>; expiration: OptionalType<NumberC>; expiredObjectDeleteMarker: OptionalType<BooleanC>; id: OptionalType<StringC>; noncurrentVersionExpiration: OptionalType<NumberC>; noncurrentVersionTransitions: OptionalType<ArrayC<TypeC<{ storageClass: EnumType<"DEEP_ARCHIVE" | "GLACIER" | "GLACIER_INSTANT_RETRIEVAL" | "INFREQUENT_ACCESS" | "INTELLIGENT_TIERING" | "ONE_ZONE_INFREQUENT_ACCESS" | "Value should be an AWS S3 Storage Class.">; transitionAfter: NumberC }>>>; transitions: OptionalType<ArrayC<TypeC<{ storageClass: EnumType<"DEEP_ARCHIVE" | "GLACIER" | "GLACIER_INSTANT_RETRIEVAL" | "INFREQUENT_ACCESS" | "INTELLIGENT_TIERING" | "ONE_ZONE_INFREQUENT_ACCESS" | "Value should be an AWS S3 Storage Class.">; transitionAfter: NumberC }>>> }> = ...

nonEmptyString

nonEmptyString: SizedType<string, Type<string, string, unknown>> = ...

nonEmptyString comment

region

region: EnumType<"af-south-1" | "ap-east-1" | "ap-northeast-1" | "ap-northeast-2" | "ap-northeast-3" | "ap-south-1" | "ap-southeast-1" | "ap-southeast-2" | "ca-central-1" | "cn-north-1" | "cn-northwest-1" | "eu-central-1" | "eu-north-1" | "eu-south-1" | "eu-west-1" | "eu-west-2" | "eu-west-3" | "me-south-1" | "sa-east-1" | "us-east-1" | "us-east-2" | "us-gov-east-1" | "us-gov-west-1" | "us-west-1" | "us-west-2" | "us-iso-west-1" | "us-iso-east-1" | "us-isob-east-1"> = ...

shareTargets

shareTargets: TypeC<{ accounts: OptionalType<ArrayC<SizedType<string, Type<string, string, unknown>>>>; organizationalUnits: OptionalType<ArrayC<SizedType<string, Type<string, string, unknown>>>> }> = ...

storageClass

storageClass: EnumType<"DEEP_ARCHIVE" | "GLACIER" | "GLACIER_INSTANT_RETRIEVAL" | "INFREQUENT_ACCESS" | "INTELLIGENT_TIERING" | "ONE_ZONE_INFREQUENT_ACCESS" | "Value should be an AWS S3 Storage Class."> = ...

tag

tag: TypeC<{ key: StringC; value: StringC }> = ...

transition

transition: TypeC<{ storageClass: EnumType<"DEEP_ARCHIVE" | "GLACIER" | "GLACIER_INSTANT_RETRIEVAL" | "INFREQUENT_ACCESS" | "INTELLIGENT_TIERING" | "ONE_ZONE_INFREQUENT_ACCESS" | "Value should be an AWS S3 Storage Class.">; transitionAfter: NumberC }> = ...

undefined

undefined: UndefinedC

primitives Variables

Array

Array: UnknownArrayC
since

1.7.1

boolean

boolean: BooleanC
since

1.0.0

number

number: NumberC
since

1.0.0

string

string: StringC
since

1.0.0

unknown

unknown: UnknownC
since

1.5.0

Other Functions

defaulted

  • defaulted<T>(type: T, defaultValue: T["_A"], name?: string): DefaultedType<T>

  • Type parameters

    Parameters

    • type: T
    • defaultValue: T["_A"]
    • Optional name: string

    Returns DefaultedType<T>

definition

  • definition<P>(name: string, props: P): Definition<P>

enums

  • enums<T>(name: string, values: readonly T[], errorMessage?: string): EnumType<T>

  • Create an enumeration type.

    Type parameters

    • T: string | number

    Parameters

    • name: string
    • values: readonly T[]
    • Optional errorMessage: string

    Returns EnumType<T>

failure

  • failure(es: ValidationError[]): string[]
  • since

    1.0.0

    Parameters

    • es: ValidationError[]

    Returns string[]

isDefinition

optional

  • Type parameters

    Parameters

    • wrapped: T
    • Optional name: string

    Returns OptionalType<T>

parse

  • parse<S, T>(type: Decoder<S, T>, content: S): T

  • Type parameters

    • S

    • T

    Parameters

    • type: Decoder<S, T>
    • content: S

    Returns T

sized

success

  • success(): string[]
  • since

    1.0.0

    Returns string[]

combinators Functions

array

  • array<C>(item: C, name?: string): ArrayC<C>
  • since

    1.0.0

    Type parameters

    Parameters

    • item: C
    • Optional name: string

    Returns ArrayC<C>

Const dictionary

  • dictionary<D, C>(domain: D, codomain: C, name?: string): RecordC<D, C>

  • Use record instead.

    since

    1.0.0

    deprecated

    Type parameters

    Parameters

    • domain: D
    • codomain: C
    • Optional name: string

    Returns RecordC<D, C>

interface

  • interface<P>(props: P, name?: string): TypeC<P>
  • since

    1.0.0

    Type parameters

    Parameters

    • props: P
    • Optional name: string

    Returns TypeC<P>

intersection

  • intersection<A, B, C, D, E>(codecs: [A, B, C, D, E], name?: string): IntersectionC<[A, B, C, D, E]>
  • intersection<A, B, C, D>(codecs: [A, B, C, D], name?: string): IntersectionC<[A, B, C, D]>
  • intersection<A, B, C>(codecs: [A, B, C], name?: string): IntersectionC<[A, B, C]>
  • intersection<A, B>(codecs: [A, B], name?: string): IntersectionC<[A, B]>
  • since

    1.0.0

    Type parameters

    Parameters

    • codecs: [A, B, C, D, E]
    • Optional name: string

    Returns IntersectionC<[A, B, C, D, E]>

  • Type parameters

    Parameters

    • codecs: [A, B, C, D]
    • Optional name: string

    Returns IntersectionC<[A, B, C, D]>

  • Type parameters

    Parameters

    • codecs: [A, B, C]
    • Optional name: string

    Returns IntersectionC<[A, B, C]>

  • Type parameters

    Parameters

    • codecs: [A, B]
    • Optional name: string

    Returns IntersectionC<[A, B]>

partial

  • partial<P>(props: P, name?: string): PartialC<P>
  • since

    1.0.0

    Type parameters

    Parameters

    • props: P
    • Optional name: string

    Returns PartialC<P>

record

  • record<D, C>(domain: D, codomain: C, name?: string): RecordC<D, C>
  • since

    1.7.1

    Type parameters

    Parameters

    • domain: D
    • codomain: C
    • Optional name: string

    Returns RecordC<D, C>

union

  • union<CS>(codecs: CS, name?: string): UnionC<CS>
  • since

    1.0.0

    Type parameters

    Parameters

    • codecs: CS
    • Optional name: string

    Returns UnionC<CS>

constructors Functions

literal

  • literal<V>(value: V, name?: string): LiteralC<V>
  • since

    1.0.0

    Type parameters

    • V: LiteralValue

    Parameters

    • value: V
    • Optional name: string

    Returns LiteralC<V>

Generated using TypeDoc