Skip to content

aws.vpc_lattice.get_rule

Example SQL Queries

SELECT * FROM
aws.vpc_lattice.get_rule
WHERE
"listener_identifier" = 'VALUE'
AND "rule_identifier" = 'VALUE'
AND "service_identifier" = 'VALUE';

Description

Retrieves information about listener rules. You can also retrieve information about the default listener rule. For more information, see Listener rules in the Amazon VPC Lattice User Guide.

Table Definition

Column NameColumn Data Type
listener_identifier Required Input Column

The ID or Amazon Resource Name (ARN) of the listener.

VARCHAR
rule_identifier Required Input Column

The ID or Amazon Resource Name (ARN) of the listener rule.

VARCHAR
service_identifier Required Input Column

The ID or Amazon Resource Name (ARN) of the service.

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
action

The action for the default rule.

STRUCT(
"fixed_response" STRUCT(
"status_code" BIGINT
),
"forward" STRUCT(
"target_groups" STRUCT(
"target_group_identifier" VARCHAR,
"weight" BIGINT
)[]
)
)
Show child fields
action.fixed_response

The fixed response action. The rule returns a custom HTTP response.

Show child fields
action.fixed_response.status_code

The HTTP response code.

action.forward

The forward action. Traffic that matches the rule is forwarded to the specified target groups.

Show child fields
action.forward.target_groups[]
Show child fields
action.forward.target_groups[].target_group_identifier

The ID or Amazon Resource Name (ARN) of the target group.

action.forward.target_groups[].weight

Only required if you specify multiple target groups for a forward action. The weight determines how requests are distributed to the target group. For example, if you specify two target groups, each with a weight of 10, each target group receives half the requests. If you specify two target groups, one with a weight of 10 and the other with a weight of 20, the target group with a weight of 20 receives twice as many requests as the other target group. If there's only one target group specified, then the default value is 100.

arn

The Amazon Resource Name (ARN) of the listener.

VARCHAR
created_at

The date and time that the listener rule was created, specified in ISO-8601 format.

TIMESTAMP_S
id

The ID of the listener.

VARCHAR
is_default

Indicates whether this is the default rule.

BOOLEAN
last_updated_at

The date and time that the listener rule was last updated, specified in ISO-8601 format.

TIMESTAMP_S
match

The rule match.

STRUCT(
"http_match" STRUCT(
"header_matches" STRUCT(
"case_sensitive" BOOLEAN,
"match" STRUCT(
"contains" VARCHAR,
"exact" VARCHAR,
"prefix" VARCHAR
),
"name" VARCHAR
)[],
"method" VARCHAR,
"path_match" STRUCT(
"case_sensitive" BOOLEAN,
"match" STRUCT(
"exact" VARCHAR,
"prefix" VARCHAR
)
)
)
)
Show child fields
match.http_match

The HTTP criteria that a rule must match.

Show child fields
match.http_match.header_matches[]
Show child fields
match.http_match.header_matches[].case_sensitive

Indicates whether the match is case sensitive.

match.http_match.header_matches[].match

The header match type.

Show child fields
match.http_match.header_matches[].match.contains

A contains type match.

match.http_match.header_matches[].match.exact

An exact type match.

match.http_match.header_matches[].match.prefix

A prefix type match. Matches the value with the prefix.

match.http_match.header_matches[].name

The name of the header.

match.http_match.method

The HTTP method type.

match.http_match.path_match

The path match.

Show child fields
match.http_match.path_match.case_sensitive

Indicates whether the match is case sensitive.

match.http_match.path_match.match

The type of path match.

Show child fields
match.http_match.path_match.match.exact

An exact match of the path.

match.http_match.path_match.match.prefix

A prefix match of the path.

name

The name of the listener.

VARCHAR
priority

The priority level for the specified rule.

BIGINT