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	aws.apprunner.vpc_ingress_connections

Fields

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.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	ServiceArn, IngressVpcConfiguration, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all vpc_ingress_connections in a region.

SELECT
region,
vpc_ingress_connection_arn,
vpc_ingress_connection_name,
service_arn,
status,
domain_name,
ingress_vpc_configuration,
tags
FROM aws.apprunner.vpc_ingress_connections
WHERE region = 'us-east-1';

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 aws.apprunner.vpc_ingress_connections
WHERE region = 'us-east-1' AND data__Identifier = '<VpcIngressConnectionArn>';

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 aws.apprunner.vpc_ingress_connections (
 ServiceArn,
 IngressVpcConfiguration,
 region
)
SELECT 
'{{ ServiceArn }}',
 '{{ IngressVpcConfiguration }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.apprunner.vpc_ingress_connections (
 VpcIngressConnectionName,
 ServiceArn,
 IngressVpcConfiguration,
 Tags,
 region
)
SELECT 
 '{{ VpcIngressConnectionName }}',
 '{{ ServiceArn }}',
 '{{ IngressVpcConfiguration }}',
 '{{ 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: VpcIngressConnectionName
        value: '{{ VpcIngressConnectionName }}'
      - name: ServiceArn
        value: '{{ ServiceArn }}'
      - name: IngressVpcConfiguration
        value:
          VpcId: '{{ VpcId }}'
          VpcEndpointId: '{{ VpcEndpointId }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.apprunner.vpc_ingress_connections
WHERE data__Identifier = '<VpcIngressConnectionArn>'
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