vpc_ingress_connections

Creates, updates, deletes or gets a vpc_ingress_connection resource or lists vpc_ingress_connections in a region

Overview

Name	vpc_ingress_connections
Type	Resource
Description	The AWS::AppRunner::VpcIngressConnection resource is an App Runner resource that specifies an App Runner VpcIngressConnection.
Id	awscc.apprunner.vpc_ingress_connections

Fields

get (all properties)

Name	Datatype	Description
vpc_ingress_connection_arn	string	The Amazon Resource Name (ARN) of the VpcIngressConnection.
vpc_ingress_connection_name	string	The customer-provided Vpc Ingress Connection name.
service_arn	string	The Amazon Resource Name (ARN) of the service.
status	string	The current status of the VpcIngressConnection.
domain_name	string	The Domain name associated with the VPC Ingress Connection.
▶ingress_vpc_configuration	object	The configuration of customer’s VPC and related VPC endpoint
▶tags	array
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
vpc_ingress_connection_arn	string	The Amazon Resource Name (ARN) of the VpcIngressConnection.
region	string	AWS region.

For more information, see AWS::AppRunner::VpcIngressConnection.

Methods

Name	Resource	Accessible by	Required Params
create_resource	vpc_ingress_connections	INSERT	ServiceArn, IngressVpcConfiguration, region
delete_resource	vpc_ingress_connections	DELETE	Identifier, region
update_resource	vpc_ingress_connections	UPDATE	Identifier, PatchDocument, region
list_resources	vpc_ingress_connections_list_only	SELECT	region
get_resource	vpc_ingress_connections	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual vpc_ingress_connection.

SELECT
  region,
  vpc_ingress_connection_arn,
  vpc_ingress_connection_name,
  service_arn,
  status,
  domain_name,
  ingress_vpc_configuration,
  tags
FROM awscc.apprunner.vpc_ingress_connections
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ vpc_ingress_connection_arn }}';

list (identifiers only)

Lists all vpc_ingress_connections in a region.

SELECT
  region,
  vpc_ingress_connection_arn
FROM awscc.apprunner.vpc_ingress_connections_list_only
WHERE
  region = 'us-east-1';

INSERT example

Use the following StackQL query and manifest file to create a new vpc_ingress_connection resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO awscc.apprunner.vpc_ingress_connections (
  ServiceArn,
  IngressVpcConfiguration,
  region
)
SELECT
  '{{ service_arn }}',
  '{{ ingress_vpc_configuration }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.apprunner.vpc_ingress_connections (
  VpcIngressConnectionName,
  ServiceArn,
  IngressVpcConfiguration,
  Tags,
  region
)
SELECT
  '{{ vpc_ingress_connection_name }}',
  '{{ service_arn }}',
  '{{ ingress_vpc_configuration }}',
  '{{ tags }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: vpc_ingress_connection
    props:
      - name: vpc_ingress_connection_name
        value: '{{ vpc_ingress_connection_name }}'
      - name: service_arn
        value: '{{ service_arn }}'
      - name: ingress_vpc_configuration
        value:
          vpc_id: '{{ vpc_id }}'
          vpc_endpoint_id: '{{ vpc_endpoint_id }}'
      - name: tags
        value:
          - key: '{{ key }}'
            value: '{{ value }}'

UPDATE example

Use the following StackQL query and manifest file to update a vpc_ingress_connection resource, using stack-deploy.

/*+ update */
UPDATE awscc.apprunner.vpc_ingress_connections
SET PatchDocument = string('{{ {
    "IngressVpcConfiguration": ingress_vpc_configuration
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ vpc_ingress_connection_arn }}';

DELETE example

/*+ delete */
DELETE FROM awscc.apprunner.vpc_ingress_connections
WHERE
  Identifier = '{{ vpc_ingress_connection_arn }}' AND
  region = 'us-east-1';

Permissions

To operate on the vpc_ingress_connections resource, the following permissions are required:

Create

apprunner:CreateVpcIngressConnection,
apprunner:DescribeVpcIngressConnection,
ec2:DescribeVpcs,
ec2:DescribeVpcEndpoints,
ec2:DescribeSubnets,
apprunner:TagResource

Read

apprunner:DescribeVpcIngressConnection

Update

apprunner:UpdateVpcIngressConnection

Delete

apprunner:DeleteVpcIngressConnection

List

apprunner:ListVpcIngressConnections