From 7c5bc5c52ef49d3b52534b60ec82190ac0c58c95 Mon Sep 17 00:00:00 2001 From: sobolk Date: Fri, 20 Sep 2024 20:36:31 +0000 Subject: [PATCH] deploy: e325044cd07ce466a41e4fec72d8747217e62f41 --- ...versation.ConversationHandlerFunction.html | 6 +-- ...ws_amplify_auth_construct.AmplifyAuth.html | 42 +++++++++---------- ...ckend_deployer.BackendDeployerFactory.html | 6 +-- ...ut_storage.AttributionMetadataStorage.html | 6 +-- ...kMetadataBackendOutputStorageStrategy.html | 10 ++--- ..._platform_test_stubs.AmplifyStackStub.html | 4 +- ...orm_test_stubs.ConstructContainerStub.html | 10 ++--- ...orm_test_stubs.ImportPathVerifierStub.html | 4 +- ..._test_stubs.ResourceNameValidatorStub.html | 4 +- ...bs.SsmEnvironmentEntriesGeneratorStub.html | 8 ++-- ...platform_test_stubs.StackResolverStub.html | 6 +-- ...ws_amplify_backend_secret.SecretError.html | 8 ++-- ..._aws_amplify_cli_core.AmplifyPrompter.html | 8 ++-- classes/_aws_amplify_cli_core.Format.html | 4 +- ..._core.PackageManagerControllerFactory.html | 8 ++-- classes/_aws_amplify_cli_core.Printer.html | 22 +++++----- ...ckend_client.BackendOutputClientError.html | 4 +- ...end_client.BackendOutputClientFactory.html | 4 +- ...d_client.DeployedBackendClientFactory.html | 4 +- ...ws_amplify_platform_core.AmplifyError.html | 14 +++---- ...ws_amplify_platform_core.AmplifyFault.html | 12 +++--- ...mplify_platform_core.AmplifyUserError.html | 12 +++--- ...orm_core.BackendIdentifierConversions.html | 6 +-- ..._amplify_platform_core.BackendLocator.html | 4 +- ...latform_core.CallerDirectoryExtractor.html | 4 +- ...m_core.ConfigurationControllerFactory.html | 6 +-- ...plify_platform_core.FilePathExtractor.html | 4 +- ...plify_platform_core.ObjectAccumulator.html | 6 +-- ...AccumulatorPropertyAlreadyExistsError.html | 4 +- ...ObjectAccumulatorVersionMismatchError.html | 4 +- ...plify_platform_core.PackageJsonReader.html | 6 +-- ...latform_core.ParameterPathConversions.html | 8 ++-- ...platform_core.UsageDataEmitterFactory.html | 4 +- ...plify_sandbox.SandboxSingletonFactory.html | 6 +-- ...lify_schema_generator.SchemaGenerator.html | 4 +- enums/_aws_amplify_cli_core.LogLevel.html | 4 +- ...lient_config.ClientConfigFileBaseName.html | 4 +- ...lify_client_config.ClientConfigFormat.html | 4 +- ...ient_config.ClientConfigVersionOption.html | 4 +- ...y_deployed_backend_client.ApiAuthType.html | 4 +- ...ackend_client.BackendDeploymentStatus.html | 4 +- ...d_client.BackendOutputClientErrorType.html | 4 +- ...deployed_backend_client.BackendStatus.html | 4 +- ...backend_client.ConflictResolutionMode.html | 4 +- ...model_generator.GenerateApiCodeFormat.html | 4 +- ..._generator.GenerateApiCodeModelTarget.html | 4 +- ...erator.GenerateApiCodeStatementTarget.html | 4 +- ...l_generator.GenerateApiCodeTypeTarget.html | 4 +- ...s_amplify_platform_core.CDKContextKey.html | 4 +- enums/_aws_amplify_platform_core.TagName.html | 4 +- .../_aws_amplify_backend.defineBackend.html | 2 +- functions/_aws_amplify_backend.secret.html | 2 +- .../_aws_amplify_backend_auth.defineAuth.html | 2 +- .../_aws_amplify_backend_data.defineData.html | 2 +- ...plify_backend_function.defineFunction.html | 2 +- ...mplify_backend_secret.getSecretClient.html | 2 +- ...tSecretClientWithAmplifyErrorHandling.html | 2 +- ...amplify_backend_storage.defineStorage.html | 2 +- ...fy_client_config.generateClientConfig.html | 2 +- ...ent_config.generateClientConfigToFile.html | 2 +- ...onfig.generateEmptyClientConfigToFile.html | 2 +- ...client_config.getClientConfigFileName.html | 2 +- ...ify_client_config.getClientConfigPath.html | 2 +- ...rator.createLocalGraphqlFormGenerator.html | 2 +- ...erator.createGraphqlDocumentGenerator.html | 2 +- ...enerator.createGraphqlModelsGenerator.html | 2 +- ...plify_model_generator.generateApiCode.html | 2 +- ...onfigTypesV1.AWSAmplifyBackendOutputs.html | 18 ++++---- ...igTypesV1.AmazonLocationServiceConfig.html | 6 +-- ...figTypesV1_1.AWSAmplifyBackendOutputs.html | 18 ++++---- ...TypesV1_1.AmazonLocationServiceConfig.html | 6 +-- ...tConfigTypesV1_1.AmplifyStorageBucket.html | 4 +- ...ws_amplify_ai_constructs.conversation.html | 2 +- ...ify_client_config.clientConfigTypesV1.html | 2 +- ...y_client_config.clientConfigTypesV1_1.html | 2 +- ...tion.ConversationHandlerFunctionProps.html | 2 +- ...fy_auth_construct.AmazonProviderProps.html | 2 +- ...ify_auth_construct.AppleProviderProps.html | 2 +- ...plify_auth_construct.AttributeMapping.html | 2 +- ..._aws_amplify_auth_construct.AuthProps.html | 2 +- ...mplify_auth_construct.CustomAttribute.html | 2 +- ...fy_auth_construct.CustomAttributeBase.html | 2 +- ...auth_construct.CustomAttributeBoolean.html | 2 +- ...uth_construct.CustomAttributeDateTime.html | 2 +- ..._auth_construct.CustomAttributeNumber.html | 2 +- ..._auth_construct.CustomAttributeString.html | 2 +- ...aws_amplify_auth_construct.EmailLogin.html | 2 +- ...ify_auth_construct.EmailLoginSettings.html | 2 +- ...uth_construct.ExternalProviderOptions.html | 2 +- ..._auth_construct.FacebookProviderProps.html | 2 +- ...fy_auth_construct.GoogleProviderProps.html | 2 +- ..._auth_construct.IdentityProviderProps.html | 2 +- types/_aws_amplify_auth_construct.MFA.html | 2 +- ...ws_amplify_auth_construct.MFASettings.html | 2 +- ...amplify_auth_construct.MFASmsSettings.html | 2 +- ...mplify_auth_construct.MFATotpSettings.html | 2 +- ...lify_auth_construct.OidcProviderProps.html | 2 +- ...plify_auth_construct.PhoneNumberLogin.html | 2 +- ...lify_auth_construct.SamlProviderProps.html | 2 +- ...s_amplify_auth_construct.TriggerEvent.html | 2 +- ...amplify_auth_construct.UserAttributes.html | 2 +- ...h_construct.VerificationEmailWithCode.html | 2 +- ...h_construct.VerificationEmailWithLink.html | 2 +- types/_aws_amplify_backend.Backend.html | 2 +- types/_aws_amplify_backend.BackendBase.html | 2 +- ...ws_amplify_backend.DefineBackendProps.html | 2 +- .../_aws_amplify_backend_auth.ActionIam.html | 2 +- .../_aws_amplify_backend_auth.ActionMeta.html | 2 +- ...ckend_auth.AmazonProviderFactoryProps.html | 2 +- ...amplify_backend_auth.AmplifyAuthProps.html | 2 +- ...ackend_auth.AppleProviderFactoryProps.html | 2 +- ...mplify_backend_auth.AuthAccessBuilder.html | 2 +- ...ify_backend_auth.AuthAccessDefinition.html | 2 +- ...lify_backend_auth.AuthAccessGenerator.html | 2 +- .../_aws_amplify_backend_auth.AuthAction.html | 2 +- ...mplify_backend_auth.AuthActionBuilder.html | 2 +- ...ackend_auth.AuthLoginWithFactoryProps.html | 2 +- ..._aws_amplify_backend_auth.BackendAuth.html | 2 +- types/_aws_amplify_backend_auth.Expand.html | 2 +- ...h.ExternalProviderGeneralFactoryProps.html | 2 +- ....ExternalProviderSpecificFactoryProps.html | 2 +- ...end_auth.FacebookProviderFactoryProps.html | 2 +- ...ckend_auth.GoogleProviderFactoryProps.html | 2 +- ...backend_auth.OidcProviderFactoryProps.html | 2 +- ...end_data.ApiKeyAuthorizationModeProps.html | 2 +- ...plify_backend_data.AuthorizationModes.html | 2 +- .../_aws_amplify_backend_data.DataProps.html | 2 +- ..._amplify_backend_data.DataSchemaInput.html | 2 +- ...backend_data.DefaultAuthorizationMode.html | 2 +- ...end_data.LambdaAuthorizationModeProps.html | 2 +- ...ckend_data.OIDCAuthorizationModeProps.html | 2 +- ...lify_backend_deployer.BackendDeployer.html | 2 +- ...ployer.BackendDeployerOutputFormatter.html | 2 +- ..._amplify_backend_deployer.DeployProps.html | 2 +- ...amplify_backend_deployer.DeployResult.html | 2 +- ...lify_backend_deployer.DeploymentTimes.html | 2 +- ...amplify_backend_deployer.DestroyProps.html | 2 +- ...mplify_backend_deployer.DestroyResult.html | 2 +- ...ackend_function.AddEnvironmentFactory.html | 2 +- ...amplify_backend_function.CronSchedule.html | 2 +- ...mplify_backend_function.FunctionProps.html | 2 +- ...ify_backend_function.FunctionSchedule.html | 2 +- ..._amplify_backend_function.NodeVersion.html | 2 +- ...amplify_backend_function.TimeInterval.html | 2 +- ...ify_backend_output_schemas.AuthOutput.html | 2 +- ..._schemas.AwsAppsyncAuthenticationType.html | 2 +- ...hemas.BackendOutputEntryStackMetadata.html | 2 +- ...ut_schemas.BackendOutputStackMetadata.html | 2 +- ...y_backend_output_schemas.CustomOutput.html | 2 +- ...backend_output_schemas.FunctionOutput.html | 2 +- ..._backend_output_schemas.GraphqlOutput.html | 2 +- ..._backend_output_schemas.StorageOutput.html | 2 +- ...d_output_schemas.UnifiedBackendOutput.html | 2 +- ...nd_output_storage.AttributionMetadata.html | 2 +- ...d_output_storage.DeploymentEngineType.html | 2 +- ...plify_backend_output_storage.Platform.html | 2 +- ...end_platform_test_stubs.StackResolver.html | 2 +- types/_aws_amplify_backend_secret.Secret.html | 2 +- ...s_amplify_backend_secret.SecretClient.html | 2 +- ...fy_backend_secret.SecretClientOptions.html | 2 +- ...plify_backend_secret.SecretIdentifier.html | 2 +- ...amplify_backend_secret.SecretListItem.html | 2 +- ...nd_storage.AmplifyStorageFactoryProps.html | 2 +- ...y_backend_storage.AmplifyStorageProps.html | 2 +- ...nd_storage.AmplifyStorageTriggerEvent.html | 2 +- ..._aws_amplify_backend_storage.EntityId.html | 2 +- ..._backend_storage.StorageAccessBuilder.html | 2 +- ...ckend_storage.StorageAccessDefinition.html | 2 +- ...ackend_storage.StorageAccessGenerator.html | 2 +- ...y_backend_storage.StorageAccessRecord.html | 2 +- ...amplify_backend_storage.StorageAction.html | 2 +- ..._backend_storage.StorageActionBuilder.html | 2 +- ...s_amplify_backend_storage.StoragePath.html | 2 +- ...lify_backend_storage.StorageResources.html | 2 +- types/_aws_amplify_cli_core.ColorName.html | 2 +- types/_aws_amplify_cli_core.RecordValue.html | 2 +- ...y_client_config.AnalyticsClientConfig.html | 2 +- ...mplify_client_config.AuthClientConfig.html | 2 +- ...ws_amplify_client_config.ClientConfig.html | 2 +- ...lify_client_config.ClientConfigLegacy.html | 2 +- ...ify_client_config.ClientConfigVersion.html | 2 +- ...onfig.ClientConfigVersionTemplateType.html | 2 +- ...lify_client_config.CustomClientConfig.html | 2 +- ...nfig.GenerateClientConfigToFileResult.html | 2 +- ...amplify_client_config.GeoClientConfig.html | 2 +- ...ify_client_config.GraphqlClientConfig.html | 2 +- ...ient_config.NotificationsClientConfig.html | 2 +- ...fy_client_config.PlatformClientConfig.html | 2 +- ...ify_client_config.StorageClientConfig.html | 2 +- ...pesV1.AmazonCognitoStandardAttributes.html | 2 +- ...tConfigTypesV1.AmazonPinpointChannels.html | 2 +- ...igTypesV1.AwsAppsyncAuthorizationType.html | 2 +- ..._config.clientConfigTypesV1.AwsRegion.html | 2 +- ...sV1_1.AmazonCognitoStandardAttributes.html | 2 +- ...onfigTypesV1_1.AmazonPinpointChannels.html | 2 +- ...TypesV1_1.AwsAppsyncAuthorizationType.html | 2 +- ...onfig.clientConfigTypesV1_1.AwsRegion.html | 2 +- ...ent.AppNameAndBranchBackendIdentifier.html | 2 +- ...ployed_backend_client.BackendMetadata.html | 2 +- ...ed_backend_client.BackendOutputClient.html | 2 +- ...ent.BackendOutputClientFactoryOptions.html | 2 +- ...end_client.BackendOutputClientOptions.html | 2 +- ...lient.BackendOutputCredentialsOptions.html | 2 +- ...backend_client.BackendSummaryMetadata.html | 2 +- ..._backend_client.DeployedBackendClient.html | 2 +- ...kend_client.DeployedBackendIdentifier.html | 2 +- ...ackend_client.DeployedBackendResource.html | 2 +- ..._backend_client.FunctionConfiguration.html | 2 +- ...ed_backend_client.ListBackendsRequest.html | 2 +- ...d_backend_client.ListBackendsResponse.html | 2 +- ...ployed_backend_client.StackIdentifier.html | 2 +- ..._form_generator.FormGenerationOptions.html | 2 +- ...generator.GenerateGraphqlToFileResult.html | 2 +- ...y_form_generator.GraphqlFormGenerator.html | 2 +- ...orm_generator.GraphqlGenerationResult.html | 2 +- ...rator.LocalGraphqlFormGeneratorParams.html | 2 +- ...enerator.DocumentGenerationParameters.html | 2 +- ..._model_generator.GenerateApiCodeProps.html | 2 +- ...nerator.GenerateGraphqlCodegenOptions.html | 2 +- ...or.GenerateGraphqlCodegenToFileResult.html | 2 +- ...enerator.GenerateIntrospectionOptions.html | 2 +- ...model_generator.GenerateModelsOptions.html | 2 +- ...plify_model_generator.GenerateOptions.html | 2 +- ...lify_model_generator.GenerationResult.html | 2 +- ...el_generator.GraphqlDocumentGenerator.html | 2 +- ...GraphqlDocumentGeneratorFactoryParams.html | 2 +- ...odel_generator.GraphqlModelsGenerator.html | 2 +- ...r.GraphqlModelsGeneratorFactoryParams.html | 2 +- ...model_generator.GraphqlTypesGenerator.html | 2 +- ..._generator.ModelsGenerationParameters.html | 2 +- ...l_generator.TypesGenerationParameters.html | 2 +- ...tform_core.AmplifyErrorClassification.html | 2 +- ...ify_platform_core.AmplifyErrorOptions.html | 2 +- ...platform_core.AmplifyUserErrorOptions.html | 2 +- ...platform_core.ConfigurationController.html | 2 +- ...tform_core.LocalConfigurationFileName.html | 2 +- ...aws_amplify_platform_core.PackageJson.html | 2 +- ...mplify_platform_core.UsageDataEmitter.html | 2 +- ...mplify_plugin_types.AWSClientProvider.html | 2 +- ..._amplify_plugin_types.AmplifyFunction.html | 2 +- types/_aws_amplify_plugin_types.AppId.html | 2 +- ...amplify_plugin_types.AuthCfnResources.html | 2 +- ...ws_amplify_plugin_types.AuthResources.html | 2 +- ...aws_amplify_plugin_types.AuthRoleName.html | 2 +- ...mplify_plugin_types.BackendIdentifier.html | 2 +- ...ws_amplify_plugin_types.BackendOutput.html | 2 +- ...plify_plugin_types.BackendOutputEntry.html | 2 +- ..._types.BackendOutputRetrievalStrategy.html | 2 +- ...in_types.BackendOutputStorageStrategy.html | 2 +- ...ws_amplify_plugin_types.BackendSecret.html | 2 +- ...fy_plugin_types.BackendSecretResolver.html | 2 +- .../_aws_amplify_plugin_types.BranchName.html | 2 +- ...plify_plugin_types.ConstructContainer.html | 2 +- ...ypes.ConstructContainerEntryGenerator.html | 2 +- ...amplify_plugin_types.ConstructFactory.html | 2 +- ...ypes.ConstructFactoryGetInstanceProps.html | 2 +- ..._aws_amplify_plugin_types.DeepPartial.html | 2 +- ...es.DeepPartialAmplifyGeneratedConfigs.html | 2 +- ...s_amplify_plugin_types.DeploymentType.html | 2 +- ...mplify_plugin_types.FunctionResources.html | 2 +- ...gin_types.GenerateContainerEntryProps.html | 2 +- ...plify_plugin_types.ImportPathVerifier.html | 2 +- ...amplify_plugin_types.MainStackCreator.html | 2 +- ...fy_plugin_types.MainStackNameResolver.html | 2 +- ...plugin_types.PackageManagerController.html | 2 +- ..._aws_amplify_plugin_types.ProjectName.html | 2 +- ...mplify_plugin_types.ResolvePathResult.html | 2 +- ...y_plugin_types.ResourceAccessAcceptor.html | 2 +- ...n_types.ResourceAccessAcceptorFactory.html | 2 +- ...fy_plugin_types.ResourceNameValidator.html | 2 +- ...amplify_plugin_types.ResourceProvider.html | 2 +- ..._aws_amplify_plugin_types.SandboxName.html | 2 +- ..._types.SsmEnvironmentEntriesGenerator.html | 2 +- ...lify_plugin_types.SsmEnvironmentEntry.html | 2 +- ...plugin_types.StableBackendIdentifiers.html | 2 +- ...ws_amplify_plugin_types.StackProvider.html | 2 +- ...lify_sandbox.BackendIdSandboxResolver.html | 2 +- types/_aws_amplify_sandbox.Sandbox.html | 2 +- ..._amplify_sandbox.SandboxDeleteOptions.html | 2 +- types/_aws_amplify_sandbox.SandboxEvents.html | 2 +- ...ndbox.SandboxFunctionStreamingOptions.html | 2 +- .../_aws_amplify_sandbox.SandboxOptions.html | 2 +- ..._schema_generator.SQLDataSourceConfig.html | 2 +- ...ws_amplify_schema_generator.SQLEngine.html | 2 +- ...chema_generator.SchemaGeneratorConfig.html | 2 +- ..._amplify_auth_construct.triggerEvents.html | 2 +- ...hemas.AwsAppsyncAuthenticationZodEnum.html | 2 +- ..._backend_output_schemas.authOutputKey.html | 2 +- ...backendOutputEntryStackMetadataSchema.html | 2 +- ...emas.backendOutputStackMetadataSchema.html | 2 +- ...ackend_output_schemas.customOutputKey.html | 2 +- ...kend_output_schemas.functionOutputKey.html | 2 +- ...ckend_output_schemas.graphqlOutputKey.html | 2 +- ...kend_output_schemas.platformOutputKey.html | 2 +- ...ckend_output_schemas.storageOutputKey.html | 2 +- ...ut_schemas.unifiedBackendOutputSchema.html | 2 +- ...put_schemas.versionedAuthOutputSchema.html | 2 +- ...t_schemas.versionedCustomOutputSchema.html | 2 +- ...schemas.versionedFunctionOutputSchema.html | 2 +- ..._schemas.versionedGraphqlOutputSchema.html | 2 +- ..._schemas.versionedStorageOutputSchema.html | 2 +- .../_aws_amplify_cli_core.colorNames.html | 2 +- variables/_aws_amplify_cli_core.format-1.html | 2 +- .../_aws_amplify_cli_core.printer-1.html | 2 +- ..._config.DEFAULT_CLIENT_CONFIG_VERSION.html | 2 +- ...form_core.USAGE_DATA_TRACKING_ENABLED.html | 2 +- ...platform_core.configControllerFactory.html | 2 +- ...plify_platform_core.packageJsonSchema.html | 2 +- 308 files changed, 445 insertions(+), 445 deletions(-) diff --git a/classes/_aws_amplify_ai_constructs.conversation.ConversationHandlerFunction.html b/classes/_aws_amplify_ai_constructs.conversation.ConversationHandlerFunction.html index 47838ed92e..ddae450769 100644 --- a/classes/_aws_amplify_ai_constructs.conversation.ConversationHandlerFunction.html +++ b/classes/_aws_amplify_ai_constructs.conversation.ConversationHandlerFunction.html @@ -8,15 +8,15 @@
  • AWS CloudWatch log group policy with appropriate data protection policies.
  • AWS IAM policy that grants access to selected AWS Bedrock models.
  • -

    Hierarchy

    Implements

    Constructors

    Hierarchy

    • Construct
      • ConversationHandlerFunction

    Implements

    Constructors

    Properties

    Methods

    Constructors

    Properties

    node: Node

    The tree node.

    -

    Methods

    Properties

    node: Node

    The tree node.

    +

    Methods

    • Returns a string representation of this construct.

      Returns string

    Properties

    computedUserPoolProps: UserPoolProps
    domainPrefix: undefined | string
    groups: {
        [key: string]: {
            cfnUserGroup: CfnUserPoolGroup;
            role: Role;
        };
    } = {}

    Type declaration

    • [key: string]: {
          cfnUserGroup: CfnUserPoolGroup;
          role: Role;
      }
      • cfnUserGroup: CfnUserPoolGroup
      • role: Role
    name: string
    node: Node

    The tree node.

    providerSetupResult: IdentityProviderSetupResult

    External provider settings

    -
    resources: AuthResources

    The resources generated by the construct.

    -
    userPool: UserPool

    Methods

    • Define bindCustomAttribute to meet requirements of the Cognito API to call the bind method

      -

      Parameters

      Returns CustomAttributeConfig & ICustomAttribute

    resources: AuthResources

    The resources generated by the construct.

    +
    userPool: UserPool

    Methods

    • Define bindCustomAttribute to meet requirements of the Cognito API to call the bind method

      +

      Parameters

      Returns CustomAttributeConfig & ICustomAttribute

    • Convert user friendly account recovery method to cognito AccountRecover enum. This eliminates the need for users to import cognito.AccountRecovery.

      Parameters

      • method: undefined | "EMAIL_AND_PHONE_WITHOUT_MFA" | "PHONE_WITHOUT_MFA_AND_EMAIL" | "EMAIL_ONLY" | "PHONE_ONLY_WITHOUT_MFA" | "PHONE_AND_EMAIL" | "NONE"

        account recovery method as a string value

      Returns undefined | AccountRecovery

      cognito.AccountRecovery enum value

      -
    • Converts the simplified mapping type to cognito.AttributeMapping.

      Parameters

      • Optional mapping: AttributeMapping

        the AttributeMapping to convert to a cognito.AttributeMapping

      Returns undefined | AttributeMapping

      cognito.AttributeMapping

      -
    • Determine the account recovery option based on enabled login methods.

      +
    • Determine the account recovery option based on enabled login methods.

      Parameters

      • emailEnabled: boolean

        is email enabled

      • phoneEnabled: boolean

        is phone enabled

      • accountRecoveryMethodAsString: undefined | "EMAIL_AND_PHONE_WITHOUT_MFA" | "PHONE_WITHOUT_MFA_AND_EMAIL" | "EMAIL_ONLY" | "PHONE_ONLY_WITHOUT_MFA" | "PHONE_AND_EMAIL" | "NONE"

        the user provided account recovery setting

      Returns undefined | AccountRecovery

      account recovery setting enum value

      -
    • Get email verification style from user props

      Parameters

      • verificationEmailStyle: undefined | "LINK" | "CODE"

        string value

      Returns undefined | VerificationEmailStyle

      verificationEmailStyle - enum value

      -
    • Convert user friendly Mfa mode to cognito Mfa Mode. This eliminates the need for users to import cognito.Mfa.

      Parameters

      • mfa: undefined | MFA

        MFA settings

      Returns undefined | Mfa

      cognito MFA enforcement mode

      -
    • Convert user friendly Mfa type to cognito Mfa type. This eliminates the need for users to import cognito.Mfa.

      Parameters

      • mfa: undefined | MFA

        MFA settings

      Returns undefined | MfaSecondFactor

      cognito MFA type (sms or totp)

      -
    • Convert scopes from string list to OAuthScopes.

      Parameters

      • scopes: undefined | ("PHONE" | "EMAIL" | "OPENID" | "PROFILE" | "COGNITO_ADMIN")[]

        scope list

      Returns OAuthScope[]

      cognito OAuthScopes

      -
    • Parses the user invitation settings and inserts codes/usernames where necessary.

      Parameters

      • settings: undefined | {
            emailBody?: ((username, code) => string);
            emailSubject?: string;
            smsMessage?: ((username, code) => string);
        }

        the invitation settings

      Returns undefined | UserInvitationConfig

      cognito.UserInvitationConfig | undefined

      -
    • Setup External Providers (OAuth/OIDC/SAML) and related settings such as OAuth settings and User Pool Domains

      Parameters

      • userPool: UserPool
      • loginOptions: {
            email?: EmailLogin;
            externalProviders?: ExternalProviderOptions;
            phone?: PhoneNumberLogin;
        }
        • Optional email?: EmailLogin

          Email login options.

          If true, email login will be enabled with default settings. @@ -77,15 +77,15 @@

        • Optional phone?: PhoneNumberLogin

          Phone number login options.

          If true, phone number login will be enabled with default settings. If settings are provided, phone number login will be enabled with the specified settings.

          -

      Returns IdentityProviderSetupResult

    • Setup Identity Pool with default roles/role mappings, and register providers

      -

      Parameters

      • userPool: UserPool
      • userPoolClient: UserPoolClient
      • providerSetupResult: IdentityProviderSetupResult

      Returns {
          identityPool: CfnIdentityPool;
          identityPoolRoleAttachment: CfnIdentityPoolRoleAttachment;
          roles: DefaultRoles;
      }

      • identityPool: CfnIdentityPool
      • identityPoolRoleAttachment: CfnIdentityPoolRoleAttachment
      • roles: DefaultRoles
    • Auto generate the user pool groups and group roles

      -

      Parameters

      • groups: undefined | string[]
      • identityPool: CfnIdentityPool

      Returns void

    • Stores auth output using the provided strategy

      -

      Parameters

      • outputStorageStrategy: BackendOutputStorageStrategy<{
            payload: {
                allowUnauthenticatedIdentities?: string;
                authRegion: string;
                identityPoolId: string;
                mfaConfiguration?: string;
                mfaTypes?: string;
                oauthClientId?: string;
                oauthCognitoDomain?: string;
                oauthRedirectSignIn?: string;
                oauthRedirectSignOut?: string;
                oauthResponseType?: string;
                oauthScope?: string;
                passwordPolicyMinLength?: string;
                passwordPolicyRequirements?: string;
                signupAttributes?: string;
                socialProviders?: string;
                userPoolId: string;
                usernameAttributes?: string;
                verificationMechanisms?: string;
                webClientId: string;
            };
            version: "1";
        }> = ...

      Returns void

    • Returns a string representation of this construct.

      +

    Returns IdentityProviderSetupResult

    • Setup Identity Pool with default roles/role mappings, and register providers

      +

      Parameters

      • userPool: UserPool
      • userPoolClient: UserPoolClient
      • providerSetupResult: IdentityProviderSetupResult

      Returns {
          identityPool: CfnIdentityPool;
          identityPoolRoleAttachment: CfnIdentityPoolRoleAttachment;
          roles: DefaultRoles;
      }

      • identityPool: CfnIdentityPool
      • identityPoolRoleAttachment: CfnIdentityPoolRoleAttachment
      • roles: DefaultRoles
    • Auto generate the user pool groups and group roles

      +

      Parameters

      • groups: undefined | string[]
      • identityPool: CfnIdentityPool

      Returns void

    • Stores auth output using the provided strategy

      +

      Parameters

      • outputStorageStrategy: BackendOutputStorageStrategy<{
            payload: {
                allowUnauthenticatedIdentities?: string;
                authRegion: string;
                identityPoolId: string;
                mfaConfiguration?: string;
                mfaTypes?: string;
                oauthClientId?: string;
                oauthCognitoDomain?: string;
                oauthRedirectSignIn?: string;
                oauthRedirectSignOut?: string;
                oauthResponseType?: string;
                oauthScope?: string;
                passwordPolicyMinLength?: string;
                passwordPolicyRequirements?: string;
                signupAttributes?: string;
                socialProviders?: string;
                userPoolId: string;
                usernameAttributes?: string;
                verificationMechanisms?: string;
                webClientId: string;
            };
            version: "1";
        }> = ...

      Returns void

    • Returns a string representation of this construct.

      Returns string

    • Verify the email body depending on if 'CODE' or 'LINK' style is used. This ensures that the template contains the necessary placeholders for Cognito to insert verification codes or links.

      Parameters

      Returns undefined | string

      emailBody

      -

    Properties

    packageManagerController: PackageManagerController
    instance: undefined | BackendDeployer

    Methods

    \ No newline at end of file diff --git a/classes/_aws_amplify_backend_output_storage.AttributionMetadataStorage.html b/classes/_aws_amplify_backend_output_storage.AttributionMetadataStorage.html index 90b70b965b..97688123af 100644 --- a/classes/_aws_amplify_backend_output_storage.AttributionMetadataStorage.html +++ b/classes/_aws_amplify_backend_output_storage.AttributionMetadataStorage.html @@ -1,5 +1,5 @@ AttributionMetadataStorage | Amplify Toolbox

    Stores BI metrics information in stack descriptions

    -

    Constructors

    Constructors

    Properties

    os: __module = _os
    packageJsonReader: PackageJsonReader = ...

    Methods

    Properties

    os: __module = _os
    packageJsonReader: PackageJsonReader = ...

    Methods

    • Stores an attribution metadata string in the stack description of the provided stack Does nothing if the stack already has a non-empty description

      -

      Parameters

      • stack: Stack
      • stackType: string
      • libraryPackageJsonAbsolutePath: string
      • additionalMetadata: Record<string, string> = {}

      Returns void

    \ No newline at end of file +

    Parameters

    Returns void

    \ No newline at end of file diff --git a/classes/_aws_amplify_backend_output_storage.StackMetadataBackendOutputStorageStrategy.html b/classes/_aws_amplify_backend_output_storage.StackMetadataBackendOutputStorageStrategy.html index eca5e27df3..0e6134c1bb 100644 --- a/classes/_aws_amplify_backend_output_storage.StackMetadataBackendOutputStorageStrategy.html +++ b/classes/_aws_amplify_backend_output_storage.StackMetadataBackendOutputStorageStrategy.html @@ -1,5 +1,5 @@ StackMetadataBackendOutputStorageStrategy | Amplify Toolbox

    Implementation of BackendOutputStorageStrategy that stores config data in stack metadata and outputs

    -

    Implements

    Constructors

    Implements

    Constructors

    Properties

    Methods

    Constructors

    Properties

    lazyListValueMap: Map<string, Map<string, string[]>> = ...
    stack: Stack

    Methods

    • Store construct output as stack output and add metadata to the metadata object.

      -

      Parameters

      Returns void

    Properties

    lazyListValueMap: Map<string, Map<string, string[]>> = ...
    stack: Stack

    Methods

    • Store construct output as stack output and add metadata to the metadata object.

      +

      Parameters

      Returns void

    • Add or update metadata entry.

      Parameters

      • existingMetadataEntry: undefined | {
            stackOutputs: string[];
            version: string;
        }

        The existing metadata entry.

      • keyName: string

        The key name.

      • backendOutputEntry: BackendOutputEntry

        The backend output entry.

        -

      Returns void

    • Lazily construct and append to output list as stack output and add metadata to the metadata object.

      -

      Parameters

      Returns void

    \ No newline at end of file +

    Returns void

    \ No newline at end of file diff --git a/classes/_aws_amplify_backend_platform_test_stubs.AmplifyStackStub.html b/classes/_aws_amplify_backend_platform_test_stubs.AmplifyStackStub.html index b7ba094bd9..99ae9149ab 100644 --- a/classes/_aws_amplify_backend_platform_test_stubs.AmplifyStackStub.html +++ b/classes/_aws_amplify_backend_platform_test_stubs.AmplifyStackStub.html @@ -1,5 +1,5 @@ AmplifyStackStub | Amplify Toolbox

    Test implementation of AmplifyStack. Currently copied from the real implementation of AmplifyStack but the implementations do not need to match going forward

    -

    Hierarchy

    • Stack
      • AmplifyStackStub

    Constructors

    Hierarchy

    • Stack
      • AmplifyStackStub

    Constructors

    Properties

    _crossRegionReferences _versionReportingEnabled account @@ -187,7 +187,7 @@

    Example

    declare const stack: Stack;

    stack.addTransform('AWS::Serverless-2016-10-31')
    \ No newline at end of file diff --git a/classes/_aws_amplify_backend_platform_test_stubs.ImportPathVerifierStub.html b/classes/_aws_amplify_backend_platform_test_stubs.ImportPathVerifierStub.html index df9caff8ec..60a0c96f11 100644 --- a/classes/_aws_amplify_backend_platform_test_stubs.ImportPathVerifierStub.html +++ b/classes/_aws_amplify_backend_platform_test_stubs.ImportPathVerifierStub.html @@ -1,4 +1,4 @@ ImportPathVerifierStub | Amplify Toolbox

    Stub implementation of ImportPathVerifier

    -

    Implements

    Constructors

    Implements

    Constructors

    Methods

    Constructors

    Methods

    \ No newline at end of file +

    Constructors

    Methods

    \ No newline at end of file diff --git a/classes/_aws_amplify_backend_platform_test_stubs.ResourceNameValidatorStub.html b/classes/_aws_amplify_backend_platform_test_stubs.ResourceNameValidatorStub.html index 95f6f3131d..03e5830161 100644 --- a/classes/_aws_amplify_backend_platform_test_stubs.ResourceNameValidatorStub.html +++ b/classes/_aws_amplify_backend_platform_test_stubs.ResourceNameValidatorStub.html @@ -1,4 +1,4 @@ ResourceNameValidatorStub | Amplify Toolbox

    Stub implementation of ResourceNameValidator

    -

    Implements

    Constructors

    Implements

    Constructors

    Methods

    Constructors

    Methods

    \ No newline at end of file +

    Constructors

    Methods

    \ No newline at end of file diff --git a/classes/_aws_amplify_backend_platform_test_stubs.SsmEnvironmentEntriesGeneratorStub.html b/classes/_aws_amplify_backend_platform_test_stubs.SsmEnvironmentEntriesGeneratorStub.html index 17496d0dee..ddd96bb21d 100644 --- a/classes/_aws_amplify_backend_platform_test_stubs.SsmEnvironmentEntriesGeneratorStub.html +++ b/classes/_aws_amplify_backend_platform_test_stubs.SsmEnvironmentEntriesGeneratorStub.html @@ -1,9 +1,9 @@ SsmEnvironmentEntriesGeneratorStub | Amplify Toolbox

    Stub implementation of SsmEnvironmentEntriesGenerator used for backend unit testing

    -

    Implements

    Constructors

    Implements

    Constructors

    Properties

    Methods

    Constructors

    Properties

    scope: Construct

    The scope of the construct.

    -

    Methods

    • Stub implementation for testing. Synthesizes SSM parameters using a test path.

      -

      Parameters

      • scopeContext: Record<string, string>

      Returns {
          name: string;
          path: string;
      }[]

    \ No newline at end of file +

    Returns SsmEnvironmentEntriesGeneratorStub

    Properties

    scope: Construct

    The scope of the construct.

    +

    Methods

    • Stub implementation for testing. Synthesizes SSM parameters using a test path.

      +

      Parameters

      • scopeContext: Record<string, string>

      Returns {
          name: string;
          path: string;
      }[]

    \ No newline at end of file diff --git a/classes/_aws_amplify_backend_platform_test_stubs.StackResolverStub.html b/classes/_aws_amplify_backend_platform_test_stubs.StackResolverStub.html index eff5161aac..55caf05306 100644 --- a/classes/_aws_amplify_backend_platform_test_stubs.StackResolverStub.html +++ b/classes/_aws_amplify_backend_platform_test_stubs.StackResolverStub.html @@ -1,9 +1,9 @@ StackResolverStub | Amplify Toolbox

    Stub implementation of StackResolver. Currently copied from @aws-amplify/backend, but they can evolve independently

    -

    Implements

    Constructors

    Implements

    Constructors

    Properties

    Methods

    Constructors

    Properties

    rootStack: Stack
    stacks: Record<string, Stack> = {}

    Methods

    Properties

    rootStack: Stack
    stacks: Record<string, Stack> = {}

    Methods

    • Returns a cached NestedStack if resourceGroupName has been seen before Otherwise, creates a new NestedStack, caches it and returns it

      -

      Parameters

      • resourceGroupName: string

      Returns Stack

    \ No newline at end of file +

    Parameters

    Returns Stack

    \ No newline at end of file diff --git a/classes/_aws_amplify_backend_secret.SecretError.html b/classes/_aws_amplify_backend_secret.SecretError.html index b41ac32445..f1088d9a60 100644 --- a/classes/_aws_amplify_backend_secret.SecretError.html +++ b/classes/_aws_amplify_backend_secret.SecretError.html @@ -1,5 +1,5 @@ SecretError | Amplify Toolbox

    Secret Error.

    -

    Hierarchy

    • Error
      • SecretError

    Constructors

    Hierarchy

    • Error
      • SecretError

    Constructors

    Properties

    Constructors

    • Creates a secret error instance.

      -

      Parameters

      • message: string
      • Optional options: {
            cause?: Error;
            httpStatusCode?: number;
        }
        • Optional cause?: Error
        • Optional httpStatusCode?: number

      Returns SecretError

    Properties

    cause?: Error
    httpStatusCode?: number
    message: string
    name: string
    stack?: string
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    +

    Parameters

    • message: string
    • Optional options: {
          cause?: Error;
          httpStatusCode?: number;
      }
      • Optional cause?: Error
      • Optional httpStatusCode?: number

    Returns SecretError

    Properties

    cause?: Error
    httpStatusCode?: number
    message: string
    name: string
    stack?: string
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    Type declaration

      • (err, stackTraces): any
      • Parameters

        • err: Error
        • stackTraces: CallSite[]

        Returns any

    stackTraceLimit: number

    Methods

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    \ No newline at end of file +

    Parameters

    Returns SecretError

    \ No newline at end of file diff --git a/classes/_aws_amplify_cli_core.AmplifyPrompter.html b/classes/_aws_amplify_cli_core.AmplifyPrompter.html index c3ee881387..1e7654d2cb 100644 --- a/classes/_aws_amplify_cli_core.AmplifyPrompter.html +++ b/classes/_aws_amplify_cli_core.AmplifyPrompter.html @@ -1,7 +1,7 @@ AmplifyPrompter | Amplify Toolbox

    Wrapper for prompter library Because @inquirer/prompts library set the methods as non-configurable, we cannot mock the methods directly. see details: https://github.com/orgs/nodejs/discussions/47959

    -

    Constructors

    Constructors

    Methods

    input secretValue yesOrNo @@ -10,10 +10,10 @@
    • Optional defaultValue?: string

      if user submits without typing anything. Default: "."

    • message: string

      display for the prompt

    Returns Promise<string>

    Promise the user input

    -
    • A secret prompt.

      -

      Parameters

      • promptMessage: string = 'Enter secret value'

      Returns Promise<string>

    • A secret prompt.

      +

      Parameters

      • promptMessage: string = 'Enter secret value'

      Returns Promise<string>

    • A confirm style prompt. Styles question as y/N

      Parameters

      • options: {
            defaultValue?: boolean;
            message: string;
        }

        for displaying the prompt

        • Optional defaultValue?: boolean

          if user submits without typing anything. Defaults false

        • message: string

          display for the prompt

      Returns Promise<boolean>

      the boolean answer

      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/classes/_aws_amplify_cli_core.Format.html b/classes/_aws_amplify_cli_core.Format.html index 139992bfba..268896c169 100644 --- a/classes/_aws_amplify_cli_core.Format.html +++ b/classes/_aws_amplify_cli_core.Format.html @@ -1,5 +1,5 @@ Format | Amplify Toolbox

    Formats various inputs into single string.

    -

    Constructors

    Constructors

    Properties

    Methods

    bold color @@ -16,4 +16,4 @@ sectionHeader success

    Constructors

    • Initialize with a package manager runner name. Defaults to attempting to load a value derived from environment variables.

      -

      Parameters

      • packageManagerRunnerName: string = ...

      Returns Format

    Properties

    packageManagerRunnerName: string = ...

    Methods

    • Parameters

      • message: string
      • colorName: "Green" | "Yellow" | "Blue" | "Magenta" | "Cyan"

      Returns string

    • Parameters

      • command: string

      Returns string

    • Parameters

      • command: string

      Returns string

    • Parameters

      • record: Record<string, string | number | Date>

      Returns string

    • Parameters

      • header: string

      Returns string

    \ No newline at end of file +

    Parameters

    Returns Format

    Properties

    packageManagerRunnerName: string = ...

    Methods

    • Parameters

      • message: string
      • colorName: "Green" | "Yellow" | "Blue" | "Magenta" | "Cyan"

      Returns string

    • Parameters

      • command: string

      Returns string

    • Parameters

      • command: string

      Returns string

    • Parameters

      • record: Record<string, string | number | Date>

      Returns string

    • Parameters

      • header: string

      Returns string

    \ No newline at end of file diff --git a/classes/_aws_amplify_cli_core.PackageManagerControllerFactory.html b/classes/_aws_amplify_cli_core.PackageManagerControllerFactory.html index 4c4f0d1954..7cd243af20 100644 --- a/classes/_aws_amplify_cli_core.PackageManagerControllerFactory.html +++ b/classes/_aws_amplify_cli_core.PackageManagerControllerFactory.html @@ -1,11 +1,11 @@ PackageManagerControllerFactory | Amplify Toolbox

    PackageManagerControllerFactory is a factory for an abstraction around package manager commands that are needed to initialize a project and install dependencies

    -

    Constructors

    Constructors

    Properties

    cwd: string = ...

    the root directory of the project

    -
    platform: Platform = process.platform
    printer: Printer = _printer

    Methods

    \ No newline at end of file +
  • printer: Printer = _printer
  • platform: Platform = process.platform
  • Returns PackageManagerControllerFactory

    Properties

    cwd: string = ...

    the root directory of the project

    +
    platform: Platform = process.platform
    printer: Printer = _printer

    Methods

    \ No newline at end of file diff --git a/classes/_aws_amplify_cli_core.Printer.html b/classes/_aws_amplify_cli_core.Printer.html index 2017203747..903c1c44af 100644 --- a/classes/_aws_amplify_cli_core.Printer.html +++ b/classes/_aws_amplify_cli_core.Printer.html @@ -1,5 +1,5 @@ Printer | Amplify Toolbox

    The class that pretty prints to the output stream.

    -

    Constructors

    Constructors

    • Sets default configs

      -

      Parameters

      • minimumLogLevel: LogLevel
      • stdout: WriteStream | WritableStream = process.stdout
      • stderr: WriteStream | WritableStream = process.stderr
      • refreshRate: number = 500

      Returns Printer

    Properties

    minimumLogLevel: LogLevel
    refreshRate: number = 500
    spinnerFrames: string[] = ...

    Spinner frames

    -
    stderr: WriteStream | WritableStream = process.stderr
    stdout: WriteStream | WritableStream = process.stdout
    timer: Timeout
    timerSet: boolean

    Methods

    • Logs a message with animated spinner +

      Parameters

      • minimumLogLevel: LogLevel
      • stdout: WriteStream | WritableStream = process.stdout
      • stderr: WriteStream | WritableStream = process.stderr
      • refreshRate: number = 500

      Returns Printer

    Properties

    minimumLogLevel: LogLevel
    refreshRate: number = 500
    spinnerFrames: string[] = ...

    Spinner frames

    +
    stderr: WriteStream | WritableStream = process.stderr
    stdout: WriteStream | WritableStream = process.stdout
    timer: Timeout
    timerSet: boolean

    Methods

    • Logs a message with animated spinner If stdout is not a TTY, the message is logged at the info level without a spinner

      -

      Parameters

      • message: string
      • callback: (() => Promise<void>)
          • (): Promise<void>
          • Returns Promise<void>

      Returns Promise<void>

    • Logs a message to the output stream at the given log level followed by a newline

      -

      Parameters

      • message: string
      • level: LogLevel = LogLevel.INFO

      Returns void

    • Prints a given message to output stream followed by a newline.

      -

      Parameters

      • message: string

      Returns void

    • Starts animating spinner with a message.

      -

      Parameters

      • message: string

      Returns void

    • Writes escape sequence to stdout

      -

      Parameters

      • action: EscapeSequence

      Returns void

    \ No newline at end of file +

    Parameters

    Returns Promise<void>

    \ No newline at end of file diff --git a/classes/_aws_amplify_deployed_backend_client.BackendOutputClientError.html b/classes/_aws_amplify_deployed_backend_client.BackendOutputClientError.html index 6b39ec1b3c..12fe64ecd5 100644 --- a/classes/_aws_amplify_deployed_backend_client.BackendOutputClientError.html +++ b/classes/_aws_amplify_deployed_backend_client.BackendOutputClientError.html @@ -1,5 +1,5 @@ BackendOutputClientError | Amplify Toolbox

    Error type for BackendOutputClientError

    -

    Hierarchy

    • Error
      • BackendOutputClientError

    Constructors

    Hierarchy

    • Error
      • BackendOutputClientError

    Constructors

    Properties

    Methods

    Constructors

    Properties

    cause?: unknown
    message: string
    name: string
    stack?: string
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    +

    Parameters

    Returns BackendOutputClientError

    Properties

    cause?: unknown
    message: string
    name: string
    stack?: string
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    Type declaration

      • (err, stackTraces): any
      • Parameters

        • err: Error
        • stackTraces: CallSite[]

        Returns any

    stackTraceLimit: number

    Methods

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    \ No newline at end of file diff --git a/classes/_aws_amplify_deployed_backend_client.BackendOutputClientFactory.html b/classes/_aws_amplify_deployed_backend_client.BackendOutputClientFactory.html index 1b466772f7..701aa7fabb 100644 --- a/classes/_aws_amplify_deployed_backend_client.BackendOutputClientFactory.html +++ b/classes/_aws_amplify_deployed_backend_client.BackendOutputClientFactory.html @@ -1,5 +1,5 @@ BackendOutputClientFactory | Amplify Toolbox

    Factory to create a backend metadata reader

    -

    Constructors

    Constructors

    Methods

    Constructors

    Methods

    \ No newline at end of file +

    Parameters

    • Optional awsClientProvider: AWSClientProvider<{
          getAmplifyClient: AmplifyClient;
          getCloudFormationClient: CloudFormationClient;
      }>

    Returns BackendOutputClient

    \ No newline at end of file diff --git a/classes/_aws_amplify_deployed_backend_client.DeployedBackendClientFactory.html b/classes/_aws_amplify_deployed_backend_client.DeployedBackendClientFactory.html index 16d233ab90..fdf61b9e3c 100644 --- a/classes/_aws_amplify_deployed_backend_client.DeployedBackendClientFactory.html +++ b/classes/_aws_amplify_deployed_backend_client.DeployedBackendClientFactory.html @@ -1,5 +1,5 @@ DeployedBackendClientFactory | Amplify Toolbox

    Factory to create a DeploymentClient

    -

    Constructors

    Constructors

    Methods

    Constructors

    Methods

    \ No newline at end of file +

    Parameters

    Returns DeployedBackendClient

    \ No newline at end of file diff --git a/classes/_aws_amplify_platform_core.AmplifyError.html b/classes/_aws_amplify_platform_core.AmplifyError.html index c1579c2787..fd4f900921 100644 --- a/classes/_aws_amplify_platform_core.AmplifyError.html +++ b/classes/_aws_amplify_platform_core.AmplifyError.html @@ -1,5 +1,5 @@ AmplifyError | Amplify Toolbox

    Base class for all Amplify errors or faults

    -

    Type Parameters

    • T extends string = string

    Hierarchy (view full)

    Constructors

    Type Parameters

    • T extends string = string

    Hierarchy (view full)

    Constructors

    Properties

    cause? classification code? @@ -24,12 +24,12 @@ you must provide the exception that was caught.

    Returns AmplifyError<T>

    Example

    try {
    ...
    } catch (error){
    throw new AmplifyError(...,...,error);
    }
    -

    Properties

    cause?: Error

    If you are throwing this exception from within a catch block, +

    Properties

    cause?: Error

    If you are throwing this exception from within a catch block, you must provide the exception that was caught.

    -

    LibraryFault or UserError

    -
    code?: string
    details?: string
    link?: string
    message: string
    name: T

    a user friendly name for the exception

    -

    error stack, resolution steps, details, or help links

    -
    resolution?: string
    serializedError?: string
    stack?: string
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    +

    LibraryFault or UserError

    +
    code?: string
    details?: string
    link?: string
    message: string
    name: T

    a user friendly name for the exception

    +

    error stack, resolution steps, details, or help links

    +
    resolution?: string
    serializedError?: string
    stack?: string
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    Type declaration

      • (err, stackTraces): any
      • Parameters

        • err: Error
        • stackTraces: CallSite[]

        Returns any

    stackTraceLimit: number

    Methods

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    \ No newline at end of file +

    Parameters

    Returns void

    \ No newline at end of file diff --git a/classes/_aws_amplify_platform_core.AmplifyFault.html b/classes/_aws_amplify_platform_core.AmplifyFault.html index 51f7acb1f0..b7cae8fae4 100644 --- a/classes/_aws_amplify_platform_core.AmplifyFault.html +++ b/classes/_aws_amplify_platform_core.AmplifyFault.html @@ -1,5 +1,5 @@ AmplifyFault | Amplify Toolbox

    Base class for all Amplify library faults

    -

    Type Parameters

    • T extends string = string

    Hierarchy (view full)

    Constructors

    Type Parameters

    • T extends string = string

    Hierarchy (view full)

    Constructors

    Properties

    cause? classification code? @@ -22,11 +22,11 @@ you must provide the exception that was caught.

    Returns AmplifyFault<T>

    Example

    try {
    ...
    } catch (error){
    throw new AmplifyLibraryFault(error,...,...);
    }
    -

    Properties

    cause?: Error

    If you are throwing this exception from within a catch block, +

    Properties

    cause?: Error

    If you are throwing this exception from within a catch block, you must provide the exception that was caught.

    -

    LibraryFault or UserError

    -
    code?: string
    details?: string
    link?: string
    message: string
    name: T

    a user friendly name for the exception

    -
    resolution?: string
    serializedError?: string
    stack?: string
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    +

    LibraryFault or UserError

    +
    code?: string
    details?: string
    link?: string
    message: string
    name: T

    a user friendly name for the exception

    +
    resolution?: string
    serializedError?: string
    stack?: string
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    Type declaration

      • (err, stackTraces): any
      • Parameters

        • err: Error
        • stackTraces: CallSite[]

        Returns any

    stackTraceLimit: number

    Methods

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    \ No newline at end of file +

    Parameters

    Returns void

    \ No newline at end of file diff --git a/classes/_aws_amplify_platform_core.AmplifyUserError.html b/classes/_aws_amplify_platform_core.AmplifyUserError.html index 70330f4734..938f78c30b 100644 --- a/classes/_aws_amplify_platform_core.AmplifyUserError.html +++ b/classes/_aws_amplify_platform_core.AmplifyUserError.html @@ -1,5 +1,5 @@ AmplifyUserError | Amplify Toolbox

    Base class for all Amplify user errors

    -

    Type Parameters

    • T extends string = string

    Hierarchy (view full)

    Constructors

    Type Parameters

    • T extends string = string

    Hierarchy (view full)

    Constructors

    Properties

    cause? classification code? @@ -22,11 +22,11 @@ you must provide the error that was caught.

    Returns AmplifyUserError<T>

    Example

    try {
    ...
    } catch (error){
    throw new AmplifyError(...,...,error);
    }
    -

    Properties

    cause?: Error

    If you are throwing this exception from within a catch block, +

    Properties

    cause?: Error

    If you are throwing this exception from within a catch block, you must provide the exception that was caught.

    -

    LibraryFault or UserError

    -
    code?: string
    details?: string
    link?: string
    message: string
    name: T

    a user friendly name for the exception

    -
    resolution?: string
    serializedError?: string
    stack?: string
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    +

    LibraryFault or UserError

    +
    code?: string
    details?: string
    link?: string
    message: string
    name: T

    a user friendly name for the exception

    +
    resolution?: string
    serializedError?: string
    stack?: string
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    Type declaration

      • (err, stackTraces): any
      • Parameters

        • err: Error
        • stackTraces: CallSite[]

        Returns any

    stackTraceLimit: number

    Methods

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    \ No newline at end of file +

    Parameters

    Returns void

    \ No newline at end of file diff --git a/classes/_aws_amplify_platform_core.BackendIdentifierConversions.html b/classes/_aws_amplify_platform_core.BackendIdentifierConversions.html index 9468b9db3e..9a75fcdc8d 100644 --- a/classes/_aws_amplify_platform_core.BackendIdentifierConversions.html +++ b/classes/_aws_amplify_platform_core.BackendIdentifierConversions.html @@ -1,11 +1,11 @@ BackendIdentifierConversions | Amplify Toolbox

    Provides static methods for converting BackendIdentifier to/from a stack name string

    -

    Constructors

    Constructors

    Methods

    • Convert a BackendIdentifier to a stack name.

      !!!DANGER!!! !!!DO NOT CHANGE THIS UNLESS YOU ARE 100% SURE YOU UNDERSTAND THE CONSEQUENCES!!!

      Changing this method will change how stack names are generated which could be a massive breaking change for existing Amplify stacks.

      -

      Parameters

      Returns string

    \ No newline at end of file +

    Parameters

    Returns string

    \ No newline at end of file diff --git a/classes/_aws_amplify_platform_core.BackendLocator.html b/classes/_aws_amplify_platform_core.BackendLocator.html index f07c3a83c2..ac0b3497fe 100644 --- a/classes/_aws_amplify_platform_core.BackendLocator.html +++ b/classes/_aws_amplify_platform_core.BackendLocator.html @@ -1,8 +1,8 @@ BackendLocator | Amplify Toolbox

    Find the backend definition file in the customer app that represents a CDK app.

    -

    Constructors

    Constructors

    Properties

    relativePath: string = ...
    rootDir: string = ...
    supportedFileExtensions: string[] = ...

    Methods

    \ No newline at end of file +

    Parameters

    Returns BackendLocator

    Properties

    relativePath: string = ...
    rootDir: string = ...
    supportedFileExtensions: string[] = ...

    Methods

    \ No newline at end of file diff --git a/classes/_aws_amplify_platform_core.CallerDirectoryExtractor.html b/classes/_aws_amplify_platform_core.CallerDirectoryExtractor.html index 4aba3b84d9..11305e9377 100644 --- a/classes/_aws_amplify_platform_core.CallerDirectoryExtractor.html +++ b/classes/_aws_amplify_platform_core.CallerDirectoryExtractor.html @@ -1,8 +1,8 @@ CallerDirectoryExtractor | Amplify Toolbox

    Extracts the path of the caller of the code that generated the input stack trace. In other words, extracts the path from the second entry in the stack trace (the first entry being the location where the stack trace was created and the second entry being the location that called the code that generated the stack trace)

    -

    Constructors

    Constructors

    Properties

    Methods

    Constructors

    Properties

    stackTrace: undefined | string

    Methods

    \ No newline at end of file +

    Parameters

    Returns CallerDirectoryExtractor

    Properties

    stackTrace: undefined | string

    Methods

    \ No newline at end of file diff --git a/classes/_aws_amplify_platform_core.ConfigurationControllerFactory.html b/classes/_aws_amplify_platform_core.ConfigurationControllerFactory.html index f8f24f5d13..0aa6179f9c 100644 --- a/classes/_aws_amplify_platform_core.ConfigurationControllerFactory.html +++ b/classes/_aws_amplify_platform_core.ConfigurationControllerFactory.html @@ -1,7 +1,7 @@ ConfigurationControllerFactory | Amplify Toolbox

    Instantiates LocalConfigurationController

    -

    Constructors

    Constructors

    Properties

    Methods

    Constructors

    Properties

    controllers: Record<string, ConfigurationController>

    Methods

    \ No newline at end of file +

    Returns ConfigurationControllerFactory

    Properties

    controllers: Record<string, ConfigurationController>

    Methods

    \ No newline at end of file diff --git a/classes/_aws_amplify_platform_core.FilePathExtractor.html b/classes/_aws_amplify_platform_core.FilePathExtractor.html index 1adad36a22..d05d08bfa4 100644 --- a/classes/_aws_amplify_platform_core.FilePathExtractor.html +++ b/classes/_aws_amplify_platform_core.FilePathExtractor.html @@ -1,7 +1,7 @@ FilePathExtractor | Amplify Toolbox

    Extracts a file path from a given stack trace line

    -

    Constructors

    Constructors

    Properties

    Methods

    Constructors

    Properties

    stackTraceLine: string

    Methods

    \ No newline at end of file +

    Parameters

    Returns FilePathExtractor

    Properties

    stackTraceLine: string

    Methods

    \ No newline at end of file diff --git a/classes/_aws_amplify_platform_core.ObjectAccumulator.html b/classes/_aws_amplify_platform_core.ObjectAccumulator.html index 0d185c9e30..b03f5f77e4 100644 --- a/classes/_aws_amplify_platform_core.ObjectAccumulator.html +++ b/classes/_aws_amplify_platform_core.ObjectAccumulator.html @@ -1,13 +1,13 @@ ObjectAccumulator | Amplify Toolbox

    A class that can accumulate (squash merge) objects into single instance.

    -

    Type Parameters

    • T

    Constructors

    Type Parameters

    • T

    Constructors

    Properties

    versionKey: string = 'version'

    Methods

    Properties

    versionKey: string = 'version'

    Methods

    \ No newline at end of file +
    \ No newline at end of file diff --git a/classes/_aws_amplify_platform_core.ObjectAccumulatorPropertyAlreadyExistsError.html b/classes/_aws_amplify_platform_core.ObjectAccumulatorPropertyAlreadyExistsError.html index a512c6f4ca..89b5c1223b 100644 --- a/classes/_aws_amplify_platform_core.ObjectAccumulatorPropertyAlreadyExistsError.html +++ b/classes/_aws_amplify_platform_core.ObjectAccumulatorPropertyAlreadyExistsError.html @@ -1,5 +1,5 @@ ObjectAccumulatorPropertyAlreadyExistsError | Amplify Toolbox

    This error is thrown when there's a collision in the object keys

    -

    Hierarchy

    • Error
      • ObjectAccumulatorPropertyAlreadyExistsError

    Constructors

    Hierarchy

    • Error
      • ObjectAccumulatorPropertyAlreadyExistsError

    Constructors

    Properties

    Methods

    Constructors

    Properties

    cause?: unknown
    existingValue: unknown
    incomingValue: unknown
    key: string
    message: string
    name: string
    stack?: string
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    +

    Parameters

    • key: string
    • existingValue: unknown
    • incomingValue: unknown

    Returns ObjectAccumulatorPropertyAlreadyExistsError

    Properties

    cause?: unknown
    existingValue: unknown
    incomingValue: unknown
    key: string
    message: string
    name: string
    stack?: string
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    Type declaration

      • (err, stackTraces): any
      • Parameters

        • err: Error
        • stackTraces: CallSite[]

        Returns any

    stackTraceLimit: number

    Methods

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    \ No newline at end of file diff --git a/classes/_aws_amplify_platform_core.ObjectAccumulatorVersionMismatchError.html b/classes/_aws_amplify_platform_core.ObjectAccumulatorVersionMismatchError.html index a5303db207..ef0e7f54df 100644 --- a/classes/_aws_amplify_platform_core.ObjectAccumulatorVersionMismatchError.html +++ b/classes/_aws_amplify_platform_core.ObjectAccumulatorVersionMismatchError.html @@ -1,5 +1,5 @@ ObjectAccumulatorVersionMismatchError | Amplify Toolbox

    This error is thrown when partial objects with different versions are being accumulated

    -

    Hierarchy

    • Error
      • ObjectAccumulatorVersionMismatchError

    Constructors

    Hierarchy

    • Error
      • ObjectAccumulatorVersionMismatchError

    Constructors

    Properties

    Methods

    Constructors

    Properties

    cause?: unknown
    existingVersion: string
    message: string
    name: string
    newVersion: string
    stack?: string
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    +

    Parameters

    • existingVersion: string
    • newVersion: string

    Returns ObjectAccumulatorVersionMismatchError

    Properties

    cause?: unknown
    existingVersion: string
    message: string
    name: string
    newVersion: string
    stack?: string
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    Type declaration

      • (err, stackTraces): any
      • Parameters

        • err: Error
        • stackTraces: CallSite[]

        Returns any

    stackTraceLimit: number

    Methods

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    \ No newline at end of file diff --git a/classes/_aws_amplify_platform_core.PackageJsonReader.html b/classes/_aws_amplify_platform_core.PackageJsonReader.html index 202d3b0997..0a9e4bb423 100644 --- a/classes/_aws_amplify_platform_core.PackageJsonReader.html +++ b/classes/_aws_amplify_platform_core.PackageJsonReader.html @@ -1,7 +1,7 @@ PackageJsonReader | Amplify Toolbox

    return the package json

    -

    Constructors

    Constructors

    Methods

    Constructors

    Methods

    • Parameters

      • absolutePackageJsonPath: string

      Returns {
          name?: string;
          type?: "module" | "commonjs";
          version?: string;
      }

      • Optional name?: string
      • Optional type?: "module" | "commonjs"
      • Optional version?: string
    • Returns the contents of the package.json file in process.cwd()

      +

    Constructors

    Methods

    • Parameters

      • absolutePackageJsonPath: string

      Returns {
          name?: string;
          type?: "module" | "commonjs";
          version?: string;
      }

      • Optional name?: string
      • Optional type?: "module" | "commonjs"
      • Optional version?: string
    • Returns the contents of the package.json file in process.cwd()

      If no package.json file exists, or the content does not pass validation, an error is thrown

      -

      Returns {
          name?: string;
          type?: "module" | "commonjs";
          version?: string;
      }

      • Optional name?: string
      • Optional type?: "module" | "commonjs"
      • Optional version?: string
    \ No newline at end of file +

    Returns {
        name?: string;
        type?: "module" | "commonjs";
        version?: string;
    }

    \ No newline at end of file diff --git a/classes/_aws_amplify_platform_core.ParameterPathConversions.html b/classes/_aws_amplify_platform_core.ParameterPathConversions.html index 8810153753..70ee644298 100644 --- a/classes/_aws_amplify_platform_core.ParameterPathConversions.html +++ b/classes/_aws_amplify_platform_core.ParameterPathConversions.html @@ -1,9 +1,9 @@ ParameterPathConversions | Amplify Toolbox

    Provides static methods for converting BackendIdentifier to parameter path strings

    -

    Constructors

    Constructors

    Methods

    \ No newline at end of file +

    Parameters

    Returns string

    \ No newline at end of file diff --git a/classes/_aws_amplify_platform_core.UsageDataEmitterFactory.html b/classes/_aws_amplify_platform_core.UsageDataEmitterFactory.html index ef27ca6adb..05d1d080cc 100644 --- a/classes/_aws_amplify_platform_core.UsageDataEmitterFactory.html +++ b/classes/_aws_amplify_platform_core.UsageDataEmitterFactory.html @@ -1,5 +1,5 @@ UsageDataEmitterFactory | Amplify Toolbox

    Creates UsageDataEmitter for a given library version

    -

    Constructors

    Constructors

    Methods

    Constructors

    Methods

    \ No newline at end of file +

    Parameters

    Returns Promise<UsageDataEmitter>

    \ No newline at end of file diff --git a/classes/_aws_amplify_sandbox.SandboxSingletonFactory.html b/classes/_aws_amplify_sandbox.SandboxSingletonFactory.html index bc898c44ed..e55f3eddfa 100644 --- a/classes/_aws_amplify_sandbox.SandboxSingletonFactory.html +++ b/classes/_aws_amplify_sandbox.SandboxSingletonFactory.html @@ -1,10 +1,10 @@ SandboxSingletonFactory | Amplify Toolbox

    Factory to create a new sandbox

    -

    Constructors

    Constructors

    Properties

    format: Format
    instance: undefined | Sandbox
    printer: Printer
    sandboxIdResolver: BackendIdSandboxResolver

    Methods

    \ No newline at end of file +

    Parameters

    Returns SandboxSingletonFactory

    Properties

    format: Format
    instance: undefined | Sandbox
    printer: Printer
    sandboxIdResolver: BackendIdSandboxResolver

    Methods

    \ No newline at end of file diff --git a/classes/_aws_amplify_schema_generator.SchemaGenerator.html b/classes/_aws_amplify_schema_generator.SchemaGenerator.html index ce66571c2b..5cc0119302 100644 --- a/classes/_aws_amplify_schema_generator.SchemaGenerator.html +++ b/classes/_aws_amplify_schema_generator.SchemaGenerator.html @@ -1,4 +1,4 @@ SchemaGenerator | Amplify Toolbox

    Schema generator class.

    -

    Constructors

    Constructors

    Methods

    Constructors

    Methods

    \ No newline at end of file +

    Constructors

    Methods

    \ No newline at end of file diff --git a/enums/_aws_amplify_cli_core.LogLevel.html b/enums/_aws_amplify_cli_core.LogLevel.html index 22794848e1..2213635aa4 100644 --- a/enums/_aws_amplify_cli_core.LogLevel.html +++ b/enums/_aws_amplify_cli_core.LogLevel.html @@ -1,4 +1,4 @@ -LogLevel | Amplify Toolbox

    Enumeration Members

    DEBUG +LogLevel | Amplify Toolbox

    Enumeration Members

    Enumeration Members

    DEBUG: 2
    ERROR: 0
    INFO: 1
    \ No newline at end of file +

    Enumeration Members

    DEBUG: 2
    ERROR: 0
    INFO: 1
    \ No newline at end of file diff --git a/enums/_aws_amplify_client_config.ClientConfigFileBaseName.html b/enums/_aws_amplify_client_config.ClientConfigFileBaseName.html index 9371f00030..d660101f8b 100644 --- a/enums/_aws_amplify_client_config.ClientConfigFileBaseName.html +++ b/enums/_aws_amplify_client_config.ClientConfigFileBaseName.html @@ -1,3 +1,3 @@ -ClientConfigFileBaseName | Amplify Toolbox

    Enumeration Members

    DEFAULT +ClientConfigFileBaseName | Amplify Toolbox

    Enumeration Members

    Enumeration Members

    DEFAULT: "amplify_outputs"
    LEGACY: "amplifyconfiguration"
    \ No newline at end of file +

    Enumeration Members

    DEFAULT: "amplify_outputs"
    LEGACY: "amplifyconfiguration"
    \ No newline at end of file diff --git a/enums/_aws_amplify_client_config.ClientConfigFormat.html b/enums/_aws_amplify_client_config.ClientConfigFormat.html index 50984634ec..934fb22967 100644 --- a/enums/_aws_amplify_client_config.ClientConfigFormat.html +++ b/enums/_aws_amplify_client_config.ClientConfigFormat.html @@ -1,6 +1,6 @@ -ClientConfigFormat | Amplify Toolbox

    Enumeration Members

    DART +ClientConfigFormat | Amplify Toolbox

    Enumeration Members

    Enumeration Members

    DART: "dart"
    JSON: "json"
    JSON_MOBILE: "json-mobile"
    MJS: "mjs"
    TS: "ts"
    \ No newline at end of file +

    Enumeration Members

    DART: "dart"
    JSON: "json"
    JSON_MOBILE: "json-mobile"
    MJS: "mjs"
    TS: "ts"
    \ No newline at end of file diff --git a/enums/_aws_amplify_client_config.ClientConfigVersionOption.html b/enums/_aws_amplify_client_config.ClientConfigVersionOption.html index bad9047dfd..a144953091 100644 --- a/enums/_aws_amplify_client_config.ClientConfigVersionOption.html +++ b/enums/_aws_amplify_client_config.ClientConfigVersionOption.html @@ -1,4 +1,4 @@ -ClientConfigVersionOption | Amplify Toolbox

    Enumeration Members

    V0 +ClientConfigVersionOption | Amplify Toolbox

    Enumeration Members

    Enumeration Members

    V0: "0"
    V1: "1"
    V1_1: "1.1"
    \ No newline at end of file +

    Enumeration Members

    V0: "0"
    V1: "1"
    V1_1: "1.1"
    \ No newline at end of file diff --git a/enums/_aws_amplify_deployed_backend_client.ApiAuthType.html b/enums/_aws_amplify_deployed_backend_client.ApiAuthType.html index 9168e4fb81..b153cd7532 100644 --- a/enums/_aws_amplify_deployed_backend_client.ApiAuthType.html +++ b/enums/_aws_amplify_deployed_backend_client.ApiAuthType.html @@ -1,6 +1,6 @@ -ApiAuthType | Amplify Toolbox

    Enumeration Members

    AMAZON_COGNITO_USER_POOLS +ApiAuthType | Amplify Toolbox
    \ No newline at end of file +

    Enumeration Members

    AMAZON_COGNITO_USER_POOLS: "AMAZON_COGNITO_USER_POOLS"
    API_KEY: "API_KEY"
    AWS_IAM: "AWS_IAM"
    AWS_LAMBDA: "AWS_LAMBDA"
    OPENID_CONNECT: "OPENID_CONNECT"
    \ No newline at end of file diff --git a/enums/_aws_amplify_deployed_backend_client.BackendDeploymentStatus.html b/enums/_aws_amplify_deployed_backend_client.BackendDeploymentStatus.html index 22ccb8df66..b85c75f4c1 100644 --- a/enums/_aws_amplify_deployed_backend_client.BackendDeploymentStatus.html +++ b/enums/_aws_amplify_deployed_backend_client.BackendDeploymentStatus.html @@ -1,7 +1,7 @@ -BackendDeploymentStatus | Amplify Toolbox

    Enumeration Members

    DELETED +BackendDeploymentStatus | Amplify Toolbox
    \ No newline at end of file +

    Enumeration Members

    DELETED: "DELETED"
    DELETING: "DELETING"
    DEPLOYED: "DEPLOYED"
    DEPLOYING: "DEPLOYING"
    FAILED: "FAILED"
    UNKNOWN: "UNKNOWN"
    \ No newline at end of file diff --git a/enums/_aws_amplify_deployed_backend_client.BackendOutputClientErrorType.html b/enums/_aws_amplify_deployed_backend_client.BackendOutputClientErrorType.html index a65a950b88..0cc17905be 100644 --- a/enums/_aws_amplify_deployed_backend_client.BackendOutputClientErrorType.html +++ b/enums/_aws_amplify_deployed_backend_client.BackendOutputClientErrorType.html @@ -1,7 +1,7 @@ -BackendOutputClientErrorType | Amplify Toolbox

    Enumeration Members

    ACCESS_DENIED +BackendOutputClientErrorType | Amplify Toolbox

    Enumeration Members

    ACCESS_DENIED: "AccessDenied"
    CREDENTIALS_ERROR: "CredentialsError"
    DEPLOYMENT_IN_PROGRESS: "DeploymentInProgress"
    METADATA_RETRIEVAL_ERROR: "MetadataRetrievalError"
    NO_OUTPUTS_FOUND: "NoOutputsFound"
    NO_STACK_FOUND: "NoStackFound"
    \ No newline at end of file +

    Enumeration Members

    ACCESS_DENIED: "AccessDenied"
    CREDENTIALS_ERROR: "CredentialsError"
    DEPLOYMENT_IN_PROGRESS: "DeploymentInProgress"
    METADATA_RETRIEVAL_ERROR: "MetadataRetrievalError"
    NO_OUTPUTS_FOUND: "NoOutputsFound"
    NO_STACK_FOUND: "NoStackFound"
    \ No newline at end of file diff --git a/enums/_aws_amplify_deployed_backend_client.BackendStatus.html b/enums/_aws_amplify_deployed_backend_client.BackendStatus.html index a2c6e98f8c..bfc23d2fc2 100644 --- a/enums/_aws_amplify_deployed_backend_client.BackendStatus.html +++ b/enums/_aws_amplify_deployed_backend_client.BackendStatus.html @@ -1,2 +1,2 @@ -BackendStatus | Amplify Toolbox
    \ No newline at end of file +BackendStatus | Amplify Toolbox
    \ No newline at end of file diff --git a/enums/_aws_amplify_deployed_backend_client.ConflictResolutionMode.html b/enums/_aws_amplify_deployed_backend_client.ConflictResolutionMode.html index 18c33a4cbe..12fdced9bf 100644 --- a/enums/_aws_amplify_deployed_backend_client.ConflictResolutionMode.html +++ b/enums/_aws_amplify_deployed_backend_client.ConflictResolutionMode.html @@ -1,4 +1,4 @@ -ConflictResolutionMode | Amplify Toolbox

    Enumeration Members

    AUTOMERGE +ConflictResolutionMode | Amplify Toolbox
    \ No newline at end of file +

    Enumeration Members

    AUTOMERGE: "AUTOMERGE"
    LAMBDA: "LAMBDA"
    OPTIMISTIC_CONCURRENCY: "OPTIMISTIC_CONCURRENCY"
    \ No newline at end of file diff --git a/enums/_aws_amplify_model_generator.GenerateApiCodeFormat.html b/enums/_aws_amplify_model_generator.GenerateApiCodeFormat.html index 0b3b7f8578..1d7e1142f7 100644 --- a/enums/_aws_amplify_model_generator.GenerateApiCodeFormat.html +++ b/enums/_aws_amplify_model_generator.GenerateApiCodeFormat.html @@ -1,4 +1,4 @@ -GenerateApiCodeFormat | Amplify Toolbox

    Enumeration Members

    GRAPHQL_CODEGEN +GenerateApiCodeFormat | Amplify Toolbox

    Enumeration Members

    GRAPHQL_CODEGEN: "graphql-codegen"
    INTROSPECTION: "introspection"
    MODELGEN: "modelgen"
    \ No newline at end of file +

    Enumeration Members

    GRAPHQL_CODEGEN: "graphql-codegen"
    INTROSPECTION: "introspection"
    MODELGEN: "modelgen"
    \ No newline at end of file diff --git a/enums/_aws_amplify_model_generator.GenerateApiCodeModelTarget.html b/enums/_aws_amplify_model_generator.GenerateApiCodeModelTarget.html index 8f8eca8a49..e092a8596f 100644 --- a/enums/_aws_amplify_model_generator.GenerateApiCodeModelTarget.html +++ b/enums/_aws_amplify_model_generator.GenerateApiCodeModelTarget.html @@ -1,6 +1,6 @@ -GenerateApiCodeModelTarget | Amplify Toolbox

    Enumeration Members

    DART +GenerateApiCodeModelTarget | Amplify Toolbox

    Enumeration Members

    Enumeration Members

    DART: "dart"
    JAVA: "java"
    JAVASCRIPT: "javascript"
    SWIFT: "swift"
    TYPESCRIPT: "typescript"
    \ No newline at end of file +

    Enumeration Members

    DART: "dart"
    JAVA: "java"
    JAVASCRIPT: "javascript"
    SWIFT: "swift"
    TYPESCRIPT: "typescript"
    \ No newline at end of file diff --git a/enums/_aws_amplify_model_generator.GenerateApiCodeStatementTarget.html b/enums/_aws_amplify_model_generator.GenerateApiCodeStatementTarget.html index 86a60a3eb9..092ca86f6a 100644 --- a/enums/_aws_amplify_model_generator.GenerateApiCodeStatementTarget.html +++ b/enums/_aws_amplify_model_generator.GenerateApiCodeStatementTarget.html @@ -1,6 +1,6 @@ -GenerateApiCodeStatementTarget | Amplify Toolbox

    Enumeration Members

    ANGULAR +GenerateApiCodeStatementTarget | Amplify Toolbox

    Enumeration Members

    ANGULAR: "angular"
    FLOW: "flow"
    GRAPHQL: "graphql"
    JAVASCRIPT: "javascript"
    TYPESCRIPT: "typescript"
    \ No newline at end of file +

    Enumeration Members

    ANGULAR: "angular"
    FLOW: "flow"
    GRAPHQL: "graphql"
    JAVASCRIPT: "javascript"
    TYPESCRIPT: "typescript"
    \ No newline at end of file diff --git a/enums/_aws_amplify_model_generator.GenerateApiCodeTypeTarget.html b/enums/_aws_amplify_model_generator.GenerateApiCodeTypeTarget.html index ab26a5e462..de3d96682c 100644 --- a/enums/_aws_amplify_model_generator.GenerateApiCodeTypeTarget.html +++ b/enums/_aws_amplify_model_generator.GenerateApiCodeTypeTarget.html @@ -1,8 +1,8 @@ -GenerateApiCodeTypeTarget | Amplify Toolbox

    Enumeration Members

    ANGULAR +GenerateApiCodeTypeTarget | Amplify Toolbox

    Enumeration Members

    ANGULAR: "angular"
    FLOW: "flow"
    FLOW_MODERN: "flow-modern"
    JSON: "json"
    SCALA: "scala"
    SWIFT: "swift"
    TYPESCRIPT: "typescript"
    \ No newline at end of file +

    Enumeration Members

    ANGULAR: "angular"
    FLOW: "flow"
    FLOW_MODERN: "flow-modern"
    JSON: "json"
    SCALA: "scala"
    SWIFT: "swift"
    TYPESCRIPT: "typescript"
    \ No newline at end of file diff --git a/enums/_aws_amplify_platform_core.CDKContextKey.html b/enums/_aws_amplify_platform_core.CDKContextKey.html index 3f2d24021d..c6ca29e1e3 100644 --- a/enums/_aws_amplify_platform_core.CDKContextKey.html +++ b/enums/_aws_amplify_platform_core.CDKContextKey.html @@ -1,7 +1,7 @@ CDKContextKey | Amplify Toolbox

    Keys for values that are passed between the Amplify deployment engine and the CDK synth process via CDK Context

    !!!WARNING!!! Changing the values of these keys could be a breaking change

    -

    Enumeration Members

    Enumeration Members

    BACKEND_NAME: "amplify-backend-name"
    BACKEND_NAMESPACE: "amplify-backend-namespace"
    DEPLOYMENT_TYPE: "amplify-backend-type"
    \ No newline at end of file +

    Enumeration Members

    BACKEND_NAME: "amplify-backend-name"
    BACKEND_NAMESPACE: "amplify-backend-namespace"
    DEPLOYMENT_TYPE: "amplify-backend-type"
    \ No newline at end of file diff --git a/enums/_aws_amplify_platform_core.TagName.html b/enums/_aws_amplify_platform_core.TagName.html index f79ca67400..7b975b65a3 100644 --- a/enums/_aws_amplify_platform_core.TagName.html +++ b/enums/_aws_amplify_platform_core.TagName.html @@ -1,2 +1,2 @@ -TagName | Amplify Toolbox

    Enumeration Members

    Enumeration Members

    FRIENDLY_NAME: "amplify:friendly-name"
    \ No newline at end of file +TagName | Amplify Toolbox

    Enumeration Members

    Enumeration Members

    FRIENDLY_NAME: "amplify:friendly-name"
    \ No newline at end of file diff --git a/functions/_aws_amplify_backend.defineBackend.html b/functions/_aws_amplify_backend.defineBackend.html index 8d80daeb60..37d7bb40af 100644 --- a/functions/_aws_amplify_backend.defineBackend.html +++ b/functions/_aws_amplify_backend.defineBackend.html @@ -1,3 +1,3 @@ defineBackend | Amplify Toolbox
    \ No newline at end of file +

    Returns Backend<T>

    \ No newline at end of file diff --git a/functions/_aws_amplify_backend.secret.html b/functions/_aws_amplify_backend.secret.html index cefacb89f7..a2bec091b3 100644 --- a/functions/_aws_amplify_backend.secret.html +++ b/functions/_aws_amplify_backend.secret.html @@ -9,4 +9,4 @@

    Example: Using a secret

             defineAuth({
    loginWith: {
    email: {},
    externalProviders: {
    loginWithAmazon: {
    clientId: secret('LOGIN_WITH_AMAZON_CLIENT_ID'),
    clientSecret: secret('LOGIN_WITH_AMAZON_CLIENT_SECRET'),
    },
    },
    },
    })
    ```
    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/functions/_aws_amplify_backend_auth.defineAuth.html b/functions/_aws_amplify_backend_auth.defineAuth.html index 358733b72b..fd9f6855ee 100644 --- a/functions/_aws_amplify_backend_auth.defineAuth.html +++ b/functions/_aws_amplify_backend_auth.defineAuth.html @@ -35,4 +35,4 @@

    Example

    access<
     
  • Optional userAttributes?: UserAttributes

    The set of attributes that are required for every user in the user pool. Read more on attributes here - https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html

    Default

    - email/phone will be added as required user attributes if they are included as login methods
     
    -
  • Returns ConstructFactory<BackendAuth>

    \ No newline at end of file +

    Returns ConstructFactory<BackendAuth>

    \ No newline at end of file diff --git a/functions/_aws_amplify_backend_data.defineData.html b/functions/_aws_amplify_backend_data.defineData.html index 0c0294dae0..c8ece7ea34 100644 --- a/functions/_aws_amplify_backend_data.defineData.html +++ b/functions/_aws_amplify_backend_data.defineData.html @@ -1,2 +1,2 @@ defineData | Amplify Toolbox
    \ No newline at end of file +

    Parameters

    Returns ConstructFactory<AmplifyGraphqlApi>

    \ No newline at end of file diff --git a/functions/_aws_amplify_backend_function.defineFunction.html b/functions/_aws_amplify_backend_function.defineFunction.html index c1b0e7c3ca..745f6d8f82 100644 --- a/functions/_aws_amplify_backend_function.defineFunction.html +++ b/functions/_aws_amplify_backend_function.defineFunction.html @@ -1,2 +1,2 @@ defineFunction | Amplify Toolbox
    \ No newline at end of file +

    Parameters

    Returns ConstructFactory<ResourceProvider<FunctionResources> & ResourceAccessAcceptorFactory & AddEnvironmentFactory & StackProvider>

    \ No newline at end of file diff --git a/functions/_aws_amplify_backend_secret.getSecretClient.html b/functions/_aws_amplify_backend_secret.getSecretClient.html index 3ea44d4af1..ca6df46ac4 100644 --- a/functions/_aws_amplify_backend_secret.getSecretClient.html +++ b/functions/_aws_amplify_backend_secret.getSecretClient.html @@ -1,2 +1,2 @@ getSecretClient | Amplify Toolbox
    \ No newline at end of file +

    Parameters

    Returns SecretClient

    \ No newline at end of file diff --git a/functions/_aws_amplify_backend_secret.getSecretClientWithAmplifyErrorHandling.html b/functions/_aws_amplify_backend_secret.getSecretClientWithAmplifyErrorHandling.html index edfad47cfb..240808fc2f 100644 --- a/functions/_aws_amplify_backend_secret.getSecretClientWithAmplifyErrorHandling.html +++ b/functions/_aws_amplify_backend_secret.getSecretClientWithAmplifyErrorHandling.html @@ -1,3 +1,3 @@ getSecretClientWithAmplifyErrorHandling | Amplify Toolbox
    \ No newline at end of file +

    Parameters

    Returns SecretClient

    \ No newline at end of file diff --git a/functions/_aws_amplify_backend_storage.defineStorage.html b/functions/_aws_amplify_backend_storage.defineStorage.html index 4dd09df4af..1a9439e5ea 100644 --- a/functions/_aws_amplify_backend_storage.defineStorage.html +++ b/functions/_aws_amplify_backend_storage.defineStorage.html @@ -1,3 +1,3 @@ defineStorage | Amplify Toolbox
    \ No newline at end of file +
    \ No newline at end of file diff --git a/functions/_aws_amplify_client_config.generateClientConfig.html b/functions/_aws_amplify_client_config.generateClientConfig.html index 0dfd7730bd..a7c3b5ae94 100644 --- a/functions/_aws_amplify_client_config.generateClientConfig.html +++ b/functions/_aws_amplify_client_config.generateClientConfig.html @@ -1,2 +1,2 @@ generateClientConfig | Amplify Toolbox
    \ No newline at end of file +

    Type Parameters

    • T extends "1" | "1.1" | "0"

    Parameters

    • backendIdentifier: DeployedBackendIdentifier
    • version: T
    • Optional awsClientProvider: AWSClientProvider<{
          getAmplifyClient: AmplifyClient;
          getCloudFormationClient: CloudFormationClient;
          getS3Client: S3Client;
      }>

    Returns Promise<ClientConfigVersionTemplateType<T>>

    \ No newline at end of file diff --git a/functions/_aws_amplify_client_config.generateClientConfigToFile.html b/functions/_aws_amplify_client_config.generateClientConfigToFile.html index 8dbc373543..994c308870 100644 --- a/functions/_aws_amplify_client_config.generateClientConfigToFile.html +++ b/functions/_aws_amplify_client_config.generateClientConfigToFile.html @@ -1,2 +1,2 @@ generateClientConfigToFile | Amplify Toolbox
    \ No newline at end of file +

    Parameters

    • backendIdentifier: DeployedBackendIdentifier
    • version: "1" | "1.1" | "0"
    • Optional outDir: string
    • Optional format: ClientConfigFormat
    • Optional awsClientProvider: AWSClientProvider<{
          getAmplifyClient: AmplifyClient;
          getCloudFormationClient: CloudFormationClient;
          getS3Client: S3Client;
      }>

    Returns Promise<GenerateClientConfigToFileResult>

    \ No newline at end of file diff --git a/functions/_aws_amplify_client_config.generateEmptyClientConfigToFile.html b/functions/_aws_amplify_client_config.generateEmptyClientConfigToFile.html index 5ee88f3054..15b454d813 100644 --- a/functions/_aws_amplify_client_config.generateEmptyClientConfigToFile.html +++ b/functions/_aws_amplify_client_config.generateEmptyClientConfigToFile.html @@ -1,2 +1,2 @@ generateEmptyClientConfigToFile | Amplify Toolbox
    \ No newline at end of file +

    Parameters

    Returns Promise<GenerateClientConfigToFileResult>

    \ No newline at end of file diff --git a/functions/_aws_amplify_client_config.getClientConfigFileName.html b/functions/_aws_amplify_client_config.getClientConfigFileName.html index 4cefd2b4e5..58b54e49d5 100644 --- a/functions/_aws_amplify_client_config.getClientConfigFileName.html +++ b/functions/_aws_amplify_client_config.getClientConfigFileName.html @@ -1,2 +1,2 @@ getClientConfigFileName | Amplify Toolbox
    \ No newline at end of file +

    Parameters

    • version: "1" | "1.1" | "0"

    Returns ClientConfigFileBaseName

    \ No newline at end of file diff --git a/functions/_aws_amplify_client_config.getClientConfigPath.html b/functions/_aws_amplify_client_config.getClientConfigPath.html index 88dba2d29c..4d3a855c02 100644 --- a/functions/_aws_amplify_client_config.getClientConfigPath.html +++ b/functions/_aws_amplify_client_config.getClientConfigPath.html @@ -3,4 +3,4 @@
  • Optional outDir: string

    path to directory where config is written. If not provided defaults to current process working directory.

  • Optional format: ClientConfigFormat

    The format which the configuration should be exported into. Defaults to JSON. returns path to config file

    -
  • Returns Promise<string>

    \ No newline at end of file +

    Returns Promise<string>

    \ No newline at end of file diff --git a/functions/_aws_amplify_form_generator.createLocalGraphqlFormGenerator.html b/functions/_aws_amplify_form_generator.createLocalGraphqlFormGenerator.html index 5a4d4674e4..0a80889c08 100644 --- a/functions/_aws_amplify_form_generator.createLocalGraphqlFormGenerator.html +++ b/functions/_aws_amplify_form_generator.createLocalGraphqlFormGenerator.html @@ -1,2 +1,2 @@ createLocalGraphqlFormGenerator | Amplify Toolbox
    \ No newline at end of file +

    Parameters

    Returns GraphqlFormGenerator

    \ No newline at end of file diff --git a/functions/_aws_amplify_model_generator.createGraphqlDocumentGenerator.html b/functions/_aws_amplify_model_generator.createGraphqlDocumentGenerator.html index f1b4efd0ed..f2ed1791b8 100644 --- a/functions/_aws_amplify_model_generator.createGraphqlDocumentGenerator.html +++ b/functions/_aws_amplify_model_generator.createGraphqlDocumentGenerator.html @@ -1,2 +1,2 @@ createGraphqlDocumentGenerator | Amplify Toolbox
    \ No newline at end of file +

    Parameters

    Returns GraphqlDocumentGenerator

    \ No newline at end of file diff --git a/functions/_aws_amplify_model_generator.createGraphqlModelsGenerator.html b/functions/_aws_amplify_model_generator.createGraphqlModelsGenerator.html index e7802f877a..6372ed1175 100644 --- a/functions/_aws_amplify_model_generator.createGraphqlModelsGenerator.html +++ b/functions/_aws_amplify_model_generator.createGraphqlModelsGenerator.html @@ -1,2 +1,2 @@ createGraphqlModelsGenerator | Amplify Toolbox
    \ No newline at end of file +

    Returns GraphqlModelsGenerator

    \ No newline at end of file diff --git a/functions/_aws_amplify_model_generator.generateApiCode.html b/functions/_aws_amplify_model_generator.generateApiCode.html index 31d832ac14..bdb3f57f5a 100644 --- a/functions/_aws_amplify_model_generator.generateApiCode.html +++ b/functions/_aws_amplify_model_generator.generateApiCode.html @@ -1,2 +1,2 @@ generateApiCode | Amplify Toolbox
    \ No newline at end of file +

    Parameters

    Returns Promise<GenerationResult>

    \ No newline at end of file diff --git a/interfaces/_aws_amplify_client_config.clientConfigTypesV1.AWSAmplifyBackendOutputs.html b/interfaces/_aws_amplify_client_config.clientConfigTypesV1.AWSAmplifyBackendOutputs.html index 7ed8ac33c3..41a6ff2756 100644 --- a/interfaces/_aws_amplify_client_config.clientConfigTypesV1.AWSAmplifyBackendOutputs.html +++ b/interfaces/_aws_amplify_client_config.clientConfigTypesV1.AWSAmplifyBackendOutputs.html @@ -1,5 +1,5 @@ AWSAmplifyBackendOutputs | Amplify Toolbox

    Config format for Amplify Gen 2 client libraries to communicate with backend services.

    -
    interface AWSAmplifyBackendOutputs {
        analytics?: {
            amazon_pinpoint?: {
                app_id: string;
                aws_region: string;
            };
        };
        auth?: {
            aws_region: string;
            identity_pool_id?: string;
            mfa_configuration?: "NONE" | "OPTIONAL" | "REQUIRED";
            mfa_methods?: ("SMS" | "TOTP")[];
            oauth?: {
                domain: string;
                identity_providers: ("GOOGLE" | "FACEBOOK" | "LOGIN_WITH_AMAZON" | "SIGN_IN_WITH_APPLE")[];
                redirect_sign_in_uri: string[];
                redirect_sign_out_uri: string[];
                response_type: "code" | "token";
                scopes: string[];
            };
            password_policy?: {
                min_length: number;
                require_lowercase: boolean;
                require_numbers: boolean;
                require_symbols: boolean;
                require_uppercase: boolean;
            };
            standard_required_attributes?: clientConfigTypesV1.AmazonCognitoStandardAttributes[];
            unauthenticated_identities_enabled?: boolean;
            user_pool_client_id: string;
            user_pool_id: string;
            user_verification_types?: ("email" | "phone_number")[];
            username_attributes?: ("email" | "phone_number" | "username")[];
        };
        custom?: {
            [k: string]: unknown;
        };
        data?: {
            api_key?: string;
            authorization_types: clientConfigTypesV1.AwsAppsyncAuthorizationType[];
            aws_region: string;
            default_authorization_type: clientConfigTypesV1.AwsAppsyncAuthorizationType;
            model_introspection?: {
                [k: string]: unknown;
            };
            url: string;
        };
        geo?: {
            aws_region: string;
            geofence_collections?: {
                default: string;
                items: string[];
            };
            maps?: {
                default: string;
                items: {
                    [k: string]: clientConfigTypesV1.AmazonLocationServiceConfig;
                };
            };
            search_indices?: {
                default: string;
                items: string[];
            };
        };
        notifications?: {
            amazon_pinpoint_app_id: string;
            aws_region: string;
            channels: clientConfigTypesV1.AmazonPinpointChannels[];
        };
        storage?: {
            aws_region: string;
            bucket_name: string;
        };
        version: "1";
    }

    Properties

    interface AWSAmplifyBackendOutputs {
        analytics?: {
            amazon_pinpoint?: {
                app_id: string;
                aws_region: string;
            };
        };
        auth?: {
            aws_region: string;
            identity_pool_id?: string;
            mfa_configuration?: "NONE" | "OPTIONAL" | "REQUIRED";
            mfa_methods?: ("SMS" | "TOTP")[];
            oauth?: {
                domain: string;
                identity_providers: ("GOOGLE" | "FACEBOOK" | "LOGIN_WITH_AMAZON" | "SIGN_IN_WITH_APPLE")[];
                redirect_sign_in_uri: string[];
                redirect_sign_out_uri: string[];
                response_type: "code" | "token";
                scopes: string[];
            };
            password_policy?: {
                min_length: number;
                require_lowercase: boolean;
                require_numbers: boolean;
                require_symbols: boolean;
                require_uppercase: boolean;
            };
            standard_required_attributes?: clientConfigTypesV1.AmazonCognitoStandardAttributes[];
            unauthenticated_identities_enabled?: boolean;
            user_pool_client_id: string;
            user_pool_id: string;
            user_verification_types?: ("email" | "phone_number")[];
            username_attributes?: ("email" | "phone_number" | "username")[];
        };
        custom?: {
            [k: string]: unknown;
        };
        data?: {
            api_key?: string;
            authorization_types: clientConfigTypesV1.AwsAppsyncAuthorizationType[];
            aws_region: string;
            default_authorization_type: clientConfigTypesV1.AwsAppsyncAuthorizationType;
            model_introspection?: {
                [k: string]: unknown;
            };
            url: string;
        };
        geo?: {
            aws_region: string;
            geofence_collections?: {
                default: string;
                items: string[];
            };
            maps?: {
                default: string;
                items: {
                    [k: string]: clientConfigTypesV1.AmazonLocationServiceConfig;
                };
            };
            search_indices?: {
                default: string;
                items: string[];
            };
        };
        notifications?: {
            amazon_pinpoint_app_id: string;
            aws_region: string;
            channels: clientConfigTypesV1.AmazonPinpointChannels[];
        };
        storage?: {
            aws_region: string;
            bucket_name: string;
        };
        version: "1";
    }

    Properties

    Properties

    analytics?: {
        amazon_pinpoint?: {
            app_id: string;
            aws_region: string;
        };
    }

    Outputs manually specified by developers for use with frontend library

    Type declaration

    • Optional amazon_pinpoint?: {
          app_id: string;
          aws_region: string;
      }
      • app_id: string
      • aws_region: string

        AWS Region of Amazon Pinpoint resources

        -
    auth?: {
        aws_region: string;
        identity_pool_id?: string;
        mfa_configuration?: "NONE" | "OPTIONAL" | "REQUIRED";
        mfa_methods?: ("SMS" | "TOTP")[];
        oauth?: {
            domain: string;
            identity_providers: ("GOOGLE" | "FACEBOOK" | "LOGIN_WITH_AMAZON" | "SIGN_IN_WITH_APPLE")[];
            redirect_sign_in_uri: string[];
            redirect_sign_out_uri: string[];
            response_type: "code" | "token";
            scopes: string[];
        };
        password_policy?: {
            min_length: number;
            require_lowercase: boolean;
            require_numbers: boolean;
            require_symbols: boolean;
            require_uppercase: boolean;
        };
        standard_required_attributes?: clientConfigTypesV1.AmazonCognitoStandardAttributes[];
        unauthenticated_identities_enabled?: boolean;
        user_pool_client_id: string;
        user_pool_id: string;
        user_verification_types?: ("email" | "phone_number")[];
        username_attributes?: ("email" | "phone_number" | "username")[];
    }

    Outputs generated from defineAuth

    +
    auth?: {
        aws_region: string;
        identity_pool_id?: string;
        mfa_configuration?: "NONE" | "OPTIONAL" | "REQUIRED";
        mfa_methods?: ("SMS" | "TOTP")[];
        oauth?: {
            domain: string;
            identity_providers: ("GOOGLE" | "FACEBOOK" | "LOGIN_WITH_AMAZON" | "SIGN_IN_WITH_APPLE")[];
            redirect_sign_in_uri: string[];
            redirect_sign_out_uri: string[];
            response_type: "code" | "token";
            scopes: string[];
        };
        password_policy?: {
            min_length: number;
            require_lowercase: boolean;
            require_numbers: boolean;
            require_symbols: boolean;
            require_uppercase: boolean;
        };
        standard_required_attributes?: clientConfigTypesV1.AmazonCognitoStandardAttributes[];
        unauthenticated_identities_enabled?: boolean;
        user_pool_client_id: string;
        user_pool_id: string;
        user_verification_types?: ("email" | "phone_number")[];
        username_attributes?: ("email" | "phone_number" | "username")[];
    }

    Outputs generated from defineAuth

    Type declaration

    • aws_region: string

      AWS Region of Amazon Cognito resources

    • Optional identity_pool_id?: string

      Cognito Identity Pool ID

    • Optional mfa_configuration?: "NONE" | "OPTIONAL" | "REQUIRED"
    • Optional mfa_methods?: ("SMS" | "TOTP")[]
    • Optional oauth?: {
          domain: string;
          identity_providers: ("GOOGLE" | "FACEBOOK" | "LOGIN_WITH_AMAZON" | "SIGN_IN_WITH_APPLE")[];
          redirect_sign_in_uri: string[];
          redirect_sign_out_uri: string[];
          response_type: "code" | "token";
          scopes: string[];
      }
      • domain: string

        Domain used for identity providers

        @@ -27,17 +27,17 @@
      • user_pool_id: string

        Cognito User Pool ID

      • Optional user_verification_types?: ("email" | "phone_number")[]
      • Optional username_attributes?: ("email" | "phone_number" | "username")[]

        Cognito User Pool username attributes

        Min Items

        1

        -
    custom?: {
        [k: string]: unknown;
    }

    Outputs generated from backend.addOutput({ custom: })

    -

    Type declaration

    • [k: string]: unknown
    data?: {
        api_key?: string;
        authorization_types: clientConfigTypesV1.AwsAppsyncAuthorizationType[];
        aws_region: string;
        default_authorization_type: clientConfigTypesV1.AwsAppsyncAuthorizationType;
        model_introspection?: {
            [k: string]: unknown;
        };
        url: string;
    }

    Outputs generated from defineData

    +
    custom?: {
        [k: string]: unknown;
    }

    Outputs generated from backend.addOutput({ custom: })

    +

    Type declaration

    • [k: string]: unknown
    data?: {
        api_key?: string;
        authorization_types: clientConfigTypesV1.AwsAppsyncAuthorizationType[];
        aws_region: string;
        default_authorization_type: clientConfigTypesV1.AwsAppsyncAuthorizationType;
        model_introspection?: {
            [k: string]: unknown;
        };
        url: string;
    }

    Outputs generated from defineData

    Type declaration

    geo?: {
        aws_region: string;
        geofence_collections?: {
            default: string;
            items: string[];
        };
        maps?: {
            default: string;
            items: {
                [k: string]: clientConfigTypesV1.AmazonLocationServiceConfig;
            };
        };
        search_indices?: {
            default: string;
            items: string[];
        };
    }

    Outputs manually specified by developers for use with frontend library

    +
    geo?: {
        aws_region: string;
        geofence_collections?: {
            default: string;
            items: string[];
        };
        maps?: {
            default: string;
            items: {
                [k: string]: clientConfigTypesV1.AmazonLocationServiceConfig;
            };
        };
        search_indices?: {
            default: string;
            items: string[];
        };
    }

    Outputs manually specified by developers for use with frontend library

    Type declaration

    • aws_region: string

      AWS Region of Amazon Location Service resources

    • Optional geofence_collections?: {
          default: string;
          items: string[];
      }

      Geofencing (visualize virtual perimeters)

      • default: string
      • items: string[]
    • Optional maps?: {
          default: string;
          items: {
              [k: string]: clientConfigTypesV1.AmazonLocationServiceConfig;
          };
      }

      Maps from Amazon Location Service

    • Optional search_indices?: {
          default: string;
          items: string[];
      }

      Location search (search by places, addresses, coordinates)

      -
      • default: string
      • items: string[]
    notifications?: {
        amazon_pinpoint_app_id: string;
        aws_region: string;
        channels: clientConfigTypesV1.AmazonPinpointChannels[];
    }

    Outputs manually specified by developers for use with frontend library

    +
    • default: string
    • items: string[]
    notifications?: {
        amazon_pinpoint_app_id: string;
        aws_region: string;
        channels: clientConfigTypesV1.AmazonPinpointChannels[];
    }

    Outputs manually specified by developers for use with frontend library

    Type declaration

    storage?: {
        aws_region: string;
        bucket_name: string;
    }

    Outputs generated from defineStorage

    -

    Type declaration

    • aws_region: string
    • bucket_name: string
    version: "1"

    Version of this schema

    -
    \ No newline at end of file +
    storage?: {
        aws_region: string;
        bucket_name: string;
    }

    Outputs generated from defineStorage

    +

    Type declaration

    • aws_region: string
    • bucket_name: string
    version: "1"

    Version of this schema

    +
    \ No newline at end of file diff --git a/interfaces/_aws_amplify_client_config.clientConfigTypesV1.AmazonLocationServiceConfig.html b/interfaces/_aws_amplify_client_config.clientConfigTypesV1.AmazonLocationServiceConfig.html index a4cce8fc32..a2dfb8e7f6 100644 --- a/interfaces/_aws_amplify_client_config.clientConfigTypesV1.AmazonLocationServiceConfig.html +++ b/interfaces/_aws_amplify_client_config.clientConfigTypesV1.AmazonLocationServiceConfig.html @@ -1,7 +1,7 @@ AmazonLocationServiceConfig | Amplify Toolbox

    This interface was referenced by undefined's JSON-Schema definition via the patternProperty ".*".

    -
    interface AmazonLocationServiceConfig {
        name?: string;
        style?: string;
    }

    Properties

    interface AmazonLocationServiceConfig {
        name?: string;
        style?: string;
    }

    Properties

    Properties

    name?: string

    Map resource name

    -
    style?: string

    Map style

    -
    \ No newline at end of file +
    style?: string

    Map style

    +
    \ No newline at end of file diff --git a/interfaces/_aws_amplify_client_config.clientConfigTypesV1_1.AWSAmplifyBackendOutputs.html b/interfaces/_aws_amplify_client_config.clientConfigTypesV1_1.AWSAmplifyBackendOutputs.html index 077795c5a4..66a7a8de2b 100644 --- a/interfaces/_aws_amplify_client_config.clientConfigTypesV1_1.AWSAmplifyBackendOutputs.html +++ b/interfaces/_aws_amplify_client_config.clientConfigTypesV1_1.AWSAmplifyBackendOutputs.html @@ -1,5 +1,5 @@ AWSAmplifyBackendOutputs | Amplify Toolbox

    Config format for Amplify Gen 2 client libraries to communicate with backend services.

    -
    interface AWSAmplifyBackendOutputs {
        analytics?: {
            amazon_pinpoint?: {
                app_id: string;
                aws_region: string;
            };
        };
        auth?: {
            aws_region: string;
            identity_pool_id?: string;
            mfa_configuration?: "NONE" | "OPTIONAL" | "REQUIRED";
            mfa_methods?: ("SMS" | "TOTP")[];
            oauth?: {
                domain: string;
                identity_providers: ("GOOGLE" | "FACEBOOK" | "LOGIN_WITH_AMAZON" | "SIGN_IN_WITH_APPLE")[];
                redirect_sign_in_uri: string[];
                redirect_sign_out_uri: string[];
                response_type: "code" | "token";
                scopes: string[];
            };
            password_policy?: {
                min_length: number;
                require_lowercase: boolean;
                require_numbers: boolean;
                require_symbols: boolean;
                require_uppercase: boolean;
            };
            standard_required_attributes?: clientConfigTypesV1_1.AmazonCognitoStandardAttributes[];
            unauthenticated_identities_enabled?: boolean;
            user_pool_client_id: string;
            user_pool_id: string;
            user_verification_types?: ("email" | "phone_number")[];
            username_attributes?: ("email" | "phone_number" | "username")[];
        };
        custom?: {
            [k: string]: unknown;
        };
        data?: {
            api_key?: string;
            authorization_types: clientConfigTypesV1_1.AwsAppsyncAuthorizationType[];
            aws_region: string;
            default_authorization_type: clientConfigTypesV1_1.AwsAppsyncAuthorizationType;
            model_introspection?: {
                [k: string]: unknown;
            };
            url: string;
        };
        geo?: {
            aws_region: string;
            geofence_collections?: {
                default: string;
                items: string[];
            };
            maps?: {
                default: string;
                items: {
                    [k: string]: clientConfigTypesV1_1.AmazonLocationServiceConfig;
                };
            };
            search_indices?: {
                default: string;
                items: string[];
            };
        };
        notifications?: {
            amazon_pinpoint_app_id: string;
            aws_region: string;
            channels: clientConfigTypesV1_1.AmazonPinpointChannels[];
        };
        storage?: {
            aws_region: string;
            bucket_name: string;
            buckets?: AmplifyStorageBucket[];
        };
        version: "1.1";
    }

    Properties

    interface AWSAmplifyBackendOutputs {
        analytics?: {
            amazon_pinpoint?: {
                app_id: string;
                aws_region: string;
            };
        };
        auth?: {
            aws_region: string;
            identity_pool_id?: string;
            mfa_configuration?: "NONE" | "OPTIONAL" | "REQUIRED";
            mfa_methods?: ("SMS" | "TOTP")[];
            oauth?: {
                domain: string;
                identity_providers: ("GOOGLE" | "FACEBOOK" | "LOGIN_WITH_AMAZON" | "SIGN_IN_WITH_APPLE")[];
                redirect_sign_in_uri: string[];
                redirect_sign_out_uri: string[];
                response_type: "code" | "token";
                scopes: string[];
            };
            password_policy?: {
                min_length: number;
                require_lowercase: boolean;
                require_numbers: boolean;
                require_symbols: boolean;
                require_uppercase: boolean;
            };
            standard_required_attributes?: clientConfigTypesV1_1.AmazonCognitoStandardAttributes[];
            unauthenticated_identities_enabled?: boolean;
            user_pool_client_id: string;
            user_pool_id: string;
            user_verification_types?: ("email" | "phone_number")[];
            username_attributes?: ("email" | "phone_number" | "username")[];
        };
        custom?: {
            [k: string]: unknown;
        };
        data?: {
            api_key?: string;
            authorization_types: clientConfigTypesV1_1.AwsAppsyncAuthorizationType[];
            aws_region: string;
            default_authorization_type: clientConfigTypesV1_1.AwsAppsyncAuthorizationType;
            model_introspection?: {
                [k: string]: unknown;
            };
            url: string;
        };
        geo?: {
            aws_region: string;
            geofence_collections?: {
                default: string;
                items: string[];
            };
            maps?: {
                default: string;
                items: {
                    [k: string]: clientConfigTypesV1_1.AmazonLocationServiceConfig;
                };
            };
            search_indices?: {
                default: string;
                items: string[];
            };
        };
        notifications?: {
            amazon_pinpoint_app_id: string;
            aws_region: string;
            channels: clientConfigTypesV1_1.AmazonPinpointChannels[];
        };
        storage?: {
            aws_region: string;
            bucket_name: string;
            buckets?: AmplifyStorageBucket[];
        };
        version: "1.1";
    }

    Properties

    Properties

    analytics?: {
        amazon_pinpoint?: {
            app_id: string;
            aws_region: string;
        };
    }

    Outputs manually specified by developers for use with frontend library

    Type declaration

    • Optional amazon_pinpoint?: {
          app_id: string;
          aws_region: string;
      }
      • app_id: string
      • aws_region: string

        AWS Region of Amazon Pinpoint resources

        -
    auth?: {
        aws_region: string;
        identity_pool_id?: string;
        mfa_configuration?: "NONE" | "OPTIONAL" | "REQUIRED";
        mfa_methods?: ("SMS" | "TOTP")[];
        oauth?: {
            domain: string;
            identity_providers: ("GOOGLE" | "FACEBOOK" | "LOGIN_WITH_AMAZON" | "SIGN_IN_WITH_APPLE")[];
            redirect_sign_in_uri: string[];
            redirect_sign_out_uri: string[];
            response_type: "code" | "token";
            scopes: string[];
        };
        password_policy?: {
            min_length: number;
            require_lowercase: boolean;
            require_numbers: boolean;
            require_symbols: boolean;
            require_uppercase: boolean;
        };
        standard_required_attributes?: clientConfigTypesV1_1.AmazonCognitoStandardAttributes[];
        unauthenticated_identities_enabled?: boolean;
        user_pool_client_id: string;
        user_pool_id: string;
        user_verification_types?: ("email" | "phone_number")[];
        username_attributes?: ("email" | "phone_number" | "username")[];
    }

    Outputs generated from defineAuth

    +
    auth?: {
        aws_region: string;
        identity_pool_id?: string;
        mfa_configuration?: "NONE" | "OPTIONAL" | "REQUIRED";
        mfa_methods?: ("SMS" | "TOTP")[];
        oauth?: {
            domain: string;
            identity_providers: ("GOOGLE" | "FACEBOOK" | "LOGIN_WITH_AMAZON" | "SIGN_IN_WITH_APPLE")[];
            redirect_sign_in_uri: string[];
            redirect_sign_out_uri: string[];
            response_type: "code" | "token";
            scopes: string[];
        };
        password_policy?: {
            min_length: number;
            require_lowercase: boolean;
            require_numbers: boolean;
            require_symbols: boolean;
            require_uppercase: boolean;
        };
        standard_required_attributes?: clientConfigTypesV1_1.AmazonCognitoStandardAttributes[];
        unauthenticated_identities_enabled?: boolean;
        user_pool_client_id: string;
        user_pool_id: string;
        user_verification_types?: ("email" | "phone_number")[];
        username_attributes?: ("email" | "phone_number" | "username")[];
    }

    Outputs generated from defineAuth

    Type declaration

    • aws_region: string

      AWS Region of Amazon Cognito resources

    • Optional identity_pool_id?: string

      Cognito Identity Pool ID

    • Optional mfa_configuration?: "NONE" | "OPTIONAL" | "REQUIRED"
    • Optional mfa_methods?: ("SMS" | "TOTP")[]
    • Optional oauth?: {
          domain: string;
          identity_providers: ("GOOGLE" | "FACEBOOK" | "LOGIN_WITH_AMAZON" | "SIGN_IN_WITH_APPLE")[];
          redirect_sign_in_uri: string[];
          redirect_sign_out_uri: string[];
          response_type: "code" | "token";
          scopes: string[];
      }
      • domain: string

        Domain used for identity providers

        @@ -27,17 +27,17 @@
      • user_pool_id: string

        Cognito User Pool ID

      • Optional user_verification_types?: ("email" | "phone_number")[]
      • Optional username_attributes?: ("email" | "phone_number" | "username")[]

        Cognito User Pool username attributes

        Min Items

        1

        -
    custom?: {
        [k: string]: unknown;
    }

    Outputs generated from backend.addOutput({ custom: })

    -

    Type declaration

    • [k: string]: unknown
    data?: {
        api_key?: string;
        authorization_types: clientConfigTypesV1_1.AwsAppsyncAuthorizationType[];
        aws_region: string;
        default_authorization_type: clientConfigTypesV1_1.AwsAppsyncAuthorizationType;
        model_introspection?: {
            [k: string]: unknown;
        };
        url: string;
    }

    Outputs generated from defineData

    +
    custom?: {
        [k: string]: unknown;
    }

    Outputs generated from backend.addOutput({ custom: })

    +

    Type declaration

    • [k: string]: unknown
    data?: {
        api_key?: string;
        authorization_types: clientConfigTypesV1_1.AwsAppsyncAuthorizationType[];
        aws_region: string;
        default_authorization_type: clientConfigTypesV1_1.AwsAppsyncAuthorizationType;
        model_introspection?: {
            [k: string]: unknown;
        };
        url: string;
    }

    Outputs generated from defineData

    Type declaration

    geo?: {
        aws_region: string;
        geofence_collections?: {
            default: string;
            items: string[];
        };
        maps?: {
            default: string;
            items: {
                [k: string]: clientConfigTypesV1_1.AmazonLocationServiceConfig;
            };
        };
        search_indices?: {
            default: string;
            items: string[];
        };
    }

    Outputs manually specified by developers for use with frontend library

    +
    geo?: {
        aws_region: string;
        geofence_collections?: {
            default: string;
            items: string[];
        };
        maps?: {
            default: string;
            items: {
                [k: string]: clientConfigTypesV1_1.AmazonLocationServiceConfig;
            };
        };
        search_indices?: {
            default: string;
            items: string[];
        };
    }

    Outputs manually specified by developers for use with frontend library

    Type declaration

    • aws_region: string

      AWS Region of Amazon Location Service resources

    • Optional geofence_collections?: {
          default: string;
          items: string[];
      }

      Geofencing (visualize virtual perimeters)

      • default: string
      • items: string[]
    • Optional maps?: {
          default: string;
          items: {
              [k: string]: clientConfigTypesV1_1.AmazonLocationServiceConfig;
          };
      }

      Maps from Amazon Location Service

    • Optional search_indices?: {
          default: string;
          items: string[];
      }

      Location search (search by places, addresses, coordinates)

      -
      • default: string
      • items: string[]
    notifications?: {
        amazon_pinpoint_app_id: string;
        aws_region: string;
        channels: clientConfigTypesV1_1.AmazonPinpointChannels[];
    }

    Outputs manually specified by developers for use with frontend library

    +
    • default: string
    • items: string[]
    notifications?: {
        amazon_pinpoint_app_id: string;
        aws_region: string;
        channels: clientConfigTypesV1_1.AmazonPinpointChannels[];
    }

    Outputs manually specified by developers for use with frontend library

    Type declaration

    storage?: {
        aws_region: string;
        bucket_name: string;
        buckets?: AmplifyStorageBucket[];
    }

    Outputs generated from defineStorage

    -

    Type declaration

    version: "1.1"

    Version of this schema

    -
    \ No newline at end of file +
    storage?: {
        aws_region: string;
        bucket_name: string;
        buckets?: AmplifyStorageBucket[];
    }

    Outputs generated from defineStorage

    +

    Type declaration

    version: "1.1"

    Version of this schema

    +
    \ No newline at end of file diff --git a/interfaces/_aws_amplify_client_config.clientConfigTypesV1_1.AmazonLocationServiceConfig.html b/interfaces/_aws_amplify_client_config.clientConfigTypesV1_1.AmazonLocationServiceConfig.html index 345b3c876d..ad19a4dd62 100644 --- a/interfaces/_aws_amplify_client_config.clientConfigTypesV1_1.AmazonLocationServiceConfig.html +++ b/interfaces/_aws_amplify_client_config.clientConfigTypesV1_1.AmazonLocationServiceConfig.html @@ -1,7 +1,7 @@ AmazonLocationServiceConfig | Amplify Toolbox

    This interface was referenced by undefined's JSON-Schema definition via the patternProperty ".*".

    -
    interface AmazonLocationServiceConfig {
        name?: string;
        style?: string;
    }

    Properties

    interface AmazonLocationServiceConfig {
        name?: string;
        style?: string;
    }

    Properties

    Properties

    name?: string

    Map resource name

    -
    style?: string

    Map style

    -
    \ No newline at end of file +
    style?: string

    Map style

    +
    \ No newline at end of file diff --git a/interfaces/_aws_amplify_client_config.clientConfigTypesV1_1.AmplifyStorageBucket.html b/interfaces/_aws_amplify_client_config.clientConfigTypesV1_1.AmplifyStorageBucket.html index cf70caac56..acffc499ea 100644 --- a/interfaces/_aws_amplify_client_config.clientConfigTypesV1_1.AmplifyStorageBucket.html +++ b/interfaces/_aws_amplify_client_config.clientConfigTypesV1_1.AmplifyStorageBucket.html @@ -1,4 +1,4 @@ -AmplifyStorageBucket | Amplify Toolbox
    interface AmplifyStorageBucket {
        aws_region: string;
        bucket_name: string;
        name: string;
    }

    Properties

    aws_region +AmplifyStorageBucket | Amplify Toolbox
    interface AmplifyStorageBucket {
        aws_region: string;
        bucket_name: string;
        name: string;
    }

    Properties

    aws_region: string
    bucket_name: string
    name: string
    \ No newline at end of file +

    Properties

    aws_region: string
    bucket_name: string
    name: string
    \ No newline at end of file diff --git a/modules/_aws_amplify_ai_constructs.conversation.html b/modules/_aws_amplify_ai_constructs.conversation.html index 06c6ea07cc..db107ee2c4 100644 --- a/modules/_aws_amplify_ai_constructs.conversation.html +++ b/modules/_aws_amplify_ai_constructs.conversation.html @@ -1,3 +1,3 @@ -conversation | Amplify Toolbox

    Index

    Classes

    ConversationHandlerFunction +conversation | Amplify Toolbox
    \ No newline at end of file diff --git a/modules/_aws_amplify_client_config.clientConfigTypesV1.html b/modules/_aws_amplify_client_config.clientConfigTypesV1.html index 805b15cd65..89d5b0bb51 100644 --- a/modules/_aws_amplify_client_config.clientConfigTypesV1.html +++ b/modules/_aws_amplify_client_config.clientConfigTypesV1.html @@ -1,4 +1,4 @@ -clientConfigTypesV1 | Amplify Toolbox

    Index

    Interfaces

    AWSAmplifyBackendOutputs +clientConfigTypesV1 | Amplify Toolbox

    Index

    Interfaces

    Type Aliases

    AmazonCognitoStandardAttributes AmazonPinpointChannels diff --git a/modules/_aws_amplify_client_config.clientConfigTypesV1_1.html b/modules/_aws_amplify_client_config.clientConfigTypesV1_1.html index 887e5d7cee..da4806ba72 100644 --- a/modules/_aws_amplify_client_config.clientConfigTypesV1_1.html +++ b/modules/_aws_amplify_client_config.clientConfigTypesV1_1.html @@ -1,4 +1,4 @@ -clientConfigTypesV1_1 | Amplify Toolbox

    Index

    Interfaces

    AWSAmplifyBackendOutputs +clientConfigTypesV1_1 | Amplify Toolbox

    Index

    Interfaces

    Type Aliases

    AmazonCognitoStandardAttributes diff --git a/types/_aws_amplify_ai_constructs.conversation.ConversationHandlerFunctionProps.html b/types/_aws_amplify_ai_constructs.conversation.ConversationHandlerFunctionProps.html index a4ca4bf075..3416f91cf9 100644 --- a/types/_aws_amplify_ai_constructs.conversation.ConversationHandlerFunctionProps.html +++ b/types/_aws_amplify_ai_constructs.conversation.ConversationHandlerFunctionProps.html @@ -1 +1 @@ -ConversationHandlerFunctionProps | Amplify Toolbox
    ConversationHandlerFunctionProps: {
        entry?: string;
        models: {
            modelId: string;
            region?: string;
        }[];
    }

    Type declaration

    • Optional entry?: string
    • models: {
          modelId: string;
          region?: string;
      }[]
    \ No newline at end of file +ConversationHandlerFunctionProps | Amplify Toolbox
    ConversationHandlerFunctionProps: {
        entry?: string;
        models: {
            modelId: string;
            region?: string;
        }[];
    }

    Type declaration

    • Optional entry?: string
    • models: {
          modelId: string;
          region?: string;
      }[]
    \ No newline at end of file diff --git a/types/_aws_amplify_auth_construct.AmazonProviderProps.html b/types/_aws_amplify_auth_construct.AmazonProviderProps.html index c2bfe4e362..d59a2aad84 100644 --- a/types/_aws_amplify_auth_construct.AmazonProviderProps.html +++ b/types/_aws_amplify_auth_construct.AmazonProviderProps.html @@ -1,2 +1,2 @@ AmazonProviderProps | Amplify Toolbox
    AmazonProviderProps: Omit<cognito.UserPoolIdentityProviderAmazonProps, "userPool" | "attributeMapping"> & IdentityProviderProps

    Amazon provider.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_auth_construct.AppleProviderProps.html b/types/_aws_amplify_auth_construct.AppleProviderProps.html index 4aeaaa2780..505481cf57 100644 --- a/types/_aws_amplify_auth_construct.AppleProviderProps.html +++ b/types/_aws_amplify_auth_construct.AppleProviderProps.html @@ -1,2 +1,2 @@ AppleProviderProps | Amplify Toolbox
    AppleProviderProps: Omit<cognito.UserPoolIdentityProviderAppleProps, "userPool" | "attributeMapping"> & IdentityProviderProps

    Apple provider.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_auth_construct.AttributeMapping.html b/types/_aws_amplify_auth_construct.AttributeMapping.html index 1da5373a07..6d81fa488e 100644 --- a/types/_aws_amplify_auth_construct.AttributeMapping.html +++ b/types/_aws_amplify_auth_construct.AttributeMapping.html @@ -3,4 +3,4 @@

    Type declaration

    • Optional custom?: {
          [key: string]: string;
      }

      Specify custom attribute mapping here and mapping for any standard attributes not supported yet.

      Default

      - no custom attribute mapping
       
      -
      • [key: string]: string
    \ No newline at end of file +
    • [key: string]: string
    \ No newline at end of file diff --git a/types/_aws_amplify_auth_construct.AuthProps.html b/types/_aws_amplify_auth_construct.AuthProps.html index a2ff5e33e3..bb7cb1f7b9 100644 --- a/types/_aws_amplify_auth_construct.AuthProps.html +++ b/types/_aws_amplify_auth_construct.AuthProps.html @@ -27,4 +27,4 @@
  • Optional userAttributes?: UserAttributes

    The set of attributes that are required for every user in the user pool. Read more on attributes here - https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html

    Default

    - email/phone will be added as required user attributes if they are included as login methods
     
    -
  • \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_auth_construct.CustomAttribute.html b/types/_aws_amplify_auth_construct.CustomAttribute.html index 93e73707f2..2ca2f6bff5 100644 --- a/types/_aws_amplify_auth_construct.CustomAttribute.html +++ b/types/_aws_amplify_auth_construct.CustomAttribute.html @@ -1,2 +1,2 @@ CustomAttribute | Amplify Toolbox

    CustomAttributes is a union type that represents all the different types of custom attributes.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_auth_construct.CustomAttributeBase.html b/types/_aws_amplify_auth_construct.CustomAttributeBase.html index 79b6f447a3..46fc15f0fc 100644 --- a/types/_aws_amplify_auth_construct.CustomAttributeBase.html +++ b/types/_aws_amplify_auth_construct.CustomAttributeBase.html @@ -1,4 +1,4 @@ CustomAttributeBase | Amplify Toolbox
    CustomAttributeBase: {
        mutable?: boolean;
    }

    CustomAttributeBase is a type that represents the base properties for a custom attribute

    Type declaration

    • Optional mutable?: boolean

      Default

      {true}
       
      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_auth_construct.CustomAttributeBoolean.html b/types/_aws_amplify_auth_construct.CustomAttributeBoolean.html index 70e938ff98..b442205a83 100644 --- a/types/_aws_amplify_auth_construct.CustomAttributeBoolean.html +++ b/types/_aws_amplify_auth_construct.CustomAttributeBoolean.html @@ -1,2 +1,2 @@ CustomAttributeBoolean | Amplify Toolbox
    CustomAttributeBoolean: CustomAttributeBase & {
        dataType: "Boolean";
    }

    CustomAttributeBoolean represents a custom attribute of type boolean.

    -

    Type declaration

    • dataType: "Boolean"
    \ No newline at end of file +

    Type declaration

    • dataType: "Boolean"
    \ No newline at end of file diff --git a/types/_aws_amplify_auth_construct.CustomAttributeDateTime.html b/types/_aws_amplify_auth_construct.CustomAttributeDateTime.html index ab1ac97b77..6443a883b4 100644 --- a/types/_aws_amplify_auth_construct.CustomAttributeDateTime.html +++ b/types/_aws_amplify_auth_construct.CustomAttributeDateTime.html @@ -1,2 +1,2 @@ CustomAttributeDateTime | Amplify Toolbox
    CustomAttributeDateTime: CustomAttributeBase & {
        dataType: "DateTime";
    }

    CustomAttributeDateTime represents a custom attribute of type dataTime.

    -

    Type declaration

    • dataType: "DateTime"
    \ No newline at end of file +

    Type declaration

    • dataType: "DateTime"
    \ No newline at end of file diff --git a/types/_aws_amplify_auth_construct.CustomAttributeNumber.html b/types/_aws_amplify_auth_construct.CustomAttributeNumber.html index a52a10d34d..936a1a7f1b 100644 --- a/types/_aws_amplify_auth_construct.CustomAttributeNumber.html +++ b/types/_aws_amplify_auth_construct.CustomAttributeNumber.html @@ -1,2 +1,2 @@ CustomAttributeNumber | Amplify Toolbox
    CustomAttributeNumber: CustomAttributeBase & NumberAttributeConstraints & {
        dataType: "Number";
    }

    CustomAttributeNumber represents a custom attribute of type number.

    -

    Type declaration

    • dataType: "Number"
    \ No newline at end of file +

    Type declaration

    • dataType: "Number"
    \ No newline at end of file diff --git a/types/_aws_amplify_auth_construct.CustomAttributeString.html b/types/_aws_amplify_auth_construct.CustomAttributeString.html index ec95566575..0fc2f12004 100644 --- a/types/_aws_amplify_auth_construct.CustomAttributeString.html +++ b/types/_aws_amplify_auth_construct.CustomAttributeString.html @@ -1,2 +1,2 @@ CustomAttributeString | Amplify Toolbox
    CustomAttributeString: CustomAttributeBase & StringAttributeConstraints & {
        dataType: "String";
    }

    CustomAttributeString represents a custom attribute of type string.

    -

    Type declaration

    • dataType: "String"
    \ No newline at end of file +

    Type declaration

    • dataType: "String"
    \ No newline at end of file diff --git a/types/_aws_amplify_auth_construct.EmailLogin.html b/types/_aws_amplify_auth_construct.EmailLogin.html index 4e287243a7..d6a0d3b6ea 100644 --- a/types/_aws_amplify_auth_construct.EmailLogin.html +++ b/types/_aws_amplify_auth_construct.EmailLogin.html @@ -1,4 +1,4 @@ EmailLogin | Amplify Toolbox
    EmailLogin: true | EmailLoginSettings

    Email login options.

    If true, email login will be enabled with default settings. If settings are provided, email login will be enabled with the specified settings.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_auth_construct.EmailLoginSettings.html b/types/_aws_amplify_auth_construct.EmailLoginSettings.html index e496ad284f..5bbc50528e 100644 --- a/types/_aws_amplify_auth_construct.EmailLoginSettings.html +++ b/types/_aws_amplify_auth_construct.EmailLoginSettings.html @@ -9,4 +9,4 @@
  • Optional smsMessage?: ((username, code) => string)

    The template to the SMS message that is sent to the user when an administrator signs them up to the user pool.

    Default

    (username, code) => 'Your username is {username()} and temporary password is {code()}.'
     
    -
      • (username, code): string
      • Parameters

        • username: (() => string)
            • (): string
            • Returns string

        • code: (() => string)
            • (): string
            • Returns string

        Returns string

  • \ No newline at end of file +
      • (username, code): string
      • Parameters

        • username: (() => string)
            • (): string
            • Returns string

        • code: (() => string)
            • (): string
            • Returns string

        Returns string

    \ No newline at end of file diff --git a/types/_aws_amplify_auth_construct.ExternalProviderOptions.html b/types/_aws_amplify_auth_construct.ExternalProviderOptions.html index be29c7bbc2..cff5f258b0 100644 --- a/types/_aws_amplify_auth_construct.ExternalProviderOptions.html +++ b/types/_aws_amplify_auth_construct.ExternalProviderOptions.html @@ -14,4 +14,4 @@

    Example

    ['PROFILE']

    For details about each scope, see below.

    'PHONE' - Grants access to the 'phone_number' and 'phone_number_verified' claims.
    Automatically includes access to `OAuthScope.OPENID`.

    'EMAIL' - Grants access to the 'email' and 'email_verified' claims.
    Automatically includes access to `OAuthScope.OPENID`.

    'OPENID' - Returns all user attributes in the ID token that are readable by the client

    'PROFILE' - Grants access to all user attributes that are readable by the client
    Automatically includes access to `OAuthScope.OPENID`.

    'COGNITO_ADMIN' - Grants access to Amazon Cognito User Pool API operations that require access tokens,
    such as UpdateUserAttributes and VerifyUserAttribute.
  • Optional signInWithApple?: AppleProviderProps

    SignInWithApple Settings

    -
  • \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_auth_construct.FacebookProviderProps.html b/types/_aws_amplify_auth_construct.FacebookProviderProps.html index a5bb478901..33a6cd50ea 100644 --- a/types/_aws_amplify_auth_construct.FacebookProviderProps.html +++ b/types/_aws_amplify_auth_construct.FacebookProviderProps.html @@ -1,2 +1,2 @@ FacebookProviderProps | Amplify Toolbox
    FacebookProviderProps: Omit<cognito.UserPoolIdentityProviderFacebookProps, "userPool" | "attributeMapping"> & IdentityProviderProps

    Facebook provider.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_auth_construct.GoogleProviderProps.html b/types/_aws_amplify_auth_construct.GoogleProviderProps.html index f3ab3ae671..a38ecd9a8b 100644 --- a/types/_aws_amplify_auth_construct.GoogleProviderProps.html +++ b/types/_aws_amplify_auth_construct.GoogleProviderProps.html @@ -3,4 +3,4 @@
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_auth_construct.IdentityProviderProps.html b/types/_aws_amplify_auth_construct.IdentityProviderProps.html index 58cf2b6913..512c21ebc9 100644 --- a/types/_aws_amplify_auth_construct.IdentityProviderProps.html +++ b/types/_aws_amplify_auth_construct.IdentityProviderProps.html @@ -2,4 +2,4 @@

    Type declaration

    • Optional attributeMapping?: AttributeMapping

      Mapping attributes from the identity provider to standard and custom attributes of the user pool.

      Default

      - no attribute mapping
       
      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_auth_construct.MFA.html b/types/_aws_amplify_auth_construct.MFA.html index 8b6df804f0..3873082460 100644 --- a/types/_aws_amplify_auth_construct.MFA.html +++ b/types/_aws_amplify_auth_construct.MFA.html @@ -2,4 +2,4 @@

    Type declaration

    • mode: "OFF"

      Configure whether users can or are required to use multifactor (MFA) to sign in.

      Default

      - 'OFF'
       
      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_auth_construct.MFASettings.html b/types/_aws_amplify_auth_construct.MFASettings.html index 9786f23a38..30be8d8322 100644 --- a/types/_aws_amplify_auth_construct.MFASettings.html +++ b/types/_aws_amplify_auth_construct.MFASettings.html @@ -1,2 +1,2 @@ MFASettings | Amplify Toolbox
    MFASettings: {
        sms: MFASmsSettings;
        totp?: MFATotpSettings;
    } | {
        sms?: MFASmsSettings;
        totp: MFATotpSettings;
    }

    Configure the MFA types that users can use. At least one of totp or sms is required.

    -

    Type declaration

    Type declaration

    \ No newline at end of file +

    Type declaration

    Type declaration

    \ No newline at end of file diff --git a/types/_aws_amplify_auth_construct.MFASmsSettings.html b/types/_aws_amplify_auth_construct.MFASmsSettings.html index af74bc396c..6366abd83f 100644 --- a/types/_aws_amplify_auth_construct.MFASmsSettings.html +++ b/types/_aws_amplify_auth_construct.MFASmsSettings.html @@ -5,4 +5,4 @@
      • (createCode): string
      • Parameters

        • createCode: (() => string)
            • (): string
            • Returns string

        Returns string

    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_auth_construct.MFATotpSettings.html b/types/_aws_amplify_auth_construct.MFATotpSettings.html index 59b3b488a6..14e8e372d7 100644 --- a/types/_aws_amplify_auth_construct.MFATotpSettings.html +++ b/types/_aws_amplify_auth_construct.MFATotpSettings.html @@ -2,4 +2,4 @@
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_auth_construct.OidcProviderProps.html b/types/_aws_amplify_auth_construct.OidcProviderProps.html index f4d4f604bc..ffcf0c63bd 100644 --- a/types/_aws_amplify_auth_construct.OidcProviderProps.html +++ b/types/_aws_amplify_auth_construct.OidcProviderProps.html @@ -2,4 +2,4 @@

    Type declaration

    • Optional Readonly attributeRequestMethod?: "GET" | "POST"

      The method to use to request attributes

      Default

      'GET'

      For details about each option, see below.

      'GET' - use GET
      'POST' - use POST
      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_auth_construct.PhoneNumberLogin.html b/types/_aws_amplify_auth_construct.PhoneNumberLogin.html index 4e92e501fa..23dff7df6c 100644 --- a/types/_aws_amplify_auth_construct.PhoneNumberLogin.html +++ b/types/_aws_amplify_auth_construct.PhoneNumberLogin.html @@ -5,4 +5,4 @@

    Default

    // If VerificationEmailStyle.LINK is chosen, verificationMessage will not be configured by default.

    // If VerificationEmailStyle.CODE is chosen, the default function will be as follows: (code) => The verification code to your new account is ${createCode()}

    -
      • (createCode): string
      • Parameters

        • createCode: (() => string)
            • (): string
            • Returns string

        Returns string

    \ No newline at end of file +
      • (createCode): string
      • Parameters

        • createCode: (() => string)
            • (): string
            • Returns string

        Returns string

    \ No newline at end of file diff --git a/types/_aws_amplify_auth_construct.SamlProviderProps.html b/types/_aws_amplify_auth_construct.SamlProviderProps.html index ab9cc840d9..2da5c079a0 100644 --- a/types/_aws_amplify_auth_construct.SamlProviderProps.html +++ b/types/_aws_amplify_auth_construct.SamlProviderProps.html @@ -1,3 +1,3 @@ SamlProviderProps | Amplify Toolbox
    SamlProviderProps: Omit<cognito.UserPoolIdentityProviderSamlProps, "userPool" | "metadata" | "attributeMapping"> & {
        metadata: Omit<UserPoolIdentityProviderSamlMetadata, "metadataType"> & {
            metadataType: "URL" | "FILE";
        };
    } & IdentityProviderProps

    SAML provider.

    Type declaration

    • metadata: Omit<UserPoolIdentityProviderSamlMetadata, "metadataType"> & {
          metadataType: "URL" | "FILE";
      }

      The SAML metadata.

      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_auth_construct.TriggerEvent.html b/types/_aws_amplify_auth_construct.TriggerEvent.html index a8a91f1e20..b8f3ee1fd6 100644 --- a/types/_aws_amplify_auth_construct.TriggerEvent.html +++ b/types/_aws_amplify_auth_construct.TriggerEvent.html @@ -1,2 +1,2 @@ TriggerEvent | Amplify Toolbox
    TriggerEvent: typeof triggerEvents[number]

    Union type of all supported auth trigger events

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_auth_construct.UserAttributes.html b/types/_aws_amplify_auth_construct.UserAttributes.html index 0030faad23..2315a509fa 100644 --- a/types/_aws_amplify_auth_construct.UserAttributes.html +++ b/types/_aws_amplify_auth_construct.UserAttributes.html @@ -1,3 +1,3 @@ UserAttributes | Amplify Toolbox
    UserAttributes: StandardAttributes & Record<`custom:${string}`, CustomAttribute>

    UserAttributes represents the combined attributes of a user, including standard attributes and any number of custom attributes defined with a 'custom:' prefix.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_auth_construct.VerificationEmailWithCode.html b/types/_aws_amplify_auth_construct.VerificationEmailWithCode.html index 06ab9aaf67..7bf75f3d03 100644 --- a/types/_aws_amplify_auth_construct.VerificationEmailWithCode.html +++ b/types/_aws_amplify_auth_construct.VerificationEmailWithCode.html @@ -4,4 +4,4 @@
  • Optional verificationEmailStyle?: "CODE"

    The type of verification. Must be one of "CODE" or "LINK".

  • Optional verificationEmailSubject?: string

    The verification email subject.

    -
  • \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_auth_construct.VerificationEmailWithLink.html b/types/_aws_amplify_auth_construct.VerificationEmailWithLink.html index 8f5a31f822..838c9697b6 100644 --- a/types/_aws_amplify_auth_construct.VerificationEmailWithLink.html +++ b/types/_aws_amplify_auth_construct.VerificationEmailWithLink.html @@ -7,4 +7,4 @@

    Example

    To
  • Optional verificationEmailStyle?: "LINK"

    The type of verification. Must be one of "CODE" or "LINK".

  • Optional verificationEmailSubject?: string

    The verification email subject.

    -
  • \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_backend.Backend.html b/types/_aws_amplify_backend.Backend.html index 82f51a2335..d04ac9f3c5 100644 --- a/types/_aws_amplify_backend.Backend.html +++ b/types/_aws_amplify_backend.Backend.html @@ -1,4 +1,4 @@ Backend | Amplify Toolbox
    Backend<T>: BackendBase & {
        [K in keyof T]: Omit<ReturnType<T[K]["getInstance"]>, keyof ResourceAccessAcceptorFactory>
    }

    Use defineBackend to create an instance of this type. This object has the Amplify BackendBase methods on it for interacting with the backend. It also has dynamic properties based on the resources passed into defineBackend

    -

    Type Parameters

    \ No newline at end of file +

    Type Parameters

    \ No newline at end of file diff --git a/types/_aws_amplify_backend.BackendBase.html b/types/_aws_amplify_backend.BackendBase.html index 0f674594b0..1310ec452e 100644 --- a/types/_aws_amplify_backend.BackendBase.html +++ b/types/_aws_amplify_backend.BackendBase.html @@ -1 +1 @@ -BackendBase | Amplify Toolbox
    BackendBase: {
        addOutput: ((clientConfigPart) => void);
        createStack: ((name) => Stack);
        stack: Stack;
    }

    Type declaration

    • addOutput: ((clientConfigPart) => void)
    • createStack: ((name) => Stack)
        • (name): Stack
        • Parameters

          • name: string

          Returns Stack

    • stack: Stack
    \ No newline at end of file +BackendBase | Amplify Toolbox
    BackendBase: {
        addOutput: ((clientConfigPart) => void);
        createStack: ((name) => Stack);
        stack: Stack;
    }

    Type declaration

    • addOutput: ((clientConfigPart) => void)
    • createStack: ((name) => Stack)
        • (name): Stack
        • Parameters

          • name: string

          Returns Stack

    • stack: Stack
    \ No newline at end of file diff --git a/types/_aws_amplify_backend.DefineBackendProps.html b/types/_aws_amplify_backend.DefineBackendProps.html index 8fb4e86bae..2bec77f652 100644 --- a/types/_aws_amplify_backend.DefineBackendProps.html +++ b/types/_aws_amplify_backend.DefineBackendProps.html @@ -1 +1 @@ -DefineBackendProps | Amplify Toolbox
    DefineBackendProps: Record<string, ConstructFactory<ResourceProvider & Partial<ResourceAccessAcceptorFactory<never>>>> & {
        [K in keyof BackendBase]?: never
    }
    \ No newline at end of file +DefineBackendProps | Amplify Toolbox
    DefineBackendProps: Record<string, ConstructFactory<ResourceProvider & Partial<ResourceAccessAcceptorFactory<never>>>> & {
        [K in keyof BackendBase]?: never
    }
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_auth.ActionIam.html b/types/_aws_amplify_backend_auth.ActionIam.html index b11df5b5cc..7b701cbc40 100644 --- a/types/_aws_amplify_backend_auth.ActionIam.html +++ b/types/_aws_amplify_backend_auth.ActionIam.html @@ -1,4 +1,4 @@ ActionIam | Amplify Toolbox
    ActionIam: "addUserToGroup" | "createGroup" | "createUser" | "deleteGroup" | "deleteUser" | "deleteUserAttributes" | "disableUser" | "enableUser" | "forgetDevice" | "getDevice" | "getGroup" | "getUser" | "listUsers" | "listUsersInGroup" | "listGroups" | "listDevices" | "listGroupsForUser" | "removeUserFromGroup" | "resetUserPassword" | "setUserMfaPreference" | "setUserPassword" | "setUserSettings" | "updateDeviceStatus" | "updateGroup" | "updateUserAttributes"

    This maps to Cognito IAM actions.

    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_auth.ActionMeta.html b/types/_aws_amplify_backend_auth.ActionMeta.html index 192aa842dc..079f5332c2 100644 --- a/types/_aws_amplify_backend_auth.ActionMeta.html +++ b/types/_aws_amplify_backend_auth.ActionMeta.html @@ -1,2 +1,2 @@ ActionMeta | Amplify Toolbox
    ActionMeta: "manageUsers" | "manageGroups" | "manageGroupMembership" | "manageUserDevices" | "managePasswordRecovery"
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_auth.AmazonProviderFactoryProps.html b/types/_aws_amplify_backend_auth.AmazonProviderFactoryProps.html index 0ed170a1bb..090ed808a7 100644 --- a/types/_aws_amplify_backend_auth.AmazonProviderFactoryProps.html +++ b/types/_aws_amplify_backend_auth.AmazonProviderFactoryProps.html @@ -3,4 +3,4 @@
  • clientSecret: BackendSecret

    The client secret to be accompanied with clientId for 'Login with Amazon' APIs to authenticate the client.

  • \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_auth.AmplifyAuthProps.html b/types/_aws_amplify_backend_auth.AmplifyAuthProps.html index 6614dd8aa1..37e3acab3e 100644 --- a/types/_aws_amplify_backend_auth.AmplifyAuthProps.html +++ b/types/_aws_amplify_backend_auth.AmplifyAuthProps.html @@ -1 +1 @@ -AmplifyAuthProps | Amplify Toolbox
    AmplifyAuthProps: Expand<Omit<AuthProps, "outputStorageStrategy" | "loginWith"> & {
        access?: AuthAccessGenerator;
        loginWith: Expand<AuthLoginWithFactoryProps>;
        triggers?: Partial<Record<TriggerEvent, ConstructFactory<ResourceProvider<FunctionResources>>>>;
    }>
    \ No newline at end of file +AmplifyAuthProps | Amplify Toolbox
    AmplifyAuthProps: Expand<Omit<AuthProps, "outputStorageStrategy" | "loginWith"> & {
        access?: AuthAccessGenerator;
        loginWith: Expand<AuthLoginWithFactoryProps>;
        triggers?: Partial<Record<TriggerEvent, ConstructFactory<ResourceProvider<FunctionResources>>>>;
    }>
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_auth.AppleProviderFactoryProps.html b/types/_aws_amplify_backend_auth.AppleProviderFactoryProps.html index 625b680ace..5e58bd66ce 100644 --- a/types/_aws_amplify_backend_auth.AppleProviderFactoryProps.html +++ b/types/_aws_amplify_backend_auth.AppleProviderFactoryProps.html @@ -4,4 +4,4 @@
  • keyId: BackendSecret

    The keyId (of the same key, which content has to be later supplied as privateKey) for Apple APIs to authenticate the client.

  • privateKey: BackendSecret

    The privateKey content for Apple APIs to authenticate the client.

  • teamId: BackendSecret

    The teamId for Apple APIs to authenticate the client.

    -
  • \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_auth.AuthAccessBuilder.html b/types/_aws_amplify_backend_auth.AuthAccessBuilder.html index eafb55b04f..aa8d827cbf 100644 --- a/types/_aws_amplify_backend_auth.AuthAccessBuilder.html +++ b/types/_aws_amplify_backend_auth.AuthAccessBuilder.html @@ -1 +1 @@ -AuthAccessBuilder | Amplify Toolbox
    AuthAccessBuilder: {
        resource: ((other) => AuthActionBuilder);
    }

    Type declaration

    \ No newline at end of file +AuthAccessBuilder | Amplify Toolbox
    AuthAccessBuilder: {
        resource: ((other) => AuthActionBuilder);
    }

    Type declaration

    \ No newline at end of file diff --git a/types/_aws_amplify_backend_auth.AuthAccessDefinition.html b/types/_aws_amplify_backend_auth.AuthAccessDefinition.html index 64b42fffe3..0baa5f9f44 100644 --- a/types/_aws_amplify_backend_auth.AuthAccessDefinition.html +++ b/types/_aws_amplify_backend_auth.AuthAccessDefinition.html @@ -1 +1 @@ -AuthAccessDefinition | Amplify Toolbox
    AuthAccessDefinition: {
        actions: AuthAction[];
        getResourceAccessAcceptor: ((getInstanceProps) => ResourceAccessAcceptor);
    }

    Type declaration

    \ No newline at end of file +AuthAccessDefinition | Amplify Toolbox
    AuthAccessDefinition: {
        actions: AuthAction[];
        getResourceAccessAcceptor: ((getInstanceProps) => ResourceAccessAcceptor);
    }

    Type declaration

    \ No newline at end of file diff --git a/types/_aws_amplify_backend_auth.AuthAccessGenerator.html b/types/_aws_amplify_backend_auth.AuthAccessGenerator.html index f9d9760d3b..39593a5313 100644 --- a/types/_aws_amplify_backend_auth.AuthAccessGenerator.html +++ b/types/_aws_amplify_backend_auth.AuthAccessGenerator.html @@ -1 +1 @@ -AuthAccessGenerator | Amplify Toolbox
    AuthAccessGenerator: ((allow) => AuthAccessDefinition[])

    Type declaration

    \ No newline at end of file +AuthAccessGenerator | Amplify Toolbox
    AuthAccessGenerator: ((allow) => AuthAccessDefinition[])

    Type declaration

    \ No newline at end of file diff --git a/types/_aws_amplify_backend_auth.AuthAction.html b/types/_aws_amplify_backend_auth.AuthAction.html index d259143d93..ede615da9d 100644 --- a/types/_aws_amplify_backend_auth.AuthAction.html +++ b/types/_aws_amplify_backend_auth.AuthAction.html @@ -1 +1 @@ -AuthAction | Amplify Toolbox
    \ No newline at end of file +AuthAction | Amplify Toolbox
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_auth.AuthActionBuilder.html b/types/_aws_amplify_backend_auth.AuthActionBuilder.html index 3dd214062c..c13d06df44 100644 --- a/types/_aws_amplify_backend_auth.AuthActionBuilder.html +++ b/types/_aws_amplify_backend_auth.AuthActionBuilder.html @@ -1 +1 @@ -AuthActionBuilder | Amplify Toolbox
    AuthActionBuilder: {
        to: ((actions) => AuthAccessDefinition);
    }

    Type declaration

    \ No newline at end of file +AuthActionBuilder | Amplify Toolbox
    AuthActionBuilder: {
        to: ((actions) => AuthAccessDefinition);
    }

    Type declaration

    \ No newline at end of file diff --git a/types/_aws_amplify_backend_auth.AuthLoginWithFactoryProps.html b/types/_aws_amplify_backend_auth.AuthLoginWithFactoryProps.html index 3ddb78a57b..acaa4d65ce 100644 --- a/types/_aws_amplify_backend_auth.AuthLoginWithFactoryProps.html +++ b/types/_aws_amplify_backend_auth.AuthLoginWithFactoryProps.html @@ -1,3 +1,3 @@ AuthLoginWithFactoryProps | Amplify Toolbox
    AuthLoginWithFactoryProps: Omit<AuthProps["loginWith"], "externalProviders"> & {
        externalProviders?: ExternalProviderSpecificFactoryProps;
    }

    Auth factory loginWith attribute.

    Type declaration

    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_auth.BackendAuth.html b/types/_aws_amplify_backend_auth.BackendAuth.html index ac7714649a..1bab8f4e50 100644 --- a/types/_aws_amplify_backend_auth.BackendAuth.html +++ b/types/_aws_amplify_backend_auth.BackendAuth.html @@ -1 +1 @@ -BackendAuth | Amplify Toolbox
    \ No newline at end of file +BackendAuth | Amplify Toolbox
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_auth.Expand.html b/types/_aws_amplify_backend_auth.Expand.html index 359909b568..69ea1af5c4 100644 --- a/types/_aws_amplify_backend_auth.Expand.html +++ b/types/_aws_amplify_backend_auth.Expand.html @@ -1,4 +1,4 @@ Expand | Amplify Toolbox
    Expand<T>: T extends infer O
        ? {
            [K in keyof O]: O[K]
        }
        : never

    This utility allows us to expand nested types in auto complete prompts.

    Type Parameters

    • T

    Example

    type OtherType = {
    property1: string;
    property2: number;
    }
    type SomeType = {
    property2: Expand<OtherType>;
    }
    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_auth.ExternalProviderGeneralFactoryProps.html b/types/_aws_amplify_backend_auth.ExternalProviderGeneralFactoryProps.html index f1e9c4683c..727f5bab4f 100644 --- a/types/_aws_amplify_backend_auth.ExternalProviderGeneralFactoryProps.html +++ b/types/_aws_amplify_backend_auth.ExternalProviderGeneralFactoryProps.html @@ -1,2 +1,2 @@ ExternalProviderGeneralFactoryProps | Amplify Toolbox
    ExternalProviderGeneralFactoryProps: Omit<ExternalProviderOptions, "signInWithApple" | "loginWithAmazon" | "facebook" | "oidc" | "google" | "domainPrefix">

    External provider general properties.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_auth.ExternalProviderSpecificFactoryProps.html b/types/_aws_amplify_backend_auth.ExternalProviderSpecificFactoryProps.html index 906ccd0a23..fb868619bc 100644 --- a/types/_aws_amplify_backend_auth.ExternalProviderSpecificFactoryProps.html +++ b/types/_aws_amplify_backend_auth.ExternalProviderSpecificFactoryProps.html @@ -4,4 +4,4 @@
  • Optional loginWithAmazon?: AmazonProviderFactoryProps

    LoginWithAmazon Settings

  • Optional oidc?: OidcProviderFactoryProps[]

    OIDC Settings

  • Optional signInWithApple?: AppleProviderFactoryProps

    SignInWithApple Settings

    -
  • \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_auth.FacebookProviderFactoryProps.html b/types/_aws_amplify_backend_auth.FacebookProviderFactoryProps.html index 6ba0d473ac..6a05cfa526 100644 --- a/types/_aws_amplify_backend_auth.FacebookProviderFactoryProps.html +++ b/types/_aws_amplify_backend_auth.FacebookProviderFactoryProps.html @@ -2,4 +2,4 @@

    Type declaration

    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_auth.GoogleProviderFactoryProps.html b/types/_aws_amplify_backend_auth.GoogleProviderFactoryProps.html index b6324f44aa..6de4244665 100644 --- a/types/_aws_amplify_backend_auth.GoogleProviderFactoryProps.html +++ b/types/_aws_amplify_backend_auth.GoogleProviderFactoryProps.html @@ -5,4 +5,4 @@
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_auth.OidcProviderFactoryProps.html b/types/_aws_amplify_backend_auth.OidcProviderFactoryProps.html index 585ea35f7d..1d0931e6f8 100644 --- a/types/_aws_amplify_backend_auth.OidcProviderFactoryProps.html +++ b/types/_aws_amplify_backend_auth.OidcProviderFactoryProps.html @@ -1,4 +1,4 @@ OidcProviderFactoryProps | Amplify Toolbox
    OidcProviderFactoryProps: Omit<OidcProviderProps, "clientId" | "clientSecret"> & {
        clientId: BackendSecret;
        clientSecret: BackendSecret;
    }

    Oidc provider properties.

    Type declaration

    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_data.ApiKeyAuthorizationModeProps.html b/types/_aws_amplify_backend_data.ApiKeyAuthorizationModeProps.html index 152e7a46b6..b1bdb13ad3 100644 --- a/types/_aws_amplify_backend_data.ApiKeyAuthorizationModeProps.html +++ b/types/_aws_amplify_backend_data.ApiKeyAuthorizationModeProps.html @@ -3,4 +3,4 @@
  • Optional expiresInDays?: number

    A duration representing the time from Cloudformation deploy until expiry.

    Default

    7
     
    -
  • \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_data.AuthorizationModes.html b/types/_aws_amplify_backend_data.AuthorizationModes.html index a866f89b35..6a8499c5d8 100644 --- a/types/_aws_amplify_backend_data.AuthorizationModes.html +++ b/types/_aws_amplify_backend_data.AuthorizationModes.html @@ -3,4 +3,4 @@
  • Optional defaultAuthorizationMode?: DefaultAuthorizationMode

    Default auth mode to use in the API, only required if more than one auth mode is specified.

  • Optional lambdaAuthorizationMode?: LambdaAuthorizationModeProps

    Lambda authorization config if function provider is specified in the api definition.

  • Optional oidcAuthorizationMode?: OIDCAuthorizationModeProps

    OIDC authorization config if oidc provider is specified in the api definition.

    -
  • \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_data.DataProps.html b/types/_aws_amplify_backend_data.DataProps.html index e28ff6dfaa..4987d0ec1c 100644 --- a/types/_aws_amplify_backend_data.DataProps.html +++ b/types/_aws_amplify_backend_data.DataProps.html @@ -3,4 +3,4 @@
  • Optional functions?: Record<string, ConstructFactory<AmplifyFunction>>

    Functions invokable by the API. The specific input type of the function is subject to change or removal.

  • Optional name?: string

    Optional name for the generated Api.

  • schema: DataSchemaInput

    Graphql Schema as a string to be passed into the CDK construct.

    -
  • \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_data.DataSchemaInput.html b/types/_aws_amplify_backend_data.DataSchemaInput.html index 8391cdb18a..9a1f1764d1 100644 --- a/types/_aws_amplify_backend_data.DataSchemaInput.html +++ b/types/_aws_amplify_backend_data.DataSchemaInput.html @@ -1,2 +1,2 @@ DataSchemaInput | Amplify Toolbox
    DataSchemaInput: string | DerivedModelSchema | DerivedCombinedSchema

    Schemas type definition, can be either a raw Graphql string, or a typed model schema, or a collection of combined Schemas.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_data.DefaultAuthorizationMode.html b/types/_aws_amplify_backend_data.DefaultAuthorizationMode.html index 867aa19c70..fcc8283182 100644 --- a/types/_aws_amplify_backend_data.DefaultAuthorizationMode.html +++ b/types/_aws_amplify_backend_data.DefaultAuthorizationMode.html @@ -1,2 +1,2 @@ DefaultAuthorizationMode | Amplify Toolbox
    DefaultAuthorizationMode: "iam" | "identityPool" | "userPool" | "oidc" | "apiKey" | "lambda"

    Authorization modes used in by client side Amplify represented in camelCase.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_data.LambdaAuthorizationModeProps.html b/types/_aws_amplify_backend_data.LambdaAuthorizationModeProps.html index 68df95cd21..6540261e2f 100644 --- a/types/_aws_amplify_backend_data.LambdaAuthorizationModeProps.html +++ b/types/_aws_amplify_backend_data.LambdaAuthorizationModeProps.html @@ -3,4 +3,4 @@
  • Optional timeToLiveInSeconds?: number

    How long the results are cached.

    Default

    60
     
    -
  • \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_data.OIDCAuthorizationModeProps.html b/types/_aws_amplify_backend_data.OIDCAuthorizationModeProps.html index 546b08f8e4..d41bf6b1be 100644 --- a/types/_aws_amplify_backend_data.OIDCAuthorizationModeProps.html +++ b/types/_aws_amplify_backend_data.OIDCAuthorizationModeProps.html @@ -7,4 +7,4 @@ This validation uses iat claim of OIDC token.

  • tokenExpiryFromAuthInSeconds: number

    The duration an OIDC token is valid after being authenticated by OIDC provider in seconds. auth_time claim in OIDC token is required for this validation to work.

    -
  • \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_deployer.BackendDeployer.html b/types/_aws_amplify_backend_deployer.BackendDeployer.html index 5bc046b155..81accd3e1d 100644 --- a/types/_aws_amplify_backend_deployer.BackendDeployer.html +++ b/types/_aws_amplify_backend_deployer.BackendDeployer.html @@ -1,2 +1,2 @@ BackendDeployer | Amplify Toolbox
    BackendDeployer: {
        deploy: ((backendId, deployProps?) => Promise<DeployResult>);
        destroy: ((backendId, destroyProps?) => Promise<DestroyResult>);
    }

    Invokes an invokable command

    -

    Type declaration

    \ No newline at end of file +

    Type declaration

    \ No newline at end of file diff --git a/types/_aws_amplify_backend_deployer.BackendDeployerOutputFormatter.html b/types/_aws_amplify_backend_deployer.BackendDeployerOutputFormatter.html index 1a1ce426ea..329d103917 100644 --- a/types/_aws_amplify_backend_deployer.BackendDeployerOutputFormatter.html +++ b/types/_aws_amplify_backend_deployer.BackendDeployerOutputFormatter.html @@ -1 +1 @@ -BackendDeployerOutputFormatter | Amplify Toolbox
    BackendDeployerOutputFormatter: {
        normalizeAmpxCommand: ((command) => string);
    }

    Type declaration

    • normalizeAmpxCommand: ((command) => string)
        • (command): string
        • Parameters

          • command: string

          Returns string

    \ No newline at end of file +BackendDeployerOutputFormatter | Amplify Toolbox
    BackendDeployerOutputFormatter: {
        normalizeAmpxCommand: ((command) => string);
    }

    Type declaration

    • normalizeAmpxCommand: ((command) => string)
        • (command): string
        • Parameters

          • command: string

          Returns string

    \ No newline at end of file diff --git a/types/_aws_amplify_backend_deployer.DeployProps.html b/types/_aws_amplify_backend_deployer.DeployProps.html index dfc418ffe4..67e6d85791 100644 --- a/types/_aws_amplify_backend_deployer.DeployProps.html +++ b/types/_aws_amplify_backend_deployer.DeployProps.html @@ -1 +1 @@ -DeployProps | Amplify Toolbox
    DeployProps: {
        profile?: string;
        secretLastUpdated?: Date;
        validateAppSources?: boolean;
    }

    Type declaration

    • Optional profile?: string
    • Optional secretLastUpdated?: Date
    • Optional validateAppSources?: boolean
    \ No newline at end of file +DeployProps | Amplify Toolbox
    DeployProps: {
        profile?: string;
        secretLastUpdated?: Date;
        validateAppSources?: boolean;
    }

    Type declaration

    • Optional profile?: string
    • Optional secretLastUpdated?: Date
    • Optional validateAppSources?: boolean
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_deployer.DeployResult.html b/types/_aws_amplify_backend_deployer.DeployResult.html index 076d582414..fde1108797 100644 --- a/types/_aws_amplify_backend_deployer.DeployResult.html +++ b/types/_aws_amplify_backend_deployer.DeployResult.html @@ -1 +1 @@ -DeployResult | Amplify Toolbox
    DeployResult: {
        deploymentTimes: DeploymentTimes;
    }

    Type declaration

    \ No newline at end of file +DeployResult | Amplify Toolbox
    DeployResult: {
        deploymentTimes: DeploymentTimes;
    }

    Type declaration

    \ No newline at end of file diff --git a/types/_aws_amplify_backend_deployer.DeploymentTimes.html b/types/_aws_amplify_backend_deployer.DeploymentTimes.html index c6c30f5b4a..3fe433523c 100644 --- a/types/_aws_amplify_backend_deployer.DeploymentTimes.html +++ b/types/_aws_amplify_backend_deployer.DeploymentTimes.html @@ -1 +1 @@ -DeploymentTimes | Amplify Toolbox
    DeploymentTimes: {
        synthesisTime?: number;
        totalTime?: number;
    }

    Type declaration

    • Optional synthesisTime?: number
    • Optional totalTime?: number
    \ No newline at end of file +DeploymentTimes | Amplify Toolbox
    DeploymentTimes: {
        synthesisTime?: number;
        totalTime?: number;
    }

    Type declaration

    • Optional synthesisTime?: number
    • Optional totalTime?: number
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_deployer.DestroyProps.html b/types/_aws_amplify_backend_deployer.DestroyProps.html index 43dd810875..2edbd515cd 100644 --- a/types/_aws_amplify_backend_deployer.DestroyProps.html +++ b/types/_aws_amplify_backend_deployer.DestroyProps.html @@ -1 +1 @@ -DestroyProps | Amplify Toolbox
    DestroyProps: {
        profile?: string;
    }

    Type declaration

    • Optional profile?: string
    \ No newline at end of file +DestroyProps | Amplify Toolbox
    DestroyProps: {
        profile?: string;
    }

    Type declaration

    • Optional profile?: string
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_deployer.DestroyResult.html b/types/_aws_amplify_backend_deployer.DestroyResult.html index d085313e0c..ffae291464 100644 --- a/types/_aws_amplify_backend_deployer.DestroyResult.html +++ b/types/_aws_amplify_backend_deployer.DestroyResult.html @@ -1 +1 @@ -DestroyResult | Amplify Toolbox
    DestroyResult: {
        deploymentTimes: DeploymentTimes;
    }

    Type declaration

    \ No newline at end of file +DestroyResult | Amplify Toolbox
    DestroyResult: {
        deploymentTimes: DeploymentTimes;
    }

    Type declaration

    \ No newline at end of file diff --git a/types/_aws_amplify_backend_function.AddEnvironmentFactory.html b/types/_aws_amplify_backend_function.AddEnvironmentFactory.html index 79b580bfc4..5da33e36f8 100644 --- a/types/_aws_amplify_backend_function.AddEnvironmentFactory.html +++ b/types/_aws_amplify_backend_function.AddEnvironmentFactory.html @@ -1 +1 @@ -AddEnvironmentFactory | Amplify Toolbox
    AddEnvironmentFactory: {
        addEnvironment: ((key, value) => void);
    }

    Type declaration

    • addEnvironment: ((key, value) => void)
        • (key, value): void
        • Parameters

          Returns void

    \ No newline at end of file +AddEnvironmentFactory | Amplify Toolbox
    AddEnvironmentFactory: {
        addEnvironment: ((key, value) => void);
    }

    Type declaration

    • addEnvironment: ((key, value) => void)
        • (key, value): void
        • Parameters

          Returns void

    \ No newline at end of file diff --git a/types/_aws_amplify_backend_function.CronSchedule.html b/types/_aws_amplify_backend_function.CronSchedule.html index 63fb4903ec..0814dd3950 100644 --- a/types/_aws_amplify_backend_function.CronSchedule.html +++ b/types/_aws_amplify_backend_function.CronSchedule.html @@ -1 +1 @@ -CronSchedule | Amplify Toolbox
    CronSchedule: `${string} ${string} ${string} ${string} ${string}` | `${string} ${string} ${string} ${string} ${string} ${string}`
    \ No newline at end of file +CronSchedule | Amplify Toolbox
    CronSchedule: `${string} ${string} ${string} ${string} ${string}` | `${string} ${string} ${string} ${string} ${string} ${string}`
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_function.FunctionProps.html b/types/_aws_amplify_backend_function.FunctionProps.html index 42db59fce8..4113e16c1a 100644 --- a/types/_aws_amplify_backend_function.FunctionProps.html +++ b/types/_aws_amplify_backend_function.FunctionProps.html @@ -25,4 +25,4 @@

    Example

    schedule
  • Optional timeoutSeconds?: number

    An amount of time in seconds between 1 second and 15 minutes. Must be a whole number. Default is 3 seconds.

    -
  • \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_function.FunctionSchedule.html b/types/_aws_amplify_backend_function.FunctionSchedule.html index 753b7e126c..0e97d529e2 100644 --- a/types/_aws_amplify_backend_function.FunctionSchedule.html +++ b/types/_aws_amplify_backend_function.FunctionSchedule.html @@ -1 +1 @@ -FunctionSchedule | Amplify Toolbox
    \ No newline at end of file +FunctionSchedule | Amplify Toolbox
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_function.NodeVersion.html b/types/_aws_amplify_backend_function.NodeVersion.html index 1b2462f610..7e59d3d638 100644 --- a/types/_aws_amplify_backend_function.NodeVersion.html +++ b/types/_aws_amplify_backend_function.NodeVersion.html @@ -1 +1 @@ -NodeVersion | Amplify Toolbox
    NodeVersion: 16 | 18 | 20
    \ No newline at end of file +NodeVersion | Amplify Toolbox
    NodeVersion: 16 | 18 | 20
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_function.TimeInterval.html b/types/_aws_amplify_backend_function.TimeInterval.html index 7e956cd10f..9a4529d3ac 100644 --- a/types/_aws_amplify_backend_function.TimeInterval.html +++ b/types/_aws_amplify_backend_function.TimeInterval.html @@ -1 +1 @@ -TimeInterval | Amplify Toolbox
    TimeInterval: `every ${number}m` | `every ${number}h` | "every day" | "every week" | "every month" | "every year"
    \ No newline at end of file +TimeInterval | Amplify Toolbox
    TimeInterval: `every ${number}m` | `every ${number}h` | "every day" | "every week" | "every month" | "every year"
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_output_schemas.AuthOutput.html b/types/_aws_amplify_backend_output_schemas.AuthOutput.html index a5bcefb73a..8be9519dec 100644 --- a/types/_aws_amplify_backend_output_schemas.AuthOutput.html +++ b/types/_aws_amplify_backend_output_schemas.AuthOutput.html @@ -1 +1 @@ -AuthOutput | Amplify Toolbox
    \ No newline at end of file +AuthOutput | Amplify Toolbox
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_output_schemas.AwsAppsyncAuthenticationType.html b/types/_aws_amplify_backend_output_schemas.AwsAppsyncAuthenticationType.html index e15f453275..4308864938 100644 --- a/types/_aws_amplify_backend_output_schemas.AwsAppsyncAuthenticationType.html +++ b/types/_aws_amplify_backend_output_schemas.AwsAppsyncAuthenticationType.html @@ -1 +1 @@ -AwsAppsyncAuthenticationType | Amplify Toolbox
    \ No newline at end of file +AwsAppsyncAuthenticationType | Amplify Toolbox
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_output_schemas.BackendOutputEntryStackMetadata.html b/types/_aws_amplify_backend_output_schemas.BackendOutputEntryStackMetadata.html index 395a85d054..9f9404aed5 100644 --- a/types/_aws_amplify_backend_output_schemas.BackendOutputEntryStackMetadata.html +++ b/types/_aws_amplify_backend_output_schemas.BackendOutputEntryStackMetadata.html @@ -1,2 +1,2 @@ BackendOutputEntryStackMetadata | Amplify Toolbox
    BackendOutputEntryStackMetadata: z.infer<typeof backendOutputEntryStackMetadataSchema>

    Inferred type from backendOutputEntryStackMetadataSchema

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_output_schemas.BackendOutputStackMetadata.html b/types/_aws_amplify_backend_output_schemas.BackendOutputStackMetadata.html index 62ab02bee1..50cae31a93 100644 --- a/types/_aws_amplify_backend_output_schemas.BackendOutputStackMetadata.html +++ b/types/_aws_amplify_backend_output_schemas.BackendOutputStackMetadata.html @@ -1,2 +1,2 @@ BackendOutputStackMetadata | Amplify Toolbox
    BackendOutputStackMetadata: z.infer<typeof backendOutputStackMetadataSchema>

    Inferred type from backendOutputStackMetadataSchema

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_output_schemas.CustomOutput.html b/types/_aws_amplify_backend_output_schemas.CustomOutput.html index 31988c3fb7..947b381dbd 100644 --- a/types/_aws_amplify_backend_output_schemas.CustomOutput.html +++ b/types/_aws_amplify_backend_output_schemas.CustomOutput.html @@ -1 +1 @@ -CustomOutput | Amplify Toolbox
    \ No newline at end of file +CustomOutput | Amplify Toolbox
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_output_schemas.FunctionOutput.html b/types/_aws_amplify_backend_output_schemas.FunctionOutput.html index 3da6f40d92..38b04a76cc 100644 --- a/types/_aws_amplify_backend_output_schemas.FunctionOutput.html +++ b/types/_aws_amplify_backend_output_schemas.FunctionOutput.html @@ -1 +1 @@ -FunctionOutput | Amplify Toolbox
    \ No newline at end of file +FunctionOutput | Amplify Toolbox
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_output_schemas.GraphqlOutput.html b/types/_aws_amplify_backend_output_schemas.GraphqlOutput.html index b81d3a434b..b94a1949d0 100644 --- a/types/_aws_amplify_backend_output_schemas.GraphqlOutput.html +++ b/types/_aws_amplify_backend_output_schemas.GraphqlOutput.html @@ -1 +1 @@ -GraphqlOutput | Amplify Toolbox
    \ No newline at end of file +GraphqlOutput | Amplify Toolbox
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_output_schemas.StorageOutput.html b/types/_aws_amplify_backend_output_schemas.StorageOutput.html index c3cfce07b4..7eccbb221d 100644 --- a/types/_aws_amplify_backend_output_schemas.StorageOutput.html +++ b/types/_aws_amplify_backend_output_schemas.StorageOutput.html @@ -1 +1 @@ -StorageOutput | Amplify Toolbox
    \ No newline at end of file +StorageOutput | Amplify Toolbox
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_output_schemas.UnifiedBackendOutput.html b/types/_aws_amplify_backend_output_schemas.UnifiedBackendOutput.html index a2c77ad7cf..6a667b88c9 100644 --- a/types/_aws_amplify_backend_output_schemas.UnifiedBackendOutput.html +++ b/types/_aws_amplify_backend_output_schemas.UnifiedBackendOutput.html @@ -1,3 +1,3 @@ UnifiedBackendOutput | Amplify Toolbox
    UnifiedBackendOutput: z.infer<typeof unifiedBackendOutputSchema>

    This type is a subset of the BackendOutput type that is exposed by the platform. It represents BackendOutput that has been validated against the schema of known output values

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_output_storage.AttributionMetadata.html b/types/_aws_amplify_backend_output_storage.AttributionMetadata.html index 2c335a9eee..7382c22765 100644 --- a/types/_aws_amplify_backend_output_storage.AttributionMetadata.html +++ b/types/_aws_amplify_backend_output_storage.AttributionMetadata.html @@ -3,4 +3,4 @@
  • createdWith: string

    The library version that created this metadata

  • metadata: Record<string, string>

    Field where constructs can put additional information for BI tracking

  • stackType: string

    String that identifies what type of stack this metadata is set on

    -
  • \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_output_storage.DeploymentEngineType.html b/types/_aws_amplify_backend_output_storage.DeploymentEngineType.html index 210bc631dd..1662ed95ec 100644 --- a/types/_aws_amplify_backend_output_storage.DeploymentEngineType.html +++ b/types/_aws_amplify_backend_output_storage.DeploymentEngineType.html @@ -1 +1 @@ -DeploymentEngineType | Amplify Toolbox
    DeploymentEngineType: "AmplifyPipelineDeploy" | "AmplifySandbox" | "AmplifyCDK"
    \ No newline at end of file +DeploymentEngineType | Amplify Toolbox
    DeploymentEngineType: "AmplifyPipelineDeploy" | "AmplifySandbox" | "AmplifyCDK"
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_output_storage.Platform.html b/types/_aws_amplify_backend_output_storage.Platform.html index 865f847961..b39902d51d 100644 --- a/types/_aws_amplify_backend_output_storage.Platform.html +++ b/types/_aws_amplify_backend_output_storage.Platform.html @@ -1 +1 @@ -Platform | Amplify Toolbox
    Platform: "Mac" | "Windows" | "Linux" | "Other"
    \ No newline at end of file +Platform | Amplify Toolbox
    Platform: "Mac" | "Windows" | "Linux" | "Other"
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_platform_test_stubs.StackResolver.html b/types/_aws_amplify_backend_platform_test_stubs.StackResolver.html index 297093b0e3..b8b44d99e3 100644 --- a/types/_aws_amplify_backend_platform_test_stubs.StackResolver.html +++ b/types/_aws_amplify_backend_platform_test_stubs.StackResolver.html @@ -1,2 +1,2 @@ StackResolver | Amplify Toolbox
    StackResolver: {
        getStackFor: ((resourceGroupName) => Stack);
    }

    Vends stacks for a resource grouping

    -

    Type declaration

    • getStackFor: ((resourceGroupName) => Stack)
        • (resourceGroupName): Stack
        • Parameters

          • resourceGroupName: string

          Returns Stack

    \ No newline at end of file +

    Type declaration

    • getStackFor: ((resourceGroupName) => Stack)
        • (resourceGroupName): Stack
        • Parameters

          • resourceGroupName: string

          Returns Stack

    \ No newline at end of file diff --git a/types/_aws_amplify_backend_secret.Secret.html b/types/_aws_amplify_backend_secret.Secret.html index a58d905b0b..1a8fb64f6d 100644 --- a/types/_aws_amplify_backend_secret.Secret.html +++ b/types/_aws_amplify_backend_secret.Secret.html @@ -1,2 +1,2 @@ Secret | Amplify Toolbox
    Secret: SecretIdentifier & {
        lastUpdated?: Date;
        value: string;
    }

    The secret object.

    -

    Type declaration

    • Optional lastUpdated?: Date
    • value: string
    \ No newline at end of file +

    Type declaration

    • Optional lastUpdated?: Date
    • value: string
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_secret.SecretClient.html b/types/_aws_amplify_backend_secret.SecretClient.html index 857c27b8a3..f49a71372c 100644 --- a/types/_aws_amplify_backend_secret.SecretClient.html +++ b/types/_aws_amplify_backend_secret.SecretClient.html @@ -3,4 +3,4 @@
  • listSecrets: ((backendIdentifier) => Promise<SecretListItem[]>)

    List secrets.

  • removeSecret: ((backendIdentifier, secretName) => Promise<void>)

    Remove a secret.

      • (backendIdentifier, secretName): Promise<void>
      • Parameters

        Returns Promise<void>

  • setSecret: ((backendIdentifier, secretName, secretValue) => Promise<SecretIdentifier>)

    Set a secret.

    -
  • \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_secret.SecretClientOptions.html b/types/_aws_amplify_backend_secret.SecretClientOptions.html index 7622677d1b..2cd4abb0d8 100644 --- a/types/_aws_amplify_backend_secret.SecretClientOptions.html +++ b/types/_aws_amplify_backend_secret.SecretClientOptions.html @@ -1,2 +1,2 @@ SecretClientOptions | Amplify Toolbox
    SecretClientOptions: {
        credentials?: AwsCredentialIdentityProvider;
        region?: string;
    }

    Secret client options.

    -

    Type declaration

    • Optional credentials?: AwsCredentialIdentityProvider
    • Optional region?: string
    \ No newline at end of file +

    Type declaration

    • Optional credentials?: AwsCredentialIdentityProvider
    • Optional region?: string
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_secret.SecretIdentifier.html b/types/_aws_amplify_backend_secret.SecretIdentifier.html index 3c192d7343..732b78513c 100644 --- a/types/_aws_amplify_backend_secret.SecretIdentifier.html +++ b/types/_aws_amplify_backend_secret.SecretIdentifier.html @@ -1,2 +1,2 @@ SecretIdentifier | Amplify Toolbox
    SecretIdentifier: {
        name: string;
        version?: number;
    }

    The unique identifier of the secret.

    -

    Type declaration

    • name: string
    • Optional version?: number
    \ No newline at end of file +

    Type declaration

    • name: string
    • Optional version?: number
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_secret.SecretListItem.html b/types/_aws_amplify_backend_secret.SecretListItem.html index b604e86824..730c29541f 100644 --- a/types/_aws_amplify_backend_secret.SecretListItem.html +++ b/types/_aws_amplify_backend_secret.SecretListItem.html @@ -1,2 +1,2 @@ SecretListItem | Amplify Toolbox
    SecretListItem: SecretIdentifier & {
        lastUpdated?: Date;
    }

    The returned object type of listSecrets API.

    -

    Type declaration

    • Optional lastUpdated?: Date
    \ No newline at end of file +

    Type declaration

    • Optional lastUpdated?: Date
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_storage.AmplifyStorageFactoryProps.html b/types/_aws_amplify_backend_storage.AmplifyStorageFactoryProps.html index 335d32ae33..5e67751a1a 100644 --- a/types/_aws_amplify_backend_storage.AmplifyStorageFactoryProps.html +++ b/types/_aws_amplify_backend_storage.AmplifyStorageFactoryProps.html @@ -2,4 +2,4 @@

    See

    https://docs.amplify.aws/gen2/build-a-backend/storage/#storage-access

    Example

    export const storage = defineStorage({
    access: (allow) => ({
    'foo/*': [allow.authenticated.to(['read'])],
    })
    })
    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_storage.AmplifyStorageProps.html b/types/_aws_amplify_backend_storage.AmplifyStorageProps.html index 52c6f8f317..5ddc705a4d 100644 --- a/types/_aws_amplify_backend_storage.AmplifyStorageProps.html +++ b/types/_aws_amplify_backend_storage.AmplifyStorageProps.html @@ -11,4 +11,4 @@

    Example

    import<
     
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_storage.AmplifyStorageTriggerEvent.html b/types/_aws_amplify_backend_storage.AmplifyStorageTriggerEvent.html index 5d431e88fd..93a21cc8ac 100644 --- a/types/_aws_amplify_backend_storage.AmplifyStorageTriggerEvent.html +++ b/types/_aws_amplify_backend_storage.AmplifyStorageTriggerEvent.html @@ -1 +1 @@ -AmplifyStorageTriggerEvent | Amplify Toolbox
    AmplifyStorageTriggerEvent: "onDelete" | "onUpload"
    \ No newline at end of file +AmplifyStorageTriggerEvent | Amplify Toolbox
    AmplifyStorageTriggerEvent: "onDelete" | "onUpload"
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_storage.EntityId.html b/types/_aws_amplify_backend_storage.EntityId.html index 53adcd3b7b..f127f5d9cb 100644 --- a/types/_aws_amplify_backend_storage.EntityId.html +++ b/types/_aws_amplify_backend_storage.EntityId.html @@ -1,4 +1,4 @@ EntityId | Amplify Toolbox
    EntityId: "identity"

    Types of entity IDs that can be substituted in access policies

    'identity' corresponds to the Cognito Identity Pool IdentityID

    Currently this is the only supported entity type.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_storage.StorageAccessBuilder.html b/types/_aws_amplify_backend_storage.StorageAccessBuilder.html index 9576bb8165..71722586ed 100644 --- a/types/_aws_amplify_backend_storage.StorageAccessBuilder.html +++ b/types/_aws_amplify_backend_storage.StorageAccessBuilder.html @@ -11,4 +11,4 @@
  • resource: ((other) => StorageActionBuilder)

    Grant other resources in the Amplify backend access to storage.

  • \ No newline at end of file +

    Returns StorageActionBuilder

    \ No newline at end of file diff --git a/types/_aws_amplify_backend_storage.StorageAccessDefinition.html b/types/_aws_amplify_backend_storage.StorageAccessDefinition.html index 2b1a36c7b9..da3074fb50 100644 --- a/types/_aws_amplify_backend_storage.StorageAccessDefinition.html +++ b/types/_aws_amplify_backend_storage.StorageAccessDefinition.html @@ -16,4 +16,4 @@ }

    The validationErrorMessage will be used to print an error message in case of validation failure

    An empty array means that no uniqueness will be enforced

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_storage.StorageAccessGenerator.html b/types/_aws_amplify_backend_storage.StorageAccessGenerator.html index c5433238fc..031af51d1b 100644 --- a/types/_aws_amplify_backend_storage.StorageAccessGenerator.html +++ b/types/_aws_amplify_backend_storage.StorageAccessGenerator.html @@ -1 +1 @@ -StorageAccessGenerator | Amplify Toolbox
    StorageAccessGenerator: ((allow) => StorageAccessRecord)

    Type declaration

    \ No newline at end of file +StorageAccessGenerator | Amplify Toolbox
    StorageAccessGenerator: ((allow) => StorageAccessRecord)

    Type declaration

    \ No newline at end of file diff --git a/types/_aws_amplify_backend_storage.StorageAccessRecord.html b/types/_aws_amplify_backend_storage.StorageAccessRecord.html index e7c7b1e7cb..5ecb7ec30b 100644 --- a/types/_aws_amplify_backend_storage.StorageAccessRecord.html +++ b/types/_aws_amplify_backend_storage.StorageAccessRecord.html @@ -1 +1 @@ -StorageAccessRecord | Amplify Toolbox
    StorageAccessRecord: Record<StoragePath, StorageAccessDefinition[]>
    \ No newline at end of file +StorageAccessRecord | Amplify Toolbox
    StorageAccessRecord: Record<StoragePath, StorageAccessDefinition[]>
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_storage.StorageAction.html b/types/_aws_amplify_backend_storage.StorageAction.html index 3399a47491..2e46bad41e 100644 --- a/types/_aws_amplify_backend_storage.StorageAction.html +++ b/types/_aws_amplify_backend_storage.StorageAction.html @@ -4,4 +4,4 @@

    'list' grants the ability to list object names matching the path prefix. It does NOT grant the ability to get the content of those objects.

    'write' grants the ability to upload objects with a certain prefix. Note that this allows both creating new objects and updating existing ones.

    'delete' grant the ability to delete objects with a certain prefix.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_storage.StorageActionBuilder.html b/types/_aws_amplify_backend_storage.StorageActionBuilder.html index 9ca2a2f821..c0adde8da5 100644 --- a/types/_aws_amplify_backend_storage.StorageActionBuilder.html +++ b/types/_aws_amplify_backend_storage.StorageActionBuilder.html @@ -2,4 +2,4 @@

    'read' is mutually exclusive with 'get' and 'list'

    \ No newline at end of file +

    Returns StorageAccessDefinition

    \ No newline at end of file diff --git a/types/_aws_amplify_backend_storage.StoragePath.html b/types/_aws_amplify_backend_storage.StoragePath.html index 6bd9022373..4940d76462 100644 --- a/types/_aws_amplify_backend_storage.StoragePath.html +++ b/types/_aws_amplify_backend_storage.StoragePath.html @@ -1,2 +1,2 @@ StoragePath | Amplify Toolbox
    StoragePath: `${string}/*`

    Storage access paths must end with /*

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_storage.StorageResources.html b/types/_aws_amplify_backend_storage.StorageResources.html index 4a7fbfbfc1..9ad02b94b0 100644 --- a/types/_aws_amplify_backend_storage.StorageResources.html +++ b/types/_aws_amplify_backend_storage.StorageResources.html @@ -1 +1 @@ -StorageResources | Amplify Toolbox
    StorageResources: {
        bucket: IBucket;
        cfnResources: {
            cfnBucket: CfnBucket;
        };
    }

    Type declaration

    • bucket: IBucket
    • cfnResources: {
          cfnBucket: CfnBucket;
      }
      • cfnBucket: CfnBucket
    \ No newline at end of file +StorageResources | Amplify Toolbox
    StorageResources: {
        bucket: IBucket;
        cfnResources: {
            cfnBucket: CfnBucket;
        };
    }

    Type declaration

    • bucket: IBucket
    • cfnResources: {
          cfnBucket: CfnBucket;
      }
      • cfnBucket: CfnBucket
    \ No newline at end of file diff --git a/types/_aws_amplify_cli_core.ColorName.html b/types/_aws_amplify_cli_core.ColorName.html index 42cb6d6ad3..9077ab0124 100644 --- a/types/_aws_amplify_cli_core.ColorName.html +++ b/types/_aws_amplify_cli_core.ColorName.html @@ -1 +1 @@ -ColorName | Amplify Toolbox
    ColorName: typeof colorNames[number]
    \ No newline at end of file +ColorName | Amplify Toolbox
    ColorName: typeof colorNames[number]
    \ No newline at end of file diff --git a/types/_aws_amplify_cli_core.RecordValue.html b/types/_aws_amplify_cli_core.RecordValue.html index c59aa037ec..edda62400b 100644 --- a/types/_aws_amplify_cli_core.RecordValue.html +++ b/types/_aws_amplify_cli_core.RecordValue.html @@ -1 +1 @@ -RecordValue | Amplify Toolbox
    RecordValue: string | number | string[] | Date
    \ No newline at end of file +RecordValue | Amplify Toolbox
    RecordValue: string | number | string[] | Date
    \ No newline at end of file diff --git a/types/_aws_amplify_client_config.AnalyticsClientConfig.html b/types/_aws_amplify_client_config.AnalyticsClientConfig.html index abf18eed39..d1be132994 100644 --- a/types/_aws_amplify_client_config.AnalyticsClientConfig.html +++ b/types/_aws_amplify_client_config.AnalyticsClientConfig.html @@ -1 +1 @@ -AnalyticsClientConfig | Amplify Toolbox
    AnalyticsClientConfig: {
        Analytics?: {
            Pinpoint: {
                appId: string;
                region: string;
            };
        };
        aws_mobile_analytics_app_id?: string;
        aws_mobile_analytics_app_region?: string;
    }

    Type declaration

    • Optional Analytics?: {
          Pinpoint: {
              appId: string;
              region: string;
          };
      }
      • Pinpoint: {
            appId: string;
            region: string;
        }
        • appId: string
        • region: string
    • Optional aws_mobile_analytics_app_id?: string
    • Optional aws_mobile_analytics_app_region?: string
    \ No newline at end of file +AnalyticsClientConfig | Amplify Toolbox
    AnalyticsClientConfig: {
        Analytics?: {
            Pinpoint: {
                appId: string;
                region: string;
            };
        };
        aws_mobile_analytics_app_id?: string;
        aws_mobile_analytics_app_region?: string;
    }

    Type declaration

    • Optional Analytics?: {
          Pinpoint: {
              appId: string;
              region: string;
          };
      }
      • Pinpoint: {
            appId: string;
            region: string;
        }
        • appId: string
        • region: string
    • Optional aws_mobile_analytics_app_id?: string
    • Optional aws_mobile_analytics_app_region?: string
    \ No newline at end of file diff --git a/types/_aws_amplify_client_config.AuthClientConfig.html b/types/_aws_amplify_client_config.AuthClientConfig.html index ee107361af..a1a683deca 100644 --- a/types/_aws_amplify_client_config.AuthClientConfig.html +++ b/types/_aws_amplify_client_config.AuthClientConfig.html @@ -1,3 +1,3 @@ AuthClientConfig | Amplify Toolbox
    AuthClientConfig: {
        allowUnauthenticatedIdentities?: string;
        aws_cognito_identity_pool_id?: string;
        aws_cognito_mfa_configuration?: string;
        aws_cognito_mfa_types?: string[];
        aws_cognito_password_protection_settings?: {
            passwordPolicyCharacters?: string[];
            passwordPolicyMinLength?: number;
        };
        aws_cognito_region: string;
        aws_cognito_signup_attributes?: string[];
        aws_cognito_social_providers?: string[];
        aws_cognito_username_attributes?: string[];
        aws_cognito_verification_mechanisms?: string[];
        aws_mandatory_sign_in?: string;
        aws_user_pools_id?: string;
        aws_user_pools_web_client_id?: string;
        oauth?: {
            clientId?: string;
            domain?: string;
            redirectSignIn?: string;
            redirectSignOut?: string;
            responseType?: string;
            scope?: string[];
        };
    }

    Type declaration

    • Optional allowUnauthenticatedIdentities?: string
    • Optional aws_cognito_identity_pool_id?: string
    • Optional aws_cognito_mfa_configuration?: string
    • Optional aws_cognito_mfa_types?: string[]
    • Optional aws_cognito_password_protection_settings?: {
          passwordPolicyCharacters?: string[];
          passwordPolicyMinLength?: number;
      }
      • Optional passwordPolicyCharacters?: string[]
      • Optional passwordPolicyMinLength?: number
    • aws_cognito_region: string
    • Optional aws_cognito_signup_attributes?: string[]
    • Optional aws_cognito_social_providers?: string[]
    • Optional aws_cognito_username_attributes?: string[]
    • Optional aws_cognito_verification_mechanisms?: string[]
    • Optional aws_mandatory_sign_in?: string
    • Optional aws_user_pools_id?: string
    • Optional aws_user_pools_web_client_id?: string
    • Optional oauth?: {
          clientId?: string;
          domain?: string;
          redirectSignIn?: string;
          redirectSignOut?: string;
          responseType?: string;
          scope?: string[];
      }
      • Optional clientId?: string
      • Optional domain?: string
      • Optional redirectSignIn?: string
      • Optional redirectSignOut?: string
      • Optional responseType?: string
      • Optional scope?: string[]
    \ No newline at end of file +

    Type declaration

    • Optional allowUnauthenticatedIdentities?: string
    • Optional aws_cognito_identity_pool_id?: string
    • Optional aws_cognito_mfa_configuration?: string
    • Optional aws_cognito_mfa_types?: string[]
    • Optional aws_cognito_password_protection_settings?: {
          passwordPolicyCharacters?: string[];
          passwordPolicyMinLength?: number;
      }
      • Optional passwordPolicyCharacters?: string[]
      • Optional passwordPolicyMinLength?: number
    • aws_cognito_region: string
    • Optional aws_cognito_signup_attributes?: string[]
    • Optional aws_cognito_social_providers?: string[]
    • Optional aws_cognito_username_attributes?: string[]
    • Optional aws_cognito_verification_mechanisms?: string[]
    • Optional aws_mandatory_sign_in?: string
    • Optional aws_user_pools_id?: string
    • Optional aws_user_pools_web_client_id?: string
    • Optional oauth?: {
          clientId?: string;
          domain?: string;
          redirectSignIn?: string;
          redirectSignOut?: string;
          responseType?: string;
          scope?: string[];
      }
      • Optional clientId?: string
      • Optional domain?: string
      • Optional redirectSignIn?: string
      • Optional redirectSignOut?: string
      • Optional responseType?: string
      • Optional scope?: string[]
    \ No newline at end of file diff --git a/types/_aws_amplify_client_config.ClientConfig.html b/types/_aws_amplify_client_config.ClientConfig.html index 04dc182fd5..9c82c29520 100644 --- a/types/_aws_amplify_client_config.ClientConfig.html +++ b/types/_aws_amplify_client_config.ClientConfig.html @@ -1,4 +1,4 @@ ClientConfig | Amplify Toolbox

    Versions of client config schema supported by "this" package version. Create union for supported versions here, such as ClientConfig = clientConfigTypesV1.AWSAmplifyBackendOutputs | clientConfigTypesV2.AWSAmplifyBackendOutputs;

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_client_config.ClientConfigLegacy.html b/types/_aws_amplify_client_config.ClientConfigLegacy.html index 1aa3a92cc6..cd6cf8dcd6 100644 --- a/types/_aws_amplify_client_config.ClientConfigLegacy.html +++ b/types/_aws_amplify_client_config.ClientConfigLegacy.html @@ -1,2 +1,2 @@ ClientConfigLegacy | Amplify Toolbox
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_client_config.ClientConfigVersion.html b/types/_aws_amplify_client_config.ClientConfigVersion.html index 0be50912b1..fadc829b49 100644 --- a/types/_aws_amplify_client_config.ClientConfigVersion.html +++ b/types/_aws_amplify_client_config.ClientConfigVersion.html @@ -1 +1 @@ -ClientConfigVersion | Amplify Toolbox
    \ No newline at end of file +ClientConfigVersion | Amplify Toolbox
    \ No newline at end of file diff --git a/types/_aws_amplify_client_config.ClientConfigVersionTemplateType.html b/types/_aws_amplify_client_config.ClientConfigVersionTemplateType.html index 64d5be1801..6b893b2eb8 100644 --- a/types/_aws_amplify_client_config.ClientConfigVersionTemplateType.html +++ b/types/_aws_amplify_client_config.ClientConfigVersionTemplateType.html @@ -6,4 +6,4 @@ : T extends '2' ? clientConfigTypesV2.AWSAmplifyBackendOutputs : never;

    -

    Type Parameters

    • T
    \ No newline at end of file +

    Type Parameters

    • T
    \ No newline at end of file diff --git a/types/_aws_amplify_client_config.CustomClientConfig.html b/types/_aws_amplify_client_config.CustomClientConfig.html index 44e80b3444..0b6d749355 100644 --- a/types/_aws_amplify_client_config.CustomClientConfig.html +++ b/types/_aws_amplify_client_config.CustomClientConfig.html @@ -1 +1 @@ -CustomClientConfig | Amplify Toolbox
    CustomClientConfig: {
        custom: Record<string, unknown>;
    }

    Type declaration

    • custom: Record<string, unknown>
    \ No newline at end of file +CustomClientConfig | Amplify Toolbox
    CustomClientConfig: {
        custom: Record<string, unknown>;
    }

    Type declaration

    • custom: Record<string, unknown>
    \ No newline at end of file diff --git a/types/_aws_amplify_client_config.GenerateClientConfigToFileResult.html b/types/_aws_amplify_client_config.GenerateClientConfigToFileResult.html index b1e2d832b8..e657c3d358 100644 --- a/types/_aws_amplify_client_config.GenerateClientConfigToFileResult.html +++ b/types/_aws_amplify_client_config.GenerateClientConfigToFileResult.html @@ -1 +1 @@ -GenerateClientConfigToFileResult | Amplify Toolbox
    GenerateClientConfigToFileResult: {
        filesWritten: string[];
    }

    Type declaration

    • filesWritten: string[]
    \ No newline at end of file +GenerateClientConfigToFileResult | Amplify Toolbox
    GenerateClientConfigToFileResult: {
        filesWritten: string[];
    }

    Type declaration

    • filesWritten: string[]
    \ No newline at end of file diff --git a/types/_aws_amplify_client_config.GeoClientConfig.html b/types/_aws_amplify_client_config.GeoClientConfig.html index 2e2a97a9df..0e03ed8597 100644 --- a/types/_aws_amplify_client_config.GeoClientConfig.html +++ b/types/_aws_amplify_client_config.GeoClientConfig.html @@ -1 +1 @@ -GeoClientConfig | Amplify Toolbox
    GeoClientConfig: {
        geo?: {
            amazon_location_service: {
                geofenceCollections?: {
                    default: string;
                    items: string[];
                };
                maps?: {
                    default: string;
                    items: Record<string, {
                        style: string;
                    }>;
                };
                region: string;
                search_indices?: {
                    default: string;
                    items: string[];
                };
            };
        };
    }

    Type declaration

    • Optional geo?: {
          amazon_location_service: {
              geofenceCollections?: {
                  default: string;
                  items: string[];
              };
              maps?: {
                  default: string;
                  items: Record<string, {
                      style: string;
                  }>;
              };
              region: string;
              search_indices?: {
                  default: string;
                  items: string[];
              };
          };
      }
      • amazon_location_service: {
            geofenceCollections?: {
                default: string;
                items: string[];
            };
            maps?: {
                default: string;
                items: Record<string, {
                    style: string;
                }>;
            };
            region: string;
            search_indices?: {
                default: string;
                items: string[];
            };
        }
        • Optional geofenceCollections?: {
              default: string;
              items: string[];
          }
          • default: string
          • items: string[]
        • Optional maps?: {
              default: string;
              items: Record<string, {
                  style: string;
              }>;
          }
          • default: string
          • items: Record<string, {
                style: string;
            }>
        • region: string
        • Optional search_indices?: {
              default: string;
              items: string[];
          }
          • default: string
          • items: string[]
    \ No newline at end of file +GeoClientConfig | Amplify Toolbox
    GeoClientConfig: {
        geo?: {
            amazon_location_service: {
                geofenceCollections?: {
                    default: string;
                    items: string[];
                };
                maps?: {
                    default: string;
                    items: Record<string, {
                        style: string;
                    }>;
                };
                region: string;
                search_indices?: {
                    default: string;
                    items: string[];
                };
            };
        };
    }

    Type declaration

    • Optional geo?: {
          amazon_location_service: {
              geofenceCollections?: {
                  default: string;
                  items: string[];
              };
              maps?: {
                  default: string;
                  items: Record<string, {
                      style: string;
                  }>;
              };
              region: string;
              search_indices?: {
                  default: string;
                  items: string[];
              };
          };
      }
      • amazon_location_service: {
            geofenceCollections?: {
                default: string;
                items: string[];
            };
            maps?: {
                default: string;
                items: Record<string, {
                    style: string;
                }>;
            };
            region: string;
            search_indices?: {
                default: string;
                items: string[];
            };
        }
        • Optional geofenceCollections?: {
              default: string;
              items: string[];
          }
          • default: string
          • items: string[]
        • Optional maps?: {
              default: string;
              items: Record<string, {
                  style: string;
              }>;
          }
          • default: string
          • items: Record<string, {
                style: string;
            }>
        • region: string
        • Optional search_indices?: {
              default: string;
              items: string[];
          }
          • default: string
          • items: string[]
    \ No newline at end of file diff --git a/types/_aws_amplify_client_config.GraphqlClientConfig.html b/types/_aws_amplify_client_config.GraphqlClientConfig.html index f937075cf8..4cf0848271 100644 --- a/types/_aws_amplify_client_config.GraphqlClientConfig.html +++ b/types/_aws_amplify_client_config.GraphqlClientConfig.html @@ -1,3 +1,3 @@ GraphqlClientConfig | Amplify Toolbox
    GraphqlClientConfig: {
        aws_appsync_additionalAuthenticationTypes?: string;
        aws_appsync_apiKey?: string;
        aws_appsync_authenticationType: string;
        aws_appsync_conflictResolutionMode?: string;
        aws_appsync_graphqlEndpoint: string;
        aws_appsync_region: string;
        modelIntrospection?: unknown;
    }

    Type declaration

    • Optional aws_appsync_additionalAuthenticationTypes?: string
    • Optional aws_appsync_apiKey?: string
    • aws_appsync_authenticationType: string
    • Optional aws_appsync_conflictResolutionMode?: string
    • aws_appsync_graphqlEndpoint: string
    • aws_appsync_region: string
    • Optional modelIntrospection?: unknown
    \ No newline at end of file +

    Type declaration

    • Optional aws_appsync_additionalAuthenticationTypes?: string
    • Optional aws_appsync_apiKey?: string
    • aws_appsync_authenticationType: string
    • Optional aws_appsync_conflictResolutionMode?: string
    • aws_appsync_graphqlEndpoint: string
    • aws_appsync_region: string
    • Optional modelIntrospection?: unknown
    \ No newline at end of file diff --git a/types/_aws_amplify_client_config.NotificationsClientConfig.html b/types/_aws_amplify_client_config.NotificationsClientConfig.html index b9dac3cbd0..1c07aa407c 100644 --- a/types/_aws_amplify_client_config.NotificationsClientConfig.html +++ b/types/_aws_amplify_client_config.NotificationsClientConfig.html @@ -1 +1 @@ -NotificationsClientConfig | Amplify Toolbox
    NotificationsClientConfig: {
        Notifications?: {
            EMAIL?: {
                AWSPinpoint: {
                    appId: string;
                    region: string;
                };
            };
            InAppMessaging?: {
                AWSPinpoint: {
                    appId: string;
                    region: string;
                };
            };
            Push?: {
                AWSPinpoint: {
                    appId: string;
                    region: string;
                };
            };
            SMS?: {
                AWSPinpoint: {
                    appId: string;
                    region: string;
                };
            };
        };
    }

    Type declaration

    • Optional Notifications?: {
          EMAIL?: {
              AWSPinpoint: {
                  appId: string;
                  region: string;
              };
          };
          InAppMessaging?: {
              AWSPinpoint: {
                  appId: string;
                  region: string;
              };
          };
          Push?: {
              AWSPinpoint: {
                  appId: string;
                  region: string;
              };
          };
          SMS?: {
              AWSPinpoint: {
                  appId: string;
                  region: string;
              };
          };
      }
      • Optional EMAIL?: {
            AWSPinpoint: {
                appId: string;
                region: string;
            };
        }
        • AWSPinpoint: {
              appId: string;
              region: string;
          }
          • appId: string
          • region: string
      • Optional InAppMessaging?: {
            AWSPinpoint: {
                appId: string;
                region: string;
            };
        }
        • AWSPinpoint: {
              appId: string;
              region: string;
          }
          • appId: string
          • region: string
      • Optional Push?: {
            AWSPinpoint: {
                appId: string;
                region: string;
            };
        }
        • AWSPinpoint: {
              appId: string;
              region: string;
          }
          • appId: string
          • region: string
      • Optional SMS?: {
            AWSPinpoint: {
                appId: string;
                region: string;
            };
        }
        • AWSPinpoint: {
              appId: string;
              region: string;
          }
          • appId: string
          • region: string
    \ No newline at end of file +NotificationsClientConfig | Amplify Toolbox
    NotificationsClientConfig: {
        Notifications?: {
            EMAIL?: {
                AWSPinpoint: {
                    appId: string;
                    region: string;
                };
            };
            InAppMessaging?: {
                AWSPinpoint: {
                    appId: string;
                    region: string;
                };
            };
            Push?: {
                AWSPinpoint: {
                    appId: string;
                    region: string;
                };
            };
            SMS?: {
                AWSPinpoint: {
                    appId: string;
                    region: string;
                };
            };
        };
    }

    Type declaration

    • Optional Notifications?: {
          EMAIL?: {
              AWSPinpoint: {
                  appId: string;
                  region: string;
              };
          };
          InAppMessaging?: {
              AWSPinpoint: {
                  appId: string;
                  region: string;
              };
          };
          Push?: {
              AWSPinpoint: {
                  appId: string;
                  region: string;
              };
          };
          SMS?: {
              AWSPinpoint: {
                  appId: string;
                  region: string;
              };
          };
      }
      • Optional EMAIL?: {
            AWSPinpoint: {
                appId: string;
                region: string;
            };
        }
        • AWSPinpoint: {
              appId: string;
              region: string;
          }
          • appId: string
          • region: string
      • Optional InAppMessaging?: {
            AWSPinpoint: {
                appId: string;
                region: string;
            };
        }
        • AWSPinpoint: {
              appId: string;
              region: string;
          }
          • appId: string
          • region: string
      • Optional Push?: {
            AWSPinpoint: {
                appId: string;
                region: string;
            };
        }
        • AWSPinpoint: {
              appId: string;
              region: string;
          }
          • appId: string
          • region: string
      • Optional SMS?: {
            AWSPinpoint: {
                appId: string;
                region: string;
            };
        }
        • AWSPinpoint: {
              appId: string;
              region: string;
          }
          • appId: string
          • region: string
    \ No newline at end of file diff --git a/types/_aws_amplify_client_config.PlatformClientConfig.html b/types/_aws_amplify_client_config.PlatformClientConfig.html index 68862e11a6..576e2e9200 100644 --- a/types/_aws_amplify_client_config.PlatformClientConfig.html +++ b/types/_aws_amplify_client_config.PlatformClientConfig.html @@ -1 +1 @@ -PlatformClientConfig | Amplify Toolbox
    PlatformClientConfig: {
        aws_project_region: string;
    }

    Type declaration

    • aws_project_region: string
    \ No newline at end of file +PlatformClientConfig | Amplify Toolbox
    PlatformClientConfig: {
        aws_project_region: string;
    }

    Type declaration

    • aws_project_region: string
    \ No newline at end of file diff --git a/types/_aws_amplify_client_config.StorageClientConfig.html b/types/_aws_amplify_client_config.StorageClientConfig.html index 1a0aceb5dc..edf7d94b7d 100644 --- a/types/_aws_amplify_client_config.StorageClientConfig.html +++ b/types/_aws_amplify_client_config.StorageClientConfig.html @@ -1,3 +1,3 @@ StorageClientConfig | Amplify Toolbox
    StorageClientConfig: {
        aws_user_files_s3_bucket: string;
        aws_user_files_s3_bucket_region: string;
    }

    Type declaration

    • aws_user_files_s3_bucket: string
    • aws_user_files_s3_bucket_region: string
    \ No newline at end of file +

    Type declaration

    • aws_user_files_s3_bucket: string
    • aws_user_files_s3_bucket_region: string
    \ No newline at end of file diff --git a/types/_aws_amplify_client_config.clientConfigTypesV1.AmazonCognitoStandardAttributes.html b/types/_aws_amplify_client_config.clientConfigTypesV1.AmazonCognitoStandardAttributes.html index b20e467517..13d6dcd53f 100644 --- a/types/_aws_amplify_client_config.clientConfigTypesV1.AmazonCognitoStandardAttributes.html +++ b/types/_aws_amplify_client_config.clientConfigTypesV1.AmazonCognitoStandardAttributes.html @@ -1,2 +1,2 @@ AmazonCognitoStandardAttributes | Amplify Toolbox
    AmazonCognitoStandardAttributes: "address" | "birthdate" | "email" | "family_name" | "gender" | "given_name" | "locale" | "middle_name" | "name" | "nickname" | "phone_number" | "picture" | "preferred_username" | "profile" | "sub" | "updated_at" | "website" | "zoneinfo"
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_client_config.clientConfigTypesV1.AmazonPinpointChannels.html b/types/_aws_amplify_client_config.clientConfigTypesV1.AmazonPinpointChannels.html index 97a0de19e2..d075c18105 100644 --- a/types/_aws_amplify_client_config.clientConfigTypesV1.AmazonPinpointChannels.html +++ b/types/_aws_amplify_client_config.clientConfigTypesV1.AmazonPinpointChannels.html @@ -1,2 +1,2 @@ AmazonPinpointChannels | Amplify Toolbox
    AmazonPinpointChannels: "IN_APP_MESSAGING" | "FCM" | "APNS" | "EMAIL" | "SMS"

    supported channels for Amazon Pinpoint

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_client_config.clientConfigTypesV1.AwsAppsyncAuthorizationType.html b/types/_aws_amplify_client_config.clientConfigTypesV1.AwsAppsyncAuthorizationType.html index 2a79e57c27..a18700bf61 100644 --- a/types/_aws_amplify_client_config.clientConfigTypesV1.AwsAppsyncAuthorizationType.html +++ b/types/_aws_amplify_client_config.clientConfigTypesV1.AwsAppsyncAuthorizationType.html @@ -1,2 +1,2 @@ AwsAppsyncAuthorizationType | Amplify Toolbox
    AwsAppsyncAuthorizationType: "AMAZON_COGNITO_USER_POOLS" | "API_KEY" | "AWS_IAM" | "AWS_LAMBDA" | "OPENID_CONNECT"

    List of supported auth types for AWS AppSync

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_client_config.clientConfigTypesV1.AwsRegion.html b/types/_aws_amplify_client_config.clientConfigTypesV1.AwsRegion.html index 4b53332f0e..8df38a5d56 100644 --- a/types/_aws_amplify_client_config.clientConfigTypesV1.AwsRegion.html +++ b/types/_aws_amplify_client_config.clientConfigTypesV1.AwsRegion.html @@ -1 +1 @@ -AwsRegion | Amplify Toolbox
    \ No newline at end of file +AwsRegion | Amplify Toolbox
    \ No newline at end of file diff --git a/types/_aws_amplify_client_config.clientConfigTypesV1_1.AmazonCognitoStandardAttributes.html b/types/_aws_amplify_client_config.clientConfigTypesV1_1.AmazonCognitoStandardAttributes.html index 502fbfce7b..96ba850caa 100644 --- a/types/_aws_amplify_client_config.clientConfigTypesV1_1.AmazonCognitoStandardAttributes.html +++ b/types/_aws_amplify_client_config.clientConfigTypesV1_1.AmazonCognitoStandardAttributes.html @@ -1,2 +1,2 @@ AmazonCognitoStandardAttributes | Amplify Toolbox
    AmazonCognitoStandardAttributes: "address" | "birthdate" | "email" | "family_name" | "gender" | "given_name" | "locale" | "middle_name" | "name" | "nickname" | "phone_number" | "picture" | "preferred_username" | "profile" | "sub" | "updated_at" | "website" | "zoneinfo"
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_client_config.clientConfigTypesV1_1.AmazonPinpointChannels.html b/types/_aws_amplify_client_config.clientConfigTypesV1_1.AmazonPinpointChannels.html index 92b68b8b5f..eaef13857f 100644 --- a/types/_aws_amplify_client_config.clientConfigTypesV1_1.AmazonPinpointChannels.html +++ b/types/_aws_amplify_client_config.clientConfigTypesV1_1.AmazonPinpointChannels.html @@ -1,2 +1,2 @@ AmazonPinpointChannels | Amplify Toolbox
    AmazonPinpointChannels: "IN_APP_MESSAGING" | "FCM" | "APNS" | "EMAIL" | "SMS"

    supported channels for Amazon Pinpoint

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_client_config.clientConfigTypesV1_1.AwsAppsyncAuthorizationType.html b/types/_aws_amplify_client_config.clientConfigTypesV1_1.AwsAppsyncAuthorizationType.html index 95d0395726..1554784719 100644 --- a/types/_aws_amplify_client_config.clientConfigTypesV1_1.AwsAppsyncAuthorizationType.html +++ b/types/_aws_amplify_client_config.clientConfigTypesV1_1.AwsAppsyncAuthorizationType.html @@ -1,2 +1,2 @@ AwsAppsyncAuthorizationType | Amplify Toolbox
    AwsAppsyncAuthorizationType: "AMAZON_COGNITO_USER_POOLS" | "API_KEY" | "AWS_IAM" | "AWS_LAMBDA" | "OPENID_CONNECT"

    List of supported auth types for AWS AppSync

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_client_config.clientConfigTypesV1_1.AwsRegion.html b/types/_aws_amplify_client_config.clientConfigTypesV1_1.AwsRegion.html index 34f883be4c..2811632ff2 100644 --- a/types/_aws_amplify_client_config.clientConfigTypesV1_1.AwsRegion.html +++ b/types/_aws_amplify_client_config.clientConfigTypesV1_1.AwsRegion.html @@ -1 +1 @@ -AwsRegion | Amplify Toolbox
    \ No newline at end of file +AwsRegion | Amplify Toolbox
    \ No newline at end of file diff --git a/types/_aws_amplify_deployed_backend_client.AppNameAndBranchBackendIdentifier.html b/types/_aws_amplify_deployed_backend_client.AppNameAndBranchBackendIdentifier.html index 5ccc0594d4..f82e3cbe81 100644 --- a/types/_aws_amplify_deployed_backend_client.AppNameAndBranchBackendIdentifier.html +++ b/types/_aws_amplify_deployed_backend_client.AppNameAndBranchBackendIdentifier.html @@ -1,2 +1,2 @@ AppNameAndBranchBackendIdentifier | Amplify Toolbox
    AppNameAndBranchBackendIdentifier: {
        appName: string;
        branchName: string;
    }

    Tuple of Amplify App name and branch

    -

    Type declaration

    • appName: string
    • branchName: string
    \ No newline at end of file +

    Type declaration

    • appName: string
    • branchName: string
    \ No newline at end of file diff --git a/types/_aws_amplify_deployed_backend_client.BackendMetadata.html b/types/_aws_amplify_deployed_backend_client.BackendMetadata.html index 5996a071a4..8ba598f9df 100644 --- a/types/_aws_amplify_deployed_backend_client.BackendMetadata.html +++ b/types/_aws_amplify_deployed_backend_client.BackendMetadata.html @@ -1 +1 @@ -BackendMetadata | Amplify Toolbox
    BackendMetadata: {
        apiConfiguration?: {
            additionalAuthTypes: ApiAuthType[];
            apiId: string;
            conflictResolutionMode?: ConflictResolutionMode;
            defaultAuthType: ApiAuthType;
            graphqlEndpoint: string;
            lastUpdated: Date | undefined;
            modelSchemaS3Uri: string;
            status: BackendDeploymentStatus;
        };
        authConfiguration?: {
            lastUpdated: Date | undefined;
            status: BackendDeploymentStatus;
            userPoolId: string;
        };
        deploymentType: DeploymentType;
        functionConfigurations?: FunctionConfiguration[];
        lastUpdated: Date | undefined;
        name: string;
        resources: DeployedBackendResource[];
        status: BackendDeploymentStatus;
        storageConfiguration?: {
            lastUpdated: Date | undefined;
            s3BucketName: string;
            status: BackendDeploymentStatus;
        };
    }

    Type declaration

    \ No newline at end of file +BackendMetadata | Amplify Toolbox
    BackendMetadata: {
        apiConfiguration?: {
            additionalAuthTypes: ApiAuthType[];
            apiId: string;
            conflictResolutionMode?: ConflictResolutionMode;
            defaultAuthType: ApiAuthType;
            graphqlEndpoint: string;
            lastUpdated: Date | undefined;
            modelSchemaS3Uri: string;
            status: BackendDeploymentStatus;
        };
        authConfiguration?: {
            lastUpdated: Date | undefined;
            status: BackendDeploymentStatus;
            userPoolId: string;
        };
        deploymentType: DeploymentType;
        functionConfigurations?: FunctionConfiguration[];
        lastUpdated: Date | undefined;
        name: string;
        resources: DeployedBackendResource[];
        status: BackendDeploymentStatus;
        storageConfiguration?: {
            lastUpdated: Date | undefined;
            s3BucketName: string;
            status: BackendDeploymentStatus;
        };
    }

    Type declaration

    \ No newline at end of file diff --git a/types/_aws_amplify_deployed_backend_client.BackendOutputClient.html b/types/_aws_amplify_deployed_backend_client.BackendOutputClient.html index 186e938876..6478db65a5 100644 --- a/types/_aws_amplify_deployed_backend_client.BackendOutputClient.html +++ b/types/_aws_amplify_deployed_backend_client.BackendOutputClient.html @@ -1,2 +1,2 @@ BackendOutputClient | Amplify Toolbox
    BackendOutputClient: {
        getOutput: ((backendIdentifier) => Promise<UnifiedBackendOutput>);
    }

    Defines BackendOutputClient

    -

    Type declaration

    \ No newline at end of file +

    Type declaration

    \ No newline at end of file diff --git a/types/_aws_amplify_deployed_backend_client.BackendOutputClientFactoryOptions.html b/types/_aws_amplify_deployed_backend_client.BackendOutputClientFactoryOptions.html index 7614252829..0f01615ec1 100644 --- a/types/_aws_amplify_deployed_backend_client.BackendOutputClientFactoryOptions.html +++ b/types/_aws_amplify_deployed_backend_client.BackendOutputClientFactoryOptions.html @@ -1 +1 @@ -BackendOutputClientFactoryOptions | Amplify Toolbox
    \ No newline at end of file +BackendOutputClientFactoryOptions | Amplify Toolbox
    \ No newline at end of file diff --git a/types/_aws_amplify_deployed_backend_client.BackendOutputClientOptions.html b/types/_aws_amplify_deployed_backend_client.BackendOutputClientOptions.html index 47726e3417..3bc557407b 100644 --- a/types/_aws_amplify_deployed_backend_client.BackendOutputClientOptions.html +++ b/types/_aws_amplify_deployed_backend_client.BackendOutputClientOptions.html @@ -1 +1 @@ -BackendOutputClientOptions | Amplify Toolbox
    BackendOutputClientOptions: {
        amplifyClient: AmplifyClient;
        cloudFormationClient: CloudFormationClient;
    }

    Type declaration

    • amplifyClient: AmplifyClient
    • cloudFormationClient: CloudFormationClient
    \ No newline at end of file +BackendOutputClientOptions | Amplify Toolbox
    BackendOutputClientOptions: {
        amplifyClient: AmplifyClient;
        cloudFormationClient: CloudFormationClient;
    }

    Type declaration

    • amplifyClient: AmplifyClient
    • cloudFormationClient: CloudFormationClient
    \ No newline at end of file diff --git a/types/_aws_amplify_deployed_backend_client.BackendOutputCredentialsOptions.html b/types/_aws_amplify_deployed_backend_client.BackendOutputCredentialsOptions.html index c1c4028555..20f153168e 100644 --- a/types/_aws_amplify_deployed_backend_client.BackendOutputCredentialsOptions.html +++ b/types/_aws_amplify_deployed_backend_client.BackendOutputCredentialsOptions.html @@ -1 +1 @@ -BackendOutputCredentialsOptions | Amplify Toolbox
    BackendOutputCredentialsOptions: {
        credentials: AwsCredentialIdentityProvider;
    }

    Type declaration

    • credentials: AwsCredentialIdentityProvider
    \ No newline at end of file +BackendOutputCredentialsOptions | Amplify Toolbox
    BackendOutputCredentialsOptions: {
        credentials: AwsCredentialIdentityProvider;
    }

    Type declaration

    • credentials: AwsCredentialIdentityProvider
    \ No newline at end of file diff --git a/types/_aws_amplify_deployed_backend_client.BackendSummaryMetadata.html b/types/_aws_amplify_deployed_backend_client.BackendSummaryMetadata.html index 739731d02d..5fc40c4818 100644 --- a/types/_aws_amplify_deployed_backend_client.BackendSummaryMetadata.html +++ b/types/_aws_amplify_deployed_backend_client.BackendSummaryMetadata.html @@ -1 +1 @@ -BackendSummaryMetadata | Amplify Toolbox
    BackendSummaryMetadata: {
        backendId: BackendIdentifier | undefined;
        lastUpdated: Date | undefined;
        name: string;
        status: BackendDeploymentStatus;
    }

    Type declaration

    \ No newline at end of file +BackendSummaryMetadata | Amplify Toolbox
    BackendSummaryMetadata: {
        backendId: BackendIdentifier | undefined;
        lastUpdated: Date | undefined;
        name: string;
        status: BackendDeploymentStatus;
    }

    Type declaration

    \ No newline at end of file diff --git a/types/_aws_amplify_deployed_backend_client.DeployedBackendClient.html b/types/_aws_amplify_deployed_backend_client.DeployedBackendClient.html index b6842f3fe3..12b325f1a1 100644 --- a/types/_aws_amplify_deployed_backend_client.DeployedBackendClient.html +++ b/types/_aws_amplify_deployed_backend_client.DeployedBackendClient.html @@ -1 +1 @@ -DeployedBackendClient | Amplify Toolbox
    DeployedBackendClient: {
        deleteSandbox: ((sandboxBackendIdentifier) => Promise<void>);
        getBackendMetadata: ((backendId) => Promise<BackendMetadata>);
        listBackends: ((listBackendsRequest?) => ListBackendsResponse);
    }

    Type declaration

    \ No newline at end of file +DeployedBackendClient | Amplify Toolbox
    DeployedBackendClient: {
        deleteSandbox: ((sandboxBackendIdentifier) => Promise<void>);
        getBackendMetadata: ((backendId) => Promise<BackendMetadata>);
        listBackends: ((listBackendsRequest?) => ListBackendsResponse);
    }

    Type declaration

    \ No newline at end of file diff --git a/types/_aws_amplify_deployed_backend_client.DeployedBackendIdentifier.html b/types/_aws_amplify_deployed_backend_client.DeployedBackendIdentifier.html index e22d65ffc2..7b2851ef4c 100644 --- a/types/_aws_amplify_deployed_backend_client.DeployedBackendIdentifier.html +++ b/types/_aws_amplify_deployed_backend_client.DeployedBackendIdentifier.html @@ -1 +1 @@ -DeployedBackendIdentifier | Amplify Toolbox
    \ No newline at end of file +DeployedBackendIdentifier | Amplify Toolbox
    \ No newline at end of file diff --git a/types/_aws_amplify_deployed_backend_client.DeployedBackendResource.html b/types/_aws_amplify_deployed_backend_client.DeployedBackendResource.html index b1f0e06c3a..73d6ea9930 100644 --- a/types/_aws_amplify_deployed_backend_client.DeployedBackendResource.html +++ b/types/_aws_amplify_deployed_backend_client.DeployedBackendResource.html @@ -1 +1 @@ -DeployedBackendResource | Amplify Toolbox
    DeployedBackendResource: {
        arn?: string;
        lastUpdated?: Date;
        logicalResourceId?: string;
        physicalResourceId?: string;
        resourceStatus?: string;
        resourceStatusReason?: string;
        resourceType?: string;
    }

    Type declaration

    • Optional arn?: string
    • Optional lastUpdated?: Date
    • Optional logicalResourceId?: string
    • Optional physicalResourceId?: string
    • Optional resourceStatus?: string
    • Optional resourceStatusReason?: string
    • Optional resourceType?: string
    \ No newline at end of file +DeployedBackendResource | Amplify Toolbox
    DeployedBackendResource: {
        arn?: string;
        lastUpdated?: Date;
        logicalResourceId?: string;
        physicalResourceId?: string;
        resourceStatus?: string;
        resourceStatusReason?: string;
        resourceType?: string;
    }

    Type declaration

    • Optional arn?: string
    • Optional lastUpdated?: Date
    • Optional logicalResourceId?: string
    • Optional physicalResourceId?: string
    • Optional resourceStatus?: string
    • Optional resourceStatusReason?: string
    • Optional resourceType?: string
    \ No newline at end of file diff --git a/types/_aws_amplify_deployed_backend_client.FunctionConfiguration.html b/types/_aws_amplify_deployed_backend_client.FunctionConfiguration.html index 8c3ee198b9..7916941997 100644 --- a/types/_aws_amplify_deployed_backend_client.FunctionConfiguration.html +++ b/types/_aws_amplify_deployed_backend_client.FunctionConfiguration.html @@ -1 +1 @@ -FunctionConfiguration | Amplify Toolbox
    FunctionConfiguration: {
        functionName: string;
        lastUpdated: Date | undefined;
        status: BackendDeploymentStatus;
    }

    Type declaration

    \ No newline at end of file +FunctionConfiguration | Amplify Toolbox
    FunctionConfiguration: {
        functionName: string;
        lastUpdated: Date | undefined;
        status: BackendDeploymentStatus;
    }

    Type declaration

    \ No newline at end of file diff --git a/types/_aws_amplify_deployed_backend_client.ListBackendsRequest.html b/types/_aws_amplify_deployed_backend_client.ListBackendsRequest.html index dce4f5c989..bc1efa468b 100644 --- a/types/_aws_amplify_deployed_backend_client.ListBackendsRequest.html +++ b/types/_aws_amplify_deployed_backend_client.ListBackendsRequest.html @@ -1 +1 @@ -ListBackendsRequest | Amplify Toolbox
    ListBackendsRequest: {
        backendStatusFilters?: BackendStatus[];
        deploymentType: DeploymentType;
    }

    Type declaration

    \ No newline at end of file +ListBackendsRequest | Amplify Toolbox
    ListBackendsRequest: {
        backendStatusFilters?: BackendStatus[];
        deploymentType: DeploymentType;
    }

    Type declaration

    \ No newline at end of file diff --git a/types/_aws_amplify_deployed_backend_client.ListBackendsResponse.html b/types/_aws_amplify_deployed_backend_client.ListBackendsResponse.html index 425ccc2690..60633b276c 100644 --- a/types/_aws_amplify_deployed_backend_client.ListBackendsResponse.html +++ b/types/_aws_amplify_deployed_backend_client.ListBackendsResponse.html @@ -1 +1 @@ -ListBackendsResponse | Amplify Toolbox
    ListBackendsResponse: {
        getBackendSummaryByPage: (() => AsyncGenerator<BackendSummaryMetadata[]>);
    }

    Type declaration

    \ No newline at end of file +ListBackendsResponse | Amplify Toolbox
    ListBackendsResponse: {
        getBackendSummaryByPage: (() => AsyncGenerator<BackendSummaryMetadata[]>);
    }

    Type declaration

    \ No newline at end of file diff --git a/types/_aws_amplify_deployed_backend_client.StackIdentifier.html b/types/_aws_amplify_deployed_backend_client.StackIdentifier.html index 25fcb5ce10..980830bd57 100644 --- a/types/_aws_amplify_deployed_backend_client.StackIdentifier.html +++ b/types/_aws_amplify_deployed_backend_client.StackIdentifier.html @@ -1 +1 @@ -StackIdentifier | Amplify Toolbox
    StackIdentifier: {
        stackName: string;
    }

    Type declaration

    • stackName: string
    \ No newline at end of file +StackIdentifier | Amplify Toolbox
    StackIdentifier: {
        stackName: string;
    }

    Type declaration

    • stackName: string
    \ No newline at end of file diff --git a/types/_aws_amplify_form_generator.FormGenerationOptions.html b/types/_aws_amplify_form_generator.FormGenerationOptions.html index e5e4312a89..79224cc191 100644 --- a/types/_aws_amplify_form_generator.FormGenerationOptions.html +++ b/types/_aws_amplify_form_generator.FormGenerationOptions.html @@ -1 +1 @@ -FormGenerationOptions | Amplify Toolbox
    FormGenerationOptions: {
        models?: string[];
    }

    Type declaration

    • Optional models?: string[]
    \ No newline at end of file +FormGenerationOptions | Amplify Toolbox
    FormGenerationOptions: {
        models?: string[];
    }

    Type declaration

    • Optional models?: string[]
    \ No newline at end of file diff --git a/types/_aws_amplify_form_generator.GenerateGraphqlToFileResult.html b/types/_aws_amplify_form_generator.GenerateGraphqlToFileResult.html index 72fdfcc7bd..fdf68510f2 100644 --- a/types/_aws_amplify_form_generator.GenerateGraphqlToFileResult.html +++ b/types/_aws_amplify_form_generator.GenerateGraphqlToFileResult.html @@ -1 +1 @@ -GenerateGraphqlToFileResult | Amplify Toolbox
    GenerateGraphqlToFileResult: {
        filesWritten: string[];
    }

    Type declaration

    • filesWritten: string[]
    \ No newline at end of file +GenerateGraphqlToFileResult | Amplify Toolbox
    GenerateGraphqlToFileResult: {
        filesWritten: string[];
    }

    Type declaration

    • filesWritten: string[]
    \ No newline at end of file diff --git a/types/_aws_amplify_form_generator.GraphqlFormGenerator.html b/types/_aws_amplify_form_generator.GraphqlFormGenerator.html index 9b2d926aeb..cefeff1ed9 100644 --- a/types/_aws_amplify_form_generator.GraphqlFormGenerator.html +++ b/types/_aws_amplify_form_generator.GraphqlFormGenerator.html @@ -1 +1 @@ -GraphqlFormGenerator | Amplify Toolbox
    GraphqlFormGenerator: {
        generateForms: ((options?) => Promise<GraphqlGenerationResult>);
    }

    Type declaration

    \ No newline at end of file +GraphqlFormGenerator | Amplify Toolbox
    GraphqlFormGenerator: {
        generateForms: ((options?) => Promise<GraphqlGenerationResult>);
    }

    Type declaration

    \ No newline at end of file diff --git a/types/_aws_amplify_form_generator.GraphqlGenerationResult.html b/types/_aws_amplify_form_generator.GraphqlGenerationResult.html index e42466e279..b27325ad66 100644 --- a/types/_aws_amplify_form_generator.GraphqlGenerationResult.html +++ b/types/_aws_amplify_form_generator.GraphqlGenerationResult.html @@ -1 +1 @@ -GraphqlGenerationResult | Amplify Toolbox
    GraphqlGenerationResult: {
        writeToDirectory: ((directoryPath) => Promise<GenerateGraphqlToFileResult>);
    }

    Type declaration

    \ No newline at end of file +GraphqlGenerationResult | Amplify Toolbox
    GraphqlGenerationResult: {
        writeToDirectory: ((directoryPath) => Promise<GenerateGraphqlToFileResult>);
    }

    Type declaration

    \ No newline at end of file diff --git a/types/_aws_amplify_form_generator.LocalGraphqlFormGeneratorParams.html b/types/_aws_amplify_form_generator.LocalGraphqlFormGeneratorParams.html index 3f94621aca..6596db4f9d 100644 --- a/types/_aws_amplify_form_generator.LocalGraphqlFormGeneratorParams.html +++ b/types/_aws_amplify_form_generator.LocalGraphqlFormGeneratorParams.html @@ -1 +1 @@ -LocalGraphqlFormGeneratorParams | Amplify Toolbox
    LocalGraphqlFormGeneratorParams: {
        graphqlModelDirectoryPath: string;
        introspectionSchemaUrl: string;
    }

    Type declaration

    • graphqlModelDirectoryPath: string
    • introspectionSchemaUrl: string
    \ No newline at end of file +LocalGraphqlFormGeneratorParams | Amplify Toolbox
    LocalGraphqlFormGeneratorParams: {
        graphqlModelDirectoryPath: string;
        introspectionSchemaUrl: string;
    }

    Type declaration

    • graphqlModelDirectoryPath: string
    • introspectionSchemaUrl: string
    \ No newline at end of file diff --git a/types/_aws_amplify_model_generator.DocumentGenerationParameters.html b/types/_aws_amplify_model_generator.DocumentGenerationParameters.html index 41ba91ae34..3caefeb678 100644 --- a/types/_aws_amplify_model_generator.DocumentGenerationParameters.html +++ b/types/_aws_amplify_model_generator.DocumentGenerationParameters.html @@ -1 +1 @@ -DocumentGenerationParameters | Amplify Toolbox
    DocumentGenerationParameters: {
        maxDepth?: number;
        relativeTypesPath?: string;
        targetFormat: StatementsTarget;
        typenameIntrospection?: boolean;
    }

    Type declaration

    • Optional maxDepth?: number
    • Optional relativeTypesPath?: string
    • targetFormat: StatementsTarget
    • Optional typenameIntrospection?: boolean
    \ No newline at end of file +DocumentGenerationParameters | Amplify Toolbox
    DocumentGenerationParameters: {
        maxDepth?: number;
        relativeTypesPath?: string;
        targetFormat: StatementsTarget;
        typenameIntrospection?: boolean;
    }

    Type declaration

    • Optional maxDepth?: number
    • Optional relativeTypesPath?: string
    • targetFormat: StatementsTarget
    • Optional typenameIntrospection?: boolean
    \ No newline at end of file diff --git a/types/_aws_amplify_model_generator.GenerateApiCodeProps.html b/types/_aws_amplify_model_generator.GenerateApiCodeProps.html index a4dbb06ffa..2c32d1e082 100644 --- a/types/_aws_amplify_model_generator.GenerateApiCodeProps.html +++ b/types/_aws_amplify_model_generator.GenerateApiCodeProps.html @@ -1 +1 @@ -GenerateApiCodeProps | Amplify Toolbox
    GenerateApiCodeProps: GenerateOptions & DeployedBackendIdentifier & {
        awsClientProvider: AWSClientProvider<{
            getAmplifyClient: AmplifyClient;
            getCloudFormationClient: CloudFormationClient;
            getS3Client: S3Client;
        }>;
    }

    Type declaration

    • awsClientProvider: AWSClientProvider<{
          getAmplifyClient: AmplifyClient;
          getCloudFormationClient: CloudFormationClient;
          getS3Client: S3Client;
      }>
    \ No newline at end of file +GenerateApiCodeProps | Amplify Toolbox
    GenerateApiCodeProps: GenerateOptions & DeployedBackendIdentifier & {
        awsClientProvider: AWSClientProvider<{
            getAmplifyClient: AmplifyClient;
            getCloudFormationClient: CloudFormationClient;
            getS3Client: S3Client;
        }>;
    }

    Type declaration

    • awsClientProvider: AWSClientProvider<{
          getAmplifyClient: AmplifyClient;
          getCloudFormationClient: CloudFormationClient;
          getS3Client: S3Client;
      }>
    \ No newline at end of file diff --git a/types/_aws_amplify_model_generator.GenerateGraphqlCodegenOptions.html b/types/_aws_amplify_model_generator.GenerateGraphqlCodegenOptions.html index 97e1710a7b..f9db0792b8 100644 --- a/types/_aws_amplify_model_generator.GenerateGraphqlCodegenOptions.html +++ b/types/_aws_amplify_model_generator.GenerateGraphqlCodegenOptions.html @@ -1 +1 @@ -GenerateGraphqlCodegenOptions | Amplify Toolbox
    GenerateGraphqlCodegenOptions: {
        format: GRAPHQL_CODEGEN;
        maxDepth?: number;
        multipleSwiftFiles?: boolean;
        statementTarget: GenerateApiCodeStatementTarget;
        typeNameIntrospection?: boolean;
        typeTarget?: GenerateApiCodeTypeTarget;
    }

    Type declaration

    \ No newline at end of file +GenerateGraphqlCodegenOptions | Amplify Toolbox
    GenerateGraphqlCodegenOptions: {
        format: GRAPHQL_CODEGEN;
        maxDepth?: number;
        multipleSwiftFiles?: boolean;
        statementTarget: GenerateApiCodeStatementTarget;
        typeNameIntrospection?: boolean;
        typeTarget?: GenerateApiCodeTypeTarget;
    }

    Type declaration

    \ No newline at end of file diff --git a/types/_aws_amplify_model_generator.GenerateGraphqlCodegenToFileResult.html b/types/_aws_amplify_model_generator.GenerateGraphqlCodegenToFileResult.html index 35dfd7a62e..f8c69c6710 100644 --- a/types/_aws_amplify_model_generator.GenerateGraphqlCodegenToFileResult.html +++ b/types/_aws_amplify_model_generator.GenerateGraphqlCodegenToFileResult.html @@ -1 +1 @@ -GenerateGraphqlCodegenToFileResult | Amplify Toolbox
    GenerateGraphqlCodegenToFileResult: {
        filesWritten: string[];
    }

    Type declaration

    • filesWritten: string[]
    \ No newline at end of file +GenerateGraphqlCodegenToFileResult | Amplify Toolbox
    GenerateGraphqlCodegenToFileResult: {
        filesWritten: string[];
    }

    Type declaration

    • filesWritten: string[]
    \ No newline at end of file diff --git a/types/_aws_amplify_model_generator.GenerateIntrospectionOptions.html b/types/_aws_amplify_model_generator.GenerateIntrospectionOptions.html index c0d3685ada..77a2402b75 100644 --- a/types/_aws_amplify_model_generator.GenerateIntrospectionOptions.html +++ b/types/_aws_amplify_model_generator.GenerateIntrospectionOptions.html @@ -1 +1 @@ -GenerateIntrospectionOptions | Amplify Toolbox
    GenerateIntrospectionOptions: {
        format: INTROSPECTION;
    }

    Type declaration

    \ No newline at end of file +GenerateIntrospectionOptions | Amplify Toolbox
    GenerateIntrospectionOptions: {
        format: INTROSPECTION;
    }

    Type declaration

    \ No newline at end of file diff --git a/types/_aws_amplify_model_generator.GenerateModelsOptions.html b/types/_aws_amplify_model_generator.GenerateModelsOptions.html index 9e0960dbe0..ee53d242a8 100644 --- a/types/_aws_amplify_model_generator.GenerateModelsOptions.html +++ b/types/_aws_amplify_model_generator.GenerateModelsOptions.html @@ -1 +1 @@ -GenerateModelsOptions | Amplify Toolbox
    GenerateModelsOptions: {
        addTimestampFields?: boolean;
        emitAuthProvider?: boolean;
        format: MODELGEN;
        generateIndexRules?: boolean;
        generateModelsForLazyLoadAndCustomSelectionSet?: boolean;
        handleListNullabilityTransparently?: boolean;
        modelTarget: GenerateApiCodeModelTarget;
        respectPrimaryKeyAttributesOnConnectionField?: boolean;
        transformerVersion?: number;
        useExperimentalPipelinedTransformer?: boolean;
    }

    Type declaration

    • Optional addTimestampFields?: boolean
    • Optional emitAuthProvider?: boolean
    • format: MODELGEN
    • Optional generateIndexRules?: boolean
    • Optional generateModelsForLazyLoadAndCustomSelectionSet?: boolean
    • Optional handleListNullabilityTransparently?: boolean
    • modelTarget: GenerateApiCodeModelTarget
    • Optional respectPrimaryKeyAttributesOnConnectionField?: boolean
    • Optional transformerVersion?: number
    • Optional useExperimentalPipelinedTransformer?: boolean
    \ No newline at end of file +GenerateModelsOptions | Amplify Toolbox
    GenerateModelsOptions: {
        addTimestampFields?: boolean;
        emitAuthProvider?: boolean;
        format: MODELGEN;
        generateIndexRules?: boolean;
        generateModelsForLazyLoadAndCustomSelectionSet?: boolean;
        handleListNullabilityTransparently?: boolean;
        modelTarget: GenerateApiCodeModelTarget;
        respectPrimaryKeyAttributesOnConnectionField?: boolean;
        transformerVersion?: number;
        useExperimentalPipelinedTransformer?: boolean;
    }

    Type declaration

    • Optional addTimestampFields?: boolean
    • Optional emitAuthProvider?: boolean
    • format: MODELGEN
    • Optional generateIndexRules?: boolean
    • Optional generateModelsForLazyLoadAndCustomSelectionSet?: boolean
    • Optional handleListNullabilityTransparently?: boolean
    • modelTarget: GenerateApiCodeModelTarget
    • Optional respectPrimaryKeyAttributesOnConnectionField?: boolean
    • Optional transformerVersion?: number
    • Optional useExperimentalPipelinedTransformer?: boolean
    \ No newline at end of file diff --git a/types/_aws_amplify_model_generator.GenerateOptions.html b/types/_aws_amplify_model_generator.GenerateOptions.html index 09abb160a7..89694b3232 100644 --- a/types/_aws_amplify_model_generator.GenerateOptions.html +++ b/types/_aws_amplify_model_generator.GenerateOptions.html @@ -1 +1 @@ -GenerateOptions | Amplify Toolbox
    \ No newline at end of file +GenerateOptions | Amplify Toolbox
    \ No newline at end of file diff --git a/types/_aws_amplify_model_generator.GenerationResult.html b/types/_aws_amplify_model_generator.GenerationResult.html index 61dda2767d..9f20f1355e 100644 --- a/types/_aws_amplify_model_generator.GenerationResult.html +++ b/types/_aws_amplify_model_generator.GenerationResult.html @@ -1 +1 @@ -GenerationResult | Amplify Toolbox
    GenerationResult: {
        getResults: (() => Promise<Record<string, string>>);
        writeToDirectory: ((directoryPath) => Promise<GenerateGraphqlCodegenToFileResult>);
    }

    Type declaration

    \ No newline at end of file +GenerationResult | Amplify Toolbox
    GenerationResult: {
        getResults: (() => Promise<Record<string, string>>);
        writeToDirectory: ((directoryPath) => Promise<GenerateGraphqlCodegenToFileResult>);
    }

    Type declaration

    \ No newline at end of file diff --git a/types/_aws_amplify_model_generator.GraphqlDocumentGenerator.html b/types/_aws_amplify_model_generator.GraphqlDocumentGenerator.html index 0c22ea1322..0ac3cf299c 100644 --- a/types/_aws_amplify_model_generator.GraphqlDocumentGenerator.html +++ b/types/_aws_amplify_model_generator.GraphqlDocumentGenerator.html @@ -1 +1 @@ -GraphqlDocumentGenerator | Amplify Toolbox
    GraphqlDocumentGenerator: {
        generateModels: ((params) => Promise<GenerationResult>);
    }

    Type declaration

    \ No newline at end of file +GraphqlDocumentGenerator | Amplify Toolbox
    GraphqlDocumentGenerator: {
        generateModels: ((params) => Promise<GenerationResult>);
    }

    Type declaration

    \ No newline at end of file diff --git a/types/_aws_amplify_model_generator.GraphqlDocumentGeneratorFactoryParams.html b/types/_aws_amplify_model_generator.GraphqlDocumentGeneratorFactoryParams.html index fd4b33e566..54ee35c127 100644 --- a/types/_aws_amplify_model_generator.GraphqlDocumentGeneratorFactoryParams.html +++ b/types/_aws_amplify_model_generator.GraphqlDocumentGeneratorFactoryParams.html @@ -1 +1 @@ -GraphqlDocumentGeneratorFactoryParams | Amplify Toolbox
    GraphqlDocumentGeneratorFactoryParams: {
        awsClientProvider: AWSClientProvider<{
            getAmplifyClient: AmplifyClient;
            getCloudFormationClient: CloudFormationClient;
        }>;
        backendIdentifier: DeployedBackendIdentifier;
    }

    Type declaration

    \ No newline at end of file +GraphqlDocumentGeneratorFactoryParams | Amplify Toolbox
    GraphqlDocumentGeneratorFactoryParams: {
        awsClientProvider: AWSClientProvider<{
            getAmplifyClient: AmplifyClient;
            getCloudFormationClient: CloudFormationClient;
        }>;
        backendIdentifier: DeployedBackendIdentifier;
    }

    Type declaration

    \ No newline at end of file diff --git a/types/_aws_amplify_model_generator.GraphqlModelsGenerator.html b/types/_aws_amplify_model_generator.GraphqlModelsGenerator.html index e50cdbe0fe..7e8e381dff 100644 --- a/types/_aws_amplify_model_generator.GraphqlModelsGenerator.html +++ b/types/_aws_amplify_model_generator.GraphqlModelsGenerator.html @@ -1 +1 @@ -GraphqlModelsGenerator | Amplify Toolbox
    GraphqlModelsGenerator: {
        generateModels: ((params) => Promise<GenerationResult>);
    }

    Type declaration

    \ No newline at end of file +GraphqlModelsGenerator | Amplify Toolbox
    GraphqlModelsGenerator: {
        generateModels: ((params) => Promise<GenerationResult>);
    }

    Type declaration

    \ No newline at end of file diff --git a/types/_aws_amplify_model_generator.GraphqlModelsGeneratorFactoryParams.html b/types/_aws_amplify_model_generator.GraphqlModelsGeneratorFactoryParams.html index 86e5e23829..f3ea4f36ae 100644 --- a/types/_aws_amplify_model_generator.GraphqlModelsGeneratorFactoryParams.html +++ b/types/_aws_amplify_model_generator.GraphqlModelsGeneratorFactoryParams.html @@ -1 +1 @@ -GraphqlModelsGeneratorFactoryParams | Amplify Toolbox
    GraphqlModelsGeneratorFactoryParams: {
        awsClientProvider: AWSClientProvider<{
            getAmplifyClient: AmplifyClient;
            getCloudFormationClient: CloudFormationClient;
            getS3Client: S3Client;
        }>;
        backendIdentifier: DeployedBackendIdentifier;
    } | {
        awsClientProvider: AWSClientProvider<{
            getAmplifyClient: AmplifyClient;
            getCloudFormationClient: CloudFormationClient;
            getS3Client: S3Client;
        }>;
        modelSchemaS3Uri: string;
    }

    Type declaration

    • awsClientProvider: AWSClientProvider<{
          getAmplifyClient: AmplifyClient;
          getCloudFormationClient: CloudFormationClient;
          getS3Client: S3Client;
      }>
    • backendIdentifier: DeployedBackendIdentifier

    Type declaration

    • awsClientProvider: AWSClientProvider<{
          getAmplifyClient: AmplifyClient;
          getCloudFormationClient: CloudFormationClient;
          getS3Client: S3Client;
      }>
    • modelSchemaS3Uri: string
    \ No newline at end of file +GraphqlModelsGeneratorFactoryParams | Amplify Toolbox
    GraphqlModelsGeneratorFactoryParams: {
        awsClientProvider: AWSClientProvider<{
            getAmplifyClient: AmplifyClient;
            getCloudFormationClient: CloudFormationClient;
            getS3Client: S3Client;
        }>;
        backendIdentifier: DeployedBackendIdentifier;
    } | {
        awsClientProvider: AWSClientProvider<{
            getAmplifyClient: AmplifyClient;
            getCloudFormationClient: CloudFormationClient;
            getS3Client: S3Client;
        }>;
        modelSchemaS3Uri: string;
    }

    Type declaration

    • awsClientProvider: AWSClientProvider<{
          getAmplifyClient: AmplifyClient;
          getCloudFormationClient: CloudFormationClient;
          getS3Client: S3Client;
      }>
    • backendIdentifier: DeployedBackendIdentifier

    Type declaration

    • awsClientProvider: AWSClientProvider<{
          getAmplifyClient: AmplifyClient;
          getCloudFormationClient: CloudFormationClient;
          getS3Client: S3Client;
      }>
    • modelSchemaS3Uri: string
    \ No newline at end of file diff --git a/types/_aws_amplify_model_generator.GraphqlTypesGenerator.html b/types/_aws_amplify_model_generator.GraphqlTypesGenerator.html index a99724fa59..c66e61d94e 100644 --- a/types/_aws_amplify_model_generator.GraphqlTypesGenerator.html +++ b/types/_aws_amplify_model_generator.GraphqlTypesGenerator.html @@ -1 +1 @@ -GraphqlTypesGenerator | Amplify Toolbox
    GraphqlTypesGenerator: {
        generateTypes: ((params) => Promise<GenerationResult>);
    }

    Type declaration

    \ No newline at end of file +GraphqlTypesGenerator | Amplify Toolbox
    GraphqlTypesGenerator: {
        generateTypes: ((params) => Promise<GenerationResult>);
    }

    Type declaration

    \ No newline at end of file diff --git a/types/_aws_amplify_model_generator.ModelsGenerationParameters.html b/types/_aws_amplify_model_generator.ModelsGenerationParameters.html index e2d4529526..6342066065 100644 --- a/types/_aws_amplify_model_generator.ModelsGenerationParameters.html +++ b/types/_aws_amplify_model_generator.ModelsGenerationParameters.html @@ -1 +1 @@ -ModelsGenerationParameters | Amplify Toolbox
    ModelsGenerationParameters: {
        addTimestampFields?: boolean;
        emitAuthProvider?: boolean;
        generateIndexRules?: boolean;
        generateModelsForLazyLoadAndCustomSelectionSet?: boolean;
        handleListNullabilityTransparently?: boolean;
        respectPrimaryKeyAttributesOnConnectionField?: boolean;
        target: ModelsTarget;
        transformerVersion?: number;
        useExperimentalPipelinedTransformer?: boolean;
    }

    Type declaration

    • Optional addTimestampFields?: boolean
    • Optional emitAuthProvider?: boolean
    • Optional generateIndexRules?: boolean
    • Optional generateModelsForLazyLoadAndCustomSelectionSet?: boolean
    • Optional handleListNullabilityTransparently?: boolean
    • Optional respectPrimaryKeyAttributesOnConnectionField?: boolean
    • target: ModelsTarget
    • Optional transformerVersion?: number
    • Optional useExperimentalPipelinedTransformer?: boolean
    \ No newline at end of file +ModelsGenerationParameters | Amplify Toolbox
    ModelsGenerationParameters: {
        addTimestampFields?: boolean;
        emitAuthProvider?: boolean;
        generateIndexRules?: boolean;
        generateModelsForLazyLoadAndCustomSelectionSet?: boolean;
        handleListNullabilityTransparently?: boolean;
        respectPrimaryKeyAttributesOnConnectionField?: boolean;
        target: ModelsTarget;
        transformerVersion?: number;
        useExperimentalPipelinedTransformer?: boolean;
    }

    Type declaration

    • Optional addTimestampFields?: boolean
    • Optional emitAuthProvider?: boolean
    • Optional generateIndexRules?: boolean
    • Optional generateModelsForLazyLoadAndCustomSelectionSet?: boolean
    • Optional handleListNullabilityTransparently?: boolean
    • Optional respectPrimaryKeyAttributesOnConnectionField?: boolean
    • target: ModelsTarget
    • Optional transformerVersion?: number
    • Optional useExperimentalPipelinedTransformer?: boolean
    \ No newline at end of file diff --git a/types/_aws_amplify_model_generator.TypesGenerationParameters.html b/types/_aws_amplify_model_generator.TypesGenerationParameters.html index 32516c3401..6c26fc8cba 100644 --- a/types/_aws_amplify_model_generator.TypesGenerationParameters.html +++ b/types/_aws_amplify_model_generator.TypesGenerationParameters.html @@ -1 +1 @@ -TypesGenerationParameters | Amplify Toolbox
    TypesGenerationParameters: {
        maxDepth?: number;
        multipleSwiftFiles?: boolean;
        target: TypesTarget;
        typenameIntrospection?: boolean;
    }

    Type declaration

    • Optional maxDepth?: number
    • Optional multipleSwiftFiles?: boolean
    • target: TypesTarget
    • Optional typenameIntrospection?: boolean
    \ No newline at end of file +TypesGenerationParameters | Amplify Toolbox
    TypesGenerationParameters: {
        maxDepth?: number;
        multipleSwiftFiles?: boolean;
        target: TypesTarget;
        typenameIntrospection?: boolean;
    }

    Type declaration

    • Optional maxDepth?: number
    • Optional multipleSwiftFiles?: boolean
    • target: TypesTarget
    • Optional typenameIntrospection?: boolean
    \ No newline at end of file diff --git a/types/_aws_amplify_platform_core.AmplifyErrorClassification.html b/types/_aws_amplify_platform_core.AmplifyErrorClassification.html index fb5e4ebcc9..5e15fba4c3 100644 --- a/types/_aws_amplify_platform_core.AmplifyErrorClassification.html +++ b/types/_aws_amplify_platform_core.AmplifyErrorClassification.html @@ -1,2 +1,2 @@ AmplifyErrorClassification | Amplify Toolbox
    AmplifyErrorClassification: "FAULT" | "ERROR"

    Amplify exception classifications

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_platform_core.AmplifyErrorOptions.html b/types/_aws_amplify_platform_core.AmplifyErrorOptions.html index 975dc1c089..ce9491c710 100644 --- a/types/_aws_amplify_platform_core.AmplifyErrorOptions.html +++ b/types/_aws_amplify_platform_core.AmplifyErrorOptions.html @@ -1,2 +1,2 @@ AmplifyErrorOptions | Amplify Toolbox
    AmplifyErrorOptions: {
        code?: string;
        details?: string;
        link?: string;
        message: string;
        resolution?: string;
    }

    Amplify Error options object

    -

    Type declaration

    • Optional code?: string
    • Optional details?: string
    • Optional link?: string
    • message: string
    • Optional resolution?: string
    \ No newline at end of file +

    Type declaration

    • Optional code?: string
    • Optional details?: string
    • Optional link?: string
    • message: string
    • Optional resolution?: string
    \ No newline at end of file diff --git a/types/_aws_amplify_platform_core.AmplifyUserErrorOptions.html b/types/_aws_amplify_platform_core.AmplifyUserErrorOptions.html index f09e5e5da9..133d1e3679 100644 --- a/types/_aws_amplify_platform_core.AmplifyUserErrorOptions.html +++ b/types/_aws_amplify_platform_core.AmplifyUserErrorOptions.html @@ -1,2 +1,2 @@ AmplifyUserErrorOptions | Amplify Toolbox
    AmplifyUserErrorOptions: Omit<AmplifyErrorOptions, "resolution"> & {
        resolution: string;
    }

    Same as AmplifyErrorOptions except resolution is required

    -

    Type declaration

    • resolution: string
    \ No newline at end of file +

    Type declaration

    • resolution: string
    \ No newline at end of file diff --git a/types/_aws_amplify_platform_core.ConfigurationController.html b/types/_aws_amplify_platform_core.ConfigurationController.html index cebdd9c5c4..6257cff733 100644 --- a/types/_aws_amplify_platform_core.ConfigurationController.html +++ b/types/_aws_amplify_platform_core.ConfigurationController.html @@ -1 +1 @@ -ConfigurationController | Amplify Toolbox
    ConfigurationController: {
        clear: (() => Promise<void>);
        get: (<T>(path) => Promise<T>);
        set: ((path, value) => Promise<void>);
        write: (() => Promise<void>);
    }

    Type declaration

    • clear: (() => Promise<void>)
        • (): Promise<void>
        • Returns Promise<void>

    • get: (<T>(path) => Promise<T>)
        • <T>(path): Promise<T>
        • Type Parameters

          • T

          Parameters

          • path: string

          Returns Promise<T>

    • set: ((path, value) => Promise<void>)
        • (path, value): Promise<void>
        • Parameters

          • path: string
          • value: string | boolean | number

          Returns Promise<void>

    • write: (() => Promise<void>)
        • (): Promise<void>
        • Returns Promise<void>

    \ No newline at end of file +ConfigurationController | Amplify Toolbox
    ConfigurationController: {
        clear: (() => Promise<void>);
        get: (<T>(path) => Promise<T>);
        set: ((path, value) => Promise<void>);
        write: (() => Promise<void>);
    }

    Type declaration

    • clear: (() => Promise<void>)
        • (): Promise<void>
        • Returns Promise<void>

    • get: (<T>(path) => Promise<T>)
        • <T>(path): Promise<T>
        • Type Parameters

          • T

          Parameters

          • path: string

          Returns Promise<T>

    • set: ((path, value) => Promise<void>)
        • (path, value): Promise<void>
        • Parameters

          • path: string
          • value: string | boolean | number

          Returns Promise<void>

    • write: (() => Promise<void>)
        • (): Promise<void>
        • Returns Promise<void>

    \ No newline at end of file diff --git a/types/_aws_amplify_platform_core.LocalConfigurationFileName.html b/types/_aws_amplify_platform_core.LocalConfigurationFileName.html index dc9d59002d..b3232114d1 100644 --- a/types/_aws_amplify_platform_core.LocalConfigurationFileName.html +++ b/types/_aws_amplify_platform_core.LocalConfigurationFileName.html @@ -1 +1 @@ -LocalConfigurationFileName | Amplify Toolbox
    LocalConfigurationFileName: "usage_data_preferences.json"
    \ No newline at end of file +LocalConfigurationFileName | Amplify Toolbox
    LocalConfigurationFileName: "usage_data_preferences.json"
    \ No newline at end of file diff --git a/types/_aws_amplify_platform_core.PackageJson.html b/types/_aws_amplify_platform_core.PackageJson.html index 67fa9325e4..ed1b353d4e 100644 --- a/types/_aws_amplify_platform_core.PackageJson.html +++ b/types/_aws_amplify_platform_core.PackageJson.html @@ -1 +1 @@ -PackageJson | Amplify Toolbox
    \ No newline at end of file +PackageJson | Amplify Toolbox
    \ No newline at end of file diff --git a/types/_aws_amplify_platform_core.UsageDataEmitter.html b/types/_aws_amplify_platform_core.UsageDataEmitter.html index 18f0369877..b8cf8ac2f4 100644 --- a/types/_aws_amplify_platform_core.UsageDataEmitter.html +++ b/types/_aws_amplify_platform_core.UsageDataEmitter.html @@ -1 +1 @@ -UsageDataEmitter | Amplify Toolbox
    UsageDataEmitter: {
        emitFailure: ((error, dimensions?) => Promise<void>);
        emitSuccess: ((metrics?, dimensions?) => Promise<void>);
    }

    Type declaration

    • emitFailure: ((error, dimensions?) => Promise<void>)
        • (error, dimensions?): Promise<void>
        • Parameters

          • error: AmplifyError
          • Optional dimensions: Record<string, string>

          Returns Promise<void>

    • emitSuccess: ((metrics?, dimensions?) => Promise<void>)
        • (metrics?, dimensions?): Promise<void>
        • Parameters

          • Optional metrics: Record<string, number>
          • Optional dimensions: Record<string, string>

          Returns Promise<void>

    \ No newline at end of file +UsageDataEmitter | Amplify Toolbox
    UsageDataEmitter: {
        emitFailure: ((error, dimensions?) => Promise<void>);
        emitSuccess: ((metrics?, dimensions?) => Promise<void>);
    }

    Type declaration

    • emitFailure: ((error, dimensions?) => Promise<void>)
        • (error, dimensions?): Promise<void>
        • Parameters

          • error: AmplifyError
          • Optional dimensions: Record<string, string>

          Returns Promise<void>

    • emitSuccess: ((metrics?, dimensions?) => Promise<void>)
        • (metrics?, dimensions?): Promise<void>
        • Parameters

          • Optional metrics: Record<string, number>
          • Optional dimensions: Record<string, string>

          Returns Promise<void>

    \ No newline at end of file diff --git a/types/_aws_amplify_plugin_types.AWSClientProvider.html b/types/_aws_amplify_plugin_types.AWSClientProvider.html index 800e97c8e2..02806d35b6 100644 --- a/types/_aws_amplify_plugin_types.AWSClientProvider.html +++ b/types/_aws_amplify_plugin_types.AWSClientProvider.html @@ -1 +1 @@ -AWSClientProvider | Amplify Toolbox
    AWSClientProvider<T>: {
        [K in keyof T]: (() => T[K])
    }

    Type Parameters

    • T extends Record<`get${string}Client`, Client<object, MetadataBearer, unknown>>
    \ No newline at end of file +AWSClientProvider | Amplify Toolbox
    AWSClientProvider<T>: {
        [K in keyof T]: (() => T[K])
    }

    Type Parameters

    • T extends Record<`get${string}Client`, Client<object, MetadataBearer, unknown>>
    \ No newline at end of file diff --git a/types/_aws_amplify_plugin_types.AmplifyFunction.html b/types/_aws_amplify_plugin_types.AmplifyFunction.html index e4d631a4cf..a34e14306d 100644 --- a/types/_aws_amplify_plugin_types.AmplifyFunction.html +++ b/types/_aws_amplify_plugin_types.AmplifyFunction.html @@ -1 +1 @@ -AmplifyFunction | Amplify Toolbox
    \ No newline at end of file +AmplifyFunction | Amplify Toolbox
    \ No newline at end of file diff --git a/types/_aws_amplify_plugin_types.AppId.html b/types/_aws_amplify_plugin_types.AppId.html index 6363345284..7da827aa9e 100644 --- a/types/_aws_amplify_plugin_types.AppId.html +++ b/types/_aws_amplify_plugin_types.AppId.html @@ -1,2 +1,2 @@ AppId | Amplify Toolbox
    AppId: string

    These are some utility types to make the BackendIdentifier a bit more self-documenting

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_plugin_types.AuthCfnResources.html b/types/_aws_amplify_plugin_types.AuthCfnResources.html index 5d0da0e2e5..145c350100 100644 --- a/types/_aws_amplify_plugin_types.AuthCfnResources.html +++ b/types/_aws_amplify_plugin_types.AuthCfnResources.html @@ -4,4 +4,4 @@
  • cfnIdentityPoolRoleAttachment: CfnIdentityPoolRoleAttachment

    The generated CfnIdentityPoolRoleAttachment L1 resource.

  • cfnUserPool: CfnUserPool

    The generated CfnUserPool L1 resource.

  • cfnUserPoolClient: CfnUserPoolClient

    The generated CfnUserPoolClient L1 resource.

    -
  • \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_plugin_types.AuthResources.html b/types/_aws_amplify_plugin_types.AuthResources.html index b4404e0283..3ffe8dc7bb 100644 --- a/types/_aws_amplify_plugin_types.AuthResources.html +++ b/types/_aws_amplify_plugin_types.AuthResources.html @@ -7,4 +7,4 @@
  • unauthenticatedUserIamRole: IRole

    The generated unauth role.

  • userPool: IUserPool

    The generated UserPool L2 Resource.

  • userPoolClient: IUserPoolClient

    The generated UserPoolClient L2 Resource.

    -
  • \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_plugin_types.AuthRoleName.html b/types/_aws_amplify_plugin_types.AuthRoleName.html index 8188dd92c9..dca00d58dd 100644 --- a/types/_aws_amplify_plugin_types.AuthRoleName.html +++ b/types/_aws_amplify_plugin_types.AuthRoleName.html @@ -1 +1 @@ -AuthRoleName | Amplify Toolbox
    AuthRoleName: keyof Pick<AuthResources, "authenticatedUserIamRole" | "unauthenticatedUserIamRole">
    \ No newline at end of file +AuthRoleName | Amplify Toolbox
    AuthRoleName: keyof Pick<AuthResources, "authenticatedUserIamRole" | "unauthenticatedUserIamRole">
    \ No newline at end of file diff --git a/types/_aws_amplify_plugin_types.BackendIdentifier.html b/types/_aws_amplify_plugin_types.BackendIdentifier.html index ece27f8b97..67c9b6698b 100644 --- a/types/_aws_amplify_plugin_types.BackendIdentifier.html +++ b/types/_aws_amplify_plugin_types.BackendIdentifier.html @@ -13,4 +13,4 @@

    While this type does not enforce any specific behavior, at the time of writing, this value defaults to package.json#name when running sandbox commands Consult upstream code for exact usage.

  • type: Readonly<Extract<DeploymentType, "sandbox">>

    Const that determines this BackendIdentifier is for a sandbox backend

    -
  • \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_plugin_types.BackendOutput.html b/types/_aws_amplify_plugin_types.BackendOutput.html index 2de39d31db..1132a71d4b 100644 --- a/types/_aws_amplify_plugin_types.BackendOutput.html +++ b/types/_aws_amplify_plugin_types.BackendOutput.html @@ -1 +1 @@ -BackendOutput | Amplify Toolbox
    BackendOutput: Record<string, BackendOutputEntry>
    \ No newline at end of file +BackendOutput | Amplify Toolbox
    BackendOutput: Record<string, BackendOutputEntry>
    \ No newline at end of file diff --git a/types/_aws_amplify_plugin_types.BackendOutputEntry.html b/types/_aws_amplify_plugin_types.BackendOutputEntry.html index b780305e60..bf79f165b5 100644 --- a/types/_aws_amplify_plugin_types.BackendOutputEntry.html +++ b/types/_aws_amplify_plugin_types.BackendOutputEntry.html @@ -1 +1 @@ -BackendOutputEntry | Amplify Toolbox
    BackendOutputEntry<T>: {
        payload: T;
        version: string;
    }

    Type Parameters

    • T extends Record<string, string> = Record<string, string>

    Type declaration

    • Readonly payload: T
    • Readonly version: string
    \ No newline at end of file +BackendOutputEntry | Amplify Toolbox
    BackendOutputEntry<T>: {
        payload: T;
        version: string;
    }

    Type Parameters

    • T extends Record<string, string> = Record<string, string>

    Type declaration

    • Readonly payload: T
    • Readonly version: string
    \ No newline at end of file diff --git a/types/_aws_amplify_plugin_types.BackendOutputRetrievalStrategy.html b/types/_aws_amplify_plugin_types.BackendOutputRetrievalStrategy.html index 6da364cbfc..c56d5f810b 100644 --- a/types/_aws_amplify_plugin_types.BackendOutputRetrievalStrategy.html +++ b/types/_aws_amplify_plugin_types.BackendOutputRetrievalStrategy.html @@ -1,2 +1,2 @@ BackendOutputRetrievalStrategy | Amplify Toolbox
    BackendOutputRetrievalStrategy: {
        fetchBackendOutput: (() => Promise<BackendOutput>);
    }

    Type declaration

    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_plugin_types.BackendOutputStorageStrategy.html b/types/_aws_amplify_plugin_types.BackendOutputStorageStrategy.html index f2ee1693ad..ae231bccb8 100644 --- a/types/_aws_amplify_plugin_types.BackendOutputStorageStrategy.html +++ b/types/_aws_amplify_plugin_types.BackendOutputStorageStrategy.html @@ -1,2 +1,2 @@ BackendOutputStorageStrategy | Amplify Toolbox
    BackendOutputStorageStrategy<T>: {
        addBackendOutputEntry: ((keyName, backendOutputEntry) => void);
        appendToBackendOutputList: ((keyName, backendOutputEntry) => void);
    }

    Type for an object that collects output data from constructs

    -

    Type Parameters

    Type declaration

    • addBackendOutputEntry: ((keyName, backendOutputEntry) => void)
        • (keyName, backendOutputEntry): void
        • Parameters

          • keyName: string
          • backendOutputEntry: T

          Returns void

    • appendToBackendOutputList: ((keyName, backendOutputEntry) => void)
        • (keyName, backendOutputEntry): void
        • Parameters

          Returns void

    \ No newline at end of file +

    Type Parameters

    Type declaration

    • addBackendOutputEntry: ((keyName, backendOutputEntry) => void)
        • (keyName, backendOutputEntry): void
        • Parameters

          • keyName: string
          • backendOutputEntry: T

          Returns void

    • appendToBackendOutputList: ((keyName, backendOutputEntry) => void)
        • (keyName, backendOutputEntry): void
        • Parameters

          Returns void

    \ No newline at end of file diff --git a/types/_aws_amplify_plugin_types.BackendSecret.html b/types/_aws_amplify_plugin_types.BackendSecret.html index 0521168afc..f2a05fb15b 100644 --- a/types/_aws_amplify_plugin_types.BackendSecret.html +++ b/types/_aws_amplify_plugin_types.BackendSecret.html @@ -1,3 +1,3 @@ BackendSecret | Amplify Toolbox
    BackendSecret: {
        resolve: ((scope, backendIdentifier) => SecretValue);
        resolvePath: ((backendIdentifier) => ResolvePathResult);
    }

    Type declaration

    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_plugin_types.BackendSecretResolver.html b/types/_aws_amplify_plugin_types.BackendSecretResolver.html index f727a30258..0796ae99ea 100644 --- a/types/_aws_amplify_plugin_types.BackendSecretResolver.html +++ b/types/_aws_amplify_plugin_types.BackendSecretResolver.html @@ -1 +1 @@ -BackendSecretResolver | Amplify Toolbox
    BackendSecretResolver: {
        resolvePath: ((backendSecret) => ResolvePathResult);
        resolveSecret: ((backendSecret) => SecretValue);
    }

    Type declaration

    \ No newline at end of file +BackendSecretResolver | Amplify Toolbox
    BackendSecretResolver: {
        resolvePath: ((backendSecret) => ResolvePathResult);
        resolveSecret: ((backendSecret) => SecretValue);
    }

    Type declaration

    \ No newline at end of file diff --git a/types/_aws_amplify_plugin_types.BranchName.html b/types/_aws_amplify_plugin_types.BranchName.html index c776599c1b..2d2e4b5771 100644 --- a/types/_aws_amplify_plugin_types.BranchName.html +++ b/types/_aws_amplify_plugin_types.BranchName.html @@ -1 +1 @@ -BranchName | Amplify Toolbox
    BranchName: string
    \ No newline at end of file +BranchName | Amplify Toolbox
    BranchName: string
    \ No newline at end of file diff --git a/types/_aws_amplify_plugin_types.ConstructContainer.html b/types/_aws_amplify_plugin_types.ConstructContainer.html index 7d37e33bfc..ba675ceb4c 100644 --- a/types/_aws_amplify_plugin_types.ConstructContainer.html +++ b/types/_aws_amplify_plugin_types.ConstructContainer.html @@ -1,2 +1,2 @@ ConstructContainer | Amplify Toolbox
    ConstructContainer: {
        getConstructFactory: (<T>(token) => ConstructFactory<T> | undefined);
        getOrCompute: ((generator) => ResourceProvider);
        registerConstructFactory: ((token, provider) => void);
    }

    Vends Constructs based on an initializer function

    -

    Type declaration

    \ No newline at end of file +

    Type declaration

    \ No newline at end of file diff --git a/types/_aws_amplify_plugin_types.ConstructContainerEntryGenerator.html b/types/_aws_amplify_plugin_types.ConstructContainerEntryGenerator.html index deb9835d76..fbd243015b 100644 --- a/types/_aws_amplify_plugin_types.ConstructContainerEntryGenerator.html +++ b/types/_aws_amplify_plugin_types.ConstructContainerEntryGenerator.html @@ -2,4 +2,4 @@

    Type Parameters

    • T extends object = object

    Type declaration

    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_plugin_types.ConstructFactory.html b/types/_aws_amplify_plugin_types.ConstructFactory.html index 115e481225..4a2a7bc3e6 100644 --- a/types/_aws_amplify_plugin_types.ConstructFactory.html +++ b/types/_aws_amplify_plugin_types.ConstructFactory.html @@ -1,4 +1,4 @@ ConstructFactory | Amplify Toolbox
    ConstructFactory<T>: {
        getInstance: ((props) => T);
        provides?: string;
    }

    Functional interface for construct factories. All objects in the backend-engine definition must implement this interface.

    Type Parameters

    Type declaration

    • getInstance: ((props) => T)
    • Optional Readonly provides?: string

      A construct factory can register that the return value implements additional interfaces Registering as a provider allows other construct factories to fetch this one based on the provides token

      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_plugin_types.ConstructFactoryGetInstanceProps.html b/types/_aws_amplify_plugin_types.ConstructFactoryGetInstanceProps.html index 7c3d614e18..db55a4d688 100644 --- a/types/_aws_amplify_plugin_types.ConstructFactoryGetInstanceProps.html +++ b/types/_aws_amplify_plugin_types.ConstructFactoryGetInstanceProps.html @@ -1 +1 @@ -ConstructFactoryGetInstanceProps | Amplify Toolbox
    ConstructFactoryGetInstanceProps: {
        constructContainer: ConstructContainer;
        importPathVerifier?: ImportPathVerifier;
        outputStorageStrategy: BackendOutputStorageStrategy<BackendOutputEntry>;
        resourceNameValidator?: ResourceNameValidator;
    }

    Type declaration

    \ No newline at end of file +ConstructFactoryGetInstanceProps | Amplify Toolbox
    ConstructFactoryGetInstanceProps: {
        constructContainer: ConstructContainer;
        importPathVerifier?: ImportPathVerifier;
        outputStorageStrategy: BackendOutputStorageStrategy<BackendOutputEntry>;
        resourceNameValidator?: ResourceNameValidator;
    }

    Type declaration

    \ No newline at end of file diff --git a/types/_aws_amplify_plugin_types.DeepPartial.html b/types/_aws_amplify_plugin_types.DeepPartial.html index ff88571002..d63a31d05c 100644 --- a/types/_aws_amplify_plugin_types.DeepPartial.html +++ b/types/_aws_amplify_plugin_types.DeepPartial.html @@ -2,4 +2,4 @@ The DeepPartial type recursively makes all properties of T optional. If a property is an object, it will also be made partially optional.

    Type Parameters

    • T

      The type of the object to make partially optional.

      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_plugin_types.DeepPartialAmplifyGeneratedConfigs.html b/types/_aws_amplify_plugin_types.DeepPartialAmplifyGeneratedConfigs.html index 7041d7648e..c456a9d159 100644 --- a/types/_aws_amplify_plugin_types.DeepPartialAmplifyGeneratedConfigs.html +++ b/types/_aws_amplify_plugin_types.DeepPartialAmplifyGeneratedConfigs.html @@ -1,3 +1,3 @@ DeepPartialAmplifyGeneratedConfigs | Amplify Toolbox
    DeepPartialAmplifyGeneratedConfigs<T>: {
        [P in keyof T]?: P extends "auth" | "data" | "storage"
            ? T[P] extends object
                ? DeepPartialAmplifyGeneratedConfigs<T[P]>
                : Partial<T[P]>
            : T[P]
    }

    Makes all the properties of the entire nested object partial for Amplify generated configs instead of just the top level properties. Other properties are not changed.

    -

    Type Parameters

    • T
    \ No newline at end of file +

    Type Parameters

    • T
    \ No newline at end of file diff --git a/types/_aws_amplify_plugin_types.DeploymentType.html b/types/_aws_amplify_plugin_types.DeploymentType.html index 78844d236c..1687352be6 100644 --- a/types/_aws_amplify_plugin_types.DeploymentType.html +++ b/types/_aws_amplify_plugin_types.DeploymentType.html @@ -1,4 +1,4 @@ DeploymentType | Amplify Toolbox
    DeploymentType: "branch" | "sandbox"

    Represents the types of Amplify deployments

    Branch deployments are tied to specific git branches and are designed to be used in CI/CD Sandbox deployments are local development environments

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_plugin_types.FunctionResources.html b/types/_aws_amplify_plugin_types.FunctionResources.html index 332b6b5a4b..d9be6fa748 100644 --- a/types/_aws_amplify_plugin_types.FunctionResources.html +++ b/types/_aws_amplify_plugin_types.FunctionResources.html @@ -1 +1 @@ -FunctionResources | Amplify Toolbox
    FunctionResources: {
        cfnResources: {
            cfnFunction: CfnFunction;
        };
        lambda: IFunction;
    }

    Type declaration

    • cfnResources: {
          cfnFunction: CfnFunction;
      }
      • cfnFunction: CfnFunction
    • lambda: IFunction
    \ No newline at end of file +FunctionResources | Amplify Toolbox
    FunctionResources: {
        cfnResources: {
            cfnFunction: CfnFunction;
        };
        lambda: IFunction;
    }

    Type declaration

    • cfnResources: {
          cfnFunction: CfnFunction;
      }
      • cfnFunction: CfnFunction
    • lambda: IFunction
    \ No newline at end of file diff --git a/types/_aws_amplify_plugin_types.GenerateContainerEntryProps.html b/types/_aws_amplify_plugin_types.GenerateContainerEntryProps.html index 8d7da04513..6d6269d2a7 100644 --- a/types/_aws_amplify_plugin_types.GenerateContainerEntryProps.html +++ b/types/_aws_amplify_plugin_types.GenerateContainerEntryProps.html @@ -1 +1 @@ -GenerateContainerEntryProps | Amplify Toolbox
    GenerateContainerEntryProps: {
        backendSecretResolver: BackendSecretResolver;
        scope: Construct;
        ssmEnvironmentEntriesGenerator: SsmEnvironmentEntriesGenerator;
        stableBackendIdentifiers: StableBackendIdentifiers;
    }

    Type declaration

    \ No newline at end of file +GenerateContainerEntryProps | Amplify Toolbox
    GenerateContainerEntryProps: {
        backendSecretResolver: BackendSecretResolver;
        scope: Construct;
        ssmEnvironmentEntriesGenerator: SsmEnvironmentEntriesGenerator;
        stableBackendIdentifiers: StableBackendIdentifiers;
    }

    Type declaration

    \ No newline at end of file diff --git a/types/_aws_amplify_plugin_types.ImportPathVerifier.html b/types/_aws_amplify_plugin_types.ImportPathVerifier.html index 870944cefe..24a59c8a13 100644 --- a/types/_aws_amplify_plugin_types.ImportPathVerifier.html +++ b/types/_aws_amplify_plugin_types.ImportPathVerifier.html @@ -2,4 +2,4 @@

    Type declaration

    • verify: ((importStack, expectedImportingFile, errorMessage) => void)

      Verify that the given stack originated from an expected file path

      importStack is expected to be in the format returned by (new Error()).stack

      If the error was not imported by the expected file, an error with errorMessage is thrown

      -
        • (importStack, expectedImportingFile, errorMessage): void
        • Parameters

          • importStack: string | undefined
          • expectedImportingFile: string
          • errorMessage: string

          Returns void

    \ No newline at end of file +
      • (importStack, expectedImportingFile, errorMessage): void
      • Parameters

        • importStack: string | undefined
        • expectedImportingFile: string
        • errorMessage: string

        Returns void

    \ No newline at end of file diff --git a/types/_aws_amplify_plugin_types.MainStackCreator.html b/types/_aws_amplify_plugin_types.MainStackCreator.html index db8460139e..aa417bcd06 100644 --- a/types/_aws_amplify_plugin_types.MainStackCreator.html +++ b/types/_aws_amplify_plugin_types.MainStackCreator.html @@ -1,2 +1,2 @@ MainStackCreator | Amplify Toolbox
    MainStackCreator: {
        getOrCreateMainStack: (() => Stack);
    }

    Interface for objects that can create stacks in a given scope

    -

    Type declaration

    • getOrCreateMainStack: (() => Stack)
        • (): Stack
        • Returns Stack

    \ No newline at end of file +

    Type declaration

    • getOrCreateMainStack: (() => Stack)
        • (): Stack
        • Returns Stack

    \ No newline at end of file diff --git a/types/_aws_amplify_plugin_types.MainStackNameResolver.html b/types/_aws_amplify_plugin_types.MainStackNameResolver.html index 871331665d..d85f3c06e7 100644 --- a/types/_aws_amplify_plugin_types.MainStackNameResolver.html +++ b/types/_aws_amplify_plugin_types.MainStackNameResolver.html @@ -1,2 +1,2 @@ MainStackNameResolver | Amplify Toolbox
    MainStackNameResolver: {
        resolveMainStackName: (() => Promise<string>);
    }

    Interface for objects that can resolve a stack name

    -

    Type declaration

    • resolveMainStackName: (() => Promise<string>)
        • (): Promise<string>
        • Returns Promise<string>

    \ No newline at end of file +

    Type declaration

    • resolveMainStackName: (() => Promise<string>)
        • (): Promise<string>
        • Returns Promise<string>

    \ No newline at end of file diff --git a/types/_aws_amplify_plugin_types.PackageManagerController.html b/types/_aws_amplify_plugin_types.PackageManagerController.html index 8e2069529f..b60fb17571 100644 --- a/types/_aws_amplify_plugin_types.PackageManagerController.html +++ b/types/_aws_amplify_plugin_types.PackageManagerController.html @@ -1 +1 @@ -PackageManagerController | Amplify Toolbox
    PackageManagerController: {
        allowsSignalPropagation: (() => boolean);
        getCommand: ((args) => string);
        initializeProject: (() => Promise<void>);
        initializeTsConfig: ((targetDir) => Promise<void>);
        installDependencies: ((packageNames, type) => Promise<void>);
        runWithPackageManager: ((args, dir, options?) => ExecaChildProcess);
    }

    Type declaration

    • allowsSignalPropagation: (() => boolean)
        • (): boolean
        • Returns boolean

    • getCommand: ((args) => string)
        • (args): string
        • Parameters

          • args: string[]

          Returns string

    • initializeProject: (() => Promise<void>)
        • (): Promise<void>
        • Returns Promise<void>

    • initializeTsConfig: ((targetDir) => Promise<void>)
        • (targetDir): Promise<void>
        • Parameters

          • targetDir: string

          Returns Promise<void>

    • installDependencies: ((packageNames, type) => Promise<void>)
        • (packageNames, type): Promise<void>
        • Parameters

          • packageNames: string[]
          • type: "dev" | "prod"

          Returns Promise<void>

    • runWithPackageManager: ((args, dir, options?) => ExecaChildProcess)
        • (args, dir, options?): ExecaChildProcess
        • Parameters

          • args: string[] | undefined
          • dir: string
          • Optional options: Options<"utf8">

          Returns ExecaChildProcess

    \ No newline at end of file +PackageManagerController | Amplify Toolbox
    PackageManagerController: {
        allowsSignalPropagation: (() => boolean);
        getCommand: ((args) => string);
        initializeProject: (() => Promise<void>);
        initializeTsConfig: ((targetDir) => Promise<void>);
        installDependencies: ((packageNames, type) => Promise<void>);
        runWithPackageManager: ((args, dir, options?) => ExecaChildProcess);
    }

    Type declaration

    • allowsSignalPropagation: (() => boolean)
        • (): boolean
        • Returns boolean

    • getCommand: ((args) => string)
        • (args): string
        • Parameters

          • args: string[]

          Returns string

    • initializeProject: (() => Promise<void>)
        • (): Promise<void>
        • Returns Promise<void>

    • initializeTsConfig: ((targetDir) => Promise<void>)
        • (targetDir): Promise<void>
        • Parameters

          • targetDir: string

          Returns Promise<void>

    • installDependencies: ((packageNames, type) => Promise<void>)
        • (packageNames, type): Promise<void>
        • Parameters

          • packageNames: string[]
          • type: "dev" | "prod"

          Returns Promise<void>

    • runWithPackageManager: ((args, dir, options?) => ExecaChildProcess)
        • (args, dir, options?): ExecaChildProcess
        • Parameters

          • args: string[] | undefined
          • dir: string
          • Optional options: Options<"utf8">

          Returns ExecaChildProcess

    \ No newline at end of file diff --git a/types/_aws_amplify_plugin_types.ProjectName.html b/types/_aws_amplify_plugin_types.ProjectName.html index 60d7c7d195..6277ecd93d 100644 --- a/types/_aws_amplify_plugin_types.ProjectName.html +++ b/types/_aws_amplify_plugin_types.ProjectName.html @@ -1 +1 @@ -ProjectName | Amplify Toolbox
    ProjectName: string
    \ No newline at end of file +ProjectName | Amplify Toolbox
    ProjectName: string
    \ No newline at end of file diff --git a/types/_aws_amplify_plugin_types.ResolvePathResult.html b/types/_aws_amplify_plugin_types.ResolvePathResult.html index 4b2541d3e2..d4e1cc43bc 100644 --- a/types/_aws_amplify_plugin_types.ResolvePathResult.html +++ b/types/_aws_amplify_plugin_types.ResolvePathResult.html @@ -1 +1 @@ -ResolvePathResult | Amplify Toolbox
    ResolvePathResult: {
        branchSecretPath: string;
        sharedSecretPath: string;
    }

    Type declaration

    • branchSecretPath: string
    • sharedSecretPath: string
    \ No newline at end of file +ResolvePathResult | Amplify Toolbox
    ResolvePathResult: {
        branchSecretPath: string;
        sharedSecretPath: string;
    }

    Type declaration

    • branchSecretPath: string
    • sharedSecretPath: string
    \ No newline at end of file diff --git a/types/_aws_amplify_plugin_types.ResourceAccessAcceptor.html b/types/_aws_amplify_plugin_types.ResourceAccessAcceptor.html index c068925138..9a487ebf71 100644 --- a/types/_aws_amplify_plugin_types.ResourceAccessAcceptor.html +++ b/types/_aws_amplify_plugin_types.ResourceAccessAcceptor.html @@ -1,2 +1,2 @@ ResourceAccessAcceptor | Amplify Toolbox
    ResourceAccessAcceptor: {
        acceptResourceAccess: ((policy, ssmEnvironmentEntries) => void);
        identifier: string;
    }

    Type declaration

    • acceptResourceAccess: ((policy, ssmEnvironmentEntries) => void)
        • (policy, ssmEnvironmentEntries): void
        • Parameters

          Returns void

    • identifier: string

      String used to uniquely identify this acceptor. Each instance should have it's own identifier.

      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_plugin_types.ResourceAccessAcceptorFactory.html b/types/_aws_amplify_plugin_types.ResourceAccessAcceptorFactory.html index 05e5094269..e63d64f86a 100644 --- a/types/_aws_amplify_plugin_types.ResourceAccessAcceptorFactory.html +++ b/types/_aws_amplify_plugin_types.ResourceAccessAcceptorFactory.html @@ -1,4 +1,4 @@ ResourceAccessAcceptorFactory | Amplify Toolbox

    Type alias ResourceAccessAcceptorFactory<RoleIdentifier>

    ResourceAccessAcceptorFactory<RoleIdentifier>: {
        getResourceAccessAcceptor: ((...roleIdentifier) => ResourceAccessAcceptor);
    }

    Type Parameters

    • RoleIdentifier extends string | undefined = undefined

    Type declaration

    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_plugin_types.ResourceNameValidator.html b/types/_aws_amplify_plugin_types.ResourceNameValidator.html index bebfab8351..28f2a2b29c 100644 --- a/types/_aws_amplify_plugin_types.ResourceNameValidator.html +++ b/types/_aws_amplify_plugin_types.ResourceNameValidator.html @@ -1,3 +1,3 @@ ResourceNameValidator | Amplify Toolbox
    ResourceNameValidator: {
        validate: ((resourceName) => void);
    }

    Implementors can validate what should be the correct resource name

    Type declaration

    • validate: ((resourceName) => void)

      executes the validation

      -
        • (resourceName): void
        • Parameters

          • resourceName: string

          Returns void

    \ No newline at end of file +
      • (resourceName): void
      • Parameters

        • resourceName: string

        Returns void

    \ No newline at end of file diff --git a/types/_aws_amplify_plugin_types.ResourceProvider.html b/types/_aws_amplify_plugin_types.ResourceProvider.html index 2ee7e487bf..d80ad047b4 100644 --- a/types/_aws_amplify_plugin_types.ResourceProvider.html +++ b/types/_aws_amplify_plugin_types.ResourceProvider.html @@ -1,4 +1,4 @@ ResourceProvider | Amplify Toolbox
    ResourceProvider<T>: {
        resources: T;
    }

    Provides reference to underlying CDK resources.

    Note: we have to use object as the generic constraint rather than Record<string, unknown> so that interfaces will also satisfy the constraint See: https://stackoverflow.com/questions/63617344/how-to-satisfy-the-constraint-of-recordstring-unknown-with-interface

    -

    Type Parameters

    • T extends object = object

    Type declaration

    • resources: T
    \ No newline at end of file +

    Type Parameters

    • T extends object = object

    Type declaration

    • resources: T
    \ No newline at end of file diff --git a/types/_aws_amplify_plugin_types.SandboxName.html b/types/_aws_amplify_plugin_types.SandboxName.html index ff607ac388..6380403fb1 100644 --- a/types/_aws_amplify_plugin_types.SandboxName.html +++ b/types/_aws_amplify_plugin_types.SandboxName.html @@ -1 +1 @@ -SandboxName | Amplify Toolbox
    SandboxName: string
    \ No newline at end of file +SandboxName | Amplify Toolbox
    SandboxName: string
    \ No newline at end of file diff --git a/types/_aws_amplify_plugin_types.SsmEnvironmentEntriesGenerator.html b/types/_aws_amplify_plugin_types.SsmEnvironmentEntriesGenerator.html index 7688f6a101..3c804bb53a 100644 --- a/types/_aws_amplify_plugin_types.SsmEnvironmentEntriesGenerator.html +++ b/types/_aws_amplify_plugin_types.SsmEnvironmentEntriesGenerator.html @@ -1 +1 @@ -SsmEnvironmentEntriesGenerator | Amplify Toolbox
    SsmEnvironmentEntriesGenerator: {
        generateSsmEnvironmentEntries: ((scopeContext) => SsmEnvironmentEntry[]);
    }

    Type declaration

    \ No newline at end of file +SsmEnvironmentEntriesGenerator | Amplify Toolbox
    SsmEnvironmentEntriesGenerator: {
        generateSsmEnvironmentEntries: ((scopeContext) => SsmEnvironmentEntry[]);
    }

    Type declaration

    \ No newline at end of file diff --git a/types/_aws_amplify_plugin_types.SsmEnvironmentEntry.html b/types/_aws_amplify_plugin_types.SsmEnvironmentEntry.html index 40511e062f..b589c5c866 100644 --- a/types/_aws_amplify_plugin_types.SsmEnvironmentEntry.html +++ b/types/_aws_amplify_plugin_types.SsmEnvironmentEntry.html @@ -1,3 +1,3 @@ SsmEnvironmentEntry | Amplify Toolbox
    SsmEnvironmentEntry: {
        name: string;
        path: string;
    }

    Type declaration

    • name: string

      The environment variable name where this SSM value will be placed at runtime

    • path: string

      The SSM parameter path that will be fetched at runtime

      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_plugin_types.StableBackendIdentifiers.html b/types/_aws_amplify_plugin_types.StableBackendIdentifiers.html index 9f33679c85..5581baf793 100644 --- a/types/_aws_amplify_plugin_types.StableBackendIdentifiers.html +++ b/types/_aws_amplify_plugin_types.StableBackendIdentifiers.html @@ -1 +1 @@ -StableBackendIdentifiers | Amplify Toolbox
    StableBackendIdentifiers: {
        getStableBackendHash: (() => string);
    }

    Type declaration

    • getStableBackendHash: (() => string)
        • (): string
        • Returns string

    \ No newline at end of file +StableBackendIdentifiers | Amplify Toolbox
    StableBackendIdentifiers: {
        getStableBackendHash: (() => string);
    }

    Type declaration

    • getStableBackendHash: (() => string)
        • (): string
        • Returns string

    \ No newline at end of file diff --git a/types/_aws_amplify_plugin_types.StackProvider.html b/types/_aws_amplify_plugin_types.StackProvider.html index 4194628ee0..da44d78dd9 100644 --- a/types/_aws_amplify_plugin_types.StackProvider.html +++ b/types/_aws_amplify_plugin_types.StackProvider.html @@ -1 +1 @@ -StackProvider | Amplify Toolbox
    StackProvider: {
        stack: Stack;
    }

    Type declaration

    • stack: Stack
    \ No newline at end of file +StackProvider | Amplify Toolbox
    StackProvider: {
        stack: Stack;
    }

    Type declaration

    • stack: Stack
    \ No newline at end of file diff --git a/types/_aws_amplify_sandbox.BackendIdSandboxResolver.html b/types/_aws_amplify_sandbox.BackendIdSandboxResolver.html index c96c084f25..c73f9b9aca 100644 --- a/types/_aws_amplify_sandbox.BackendIdSandboxResolver.html +++ b/types/_aws_amplify_sandbox.BackendIdSandboxResolver.html @@ -1 +1 @@ -BackendIdSandboxResolver | Amplify Toolbox
    BackendIdSandboxResolver: ((identifier?) => Promise<BackendIdentifier>)

    Type declaration

    \ No newline at end of file +BackendIdSandboxResolver | Amplify Toolbox
    BackendIdSandboxResolver: ((identifier?) => Promise<BackendIdentifier>)

    Type declaration

    \ No newline at end of file diff --git a/types/_aws_amplify_sandbox.Sandbox.html b/types/_aws_amplify_sandbox.Sandbox.html index 22547d8eb8..7ecf09c9e8 100644 --- a/types/_aws_amplify_sandbox.Sandbox.html +++ b/types/_aws_amplify_sandbox.Sandbox.html @@ -3,4 +3,4 @@
  • start: ((options) => Promise<void>)

    Starts the sandbox

      • (options): Promise<void>
      • Parameters

        • options: SandboxOptions

          such as which directory to watch for file changes

        Returns Promise<void>

  • stop: (() => Promise<void>)

    Stops watching for file changes

    -
      • (): Promise<void>
      • Returns Promise<void>

  • \ No newline at end of file +
      • (): Promise<void>
      • Returns Promise<void>

    \ No newline at end of file diff --git a/types/_aws_amplify_sandbox.SandboxDeleteOptions.html b/types/_aws_amplify_sandbox.SandboxDeleteOptions.html index bb700a1b5f..b845f184c7 100644 --- a/types/_aws_amplify_sandbox.SandboxDeleteOptions.html +++ b/types/_aws_amplify_sandbox.SandboxDeleteOptions.html @@ -1 +1 @@ -SandboxDeleteOptions | Amplify Toolbox
    SandboxDeleteOptions: {
        identifier?: string;
        profile?: string;
    }

    Type declaration

    • Optional identifier?: string
    • Optional profile?: string
    \ No newline at end of file +SandboxDeleteOptions | Amplify Toolbox
    SandboxDeleteOptions: {
        identifier?: string;
        profile?: string;
    }

    Type declaration

    • Optional identifier?: string
    • Optional profile?: string
    \ No newline at end of file diff --git a/types/_aws_amplify_sandbox.SandboxEvents.html b/types/_aws_amplify_sandbox.SandboxEvents.html index 5db725dee2..2f4c79728b 100644 --- a/types/_aws_amplify_sandbox.SandboxEvents.html +++ b/types/_aws_amplify_sandbox.SandboxEvents.html @@ -1 +1 @@ -SandboxEvents | Amplify Toolbox
    SandboxEvents: "successfulDeployment" | "failedDeployment" | "successfulDeletion"
    \ No newline at end of file +SandboxEvents | Amplify Toolbox
    SandboxEvents: "successfulDeployment" | "failedDeployment" | "successfulDeletion"
    \ No newline at end of file diff --git a/types/_aws_amplify_sandbox.SandboxFunctionStreamingOptions.html b/types/_aws_amplify_sandbox.SandboxFunctionStreamingOptions.html index 5de8531078..aab15913ff 100644 --- a/types/_aws_amplify_sandbox.SandboxFunctionStreamingOptions.html +++ b/types/_aws_amplify_sandbox.SandboxFunctionStreamingOptions.html @@ -1 +1 @@ -SandboxFunctionStreamingOptions | Amplify Toolbox
    SandboxFunctionStreamingOptions: {
        enabled: boolean;
        logsFilters?: string[];
        logsOutFile?: string;
    }

    Type declaration

    • enabled: boolean
    • Optional logsFilters?: string[]
    • Optional logsOutFile?: string
    \ No newline at end of file +SandboxFunctionStreamingOptions | Amplify Toolbox
    SandboxFunctionStreamingOptions: {
        enabled: boolean;
        logsFilters?: string[];
        logsOutFile?: string;
    }

    Type declaration

    • enabled: boolean
    • Optional logsFilters?: string[]
    • Optional logsOutFile?: string
    \ No newline at end of file diff --git a/types/_aws_amplify_sandbox.SandboxOptions.html b/types/_aws_amplify_sandbox.SandboxOptions.html index 072a5b0e3e..8761f5835f 100644 --- a/types/_aws_amplify_sandbox.SandboxOptions.html +++ b/types/_aws_amplify_sandbox.SandboxOptions.html @@ -1 +1 @@ -SandboxOptions | Amplify Toolbox
    SandboxOptions: {
        dir?: string;
        exclude?: string[];
        format?: ClientConfigFormat;
        functionStreamingOptions?: SandboxFunctionStreamingOptions;
        identifier?: string;
        profile?: string;
        watchForChanges?: boolean;
    }

    Type declaration

    \ No newline at end of file +SandboxOptions | Amplify Toolbox
    SandboxOptions: {
        dir?: string;
        exclude?: string[];
        format?: ClientConfigFormat;
        functionStreamingOptions?: SandboxFunctionStreamingOptions;
        identifier?: string;
        profile?: string;
        watchForChanges?: boolean;
    }

    Type declaration

    \ No newline at end of file diff --git a/types/_aws_amplify_schema_generator.SQLDataSourceConfig.html b/types/_aws_amplify_schema_generator.SQLDataSourceConfig.html index d476007bf8..0d9c0f6858 100644 --- a/types/_aws_amplify_schema_generator.SQLDataSourceConfig.html +++ b/types/_aws_amplify_schema_generator.SQLDataSourceConfig.html @@ -1 +1 @@ -SQLDataSourceConfig | Amplify Toolbox
    SQLDataSourceConfig: {
        database: string;
        engine: SQLEngine;
        host: string;
        password: string;
        port: number;
        username: string;
    }

    Type declaration

    • database: string
    • engine: SQLEngine
    • host: string
    • password: string
    • port: number
    • username: string
    \ No newline at end of file +SQLDataSourceConfig | Amplify Toolbox
    SQLDataSourceConfig: {
        database: string;
        engine: SQLEngine;
        host: string;
        password: string;
        port: number;
        username: string;
    }

    Type declaration

    • database: string
    • engine: SQLEngine
    • host: string
    • password: string
    • port: number
    • username: string
    \ No newline at end of file diff --git a/types/_aws_amplify_schema_generator.SQLEngine.html b/types/_aws_amplify_schema_generator.SQLEngine.html index 356de35a5f..37ea5ebb57 100644 --- a/types/_aws_amplify_schema_generator.SQLEngine.html +++ b/types/_aws_amplify_schema_generator.SQLEngine.html @@ -1 +1 @@ -SQLEngine | Amplify Toolbox
    SQLEngine: "mysql" | "postgresql"
    \ No newline at end of file +SQLEngine | Amplify Toolbox
    SQLEngine: "mysql" | "postgresql"
    \ No newline at end of file diff --git a/types/_aws_amplify_schema_generator.SchemaGeneratorConfig.html b/types/_aws_amplify_schema_generator.SchemaGeneratorConfig.html index 38c135c4b6..fa8477271b 100644 --- a/types/_aws_amplify_schema_generator.SchemaGeneratorConfig.html +++ b/types/_aws_amplify_schema_generator.SchemaGeneratorConfig.html @@ -1 +1 @@ -SchemaGeneratorConfig | Amplify Toolbox
    SchemaGeneratorConfig: {
        connectionUri: {
            secretName: string;
            value: string;
        };
        out: string;
        sslCert?: {
            secretName: string;
            value: string;
        };
    }

    Type declaration

    • connectionUri: {
          secretName: string;
          value: string;
      }
      • secretName: string
      • value: string
    • out: string
    • Optional sslCert?: {
          secretName: string;
          value: string;
      }
      • secretName: string
      • value: string
    \ No newline at end of file +SchemaGeneratorConfig | Amplify Toolbox
    SchemaGeneratorConfig: {
        connectionUri: {
            secretName: string;
            value: string;
        };
        out: string;
        sslCert?: {
            secretName: string;
            value: string;
        };
    }

    Type declaration

    • connectionUri: {
          secretName: string;
          value: string;
      }
      • secretName: string
      • value: string
    • out: string
    • Optional sslCert?: {
          secretName: string;
          value: string;
      }
      • secretName: string
      • value: string
    \ No newline at end of file diff --git a/variables/_aws_amplify_auth_construct.triggerEvents.html b/variables/_aws_amplify_auth_construct.triggerEvents.html index f8ec7048e7..041f23faba 100644 --- a/variables/_aws_amplify_auth_construct.triggerEvents.html +++ b/variables/_aws_amplify_auth_construct.triggerEvents.html @@ -1,3 +1,3 @@ triggerEvents | Amplify Toolbox
    triggerEvents: readonly ["createAuthChallenge", "customMessage", "defineAuthChallenge", "postAuthentication", "postConfirmation", "preAuthentication", "preSignUp", "preTokenGeneration", "userMigration", "verifyAuthChallengeResponse"] = ...

    Supported auth trigger events. Derived from CDK UserPoolOperation, but we can't use that to get type inference because the operation names are typed as "string" rather than a string literal

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/variables/_aws_amplify_backend_output_schemas.AwsAppsyncAuthenticationZodEnum.html b/variables/_aws_amplify_backend_output_schemas.AwsAppsyncAuthenticationZodEnum.html index b444ff9670..c6d45f80e2 100644 --- a/variables/_aws_amplify_backend_output_schemas.AwsAppsyncAuthenticationZodEnum.html +++ b/variables/_aws_amplify_backend_output_schemas.AwsAppsyncAuthenticationZodEnum.html @@ -1 +1 @@ -AwsAppsyncAuthenticationZodEnum | Amplify Toolbox
    AwsAppsyncAuthenticationZodEnum: ZodEnum<["API_KEY", "AWS_LAMBDA", "AWS_IAM", "OPENID_CONNECT", "AMAZON_COGNITO_USER_POOLS"]> = ...
    \ No newline at end of file +AwsAppsyncAuthenticationZodEnum | Amplify Toolbox
    AwsAppsyncAuthenticationZodEnum: ZodEnum<["API_KEY", "AWS_LAMBDA", "AWS_IAM", "OPENID_CONNECT", "AMAZON_COGNITO_USER_POOLS"]> = ...
    \ No newline at end of file diff --git a/variables/_aws_amplify_backend_output_schemas.authOutputKey.html b/variables/_aws_amplify_backend_output_schemas.authOutputKey.html index a092832069..cecd208aae 100644 --- a/variables/_aws_amplify_backend_output_schemas.authOutputKey.html +++ b/variables/_aws_amplify_backend_output_schemas.authOutputKey.html @@ -1,2 +1,2 @@ authOutputKey | Amplify Toolbox
    authOutputKey: "AWS::Amplify::Auth" = 'AWS::Amplify::Auth'

    Expected key that auth output is stored under

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/variables/_aws_amplify_backend_output_schemas.backendOutputEntryStackMetadataSchema.html b/variables/_aws_amplify_backend_output_schemas.backendOutputEntryStackMetadataSchema.html index 896d6ff306..4b39bee36d 100644 --- a/variables/_aws_amplify_backend_output_schemas.backendOutputEntryStackMetadataSchema.html +++ b/variables/_aws_amplify_backend_output_schemas.backendOutputEntryStackMetadataSchema.html @@ -1,2 +1,2 @@ backendOutputEntryStackMetadataSchema | Amplify Toolbox
    backendOutputEntryStackMetadataSchema: ZodObject<{
        stackOutputs: ZodArray<ZodString, "many">;
        version: ZodString;
    }, "strip", ZodTypeAny, {
        stackOutputs: string[];
        version: string;
    }, {
        stackOutputs: string[];
        version: string;
    }> = ...

    Data schema for storing a backend output entry using stack metadata

    -

    Type declaration

    • stackOutputs: ZodArray<ZodString, "many">
    • version: ZodString

    Type declaration

    • stackOutputs: string[]
    • version: string

    Type declaration

    • stackOutputs: string[]
    • version: string
    \ No newline at end of file +

    Type declaration

    • stackOutputs: ZodArray<ZodString, "many">
    • version: ZodString

    Type declaration

    • stackOutputs: string[]
    • version: string

    Type declaration

    • stackOutputs: string[]
    • version: string
    \ No newline at end of file diff --git a/variables/_aws_amplify_backend_output_schemas.backendOutputStackMetadataSchema.html b/variables/_aws_amplify_backend_output_schemas.backendOutputStackMetadataSchema.html index 0dc9871487..4ce3b7e6ee 100644 --- a/variables/_aws_amplify_backend_output_schemas.backendOutputStackMetadataSchema.html +++ b/variables/_aws_amplify_backend_output_schemas.backendOutputStackMetadataSchema.html @@ -1,2 +1,2 @@ backendOutputStackMetadataSchema | Amplify Toolbox
    backendOutputStackMetadataSchema: ZodRecord<ZodString, ZodObject<{
        stackOutputs: ZodArray<ZodString, "many">;
        version: ZodString;
    }, "strip", ZodTypeAny, {
        stackOutputs: string[];
        version: string;
    }, {
        stackOutputs: string[];
        version: string;
    }>> = ...

    Data schema for storing backend output using stack metadata

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/variables/_aws_amplify_backend_output_schemas.customOutputKey.html b/variables/_aws_amplify_backend_output_schemas.customOutputKey.html index a47f796c10..62e0f15700 100644 --- a/variables/_aws_amplify_backend_output_schemas.customOutputKey.html +++ b/variables/_aws_amplify_backend_output_schemas.customOutputKey.html @@ -1,2 +1,2 @@ customOutputKey | Amplify Toolbox
    customOutputKey: "AWS::Amplify::Custom" = 'AWS::Amplify::Custom'

    ---------- Custom exports ----------

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/variables/_aws_amplify_backend_output_schemas.functionOutputKey.html b/variables/_aws_amplify_backend_output_schemas.functionOutputKey.html index 377aa207fc..5bcfa95421 100644 --- a/variables/_aws_amplify_backend_output_schemas.functionOutputKey.html +++ b/variables/_aws_amplify_backend_output_schemas.functionOutputKey.html @@ -1,2 +1,2 @@ functionOutputKey | Amplify Toolbox
    functionOutputKey: "AWS::Amplify::Function" = 'AWS::Amplify::Function'

    Expected key that function output is stored under

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/variables/_aws_amplify_backend_output_schemas.graphqlOutputKey.html b/variables/_aws_amplify_backend_output_schemas.graphqlOutputKey.html index e160dec140..f74db776d4 100644 --- a/variables/_aws_amplify_backend_output_schemas.graphqlOutputKey.html +++ b/variables/_aws_amplify_backend_output_schemas.graphqlOutputKey.html @@ -1,2 +1,2 @@ graphqlOutputKey | Amplify Toolbox
    graphqlOutputKey: "AWS::Amplify::GraphQL" = 'AWS::Amplify::GraphQL'

    Expected key that graphql output is stored under

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/variables/_aws_amplify_backend_output_schemas.platformOutputKey.html b/variables/_aws_amplify_backend_output_schemas.platformOutputKey.html index 0c7a16b767..ae0053ddde 100644 --- a/variables/_aws_amplify_backend_output_schemas.platformOutputKey.html +++ b/variables/_aws_amplify_backend_output_schemas.platformOutputKey.html @@ -1,2 +1,2 @@ platformOutputKey | Amplify Toolbox
    platformOutputKey: "AWS::Amplify::Platform" = 'AWS::Amplify::Platform'

    ---------- Platform exports ----------

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/variables/_aws_amplify_backend_output_schemas.storageOutputKey.html b/variables/_aws_amplify_backend_output_schemas.storageOutputKey.html index cdd969d7a9..22b018c682 100644 --- a/variables/_aws_amplify_backend_output_schemas.storageOutputKey.html +++ b/variables/_aws_amplify_backend_output_schemas.storageOutputKey.html @@ -1,2 +1,2 @@ storageOutputKey | Amplify Toolbox
    storageOutputKey: "AWS::Amplify::Storage" = 'AWS::Amplify::Storage'

    Expected key that storage output is stored under

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/variables/_aws_amplify_backend_output_schemas.unifiedBackendOutputSchema.html b/variables/_aws_amplify_backend_output_schemas.unifiedBackendOutputSchema.html index ef10f3b34e..de78d15b87 100644 --- a/variables/_aws_amplify_backend_output_schemas.unifiedBackendOutputSchema.html +++ b/variables/_aws_amplify_backend_output_schemas.unifiedBackendOutputSchema.html @@ -1,3 +1,3 @@ unifiedBackendOutputSchema | Amplify Toolbox
    unifiedBackendOutputSchema: ZodObject<{
        AWS::Amplify::Auth: ZodOptional<ZodDiscriminatedUnion<"version", [ZodObject<{
            payload: ZodObject<{
                allowUnauthenticatedIdentities: ZodOptional<ZodString>;
                authRegion: ZodString;
                identityPoolId: ZodString;
                mfaConfiguration: ZodOptional<ZodString>;
                mfaTypes: ZodOptional<ZodString>;
                oauthClientId: ZodOptional<ZodString>;
                oauthCognitoDomain: ZodOptional<ZodString>;
                oauthRedirectSignIn: ZodOptional<ZodString>;
                oauthRedirectSignOut: ZodOptional<ZodString>;
                oauthResponseType: ZodOptional<ZodString>;
                oauthScope: ZodOptional<ZodString>;
                passwordPolicyMinLength: ZodOptional<ZodString>;
                passwordPolicyRequirements: ZodOptional<ZodString>;
                signupAttributes: ZodOptional<ZodString>;
                socialProviders: ZodOptional<ZodString>;
                userPoolId: ZodString;
                usernameAttributes: ZodOptional<ZodString>;
                verificationMechanisms: ZodOptional<ZodString>;
                webClientId: ZodString;
            }, "strip", ZodTypeAny, {
                allowUnauthenticatedIdentities?: string;
                authRegion: string;
                identityPoolId: string;
                mfaConfiguration?: string;
                mfaTypes?: string;
                oauthClientId?: string;
                oauthCognitoDomain?: string;
                oauthRedirectSignIn?: string;
                oauthRedirectSignOut?: string;
                oauthResponseType?: string;
                oauthScope?: string;
                passwordPolicyMinLength?: string;
                passwordPolicyRequirements?: string;
                signupAttributes?: string;
                socialProviders?: string;
                userPoolId: string;
                usernameAttributes?: string;
                verificationMechanisms?: string;
                webClientId: string;
            }, {
                allowUnauthenticatedIdentities?: string;
                authRegion: string;
                identityPoolId: string;
                mfaConfiguration?: string;
                mfaTypes?: string;
                oauthClientId?: string;
                oauthCognitoDomain?: string;
                oauthRedirectSignIn?: string;
                oauthRedirectSignOut?: string;
                oauthResponseType?: string;
                oauthScope?: string;
                passwordPolicyMinLength?: string;
                passwordPolicyRequirements?: string;
                signupAttributes?: string;
                socialProviders?: string;
                userPoolId: string;
                usernameAttributes?: string;
                verificationMechanisms?: string;
                webClientId: string;
            }>;
            version: ZodLiteral<"1">;
        }, "strip", ZodTypeAny, {
            payload: {
                allowUnauthenticatedIdentities?: string;
                authRegion: string;
                identityPoolId: string;
                mfaConfiguration?: string;
                mfaTypes?: string;
                oauthClientId?: string;
                oauthCognitoDomain?: string;
                oauthRedirectSignIn?: string;
                oauthRedirectSignOut?: string;
                oauthResponseType?: string;
                oauthScope?: string;
                passwordPolicyMinLength?: string;
                passwordPolicyRequirements?: string;
                signupAttributes?: string;
                socialProviders?: string;
                userPoolId: string;
                usernameAttributes?: string;
                verificationMechanisms?: string;
                webClientId: string;
            };
            version: "1";
        }, {
            payload: {
                allowUnauthenticatedIdentities?: string;
                authRegion: string;
                identityPoolId: string;
                mfaConfiguration?: string;
                mfaTypes?: string;
                oauthClientId?: string;
                oauthCognitoDomain?: string;
                oauthRedirectSignIn?: string;
                oauthRedirectSignOut?: string;
                oauthResponseType?: string;
                oauthScope?: string;
                passwordPolicyMinLength?: string;
                passwordPolicyRequirements?: string;
                signupAttributes?: string;
                socialProviders?: string;
                userPoolId: string;
                usernameAttributes?: string;
                verificationMechanisms?: string;
                webClientId: string;
            };
            version: "1";
        }>]>>;
        AWS::Amplify::Custom: ZodOptional<ZodDiscriminatedUnion<"version", [ZodObject<{
            payload: ZodObject<{
                customOutputs: ZodString;
            }, "strip", ZodTypeAny, {
                customOutputs: string;
            }, {
                customOutputs: string;
            }>;
            version: ZodLiteral<"1">;
        }, "strip", ZodTypeAny, {
            payload: {
                customOutputs: string;
            };
            version: "1";
        }, {
            payload: {
                customOutputs: string;
            };
            version: "1";
        }>]>>;
        AWS::Amplify::Function: ZodOptional<ZodDiscriminatedUnion<"version", [ZodObject<{
            payload: ZodObject<{
                definedFunctions: ZodString;
            }, "strip", ZodTypeAny, {
                definedFunctions: string;
            }, {
                definedFunctions: string;
            }>;
            version: ZodLiteral<"1">;
        }, "strip", ZodTypeAny, {
            payload: {
                definedFunctions: string;
            };
            version: "1";
        }, {
            payload: {
                definedFunctions: string;
            };
            version: "1";
        }>]>>;
        AWS::Amplify::GraphQL: ZodOptional<ZodDiscriminatedUnion<"version", [ZodObject<{
            payload: ZodObject<{
                amplifyApiModelSchemaS3Uri: ZodString;
                awsAppsyncAdditionalAuthenticationTypes: ZodOptional<ZodString>;
                awsAppsyncApiEndpoint: ZodString;
                awsAppsyncApiId: ZodString;
                awsAppsyncApiKey: ZodOptional<ZodString>;
                awsAppsyncAuthenticationType: ZodEnum<[(...), (...), (...), (...), (...)]>;
                awsAppsyncConflictResolutionMode: ZodOptional<ZodString>;
                awsAppsyncRegion: ZodString;
            }, "strip", ZodTypeAny, {
                amplifyApiModelSchemaS3Uri: string;
                awsAppsyncAdditionalAuthenticationTypes?: string;
                awsAppsyncApiEndpoint: string;
                awsAppsyncApiId: string;
                awsAppsyncApiKey?: string;
                awsAppsyncAuthenticationType: "API_KEY" | "AWS_LAMBDA" | "AWS_IAM" | "OPENID_CONNECT" | "AMAZON_COGNITO_USER_POOLS";
                awsAppsyncConflictResolutionMode?: string;
                awsAppsyncRegion: string;
            }, {
                amplifyApiModelSchemaS3Uri: string;
                awsAppsyncAdditionalAuthenticationTypes?: string;
                awsAppsyncApiEndpoint: string;
                awsAppsyncApiId: string;
                awsAppsyncApiKey?: string;
                awsAppsyncAuthenticationType: "API_KEY" | "AWS_LAMBDA" | "AWS_IAM" | "OPENID_CONNECT" | "AMAZON_COGNITO_USER_POOLS";
                awsAppsyncConflictResolutionMode?: string;
                awsAppsyncRegion: string;
            }>;
            version: ZodLiteral<"1">;
        }, "strip", ZodTypeAny, {
            payload: {
                amplifyApiModelSchemaS3Uri: string;
                awsAppsyncAdditionalAuthenticationTypes?: string;
                awsAppsyncApiEndpoint: string;
                awsAppsyncApiId: string;
                awsAppsyncApiKey?: string;
                awsAppsyncAuthenticationType: "API_KEY" | "AWS_LAMBDA" | "AWS_IAM" | "OPENID_CONNECT" | "AMAZON_COGNITO_USER_POOLS";
                awsAppsyncConflictResolutionMode?: string;
                awsAppsyncRegion: string;
            };
            version: "1";
        }, {
            payload: {
                amplifyApiModelSchemaS3Uri: string;
                awsAppsyncAdditionalAuthenticationTypes?: string;
                awsAppsyncApiEndpoint: string;
                awsAppsyncApiId: string;
                awsAppsyncApiKey?: string;
                awsAppsyncAuthenticationType: "API_KEY" | "AWS_LAMBDA" | "AWS_IAM" | "OPENID_CONNECT" | "AMAZON_COGNITO_USER_POOLS";
                awsAppsyncConflictResolutionMode?: string;
                awsAppsyncRegion: string;
            };
            version: "1";
        }>]>>;
        AWS::Amplify::Platform: ZodOptional<ZodDiscriminatedUnion<"version", [ZodObject<{
            payload: ZodObject<{
                deploymentType: ZodString;
                region: ZodString;
            }, "strip", ZodTypeAny, {
                deploymentType: string;
                region: string;
            }, {
                deploymentType: string;
                region: string;
            }>;
            version: ZodLiteral<"1">;
        }, "strip", ZodTypeAny, {
            payload: {
                deploymentType: string;
                region: string;
            };
            version: "1";
        }, {
            payload: {
                deploymentType: string;
                region: string;
            };
            version: "1";
        }>]>>;
        AWS::Amplify::Storage: ZodOptional<ZodDiscriminatedUnion<"version", [ZodObject<{
            payload: ZodObject<{
                bucketName: ZodString;
                buckets: ZodOptional<ZodString>;
                storageRegion: ZodString;
            }, "strip", ZodTypeAny, {
                bucketName: string;
                buckets?: string;
                storageRegion: string;
            }, {
                bucketName: string;
                buckets?: string;
                storageRegion: string;
            }>;
            version: ZodLiteral<"1">;
        }, "strip", ZodTypeAny, {
            payload: {
                bucketName: string;
                buckets?: string;
                storageRegion: string;
            };
            version: "1";
        }, {
            payload: {
                bucketName: string;
                buckets?: string;
                storageRegion: string;
            };
            version: "1";
        }>]>>;
    }, "strip", ZodTypeAny, {
        AWS::Amplify::Auth?: {
            payload: {
                allowUnauthenticatedIdentities?: string;
                authRegion: string;
                identityPoolId: string;
                mfaConfiguration?: string;
                mfaTypes?: string;
                oauthClientId?: string;
                oauthCognitoDomain?: string;
                oauthRedirectSignIn?: string;
                oauthRedirectSignOut?: string;
                oauthResponseType?: string;
                oauthScope?: string;
                passwordPolicyMinLength?: string;
                passwordPolicyRequirements?: string;
                signupAttributes?: string;
                socialProviders?: string;
                userPoolId: string;
                usernameAttributes?: string;
                verificationMechanisms?: string;
                webClientId: string;
            };
            version: "1";
        };
        AWS::Amplify::Custom?: {
            payload: {
                customOutputs: string;
            };
            version: "1";
        };
        AWS::Amplify::Function?: {
            payload: {
                definedFunctions: string;
            };
            version: "1";
        };
        AWS::Amplify::GraphQL?: {
            payload: {
                amplifyApiModelSchemaS3Uri: string;
                awsAppsyncAdditionalAuthenticationTypes?: string;
                awsAppsyncApiEndpoint: string;
                awsAppsyncApiId: string;
                awsAppsyncApiKey?: string;
                awsAppsyncAuthenticationType: "API_KEY" | "AWS_LAMBDA" | "AWS_IAM" | "OPENID_CONNECT" | "AMAZON_COGNITO_USER_POOLS";
                awsAppsyncConflictResolutionMode?: string;
                awsAppsyncRegion: string;
            };
            version: "1";
        };
        AWS::Amplify::Platform?: {
            payload: {
                deploymentType: string;
                region: string;
            };
            version: "1";
        };
        AWS::Amplify::Storage?: {
            payload: {
                bucketName: string;
                buckets?: string;
                storageRegion: string;
            };
            version: "1";
        };
    }, {
        AWS::Amplify::Auth?: {
            payload: {
                allowUnauthenticatedIdentities?: string;
                authRegion: string;
                identityPoolId: string;
                mfaConfiguration?: string;
                mfaTypes?: string;
                oauthClientId?: string;
                oauthCognitoDomain?: string;
                oauthRedirectSignIn?: string;
                oauthRedirectSignOut?: string;
                oauthResponseType?: string;
                oauthScope?: string;
                passwordPolicyMinLength?: string;
                passwordPolicyRequirements?: string;
                signupAttributes?: string;
                socialProviders?: string;
                userPoolId: string;
                usernameAttributes?: string;
                verificationMechanisms?: string;
                webClientId: string;
            };
            version: "1";
        };
        AWS::Amplify::Custom?: {
            payload: {
                customOutputs: string;
            };
            version: "1";
        };
        AWS::Amplify::Function?: {
            payload: {
                definedFunctions: string;
            };
            version: "1";
        };
        AWS::Amplify::GraphQL?: {
            payload: {
                amplifyApiModelSchemaS3Uri: string;
                awsAppsyncAdditionalAuthenticationTypes?: string;
                awsAppsyncApiEndpoint: string;
                awsAppsyncApiId: string;
                awsAppsyncApiKey?: string;
                awsAppsyncAuthenticationType: "API_KEY" | "AWS_LAMBDA" | "AWS_IAM" | "OPENID_CONNECT" | "AMAZON_COGNITO_USER_POOLS";
                awsAppsyncConflictResolutionMode?: string;
                awsAppsyncRegion: string;
            };
            version: "1";
        };
        AWS::Amplify::Platform?: {
            payload: {
                deploymentType: string;
                region: string;
            };
            version: "1";
        };
        AWS::Amplify::Storage?: {
            payload: {
                bucketName: string;
                buckets?: string;
                storageRegion: string;
            };
            version: "1";
        };
    }> = ...

    Defines the unified expected shape of Amplify backend output. As new constructs are added that need to contribute backend output, entries should be added here so that client config generation is aware of these outputs

    -

    Type declaration

    • AWS::Amplify::Auth: ZodOptional<ZodDiscriminatedUnion<"version", [ZodObject<{
          payload: ZodObject<{
              allowUnauthenticatedIdentities: ZodOptional<ZodString>;
              authRegion: ZodString;
              identityPoolId: ZodString;
              mfaConfiguration: ZodOptional<ZodString>;
              mfaTypes: ZodOptional<ZodString>;
              oauthClientId: ZodOptional<ZodString>;
              oauthCognitoDomain: ZodOptional<ZodString>;
              oauthRedirectSignIn: ZodOptional<ZodString>;
              oauthRedirectSignOut: ZodOptional<ZodString>;
              oauthResponseType: ZodOptional<ZodString>;
              oauthScope: ZodOptional<ZodString>;
              passwordPolicyMinLength: ZodOptional<ZodString>;
              passwordPolicyRequirements: ZodOptional<ZodString>;
              signupAttributes: ZodOptional<ZodString>;
              socialProviders: ZodOptional<ZodString>;
              userPoolId: ZodString;
              usernameAttributes: ZodOptional<ZodString>;
              verificationMechanisms: ZodOptional<ZodString>;
              webClientId: ZodString;
          }, "strip", ZodTypeAny, {
              allowUnauthenticatedIdentities?: string;
              authRegion: string;
              identityPoolId: string;
              mfaConfiguration?: string;
              mfaTypes?: string;
              oauthClientId?: string;
              oauthCognitoDomain?: string;
              oauthRedirectSignIn?: string;
              oauthRedirectSignOut?: string;
              oauthResponseType?: string;
              oauthScope?: string;
              passwordPolicyMinLength?: string;
              passwordPolicyRequirements?: string;
              signupAttributes?: string;
              socialProviders?: string;
              userPoolId: string;
              usernameAttributes?: string;
              verificationMechanisms?: string;
              webClientId: string;
          }, {
              allowUnauthenticatedIdentities?: string;
              authRegion: string;
              identityPoolId: string;
              mfaConfiguration?: string;
              mfaTypes?: string;
              oauthClientId?: string;
              oauthCognitoDomain?: string;
              oauthRedirectSignIn?: string;
              oauthRedirectSignOut?: string;
              oauthResponseType?: string;
              oauthScope?: string;
              passwordPolicyMinLength?: string;
              passwordPolicyRequirements?: string;
              signupAttributes?: string;
              socialProviders?: string;
              userPoolId: string;
              usernameAttributes?: string;
              verificationMechanisms?: string;
              webClientId: string;
          }>;
          version: ZodLiteral<"1">;
      }, "strip", ZodTypeAny, {
          payload: {
              allowUnauthenticatedIdentities?: string;
              authRegion: string;
              identityPoolId: string;
              mfaConfiguration?: string;
              mfaTypes?: string;
              oauthClientId?: string;
              oauthCognitoDomain?: string;
              oauthRedirectSignIn?: string;
              oauthRedirectSignOut?: string;
              oauthResponseType?: string;
              oauthScope?: string;
              passwordPolicyMinLength?: string;
              passwordPolicyRequirements?: string;
              signupAttributes?: string;
              socialProviders?: string;
              userPoolId: string;
              usernameAttributes?: string;
              verificationMechanisms?: string;
              webClientId: string;
          };
          version: "1";
      }, {
          payload: {
              allowUnauthenticatedIdentities?: string;
              authRegion: string;
              identityPoolId: string;
              mfaConfiguration?: string;
              mfaTypes?: string;
              oauthClientId?: string;
              oauthCognitoDomain?: string;
              oauthRedirectSignIn?: string;
              oauthRedirectSignOut?: string;
              oauthResponseType?: string;
              oauthScope?: string;
              passwordPolicyMinLength?: string;
              passwordPolicyRequirements?: string;
              signupAttributes?: string;
              socialProviders?: string;
              userPoolId: string;
              usernameAttributes?: string;
              verificationMechanisms?: string;
              webClientId: string;
          };
          version: "1";
      }>]>>
    • AWS::Amplify::Custom: ZodOptional<ZodDiscriminatedUnion<"version", [ZodObject<{
          payload: ZodObject<{
              customOutputs: ZodString;
          }, "strip", ZodTypeAny, {
              customOutputs: string;
          }, {
              customOutputs: string;
          }>;
          version: ZodLiteral<"1">;
      }, "strip", ZodTypeAny, {
          payload: {
              customOutputs: string;
          };
          version: "1";
      }, {
          payload: {
              customOutputs: string;
          };
          version: "1";
      }>]>>
    • AWS::Amplify::Function: ZodOptional<ZodDiscriminatedUnion<"version", [ZodObject<{
          payload: ZodObject<{
              definedFunctions: ZodString;
          }, "strip", ZodTypeAny, {
              definedFunctions: string;
          }, {
              definedFunctions: string;
          }>;
          version: ZodLiteral<"1">;
      }, "strip", ZodTypeAny, {
          payload: {
              definedFunctions: string;
          };
          version: "1";
      }, {
          payload: {
              definedFunctions: string;
          };
          version: "1";
      }>]>>
    • AWS::Amplify::GraphQL: ZodOptional<ZodDiscriminatedUnion<"version", [ZodObject<{
          payload: ZodObject<{
              amplifyApiModelSchemaS3Uri: ZodString;
              awsAppsyncAdditionalAuthenticationTypes: ZodOptional<ZodString>;
              awsAppsyncApiEndpoint: ZodString;
              awsAppsyncApiId: ZodString;
              awsAppsyncApiKey: ZodOptional<ZodString>;
              awsAppsyncAuthenticationType: ZodEnum<[(...), (...), (...), (...), (...)]>;
              awsAppsyncConflictResolutionMode: ZodOptional<ZodString>;
              awsAppsyncRegion: ZodString;
          }, "strip", ZodTypeAny, {
              amplifyApiModelSchemaS3Uri: string;
              awsAppsyncAdditionalAuthenticationTypes?: string;
              awsAppsyncApiEndpoint: string;
              awsAppsyncApiId: string;
              awsAppsyncApiKey?: string;
              awsAppsyncAuthenticationType: "API_KEY" | "AWS_LAMBDA" | "AWS_IAM" | "OPENID_CONNECT" | "AMAZON_COGNITO_USER_POOLS";
              awsAppsyncConflictResolutionMode?: string;
              awsAppsyncRegion: string;
          }, {
              amplifyApiModelSchemaS3Uri: string;
              awsAppsyncAdditionalAuthenticationTypes?: string;
              awsAppsyncApiEndpoint: string;
              awsAppsyncApiId: string;
              awsAppsyncApiKey?: string;
              awsAppsyncAuthenticationType: "API_KEY" | "AWS_LAMBDA" | "AWS_IAM" | "OPENID_CONNECT" | "AMAZON_COGNITO_USER_POOLS";
              awsAppsyncConflictResolutionMode?: string;
              awsAppsyncRegion: string;
          }>;
          version: ZodLiteral<"1">;
      }, "strip", ZodTypeAny, {
          payload: {
              amplifyApiModelSchemaS3Uri: string;
              awsAppsyncAdditionalAuthenticationTypes?: string;
              awsAppsyncApiEndpoint: string;
              awsAppsyncApiId: string;
              awsAppsyncApiKey?: string;
              awsAppsyncAuthenticationType: "API_KEY" | "AWS_LAMBDA" | "AWS_IAM" | "OPENID_CONNECT" | "AMAZON_COGNITO_USER_POOLS";
              awsAppsyncConflictResolutionMode?: string;
              awsAppsyncRegion: string;
          };
          version: "1";
      }, {
          payload: {
              amplifyApiModelSchemaS3Uri: string;
              awsAppsyncAdditionalAuthenticationTypes?: string;
              awsAppsyncApiEndpoint: string;
              awsAppsyncApiId: string;
              awsAppsyncApiKey?: string;
              awsAppsyncAuthenticationType: "API_KEY" | "AWS_LAMBDA" | "AWS_IAM" | "OPENID_CONNECT" | "AMAZON_COGNITO_USER_POOLS";
              awsAppsyncConflictResolutionMode?: string;
              awsAppsyncRegion: string;
          };
          version: "1";
      }>]>>
    • AWS::Amplify::Platform: ZodOptional<ZodDiscriminatedUnion<"version", [ZodObject<{
          payload: ZodObject<{
              deploymentType: ZodString;
              region: ZodString;
          }, "strip", ZodTypeAny, {
              deploymentType: string;
              region: string;
          }, {
              deploymentType: string;
              region: string;
          }>;
          version: ZodLiteral<"1">;
      }, "strip", ZodTypeAny, {
          payload: {
              deploymentType: string;
              region: string;
          };
          version: "1";
      }, {
          payload: {
              deploymentType: string;
              region: string;
          };
          version: "1";
      }>]>>
    • AWS::Amplify::Storage: ZodOptional<ZodDiscriminatedUnion<"version", [ZodObject<{
          payload: ZodObject<{
              bucketName: ZodString;
              buckets: ZodOptional<ZodString>;
              storageRegion: ZodString;
          }, "strip", ZodTypeAny, {
              bucketName: string;
              buckets?: string;
              storageRegion: string;
          }, {
              bucketName: string;
              buckets?: string;
              storageRegion: string;
          }>;
          version: ZodLiteral<"1">;
      }, "strip", ZodTypeAny, {
          payload: {
              bucketName: string;
              buckets?: string;
              storageRegion: string;
          };
          version: "1";
      }, {
          payload: {
              bucketName: string;
              buckets?: string;
              storageRegion: string;
          };
          version: "1";
      }>]>>

    Type declaration

    • Optional AWS::Amplify::Auth?: {
          payload: {
              allowUnauthenticatedIdentities?: string;
              authRegion: string;
              identityPoolId: string;
              mfaConfiguration?: string;
              mfaTypes?: string;
              oauthClientId?: string;
              oauthCognitoDomain?: string;
              oauthRedirectSignIn?: string;
              oauthRedirectSignOut?: string;
              oauthResponseType?: string;
              oauthScope?: string;
              passwordPolicyMinLength?: string;
              passwordPolicyRequirements?: string;
              signupAttributes?: string;
              socialProviders?: string;
              userPoolId: string;
              usernameAttributes?: string;
              verificationMechanisms?: string;
              webClientId: string;
          };
          version: "1";
      }
      • payload: {
            allowUnauthenticatedIdentities?: string;
            authRegion: string;
            identityPoolId: string;
            mfaConfiguration?: string;
            mfaTypes?: string;
            oauthClientId?: string;
            oauthCognitoDomain?: string;
            oauthRedirectSignIn?: string;
            oauthRedirectSignOut?: string;
            oauthResponseType?: string;
            oauthScope?: string;
            passwordPolicyMinLength?: string;
            passwordPolicyRequirements?: string;
            signupAttributes?: string;
            socialProviders?: string;
            userPoolId: string;
            usernameAttributes?: string;
            verificationMechanisms?: string;
            webClientId: string;
        }
        • Optional allowUnauthenticatedIdentities?: string
        • authRegion: string
        • identityPoolId: string
        • Optional mfaConfiguration?: string
        • Optional mfaTypes?: string
        • Optional oauthClientId?: string
        • Optional oauthCognitoDomain?: string
        • Optional oauthRedirectSignIn?: string
        • Optional oauthRedirectSignOut?: string
        • Optional oauthResponseType?: string
        • Optional oauthScope?: string
        • Optional passwordPolicyMinLength?: string
        • Optional passwordPolicyRequirements?: string
        • Optional signupAttributes?: string
        • Optional socialProviders?: string
        • userPoolId: string
        • Optional usernameAttributes?: string
        • Optional verificationMechanisms?: string
        • webClientId: string
      • version: "1"
    • Optional AWS::Amplify::Custom?: {
          payload: {
              customOutputs: string;
          };
          version: "1";
      }
      • payload: {
            customOutputs: string;
        }
        • customOutputs: string
      • version: "1"
    • Optional AWS::Amplify::Function?: {
          payload: {
              definedFunctions: string;
          };
          version: "1";
      }
      • payload: {
            definedFunctions: string;
        }
        • definedFunctions: string
      • version: "1"
    • Optional AWS::Amplify::GraphQL?: {
          payload: {
              amplifyApiModelSchemaS3Uri: string;
              awsAppsyncAdditionalAuthenticationTypes?: string;
              awsAppsyncApiEndpoint: string;
              awsAppsyncApiId: string;
              awsAppsyncApiKey?: string;
              awsAppsyncAuthenticationType: "API_KEY" | "AWS_LAMBDA" | "AWS_IAM" | "OPENID_CONNECT" | "AMAZON_COGNITO_USER_POOLS";
              awsAppsyncConflictResolutionMode?: string;
              awsAppsyncRegion: string;
          };
          version: "1";
      }
      • payload: {
            amplifyApiModelSchemaS3Uri: string;
            awsAppsyncAdditionalAuthenticationTypes?: string;
            awsAppsyncApiEndpoint: string;
            awsAppsyncApiId: string;
            awsAppsyncApiKey?: string;
            awsAppsyncAuthenticationType: "API_KEY" | "AWS_LAMBDA" | "AWS_IAM" | "OPENID_CONNECT" | "AMAZON_COGNITO_USER_POOLS";
            awsAppsyncConflictResolutionMode?: string;
            awsAppsyncRegion: string;
        }
        • amplifyApiModelSchemaS3Uri: string
        • Optional awsAppsyncAdditionalAuthenticationTypes?: string
        • awsAppsyncApiEndpoint: string
        • awsAppsyncApiId: string
        • Optional awsAppsyncApiKey?: string
        • awsAppsyncAuthenticationType: "API_KEY" | "AWS_LAMBDA" | "AWS_IAM" | "OPENID_CONNECT" | "AMAZON_COGNITO_USER_POOLS"
        • Optional awsAppsyncConflictResolutionMode?: string
        • awsAppsyncRegion: string
      • version: "1"
    • Optional AWS::Amplify::Platform?: {
          payload: {
              deploymentType: string;
              region: string;
          };
          version: "1";
      }
      • payload: {
            deploymentType: string;
            region: string;
        }
        • deploymentType: string
        • region: string
      • version: "1"
    • Optional AWS::Amplify::Storage?: {
          payload: {
              bucketName: string;
              buckets?: string;
              storageRegion: string;
          };
          version: "1";
      }
      • payload: {
            bucketName: string;
            buckets?: string;
            storageRegion: string;
        }
        • bucketName: string
        • Optional buckets?: string
        • storageRegion: string
      • version: "1"

    Type declaration

    • Optional AWS::Amplify::Auth?: {
          payload: {
              allowUnauthenticatedIdentities?: string;
              authRegion: string;
              identityPoolId: string;
              mfaConfiguration?: string;
              mfaTypes?: string;
              oauthClientId?: string;
              oauthCognitoDomain?: string;
              oauthRedirectSignIn?: string;
              oauthRedirectSignOut?: string;
              oauthResponseType?: string;
              oauthScope?: string;
              passwordPolicyMinLength?: string;
              passwordPolicyRequirements?: string;
              signupAttributes?: string;
              socialProviders?: string;
              userPoolId: string;
              usernameAttributes?: string;
              verificationMechanisms?: string;
              webClientId: string;
          };
          version: "1";
      }
      • payload: {
            allowUnauthenticatedIdentities?: string;
            authRegion: string;
            identityPoolId: string;
            mfaConfiguration?: string;
            mfaTypes?: string;
            oauthClientId?: string;
            oauthCognitoDomain?: string;
            oauthRedirectSignIn?: string;
            oauthRedirectSignOut?: string;
            oauthResponseType?: string;
            oauthScope?: string;
            passwordPolicyMinLength?: string;
            passwordPolicyRequirements?: string;
            signupAttributes?: string;
            socialProviders?: string;
            userPoolId: string;
            usernameAttributes?: string;
            verificationMechanisms?: string;
            webClientId: string;
        }
        • Optional allowUnauthenticatedIdentities?: string
        • authRegion: string
        • identityPoolId: string
        • Optional mfaConfiguration?: string
        • Optional mfaTypes?: string
        • Optional oauthClientId?: string
        • Optional oauthCognitoDomain?: string
        • Optional oauthRedirectSignIn?: string
        • Optional oauthRedirectSignOut?: string
        • Optional oauthResponseType?: string
        • Optional oauthScope?: string
        • Optional passwordPolicyMinLength?: string
        • Optional passwordPolicyRequirements?: string
        • Optional signupAttributes?: string
        • Optional socialProviders?: string
        • userPoolId: string
        • Optional usernameAttributes?: string
        • Optional verificationMechanisms?: string
        • webClientId: string
      • version: "1"
    • Optional AWS::Amplify::Custom?: {
          payload: {
              customOutputs: string;
          };
          version: "1";
      }
      • payload: {
            customOutputs: string;
        }
        • customOutputs: string
      • version: "1"
    • Optional AWS::Amplify::Function?: {
          payload: {
              definedFunctions: string;
          };
          version: "1";
      }
      • payload: {
            definedFunctions: string;
        }
        • definedFunctions: string
      • version: "1"
    • Optional AWS::Amplify::GraphQL?: {
          payload: {
              amplifyApiModelSchemaS3Uri: string;
              awsAppsyncAdditionalAuthenticationTypes?: string;
              awsAppsyncApiEndpoint: string;
              awsAppsyncApiId: string;
              awsAppsyncApiKey?: string;
              awsAppsyncAuthenticationType: "API_KEY" | "AWS_LAMBDA" | "AWS_IAM" | "OPENID_CONNECT" | "AMAZON_COGNITO_USER_POOLS";
              awsAppsyncConflictResolutionMode?: string;
              awsAppsyncRegion: string;
          };
          version: "1";
      }
      • payload: {
            amplifyApiModelSchemaS3Uri: string;
            awsAppsyncAdditionalAuthenticationTypes?: string;
            awsAppsyncApiEndpoint: string;
            awsAppsyncApiId: string;
            awsAppsyncApiKey?: string;
            awsAppsyncAuthenticationType: "API_KEY" | "AWS_LAMBDA" | "AWS_IAM" | "OPENID_CONNECT" | "AMAZON_COGNITO_USER_POOLS";
            awsAppsyncConflictResolutionMode?: string;
            awsAppsyncRegion: string;
        }
        • amplifyApiModelSchemaS3Uri: string
        • Optional awsAppsyncAdditionalAuthenticationTypes?: string
        • awsAppsyncApiEndpoint: string
        • awsAppsyncApiId: string
        • Optional awsAppsyncApiKey?: string
        • awsAppsyncAuthenticationType: "API_KEY" | "AWS_LAMBDA" | "AWS_IAM" | "OPENID_CONNECT" | "AMAZON_COGNITO_USER_POOLS"
        • Optional awsAppsyncConflictResolutionMode?: string
        • awsAppsyncRegion: string
      • version: "1"
    • Optional AWS::Amplify::Platform?: {
          payload: {
              deploymentType: string;
              region: string;
          };
          version: "1";
      }
      • payload: {
            deploymentType: string;
            region: string;
        }
        • deploymentType: string
        • region: string
      • version: "1"
    • Optional AWS::Amplify::Storage?: {
          payload: {
              bucketName: string;
              buckets?: string;
              storageRegion: string;
          };
          version: "1";
      }
      • payload: {
            bucketName: string;
            buckets?: string;
            storageRegion: string;
        }
        • bucketName: string
        • Optional buckets?: string
        • storageRegion: string
      • version: "1"
    \ No newline at end of file +

    Type declaration

    • AWS::Amplify::Auth: ZodOptional<ZodDiscriminatedUnion<"version", [ZodObject<{
          payload: ZodObject<{
              allowUnauthenticatedIdentities: ZodOptional<ZodString>;
              authRegion: ZodString;
              identityPoolId: ZodString;
              mfaConfiguration: ZodOptional<ZodString>;
              mfaTypes: ZodOptional<ZodString>;
              oauthClientId: ZodOptional<ZodString>;
              oauthCognitoDomain: ZodOptional<ZodString>;
              oauthRedirectSignIn: ZodOptional<ZodString>;
              oauthRedirectSignOut: ZodOptional<ZodString>;
              oauthResponseType: ZodOptional<ZodString>;
              oauthScope: ZodOptional<ZodString>;
              passwordPolicyMinLength: ZodOptional<ZodString>;
              passwordPolicyRequirements: ZodOptional<ZodString>;
              signupAttributes: ZodOptional<ZodString>;
              socialProviders: ZodOptional<ZodString>;
              userPoolId: ZodString;
              usernameAttributes: ZodOptional<ZodString>;
              verificationMechanisms: ZodOptional<ZodString>;
              webClientId: ZodString;
          }, "strip", ZodTypeAny, {
              allowUnauthenticatedIdentities?: string;
              authRegion: string;
              identityPoolId: string;
              mfaConfiguration?: string;
              mfaTypes?: string;
              oauthClientId?: string;
              oauthCognitoDomain?: string;
              oauthRedirectSignIn?: string;
              oauthRedirectSignOut?: string;
              oauthResponseType?: string;
              oauthScope?: string;
              passwordPolicyMinLength?: string;
              passwordPolicyRequirements?: string;
              signupAttributes?: string;
              socialProviders?: string;
              userPoolId: string;
              usernameAttributes?: string;
              verificationMechanisms?: string;
              webClientId: string;
          }, {
              allowUnauthenticatedIdentities?: string;
              authRegion: string;
              identityPoolId: string;
              mfaConfiguration?: string;
              mfaTypes?: string;
              oauthClientId?: string;
              oauthCognitoDomain?: string;
              oauthRedirectSignIn?: string;
              oauthRedirectSignOut?: string;
              oauthResponseType?: string;
              oauthScope?: string;
              passwordPolicyMinLength?: string;
              passwordPolicyRequirements?: string;
              signupAttributes?: string;
              socialProviders?: string;
              userPoolId: string;
              usernameAttributes?: string;
              verificationMechanisms?: string;
              webClientId: string;
          }>;
          version: ZodLiteral<"1">;
      }, "strip", ZodTypeAny, {
          payload: {
              allowUnauthenticatedIdentities?: string;
              authRegion: string;
              identityPoolId: string;
              mfaConfiguration?: string;
              mfaTypes?: string;
              oauthClientId?: string;
              oauthCognitoDomain?: string;
              oauthRedirectSignIn?: string;
              oauthRedirectSignOut?: string;
              oauthResponseType?: string;
              oauthScope?: string;
              passwordPolicyMinLength?: string;
              passwordPolicyRequirements?: string;
              signupAttributes?: string;
              socialProviders?: string;
              userPoolId: string;
              usernameAttributes?: string;
              verificationMechanisms?: string;
              webClientId: string;
          };
          version: "1";
      }, {
          payload: {
              allowUnauthenticatedIdentities?: string;
              authRegion: string;
              identityPoolId: string;
              mfaConfiguration?: string;
              mfaTypes?: string;
              oauthClientId?: string;
              oauthCognitoDomain?: string;
              oauthRedirectSignIn?: string;
              oauthRedirectSignOut?: string;
              oauthResponseType?: string;
              oauthScope?: string;
              passwordPolicyMinLength?: string;
              passwordPolicyRequirements?: string;
              signupAttributes?: string;
              socialProviders?: string;
              userPoolId: string;
              usernameAttributes?: string;
              verificationMechanisms?: string;
              webClientId: string;
          };
          version: "1";
      }>]>>
    • AWS::Amplify::Custom: ZodOptional<ZodDiscriminatedUnion<"version", [ZodObject<{
          payload: ZodObject<{
              customOutputs: ZodString;
          }, "strip", ZodTypeAny, {
              customOutputs: string;
          }, {
              customOutputs: string;
          }>;
          version: ZodLiteral<"1">;
      }, "strip", ZodTypeAny, {
          payload: {
              customOutputs: string;
          };
          version: "1";
      }, {
          payload: {
              customOutputs: string;
          };
          version: "1";
      }>]>>
    • AWS::Amplify::Function: ZodOptional<ZodDiscriminatedUnion<"version", [ZodObject<{
          payload: ZodObject<{
              definedFunctions: ZodString;
          }, "strip", ZodTypeAny, {
              definedFunctions: string;
          }, {
              definedFunctions: string;
          }>;
          version: ZodLiteral<"1">;
      }, "strip", ZodTypeAny, {
          payload: {
              definedFunctions: string;
          };
          version: "1";
      }, {
          payload: {
              definedFunctions: string;
          };
          version: "1";
      }>]>>
    • AWS::Amplify::GraphQL: ZodOptional<ZodDiscriminatedUnion<"version", [ZodObject<{
          payload: ZodObject<{
              amplifyApiModelSchemaS3Uri: ZodString;
              awsAppsyncAdditionalAuthenticationTypes: ZodOptional<ZodString>;
              awsAppsyncApiEndpoint: ZodString;
              awsAppsyncApiId: ZodString;
              awsAppsyncApiKey: ZodOptional<ZodString>;
              awsAppsyncAuthenticationType: ZodEnum<[(...), (...), (...), (...), (...)]>;
              awsAppsyncConflictResolutionMode: ZodOptional<ZodString>;
              awsAppsyncRegion: ZodString;
          }, "strip", ZodTypeAny, {
              amplifyApiModelSchemaS3Uri: string;
              awsAppsyncAdditionalAuthenticationTypes?: string;
              awsAppsyncApiEndpoint: string;
              awsAppsyncApiId: string;
              awsAppsyncApiKey?: string;
              awsAppsyncAuthenticationType: "API_KEY" | "AWS_LAMBDA" | "AWS_IAM" | "OPENID_CONNECT" | "AMAZON_COGNITO_USER_POOLS";
              awsAppsyncConflictResolutionMode?: string;
              awsAppsyncRegion: string;
          }, {
              amplifyApiModelSchemaS3Uri: string;
              awsAppsyncAdditionalAuthenticationTypes?: string;
              awsAppsyncApiEndpoint: string;
              awsAppsyncApiId: string;
              awsAppsyncApiKey?: string;
              awsAppsyncAuthenticationType: "API_KEY" | "AWS_LAMBDA" | "AWS_IAM" | "OPENID_CONNECT" | "AMAZON_COGNITO_USER_POOLS";
              awsAppsyncConflictResolutionMode?: string;
              awsAppsyncRegion: string;
          }>;
          version: ZodLiteral<"1">;
      }, "strip", ZodTypeAny, {
          payload: {
              amplifyApiModelSchemaS3Uri: string;
              awsAppsyncAdditionalAuthenticationTypes?: string;
              awsAppsyncApiEndpoint: string;
              awsAppsyncApiId: string;
              awsAppsyncApiKey?: string;
              awsAppsyncAuthenticationType: "API_KEY" | "AWS_LAMBDA" | "AWS_IAM" | "OPENID_CONNECT" | "AMAZON_COGNITO_USER_POOLS";
              awsAppsyncConflictResolutionMode?: string;
              awsAppsyncRegion: string;
          };
          version: "1";
      }, {
          payload: {
              amplifyApiModelSchemaS3Uri: string;
              awsAppsyncAdditionalAuthenticationTypes?: string;
              awsAppsyncApiEndpoint: string;
              awsAppsyncApiId: string;
              awsAppsyncApiKey?: string;
              awsAppsyncAuthenticationType: "API_KEY" | "AWS_LAMBDA" | "AWS_IAM" | "OPENID_CONNECT" | "AMAZON_COGNITO_USER_POOLS";
              awsAppsyncConflictResolutionMode?: string;
              awsAppsyncRegion: string;
          };
          version: "1";
      }>]>>
    • AWS::Amplify::Platform: ZodOptional<ZodDiscriminatedUnion<"version", [ZodObject<{
          payload: ZodObject<{
              deploymentType: ZodString;
              region: ZodString;
          }, "strip", ZodTypeAny, {
              deploymentType: string;
              region: string;
          }, {
              deploymentType: string;
              region: string;
          }>;
          version: ZodLiteral<"1">;
      }, "strip", ZodTypeAny, {
          payload: {
              deploymentType: string;
              region: string;
          };
          version: "1";
      }, {
          payload: {
              deploymentType: string;
              region: string;
          };
          version: "1";
      }>]>>
    • AWS::Amplify::Storage: ZodOptional<ZodDiscriminatedUnion<"version", [ZodObject<{
          payload: ZodObject<{
              bucketName: ZodString;
              buckets: ZodOptional<ZodString>;
              storageRegion: ZodString;
          }, "strip", ZodTypeAny, {
              bucketName: string;
              buckets?: string;
              storageRegion: string;
          }, {
              bucketName: string;
              buckets?: string;
              storageRegion: string;
          }>;
          version: ZodLiteral<"1">;
      }, "strip", ZodTypeAny, {
          payload: {
              bucketName: string;
              buckets?: string;
              storageRegion: string;
          };
          version: "1";
      }, {
          payload: {
              bucketName: string;
              buckets?: string;
              storageRegion: string;
          };
          version: "1";
      }>]>>

    Type declaration

    • Optional AWS::Amplify::Auth?: {
          payload: {
              allowUnauthenticatedIdentities?: string;
              authRegion: string;
              identityPoolId: string;
              mfaConfiguration?: string;
              mfaTypes?: string;
              oauthClientId?: string;
              oauthCognitoDomain?: string;
              oauthRedirectSignIn?: string;
              oauthRedirectSignOut?: string;
              oauthResponseType?: string;
              oauthScope?: string;
              passwordPolicyMinLength?: string;
              passwordPolicyRequirements?: string;
              signupAttributes?: string;
              socialProviders?: string;
              userPoolId: string;
              usernameAttributes?: string;
              verificationMechanisms?: string;
              webClientId: string;
          };
          version: "1";
      }
      • payload: {
            allowUnauthenticatedIdentities?: string;
            authRegion: string;
            identityPoolId: string;
            mfaConfiguration?: string;
            mfaTypes?: string;
            oauthClientId?: string;
            oauthCognitoDomain?: string;
            oauthRedirectSignIn?: string;
            oauthRedirectSignOut?: string;
            oauthResponseType?: string;
            oauthScope?: string;
            passwordPolicyMinLength?: string;
            passwordPolicyRequirements?: string;
            signupAttributes?: string;
            socialProviders?: string;
            userPoolId: string;
            usernameAttributes?: string;
            verificationMechanisms?: string;
            webClientId: string;
        }
        • Optional allowUnauthenticatedIdentities?: string
        • authRegion: string
        • identityPoolId: string
        • Optional mfaConfiguration?: string
        • Optional mfaTypes?: string
        • Optional oauthClientId?: string
        • Optional oauthCognitoDomain?: string
        • Optional oauthRedirectSignIn?: string
        • Optional oauthRedirectSignOut?: string
        • Optional oauthResponseType?: string
        • Optional oauthScope?: string
        • Optional passwordPolicyMinLength?: string
        • Optional passwordPolicyRequirements?: string
        • Optional signupAttributes?: string
        • Optional socialProviders?: string
        • userPoolId: string
        • Optional usernameAttributes?: string
        • Optional verificationMechanisms?: string
        • webClientId: string
      • version: "1"
    • Optional AWS::Amplify::Custom?: {
          payload: {
              customOutputs: string;
          };
          version: "1";
      }
      • payload: {
            customOutputs: string;
        }
        • customOutputs: string
      • version: "1"
    • Optional AWS::Amplify::Function?: {
          payload: {
              definedFunctions: string;
          };
          version: "1";
      }
      • payload: {
            definedFunctions: string;
        }
        • definedFunctions: string
      • version: "1"
    • Optional AWS::Amplify::GraphQL?: {
          payload: {
              amplifyApiModelSchemaS3Uri: string;
              awsAppsyncAdditionalAuthenticationTypes?: string;
              awsAppsyncApiEndpoint: string;
              awsAppsyncApiId: string;
              awsAppsyncApiKey?: string;
              awsAppsyncAuthenticationType: "API_KEY" | "AWS_LAMBDA" | "AWS_IAM" | "OPENID_CONNECT" | "AMAZON_COGNITO_USER_POOLS";
              awsAppsyncConflictResolutionMode?: string;
              awsAppsyncRegion: string;
          };
          version: "1";
      }
      • payload: {
            amplifyApiModelSchemaS3Uri: string;
            awsAppsyncAdditionalAuthenticationTypes?: string;
            awsAppsyncApiEndpoint: string;
            awsAppsyncApiId: string;
            awsAppsyncApiKey?: string;
            awsAppsyncAuthenticationType: "API_KEY" | "AWS_LAMBDA" | "AWS_IAM" | "OPENID_CONNECT" | "AMAZON_COGNITO_USER_POOLS";
            awsAppsyncConflictResolutionMode?: string;
            awsAppsyncRegion: string;
        }
        • amplifyApiModelSchemaS3Uri: string
        • Optional awsAppsyncAdditionalAuthenticationTypes?: string
        • awsAppsyncApiEndpoint: string
        • awsAppsyncApiId: string
        • Optional awsAppsyncApiKey?: string
        • awsAppsyncAuthenticationType: "API_KEY" | "AWS_LAMBDA" | "AWS_IAM" | "OPENID_CONNECT" | "AMAZON_COGNITO_USER_POOLS"
        • Optional awsAppsyncConflictResolutionMode?: string
        • awsAppsyncRegion: string
      • version: "1"
    • Optional AWS::Amplify::Platform?: {
          payload: {
              deploymentType: string;
              region: string;
          };
          version: "1";
      }
      • payload: {
            deploymentType: string;
            region: string;
        }
        • deploymentType: string
        • region: string
      • version: "1"
    • Optional AWS::Amplify::Storage?: {
          payload: {
              bucketName: string;
              buckets?: string;
              storageRegion: string;
          };
          version: "1";
      }
      • payload: {
            bucketName: string;
            buckets?: string;
            storageRegion: string;
        }
        • bucketName: string
        • Optional buckets?: string
        • storageRegion: string
      • version: "1"

    Type declaration

    • Optional AWS::Amplify::Auth?: {
          payload: {
              allowUnauthenticatedIdentities?: string;
              authRegion: string;
              identityPoolId: string;
              mfaConfiguration?: string;
              mfaTypes?: string;
              oauthClientId?: string;
              oauthCognitoDomain?: string;
              oauthRedirectSignIn?: string;
              oauthRedirectSignOut?: string;
              oauthResponseType?: string;
              oauthScope?: string;
              passwordPolicyMinLength?: string;
              passwordPolicyRequirements?: string;
              signupAttributes?: string;
              socialProviders?: string;
              userPoolId: string;
              usernameAttributes?: string;
              verificationMechanisms?: string;
              webClientId: string;
          };
          version: "1";
      }
      • payload: {
            allowUnauthenticatedIdentities?: string;
            authRegion: string;
            identityPoolId: string;
            mfaConfiguration?: string;
            mfaTypes?: string;
            oauthClientId?: string;
            oauthCognitoDomain?: string;
            oauthRedirectSignIn?: string;
            oauthRedirectSignOut?: string;
            oauthResponseType?: string;
            oauthScope?: string;
            passwordPolicyMinLength?: string;
            passwordPolicyRequirements?: string;
            signupAttributes?: string;
            socialProviders?: string;
            userPoolId: string;
            usernameAttributes?: string;
            verificationMechanisms?: string;
            webClientId: string;
        }
        • Optional allowUnauthenticatedIdentities?: string
        • authRegion: string
        • identityPoolId: string
        • Optional mfaConfiguration?: string
        • Optional mfaTypes?: string
        • Optional oauthClientId?: string
        • Optional oauthCognitoDomain?: string
        • Optional oauthRedirectSignIn?: string
        • Optional oauthRedirectSignOut?: string
        • Optional oauthResponseType?: string
        • Optional oauthScope?: string
        • Optional passwordPolicyMinLength?: string
        • Optional passwordPolicyRequirements?: string
        • Optional signupAttributes?: string
        • Optional socialProviders?: string
        • userPoolId: string
        • Optional usernameAttributes?: string
        • Optional verificationMechanisms?: string
        • webClientId: string
      • version: "1"
    • Optional AWS::Amplify::Custom?: {
          payload: {
              customOutputs: string;
          };
          version: "1";
      }
      • payload: {
            customOutputs: string;
        }
        • customOutputs: string
      • version: "1"
    • Optional AWS::Amplify::Function?: {
          payload: {
              definedFunctions: string;
          };
          version: "1";
      }
      • payload: {
            definedFunctions: string;
        }
        • definedFunctions: string
      • version: "1"
    • Optional AWS::Amplify::GraphQL?: {
          payload: {
              amplifyApiModelSchemaS3Uri: string;
              awsAppsyncAdditionalAuthenticationTypes?: string;
              awsAppsyncApiEndpoint: string;
              awsAppsyncApiId: string;
              awsAppsyncApiKey?: string;
              awsAppsyncAuthenticationType: "API_KEY" | "AWS_LAMBDA" | "AWS_IAM" | "OPENID_CONNECT" | "AMAZON_COGNITO_USER_POOLS";
              awsAppsyncConflictResolutionMode?: string;
              awsAppsyncRegion: string;
          };
          version: "1";
      }
      • payload: {
            amplifyApiModelSchemaS3Uri: string;
            awsAppsyncAdditionalAuthenticationTypes?: string;
            awsAppsyncApiEndpoint: string;
            awsAppsyncApiId: string;
            awsAppsyncApiKey?: string;
            awsAppsyncAuthenticationType: "API_KEY" | "AWS_LAMBDA" | "AWS_IAM" | "OPENID_CONNECT" | "AMAZON_COGNITO_USER_POOLS";
            awsAppsyncConflictResolutionMode?: string;
            awsAppsyncRegion: string;
        }
        • amplifyApiModelSchemaS3Uri: string
        • Optional awsAppsyncAdditionalAuthenticationTypes?: string
        • awsAppsyncApiEndpoint: string
        • awsAppsyncApiId: string
        • Optional awsAppsyncApiKey?: string
        • awsAppsyncAuthenticationType: "API_KEY" | "AWS_LAMBDA" | "AWS_IAM" | "OPENID_CONNECT" | "AMAZON_COGNITO_USER_POOLS"
        • Optional awsAppsyncConflictResolutionMode?: string
        • awsAppsyncRegion: string
      • version: "1"
    • Optional AWS::Amplify::Platform?: {
          payload: {
              deploymentType: string;
              region: string;
          };
          version: "1";
      }
      • payload: {
            deploymentType: string;
            region: string;
        }
        • deploymentType: string
        • region: string
      • version: "1"
    • Optional AWS::Amplify::Storage?: {
          payload: {
              bucketName: string;
              buckets?: string;
              storageRegion: string;
          };
          version: "1";
      }
      • payload: {
            bucketName: string;
            buckets?: string;
            storageRegion: string;
        }
        • bucketName: string
        • Optional buckets?: string
        • storageRegion: string
      • version: "1"
    \ No newline at end of file diff --git a/variables/_aws_amplify_backend_output_schemas.versionedAuthOutputSchema.html b/variables/_aws_amplify_backend_output_schemas.versionedAuthOutputSchema.html index 576be9c9c8..cf2e9fc9d3 100644 --- a/variables/_aws_amplify_backend_output_schemas.versionedAuthOutputSchema.html +++ b/variables/_aws_amplify_backend_output_schemas.versionedAuthOutputSchema.html @@ -1 +1 @@ -versionedAuthOutputSchema | Amplify Toolbox
    versionedAuthOutputSchema: ZodDiscriminatedUnion<"version", [ZodObject<{
        payload: ZodObject<{
            allowUnauthenticatedIdentities: ZodOptional<ZodString>;
            authRegion: ZodString;
            identityPoolId: ZodString;
            mfaConfiguration: ZodOptional<ZodString>;
            mfaTypes: ZodOptional<ZodString>;
            oauthClientId: ZodOptional<ZodString>;
            oauthCognitoDomain: ZodOptional<ZodString>;
            oauthRedirectSignIn: ZodOptional<ZodString>;
            oauthRedirectSignOut: ZodOptional<ZodString>;
            oauthResponseType: ZodOptional<ZodString>;
            oauthScope: ZodOptional<ZodString>;
            passwordPolicyMinLength: ZodOptional<ZodString>;
            passwordPolicyRequirements: ZodOptional<ZodString>;
            signupAttributes: ZodOptional<ZodString>;
            socialProviders: ZodOptional<ZodString>;
            userPoolId: ZodString;
            usernameAttributes: ZodOptional<ZodString>;
            verificationMechanisms: ZodOptional<ZodString>;
            webClientId: ZodString;
        }, "strip", ZodTypeAny, {
            allowUnauthenticatedIdentities?: string;
            authRegion: string;
            identityPoolId: string;
            mfaConfiguration?: string;
            mfaTypes?: string;
            oauthClientId?: string;
            oauthCognitoDomain?: string;
            oauthRedirectSignIn?: string;
            oauthRedirectSignOut?: string;
            oauthResponseType?: string;
            oauthScope?: string;
            passwordPolicyMinLength?: string;
            passwordPolicyRequirements?: string;
            signupAttributes?: string;
            socialProviders?: string;
            userPoolId: string;
            usernameAttributes?: string;
            verificationMechanisms?: string;
            webClientId: string;
        }, {
            allowUnauthenticatedIdentities?: string;
            authRegion: string;
            identityPoolId: string;
            mfaConfiguration?: string;
            mfaTypes?: string;
            oauthClientId?: string;
            oauthCognitoDomain?: string;
            oauthRedirectSignIn?: string;
            oauthRedirectSignOut?: string;
            oauthResponseType?: string;
            oauthScope?: string;
            passwordPolicyMinLength?: string;
            passwordPolicyRequirements?: string;
            signupAttributes?: string;
            socialProviders?: string;
            userPoolId: string;
            usernameAttributes?: string;
            verificationMechanisms?: string;
            webClientId: string;
        }>;
        version: ZodLiteral<"1">;
    }, "strip", ZodTypeAny, {
        payload: {
            allowUnauthenticatedIdentities?: string;
            authRegion: string;
            identityPoolId: string;
            mfaConfiguration?: string;
            mfaTypes?: string;
            oauthClientId?: string;
            oauthCognitoDomain?: string;
            oauthRedirectSignIn?: string;
            oauthRedirectSignOut?: string;
            oauthResponseType?: string;
            oauthScope?: string;
            passwordPolicyMinLength?: string;
            passwordPolicyRequirements?: string;
            signupAttributes?: string;
            socialProviders?: string;
            userPoolId: string;
            usernameAttributes?: string;
            verificationMechanisms?: string;
            webClientId: string;
        };
        version: "1";
    }, {
        payload: {
            allowUnauthenticatedIdentities?: string;
            authRegion: string;
            identityPoolId: string;
            mfaConfiguration?: string;
            mfaTypes?: string;
            oauthClientId?: string;
            oauthCognitoDomain?: string;
            oauthRedirectSignIn?: string;
            oauthRedirectSignOut?: string;
            oauthResponseType?: string;
            oauthScope?: string;
            passwordPolicyMinLength?: string;
            passwordPolicyRequirements?: string;
            signupAttributes?: string;
            socialProviders?: string;
            userPoolId: string;
            usernameAttributes?: string;
            verificationMechanisms?: string;
            webClientId: string;
        };
        version: "1";
    }>]> = ...
    \ No newline at end of file +versionedAuthOutputSchema | Amplify Toolbox
    versionedAuthOutputSchema: ZodDiscriminatedUnion<"version", [ZodObject<{
        payload: ZodObject<{
            allowUnauthenticatedIdentities: ZodOptional<ZodString>;
            authRegion: ZodString;
            identityPoolId: ZodString;
            mfaConfiguration: ZodOptional<ZodString>;
            mfaTypes: ZodOptional<ZodString>;
            oauthClientId: ZodOptional<ZodString>;
            oauthCognitoDomain: ZodOptional<ZodString>;
            oauthRedirectSignIn: ZodOptional<ZodString>;
            oauthRedirectSignOut: ZodOptional<ZodString>;
            oauthResponseType: ZodOptional<ZodString>;
            oauthScope: ZodOptional<ZodString>;
            passwordPolicyMinLength: ZodOptional<ZodString>;
            passwordPolicyRequirements: ZodOptional<ZodString>;
            signupAttributes: ZodOptional<ZodString>;
            socialProviders: ZodOptional<ZodString>;
            userPoolId: ZodString;
            usernameAttributes: ZodOptional<ZodString>;
            verificationMechanisms: ZodOptional<ZodString>;
            webClientId: ZodString;
        }, "strip", ZodTypeAny, {
            allowUnauthenticatedIdentities?: string;
            authRegion: string;
            identityPoolId: string;
            mfaConfiguration?: string;
            mfaTypes?: string;
            oauthClientId?: string;
            oauthCognitoDomain?: string;
            oauthRedirectSignIn?: string;
            oauthRedirectSignOut?: string;
            oauthResponseType?: string;
            oauthScope?: string;
            passwordPolicyMinLength?: string;
            passwordPolicyRequirements?: string;
            signupAttributes?: string;
            socialProviders?: string;
            userPoolId: string;
            usernameAttributes?: string;
            verificationMechanisms?: string;
            webClientId: string;
        }, {
            allowUnauthenticatedIdentities?: string;
            authRegion: string;
            identityPoolId: string;
            mfaConfiguration?: string;
            mfaTypes?: string;
            oauthClientId?: string;
            oauthCognitoDomain?: string;
            oauthRedirectSignIn?: string;
            oauthRedirectSignOut?: string;
            oauthResponseType?: string;
            oauthScope?: string;
            passwordPolicyMinLength?: string;
            passwordPolicyRequirements?: string;
            signupAttributes?: string;
            socialProviders?: string;
            userPoolId: string;
            usernameAttributes?: string;
            verificationMechanisms?: string;
            webClientId: string;
        }>;
        version: ZodLiteral<"1">;
    }, "strip", ZodTypeAny, {
        payload: {
            allowUnauthenticatedIdentities?: string;
            authRegion: string;
            identityPoolId: string;
            mfaConfiguration?: string;
            mfaTypes?: string;
            oauthClientId?: string;
            oauthCognitoDomain?: string;
            oauthRedirectSignIn?: string;
            oauthRedirectSignOut?: string;
            oauthResponseType?: string;
            oauthScope?: string;
            passwordPolicyMinLength?: string;
            passwordPolicyRequirements?: string;
            signupAttributes?: string;
            socialProviders?: string;
            userPoolId: string;
            usernameAttributes?: string;
            verificationMechanisms?: string;
            webClientId: string;
        };
        version: "1";
    }, {
        payload: {
            allowUnauthenticatedIdentities?: string;
            authRegion: string;
            identityPoolId: string;
            mfaConfiguration?: string;
            mfaTypes?: string;
            oauthClientId?: string;
            oauthCognitoDomain?: string;
            oauthRedirectSignIn?: string;
            oauthRedirectSignOut?: string;
            oauthResponseType?: string;
            oauthScope?: string;
            passwordPolicyMinLength?: string;
            passwordPolicyRequirements?: string;
            signupAttributes?: string;
            socialProviders?: string;
            userPoolId: string;
            usernameAttributes?: string;
            verificationMechanisms?: string;
            webClientId: string;
        };
        version: "1";
    }>]> = ...
    \ No newline at end of file diff --git a/variables/_aws_amplify_backend_output_schemas.versionedCustomOutputSchema.html b/variables/_aws_amplify_backend_output_schemas.versionedCustomOutputSchema.html index cc2361dbc8..e602ab9c67 100644 --- a/variables/_aws_amplify_backend_output_schemas.versionedCustomOutputSchema.html +++ b/variables/_aws_amplify_backend_output_schemas.versionedCustomOutputSchema.html @@ -1 +1 @@ -versionedCustomOutputSchema | Amplify Toolbox
    versionedCustomOutputSchema: ZodDiscriminatedUnion<"version", [ZodObject<{
        payload: ZodObject<{
            customOutputs: ZodString;
        }, "strip", ZodTypeAny, {
            customOutputs: string;
        }, {
            customOutputs: string;
        }>;
        version: ZodLiteral<"1">;
    }, "strip", ZodTypeAny, {
        payload: {
            customOutputs: string;
        };
        version: "1";
    }, {
        payload: {
            customOutputs: string;
        };
        version: "1";
    }>]> = ...
    \ No newline at end of file +versionedCustomOutputSchema | Amplify Toolbox
    versionedCustomOutputSchema: ZodDiscriminatedUnion<"version", [ZodObject<{
        payload: ZodObject<{
            customOutputs: ZodString;
        }, "strip", ZodTypeAny, {
            customOutputs: string;
        }, {
            customOutputs: string;
        }>;
        version: ZodLiteral<"1">;
    }, "strip", ZodTypeAny, {
        payload: {
            customOutputs: string;
        };
        version: "1";
    }, {
        payload: {
            customOutputs: string;
        };
        version: "1";
    }>]> = ...
    \ No newline at end of file diff --git a/variables/_aws_amplify_backend_output_schemas.versionedFunctionOutputSchema.html b/variables/_aws_amplify_backend_output_schemas.versionedFunctionOutputSchema.html index 4cdf628ed8..bd0963cf68 100644 --- a/variables/_aws_amplify_backend_output_schemas.versionedFunctionOutputSchema.html +++ b/variables/_aws_amplify_backend_output_schemas.versionedFunctionOutputSchema.html @@ -1 +1 @@ -versionedFunctionOutputSchema | Amplify Toolbox
    versionedFunctionOutputSchema: ZodDiscriminatedUnion<"version", [ZodObject<{
        payload: ZodObject<{
            definedFunctions: ZodString;
        }, "strip", ZodTypeAny, {
            definedFunctions: string;
        }, {
            definedFunctions: string;
        }>;
        version: ZodLiteral<"1">;
    }, "strip", ZodTypeAny, {
        payload: {
            definedFunctions: string;
        };
        version: "1";
    }, {
        payload: {
            definedFunctions: string;
        };
        version: "1";
    }>]> = ...
    \ No newline at end of file +versionedFunctionOutputSchema | Amplify Toolbox
    versionedFunctionOutputSchema: ZodDiscriminatedUnion<"version", [ZodObject<{
        payload: ZodObject<{
            definedFunctions: ZodString;
        }, "strip", ZodTypeAny, {
            definedFunctions: string;
        }, {
            definedFunctions: string;
        }>;
        version: ZodLiteral<"1">;
    }, "strip", ZodTypeAny, {
        payload: {
            definedFunctions: string;
        };
        version: "1";
    }, {
        payload: {
            definedFunctions: string;
        };
        version: "1";
    }>]> = ...
    \ No newline at end of file diff --git a/variables/_aws_amplify_backend_output_schemas.versionedGraphqlOutputSchema.html b/variables/_aws_amplify_backend_output_schemas.versionedGraphqlOutputSchema.html index 535d778657..ef35bf776f 100644 --- a/variables/_aws_amplify_backend_output_schemas.versionedGraphqlOutputSchema.html +++ b/variables/_aws_amplify_backend_output_schemas.versionedGraphqlOutputSchema.html @@ -1 +1 @@ -versionedGraphqlOutputSchema | Amplify Toolbox
    versionedGraphqlOutputSchema: ZodDiscriminatedUnion<"version", [ZodObject<{
        payload: ZodObject<{
            amplifyApiModelSchemaS3Uri: ZodString;
            awsAppsyncAdditionalAuthenticationTypes: ZodOptional<ZodString>;
            awsAppsyncApiEndpoint: ZodString;
            awsAppsyncApiId: ZodString;
            awsAppsyncApiKey: ZodOptional<ZodString>;
            awsAppsyncAuthenticationType: ZodEnum<["API_KEY", "AWS_LAMBDA", "AWS_IAM", "OPENID_CONNECT", "AMAZON_COGNITO_USER_POOLS"]>;
            awsAppsyncConflictResolutionMode: ZodOptional<ZodString>;
            awsAppsyncRegion: ZodString;
        }, "strip", ZodTypeAny, {
            amplifyApiModelSchemaS3Uri: string;
            awsAppsyncAdditionalAuthenticationTypes?: string;
            awsAppsyncApiEndpoint: string;
            awsAppsyncApiId: string;
            awsAppsyncApiKey?: string;
            awsAppsyncAuthenticationType: "API_KEY" | "AWS_LAMBDA" | "AWS_IAM" | "OPENID_CONNECT" | "AMAZON_COGNITO_USER_POOLS";
            awsAppsyncConflictResolutionMode?: string;
            awsAppsyncRegion: string;
        }, {
            amplifyApiModelSchemaS3Uri: string;
            awsAppsyncAdditionalAuthenticationTypes?: string;
            awsAppsyncApiEndpoint: string;
            awsAppsyncApiId: string;
            awsAppsyncApiKey?: string;
            awsAppsyncAuthenticationType: "API_KEY" | "AWS_LAMBDA" | "AWS_IAM" | "OPENID_CONNECT" | "AMAZON_COGNITO_USER_POOLS";
            awsAppsyncConflictResolutionMode?: string;
            awsAppsyncRegion: string;
        }>;
        version: ZodLiteral<"1">;
    }, "strip", ZodTypeAny, {
        payload: {
            amplifyApiModelSchemaS3Uri: string;
            awsAppsyncAdditionalAuthenticationTypes?: string;
            awsAppsyncApiEndpoint: string;
            awsAppsyncApiId: string;
            awsAppsyncApiKey?: string;
            awsAppsyncAuthenticationType: "API_KEY" | "AWS_LAMBDA" | "AWS_IAM" | "OPENID_CONNECT" | "AMAZON_COGNITO_USER_POOLS";
            awsAppsyncConflictResolutionMode?: string;
            awsAppsyncRegion: string;
        };
        version: "1";
    }, {
        payload: {
            amplifyApiModelSchemaS3Uri: string;
            awsAppsyncAdditionalAuthenticationTypes?: string;
            awsAppsyncApiEndpoint: string;
            awsAppsyncApiId: string;
            awsAppsyncApiKey?: string;
            awsAppsyncAuthenticationType: "API_KEY" | "AWS_LAMBDA" | "AWS_IAM" | "OPENID_CONNECT" | "AMAZON_COGNITO_USER_POOLS";
            awsAppsyncConflictResolutionMode?: string;
            awsAppsyncRegion: string;
        };
        version: "1";
    }>]> = ...
    \ No newline at end of file +versionedGraphqlOutputSchema | Amplify Toolbox
    versionedGraphqlOutputSchema: ZodDiscriminatedUnion<"version", [ZodObject<{
        payload: ZodObject<{
            amplifyApiModelSchemaS3Uri: ZodString;
            awsAppsyncAdditionalAuthenticationTypes: ZodOptional<ZodString>;
            awsAppsyncApiEndpoint: ZodString;
            awsAppsyncApiId: ZodString;
            awsAppsyncApiKey: ZodOptional<ZodString>;
            awsAppsyncAuthenticationType: ZodEnum<["API_KEY", "AWS_LAMBDA", "AWS_IAM", "OPENID_CONNECT", "AMAZON_COGNITO_USER_POOLS"]>;
            awsAppsyncConflictResolutionMode: ZodOptional<ZodString>;
            awsAppsyncRegion: ZodString;
        }, "strip", ZodTypeAny, {
            amplifyApiModelSchemaS3Uri: string;
            awsAppsyncAdditionalAuthenticationTypes?: string;
            awsAppsyncApiEndpoint: string;
            awsAppsyncApiId: string;
            awsAppsyncApiKey?: string;
            awsAppsyncAuthenticationType: "API_KEY" | "AWS_LAMBDA" | "AWS_IAM" | "OPENID_CONNECT" | "AMAZON_COGNITO_USER_POOLS";
            awsAppsyncConflictResolutionMode?: string;
            awsAppsyncRegion: string;
        }, {
            amplifyApiModelSchemaS3Uri: string;
            awsAppsyncAdditionalAuthenticationTypes?: string;
            awsAppsyncApiEndpoint: string;
            awsAppsyncApiId: string;
            awsAppsyncApiKey?: string;
            awsAppsyncAuthenticationType: "API_KEY" | "AWS_LAMBDA" | "AWS_IAM" | "OPENID_CONNECT" | "AMAZON_COGNITO_USER_POOLS";
            awsAppsyncConflictResolutionMode?: string;
            awsAppsyncRegion: string;
        }>;
        version: ZodLiteral<"1">;
    }, "strip", ZodTypeAny, {
        payload: {
            amplifyApiModelSchemaS3Uri: string;
            awsAppsyncAdditionalAuthenticationTypes?: string;
            awsAppsyncApiEndpoint: string;
            awsAppsyncApiId: string;
            awsAppsyncApiKey?: string;
            awsAppsyncAuthenticationType: "API_KEY" | "AWS_LAMBDA" | "AWS_IAM" | "OPENID_CONNECT" | "AMAZON_COGNITO_USER_POOLS";
            awsAppsyncConflictResolutionMode?: string;
            awsAppsyncRegion: string;
        };
        version: "1";
    }, {
        payload: {
            amplifyApiModelSchemaS3Uri: string;
            awsAppsyncAdditionalAuthenticationTypes?: string;
            awsAppsyncApiEndpoint: string;
            awsAppsyncApiId: string;
            awsAppsyncApiKey?: string;
            awsAppsyncAuthenticationType: "API_KEY" | "AWS_LAMBDA" | "AWS_IAM" | "OPENID_CONNECT" | "AMAZON_COGNITO_USER_POOLS";
            awsAppsyncConflictResolutionMode?: string;
            awsAppsyncRegion: string;
        };
        version: "1";
    }>]> = ...
    \ No newline at end of file diff --git a/variables/_aws_amplify_backend_output_schemas.versionedStorageOutputSchema.html b/variables/_aws_amplify_backend_output_schemas.versionedStorageOutputSchema.html index f3dfb4d5ba..a7d312125f 100644 --- a/variables/_aws_amplify_backend_output_schemas.versionedStorageOutputSchema.html +++ b/variables/_aws_amplify_backend_output_schemas.versionedStorageOutputSchema.html @@ -1 +1 @@ -versionedStorageOutputSchema | Amplify Toolbox
    versionedStorageOutputSchema: ZodDiscriminatedUnion<"version", [ZodObject<{
        payload: ZodObject<{
            bucketName: ZodString;
            buckets: ZodOptional<ZodString>;
            storageRegion: ZodString;
        }, "strip", ZodTypeAny, {
            bucketName: string;
            buckets?: string;
            storageRegion: string;
        }, {
            bucketName: string;
            buckets?: string;
            storageRegion: string;
        }>;
        version: ZodLiteral<"1">;
    }, "strip", ZodTypeAny, {
        payload: {
            bucketName: string;
            buckets?: string;
            storageRegion: string;
        };
        version: "1";
    }, {
        payload: {
            bucketName: string;
            buckets?: string;
            storageRegion: string;
        };
        version: "1";
    }>]> = ...
    \ No newline at end of file +versionedStorageOutputSchema | Amplify Toolbox
    versionedStorageOutputSchema: ZodDiscriminatedUnion<"version", [ZodObject<{
        payload: ZodObject<{
            bucketName: ZodString;
            buckets: ZodOptional<ZodString>;
            storageRegion: ZodString;
        }, "strip", ZodTypeAny, {
            bucketName: string;
            buckets?: string;
            storageRegion: string;
        }, {
            bucketName: string;
            buckets?: string;
            storageRegion: string;
        }>;
        version: ZodLiteral<"1">;
    }, "strip", ZodTypeAny, {
        payload: {
            bucketName: string;
            buckets?: string;
            storageRegion: string;
        };
        version: "1";
    }, {
        payload: {
            bucketName: string;
            buckets?: string;
            storageRegion: string;
        };
        version: "1";
    }>]> = ...
    \ No newline at end of file diff --git a/variables/_aws_amplify_cli_core.colorNames.html b/variables/_aws_amplify_cli_core.colorNames.html index 0a33055f63..5de5d71727 100644 --- a/variables/_aws_amplify_cli_core.colorNames.html +++ b/variables/_aws_amplify_cli_core.colorNames.html @@ -1 +1 @@ -colorNames | Amplify Toolbox
    colorNames: readonly ["Green", "Yellow", "Blue", "Magenta", "Cyan"] = ...
    \ No newline at end of file +colorNames | Amplify Toolbox
    colorNames: readonly ["Green", "Yellow", "Blue", "Magenta", "Cyan"] = ...
    \ No newline at end of file diff --git a/variables/_aws_amplify_cli_core.format-1.html b/variables/_aws_amplify_cli_core.format-1.html index afbc0d906a..a3b641cf71 100644 --- a/variables/_aws_amplify_cli_core.format-1.html +++ b/variables/_aws_amplify_cli_core.format-1.html @@ -1 +1 @@ -format | Amplify Toolbox
    format: Format = ...
    \ No newline at end of file +format | Amplify Toolbox
    format: Format = ...
    \ No newline at end of file diff --git a/variables/_aws_amplify_cli_core.printer-1.html b/variables/_aws_amplify_cli_core.printer-1.html index 4ec7d93391..825f4259dc 100644 --- a/variables/_aws_amplify_cli_core.printer-1.html +++ b/variables/_aws_amplify_cli_core.printer-1.html @@ -1 +1 @@ -printer | Amplify Toolbox
    printer: Printer = ...
    \ No newline at end of file +printer | Amplify Toolbox
    printer: Printer = ...
    \ No newline at end of file diff --git a/variables/_aws_amplify_client_config.DEFAULT_CLIENT_CONFIG_VERSION.html b/variables/_aws_amplify_client_config.DEFAULT_CLIENT_CONFIG_VERSION.html index b4a9ebd9c0..d61de4bccf 100644 --- a/variables/_aws_amplify_client_config.DEFAULT_CLIENT_CONFIG_VERSION.html +++ b/variables/_aws_amplify_client_config.DEFAULT_CLIENT_CONFIG_VERSION.html @@ -1 +1 @@ -DEFAULT_CLIENT_CONFIG_VERSION | Amplify Toolbox
    DEFAULT_CLIENT_CONFIG_VERSION: ClientConfigVersion = ClientConfigVersionOption.V1_1
    \ No newline at end of file +DEFAULT_CLIENT_CONFIG_VERSION | Amplify Toolbox
    DEFAULT_CLIENT_CONFIG_VERSION: ClientConfigVersion = ClientConfigVersionOption.V1_1
    \ No newline at end of file diff --git a/variables/_aws_amplify_platform_core.USAGE_DATA_TRACKING_ENABLED.html b/variables/_aws_amplify_platform_core.USAGE_DATA_TRACKING_ENABLED.html index fabee87e84..c50f0d790c 100644 --- a/variables/_aws_amplify_platform_core.USAGE_DATA_TRACKING_ENABLED.html +++ b/variables/_aws_amplify_platform_core.USAGE_DATA_TRACKING_ENABLED.html @@ -1,2 +1,2 @@ USAGE_DATA_TRACKING_ENABLED | Amplify Toolbox
    USAGE_DATA_TRACKING_ENABLED: "telemetry.enabled" = 'telemetry.enabled'

    Key to access whether user opted-in status of usage data tracking preference.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/variables/_aws_amplify_platform_core.configControllerFactory.html b/variables/_aws_amplify_platform_core.configControllerFactory.html index 3262d074c2..0e41e9bf8a 100644 --- a/variables/_aws_amplify_platform_core.configControllerFactory.html +++ b/variables/_aws_amplify_platform_core.configControllerFactory.html @@ -1 +1 @@ -configControllerFactory | Amplify Toolbox
    \ No newline at end of file +configControllerFactory | Amplify Toolbox
    \ No newline at end of file diff --git a/variables/_aws_amplify_platform_core.packageJsonSchema.html b/variables/_aws_amplify_platform_core.packageJsonSchema.html index a1a888a0c1..8d0b9b8961 100644 --- a/variables/_aws_amplify_platform_core.packageJsonSchema.html +++ b/variables/_aws_amplify_platform_core.packageJsonSchema.html @@ -1,3 +1,3 @@ packageJsonSchema | Amplify Toolbox
    packageJsonSchema: ZodObject<{
        name: ZodOptional<ZodString>;
        type: ZodOptional<ZodUnion<[ZodLiteral<"module">, ZodLiteral<"commonjs">]>>;
        version: ZodOptional<ZodString>;
    }, "strip", ZodTypeAny, {
        name?: string;
        type?: "module" | "commonjs";
        version?: string;
    }, {
        name?: string;
        type?: "module" | "commonjs";
        version?: string;
    }> = ...

    Type for package.json content.

    Add additional validation if there are other fields we need to read

    -

    Type declaration

    • name: ZodOptional<ZodString>
    • type: ZodOptional<ZodUnion<[ZodLiteral<"module">, ZodLiteral<"commonjs">]>>
    • version: ZodOptional<ZodString>

    Type declaration

    • Optional name?: string
    • Optional type?: "module" | "commonjs"
    • Optional version?: string

    Type declaration

    • Optional name?: string
    • Optional type?: "module" | "commonjs"
    • Optional version?: string
    \ No newline at end of file +

    Type declaration

    • name: ZodOptional<ZodString>
    • type: ZodOptional<ZodUnion<[ZodLiteral<"module">, ZodLiteral<"commonjs">]>>
    • version: ZodOptional<ZodString>

    Type declaration

    • Optional name?: string
    • Optional type?: "module" | "commonjs"
    • Optional version?: string

    Type declaration

    • Optional name?: string
    • Optional type?: "module" | "commonjs"
    • Optional version?: string
    \ No newline at end of file