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

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
vpc_endpoint_association_arn	string	A resource ARN.
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	vpc_endpoint_associations	INSERT	FirewallArn, VpcId, SubnetMapping, region
delete_resource	vpc_endpoint_associations	DELETE	Identifier, region
update_resource	vpc_endpoint_associations	UPDATE	Identifier, PatchDocument, region
list_resources	vpc_endpoint_associations_list_only	SELECT	region
get_resource	vpc_endpoint_associations	SELECT	Identifier, region

SELECT examples

get (all properties)

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 = '{{ region }}' AND
  Identifier = '{{ vpc_endpoint_association_arn }}';

list (identifiers only)

Lists all vpc_endpoint_associations in a region.

SELECT
  region,
  vpc_endpoint_association_arn
FROM awscc.networkfirewall.vpc_endpoint_associations_list_only
WHERE
  region = '{{ region }}';

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
  '{{ firewall_arn }}',
  '{{ vpc_id }}',
  '{{ subnet_mapping }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.networkfirewall.vpc_endpoint_associations (
  Description,
  FirewallArn,
  VpcId,
  SubnetMapping,
  Tags,
  region
)
SELECT
  '{{ description }}',
  '{{ firewall_arn }}',
  '{{ vpc_id }}',
  '{{ subnet_mapping }}',
  '{{ 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_endpoint_association
  props:
    - name: description
      value: '{{ description }}'
    - name: firewall_arn
      value: '{{ firewall_arn }}'
    - name: vpc_id
      value: '{{ vpc_id }}'
    - name: subnet_mapping
      value:
        subnet_id: '{{ subnet_id }}'
        ip_address_type: '{{ ip_address_type }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.networkfirewall.vpc_endpoint_associations
SET PatchDocument = string('{{ {
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ vpc_endpoint_association_arn }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.networkfirewall.vpc_endpoint_associations
WHERE
  Identifier = '{{ vpc_endpoint_association_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_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