Skip to content
AWS for Query.Farm

aws.resiliencehub.describe_app_version_resource

Example SQL Queries

SELECT * FROM
aws.resiliencehub.describe_app_version_resource
WHERE
"app_arn" = 'VALUE'
AND "app_version" = 'VALUE';

Description

Describes a resource of the Resilience Hub application.

This API accepts only one of the following parameters to describe the resource:

  • resourceName

  • logicalResourceId

  • physicalResourceId (Along with physicalResourceId, you can also provide awsAccountId, and awsRegion)

Table Definition

Column NameColumn Data Type
app_arn Required Input Column

Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

VARCHAR
app_version Required Input Column

Resilience Hub application version.

VARCHAR
aws_account_id Input Column

Amazon Web Services account that owns the physical resource.

VARCHAR
aws_region Input Column

Amazon Web Services region that owns the physical resource.

VARCHAR
logical_resource_id Input Column

Logical identifier of the resource.

STRUCT(
    "eks_source_name" VARCHAR,
    "identifier" VARCHAR,
    "logical_stack_name" VARCHAR,
    "resource_group_name" VARCHAR,
    "terraform_source_name" VARCHAR
)
Show child fields
logical_resource_id.eks_source_name

Name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to.

This parameter accepts values in "eks-cluster/namespace" format.

logical_resource_id.identifier

Identifier of the resource.

logical_resource_id.logical_stack_name

The name of the CloudFormation stack this resource belongs to.

logical_resource_id.resource_group_name

The name of the resource group that this resource belongs to.

logical_resource_id.terraform_source_name

The name of the Terraform S3 state file this resource belongs to.

physical_resource_id Input Column

Physical identifier of the resource.

VARCHAR
resource_name Input Column

Name of the 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
physical_resource

Defines a physical resource. A physical resource is a resource that exists in your account. It can be identified using an Amazon Resource Name (ARN) or a Resilience Hub-native identifier.

STRUCT(
    "additional_info" MAP(VARCHAR, VARCHAR[]),
    "app_components" STRUCT(
        "additional_info" MAP(VARCHAR, VARCHAR[]),
        "id" VARCHAR,
        "name" VARCHAR,
        "type" VARCHAR
    )[],
    "excluded" BOOLEAN,
    "logical_resource_id" STRUCT(
        "eks_source_name" VARCHAR,
        "identifier" VARCHAR,
        "logical_stack_name" VARCHAR,
        "resource_group_name" VARCHAR,
        "terraform_source_name" VARCHAR
    ),
    "parent_resource_name" VARCHAR,
    "physical_resource_id" STRUCT(
        "aws_account_id" VARCHAR,
        "aws_region" VARCHAR,
        "identifier" VARCHAR,
        "type" VARCHAR
    ),
    "resource_name" VARCHAR,
    "resource_type" VARCHAR,
    "source_type" VARCHAR
)
Show child fields
physical_resource.additional_info

Additional configuration parameters for an Resilience Hub application. If you want to implement additionalInfo through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters.

Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.

Key: "failover-regions"

Value: "[{"region":"<REGION>", "accounts":[{"id":"<ACCOUNT_ID>"}]}]"

physical_resource.app_components[]
Show child fields
physical_resource.app_components[].additional_info

Additional configuration parameters for an Resilience Hub application. If you want to implement additionalInfo through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters.

Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.

Key: "failover-regions"

Value: "[{"region":"<REGION>", "accounts":[{"id":"<ACCOUNT_ID>"}]}]"

physical_resource.app_components[].id

Identifier of the Application Component.

physical_resource.app_components[].name

Name of the Application Component.

physical_resource.app_components[].type

The type of Application Component.

physical_resource.excluded

Indicates if a resource is included or excluded from the assessment.

physical_resource.logical_resource_id

Logical identifier of the resource.

Show child fields
physical_resource.logical_resource_id.eks_source_name

Name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to.

This parameter accepts values in "eks-cluster/namespace" format.

physical_resource.logical_resource_id.identifier

Identifier of the resource.

physical_resource.logical_resource_id.logical_stack_name

The name of the CloudFormation stack this resource belongs to.

physical_resource.logical_resource_id.resource_group_name

The name of the resource group that this resource belongs to.

physical_resource.logical_resource_id.terraform_source_name

The name of the Terraform S3 state file this resource belongs to.

physical_resource.parent_resource_name

Name of the parent resource.

physical_resource.physical_resource_id

Identifier of the physical resource.

Show child fields
physical_resource.physical_resource_id.aws_account_id

The Amazon Web Services account that owns the physical resource.

physical_resource.physical_resource_id.aws_region

The Amazon Web Services Region that the physical resource is located in.

physical_resource.physical_resource_id.identifier

Identifier of the physical resource.

physical_resource.physical_resource_id.type

Specifies the type of physical resource identifier.

Arn

The resource identifier is an Amazon Resource Name (ARN) and it can identify the following list of resources:

  • AWS::ECS::Service

  • AWS::EFS::FileSystem

  • AWS::ElasticLoadBalancingV2::LoadBalancer

  • AWS::Lambda::Function

  • AWS::SNS::Topic

Native

The resource identifier is an Resilience Hub-native identifier and it can identify the following list of resources:

  • AWS::ApiGateway::RestApi

  • AWS::ApiGatewayV2::Api

  • AWS::AutoScaling::AutoScalingGroup

  • AWS::DocDB::DBCluster

  • AWS::DocDB::DBGlobalCluster

  • AWS::DocDB::DBInstance

  • AWS::DynamoDB::GlobalTable

  • AWS::DynamoDB::Table

  • AWS::EC2::EC2Fleet

  • AWS::EC2::Instance

  • AWS::EC2::NatGateway

  • AWS::EC2::Volume

  • AWS::ElasticLoadBalancing::LoadBalancer

  • AWS::RDS::DBCluster

  • AWS::RDS::DBInstance

  • AWS::RDS::GlobalCluster

  • AWS::Route53::RecordSet

  • AWS::S3::Bucket

  • AWS::SQS::Queue

physical_resource.resource_name

The name of the resource.

physical_resource.resource_type

Type of resource.

physical_resource.source_type

Type of input source.