network_acls

Creates, updates, deletes or gets a network_acl resource or lists network_acls in a region

Overview

Name	network_acls
Type	Resource
Description	Specifies a network ACL for your VPC. To add a network ACL entry, see AWS::EC2::NetworkAclEntry.
Id	awscc.ec2.network_acls

Fields

get (all properties)

Name	Datatype	Description
vpc_id	string	The ID of the VPC for the network ACL.
id	string
▶tags	array	The tags for the network ACL.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
id	string
region	string	AWS region.

For more information, see AWS::EC2::NetworkAcl.

Methods

Name	Resource	Accessible by	Required Params
create_resource	network_acls	INSERT	VpcId, region
delete_resource	network_acls	DELETE	Identifier, region
update_resource	network_acls	UPDATE	Identifier, PatchDocument, region
list_resources	network_acls_list_only	SELECT	region
get_resource	network_acls	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual network_acl.

SELECT
  region,
  vpc_id,
  id,
  tags
FROM awscc.ec2.network_acls
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ id }}';

list (identifiers only)

Lists all network_acls in a region.

SELECT
  region,
  id
FROM awscc.ec2.network_acls_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.ec2.network_acls (
  VpcId,
  region
)
SELECT
  '{{ vpc_id }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.ec2.network_acls (
  VpcId,
  Tags,
  region
)
SELECT
  '{{ vpc_id }}',
  '{{ 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: network_acl
  props:
    - name: vpc_id
      value: '{{ vpc_id }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

UPDATE example

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

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

DELETE example

/*+ delete */
DELETE FROM awscc.ec2.network_acls
WHERE
  Identifier = '{{ id }}' 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 network_acls resource, the following permissions are required:

Read

ec2:DescribeNetworkAcls,
ec2:DescribeTags

Create

ec2:CreateNetworkAcl,
ec2:DescribeNetworkAcls,
ec2:CreateTags

Update

ec2:DescribeNetworkAcls,
ec2:DeleteTags,
ec2:CreateTags

List

ec2:DescribeNetworkAcls

Delete

ec2:DeleteTags,
ec2:DeleteNetworkAcl,
ec2:DescribeNetworkAcls