Skip to content

types.DynasyncProps

Steven Guggenheimer edited this page Oct 14, 2023 · 3 revisions

Interface: DynasyncProps

types.DynasyncProps

Hierarchy

  • ResourceProps

    DynasyncProps

Table of contents

Properties

Properties

account

Optional Readonly account: string

The AWS account ID this resource belongs to.

Default

- the resource is in the same account as the stack it belongs to

Inherited from

ResourceProps.account

Defined in

node_modules/aws-cdk-lib/core/lib/resource.d.ts:79


apiProps

Optional apiProps: AppsyncApiProps

Defined in

src/types.ts:21


auth

Optional auth: AuthorizationMode[]

Defined in

src/types.ts:23


configFile

Optional configFile: string

Defined in

src/types.ts:17


deleteTablesWithStack

Optional deleteTablesWithStack: boolean

Defined in

src/types.ts:24


environmentFromArn

Optional Readonly environmentFromArn: string

ARN to deduce region and account from

The ARN is parsed and the account and region are taken from the ARN. This should be used for imported resources.

Cannot be supplied together with either account or region.

Default

  • take environment from account, region parameters, or use Stack environment.

Inherited from

ResourceProps.environmentFromArn

Defined in

node_modules/aws-cdk-lib/core/lib/resource.d.ts:96


physicalName

Optional Readonly physicalName: string

The value passed in by users to the physical name prop of the resource.

  • undefined implies that a physical name will be allocated by CloudFormation during deployment.
  • a concrete value implies a specific physical name
  • PhysicalName.GENERATE_IF_NEEDED is a marker that indicates that a physical will only be generated by the CDK if it is needed for cross-environment references. Otherwise, it will be allocated by CloudFormation.

Default

- The physical name will be allocated by CloudFormation at deployment time

Inherited from

ResourceProps.physicalName

Defined in

node_modules/aws-cdk-lib/core/lib/resource.d.ts:73


region

Optional Readonly region: string

The AWS region this resource belongs to.

Default

- the resource is in the same region as the stack it belongs to

Inherited from

ResourceProps.region

Defined in

node_modules/aws-cdk-lib/core/lib/resource.d.ts:85


tableProps

Optional tableProps: DynamoTableProps

Defined in

src/types.ts:22


tables

Optional tables: (DbTable | SchemaTable)[]

Defined in

src/types.ts:16


types

Optional types: GraphQlTypeList

Defined in

src/types.ts:18


userPool

Optional userPool: IUserPool

Defined in

src/types.ts:15


userPoolDeny

Optional userPoolDeny: boolean

Defined in

src/types.ts:20


userPoolRegex

Optional userPoolRegex: string

Defined in

src/types.ts:19