vpc_connectors

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

Overview

Name	vpc_connectors
Type	Resource
Id	aws.apprunner.vpc_connectors

Fields

The following fields are returned by SELECT queries:

describe_vpc_connector

Name	Datatype	Description
created_at	string (date-time)	The time when the VPC connector was created. It's in Unix time stamp format.
deleted_at	string (date-time)	The time when the VPC connector was deleted. It's in Unix time stamp format.
security_groups	array	A list of IDs of security groups that App Runner uses for access to Amazon Web Services resources under the specified subnets. If not specified, App Runner uses the default security group of the Amazon VPC. The default security group allows all outbound traffic.
status	string	The current state of the VPC connector. If the status of a connector revision is INACTIVE, it was deleted and can't be used. Inactive connector revisions are permanently removed some time after they are deleted. (ACTIVE, INACTIVE)
subnets	array	A list of IDs of subnets that App Runner uses for your service. All IDs are of subnets of a single Amazon VPC.
vpc_connector_arn	string	The Amazon Resource Name (ARN) of this VPC connector. (pattern: <code>arn:aws(-[\w]+)*:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[0-9]{12}:(\w|/|-){1,1011}</code>)
vpc_connector_name	string	The customer-provided VPC connector name. (pattern: <code>[A-Za-z0-9][A-Za-z0-9-_]{3,39}</code>)
vpc_connector_revision	integer	The revision of this VPC connector. It's unique among all the active connectors ("Status": "ACTIVE") that share the same Name. At this time, App Runner supports only one revision per name.

list_vpc_connectors

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_connectors	array	A list of information records for VPC connectors. 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_connector	select	region		Return a description of an App Runner VPC connector resource.
list_vpc_connectors	select	region		Returns a list of App Runner VPC connectors in your Amazon Web Services account.
create_vpc_connector	insert	region, VpcConnectorName, Subnets		Create an App Runner VPC connector resource. App Runner requires this resource when you want to associate your App Runner service to a custom Amazon Virtual Private Cloud (Amazon VPC).
delete_vpc_connector	delete	region		Delete an App Runner VPC connector resource. You can't delete a connector that's used by one or more App Runner services.

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_connector

Return a description of an App Runner VPC connector resource.

SELECT
created_at,
deleted_at,
security_groups,
status,
subnets,
vpc_connector_arn,
vpc_connector_name,
vpc_connector_revision
FROM aws.apprunner.vpc_connectors
WHERE region = '{{ region }}' -- required
;

list_vpc_connectors

Returns a list of App Runner VPC connectors in your Amazon Web Services account.

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

INSERT examples

create_vpc_connector

Create an App Runner VPC connector resource. App Runner requires this resource when you want to associate your App Runner service to a custom Amazon Virtual Private Cloud (Amazon VPC).

INSERT INTO aws.apprunner.vpc_connectors (
VpcConnectorName,
Subnets,
SecurityGroups,
Tags,
region
)
SELECT 
'{{ VpcConnectorName }}' /* required */,
'{{ Subnets }}' /* required */,
'{{ SecurityGroups }}',
'{{ Tags }}',
'{{ region }}'
RETURNING
vpc_connector
;

Manifest

# Description fields are for documentation purposes
- name: vpc_connectors
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the vpc_connectors resource.
  - name: VpcConnectorName
    value: "{{ VpcConnectorName }}"
    description: |
      A name for the VPC connector.
  - name: Subnets
    value:
      - "{{ Subnets }}"
    description: |
      A list of IDs of subnets that App Runner should use when it associates your service with a custom Amazon VPC. Specify IDs of subnets of a single Amazon VPC. App Runner determines the Amazon VPC from the subnets you specify. App Runner only supports subnets of IP address type IPv4 and dual stack (IPv4 and IPv6).
  - name: SecurityGroups
    value:
      - "{{ SecurityGroups }}"
    description: |
      A list of IDs of security groups that App Runner should use for access to Amazon Web Services resources under the specified subnets. If not specified, App Runner uses the default security group of the Amazon VPC. The default security group allows all outbound traffic.
  - name: Tags
    description: |
      A list of metadata items that you can associate with your VPC connector resource. A tag is a key-value pair.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"

DELETE examples

delete_vpc_connector

Delete an App Runner VPC connector resource. You can't delete a connector that's used by one or more App Runner services.

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