vpc_block_public_access_exclusions

Creates, updates, deletes or gets a vpc_block_public_access_exclusion resource or lists vpc_block_public_access_exclusions in a region

Overview

Name	vpc_block_public_access_exclusions
Type	Resource
Description	Resource Type definition for AWS::EC2::VPCBlockPublicAccessExclusion.
Id	awscc.ec2.vpc_block_public_access_exclusions

Fields

get (all properties)

Name	Datatype	Description
exclusion_id	string	The ID of the exclusion
internet_gateway_exclusion_mode	string	The desired Block Public Access Exclusion Mode for a specific VPC/Subnet.
vpc_id	string	The ID of the vpc. Required only if you don't specify SubnetId.
subnet_id	string	The ID of the subnet. Required only if you don't specify VpcId
▶tags	array	An array of key-value pairs to apply to this resource.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
exclusion_id	string	The ID of the exclusion
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	vpc_block_public_access_exclusions	INSERT	InternetGatewayExclusionMode, region
delete_resource	vpc_block_public_access_exclusions	DELETE	Identifier, region
update_resource	vpc_block_public_access_exclusions	UPDATE	Identifier, PatchDocument, region
list_resources	vpc_block_public_access_exclusions_list_only	SELECT	region
get_resource	vpc_block_public_access_exclusions	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual vpc_block_public_access_exclusion.

SELECT
  region,
  exclusion_id,
  internet_gateway_exclusion_mode,
  vpc_id,
  subnet_id,
  tags
FROM awscc.ec2.vpc_block_public_access_exclusions
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ exclusion_id }}';

list (identifiers only)

Lists all vpc_block_public_access_exclusions in a region.

SELECT
  region,
  exclusion_id
FROM awscc.ec2.vpc_block_public_access_exclusions_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

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

All Properties

/*+ create */
INSERT INTO awscc.ec2.vpc_block_public_access_exclusions (
  InternetGatewayExclusionMode,
  VpcId,
  SubnetId,
  Tags,
  region
)
SELECT
  '{{ internet_gateway_exclusion_mode }}',
  '{{ vpc_id }}',
  '{{ subnet_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: vpc_block_public_access_exclusion
  props:
    - name: internet_gateway_exclusion_mode
      value: '{{ internet_gateway_exclusion_mode }}'
    - name: vpc_id
      value: '{{ vpc_id }}'
    - name: subnet_id
      value: '{{ subnet_id }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

UPDATE example

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

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

DELETE example

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

Create

ec2:DescribeVpcBlockPublicAccessExclusions,
ec2:CreateVpcBlockPublicAccessExclusion,
ec2:CreateTags

Read

ec2:DescribeVpcBlockPublicAccessExclusions

Update

ec2:DescribeVpcBlockPublicAccessExclusions,
ec2:ModifyVpcBlockPublicAccessExclusion,
ec2:CreateTags,
ec2:DeleteTags

Delete

ec2:DescribeVpcBlockPublicAccessExclusions,
ec2:DeleteVpcBlockPublicAccessExclusion

List

ec2:DescribeVpcBlockPublicAccessExclusions