vpc_endpoint_associations

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

Overview

Name	vpc_endpoint_associations
Type	Resource
Id	aws.network_firewall.vpc_endpoint_associations

Fields

The following fields are returned by SELECT queries:

describe_vpc_endpoint_association

Name	Datatype	Description
vpc_endpoint_association	object	The configuration settings for the VPC endpoint association. These settings include the firewall and the VPC and subnet to use for the firewall endpoint.
vpc_endpoint_association_status	object	Detailed information about the current status of a VpcEndpointAssociation. You can retrieve this by calling DescribeVpcEndpointAssociation and providing the VPC endpoint association ARN.

list_vpc_endpoint_associations

Name	Datatype	Description
vpc_endpoint_association_arn	string	The Amazon Resource Name (ARN) of a VPC endpoint association. (pattern: <code>^arn:aws.*</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_vpc_endpoint_association	select	region		Returns the data object for the specified VPC endpoint association.
list_vpc_endpoint_associations	select	region		Retrieves the metadata for the VPC endpoint associations that you have defined. If you specify a fireawll, this returns only the endpoint associations for that firewall. Depending on your setting for max results and the number of associations, a single call might not return the full list.
create_vpc_endpoint_association	insert	region, FirewallArn, VpcId, SubnetMapping		Creates a firewall endpoint for an Network Firewall firewall. This type of firewall endpoint is independent of the firewall endpoints that you specify in the Firewall itself, and you define it in addition to those endpoints after the firewall has been created. You can define a VPC endpoint association using a different VPC than the one you used in the firewall specifications.
delete_vpc_endpoint_association	delete	region		Deletes the specified VpcEndpointAssociation. You can check whether an endpoint association is in use by reviewing the route tables for the Availability Zones where you have the endpoint subnet mapping. You can retrieve the subnet mapping by calling DescribeVpcEndpointAssociation. You define and update the route tables through Amazon VPC. As needed, update the route tables for the Availability Zone to remove the firewall endpoint for the association. When the route tables no longer use the firewall endpoint, you can remove the endpoint association safely.

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_endpoint_association

Returns the data object for the specified VPC endpoint association.

SELECT
vpc_endpoint_association,
vpc_endpoint_association_status
FROM aws.network_firewall.vpc_endpoint_associations
WHERE region = '{{ region }}' -- required
;

list_vpc_endpoint_associations

Retrieves the metadata for the VPC endpoint associations that you have defined. If you specify a fireawll, this returns only the endpoint associations for that firewall. Depending on your setting for max results and the number of associations, a single call might not return the full list.

SELECT
vpc_endpoint_association_arn
FROM aws.network_firewall.vpc_endpoint_associations
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_vpc_endpoint_association

Creates a firewall endpoint for an Network Firewall firewall. This type of firewall endpoint is independent of the firewall endpoints that you specify in the Firewall itself, and you define it in addition to those endpoints after the firewall has been created. You can define a VPC endpoint association using a different VPC than the one you used in the firewall specifications.

INSERT INTO aws.network_firewall.vpc_endpoint_associations (
FirewallArn,
VpcId,
SubnetMapping,
Description,
Tags,
region
)
SELECT 
'{{ FirewallArn }}' /* required */,
'{{ VpcId }}' /* required */,
'{{ SubnetMapping }}' /* required */,
'{{ Description }}',
'{{ Tags }}',
'{{ region }}'
RETURNING
vpc_endpoint_association,
vpc_endpoint_association_status
;

Manifest

# Description fields are for documentation purposes
- name: vpc_endpoint_associations
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the vpc_endpoint_associations resource.
  - name: FirewallArn
    value: "{{ FirewallArn }}"
    description: |
      The Amazon Resource Name (ARN) of the firewall.
  - name: VpcId
    value: "{{ VpcId }}"
    description: |
      The unique identifier of the VPC where you want to create a firewall endpoint.
  - name: SubnetMapping
    description: |
      The ID for a subnet that's used in an association with a firewall. This is used in CreateFirewall, AssociateSubnets, and CreateVpcEndpointAssociation. Network Firewall creates an instance of the associated firewall in each subnet that you specify, to filter traffic in the subnet's Availability Zone.
    value:
      SubnetId: "{{ SubnetId }}"
      IPAddressType: "{{ IPAddressType }}"
  - name: Description
    value: "{{ Description }}"
    description: |
      A description of the VPC endpoint association.
  - name: Tags
    description: |
      The key:value pairs to associate with the resource.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"

DELETE examples

delete_vpc_endpoint_association

Deletes the specified VpcEndpointAssociation. You can check whether an endpoint association is in use by reviewing the route tables for the Availability Zones where you have the endpoint subnet mapping. You can retrieve the subnet mapping by calling DescribeVpcEndpointAssociation. You define and update the route tables through Amazon VPC. As needed, update the route tables for the Availability Zone to remove the firewall endpoint for the association. When the route tables no longer use the firewall endpoint, you can remove the endpoint association safely.

DELETE FROM aws.network_firewall.vpc_endpoint_associations
WHERE region = '{{ region }}' --required
;