Skip to content
AWS for Query.Farm

aws.amplifybackend.get_backend_auth

Example SQL Queries

SELECT * FROM
aws.amplifybackend.get_backend_auth
WHERE
"app_id" = 'VALUE'
AND "backend_environment_name" = 'VALUE'
AND "resource_name" = 'VALUE';

Description

Gets a backend auth details.

Table Definition

Column NameColumn Data Type
app_id Required Input Column

The app ID.

VARCHAR
backend_environment_name Required Input Column

The name of the backend environment.

VARCHAR
resource_name Required Input Column

The name of this resource.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
error

If the request fails, this error is returned.

VARCHAR
resource_config

The resource configuration for authorization requests to the backend of your Amplify project.

STRUCT(
    "auth_resources" VARCHAR,
    "identity_pool_configs" STRUCT(
        "identity_pool_name" VARCHAR,
        "unauthenticated_login" BOOLEAN
    ),
    "service" VARCHAR,
    "user_pool_configs" STRUCT(
        "forgot_password" STRUCT(
            "delivery_method" VARCHAR,
            "email_settings" STRUCT(
                "email_message" VARCHAR,
                "email_subject" VARCHAR
            ),
            "sms_settings" STRUCT(
                "sms_message" VARCHAR
            )
        ),
        "mfa" STRUCT(
            "mfa_mode" VARCHAR,
            "settings" STRUCT(
                "mfa_types" VARCHAR[],
                "sms_message" VARCHAR
            )
        ),
        "o_auth" STRUCT(
            "domain_prefix" VARCHAR,
            "o_auth_grant_type" VARCHAR,
            "o_auth_scopes" VARCHAR[],
            "redirect_sign_in_ur_is" VARCHAR[],
            "redirect_sign_out_ur_is" VARCHAR[],
            "social_provider_settings" STRUCT(
                "facebook" STRUCT(
                    "client_id" VARCHAR,
                    "client_secret" VARCHAR
                ),
                "google" STRUCT(
                    "client_id" VARCHAR,
                    "client_secret" VARCHAR
                ),
                "login_with_amazon" STRUCT(
                    "client_id" VARCHAR,
                    "client_secret" VARCHAR
                ),
                "sign_in_with_apple" STRUCT(
                    "client_id" VARCHAR,
                    "key_id" VARCHAR,
                    "private_key" VARCHAR,
                    "team_id" VARCHAR
                )
            )
        ),
        "password_policy" STRUCT(
            "additional_constraints" VARCHAR[],
            "minimum_length" DOUBLE
        ),
        "required_sign_up_attributes" VARCHAR[],
        "sign_in_method" VARCHAR,
        "user_pool_name" VARCHAR,
        "verification_message" STRUCT(
            "delivery_method" VARCHAR,
            "email_settings" STRUCT(
                "email_message" VARCHAR,
                "email_subject" VARCHAR
            ),
            "sms_settings" STRUCT(
                "sms_message" VARCHAR
            )
        )
    )
)
Show child fields
resource_config.auth_resources

Defines whether you want to configure only authentication or both authentication and authorization settings.

resource_config.identity_pool_configs

Describes the authorization configuration for the Amazon Cognito identity pool, provisioned as a part of your auth resource in the Amplify project.

Show child fields
resource_config.identity_pool_configs.identity_pool_name

Name of the Amazon Cognito identity pool used for authorization.

resource_config.identity_pool_configs.unauthenticated_login

Set to true or false based on whether you want to enable guest authorization to your Amplify app.

resource_config.service

Defines the service name to use when configuring an authentication resource in your Amplify project.

resource_config.user_pool_configs

Describes authentication configuration for the Amazon Cognito user pool, provisioned as a part of your auth resource in the Amplify project.

Show child fields
resource_config.user_pool_configs.forgot_password

(DEPRECATED) Describes the forgotten password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.

Show child fields
resource_config.user_pool_configs.forgot_password.delivery_method

(DEPRECATED) Describes which mode to use (either SMS or email) to deliver messages to app users who want to recover their password.

resource_config.user_pool_configs.forgot_password.email_settings

(DEPRECATED) The configuration for the email sent when an app user forgets their password.

Show child fields
resource_config.user_pool_configs.forgot_password.email_settings.email_message

The contents of the email message.

resource_config.user_pool_configs.forgot_password.email_settings.email_subject

The contents of the subject line of the email message.

resource_config.user_pool_configs.forgot_password.sms_settings

(DEPRECATED) The configuration for the SMS message sent when an app user forgets their password.

Show child fields
resource_config.user_pool_configs.forgot_password.sms_settings.sms_message

The contents of the SMS message.

resource_config.user_pool_configs.mfa

Describes whether to apply multi-factor authentication policies for your Amazon Cognito user pool configured as a part of your Amplify project.

Show child fields
resource_config.user_pool_configs.mfa.mfa_mode

Describes whether MFA should be [ON, OFF, or OPTIONAL] for authentication in your Amplify project.

resource_config.user_pool_configs.mfa.settings

Describes the configuration settings and methods for your Amplify app users to use MFA.

Show child fields
resource_config.user_pool_configs.mfa.settings.mfa_types[]
resource_config.user_pool_configs.mfa.settings.sms_message

The body of the SMS message.

resource_config.user_pool_configs.o_auth

Describes the OAuth policy and rules for your Amazon Cognito user pool, configured as a part of your Amplify project.

Show child fields
resource_config.user_pool_configs.o_auth.domain_prefix

The domain prefix for your Amplify app.

resource_config.user_pool_configs.o_auth.o_auth_grant_type

The OAuth grant type that you use to allow app users to authenticate from your Amplify app.

resource_config.user_pool_configs.o_auth.o_auth_scopes[]
resource_config.user_pool_configs.o_auth.redirect_sign_in_ur_is[]
resource_config.user_pool_configs.o_auth.redirect_sign_out_ur_is[]
resource_config.user_pool_configs.o_auth.social_provider_settings

The settings for using social providers to access your Amplify app.

Show child fields
resource_config.user_pool_configs.o_auth.social_provider_settings.facebook

Describes third-party social federation configurations for allowing your app users to sign in using OAuth.

Show child fields
resource_config.user_pool_configs.o_auth.social_provider_settings.facebook.client_id

Describes the client_id, which can be obtained from the third-party social federation provider.

resource_config.user_pool_configs.o_auth.social_provider_settings.facebook.client_secret

Describes the client_secret, which can be obtained from third-party social federation providers.

resource_config.user_pool_configs.o_auth.social_provider_settings.google

Describes third-party social federation configurations for allowing your app users to sign in using OAuth.

Show child fields
resource_config.user_pool_configs.o_auth.social_provider_settings.google.client_id

Describes the client_id, which can be obtained from the third-party social federation provider.

resource_config.user_pool_configs.o_auth.social_provider_settings.google.client_secret

Describes the client_secret, which can be obtained from third-party social federation providers.

resource_config.user_pool_configs.o_auth.social_provider_settings.login_with_amazon

Describes third-party social federation configurations for allowing your app users to sign in using OAuth.

Show child fields
resource_config.user_pool_configs.o_auth.social_provider_settings.login_with_amazon.client_id

Describes the client_id, which can be obtained from the third-party social federation provider.

resource_config.user_pool_configs.o_auth.social_provider_settings.login_with_amazon.client_secret

Describes the client_secret, which can be obtained from third-party social federation providers.

resource_config.user_pool_configs.o_auth.social_provider_settings.sign_in_with_apple

Describes Apple social federation configurations for allowing your app users to sign in using OAuth.

Show child fields
resource_config.user_pool_configs.o_auth.social_provider_settings.sign_in_with_apple.client_id

Describes the client_id (also called Services ID) that comes from Apple.

resource_config.user_pool_configs.o_auth.social_provider_settings.sign_in_with_apple.key_id

Describes the key_id that comes from Apple.

resource_config.user_pool_configs.o_auth.social_provider_settings.sign_in_with_apple.private_key

Describes the private_key that comes from Apple.

resource_config.user_pool_configs.o_auth.social_provider_settings.sign_in_with_apple.team_id

Describes the team_id that comes from Apple.

resource_config.user_pool_configs.password_policy

Describes the password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.

Show child fields
resource_config.user_pool_configs.password_policy.additional_constraints[]
resource_config.user_pool_configs.password_policy.minimum_length

The minimum length of the password used to access the backend of your Amplify project.

resource_config.user_pool_configs.required_sign_up_attributes[]
resource_config.user_pool_configs.sign_in_method

Describes the sign-in methods that your Amplify app users use to log in using the Amazon Cognito user pool, configured as a part of your Amplify project.

resource_config.user_pool_configs.user_pool_name

The Amazon Cognito user pool name.

resource_config.user_pool_configs.verification_message

Describes the email or SMS verification message for your Amazon Cognito user pool, configured as a part of your Amplify project.

Show child fields
resource_config.user_pool_configs.verification_message.delivery_method

The type of verification message to send.

resource_config.user_pool_configs.verification_message.email_settings

The settings for the email message.

Show child fields
resource_config.user_pool_configs.verification_message.email_settings.email_message

The contents of the email message.

resource_config.user_pool_configs.verification_message.email_settings.email_subject

The contents of the subject line of the email message.

resource_config.user_pool_configs.verification_message.sms_settings

The settings for the SMS message.

Show child fields
resource_config.user_pool_configs.verification_message.sms_settings.sms_message

The contents of the SMS message.