vpc_ingress_connections

Creates, updates, deletes, gets or lists a vpc_ingress_connections resource.

Overview

Name	vpc_ingress_connections
Type	Resource
Id	aws.apprunner.vpc_ingress_connections

Fields

The following fields are returned by SELECT queries:

describe_vpc_ingress_connection

Name	Datatype	Description
account_id	string	The Account Id you use to create the VPC Ingress Connection resource. (pattern: <code>[0-9]{12}</code>)
created_at	string (date-time)	The time when the VPC Ingress Connection was created. It's in the Unix time stamp format. Type: Timestamp Required: Yes
deleted_at	string (date-time)	The time when the App Runner service was deleted. It's in the Unix time stamp format. Type: Timestamp Required: No
domain_name	string	The domain name associated with the VPC Ingress Connection resource. (pattern: <code>[A-Za-z0-9*.-]{1,255}</code>)
ingress_vpc_configuration	object	Specifications for the customer’s VPC and related PrivateLink VPC endpoint that are used to associate with the VPC Ingress Connection resource.
service_arn	string	The Amazon Resource Name (ARN) of the service associated with the VPC Ingress Connection. (pattern: <code>arn:aws(-[\w]+)*:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[0-9]{12}:(\w|/|-){1,1011}</code>)
status	string	The current status of the VPC Ingress Connection. The VPC Ingress Connection displays one of the following statuses: AVAILABLE, PENDING_CREATION, PENDING_UPDATE, PENDING_DELETION,FAILED_CREATION, FAILED_UPDATE, FAILED_DELETION, and DELETED.. (AVAILABLE, PENDING_CREATION, PENDING_UPDATE, PENDING_DELETION, FAILED_CREATION, FAILED_UPDATE, FAILED_DELETION, DELETED)
vpc_ingress_connection_arn	string	The Amazon Resource Name (ARN) of the VPC Ingress Connection. (pattern: <code>arn:aws(-[\w]+)*:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[0-9]{12}:(\w|/|-){1,1011}</code>)
vpc_ingress_connection_name	string	The customer-provided VPC Ingress Connection name. (pattern: <code>[A-Za-z0-9][A-Za-z0-9-_]{3,39}</code>)

list_vpc_ingress_connections

Name	Datatype	Description
next_token	string	The token that you can pass in a subsequent request to get the next result page. It's returned in a paginated request. (pattern: <code>.*</code>)
vpc_ingress_connection_summary_list	array	A list of summary information records for VPC Ingress Connections. In a paginated request, the request returns up to MaxResults records for each call.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_vpc_ingress_connection	select	region		Return a full description of an App Runner VPC Ingress Connection resource.
list_vpc_ingress_connections	select	region		Return a list of App Runner VPC Ingress Connections in your Amazon Web Services account.
create_vpc_ingress_connection	insert	region, ServiceArn, VpcIngressConnectionName, IngressVpcConfiguration		Create an App Runner VPC Ingress Connection resource. App Runner requires this resource when you want to associate your App Runner service with an Amazon VPC endpoint.
update_vpc_ingress_connection	update	region, VpcIngressConnectionArn, IngressVpcConfiguration		Update an existing App Runner VPC Ingress Connection resource. The VPC Ingress Connection must be in one of the following states to be updated: AVAILABLE FAILED_CREATION FAILED_UPDATE
delete_vpc_ingress_connection	delete	region		Delete an App Runner VPC Ingress Connection resource that's associated with an App Runner service. The VPC Ingress Connection must be in one of the following states to be deleted: AVAILABLE FAILED_CREATION FAILED_UPDATE FAILED_DELETION

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_vpc_ingress_connection

Return a full description of an App Runner VPC Ingress Connection resource.

SELECT
account_id,
created_at,
deleted_at,
domain_name,
ingress_vpc_configuration,
service_arn,
status,
vpc_ingress_connection_arn,
vpc_ingress_connection_name
FROM aws.apprunner.vpc_ingress_connections
WHERE region = '{{ region }}' -- required
;

list_vpc_ingress_connections

Return a list of App Runner VPC Ingress Connections in your Amazon Web Services account.

SELECT
next_token,
vpc_ingress_connection_summary_list
FROM aws.apprunner.vpc_ingress_connections
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_vpc_ingress_connection

Create an App Runner VPC Ingress Connection resource. App Runner requires this resource when you want to associate your App Runner service with an Amazon VPC endpoint.

INSERT INTO aws.apprunner.vpc_ingress_connections (
ServiceArn,
VpcIngressConnectionName,
IngressVpcConfiguration,
Tags,
region
)
SELECT 
'{{ ServiceArn }}' /* required */,
'{{ VpcIngressConnectionName }}' /* required */,
'{{ IngressVpcConfiguration }}' /* required */,
'{{ Tags }}',
'{{ region }}'
RETURNING
vpc_ingress_connection
;

Manifest

# Description fields are for documentation purposes
- name: vpc_ingress_connections
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the vpc_ingress_connections resource.
  - name: ServiceArn
    value: "{{ ServiceArn }}"
    description: |
      The Amazon Resource Name (ARN) for this App Runner service that is used to create the VPC Ingress Connection resource.
  - name: VpcIngressConnectionName
    value: "{{ VpcIngressConnectionName }}"
    description: |
      A name for the VPC Ingress Connection resource. It must be unique across all the active VPC Ingress Connections in your Amazon Web Services account in the Amazon Web Services Region.
  - name: IngressVpcConfiguration
    description: |
      Specifications for the customer’s Amazon VPC and the related Amazon Web Services PrivateLink VPC endpoint that are used to create the VPC Ingress Connection resource.
    value:
      VpcId: "{{ VpcId }}"
      VpcEndpointId: "{{ VpcEndpointId }}"
  - name: Tags
    description: |
      An optional list of metadata items that you can associate with the VPC Ingress Connection resource. A tag is a key-value pair.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"

UPDATE examples

update_vpc_ingress_connection

Update an existing App Runner VPC Ingress Connection resource. The VPC Ingress Connection must be in one of the following states to be updated: AVAILABLE FAILED_CREATION FAILED_UPDATE

UPDATE aws.apprunner.vpc_ingress_connections
SET 
VpcIngressConnectionArn = '{{ VpcIngressConnectionArn }}',
IngressVpcConfiguration = '{{ IngressVpcConfiguration }}'
WHERE 
region = '{{ region }}' --required
AND VpcIngressConnectionArn = '{{ VpcIngressConnectionArn }}' --required
AND IngressVpcConfiguration = '{{ IngressVpcConfiguration }}' --required
RETURNING
vpc_ingress_connection;

DELETE examples

delete_vpc_ingress_connection

Delete an App Runner VPC Ingress Connection resource that's associated with an App Runner service. The VPC Ingress Connection must be in one of the following states to be deleted: AVAILABLE FAILED_CREATION FAILED_UPDATE FAILED_DELETION

DELETE FROM aws.apprunner.vpc_ingress_connections
WHERE region = '{{ region }}' --required
;