vpc_endpoint_associations

Creates, updates, deletes or gets a vpc_endpoint_association resource or lists vpc_endpoint_associations in a region

Overview

Name	vpc_endpoint_associations
Type	Resource
Description	Resource type definition for AWS::NetworkFirewall::VpcEndpointAssociation
Id	awscc.networkfirewall.vpc_endpoint_associations

Fields

Name	Datatype	Description
vpc_endpoint_association_arn	string	A resource ARN.
vpc_endpoint_association_id	string
description	string
vpc_id	string
endpoint_id	string	An endpoint Id.
▶subnet_mapping	object
▶tags	array
region	string	AWS region.

For more information, see AWS::NetworkFirewall::VpcEndpointAssociation.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	FirewallArn, VpcId, SubnetMapping, 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 properties from an individual vpc_endpoint_association.

SELECT
region,
vpc_endpoint_association_arn,
vpc_endpoint_association_id,
description,
firewall_arn,
vpc_id,
endpoint_id,
subnet_mapping,
tags
FROM awscc.networkfirewall.vpc_endpoint_associations
WHERE region = 'us-east-1' AND data__Identifier = '<VpcEndpointAssociationArn>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.networkfirewall.vpc_endpoint_associations (
 FirewallArn,
 VpcId,
 SubnetMapping,
 region
)
SELECT 
'{{ FirewallArn }}',
 '{{ VpcId }}',
 '{{ SubnetMapping }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.networkfirewall.vpc_endpoint_associations (
 Description,
 FirewallArn,
 VpcId,
 SubnetMapping,
 Tags,
 region
)
SELECT 
 '{{ Description }}',
 '{{ FirewallArn }}',
 '{{ VpcId }}',
 '{{ SubnetMapping }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: vpc_endpoint_association
    props:
      - name: Description
        value: '{{ Description }}'
      - name: FirewallArn
        value: '{{ FirewallArn }}'
      - name: VpcId
        value: '{{ VpcId }}'
      - name: SubnetMapping
        value:
          SubnetId: '{{ SubnetId }}'
          IPAddressType: '{{ IPAddressType }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM awscc.networkfirewall.vpc_endpoint_associations
WHERE data__Identifier = '<VpcEndpointAssociationArn>'
AND region = 'us-east-1';

Permissions

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

Create

network-firewall:CreateVpcEndpointAssociation,
network-firewall:DescribeVpcEndpointAssociation,
network-firewall:ListFirewalls,
network-firewall:TagResource,
ec2:CreateVpcEndpoint,
ec2:DescribeVpcEndpoints,
ec2:DescribeSubnets,
ec2:DescribeVpcs,
iam:CreateServiceLinkedRole

Read

network-firewall:DescribeVpcEndpointAssociation,
network-firewall:ListTagsForResource

Update

network-firewall:DescribeVpcEndpointAssociation,
network-firewall:TagResource,
network-firewall:UntagResource

Delete

network-firewall:DeleteVpcEndpointAssociation,
network-firewall:DescribeVpcEndpointAssociation,
network-firewall:UntagResource,
ec2:DeleteVpcEndpoints,
ec2:DescribeRouteTables

List

network-firewall:ListVpcEndpointAssociations