vpc_connectors

Creates, updates, deletes or gets a vpc_connector resource or lists vpc_connectors in a region

Overview

Name	vpc_connectors
Type	Resource
Description	The AWS::AppRunner::VpcConnector resource specifies an App Runner VpcConnector.
Id	awscc.apprunner.vpc_connectors

Fields

get (all properties)

Name	Datatype	Description
vpc_connector_name	string	A name for the VPC connector. If you don't specify a name, AWS CloudFormation generates a name for your VPC connector.
vpc_connector_arn	string	The Amazon Resource Name (ARN) of this VPC connector.
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.
subnets	array	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.
security_groups	array	A list of IDs of security groups that App Runner should use for access to AWS 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.
▶tags	array	A list of metadata items that you can associate with your VPC connector resource. A tag is a key-value pair.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
vpc_connector_arn	string	The Amazon Resource Name (ARN) of this VPC connector.
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	vpc_connectors	INSERT	Subnets, region
delete_resource	vpc_connectors	DELETE	Identifier, region
list_resources	vpc_connectors_list_only	SELECT	region
get_resource	vpc_connectors	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual vpc_connector.

SELECT
  region,
  vpc_connector_name,
  vpc_connector_arn,
  vpc_connector_revision,
  subnets,
  security_groups,
  tags
FROM awscc.apprunner.vpc_connectors
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ vpc_connector_arn }}';

list (identifiers only)

Lists all vpc_connectors in a region.

SELECT
  region,
  vpc_connector_arn
FROM awscc.apprunner.vpc_connectors_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.apprunner.vpc_connectors (
  Subnets,
  region
)
SELECT
  '{{ subnets }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.apprunner.vpc_connectors (
  VpcConnectorName,
  Subnets,
  SecurityGroups,
  Tags,
  region
)
SELECT
  '{{ vpc_connector_name }}',
  '{{ subnets }}',
  '{{ security_groups }}',
  '{{ tags }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Manifest

version: 1
name: stack name
description: stack description
providers:
- aws
globals:
- name: region
  value: '{{ vars.AWS_REGION }}'
resources:
- name: vpc_connector
  props:
    - name: vpc_connector_name
      value: '{{ vpc_connector_name }}'
    - name: subnets
      value:
        - '{{ subnets[0] }}'
    - name: security_groups
      value:
        - '{{ security_groups[0] }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

DELETE example

/*+ delete */
DELETE FROM awscc.apprunner.vpc_connectors
WHERE
  Identifier = '{{ vpc_connector_arn }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

Permissions

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

Create

iam:CreateServiceLinkedRole,
apprunner:CreateVpcConnector,
apprunner:DescribeVpcConnector,
apprunner:TagResource,
ec2:DescribeSubnets,
ec2:DescribeSecurityGroups

Read

apprunner:DescribeVpcConnector

Delete

apprunner:DeleteVpcConnector

List

apprunner:ListVpcConnectors